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
245 @page authors Authors
246 @author Carsten Haitzler <raster@@rasterman.com>
247 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
248 @author Cedric Bail <cedric.bail@@free.fr>
249 @author Vincent Torri <vtorri@@univ-evry.fr>
250 @author Daniel Kolesa <quaker66@@gmail.com>
251 @author Jaime Thomas <avi.thomas@@gmail.com>
252 @author Swisscom - http://www.swisscom.ch/
253 @author Christopher Michael <devilhorns@@comcast.net>
254 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
255 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
256 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
257 @author Brian Wang <brian.wang.0721@@gmail.com>
258 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
259 @author Samsung Electronics <tbd>
260 @author Samsung SAIT <tbd>
261 @author Brett Nash <nash@@nash.id.au>
262 @author Bruno Dilly <bdilly@@profusion.mobi>
263 @author Rafael Fonseca <rfonseca@@profusion.mobi>
264 @author Chuneon Park <hermet@@hermet.pe.kr>
265 @author Woohyun Jung <wh0705.jung@@samsung.com>
266 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
267 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
268 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
269 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
270 @author Gustavo Lima Chaves <glima@@profusion.mobi>
271 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
272 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
273 @author Otavio Pontes <otavio@@profusion.mobi>
274 @author Viktor Kojouharov <vkojouharov@@gmail.com>
275 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
276 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
277 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
278 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
279 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
280 @author Jihoon Kim <jihoon48.kim@@samsung.com>
281 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
282 @author Tom Hacohen <tom@@stosb.com>
283 @author Aharon Hillel <a.hillel@@partner.samsung.com>
284 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
285 @author Shinwoo Kim <kimcinoo@@gmail.com>
286 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
287 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
288 @author Sung W. Park <sungwoo@@gmail.com>
289 @author Thierry el Borgi <thierry@@substantiel.fr>
290 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
291 @author Chanwook Jung <joey.jung@@samsung.com>
292 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
293 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
294 @author Kim Yunhan <spbear@@gmail.com>
295 @author Bluezery <ohpowel@@gmail.com>
296 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
297 @author Sanjeev BA <iamsanjeev@@gmail.com>
299 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
300 contact with the developers and maintainers.
308 * @brief Elementary's API
313 @ELM_UNIX_DEF@ ELM_UNIX
314 @ELM_WIN32_DEF@ ELM_WIN32
315 @ELM_WINCE_DEF@ ELM_WINCE
316 @ELM_EDBUS_DEF@ ELM_EDBUS
317 @ELM_EFREET_DEF@ ELM_EFREET
318 @ELM_ETHUMB_DEF@ ELM_ETHUMB
319 @ELM_WEB_DEF@ ELM_WEB
320 @ELM_EMAP_DEF@ ELM_EMAP
321 @ELM_DEBUG_DEF@ ELM_DEBUG
322 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
323 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
326 /* Standard headers for standard system calls etc. */
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
348 # ifdef ELM_LIBINTL_H
349 # include <libintl.h>
360 #if defined (ELM_WIN32) || defined (ELM_WINCE)
363 # define alloca _alloca
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
391 # include <Ethumb_Client.h>
403 # ifdef ELEMENTARY_BUILD
405 # define EAPI __declspec(dllexport)
408 # endif /* ! DLL_EXPORT */
410 # define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
415 # define EAPI __attribute__ ((visibility("default")))
422 #endif /* ! _WIN32 */
427 # define EAPI_MAIN EAPI
430 /* allow usage from c++ */
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
438 typedef struct _Elm_Version
446 EAPI extern Elm_Version *elm_version;
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
453 * @defgroup General General
455 * @brief General Elementary API. Functions that don't relate to
456 * Elementary objects specifically.
458 * Here are documented functions which init/shutdown the library,
459 * that apply to generic Elementary objects, that deal with
460 * configuration, et cetera.
462 * @ref general_functions_example_page "This" example contemplates
463 * some of these functions.
467 * @addtogroup General
472 * Defines couple of standard Evas_Object layers to be used
473 * with evas_object_layer_set().
475 * @note whenever extending with new values, try to keep some padding
476 * to siblings so there is room for further extensions.
478 typedef enum _Elm_Object_Layer
480 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488 /**************************************************************************/
489 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492 * Emitted when the application has reconfigured elementary settings due
493 * to an external configuration tool asking it to.
495 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498 * Emitted when any Elementary's policy value is changed.
500 EAPI extern int ELM_EVENT_POLICY_CHANGED;
503 * @typedef Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510 * @struct _Elm_Event_Policy_Changed
512 * Data on the event when an Elementary policy has changed
514 struct _Elm_Event_Policy_Changed
516 unsigned int policy; /**< the policy identifier */
517 int new_value; /**< value the policy had before the change */
518 int old_value; /**< new value the policy got */
522 * Policy identifiers.
524 typedef enum _Elm_Policy
526 ELM_POLICY_QUIT, /**< under which circumstances the application
527 * should quit automatically. @see
531 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set() */
533 typedef enum _Elm_Policy_Quit
535 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
537 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
539 * window is closed */
540 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
542 typedef enum _Elm_Focus_Direction
546 } Elm_Focus_Direction;
548 typedef enum _Elm_Text_Format
550 ELM_TEXT_FORMAT_PLAIN_UTF8,
551 ELM_TEXT_FORMAT_MARKUP_UTF8
555 * Line wrapping types.
557 typedef enum _Elm_Wrap_Type
559 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
560 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
561 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
562 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
568 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
569 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
570 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
571 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
572 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
573 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
574 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
575 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
576 ELM_INPUT_PANEL_LAYOUT_INVALID
577 } Elm_Input_Panel_Layout;
581 ELM_AUTOCAPITAL_TYPE_NONE,
582 ELM_AUTOCAPITAL_TYPE_WORD,
583 ELM_AUTOCAPITAL_TYPE_SENTENCE,
584 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
585 } Elm_Autocapital_Type;
588 * @typedef Elm_Object_Item
589 * An Elementary Object item handle.
592 typedef struct _Elm_Object_Item Elm_Object_Item;
596 * Called back when a widget's tooltip is activated and needs content.
597 * @param data user-data given to elm_object_tooltip_content_cb_set()
598 * @param obj owner widget.
599 * @param tooltip The tooltip object (affix content to this!)
601 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
604 * Called back when a widget's item tooltip is activated and needs content.
605 * @param data user-data given to elm_object_tooltip_content_cb_set()
606 * @param obj owner widget.
607 * @param tooltip The tooltip object (affix content to this!)
608 * @param item context dependent item. As an example, if tooltip was
609 * set on Elm_List_Item, then it is of this type.
611 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
613 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. */
615 #ifndef ELM_LIB_QUICKLAUNCH
616 #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 */
618 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
621 /**************************************************************************/
625 * Initialize Elementary
627 * @param[in] argc System's argument count value
628 * @param[in] argv System's pointer to array of argument strings
629 * @return The init counter value.
631 * This function initializes Elementary and increments a counter of
632 * the number of calls to it. It returns the new counter's value.
634 * @warning This call is exported only for use by the @c ELM_MAIN()
635 * macro. There is no need to use this if you use this macro (which
636 * is highly advisable). An elm_main() should contain the entry
637 * point code for your application, having the same prototype as
638 * elm_init(), and @b not being static (putting the @c EAPI symbol
639 * in front of its type declaration is advisable). The @c
640 * ELM_MAIN() call should be placed just after it.
643 * @dontinclude bg_example_01.c
647 * See the full @ref bg_example_01_c "example".
649 * @see elm_shutdown().
652 EAPI int elm_init(int argc, char **argv);
655 * Shut down Elementary
657 * @return The init counter value.
659 * This should be called at the end of your application, just
660 * before it ceases to do any more processing. This will clean up
661 * any permanent resources your application may have allocated via
662 * Elementary that would otherwise persist.
664 * @see elm_init() for an example
668 EAPI int elm_shutdown(void);
671 * Run Elementary's main loop
673 * This call should be issued just after all initialization is
674 * completed. This function will not return until elm_exit() is
675 * called. It will keep looping, running the main
676 * (event/processing) loop for Elementary.
678 * @see elm_init() for an example
682 EAPI void elm_run(void);
685 * Exit Elementary's main loop
687 * If this call is issued, it will flag the main loop to cease
688 * processing and return back to its parent function (usually your
689 * elm_main() function).
691 * @see elm_init() for an example. There, just after a request to
692 * close the window comes, the main loop will be left.
694 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
695 * applications, you'll be able to get this function called automatically for you.
699 EAPI void elm_exit(void);
702 * Provide information in order to make Elementary determine the @b
703 * run time location of the software in question, so other data files
704 * such as images, sound files, executable utilities, libraries,
705 * modules and locale files can be found.
707 * @param mainfunc This is your application's main function name,
708 * whose binary's location is to be found. Providing @c NULL
709 * will make Elementary not to use it
710 * @param dom This will be used as the application's "domain", in the
711 * form of a prefix to any environment variables that may
712 * override prefix detection and the directory name, inside the
713 * standard share or data directories, where the software's
714 * data files will be looked for.
715 * @param checkfile This is an (optional) magic file's path to check
716 * for existence (and it must be located in the data directory,
717 * under the share directory provided above). Its presence will
718 * help determine the prefix found was correct. Pass @c NULL if
719 * the check is not to be done.
721 * This function allows one to re-locate the application somewhere
722 * else after compilation, if the developer wishes for easier
723 * distribution of pre-compiled binaries.
725 * The prefix system is designed to locate where the given software is
726 * installed (under a common path prefix) at run time and then report
727 * specific locations of this prefix and common directories inside
728 * this prefix like the binary, library, data and locale directories,
729 * through the @c elm_app_*_get() family of functions.
731 * Call elm_app_info_set() early on before you change working
732 * directory or anything about @c argv[0], so it gets accurate
735 * It will then try and trace back which file @p mainfunc comes from,
736 * if provided, to determine the application's prefix directory.
738 * The @p dom parameter provides a string prefix to prepend before
739 * environment variables, allowing a fallback to @b specific
740 * environment variables to locate the software. You would most
741 * probably provide a lowercase string there, because it will also
742 * serve as directory domain, explained next. For environment
743 * variables purposes, this string is made uppercase. For example if
744 * @c "myapp" is provided as the prefix, then the program would expect
745 * @c "MYAPP_PREFIX" as a master environment variable to specify the
746 * exact install prefix for the software, or more specific environment
747 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
748 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
749 * the user or scripts before launching. If not provided (@c NULL),
750 * environment variables will not be used to override compiled-in
751 * defaults or auto detections.
753 * The @p dom string also provides a subdirectory inside the system
754 * shared data directory for data files. For example, if the system
755 * directory is @c /usr/local/share, then this directory name is
756 * appended, creating @c /usr/local/share/myapp, if it @p was @c
757 * "myapp". It is expected that the application installs data files in
760 * The @p checkfile is a file name or path of something inside the
761 * share or data directory to be used to test that the prefix
762 * detection worked. For example, your app will install a wallpaper
763 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
764 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
767 * @see elm_app_compile_bin_dir_set()
768 * @see elm_app_compile_lib_dir_set()
769 * @see elm_app_compile_data_dir_set()
770 * @see elm_app_compile_locale_set()
771 * @see elm_app_prefix_dir_get()
772 * @see elm_app_bin_dir_get()
773 * @see elm_app_lib_dir_get()
774 * @see elm_app_data_dir_get()
775 * @see elm_app_locale_dir_get()
777 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
780 * Provide information on the @b fallback application's binaries
781 * directory, in scenarios where they get overriden by
782 * elm_app_info_set().
784 * @param dir The path to the default binaries directory (compile time
787 * @note Elementary will as well use this path to determine actual
788 * names of binaries' directory paths, maybe changing it to be @c
789 * something/local/bin instead of @c something/bin, only, for
792 * @warning You should call this function @b before
793 * elm_app_info_set().
795 EAPI void elm_app_compile_bin_dir_set(const char *dir);
798 * Provide information on the @b fallback application's libraries
799 * directory, on scenarios where they get overriden by
800 * elm_app_info_set().
802 * @param dir The path to the default libraries directory (compile
805 * @note Elementary will as well use this path to determine actual
806 * names of libraries' directory paths, maybe changing it to be @c
807 * something/lib32 or @c something/lib64 instead of @c something/lib,
810 * @warning You should call this function @b before
811 * elm_app_info_set().
813 EAPI void elm_app_compile_lib_dir_set(const char *dir);
816 * Provide information on the @b fallback application's data
817 * directory, on scenarios where they get overriden by
818 * elm_app_info_set().
820 * @param dir The path to the default data directory (compile time
823 * @note Elementary will as well use this path to determine actual
824 * names of data directory paths, maybe changing it to be @c
825 * something/local/share instead of @c something/share, only, for
828 * @warning You should call this function @b before
829 * elm_app_info_set().
831 EAPI void elm_app_compile_data_dir_set(const char *dir);
834 * Provide information on the @b fallback application's locale
835 * directory, on scenarios where they get overriden by
836 * elm_app_info_set().
838 * @param dir The path to the default locale directory (compile time
841 * @warning You should call this function @b before
842 * elm_app_info_set().
844 EAPI void elm_app_compile_locale_set(const char *dir);
847 * Retrieve the application's run time prefix directory, as set by
848 * elm_app_info_set() and the way (environment) the application was
851 * @return The directory prefix the application is actually using.
853 EAPI const char *elm_app_prefix_dir_get(void);
856 * Retrieve the application's run time binaries prefix directory, as
857 * set by elm_app_info_set() and the way (environment) the application
860 * @return The binaries directory prefix the application is actually
863 EAPI const char *elm_app_bin_dir_get(void);
866 * Retrieve the application's run time libraries prefix directory, as
867 * set by elm_app_info_set() and the way (environment) the application
870 * @return The libraries directory prefix the application is actually
873 EAPI const char *elm_app_lib_dir_get(void);
876 * Retrieve the application's run time data prefix directory, as
877 * set by elm_app_info_set() and the way (environment) the application
880 * @return The data directory prefix the application is actually
883 EAPI const char *elm_app_data_dir_get(void);
886 * Retrieve the application's run time locale prefix directory, as
887 * set by elm_app_info_set() and the way (environment) the application
890 * @return The locale directory prefix the application is actually
893 EAPI const char *elm_app_locale_dir_get(void);
896 * Exposed symbol used only by macros and should not be used by apps
898 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
901 * Exposed symbol used only by macros and should not be used by apps
903 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
906 * Exposed symbol used only by macros and should not be used by apps
908 EAPI int elm_quicklaunch_init(int argc, char **argv);
911 * Exposed symbol used only by macros and should not be used by apps
913 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
916 * Exposed symbol used only by macros and should not be used by apps
918 EAPI int elm_quicklaunch_sub_shutdown(void);
921 * Exposed symbol used only by macros and should not be used by apps
923 EAPI int elm_quicklaunch_shutdown(void);
926 * Exposed symbol used only by macros and should not be used by apps
928 EAPI void elm_quicklaunch_seed(void);
931 * Exposed symbol used only by macros and should not be used by apps
933 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
936 * Exposed symbol used only by macros and should not be used by apps
938 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
941 * Exposed symbol used only by macros and should not be used by apps
943 EAPI void elm_quicklaunch_cleanup(void);
946 * Exposed symbol used only by macros and should not be used by apps
948 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
951 * Exposed symbol used only by macros and should not be used by apps
953 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
956 * Request that your elementary application needs efreet
958 * This initializes the Efreet library when called and if support exists
959 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
960 * before any efreet calls.
962 * @return EINA_TRUE if support exists and initialization succeeded.
966 EAPI Eina_Bool elm_need_efreet(void);
969 * Request that your elementary application needs e_dbus
971 * This initializes the E_dbus library when called and if support exists
972 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
973 * before any e_dbus calls.
975 * @return EINA_TRUE if support exists and initialization succeeded.
979 EAPI Eina_Bool elm_need_e_dbus(void);
982 * Request that your elementary application needs ethumb
984 * This initializes the Ethumb library when called and if support exists
985 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
986 * This must be called before any other function that deals with
987 * elm_thumb objects or ethumb_client instances.
991 EAPI Eina_Bool elm_need_ethumb(void);
994 * Request that your elementary application needs web support
996 * This initializes the Ewebkit library when called and if support exists
997 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
998 * This must be called before any other function that deals with
999 * elm_web objects or ewk_view instances.
1003 EAPI Eina_Bool elm_need_web(void);
1006 * Set a new policy's value (for a given policy group/identifier).
1008 * @param policy policy identifier, as in @ref Elm_Policy.
1009 * @param value policy value, which depends on the identifier
1011 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1013 * Elementary policies define applications' behavior,
1014 * somehow. These behaviors are divided in policy groups (see
1015 * #Elm_Policy enumeration). This call will emit the Ecore event
1016 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1017 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1020 * @note Currently, we have only one policy identifier/group
1021 * (#ELM_POLICY_QUIT), which has two possible values.
1025 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
1028 * Gets the policy value for given policy identifier.
1030 * @param policy policy identifier, as in #Elm_Policy.
1031 * @return The currently set policy value, for that
1032 * identifier. Will be @c 0 if @p policy passed is invalid.
1036 EAPI int elm_policy_get(unsigned int policy);
1039 * Change the language of the current application
1041 * The @p lang passed must be the full name of the locale to use, for
1042 * example "en_US.utf8" or "es_ES@euro".
1044 * Changing language with this function will make Elementary run through
1045 * all its widgets, translating strings set with
1046 * elm_object_domain_translatable_text_part_set(). This way, an entire
1047 * UI can have its language changed without having to restart the program.
1049 * For more complex cases, like having formatted strings that need
1050 * translation, widgets will also emit a "language,changed" signal that
1051 * the user can listen to to manually translate the text.
1053 * @param lang Language to set, must be the full name of the locale
1057 EAPI void elm_language_set(const char *lang);
1060 * Set a label of an object
1062 * @param obj The Elementary object
1063 * @param part The text part name to set (NULL for the default label)
1064 * @param label The new text of the label
1066 * @note Elementary objects may have many labels (e.g. Action Slider)
1067 * @deprecated Use elm_object_part_text_set() instead.
1070 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1073 * Set a label of an object
1075 * @param obj The Elementary object
1076 * @param part The text part name to set (NULL for the default label)
1077 * @param label The new text of the label
1079 * @note Elementary objects may have many labels (e.g. Action Slider)
1083 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1085 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1088 * Get a label of an object
1090 * @param obj The Elementary object
1091 * @param part The text part name to get (NULL for the default label)
1092 * @return text of the label or NULL for any error
1094 * @note Elementary objects may have many labels (e.g. Action Slider)
1095 * @deprecated Use elm_object_part_text_get() instead.
1098 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1101 * Get a label of an object
1103 * @param obj The Elementary object
1104 * @param part The text part name to get (NULL for the default label)
1105 * @return text of the label or NULL for any error
1107 * @note Elementary objects may have many labels (e.g. Action Slider)
1111 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1113 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1116 * Set the text for an objects' part, marking it as translatable.
1118 * The string to set as @p text must be the original one. Do not pass the
1119 * return of @c gettext() here. Elementary will translate the string
1120 * internally and set it on the object using elm_object_part_text_set(),
1121 * also storing the original string so that it can be automatically
1122 * translated when the language is changed with elm_language_set().
1124 * The @p domain will be stored along to find the translation in the
1125 * correct catalog. It can be NULL, in which case it will use whatever
1126 * domain was set by the application with @c textdomain(). This is useful
1127 * in case you are building a library on top of Elementary that will have
1128 * its own translatable strings, that should not be mixed with those of
1129 * programs using the library.
1131 * @param obj The object containing the text part
1132 * @param part The name of the part to set
1133 * @param domain The translation domain to use
1134 * @param text The original, non-translated text to set
1138 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1140 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1142 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1145 * Gets the original string set as translatable for an object
1147 * When setting translated strings, the function elm_object_part_text_get()
1148 * will return the translation returned by @c gettext(). To get the
1149 * original string use this function.
1151 * @param obj The object
1152 * @param part The name of the part that was set
1154 * @return The original, untranslated string
1158 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1160 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1163 * Set a content of an object
1165 * @param obj The Elementary object
1166 * @param part The content part name to set (NULL for the default content)
1167 * @param content The new content of the object
1169 * @note Elementary objects may have many contents
1170 * @deprecated Use elm_object_part_content_set instead.
1173 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1176 * Set a content of an object
1178 * @param obj The Elementary object
1179 * @param part The content part name to set (NULL for the default content)
1180 * @param content The new content of the object
1182 * @note Elementary objects may have many contents
1186 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1188 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1191 * Get a content of an object
1193 * @param obj The Elementary object
1194 * @param item The content part name to get (NULL for the default content)
1195 * @return content of the object or NULL for any error
1197 * @note Elementary objects may have many contents
1198 * @deprecated Use elm_object_part_content_get instead.
1201 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1204 * Get a content of an object
1206 * @param obj The Elementary object
1207 * @param item The content part name to get (NULL for the default content)
1208 * @return content of the object or NULL for any error
1210 * @note Elementary objects may have many contents
1214 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1216 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1219 * Unset a content of an object
1221 * @param obj The Elementary object
1222 * @param item The content part name to unset (NULL for the default content)
1224 * @note Elementary objects may have many contents
1225 * @deprecated Use elm_object_part_content_unset instead.
1228 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1231 * Unset a content of an object
1233 * @param obj The Elementary object
1234 * @param item The content part name to unset (NULL for the default content)
1236 * @note Elementary objects may have many contents
1240 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1242 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1245 * Set the text to read out when in accessibility mode
1247 * @param obj The object which is to be described
1248 * @param txt The text that describes the widget to people with poor or no vision
1252 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1255 * Get a named object from the children
1257 * @param obj The parent object whose children to look at
1258 * @param name The name of the child to find
1259 * @param recurse Set to thge maximum number of levels to recurse (0 == none, 1 is only look at 1 level of children etc.)
1260 * @return The found object of that name, or NULL if none is found
1262 * This function searches the children (or recursively children of
1263 * children and so on) of the given @p obj object looking for a child with
1264 * the name of @p name. If the child is found the object is returned, or
1265 * NULL is returned. You can set the name of an object with
1266 * evas_object_name_set(). If the name is not unique within the child
1267 * objects (or the tree is @p recurse is greater than 0) then it is
1268 * undefined as to which child of that name is returned, so ensure the name
1269 * is unique amongst children. If recurse is set to -1 it will recurse
1274 EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, const char *name, int recurse);
1277 * Get the widget object's handle which contains a given item
1279 * @param item The Elementary object item
1280 * @return The widget object
1282 * @note This returns the widget object itself that an item belongs to.
1286 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1289 * Set a content of an object item
1291 * @param it The Elementary object item
1292 * @param part The content part name to set (NULL for the default content)
1293 * @param content The new content of the object item
1295 * @note Elementary object items may have many contents
1296 * @deprecated Use elm_object_item_part_content_set instead.
1299 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1302 * Set a content of an object item
1304 * @param it The Elementary object item
1305 * @param part The content part name to set (NULL for the default content)
1306 * @param content The new content of the object item
1308 * @note Elementary object items may have many contents
1312 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1314 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1317 * Get a content of an object item
1319 * @param it The Elementary object item
1320 * @param part The content part name to unset (NULL for the default content)
1321 * @return content of the object item or NULL for any error
1323 * @note Elementary object items may have many contents
1324 * @deprecated Use elm_object_item_part_content_get instead.
1327 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1330 * Get a content of an object item
1332 * @param it The Elementary object item
1333 * @param part The content part name to unset (NULL for the default content)
1334 * @return content of the object item or NULL for any error
1336 * @note Elementary object items may have many contents
1340 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1342 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1345 * Unset a content of an object item
1347 * @param it The Elementary object item
1348 * @param part The content part name to unset (NULL for the default content)
1350 * @note Elementary object items may have many contents
1351 * @deprecated Use elm_object_item_part_content_unset instead.
1354 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1357 * Unset a content of an object item
1359 * @param it The Elementary object item
1360 * @param part The content part name to unset (NULL for the default content)
1362 * @note Elementary object items may have many contents
1366 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1368 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1371 * Set a label of an object item
1373 * @param it The Elementary object item
1374 * @param part The text part name to set (NULL for the default label)
1375 * @param label The new text of the label
1377 * @note Elementary object items may have many labels
1378 * @deprecated Use elm_object_item_part_text_set instead.
1381 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1384 * Set a label of an object item
1386 * @param it The Elementary object item
1387 * @param part The text part name to set (NULL for the default label)
1388 * @param label The new text of the label
1390 * @note Elementary object items may have many labels
1394 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1396 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1399 * Get a label of an object item
1401 * @param it The Elementary object item
1402 * @param part The text part name to get (NULL for the default label)
1403 * @return text of the label or NULL for any error
1405 * @note Elementary object items may have many labels
1406 * @deprecated Use elm_object_item_part_text_get instead.
1409 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1411 * Get a label of an object item
1413 * @param it The Elementary object item
1414 * @param part The text part name to get (NULL for the default label)
1415 * @return text of the label or NULL for any error
1417 * @note Elementary object items may have many labels
1421 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1423 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1426 * Set the text to read out when in accessibility mode
1428 * @param it The object item which is to be described
1429 * @param txt The text that describes the widget to people with poor or no vision
1433 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1436 * Get the data associated with an object item
1437 * @param it The Elementary object item
1438 * @return The data associated with @p it
1442 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1445 * Set the data associated with an object item
1446 * @param it The Elementary object item
1447 * @param data The data to be associated with @p it
1451 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1454 * Send a signal to the edje object of the widget item.
1456 * This function sends a signal to the edje object of the obj item. An
1457 * edje program can respond to a signal by specifying matching
1458 * 'signal' and 'source' fields.
1460 * @param it The Elementary object item
1461 * @param emission The signal's name.
1462 * @param source The signal's source.
1465 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1468 * Set the disabled state of an widget item.
1470 * @param obj The Elementary object item
1471 * @param disabled The state to put in in: @c EINA_TRUE for
1472 * disabled, @c EINA_FALSE for enabled
1474 * Elementary object item can be @b disabled, in which state they won't
1475 * receive input and, in general, will be themed differently from
1476 * their normal state, usually greyed out. Useful for contexts
1477 * where you don't want your users to interact with some of the
1478 * parts of you interface.
1480 * This sets the state for the widget item, either disabling it or
1485 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1488 * Get the disabled state of an widget item.
1490 * @param obj The Elementary object
1491 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1492 * if it's enabled (or on errors)
1494 * This gets the state of the widget, which might be enabled or disabled.
1498 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1505 * @defgroup Caches Caches
1507 * These are functions which let one fine-tune some cache values for
1508 * Elementary applications, thus allowing for performance adjustments.
1514 * @brief Flush all caches.
1516 * Frees all data that was in cache and is not currently being used to reduce
1517 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1518 * to calling all of the following functions:
1519 * @li edje_file_cache_flush()
1520 * @li edje_collection_cache_flush()
1521 * @li eet_clearcache()
1522 * @li evas_image_cache_flush()
1523 * @li evas_font_cache_flush()
1524 * @li evas_render_dump()
1525 * @note Evas caches are flushed for every canvas associated with a window.
1529 EAPI void elm_all_flush(void);
1532 * Get the configured cache flush interval time
1534 * This gets the globally configured cache flush interval time, in
1537 * @return The cache flush interval time
1540 * @see elm_all_flush()
1542 EAPI int elm_cache_flush_interval_get(void);
1545 * Set the configured cache flush interval time
1547 * This sets the globally configured cache flush interval time, in ticks
1549 * @param size The cache flush interval time
1552 * @see elm_all_flush()
1554 EAPI void elm_cache_flush_interval_set(int size);
1557 * Set the configured cache flush interval time for all applications on the
1560 * This sets the globally configured cache flush interval time -- in ticks
1561 * -- for all applications on the display.
1563 * @param size The cache flush interval time
1566 EAPI void elm_cache_flush_interval_all_set(int size);
1569 * Get the configured cache flush enabled state
1571 * This gets the globally configured cache flush state - if it is enabled
1572 * or not. When cache flushing is enabled, elementary will regularly
1573 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1574 * memory and allow usage to re-seed caches and data in memory where it
1575 * can do so. An idle application will thus minimise its memory usage as
1576 * data will be freed from memory and not be re-loaded as it is idle and
1577 * not rendering or doing anything graphically right now.
1579 * @return The cache flush state
1582 * @see elm_all_flush()
1584 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1587 * Set the configured cache flush enabled state
1589 * This sets the globally configured cache flush enabled state.
1591 * @param size The cache flush enabled state
1594 * @see elm_all_flush()
1596 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1599 * Set the configured cache flush enabled state for all applications on the
1602 * This sets the globally configured cache flush enabled state for all
1603 * applications on the display.
1605 * @param size The cache flush enabled state
1608 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1611 * Get the configured font cache size
1613 * This gets the globally configured font cache size, in bytes.
1615 * @return The font cache size
1618 EAPI int elm_font_cache_get(void);
1621 * Set the configured font cache size
1623 * This sets the globally configured font cache size, in bytes
1625 * @param size The font cache size
1628 EAPI void elm_font_cache_set(int size);
1631 * Set the configured font cache size for all applications on the
1634 * This sets the globally configured font cache size -- in bytes
1635 * -- for all applications on the display.
1637 * @param size The font cache size
1640 EAPI void elm_font_cache_all_set(int size);
1643 * Get the configured image cache size
1645 * This gets the globally configured image cache size, in bytes
1647 * @return The image cache size
1650 EAPI int elm_image_cache_get(void);
1653 * Set the configured image cache size
1655 * This sets the globally configured image cache size, in bytes
1657 * @param size The image cache size
1660 EAPI void elm_image_cache_set(int size);
1663 * Set the configured image cache size for all applications on the
1666 * This sets the globally configured image cache size -- in bytes
1667 * -- for all applications on the display.
1669 * @param size The image cache size
1672 EAPI void elm_image_cache_all_set(int size);
1675 * Get the configured edje file cache size.
1677 * This gets the globally configured edje file cache size, in number
1680 * @return The edje file cache size
1683 EAPI int elm_edje_file_cache_get(void);
1686 * Set the configured edje file cache size
1688 * This sets the globally configured edje file cache size, in number
1691 * @param size The edje file cache size
1694 EAPI void elm_edje_file_cache_set(int size);
1697 * Set the configured edje file cache size for all applications on the
1700 * This sets the globally configured edje file cache size -- in number
1701 * of files -- for all applications on the display.
1703 * @param size The edje file cache size
1706 EAPI void elm_edje_file_cache_all_set(int size);
1709 * Get the configured edje collections (groups) cache size.
1711 * This gets the globally configured edje collections cache size, in
1712 * number of collections.
1714 * @return The edje collections cache size
1717 EAPI int elm_edje_collection_cache_get(void);
1720 * Set the configured edje collections (groups) cache size
1722 * This sets the globally configured edje collections cache size, in
1723 * number of collections.
1725 * @param size The edje collections cache size
1728 EAPI void elm_edje_collection_cache_set(int size);
1731 * Set the configured edje collections (groups) cache size for all
1732 * applications on the display
1734 * This sets the globally configured edje collections cache size -- in
1735 * number of collections -- for all applications on the display.
1737 * @param size The edje collections cache size
1740 EAPI void elm_edje_collection_cache_all_set(int size);
1747 * @defgroup Scaling Widget Scaling
1749 * Different widgets can be scaled independently. These functions
1750 * allow you to manipulate this scaling on a per-widget basis. The
1751 * object and all its children get their scaling factors multiplied
1752 * by the scale factor set. This is multiplicative, in that if a
1753 * child also has a scale size set it is in turn multiplied by its
1754 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1755 * double size, @c 0.5 is half, etc.
1757 * @ref general_functions_example_page "This" example contemplates
1758 * some of these functions.
1762 * Get the global scaling factor
1764 * This gets the globally configured scaling factor that is applied to all
1767 * @return The scaling factor
1770 EAPI double elm_scale_get(void);
1773 * Set the global scaling factor
1775 * This sets the globally configured scaling factor that is applied to all
1778 * @param scale The scaling factor to set
1781 EAPI void elm_scale_set(double scale);
1784 * Set the global scaling factor for all applications on the display
1786 * This sets the globally configured scaling factor that is applied to all
1787 * objects for all applications.
1788 * @param scale The scaling factor to set
1791 EAPI void elm_scale_all_set(double scale);
1794 * Set the scaling factor for a given Elementary object
1796 * @param obj The Elementary to operate on
1797 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1802 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1805 * Get the scaling factor for a given Elementary object
1807 * @param obj The object
1808 * @return The scaling factor set by elm_object_scale_set()
1812 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1815 * @defgroup Password_last_show Password last input show
1817 * Last show feature of password mode enables user to view
1818 * the last input entered for few seconds before masking it.
1819 * These functions allow to set this feature in password mode
1820 * of entry widget and also allow to manipulate the duration
1821 * for which the input has to be visible.
1827 * Get show last setting of password mode.
1829 * This gets the show last input setting of password mode which might be
1830 * enabled or disabled.
1832 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1834 * @ingroup Password_last_show
1836 EAPI Eina_Bool elm_password_show_last_get(void);
1839 * Set show last setting in password mode.
1841 * This enables or disables show last setting of password mode.
1843 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1844 * @see elm_password_show_last_timeout_set()
1845 * @ingroup Password_last_show
1847 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1850 * Get's the timeout value in last show password mode.
1852 * This gets the time out value for which the last input entered in password
1853 * mode will be visible.
1855 * @return The timeout value of last show password mode.
1856 * @ingroup Password_last_show
1858 EAPI double elm_password_show_last_timeout_get(void);
1861 * Set's the timeout value in last show password mode.
1863 * This sets the time out value for which the last input entered in password
1864 * mode will be visible.
1866 * @param password_show_last_timeout The timeout value.
1867 * @see elm_password_show_last_set()
1868 * @ingroup Password_last_show
1870 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1877 * @defgroup UI-Mirroring Selective Widget mirroring
1879 * These functions allow you to set ui-mirroring on specific
1880 * widgets or the whole interface. Widgets can be in one of two
1881 * modes, automatic and manual. Automatic means they'll be changed
1882 * according to the system mirroring mode and manual means only
1883 * explicit changes will matter. You are not supposed to change
1884 * mirroring state of a widget set to automatic, will mostly work,
1885 * but the behavior is not really defined.
1890 EAPI Eina_Bool elm_mirrored_get(void);
1891 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1894 * Get the system mirrored mode. This determines the default mirrored mode
1897 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1899 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1902 * Set the system mirrored mode. This determines the default mirrored mode
1905 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1907 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1910 * Returns the widget's mirrored mode setting.
1912 * @param obj The widget.
1913 * @return mirrored mode setting of the object.
1916 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1919 * Sets the widget's mirrored mode setting.
1920 * When widget in automatic mode, it follows the system mirrored mode set by
1921 * elm_mirrored_set().
1922 * @param obj The widget.
1923 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1925 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1932 * Set the style to use by a widget
1934 * Sets the style name that will define the appearance of a widget. Styles
1935 * vary from widget to widget and may also be defined by other themes
1936 * by means of extensions and overlays.
1938 * @param obj The Elementary widget to style
1939 * @param style The style name to use
1941 * @see elm_theme_extension_add()
1942 * @see elm_theme_extension_del()
1943 * @see elm_theme_overlay_add()
1944 * @see elm_theme_overlay_del()
1948 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1950 * Get the style used by the widget
1952 * This gets the style being used for that widget. Note that the string
1953 * pointer is only valid as longas the object is valid and the style doesn't
1956 * @param obj The Elementary widget to query for its style
1957 * @return The style name used
1959 * @see elm_object_style_set()
1963 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1966 * @defgroup Styles Styles
1968 * Widgets can have different styles of look. These generic API's
1969 * set styles of widgets, if they support them (and if the theme(s)
1972 * @ref general_functions_example_page "This" example contemplates
1973 * some of these functions.
1977 * Set the disabled state of an Elementary object.
1979 * @param obj The Elementary object to operate on
1980 * @param disabled The state to put in in: @c EINA_TRUE for
1981 * disabled, @c EINA_FALSE for enabled
1983 * Elementary objects can be @b disabled, in which state they won't
1984 * receive input and, in general, will be themed differently from
1985 * their normal state, usually greyed out. Useful for contexts
1986 * where you don't want your users to interact with some of the
1987 * parts of you interface.
1989 * This sets the state for the widget, either disabling it or
1994 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1997 * Get the disabled state of an Elementary object.
1999 * @param obj The Elementary object to operate on
2000 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
2001 * if it's enabled (or on errors)
2003 * This gets the state of the widget, which might be enabled or disabled.
2007 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2010 * @defgroup WidgetNavigation Widget Tree Navigation.
2012 * How to check if an Evas Object is an Elementary widget? How to
2013 * get the first elementary widget that is parent of the given
2014 * object? These are all covered in widget tree navigation.
2016 * @ref general_functions_example_page "This" example contemplates
2017 * some of these functions.
2021 * Check if the given Evas Object is an Elementary widget.
2023 * @param obj the object to query.
2024 * @return @c EINA_TRUE if it is an elementary widget variant,
2025 * @c EINA_FALSE otherwise
2026 * @ingroup WidgetNavigation
2028 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2031 * Get the first parent of the given object that is an Elementary
2034 * @param obj the Elementary object to query parent from.
2035 * @return the parent object that is an Elementary widget, or @c
2036 * NULL, if it was not found.
2038 * Use this to query for an object's parent widget.
2040 * @note Most of Elementary users wouldn't be mixing non-Elementary
2041 * smart objects in the objects tree of an application, as this is
2042 * an advanced usage of Elementary with Evas. So, except for the
2043 * application's window, which is the root of that tree, all other
2044 * objects would have valid Elementary widget parents.
2046 * @ingroup WidgetNavigation
2048 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2051 * Get the top level parent of an Elementary widget.
2053 * @param obj The object to query.
2054 * @return The top level Elementary widget, or @c NULL if parent cannot be
2056 * @ingroup WidgetNavigation
2058 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2061 * Get the string that represents this Elementary widget.
2063 * @note Elementary is weird and exposes itself as a single
2064 * Evas_Object_Smart_Class of type "elm_widget", so
2065 * evas_object_type_get() always return that, making debug and
2066 * language bindings hard. This function tries to mitigate this
2067 * problem, but the solution is to change Elementary to use
2068 * proper inheritance.
2070 * @param obj the object to query.
2071 * @return Elementary widget name, or @c NULL if not a valid widget.
2072 * @ingroup WidgetNavigation
2074 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2077 * @defgroup Config Elementary Config
2079 * Elementary configuration is formed by a set options bounded to a
2080 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2081 * "finger size", etc. These are functions with which one syncronizes
2082 * changes made to those values to the configuration storing files, de
2083 * facto. You most probably don't want to use the functions in this
2084 * group unlees you're writing an elementary configuration manager.
2090 * Save back Elementary's configuration, so that it will persist on
2093 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2096 * This function will take effect -- thus, do I/O -- immediately. Use
2097 * it when you want to apply all configuration changes at once. The
2098 * current configuration set will get saved onto the current profile
2099 * configuration file.
2102 EAPI Eina_Bool elm_config_save(void);
2105 * Reload Elementary's configuration, bounded to current selected
2108 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2111 * Useful when you want to force reloading of configuration values for
2112 * a profile. If one removes user custom configuration directories,
2113 * for example, it will force a reload with system values instead.
2116 EAPI void elm_config_reload(void);
2123 * @defgroup Profile Elementary Profile
2125 * Profiles are pre-set options that affect the whole look-and-feel of
2126 * Elementary-based applications. There are, for example, profiles
2127 * aimed at desktop computer applications and others aimed at mobile,
2128 * touchscreen-based ones. You most probably don't want to use the
2129 * functions in this group unlees you're writing an elementary
2130 * configuration manager.
2136 * Get Elementary's profile in use.
2138 * This gets the global profile that is applied to all Elementary
2141 * @return The profile's name
2144 EAPI const char *elm_profile_current_get(void);
2147 * Get an Elementary's profile directory path in the filesystem. One
2148 * may want to fetch a system profile's dir or an user one (fetched
2151 * @param profile The profile's name
2152 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2153 * or a system one (@c EINA_FALSE)
2154 * @return The profile's directory path.
2157 * @note You must free it with elm_profile_dir_free().
2159 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2162 * Free an Elementary's profile directory path, as returned by
2163 * elm_profile_dir_get().
2165 * @param p_dir The profile's path
2169 EAPI void elm_profile_dir_free(const char *p_dir);
2172 * Get Elementary's list of available profiles.
2174 * @return The profiles list. List node data are the profile name
2178 * @note One must free this list, after usage, with the function
2179 * elm_profile_list_free().
2181 EAPI Eina_List *elm_profile_list_get(void);
2184 * Free Elementary's list of available profiles.
2186 * @param l The profiles list, as returned by elm_profile_list_get().
2190 EAPI void elm_profile_list_free(Eina_List *l);
2193 * Set Elementary's profile.
2195 * This sets the global profile that is applied to Elementary
2196 * applications. Just the process the call comes from will be
2199 * @param profile The profile's name
2203 EAPI void elm_profile_set(const char *profile);
2206 * Set Elementary's profile.
2208 * This sets the global profile that is applied to all Elementary
2209 * applications. All running Elementary windows will be affected.
2211 * @param profile The profile's name
2215 EAPI void elm_profile_all_set(const char *profile);
2222 * @defgroup Engine Elementary Engine
2224 * These are functions setting and querying which rendering engine
2225 * Elementary will use for drawing its windows' pixels.
2227 * The following are the available engines:
2228 * @li "software_x11"
2231 * @li "software_16_x11"
2232 * @li "software_8_x11"
2235 * @li "software_gdi"
2236 * @li "software_16_wince_gdi"
2238 * @li "software_16_sdl"
2242 * @li "opengl_cocoa"
2249 * @brief Get Elementary's rendering engine in use.
2251 * @return The rendering engine's name
2252 * @note there's no need to free the returned string, here.
2254 * This gets the global rendering engine that is applied to all Elementary
2257 * @see elm_engine_set()
2259 EAPI const char *elm_engine_current_get(void);
2262 * @brief Set Elementary's rendering engine for use.
2264 * @param engine The rendering engine's name
2266 * This sets global rendering engine that is applied to all Elementary
2267 * applications. Note that it will take effect only to Elementary windows
2268 * created after this is called.
2270 * @see elm_win_add()
2272 EAPI void elm_engine_set(const char *engine);
2279 * @defgroup Fonts Elementary Fonts
2281 * These are functions dealing with font rendering, selection and the
2282 * like for Elementary applications. One might fetch which system
2283 * fonts are there to use and set custom fonts for individual classes
2284 * of UI items containing text (text classes).
2289 typedef struct _Elm_Text_Class
2295 typedef struct _Elm_Font_Overlay
2297 const char *text_class;
2299 Evas_Font_Size size;
2302 typedef struct _Elm_Font_Properties
2306 } Elm_Font_Properties;
2309 * Get Elementary's list of supported text classes.
2311 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2314 * Release the list with elm_text_classes_list_free().
2316 EAPI const Eina_List *elm_text_classes_list_get(void);
2319 * Free Elementary's list of supported text classes.
2323 * @see elm_text_classes_list_get().
2325 EAPI void elm_text_classes_list_free(const Eina_List *list);
2328 * Get Elementary's list of font overlays, set with
2329 * elm_font_overlay_set().
2331 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2336 * For each text class, one can set a <b>font overlay</b> for it,
2337 * overriding the default font properties for that class coming from
2338 * the theme in use. There is no need to free this list.
2340 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2342 EAPI const Eina_List *elm_font_overlay_list_get(void);
2345 * Set a font overlay for a given Elementary text class.
2347 * @param text_class Text class name
2348 * @param font Font name and style string
2349 * @param size Font size
2353 * @p font has to be in the format returned by
2354 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2355 * and elm_font_overlay_unset().
2357 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2360 * Unset a font overlay for a given Elementary text class.
2362 * @param text_class Text class name
2366 * This will bring back text elements belonging to text class
2367 * @p text_class back to their default font settings.
2369 EAPI void elm_font_overlay_unset(const char *text_class);
2372 * Apply the changes made with elm_font_overlay_set() and
2373 * elm_font_overlay_unset() on the current Elementary window.
2377 * This applies all font overlays set to all objects in the UI.
2379 EAPI void elm_font_overlay_apply(void);
2382 * Apply the changes made with elm_font_overlay_set() and
2383 * elm_font_overlay_unset() on all Elementary application windows.
2387 * This applies all font overlays set to all objects in the UI.
2389 EAPI void elm_font_overlay_all_apply(void);
2392 * Translate a font (family) name string in fontconfig's font names
2393 * syntax into an @c Elm_Font_Properties struct.
2395 * @param font The font name and styles string
2396 * @return the font properties struct
2400 * @note The reverse translation can be achived with
2401 * elm_font_fontconfig_name_get(), for one style only (single font
2402 * instance, not family).
2404 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2407 * Free font properties return by elm_font_properties_get().
2409 * @param efp the font properties struct
2413 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2416 * Translate a font name, bound to a style, into fontconfig's font names
2419 * @param name The font (family) name
2420 * @param style The given style (may be @c NULL)
2422 * @return the font name and style string
2426 * @note The reverse translation can be achived with
2427 * elm_font_properties_get(), for one style only (single font
2428 * instance, not family).
2430 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2433 * Free the font string return by elm_font_fontconfig_name_get().
2435 * @param efp the font properties struct
2439 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2442 * Create a font hash table of available system fonts.
2444 * One must call it with @p list being the return value of
2445 * evas_font_available_list(). The hash will be indexed by font
2446 * (family) names, being its values @c Elm_Font_Properties blobs.
2448 * @param list The list of available system fonts, as returned by
2449 * evas_font_available_list().
2450 * @return the font hash.
2454 * @note The user is supposed to get it populated at least with 3
2455 * default font families (Sans, Serif, Monospace), which should be
2456 * present on most systems.
2458 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2461 * Free the hash return by elm_font_available_hash_add().
2463 * @param hash the hash to be freed.
2467 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2474 * @defgroup Fingers Fingers
2476 * Elementary is designed to be finger-friendly for touchscreens,
2477 * and so in addition to scaling for display resolution, it can
2478 * also scale based on finger "resolution" (or size). You can then
2479 * customize the granularity of the areas meant to receive clicks
2482 * Different profiles may have pre-set values for finger sizes.
2484 * @ref general_functions_example_page "This" example contemplates
2485 * some of these functions.
2491 * Get the configured "finger size"
2493 * @return The finger size
2495 * This gets the globally configured finger size, <b>in pixels</b>
2499 EAPI Evas_Coord elm_finger_size_get(void);
2502 * Set the configured finger size
2504 * This sets the globally configured finger size in pixels
2506 * @param size The finger size
2509 EAPI void elm_finger_size_set(Evas_Coord size);
2512 * Set the configured finger size for all applications on the display
2514 * This sets the globally configured finger size in pixels for all
2515 * applications on the display
2517 * @param size The finger size
2520 EAPI void elm_finger_size_all_set(Evas_Coord size);
2527 * @defgroup Focus Focus
2529 * An Elementary application has, at all times, one (and only one)
2530 * @b focused object. This is what determines where the input
2531 * events go to within the application's window. Also, focused
2532 * objects can be decorated differently, in order to signal to the
2533 * user where the input is, at a given moment.
2535 * Elementary applications also have the concept of <b>focus
2536 * chain</b>: one can cycle through all the windows' focusable
2537 * objects by input (tab key) or programmatically. The default
2538 * focus chain for an application is the one define by the order in
2539 * which the widgets where added in code. One will cycle through
2540 * top level widgets, and, for each one containg sub-objects, cycle
2541 * through them all, before returning to the level
2542 * above. Elementary also allows one to set @b custom focus chains
2543 * for their applications.
2545 * Besides the focused decoration a widget may exhibit, when it
2546 * gets focus, Elementary has a @b global focus highlight object
2547 * that can be enabled for a window. If one chooses to do so, this
2548 * extra highlight effect will surround the current focused object,
2551 * @note Some Elementary widgets are @b unfocusable, after
2552 * creation, by their very nature: they are not meant to be
2553 * interacted with input events, but are there just for visual
2556 * @ref general_functions_example_page "This" example contemplates
2557 * some of these functions.
2561 * Get the enable status of the focus highlight
2563 * This gets whether the highlight on focused objects is enabled or not
2566 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2569 * Set the enable status of the focus highlight
2571 * Set whether to show or not the highlight on focused objects
2572 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2575 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2578 * Get the enable status of the highlight animation
2580 * Get whether the focus highlight, if enabled, will animate its switch from
2581 * one object to the next
2584 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2587 * Set the enable status of the highlight animation
2589 * Set whether the focus highlight, if enabled, will animate its switch from
2590 * one object to the next
2591 * @param animate Enable animation if EINA_TRUE, disable otherwise
2594 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2597 * Get the whether an Elementary object has the focus or not.
2599 * @param obj The Elementary object to get the information from
2600 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2601 * not (and on errors).
2603 * @see elm_object_focus_set()
2607 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2610 * Set/unset focus to a given Elementary object.
2612 * @param obj The Elementary object to operate on.
2613 * @param enable @c EINA_TRUE Set focus to a given object,
2614 * @c EINA_FALSE Unset focus to a given object.
2616 * @note When you set focus to this object, if it can handle focus, will
2617 * take the focus away from the one who had it previously and will, for
2618 * now on, be the one receiving input events. Unsetting focus will remove
2619 * the focus from @p obj, passing it back to the previous element in the
2622 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2626 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2629 * Make a given Elementary object the focused one.
2631 * @param obj The Elementary object to make focused.
2633 * @note This object, if it can handle focus, will take the focus
2634 * away from the one who had it previously and will, for now on, be
2635 * the one receiving input events.
2637 * @see elm_object_focus_get()
2638 * @deprecated use elm_object_focus_set() instead.
2642 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2645 * Remove the focus from an Elementary object
2647 * @param obj The Elementary to take focus from
2649 * This removes the focus from @p obj, passing it back to the
2650 * previous element in the focus chain list.
2652 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2653 * @deprecated use elm_object_focus_set() instead.
2657 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2660 * Set the ability for an Element object to be focused
2662 * @param obj The Elementary object to operate on
2663 * @param enable @c EINA_TRUE if the object can be focused, @c
2664 * EINA_FALSE if not (and on errors)
2666 * This sets whether the object @p obj is able to take focus or
2667 * not. Unfocusable objects do nothing when programmatically
2668 * focused, being the nearest focusable parent object the one
2669 * really getting focus. Also, when they receive mouse input, they
2670 * will get the event, but not take away the focus from where it
2675 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2678 * Get whether an Elementary object is focusable or not
2680 * @param obj The Elementary object to operate on
2681 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2682 * EINA_FALSE if not (and on errors)
2684 * @note Objects which are meant to be interacted with by input
2685 * events are created able to be focused, by default. All the
2690 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2693 * Set custom focus chain.
2695 * This function overwrites any previous custom focus chain within
2696 * the list of objects. The previous list will be deleted and this list
2697 * will be managed by elementary. After it is set, don't modify it.
2699 * @note On focus cycle, only will be evaluated children of this container.
2701 * @param obj The container object
2702 * @param objs Chain of objects to pass focus
2705 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2708 * Unset a custom focus chain on a given Elementary widget
2710 * @param obj The container object to remove focus chain from
2712 * Any focus chain previously set on @p obj (for its child objects)
2713 * is removed entirely after this call.
2717 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2720 * Get custom focus chain
2722 * @param obj The container object
2725 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2728 * Append object to custom focus chain.
2730 * @note If relative_child equal to NULL or not in custom chain, the object
2731 * will be added in end.
2733 * @note On focus cycle, only will be evaluated children of this container.
2735 * @param obj The container object
2736 * @param child The child to be added in custom chain
2737 * @param relative_child The relative object to position the child
2740 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2743 * Prepend object to custom focus chain.
2745 * @note If relative_child equal to NULL or not in custom chain, the object
2746 * will be added in begin.
2748 * @note On focus cycle, only will be evaluated children of this container.
2750 * @param obj The container object
2751 * @param child The child to be added in custom chain
2752 * @param relative_child The relative object to position the child
2755 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2758 * Give focus to next object in object tree.
2760 * Give focus to next object in focus chain of one object sub-tree.
2761 * If the last object of chain already have focus, the focus will go to the
2762 * first object of chain.
2764 * @param obj The object root of sub-tree
2765 * @param dir Direction to cycle the focus
2769 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2772 * Give focus to near object in one direction.
2774 * Give focus to near object in direction of one object.
2775 * If none focusable object in given direction, the focus will not change.
2777 * @param obj The reference object
2778 * @param x Horizontal component of direction to focus
2779 * @param y Vertical component of direction to focus
2783 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2786 * Make the elementary object and its children to be unfocusable
2789 * @param obj The Elementary object to operate on
2790 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2791 * @c EINA_FALSE for focusable.
2793 * This sets whether the object @p obj and its children objects
2794 * are able to take focus or not. If the tree is set as unfocusable,
2795 * newest focused object which is not in this tree will get focus.
2796 * This API can be helpful for an object to be deleted.
2797 * When an object will be deleted soon, it and its children may not
2798 * want to get focus (by focus reverting or by other focus controls).
2799 * Then, just use this API before deleting.
2801 * @see elm_object_tree_unfocusable_get()
2805 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2808 * Get whether an Elementary object and its children are unfocusable or not.
2810 * @param obj The Elementary object to get the information from
2811 * @return @c EINA_TRUE, if the tree is unfocussable,
2812 * @c EINA_FALSE if not (and on errors).
2814 * @see elm_object_tree_unfocusable_set()
2818 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2821 * @defgroup Scrolling Scrolling
2823 * These are functions setting how scrollable views in Elementary
2824 * widgets should behave on user interaction.
2830 * Get whether scrollers should bounce when they reach their
2831 * viewport's edge during a scroll.
2833 * @return the thumb scroll bouncing state
2835 * This is the default behavior for touch screens, in general.
2836 * @ingroup Scrolling
2838 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2841 * Set whether scrollers should bounce when they reach their
2842 * viewport's edge during a scroll.
2844 * @param enabled the thumb scroll bouncing state
2846 * @see elm_thumbscroll_bounce_enabled_get()
2847 * @ingroup Scrolling
2849 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2852 * Set whether scrollers should bounce when they reach their
2853 * viewport's edge during a scroll, for all Elementary application
2856 * @param enabled the thumb scroll bouncing state
2858 * @see elm_thumbscroll_bounce_enabled_get()
2859 * @ingroup Scrolling
2861 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2864 * Get the amount of inertia a scroller will impose at bounce
2867 * @return the thumb scroll bounce friction
2869 * @ingroup Scrolling
2871 EAPI double elm_scroll_bounce_friction_get(void);
2874 * Set the amount of inertia a scroller will impose at bounce
2877 * @param friction the thumb scroll bounce friction
2879 * @see elm_thumbscroll_bounce_friction_get()
2880 * @ingroup Scrolling
2882 EAPI void elm_scroll_bounce_friction_set(double friction);
2885 * Set the amount of inertia a scroller will impose at bounce
2886 * animations, for all Elementary application windows.
2888 * @param friction the thumb scroll bounce friction
2890 * @see elm_thumbscroll_bounce_friction_get()
2891 * @ingroup Scrolling
2893 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2896 * Get the amount of inertia a <b>paged</b> scroller will impose at
2897 * page fitting animations.
2899 * @return the page scroll friction
2901 * @ingroup Scrolling
2903 EAPI double elm_scroll_page_scroll_friction_get(void);
2906 * Set the amount of inertia a <b>paged</b> scroller will impose at
2907 * page fitting animations.
2909 * @param friction the page scroll friction
2911 * @see elm_thumbscroll_page_scroll_friction_get()
2912 * @ingroup Scrolling
2914 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2917 * Set the amount of inertia a <b>paged</b> scroller will impose at
2918 * page fitting animations, for all Elementary application windows.
2920 * @param friction the page scroll friction
2922 * @see elm_thumbscroll_page_scroll_friction_get()
2923 * @ingroup Scrolling
2925 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2928 * Get the amount of inertia a scroller will impose at region bring
2931 * @return the bring in scroll friction
2933 * @ingroup Scrolling
2935 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2938 * Set the amount of inertia a scroller will impose at region bring
2941 * @param friction the bring in scroll friction
2943 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2944 * @ingroup Scrolling
2946 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2949 * Set the amount of inertia a scroller will impose at region bring
2950 * animations, for all Elementary application windows.
2952 * @param friction the bring in scroll friction
2954 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2955 * @ingroup Scrolling
2957 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2960 * Get the amount of inertia scrollers will impose at animations
2961 * triggered by Elementary widgets' zooming API.
2963 * @return the zoom friction
2965 * @ingroup Scrolling
2967 EAPI double elm_scroll_zoom_friction_get(void);
2970 * Set the amount of inertia scrollers will impose at animations
2971 * triggered by Elementary widgets' zooming API.
2973 * @param friction the zoom friction
2975 * @see elm_thumbscroll_zoom_friction_get()
2976 * @ingroup Scrolling
2978 EAPI void elm_scroll_zoom_friction_set(double friction);
2981 * Set the amount of inertia scrollers will impose at animations
2982 * triggered by Elementary widgets' zooming API, for all Elementary
2983 * application windows.
2985 * @param friction the zoom friction
2987 * @see elm_thumbscroll_zoom_friction_get()
2988 * @ingroup Scrolling
2990 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2993 * Get whether scrollers should be draggable from any point in their
2996 * @return the thumb scroll state
2998 * @note This is the default behavior for touch screens, in general.
2999 * @note All other functions namespaced with "thumbscroll" will only
3000 * have effect if this mode is enabled.
3002 * @ingroup Scrolling
3004 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
3007 * Set whether scrollers should be draggable from any point in their
3010 * @param enabled the thumb scroll state
3012 * @see elm_thumbscroll_enabled_get()
3013 * @ingroup Scrolling
3015 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
3018 * Set whether scrollers should be draggable from any point in their
3019 * views, for all Elementary application windows.
3021 * @param enabled the thumb scroll state
3023 * @see elm_thumbscroll_enabled_get()
3024 * @ingroup Scrolling
3026 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3029 * Get the number of pixels one should travel while dragging a
3030 * scroller's view to actually trigger scrolling.
3032 * @return the thumb scroll threshould
3034 * One would use higher values for touch screens, in general, because
3035 * of their inherent imprecision.
3036 * @ingroup Scrolling
3038 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
3041 * Set the number of pixels one should travel while dragging a
3042 * scroller's view to actually trigger scrolling.
3044 * @param threshold the thumb scroll threshould
3046 * @see elm_thumbscroll_threshould_get()
3047 * @ingroup Scrolling
3049 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3052 * Set the number of pixels one should travel while dragging a
3053 * scroller's view to actually trigger scrolling, for all Elementary
3054 * application windows.
3056 * @param threshold the thumb scroll threshould
3058 * @see elm_thumbscroll_threshould_get()
3059 * @ingroup Scrolling
3061 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3064 * Get the minimum speed of mouse cursor movement which will trigger
3065 * list self scrolling animation after a mouse up event
3068 * @return the thumb scroll momentum threshould
3070 * @ingroup Scrolling
3072 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
3075 * Set the minimum speed of mouse cursor movement which will trigger
3076 * list self scrolling animation after a mouse up event
3079 * @param threshold the thumb scroll momentum threshould
3081 * @see elm_thumbscroll_momentum_threshould_get()
3082 * @ingroup Scrolling
3084 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3087 * Set the minimum speed of mouse cursor movement which will trigger
3088 * list self scrolling animation after a mouse up event
3089 * (pixels/second), for all Elementary application windows.
3091 * @param threshold the thumb scroll momentum threshould
3093 * @see elm_thumbscroll_momentum_threshould_get()
3094 * @ingroup Scrolling
3096 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3099 * Get the amount of inertia a scroller will impose at self scrolling
3102 * @return the thumb scroll friction
3104 * @ingroup Scrolling
3106 EAPI double elm_scroll_thumbscroll_friction_get(void);
3109 * Set the amount of inertia a scroller will impose at self scrolling
3112 * @param friction the thumb scroll friction
3114 * @see elm_thumbscroll_friction_get()
3115 * @ingroup Scrolling
3117 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3120 * Set the amount of inertia a scroller will impose at self scrolling
3121 * animations, for all Elementary application windows.
3123 * @param friction the thumb scroll friction
3125 * @see elm_thumbscroll_friction_get()
3126 * @ingroup Scrolling
3128 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3131 * Get the amount of lag between your actual mouse cursor dragging
3132 * movement and a scroller's view movement itself, while pushing it
3133 * into bounce state manually.
3135 * @return the thumb scroll border friction
3137 * @ingroup Scrolling
3139 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3142 * Set the amount of lag between your actual mouse cursor dragging
3143 * movement and a scroller's view movement itself, while pushing it
3144 * into bounce state manually.
3146 * @param friction the thumb scroll border friction. @c 0.0 for
3147 * perfect synchrony between two movements, @c 1.0 for maximum
3150 * @see elm_thumbscroll_border_friction_get()
3151 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3153 * @ingroup Scrolling
3155 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3158 * Set the amount of lag between your actual mouse cursor dragging
3159 * movement and a scroller's view movement itself, while pushing it
3160 * into bounce state manually, for all Elementary application windows.
3162 * @param friction the thumb scroll border friction. @c 0.0 for
3163 * perfect synchrony between two movements, @c 1.0 for maximum
3166 * @see elm_thumbscroll_border_friction_get()
3167 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3169 * @ingroup Scrolling
3171 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3174 * Get the sensitivity amount which is be multiplied by the length of
3177 * @return the thumb scroll sensitivity friction
3179 * @ingroup Scrolling
3181 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3184 * Set the sensitivity amount which is be multiplied by the length of
3187 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3188 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3191 * @see elm_thumbscroll_sensitivity_friction_get()
3192 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3194 * @ingroup Scrolling
3196 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3199 * Set the sensitivity amount which is be multiplied by the length of
3200 * mouse dragging, for all Elementary application windows.
3202 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3203 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3206 * @see elm_thumbscroll_sensitivity_friction_get()
3207 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3209 * @ingroup Scrolling
3211 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3218 * @defgroup Scrollhints Scrollhints
3220 * Objects when inside a scroller can scroll, but this may not always be
3221 * desirable in certain situations. This allows an object to hint to itself
3222 * and parents to "not scroll" in one of 2 ways. If any child object of a
3223 * scroller has pushed a scroll freeze or hold then it affects all parent
3224 * scrollers until all children have released them.
3226 * 1. To hold on scrolling. This means just flicking and dragging may no
3227 * longer scroll, but pressing/dragging near an edge of the scroller will
3228 * still scroll. This is automatically used by the entry object when
3231 * 2. To totally freeze scrolling. This means it stops. until
3238 * Push the scroll hold by 1
3240 * This increments the scroll hold count by one. If it is more than 0 it will
3241 * take effect on the parents of the indicated object.
3243 * @param obj The object
3244 * @ingroup Scrollhints
3246 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3249 * Pop the scroll hold by 1
3251 * This decrements the scroll hold count by one. If it is more than 0 it will
3252 * take effect on the parents of the indicated object.
3254 * @param obj The object
3255 * @ingroup Scrollhints
3257 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3260 * Push the scroll freeze by 1
3262 * This increments the scroll freeze count by one. If it is more
3263 * than 0 it will take effect on the parents of the indicated
3266 * @param obj The object
3267 * @ingroup Scrollhints
3269 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3272 * Pop the scroll freeze by 1
3274 * This decrements the scroll freeze count by one. If it is more
3275 * than 0 it will take effect on the parents of the indicated
3278 * @param obj The object
3279 * @ingroup Scrollhints
3281 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3284 * Lock the scrolling of the given widget (and thus all parents)
3286 * This locks the given object from scrolling in the X axis (and implicitly
3287 * also locks all parent scrollers too from doing the same).
3289 * @param obj The object
3290 * @param lock The lock state (1 == locked, 0 == unlocked)
3291 * @ingroup Scrollhints
3293 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3296 * Lock the scrolling of the given widget (and thus all parents)
3298 * This locks the given object from scrolling in the Y axis (and implicitly
3299 * also locks all parent scrollers too from doing the same).
3301 * @param obj The object
3302 * @param lock The lock state (1 == locked, 0 == unlocked)
3303 * @ingroup Scrollhints
3305 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3308 * Get the scrolling lock of the given widget
3310 * This gets the lock for X axis scrolling.
3312 * @param obj The object
3313 * @ingroup Scrollhints
3315 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3318 * Get the scrolling lock of the given widget
3320 * This gets the lock for X axis scrolling.
3322 * @param obj The object
3323 * @ingroup Scrollhints
3325 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3332 * Send a signal to the widget edje object.
3334 * This function sends a signal to the edje object of the obj. An
3335 * edje program can respond to a signal by specifying matching
3336 * 'signal' and 'source' fields.
3338 * @param obj The object
3339 * @param emission The signal's name.
3340 * @param source The signal's source.
3343 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3346 * Add a callback for a signal emitted by widget edje object.
3348 * This function connects a callback function to a signal emitted by the
3349 * edje object of the obj.
3350 * Globs can occur in either the emission or source name.
3352 * @param obj The object
3353 * @param emission The signal's name.
3354 * @param source The signal's source.
3355 * @param func The callback function to be executed when the signal is
3357 * @param data A pointer to data to pass in to the callback function.
3360 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);
3363 * Remove a signal-triggered callback from a widget edje object.
3365 * This function removes a callback, previoulsy attached to a
3366 * signal emitted by the edje object of the obj. The parameters
3367 * emission, source and func must match exactly those passed to a
3368 * previous call to elm_object_signal_callback_add(). The data
3369 * pointer that was passed to this call will be returned.
3371 * @param obj The object
3372 * @param emission The signal's name.
3373 * @param source The signal's source.
3374 * @param func The callback function to be executed when the signal is
3376 * @return The data pointer
3379 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);
3382 * Add a callback for input events (key up, key down, mouse wheel)
3383 * on a given Elementary widget
3385 * @param obj The widget to add an event callback on
3386 * @param func The callback function to be executed when the event
3388 * @param data Data to pass in to @p func
3390 * Every widget in an Elementary interface set to receive focus,
3391 * with elm_object_focus_allow_set(), will propagate @b all of its
3392 * key up, key down and mouse wheel input events up to its parent
3393 * object, and so on. All of the focusable ones in this chain which
3394 * had an event callback set, with this call, will be able to treat
3395 * those events. There are two ways of making the propagation of
3396 * these event upwards in the tree of widgets to @b cease:
3397 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3398 * the event was @b not processed, so the propagation will go on.
3399 * - The @c event_info pointer passed to @p func will contain the
3400 * event's structure and, if you OR its @c event_flags inner
3401 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3402 * one has already handled it, thus killing the event's
3405 * @note Your event callback will be issued on those events taking
3406 * place only if no other child widget of @obj has consumed the
3409 * @note Not to be confused with @c
3410 * evas_object_event_callback_add(), which will add event callbacks
3411 * per type on general Evas objects (no event propagation
3412 * infrastructure taken in account).
3414 * @note Not to be confused with @c
3415 * elm_object_signal_callback_add(), which will add callbacks to @b
3416 * signals coming from a widget's theme, not input events.
3418 * @note Not to be confused with @c
3419 * edje_object_signal_callback_add(), which does the same as
3420 * elm_object_signal_callback_add(), but directly on an Edje
3423 * @note Not to be confused with @c
3424 * evas_object_smart_callback_add(), which adds callbacks to smart
3425 * objects' <b>smart events</b>, and not input events.
3427 * @see elm_object_event_callback_del()
3431 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3434 * Remove an event callback from a widget.
3436 * This function removes a callback, previoulsy attached to event emission
3438 * The parameters func and data must match exactly those passed to
3439 * a previous call to elm_object_event_callback_add(). The data pointer that
3440 * was passed to this call will be returned.
3442 * @param obj The object
3443 * @param func The callback function to be executed when the event is
3445 * @param data Data to pass in to the callback function.
3446 * @return The data pointer
3449 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3452 * Adjust size of an element for finger usage.
3454 * @param times_w How many fingers should fit horizontally
3455 * @param w Pointer to the width size to adjust
3456 * @param times_h How many fingers should fit vertically
3457 * @param h Pointer to the height size to adjust
3459 * This takes width and height sizes (in pixels) as input and a
3460 * size multiple (which is how many fingers you want to place
3461 * within the area, being "finger" the size set by
3462 * elm_finger_size_set()), and adjusts the size to be large enough
3463 * to accommodate the resulting size -- if it doesn't already
3464 * accommodate it. On return the @p w and @p h sizes pointed to by
3465 * these parameters will be modified, on those conditions.
3467 * @note This is kind of a low level Elementary call, most useful
3468 * on size evaluation times for widgets. An external user wouldn't
3469 * be calling, most of the time.
3473 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3476 * Get the duration for occuring long press event.
3478 * @return Timeout for long press event
3479 * @ingroup Longpress
3481 EAPI double elm_longpress_timeout_get(void);
3484 * Set the duration for occuring long press event.
3486 * @param lonpress_timeout Timeout for long press event
3487 * @ingroup Longpress
3489 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3492 * @defgroup Debug Debug
3493 * don't use it unless you are sure
3499 * Print Tree object hierarchy in stdout
3501 * @param obj The root object
3504 EAPI void elm_object_tree_dump(const Evas_Object *top);
3507 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3509 * @param obj The root object
3510 * @param file The path of output file
3513 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3520 * @defgroup Theme Theme
3522 * Elementary uses Edje to theme its widgets, naturally. But for the most
3523 * part this is hidden behind a simpler interface that lets the user set
3524 * extensions and choose the style of widgets in a much easier way.
3526 * Instead of thinking in terms of paths to Edje files and their groups
3527 * each time you want to change the appearance of a widget, Elementary
3528 * works so you can add any theme file with extensions or replace the
3529 * main theme at one point in the application, and then just set the style
3530 * of widgets with elm_object_style_set() and related functions. Elementary
3531 * will then look in its list of themes for a matching group and apply it,
3532 * and when the theme changes midway through the application, all widgets
3533 * will be updated accordingly.
3535 * There are three concepts you need to know to understand how Elementary
3536 * theming works: default theme, extensions and overlays.
3538 * Default theme, obviously enough, is the one that provides the default
3539 * look of all widgets. End users can change the theme used by Elementary
3540 * by setting the @c ELM_THEME environment variable before running an
3541 * application, or globally for all programs using the @c elementary_config
3542 * utility. Applications can change the default theme using elm_theme_set(),
3543 * but this can go against the user wishes, so it's not an adviced practice.
3545 * Ideally, applications should find everything they need in the already
3546 * provided theme, but there may be occasions when that's not enough and
3547 * custom styles are required to correctly express the idea. For this
3548 * cases, Elementary has extensions.
3550 * Extensions allow the application developer to write styles of its own
3551 * to apply to some widgets. This requires knowledge of how each widget
3552 * is themed, as extensions will always replace the entire group used by
3553 * the widget, so important signals and parts need to be there for the
3554 * object to behave properly (see documentation of Edje for details).
3555 * Once the theme for the extension is done, the application needs to add
3556 * it to the list of themes Elementary will look into, using
3557 * elm_theme_extension_add(), and set the style of the desired widgets as
3558 * he would normally with elm_object_style_set().
3560 * Overlays, on the other hand, can replace the look of all widgets by
3561 * overriding the default style. Like extensions, it's up to the application
3562 * developer to write the theme for the widgets it wants, the difference
3563 * being that when looking for the theme, Elementary will check first the
3564 * list of overlays, then the set theme and lastly the list of extensions,
3565 * so with overlays it's possible to replace the default view and every
3566 * widget will be affected. This is very much alike to setting the whole
3567 * theme for the application and will probably clash with the end user
3568 * options, not to mention the risk of ending up with not matching styles
3569 * across the program. Unless there's a very special reason to use them,
3570 * overlays should be avoided for the resons exposed before.
3572 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3573 * keeps one default internally and every function that receives one of
3574 * these can be called with NULL to refer to this default (except for
3575 * elm_theme_free()). It's possible to create a new instance of a
3576 * ::Elm_Theme to set other theme for a specific widget (and all of its
3577 * children), but this is as discouraged, if not even more so, than using
3578 * overlays. Don't use this unless you really know what you are doing.
3580 * But to be less negative about things, you can look at the following
3582 * @li @ref theme_example_01 "Using extensions"
3583 * @li @ref theme_example_02 "Using overlays"
3588 * @typedef Elm_Theme
3590 * Opaque handler for the list of themes Elementary looks for when
3591 * rendering widgets.
3593 * Stay out of this unless you really know what you are doing. For most
3594 * cases, sticking to the default is all a developer needs.
3596 typedef struct _Elm_Theme Elm_Theme;
3599 * Create a new specific theme
3601 * This creates an empty specific theme that only uses the default theme. A
3602 * specific theme has its own private set of extensions and overlays too
3603 * (which are empty by default). Specific themes do not fall back to themes
3604 * of parent objects. They are not intended for this use. Use styles, overlays
3605 * and extensions when needed, but avoid specific themes unless there is no
3606 * other way (example: you want to have a preview of a new theme you are
3607 * selecting in a "theme selector" window. The preview is inside a scroller
3608 * and should display what the theme you selected will look like, but not
3609 * actually apply it yet. The child of the scroller will have a specific
3610 * theme set to show this preview before the user decides to apply it to all
3613 EAPI Elm_Theme *elm_theme_new(void);
3616 * Free a specific theme
3618 * @param th The theme to free
3620 * This frees a theme created with elm_theme_new().
3622 EAPI void elm_theme_free(Elm_Theme *th);
3625 * Copy the theme fom the source to the destination theme
3627 * @param th The source theme to copy from
3628 * @param thdst The destination theme to copy data to
3630 * This makes a one-time static copy of all the theme config, extensions
3631 * and overlays from @p th to @p thdst. If @p th references a theme, then
3632 * @p thdst is also set to reference it, with all the theme settings,
3633 * overlays and extensions that @p th had.
3635 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3638 * Tell the source theme to reference the ref theme
3640 * @param th The theme that will do the referencing
3641 * @param thref The theme that is the reference source
3643 * This clears @p th to be empty and then sets it to refer to @p thref
3644 * so @p th acts as an override to @p thref, but where its overrides
3645 * don't apply, it will fall through to @p thref for configuration.
3647 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3650 * Return the theme referred to
3652 * @param th The theme to get the reference from
3653 * @return The referenced theme handle
3655 * This gets the theme set as the reference theme by elm_theme_ref_set().
3656 * If no theme is set as a reference, NULL is returned.
3658 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3661 * Return the default theme
3663 * @return The default theme handle
3665 * This returns the internal default theme setup handle that all widgets
3666 * use implicitly unless a specific theme is set. This is also often use
3667 * as a shorthand of NULL.
3669 EAPI Elm_Theme *elm_theme_default_get(void);
3672 * Prepends a theme overlay to the list of overlays
3674 * @param th The theme to add to, or if NULL, the default theme
3675 * @param item The Edje file path to be used
3677 * Use this if your application needs to provide some custom overlay theme
3678 * (An Edje file that replaces some default styles of widgets) where adding
3679 * new styles, or changing system theme configuration is not possible. Do
3680 * NOT use this instead of a proper system theme configuration. Use proper
3681 * configuration files, profiles, environment variables etc. to set a theme
3682 * so that the theme can be altered by simple confiugration by a user. Using
3683 * this call to achieve that effect is abusing the API and will create lots
3686 * @see elm_theme_extension_add()
3688 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3691 * Delete a theme overlay from the list of overlays
3693 * @param th The theme to delete from, or if NULL, the default theme
3694 * @param item The name of the theme overlay
3696 * @see elm_theme_overlay_add()
3698 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3701 * Appends a theme extension to the list of extensions.
3703 * @param th The theme to add to, or if NULL, the default theme
3704 * @param item The Edje file path to be used
3706 * This is intended when an application needs more styles of widgets or new
3707 * widget themes that the default does not provide (or may not provide). The
3708 * application has "extended" usage by coming up with new custom style names
3709 * for widgets for specific uses, but as these are not "standard", they are
3710 * not guaranteed to be provided by a default theme. This means the
3711 * application is required to provide these extra elements itself in specific
3712 * Edje files. This call adds one of those Edje files to the theme search
3713 * path to be search after the default theme. The use of this call is
3714 * encouraged when default styles do not meet the needs of the application.
3715 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3717 * @see elm_object_style_set()
3719 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3722 * Deletes a theme extension from the list of extensions.
3724 * @param th The theme to delete from, or if NULL, the default theme
3725 * @param item The name of the theme extension
3727 * @see elm_theme_extension_add()
3729 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3732 * Set the theme search order for the given theme
3734 * @param th The theme to set the search order, or if NULL, the default theme
3735 * @param theme Theme search string
3737 * This sets the search string for the theme in path-notation from first
3738 * theme to search, to last, delimited by the : character. Example:
3740 * "shiny:/path/to/file.edj:default"
3742 * See the ELM_THEME environment variable for more information.
3744 * @see elm_theme_get()
3745 * @see elm_theme_list_get()
3747 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3750 * Return the theme search order
3752 * @param th The theme to get the search order, or if NULL, the default theme
3753 * @return The internal search order path
3755 * This function returns a colon separated string of theme elements as
3756 * returned by elm_theme_list_get().
3758 * @see elm_theme_set()
3759 * @see elm_theme_list_get()
3761 EAPI const char *elm_theme_get(Elm_Theme *th);
3764 * Return a list of theme elements to be used in a theme.
3766 * @param th Theme to get the list of theme elements from.
3767 * @return The internal list of theme elements
3769 * This returns the internal list of theme elements (will only be valid as
3770 * long as the theme is not modified by elm_theme_set() or theme is not
3771 * freed by elm_theme_free(). This is a list of strings which must not be
3772 * altered as they are also internal. If @p th is NULL, then the default
3773 * theme element list is returned.
3775 * A theme element can consist of a full or relative path to a .edj file,
3776 * or a name, without extension, for a theme to be searched in the known
3777 * theme paths for Elemementary.
3779 * @see elm_theme_set()
3780 * @see elm_theme_get()
3782 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3785 * Return the full patrh for a theme element
3787 * @param f The theme element name
3788 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3789 * @return The full path to the file found.
3791 * This returns a string you should free with free() on success, NULL on
3792 * failure. This will search for the given theme element, and if it is a
3793 * full or relative path element or a simple searchable name. The returned
3794 * path is the full path to the file, if searched, and the file exists, or it
3795 * is simply the full path given in the element or a resolved path if
3796 * relative to home. The @p in_search_path boolean pointed to is set to
3797 * EINA_TRUE if the file was a searchable file andis in the search path,
3798 * and EINA_FALSE otherwise.
3800 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3803 * Flush the current theme.
3805 * @param th Theme to flush
3807 * This flushes caches that let elementary know where to find theme elements
3808 * in the given theme. If @p th is NULL, then the default theme is flushed.
3809 * Call this function if source theme data has changed in such a way as to
3810 * make any caches Elementary kept invalid.
3812 EAPI void elm_theme_flush(Elm_Theme *th);
3815 * This flushes all themes (default and specific ones).
3817 * This will flush all themes in the current application context, by calling
3818 * elm_theme_flush() on each of them.
3820 EAPI void elm_theme_full_flush(void);
3823 * Set the theme for all elementary using applications on the current display
3825 * @param theme The name of the theme to use. Format same as the ELM_THEME
3826 * environment variable.
3828 EAPI void elm_theme_all_set(const char *theme);
3831 * Return a list of theme elements in the theme search path
3833 * @return A list of strings that are the theme element names.
3835 * This lists all available theme files in the standard Elementary search path
3836 * for theme elements, and returns them in alphabetical order as theme
3837 * element names in a list of strings. Free this with
3838 * elm_theme_name_available_list_free() when you are done with the list.
3840 EAPI Eina_List *elm_theme_name_available_list_new(void);
3843 * Free the list returned by elm_theme_name_available_list_new()
3845 * This frees the list of themes returned by
3846 * elm_theme_name_available_list_new(). Once freed the list should no longer
3847 * be used. a new list mys be created.
3849 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3852 * Set a specific theme to be used for this object and its children
3854 * @param obj The object to set the theme on
3855 * @param th The theme to set
3857 * This sets a specific theme that will be used for the given object and any
3858 * child objects it has. If @p th is NULL then the theme to be used is
3859 * cleared and the object will inherit its theme from its parent (which
3860 * ultimately will use the default theme if no specific themes are set).
3862 * Use special themes with great care as this will annoy users and make
3863 * configuration difficult. Avoid any custom themes at all if it can be
3866 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3869 * Get the specific theme to be used
3871 * @param obj The object to get the specific theme from
3872 * @return The specifc theme set.
3874 * This will return a specific theme set, or NULL if no specific theme is
3875 * set on that object. It will not return inherited themes from parents, only
3876 * the specific theme set for that specific object. See elm_object_theme_set()
3877 * for more information.
3879 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3882 * Get a data item from a theme
3884 * @param th The theme, or NULL for default theme
3885 * @param key The data key to search with
3886 * @return The data value, or NULL on failure
3888 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3889 * It works the same way as edje_file_data_get() except that the return is stringshared.
3891 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3898 /** @defgroup Win Win
3900 * @image html img/widget/win/preview-00.png
3901 * @image latex img/widget/win/preview-00.eps
3903 * The window class of Elementary. Contains functions to manipulate
3904 * windows. The Evas engine used to render the window contents is specified
3905 * in the system or user elementary config files (whichever is found last),
3906 * and can be overridden with the ELM_ENGINE environment variable for
3907 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3908 * compilation setup and modules actually installed at runtime) are (listed
3909 * in order of best supported and most likely to be complete and work to
3912 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3913 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3915 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3917 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3919 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3921 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3922 * rendering using SDL as the buffer)
3923 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3924 * GDI with software)
3925 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3926 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3927 * grayscale using dedicated 8bit software engine in X11)
3928 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3929 * X11 using 16bit software engine)
3930 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3931 * (Windows CE rendering via GDI with 16bit software renderer)
3932 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3933 * buffer with 16bit software renderer)
3934 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3935 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3936 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3938 * All engines use a simple string to select the engine to render, EXCEPT
3939 * the "shot" engine. This actually encodes the output of the virtual
3940 * screenshot and how long to delay in the engine string. The engine string
3941 * is encoded in the following way:
3943 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3945 * Where options are separated by a ":" char if more than one option is
3946 * given, with delay, if provided being the first option and file the last
3947 * (order is important). The delay specifies how long to wait after the
3948 * window is shown before doing the virtual "in memory" rendering and then
3949 * save the output to the file specified by the file option (and then exit).
3950 * If no delay is given, the default is 0.5 seconds. If no file is given the
3951 * default output file is "out.png". Repeat option is for continous
3952 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3953 * fixed to "out001.png" Some examples of using the shot engine:
3955 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3956 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3957 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3958 * ELM_ENGINE="shot:delay=2.0" elementary_test
3959 * ELM_ENGINE="shot:" elementary_test
3961 * Signals that you can add callbacks for are:
3963 * @li "delete,request": the user requested to close the window. See
3964 * elm_win_autodel_set().
3965 * @li "focus,in": window got focus
3966 * @li "focus,out": window lost focus
3967 * @li "moved": window that holds the canvas was moved
3970 * @li @ref win_example_01
3975 * Defines the types of window that can be created
3977 * These are hints set on the window so that a running Window Manager knows
3978 * how the window should be handled and/or what kind of decorations it
3981 * Currently, only the X11 backed engines use them.
3983 typedef enum _Elm_Win_Type
3985 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3986 window. Almost every window will be created with this
3988 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3989 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3990 window holding desktop icons. */
3991 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3992 be kept on top of any other window by the Window
3994 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3996 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3997 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3999 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
4000 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
4001 entry in a menubar is clicked. Typically used
4002 with elm_win_override_set(). This hint exists
4003 for completion only, as the EFL way of
4004 implementing a menu would not normally use a
4005 separate window for its contents. */
4006 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
4007 triggered by right-clicking an object. */
4008 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
4009 explanatory text that typically appear after the
4010 mouse cursor hovers over an object for a while.
4011 Typically used with elm_win_override_set() and also
4012 not very commonly used in the EFL. */
4013 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
4014 battery life or a new E-Mail received. */
4015 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
4016 usually used in the EFL. */
4017 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
4018 object being dragged across different windows, or even
4019 applications. Typically used with
4020 elm_win_override_set(). */
4021 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
4022 buffer. No actual window is created for this
4023 type, instead the window and all of its
4024 contents will be rendered to an image buffer.
4025 This allows to have children window inside a
4026 parent one just like any other object would
4027 be, and do other things like applying @c
4028 Evas_Map effects to it. This is the only type
4029 of window that requires the @c parent
4030 parameter of elm_win_add() to be a valid @c
4035 * The differents layouts that can be requested for the virtual keyboard.
4037 * When the application window is being managed by Illume, it may request
4038 * any of the following layouts for the virtual keyboard.
4040 typedef enum _Elm_Win_Keyboard_Mode
4042 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4043 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4044 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4045 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4046 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4047 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4048 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4049 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4050 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4051 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4052 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4053 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4054 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4055 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4056 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4057 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4058 } Elm_Win_Keyboard_Mode;
4061 * Available commands that can be sent to the Illume manager.
4063 * When running under an Illume session, a window may send commands to the
4064 * Illume manager to perform different actions.
4066 typedef enum _Elm_Illume_Command
4068 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4070 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4072 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4074 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4075 } Elm_Illume_Command;
4078 * Adds a window object. If this is the first window created, pass NULL as
4081 * @param parent Parent object to add the window to, or NULL
4082 * @param name The name of the window
4083 * @param type The window type, one of #Elm_Win_Type.
4085 * The @p parent paramter can be @c NULL for every window @p type except
4086 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4087 * which the image object will be created.
4089 * @return The created object, or NULL on failure
4091 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4094 * Adds a window object with standard setup
4096 * @param name The name of the window
4097 * @param title The title for the window
4099 * This creates a window like elm_win_add() but also puts in a standard
4100 * background with elm_bg_add(), as well as setting the window title to
4101 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4102 * as the parent widget.
4104 * @return The created object, or NULL on failure
4106 * @see elm_win_add()
4108 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4111 * Add @p subobj as a resize object of window @p obj.
4114 * Setting an object as a resize object of the window means that the
4115 * @p subobj child's size and position will be controlled by the window
4116 * directly. That is, the object will be resized to match the window size
4117 * and should never be moved or resized manually by the developer.
4119 * In addition, resize objects of the window control what the minimum size
4120 * of it will be, as well as whether it can or not be resized by the user.
4122 * For the end user to be able to resize a window by dragging the handles
4123 * or borders provided by the Window Manager, or using any other similar
4124 * mechanism, all of the resize objects in the window should have their
4125 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4127 * Also notice that the window can get resized to the current size of the
4128 * object if the EVAS_HINT_EXPAND is set @b after the call to
4129 * elm_win_resize_object_add(). So if the object should get resized to the
4130 * size of the window, set this hint @b before adding it as a resize object
4131 * (this happens because the size of the window and the object are evaluated
4132 * as soon as the object is added to the window).
4134 * @param obj The window object
4135 * @param subobj The resize object to add
4137 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4140 * Delete @p subobj as a resize object of window @p obj.
4142 * This function removes the object @p subobj from the resize objects of
4143 * the window @p obj. It will not delete the object itself, which will be
4144 * left unmanaged and should be deleted by the developer, manually handled
4145 * or set as child of some other container.
4147 * @param obj The window object
4148 * @param subobj The resize object to add
4150 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4153 * Set the title of the window
4155 * @param obj The window object
4156 * @param title The title to set
4158 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4161 * Get the title of the window
4163 * The returned string is an internal one and should not be freed or
4164 * modified. It will also be rendered invalid if a new title is set or if
4165 * the window is destroyed.
4167 * @param obj The window object
4170 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4173 * Set the window's autodel state.
4175 * When closing the window in any way outside of the program control, like
4176 * pressing the X button in the titlebar or using a command from the
4177 * Window Manager, a "delete,request" signal is emitted to indicate that
4178 * this event occurred and the developer can take any action, which may
4179 * include, or not, destroying the window object.
4181 * When the @p autodel parameter is set, the window will be automatically
4182 * destroyed when this event occurs, after the signal is emitted.
4183 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4184 * and is up to the program to do so when it's required.
4186 * @param obj The window object
4187 * @param autodel If true, the window will automatically delete itself when
4190 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4193 * Get the window's autodel state.
4195 * @param obj The window object
4196 * @return If the window will automatically delete itself when closed
4198 * @see elm_win_autodel_set()
4200 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4203 * Activate a window object.
4205 * This function sends a request to the Window Manager to activate the
4206 * window pointed by @p obj. If honored by the WM, the window will receive
4207 * the keyboard focus.
4209 * @note This is just a request that a Window Manager may ignore, so calling
4210 * this function does not ensure in any way that the window will be the
4211 * active one after it.
4213 * @param obj The window object
4215 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4218 * Lower a window object.
4220 * Places the window pointed by @p obj at the bottom of the stack, so that
4221 * no other window is covered by it.
4223 * If elm_win_override_set() is not set, the Window Manager may ignore this
4226 * @param obj The window object
4228 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4231 * Raise a window object.
4233 * Places the window pointed by @p obj at the top of the stack, so that it's
4234 * not covered by any other window.
4236 * If elm_win_override_set() is not set, the Window Manager may ignore this
4239 * @param obj The window object
4241 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4244 * Center a window on its screen
4246 * This function centers window @p obj horizontally and/or vertically based on the values
4248 * @param obj The window object
4249 * @param h If true, center horizontally. If false, do not change horizontal location.
4250 * @param v If true, center vertically. If false, do not change vertical location.
4252 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
4255 * Set the borderless state of a window.
4257 * This function requests the Window Manager to not draw any decoration
4258 * around the window.
4260 * @param obj The window object
4261 * @param borderless If true, the window is borderless
4263 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4266 * Get the borderless state of a window.
4268 * @param obj The window object
4269 * @return If true, the window is borderless
4271 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4274 * Set the shaped state of a window.
4276 * Shaped windows, when supported, will render the parts of the window that
4277 * has no content, transparent.
4279 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4280 * background object or cover the entire window in any other way, or the
4281 * parts of the canvas that have no data will show framebuffer artifacts.
4283 * @param obj The window object
4284 * @param shaped If true, the window is shaped
4286 * @see elm_win_alpha_set()
4288 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4291 * Get the shaped state of a window.
4293 * @param obj The window object
4294 * @return If true, the window is shaped
4296 * @see elm_win_shaped_set()
4298 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4301 * Set the alpha channel state of a window.
4303 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4304 * possibly making parts of the window completely or partially transparent.
4305 * This is also subject to the underlying system supporting it, like for
4306 * example, running under a compositing manager. If no compositing is
4307 * available, enabling this option will instead fallback to using shaped
4308 * windows, with elm_win_shaped_set().
4310 * @param obj The window object
4311 * @param alpha If true, the window has an alpha channel
4313 * @see elm_win_alpha_set()
4315 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4318 * Get the transparency state of a window.
4320 * @param obj The window object
4321 * @return If true, the window is transparent
4323 * @see elm_win_transparent_set()
4325 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4328 * Set the transparency state of a window.
4330 * Use elm_win_alpha_set() instead.
4332 * @param obj The window object
4333 * @param transparent If true, the window is transparent
4335 * @see elm_win_alpha_set()
4337 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4340 * Get the alpha channel state of a window.
4342 * @param obj The window object
4343 * @return If true, the window has an alpha channel
4345 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4348 * Set the override state of a window.
4350 * A window with @p override set to EINA_TRUE will not be managed by the
4351 * Window Manager. This means that no decorations of any kind will be shown
4352 * for it, moving and resizing must be handled by the application, as well
4353 * as the window visibility.
4355 * This should not be used for normal windows, and even for not so normal
4356 * ones, it should only be used when there's a good reason and with a lot
4357 * of care. Mishandling override windows may result situations that
4358 * disrupt the normal workflow of the end user.
4360 * @param obj The window object
4361 * @param override If true, the window is overridden
4363 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4366 * Get the override state of a window.
4368 * @param obj The window object
4369 * @return If true, the window is overridden
4371 * @see elm_win_override_set()
4373 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4376 * Set the fullscreen state of a window.
4378 * @param obj The window object
4379 * @param fullscreen If true, the window is fullscreen
4381 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4384 * Get the fullscreen state of a window.
4386 * @param obj The window object
4387 * @return If true, the window is fullscreen
4389 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4392 * Set the maximized state of a window.
4394 * @param obj The window object
4395 * @param maximized If true, the window is maximized
4397 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4400 * Get the maximized state of a window.
4402 * @param obj The window object
4403 * @return If true, the window is maximized
4405 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4408 * Set the iconified state of a window.
4410 * @param obj The window object
4411 * @param iconified If true, the window is iconified
4413 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4416 * Get the iconified state of a window.
4418 * @param obj The window object
4419 * @return If true, the window is iconified
4421 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4424 * Set the layer of the window.
4426 * What this means exactly will depend on the underlying engine used.
4428 * In the case of X11 backed engines, the value in @p layer has the
4429 * following meanings:
4430 * @li < 3: The window will be placed below all others.
4431 * @li > 5: The window will be placed above all others.
4432 * @li other: The window will be placed in the default layer.
4434 * @param obj The window object
4435 * @param layer The layer of the window
4437 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4440 * Get the layer of the window.
4442 * @param obj The window object
4443 * @return The layer of the window
4445 * @see elm_win_layer_set()
4447 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4450 * Set the rotation of the window.
4452 * Most engines only work with multiples of 90.
4454 * This function is used to set the orientation of the window @p obj to
4455 * match that of the screen. The window itself will be resized to adjust
4456 * to the new geometry of its contents. If you want to keep the window size,
4457 * see elm_win_rotation_with_resize_set().
4459 * @param obj The window object
4460 * @param rotation The rotation of the window, in degrees (0-360),
4461 * counter-clockwise.
4463 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4466 * Rotates the window and resizes it.
4468 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4469 * that they fit inside the current window geometry.
4471 * @param obj The window object
4472 * @param layer The rotation of the window in degrees (0-360),
4473 * counter-clockwise.
4475 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4478 * Get the rotation of the window.
4480 * @param obj The window object
4481 * @return The rotation of the window in degrees (0-360)
4483 * @see elm_win_rotation_set()
4484 * @see elm_win_rotation_with_resize_set()
4486 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4489 * Set the sticky state of the window.
4491 * Hints the Window Manager that the window in @p obj should be left fixed
4492 * at its position even when the virtual desktop it's on moves or changes.
4494 * @param obj The window object
4495 * @param sticky If true, the window's sticky state is enabled
4497 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4500 * Get the sticky state of the window.
4502 * @param obj The window object
4503 * @return If true, the window's sticky state is enabled
4505 * @see elm_win_sticky_set()
4507 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4510 * Set if this window is an illume conformant window
4512 * @param obj The window object
4513 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4515 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4518 * Get if this window is an illume conformant window
4520 * @param obj The window object
4521 * @return A boolean if this window is illume conformant or not
4523 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4526 * Set a window to be an illume quickpanel window
4528 * By default window objects are not quickpanel windows.
4530 * @param obj The window object
4531 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4533 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4536 * Get if this window is a quickpanel or not
4538 * @param obj The window object
4539 * @return A boolean if this window is a quickpanel or not
4541 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4544 * Set the major priority of a quickpanel window
4546 * @param obj The window object
4547 * @param priority The major priority for this quickpanel
4549 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4552 * Get the major priority of a quickpanel window
4554 * @param obj The window object
4555 * @return The major priority of this quickpanel
4557 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4560 * Set the minor priority of a quickpanel window
4562 * @param obj The window object
4563 * @param priority The minor priority for this quickpanel
4565 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4568 * Get the minor priority of a quickpanel window
4570 * @param obj The window object
4571 * @return The minor priority of this quickpanel
4573 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4576 * Set which zone this quickpanel should appear in
4578 * @param obj The window object
4579 * @param zone The requested zone for this quickpanel
4581 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4584 * Get which zone this quickpanel should appear in
4586 * @param obj The window object
4587 * @return The requested zone for this quickpanel
4589 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4592 * Set the window to be skipped by keyboard focus
4594 * This sets the window to be skipped by normal keyboard input. This means
4595 * a window manager will be asked to not focus this window as well as omit
4596 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4598 * Call this and enable it on a window BEFORE you show it for the first time,
4599 * otherwise it may have no effect.
4601 * Use this for windows that have only output information or might only be
4602 * interacted with by the mouse or fingers, and never for typing input.
4603 * Be careful that this may have side-effects like making the window
4604 * non-accessible in some cases unless the window is specially handled. Use
4607 * @param obj The window object
4608 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4610 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4613 * Send a command to the windowing environment
4615 * This is intended to work in touchscreen or small screen device
4616 * environments where there is a more simplistic window management policy in
4617 * place. This uses the window object indicated to select which part of the
4618 * environment to control (the part that this window lives in), and provides
4619 * a command and an optional parameter structure (use NULL for this if not
4622 * @param obj The window object that lives in the environment to control
4623 * @param command The command to send
4624 * @param params Optional parameters for the command
4626 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4629 * Get the inlined image object handle
4631 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4632 * then the window is in fact an evas image object inlined in the parent
4633 * canvas. You can get this object (be careful to not manipulate it as it
4634 * is under control of elementary), and use it to do things like get pixel
4635 * data, save the image to a file, etc.
4637 * @param obj The window object to get the inlined image from
4638 * @return The inlined image object, or NULL if none exists
4640 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4643 * Determine whether a window has focus
4644 * @param obj The window to query
4645 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4647 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650 * Constrain the maximum width and height of a window to the width and height of its screen
4652 * When @p constrain is true, @p obj will never resize larger than the screen.
4653 * @param obj The window object
4654 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4656 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
4659 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
4661 * When this function returns true, @p obj will never resize larger than the screen.
4662 * @param obj The window object
4663 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4665 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4668 * Get screen geometry details for the screen that a window is on
4669 * @param obj The window to query
4670 * @param x where to return the horizontal offset value. May be NULL.
4671 * @param y where to return the vertical offset value. May be NULL.
4672 * @param w where to return the width value. May be NULL.
4673 * @param h where to return the height value. May be NULL.
4675 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4678 * Set the enabled status for the focus highlight in a window
4680 * This function will enable or disable the focus highlight only for the
4681 * given window, regardless of the global setting for it
4683 * @param obj The window where to enable the highlight
4684 * @param enabled The enabled value for the highlight
4686 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4689 * Get the enabled value of the focus highlight for this window
4691 * @param obj The window in which to check if the focus highlight is enabled
4693 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4695 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4698 * Set the style for the focus highlight on this window
4700 * Sets the style to use for theming the highlight of focused objects on
4701 * the given window. If @p style is NULL, the default will be used.
4703 * @param obj The window where to set the style
4704 * @param style The style to set
4706 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4709 * Get the style set for the focus highlight object
4711 * Gets the style set for this windows highilght object, or NULL if none
4714 * @param obj The window to retrieve the highlights style from
4716 * @return The style set or NULL if none was. Default is used in that case.
4718 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4721 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4722 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4723 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4724 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4725 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4726 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4727 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4729 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4730 * (blank mouse, private mouse obj, defaultmouse)
4735 * Sets the keyboard mode of the window.
4737 * @param obj The window object
4738 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4740 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4743 * Gets the keyboard mode of the window.
4745 * @param obj The window object
4746 * @return The mode, one of #Elm_Win_Keyboard_Mode
4748 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4751 * Sets whether the window is a keyboard.
4753 * @param obj The window object
4754 * @param is_keyboard If true, the window is a virtual keyboard
4756 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4759 * Gets whether the window is a keyboard.
4761 * @param obj The window object
4762 * @return If the window is a virtual keyboard
4764 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4767 * Get the screen position of a window.
4769 * @param obj The window object
4770 * @param x The int to store the x coordinate to
4771 * @param y The int to store the y coordinate to
4773 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4780 * @defgroup Inwin Inwin
4782 * @image html img/widget/inwin/preview-00.png
4783 * @image latex img/widget/inwin/preview-00.eps
4784 * @image html img/widget/inwin/preview-01.png
4785 * @image latex img/widget/inwin/preview-01.eps
4786 * @image html img/widget/inwin/preview-02.png
4787 * @image latex img/widget/inwin/preview-02.eps
4789 * An inwin is a window inside a window that is useful for a quick popup.
4790 * It does not hover.
4792 * It works by creating an object that will occupy the entire window, so it
4793 * must be created using an @ref Win "elm_win" as parent only. The inwin
4794 * object can be hidden or restacked below every other object if it's
4795 * needed to show what's behind it without destroying it. If this is done,
4796 * the elm_win_inwin_activate() function can be used to bring it back to
4797 * full visibility again.
4799 * There are three styles available in the default theme. These are:
4800 * @li default: The inwin is sized to take over most of the window it's
4802 * @li minimal: The size of the inwin will be the minimum necessary to show
4804 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4805 * possible, but it's sized vertically the most it needs to fit its\
4808 * Some examples of Inwin can be found in the following:
4809 * @li @ref inwin_example_01
4815 * Adds an inwin to the current window
4817 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4818 * Never call this function with anything other than the top-most window
4819 * as its parameter, unless you are fond of undefined behavior.
4821 * After creating the object, the widget will set itself as resize object
4822 * for the window with elm_win_resize_object_add(), so when shown it will
4823 * appear to cover almost the entire window (how much of it depends on its
4824 * content and the style used). It must not be added into other container
4825 * objects and it needs not be moved or resized manually.
4827 * @param parent The parent object
4828 * @return The new object or NULL if it cannot be created
4830 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4833 * Activates an inwin object, ensuring its visibility
4835 * This function will make sure that the inwin @p obj is completely visible
4836 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4837 * to the front. It also sets the keyboard focus to it, which will be passed
4840 * The object's theme will also receive the signal "elm,action,show" with
4843 * @param obj The inwin to activate
4845 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4848 * Set the content of an inwin object.
4850 * Once the content object is set, a previously set one will be deleted.
4851 * If you want to keep that old content object, use the
4852 * elm_win_inwin_content_unset() function.
4854 * @param obj The inwin object
4855 * @param content The object to set as content
4857 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4860 * Get the content of an inwin object.
4862 * Return the content object which is set for this widget.
4864 * The returned object is valid as long as the inwin is still alive and no
4865 * other content is set on it. Deleting the object will notify the inwin
4866 * about it and this one will be left empty.
4868 * If you need to remove an inwin's content to be reused somewhere else,
4869 * see elm_win_inwin_content_unset().
4871 * @param obj The inwin object
4872 * @return The content that is being used
4874 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4877 * Unset the content of an inwin object.
4879 * Unparent and return the content object which was set for this widget.
4881 * @param obj The inwin object
4882 * @return The content that was being used
4884 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4889 /* X specific calls - won't work on non-x engines (return 0) */
4892 * Get the Ecore_X_Window of an Evas_Object
4894 * @param obj The object
4896 * @return The Ecore_X_Window of @p obj
4900 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4902 /* smart callbacks called:
4903 * "delete,request" - the user requested to delete the window
4904 * "focus,in" - window got focus
4905 * "focus,out" - window lost focus
4906 * "moved" - window that holds the canvas was moved
4912 * @image html img/widget/bg/preview-00.png
4913 * @image latex img/widget/bg/preview-00.eps
4915 * @brief Background object, used for setting a solid color, image or Edje
4916 * group as background to a window or any container object.
4918 * The bg object is used for setting a solid background to a window or
4919 * packing into any container object. It works just like an image, but has
4920 * some properties useful to a background, like setting it to tiled,
4921 * centered, scaled or stretched.
4923 * Default contents parts of the bg widget that you can use for are:
4924 * @li "overlay" - overlay of the bg
4926 * Here is some sample code using it:
4927 * @li @ref bg_01_example_page
4928 * @li @ref bg_02_example_page
4929 * @li @ref bg_03_example_page
4933 typedef enum _Elm_Bg_Option
4935 ELM_BG_OPTION_CENTER, /**< center the background */
4936 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4937 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4938 ELM_BG_OPTION_TILE /**< tile background at its original size */
4942 * Add a new background to the parent
4944 * @param parent The parent object
4945 * @return The new object or NULL if it cannot be created
4949 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4952 * Set the file (image or edje) used for the background
4954 * @param obj The bg object
4955 * @param file The file path
4956 * @param group Optional key (group in Edje) within the file
4958 * This sets the image file used in the background object. The image (or edje)
4959 * will be stretched (retaining aspect if its an image file) to completely fill
4960 * the bg object. This may mean some parts are not visible.
4962 * @note Once the image of @p obj is set, a previously set one will be deleted,
4963 * even if @p file is NULL.
4967 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4970 * Get the file (image or edje) used for the background
4972 * @param obj The bg object
4973 * @param file The file path
4974 * @param group Optional key (group in Edje) within the file
4978 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4981 * Set the option used for the background image
4983 * @param obj The bg object
4984 * @param option The desired background option (TILE, SCALE)
4986 * This sets the option used for manipulating the display of the background
4987 * image. The image can be tiled or scaled.
4991 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4994 * Get the option used for the background image
4996 * @param obj The bg object
4997 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
5001 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5003 * Set the option used for the background color
5005 * @param obj The bg object
5010 * This sets the color used for the background rectangle. Its range goes
5015 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
5017 * Get the option used for the background color
5019 * @param obj The bg object
5026 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
5029 * Set the overlay object used for the background object.
5031 * @param obj The bg object
5032 * @param overlay The overlay object
5034 * This provides a way for elm_bg to have an 'overlay' that will be on top
5035 * of the bg. Once the over object is set, a previously set one will be
5036 * deleted, even if you set the new one to NULL. If you want to keep that
5037 * old content object, use the elm_bg_overlay_unset() function.
5039 * @deprecated use elm_object_part_content_set() instead
5044 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
5047 * Get the overlay object used for the background object.
5049 * @param obj The bg object
5050 * @return The content that is being used
5052 * Return the content object which is set for this widget
5054 * @deprecated use elm_object_part_content_get() instead
5058 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5061 * Get the overlay object used for the background object.
5063 * @param obj The bg object
5064 * @return The content that was being used
5066 * Unparent and return the overlay object which was set for this widget
5068 * @deprecated use elm_object_part_content_unset() instead
5072 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5075 * Set the size of the pixmap representation of the image.
5077 * This option just makes sense if an image is going to be set in the bg.
5079 * @param obj The bg object
5080 * @param w The new width of the image pixmap representation.
5081 * @param h The new height of the image pixmap representation.
5083 * This function sets a new size for pixmap representation of the given bg
5084 * image. It allows the image to be loaded already in the specified size,
5085 * reducing the memory usage and load time when loading a big image with load
5086 * size set to a smaller size.
5088 * NOTE: this is just a hint, the real size of the pixmap may differ
5089 * depending on the type of image being loaded, being bigger than requested.
5093 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5100 * @defgroup Icon Icon
5102 * @image html img/widget/icon/preview-00.png
5103 * @image latex img/widget/icon/preview-00.eps
5105 * An object that provides standard icon images (delete, edit, arrows, etc.)
5106 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
5108 * The icon image requested can be in the elementary theme, or in the
5109 * freedesktop.org paths. It's possible to set the order of preference from
5110 * where the image will be used.
5112 * This API is very similar to @ref Image, but with ready to use images.
5114 * Default images provided by the theme are described below.
5116 * The first list contains icons that were first intended to be used in
5117 * toolbars, but can be used in many other places too:
5133 * Now some icons that were designed to be used in menus (but again, you can
5134 * use them anywhere else):
5139 * @li menu/arrow_down
5140 * @li menu/arrow_left
5141 * @li menu/arrow_right
5150 * And here we have some media player specific icons:
5151 * @li media_player/forward
5152 * @li media_player/info
5153 * @li media_player/next
5154 * @li media_player/pause
5155 * @li media_player/play
5156 * @li media_player/prev
5157 * @li media_player/rewind
5158 * @li media_player/stop
5160 * Signals that you can add callbacks for are:
5162 * "clicked" - This is called when a user has clicked the icon
5164 * An example of usage for this API follows:
5165 * @li @ref tutorial_icon
5173 typedef enum _Elm_Icon_Type
5181 * @enum _Elm_Icon_Lookup_Order
5182 * @typedef Elm_Icon_Lookup_Order
5184 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5185 * theme, FDO paths, or both?
5189 typedef enum _Elm_Icon_Lookup_Order
5191 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5192 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5193 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
5194 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
5195 } Elm_Icon_Lookup_Order;
5198 * Add a new icon object to the parent.
5200 * @param parent The parent object
5201 * @return The new object or NULL if it cannot be created
5203 * @see elm_icon_file_set()
5207 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5210 * Set the file that will be used as icon.
5212 * @param obj The icon object
5213 * @param file The path to file that will be used as icon image
5214 * @param group The group that the icon belongs to an edje file
5216 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5218 * @note The icon image set by this function can be changed by
5219 * elm_icon_standard_set().
5221 * @see elm_icon_file_get()
5225 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5228 * Set a location in memory to be used as an icon
5230 * @param obj The icon object
5231 * @param img The binary data that will be used as an image
5232 * @param size The size of binary data @p img
5233 * @param format Optional format of @p img to pass to the image loader
5234 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5236 * The @p format string should be something like "png", "jpg", "tga",
5237 * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5238 * the loader performance as it tries the "correct" loader first before
5239 * trying a range of other possible loaders until one succeeds.
5241 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5243 * @note The icon image set by this function can be changed by
5244 * elm_icon_standard_set().
5248 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);
5251 * Get the file that will be used as icon.
5253 * @param obj The icon object
5254 * @param file The path to file that will be used as the icon image
5255 * @param group The group that the icon belongs to, in edje file
5257 * @see elm_icon_file_set()
5261 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5264 * Set the file that will be used, but use a generated thumbnail.
5266 * @param obj The icon object
5267 * @param file The path to file that will be used as icon image
5268 * @param group The group that the icon belongs to an edje file
5270 * This functions like elm_icon_file_set() but requires the Ethumb library
5271 * support to be enabled successfully with elm_need_ethumb(). When set
5272 * the file indicated has a thumbnail generated and cached on disk for
5273 * future use or will directly use an existing cached thumbnail if it
5276 * @see elm_icon_file_set()
5280 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5283 * Set the icon by icon standards names.
5285 * @param obj The icon object
5286 * @param name The icon name
5288 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5290 * For example, freedesktop.org defines standard icon names such as "home",
5291 * "network", etc. There can be different icon sets to match those icon
5292 * keys. The @p name given as parameter is one of these "keys", and will be
5293 * used to look in the freedesktop.org paths and elementary theme. One can
5294 * change the lookup order with elm_icon_order_lookup_set().
5296 * If name is not found in any of the expected locations and it is the
5297 * absolute path of an image file, this image will be used.
5299 * @note The icon image set by this function can be changed by
5300 * elm_icon_file_set().
5302 * @see elm_icon_standard_get()
5303 * @see elm_icon_file_set()
5307 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5310 * Get the icon name set by icon standard names.
5312 * @param obj The icon object
5313 * @return The icon name
5315 * If the icon image was set using elm_icon_file_set() instead of
5316 * elm_icon_standard_set(), then this function will return @c NULL.
5318 * @see elm_icon_standard_set()
5322 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5325 * Set the smooth scaling for an icon object.
5327 * @param obj The icon object
5328 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5329 * otherwise. Default is @c EINA_TRUE.
5331 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5332 * scaling provides a better resulting image, but is slower.
5334 * The smooth scaling should be disabled when making animations that change
5335 * the icon size, since they will be faster. Animations that don't require
5336 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5337 * is already scaled, since the scaled icon image will be cached).
5339 * @see elm_icon_smooth_get()
5343 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5346 * Get whether smooth scaling is enabled for an icon object.
5348 * @param obj The icon object
5349 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5351 * @see elm_icon_smooth_set()
5355 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5358 * Disable scaling of this object.
5360 * @param obj The icon object.
5361 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5362 * otherwise. Default is @c EINA_FALSE.
5364 * This function disables scaling of the icon object through the function
5365 * elm_object_scale_set(). However, this does not affect the object
5366 * size/resize in any way. For that effect, take a look at
5367 * elm_icon_scale_set().
5369 * @see elm_icon_no_scale_get()
5370 * @see elm_icon_scale_set()
5371 * @see elm_object_scale_set()
5375 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5378 * Get whether scaling is disabled on the object.
5380 * @param obj The icon object
5381 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5383 * @see elm_icon_no_scale_set()
5387 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5390 * Set if the object is (up/down) resizable.
5392 * @param obj The icon object
5393 * @param scale_up A bool to set if the object is resizable up. Default is
5395 * @param scale_down A bool to set if the object is resizable down. Default
5398 * This function limits the icon object resize ability. If @p scale_up is set to
5399 * @c EINA_FALSE, the object can't have its height or width resized to a value
5400 * higher than the original icon size. Same is valid for @p scale_down.
5402 * @see elm_icon_scale_get()
5406 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5409 * Get if the object is (up/down) resizable.
5411 * @param obj The icon object
5412 * @param scale_up A bool to set if the object is resizable up
5413 * @param scale_down A bool to set if the object is resizable down
5415 * @see elm_icon_scale_set()
5419 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5422 * Get the object's image size
5424 * @param obj The icon object
5425 * @param w A pointer to store the width in
5426 * @param h A pointer to store the height in
5430 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5433 * Set if the icon fill the entire object area.
5435 * @param obj The icon object
5436 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5437 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5439 * When the icon object is resized to a different aspect ratio from the
5440 * original icon image, the icon image will still keep its aspect. This flag
5441 * tells how the image should fill the object's area. They are: keep the
5442 * entire icon inside the limits of height and width of the object (@p
5443 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5444 * of the object, and the icon will fill the entire object (@p fill_outside
5447 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5448 * retain property to false. Thus, the icon image will always keep its
5449 * original aspect ratio.
5451 * @see elm_icon_fill_outside_get()
5452 * @see elm_image_fill_outside_set()
5456 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5459 * Get if the object is filled outside.
5461 * @param obj The icon object
5462 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5464 * @see elm_icon_fill_outside_set()
5468 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5471 * Set the prescale size for the icon.
5473 * @param obj The icon object
5474 * @param size The prescale size. This value is used for both width and
5477 * This function sets a new size for pixmap representation of the given
5478 * icon. It allows the icon to be loaded already in the specified size,
5479 * reducing the memory usage and load time when loading a big icon with load
5480 * size set to a smaller size.
5482 * It's equivalent to the elm_bg_load_size_set() function for bg.
5484 * @note this is just a hint, the real size of the pixmap may differ
5485 * depending on the type of icon being loaded, being bigger than requested.
5487 * @see elm_icon_prescale_get()
5488 * @see elm_bg_load_size_set()
5492 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5495 * Get the prescale size for the icon.
5497 * @param obj The icon object
5498 * @return The prescale size
5500 * @see elm_icon_prescale_set()
5504 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507 * Gets the image object of the icon. DO NOT MODIFY THIS.
5509 * @param obj The icon object
5510 * @return The internal icon object
5514 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5517 * Sets the icon lookup order used by elm_icon_standard_set().
5519 * @param obj The icon object
5520 * @param order The icon lookup order (can be one of
5521 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5522 * or ELM_ICON_LOOKUP_THEME)
5524 * @see elm_icon_order_lookup_get()
5525 * @see Elm_Icon_Lookup_Order
5529 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5532 * Gets the icon lookup order.
5534 * @param obj The icon object
5535 * @return The icon lookup order
5537 * @see elm_icon_order_lookup_set()
5538 * @see Elm_Icon_Lookup_Order
5542 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5545 * Enable or disable preloading of the icon
5547 * @param obj The icon object
5548 * @param disable If EINA_TRUE, preloading will be disabled
5551 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5554 * Get if the icon supports animation or not.
5556 * @param obj The icon object
5557 * @return @c EINA_TRUE if the icon supports animation,
5558 * @c EINA_FALSE otherwise.
5560 * Return if this elm icon's image can be animated. Currently Evas only
5561 * supports gif animation. If the return value is EINA_FALSE, other
5562 * elm_icon_animated_XXX APIs won't work.
5565 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5568 * Set animation mode of the icon.
5570 * @param obj The icon object
5571 * @param anim @c EINA_TRUE if the object do animation job,
5572 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5574 * Since the default animation mode is set to EINA_FALSE,
5575 * the icon is shown without animation. Files like animated GIF files
5576 * can animate, and this is supported if you enable animated support
5578 * Set it to EINA_TRUE when the icon needs to be animated.
5581 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5584 * Get animation mode of the icon.
5586 * @param obj The icon object
5587 * @return The animation mode of the icon object
5588 * @see elm_icon_animated_set
5591 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5594 * Set animation play mode of the icon.
5596 * @param obj The icon object
5597 * @param play @c EINA_TRUE the object play animation images,
5598 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5600 * To play elm icon's animation, set play to EINA_TURE.
5601 * For example, you make gif player using this set/get API and click event.
5602 * This literally lets you control current play or paused state. To have
5603 * this work with animated GIF files for example, you first, before
5604 * setting the file have to use elm_icon_animated_set() to enable animation
5605 * at all on the icon.
5607 * 1. Click event occurs
5608 * 2. Check play flag using elm_icon_animaged_play_get
5609 * 3. If elm icon was playing, set play to EINA_FALSE.
5610 * Then animation will be stopped and vice versa
5613 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5616 * Get animation play mode of the icon.
5618 * @param obj The icon object
5619 * @return The play mode of the icon object
5621 * @see elm_icon_animated_play_get
5624 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5631 * @defgroup Image Image
5633 * @image html img/widget/image/preview-00.png
5634 * @image latex img/widget/image/preview-00.eps
5637 * An object that allows one to load an image file to it. It can be used
5638 * anywhere like any other elementary widget.
5640 * This widget provides most of the functionality provided from @ref Bg or @ref
5641 * Icon, but with a slightly different API (use the one that fits better your
5644 * The features not provided by those two other image widgets are:
5645 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5646 * @li change the object orientation with elm_image_orient_set();
5647 * @li and turning the image editable with elm_image_editable_set().
5649 * Signals that you can add callbacks for are:
5651 * @li @c "clicked" - This is called when a user has clicked the image
5653 * An example of usage for this API follows:
5654 * @li @ref tutorial_image
5663 * @enum _Elm_Image_Orient
5664 * @typedef Elm_Image_Orient
5666 * Possible orientation options for elm_image_orient_set().
5668 * @image html elm_image_orient_set.png
5669 * @image latex elm_image_orient_set.eps width=\textwidth
5673 typedef enum _Elm_Image_Orient
5675 ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5676 ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5677 ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5678 ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5679 ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5680 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5681 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5682 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5683 ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5684 ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5685 ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5686 ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5690 * Add a new image to the parent.
5692 * @param parent The parent object
5693 * @return The new object or NULL if it cannot be created
5695 * @see elm_image_file_set()
5699 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5702 * Set the file that will be used as image.
5704 * @param obj The image object
5705 * @param file The path to file that will be used as image
5706 * @param group The group that the image belongs in edje file (if it's an
5709 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5711 * @see elm_image_file_get()
5715 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5718 * Get the file that will be used as image.
5720 * @param obj The image object
5721 * @param file The path to file
5722 * @param group The group that the image belongs in edje file
5724 * @see elm_image_file_set()
5728 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5731 * Set the smooth effect for an image.
5733 * @param obj The image object
5734 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5735 * otherwise. Default is @c EINA_TRUE.
5737 * Set the scaling algorithm to be used when scaling the image. Smooth
5738 * scaling provides a better resulting image, but is slower.
5740 * The smooth scaling should be disabled when making animations that change
5741 * the image size, since it will be faster. Animations that don't require
5742 * resizing of the image can keep the smooth scaling enabled (even if the
5743 * image is already scaled, since the scaled image will be cached).
5745 * @see elm_image_smooth_get()
5749 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5752 * Get the smooth effect for an image.
5754 * @param obj The image object
5755 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5757 * @see elm_image_smooth_get()
5761 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5764 * Gets the current size of the image.
5766 * @param obj The image object.
5767 * @param w Pointer to store width, or NULL.
5768 * @param h Pointer to store height, or NULL.
5770 * This is the real size of the image, not the size of the object.
5772 * On error, neither w and h will be fileld with 0.
5776 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5779 * Disable scaling of this object.
5781 * @param obj The image object.
5782 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5783 * otherwise. Default is @c EINA_FALSE.
5785 * This function disables scaling of the elm_image widget through the
5786 * function elm_object_scale_set(). However, this does not affect the widget
5787 * size/resize in any way. For that effect, take a look at
5788 * elm_image_scale_set().
5790 * @see elm_image_no_scale_get()
5791 * @see elm_image_scale_set()
5792 * @see elm_object_scale_set()
5796 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5799 * Get whether scaling is disabled on the object.
5801 * @param obj The image object
5802 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5804 * @see elm_image_no_scale_set()
5808 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5811 * Set if the object is (up/down) resizable.
5813 * @param obj The image object
5814 * @param scale_up A bool to set if the object is resizable up. Default is
5816 * @param scale_down A bool to set if the object is resizable down. Default
5819 * This function limits the image resize ability. If @p scale_up is set to
5820 * @c EINA_FALSE, the object can't have its height or width resized to a value
5821 * higher than the original image size. Same is valid for @p scale_down.
5823 * @see elm_image_scale_get()
5827 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5830 * Get if the object is (up/down) resizable.
5832 * @param obj The image object
5833 * @param scale_up A bool to set if the object is resizable up
5834 * @param scale_down A bool to set if the object is resizable down
5836 * @see elm_image_scale_set()
5840 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5843 * Set if the image fills the entire object area, when keeping the aspect ratio.
5845 * @param obj The image object
5846 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5847 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5849 * When the image should keep its aspect ratio even if resized to another
5850 * aspect ratio, there are two possibilities to resize it: keep the entire
5851 * image inside the limits of height and width of the object (@p fill_outside
5852 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5853 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5855 * @note This option will have no effect if
5856 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5858 * @see elm_image_fill_outside_get()
5859 * @see elm_image_aspect_ratio_retained_set()
5863 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5866 * Get if the object is filled outside
5868 * @param obj The image object
5869 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5871 * @see elm_image_fill_outside_set()
5875 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5878 * Set the prescale size for the image
5880 * @param obj The image object
5881 * @param size The prescale size. This value is used for both width and
5884 * This function sets a new size for pixmap representation of the given
5885 * image. It allows the image to be loaded already in the specified size,
5886 * reducing the memory usage and load time when loading a big image with load
5887 * size set to a smaller size.
5889 * It's equivalent to the elm_bg_load_size_set() function for bg.
5891 * @note this is just a hint, the real size of the pixmap may differ
5892 * depending on the type of image being loaded, being bigger than requested.
5894 * @see elm_image_prescale_get()
5895 * @see elm_bg_load_size_set()
5899 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5902 * Get the prescale size for the image
5904 * @param obj The image object
5905 * @return The prescale size
5907 * @see elm_image_prescale_set()
5911 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5914 * Set the image orientation.
5916 * @param obj The image object
5917 * @param orient The image orientation @ref Elm_Image_Orient
5918 * Default is #ELM_IMAGE_ORIENT_NONE.
5920 * This function allows to rotate or flip the given image.
5922 * @see elm_image_orient_get()
5923 * @see @ref Elm_Image_Orient
5927 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5930 * Get the image orientation.
5932 * @param obj The image object
5933 * @return The image orientation @ref Elm_Image_Orient
5935 * @see elm_image_orient_set()
5936 * @see @ref Elm_Image_Orient
5940 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5943 * Make the image 'editable'.
5945 * @param obj Image object.
5946 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5948 * This means the image is a valid drag target for drag and drop, and can be
5949 * cut or pasted too.
5953 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5956 * Check if the image 'editable'.
5958 * @param obj Image object.
5959 * @return Editability.
5961 * A return value of EINA_TRUE means the image is a valid drag target
5962 * for drag and drop, and can be cut or pasted too.
5966 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 * Get the basic Evas_Image object from this object (widget).
5971 * @param obj The image object to get the inlined image from
5972 * @return The inlined image object, or NULL if none exists
5974 * This function allows one to get the underlying @c Evas_Object of type
5975 * Image from this elementary widget. It can be useful to do things like get
5976 * the pixel data, save the image to a file, etc.
5978 * @note Be careful to not manipulate it, as it is under control of
5983 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5986 * Set whether the original aspect ratio of the image should be kept on resize.
5988 * @param obj The image object.
5989 * @param retained @c EINA_TRUE if the image should retain the aspect,
5990 * @c EINA_FALSE otherwise.
5992 * The original aspect ratio (width / height) of the image is usually
5993 * distorted to match the object's size. Enabling this option will retain
5994 * this original aspect, and the way that the image is fit into the object's
5995 * area depends on the option set by elm_image_fill_outside_set().
5997 * @see elm_image_aspect_ratio_retained_get()
5998 * @see elm_image_fill_outside_set()
6002 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
6005 * Get if the object retains the original aspect ratio.
6007 * @param obj The image object.
6008 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
6013 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6020 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
6022 typedef enum _Elm_GLView_Mode
6024 ELM_GLVIEW_ALPHA = 1,
6025 ELM_GLVIEW_DEPTH = 2,
6026 ELM_GLVIEW_STENCIL = 4
6030 * Defines a policy for the glview resizing.
6032 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
6034 typedef enum _Elm_GLView_Resize_Policy
6036 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
6037 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
6038 } Elm_GLView_Resize_Policy;
6040 typedef enum _Elm_GLView_Render_Policy
6042 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
6043 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
6044 } Elm_GLView_Render_Policy;
6049 * A simple GLView widget that allows GL rendering.
6051 * Signals that you can add callbacks for are:
6057 * Add a new glview to the parent
6059 * @param parent The parent object
6060 * @return The new object or NULL if it cannot be created
6064 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6067 * Sets the size of the glview
6069 * @param obj The glview object
6070 * @param width width of the glview object
6071 * @param height height of the glview object
6075 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6078 * Gets the size of the glview.
6080 * @param obj The glview object
6081 * @param width width of the glview object
6082 * @param height height of the glview object
6084 * Note that this function returns the actual image size of the
6085 * glview. This means that when the scale policy is set to
6086 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
6091 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6094 * Gets the gl api struct for gl rendering
6096 * @param obj The glview object
6097 * @return The api object or NULL if it cannot be created
6101 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6104 * Set the mode of the GLView. Supports Three simple modes.
6106 * @param obj The glview object
6107 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
6108 * @return True if set properly.
6112 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
6115 * Set the resize policy for the glview object.
6117 * @param obj The glview object.
6118 * @param policy The scaling policy.
6120 * By default, the resize policy is set to
6121 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
6122 * destroys the previous surface and recreates the newly specified
6123 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
6124 * however, glview only scales the image object and not the underlying
6129 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
6132 * Set the render policy for the glview object.
6134 * @param obj The glview object.
6135 * @param policy The render policy.
6137 * By default, the render policy is set to
6138 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
6139 * that during the render loop, glview is only redrawn if it needs
6140 * to be redrawn. (i.e. When it is visible) If the policy is set to
6141 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
6142 * whether it is visible/need redrawing or not.
6146 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
6149 * Set the init function that runs once in the main loop.
6151 * @param obj The glview object.
6152 * @param func The init function to be registered.
6154 * The registered init function gets called once during the render loop.
6158 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6161 * Set the render function that runs in the main loop.
6163 * @param obj The glview object.
6164 * @param func The delete function to be registered.
6166 * The registered del function gets called when GLView object is deleted.
6170 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6173 * Set the resize function that gets called when resize happens.
6175 * @param obj The glview object.
6176 * @param func The resize function to be registered.
6180 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6183 * Set the render function that runs in the main loop.
6185 * @param obj The glview object.
6186 * @param func The render function to be registered.
6190 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6193 * Notifies that there has been changes in the GLView.
6195 * @param obj The glview object.
6199 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6209 * @image html img/widget/box/preview-00.png
6210 * @image latex img/widget/box/preview-00.eps width=\textwidth
6212 * @image html img/box.png
6213 * @image latex img/box.eps width=\textwidth
6215 * A box arranges objects in a linear fashion, governed by a layout function
6216 * that defines the details of this arrangement.
6218 * By default, the box will use an internal function to set the layout to
6219 * a single row, either vertical or horizontal. This layout is affected
6220 * by a number of parameters, such as the homogeneous flag set by
6221 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6222 * elm_box_align_set() and the hints set to each object in the box.
6224 * For this default layout, it's possible to change the orientation with
6225 * elm_box_horizontal_set(). The box will start in the vertical orientation,
6226 * placing its elements ordered from top to bottom. When horizontal is set,
6227 * the order will go from left to right. If the box is set to be
6228 * homogeneous, every object in it will be assigned the same space, that
6229 * of the largest object. Padding can be used to set some spacing between
6230 * the cell given to each object. The alignment of the box, set with
6231 * elm_box_align_set(), determines how the bounding box of all the elements
6232 * will be placed within the space given to the box widget itself.
6234 * The size hints of each object also affect how they are placed and sized
6235 * within the box. evas_object_size_hint_min_set() will give the minimum
6236 * size the object can have, and the box will use it as the basis for all
6237 * latter calculations. Elementary widgets set their own minimum size as
6238 * needed, so there's rarely any need to use it manually.
6240 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6241 * used to tell whether the object will be allocated the minimum size it
6242 * needs or if the space given to it should be expanded. It's important
6243 * to realize that expanding the size given to the object is not the same
6244 * thing as resizing the object. It could very well end being a small
6245 * widget floating in a much larger empty space. If not set, the weight
6246 * for objects will normally be 0.0 for both axis, meaning the widget will
6247 * not be expanded. To take as much space possible, set the weight to
6248 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6250 * Besides how much space each object is allocated, it's possible to control
6251 * how the widget will be placed within that space using
6252 * evas_object_size_hint_align_set(). By default, this value will be 0.5
6253 * for both axis, meaning the object will be centered, but any value from
6254 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6255 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6256 * is -1.0, means the object will be resized to fill the entire space it
6259 * In addition, customized functions to define the layout can be set, which
6260 * allow the application developer to organize the objects within the box
6261 * in any number of ways.
6263 * The special elm_box_layout_transition() function can be used
6264 * to switch from one layout to another, animating the motion of the
6265 * children of the box.
6267 * @note Objects should not be added to box objects using _add() calls.
6269 * Some examples on how to use boxes follow:
6270 * @li @ref box_example_01
6271 * @li @ref box_example_02
6276 * @typedef Elm_Box_Transition
6278 * Opaque handler containing the parameters to perform an animated
6279 * transition of the layout the box uses.
6281 * @see elm_box_transition_new()
6282 * @see elm_box_layout_set()
6283 * @see elm_box_layout_transition()
6285 typedef struct _Elm_Box_Transition Elm_Box_Transition;
6288 * Add a new box to the parent
6290 * By default, the box will be in vertical mode and non-homogeneous.
6292 * @param parent The parent object
6293 * @return The new object or NULL if it cannot be created
6295 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6298 * Set the horizontal orientation
6300 * By default, box object arranges their contents vertically from top to
6302 * By calling this function with @p horizontal as EINA_TRUE, the box will
6303 * become horizontal, arranging contents from left to right.
6305 * @note This flag is ignored if a custom layout function is set.
6307 * @param obj The box object
6308 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6309 * EINA_FALSE = vertical)
6311 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6314 * Get the horizontal orientation
6316 * @param obj The box object
6317 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6319 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6322 * Set the box to arrange its children homogeneously
6324 * If enabled, homogeneous layout makes all items the same size, according
6325 * to the size of the largest of its children.
6327 * @note This flag is ignored if a custom layout function is set.
6329 * @param obj The box object
6330 * @param homogeneous The homogeneous flag
6332 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6335 * Get whether the box is using homogeneous mode or not
6337 * @param obj The box object
6338 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6340 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6343 * Add an object to the beginning of the pack list
6345 * Pack @p subobj into the box @p obj, placing it first in the list of
6346 * children objects. The actual position the object will get on screen
6347 * depends on the layout used. If no custom layout is set, it will be at
6348 * the top or left, depending if the box is vertical or horizontal,
6351 * @param obj The box object
6352 * @param subobj The object to add to the box
6354 * @see elm_box_pack_end()
6355 * @see elm_box_pack_before()
6356 * @see elm_box_pack_after()
6357 * @see elm_box_unpack()
6358 * @see elm_box_unpack_all()
6359 * @see elm_box_clear()
6361 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6364 * Add an object at the end of the pack list
6366 * Pack @p subobj into the box @p obj, placing it last in the list of
6367 * children objects. The actual position the object will get on screen
6368 * depends on the layout used. If no custom layout is set, it will be at
6369 * the bottom or right, depending if the box is vertical or horizontal,
6372 * @param obj The box object
6373 * @param subobj The object to add to the box
6375 * @see elm_box_pack_start()
6376 * @see elm_box_pack_before()
6377 * @see elm_box_pack_after()
6378 * @see elm_box_unpack()
6379 * @see elm_box_unpack_all()
6380 * @see elm_box_clear()
6382 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6385 * Adds an object to the box before the indicated object
6387 * This will add the @p subobj to the box indicated before the object
6388 * indicated with @p before. If @p before is not already in the box, results
6389 * are undefined. Before means either to the left of the indicated object or
6390 * above it depending on orientation.
6392 * @param obj The box object
6393 * @param subobj The object to add to the box
6394 * @param before The object before which to add it
6396 * @see elm_box_pack_start()
6397 * @see elm_box_pack_end()
6398 * @see elm_box_pack_after()
6399 * @see elm_box_unpack()
6400 * @see elm_box_unpack_all()
6401 * @see elm_box_clear()
6403 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6406 * Adds an object to the box after the indicated object
6408 * This will add the @p subobj to the box indicated after the object
6409 * indicated with @p after. If @p after is not already in the box, results
6410 * are undefined. After means either to the right of the indicated object or
6411 * below it depending on orientation.
6413 * @param obj The box object
6414 * @param subobj The object to add to the box
6415 * @param after The object after which to add it
6417 * @see elm_box_pack_start()
6418 * @see elm_box_pack_end()
6419 * @see elm_box_pack_before()
6420 * @see elm_box_unpack()
6421 * @see elm_box_unpack_all()
6422 * @see elm_box_clear()
6424 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6427 * Clear the box of all children
6429 * Remove all the elements contained by the box, deleting the respective
6432 * @param obj The box object
6434 * @see elm_box_unpack()
6435 * @see elm_box_unpack_all()
6437 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6442 * Remove the object given by @p subobj from the box @p obj without
6445 * @param obj The box object
6447 * @see elm_box_unpack_all()
6448 * @see elm_box_clear()
6450 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6453 * Remove all items from the box, without deleting them
6455 * Clear the box from all children, but don't delete the respective objects.
6456 * If no other references of the box children exist, the objects will never
6457 * be deleted, and thus the application will leak the memory. Make sure
6458 * when using this function that you hold a reference to all the objects
6459 * in the box @p obj.
6461 * @param obj The box object
6463 * @see elm_box_clear()
6464 * @see elm_box_unpack()
6466 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6469 * Retrieve a list of the objects packed into the box
6471 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6472 * The order of the list corresponds to the packing order the box uses.
6474 * You must free this list with eina_list_free() once you are done with it.
6476 * @param obj The box object
6478 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6481 * Set the space (padding) between the box's elements.
6483 * Extra space in pixels that will be added between a box child and its
6484 * neighbors after its containing cell has been calculated. This padding
6485 * is set for all elements in the box, besides any possible padding that
6486 * individual elements may have through their size hints.
6488 * @param obj The box object
6489 * @param horizontal The horizontal space between elements
6490 * @param vertical The vertical space between elements
6492 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6495 * Get the space (padding) between the box's elements.
6497 * @param obj The box object
6498 * @param horizontal The horizontal space between elements
6499 * @param vertical The vertical space between elements
6501 * @see elm_box_padding_set()
6503 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6506 * Set the alignment of the whole bouding box of contents.
6508 * Sets how the bounding box containing all the elements of the box, after
6509 * their sizes and position has been calculated, will be aligned within
6510 * the space given for the whole box widget.
6512 * @param obj The box object
6513 * @param horizontal The horizontal alignment of elements
6514 * @param vertical The vertical alignment of elements
6516 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6519 * Get the alignment of the whole bouding box of contents.
6521 * @param obj The box object
6522 * @param horizontal The horizontal alignment of elements
6523 * @param vertical The vertical alignment of elements
6525 * @see elm_box_align_set()
6527 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6530 * Force the box to recalculate its children packing.
6532 * If any children was added or removed, box will not calculate the
6533 * values immediately rather leaving it to the next main loop
6534 * iteration. While this is great as it would save lots of
6535 * recalculation, whenever you need to get the position of a just
6536 * added item you must force recalculate before doing so.
6538 * @param obj The box object.
6540 EAPI void elm_box_recalculate(Evas_Object *obj);
6543 * Set the layout defining function to be used by the box
6545 * Whenever anything changes that requires the box in @p obj to recalculate
6546 * the size and position of its elements, the function @p cb will be called
6547 * to determine what the layout of the children will be.
6549 * Once a custom function is set, everything about the children layout
6550 * is defined by it. The flags set by elm_box_horizontal_set() and
6551 * elm_box_homogeneous_set() no longer have any meaning, and the values
6552 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6553 * layout function to decide if they are used and how. These last two
6554 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6555 * passed to @p cb. The @c Evas_Object the function receives is not the
6556 * Elementary widget, but the internal Evas Box it uses, so none of the
6557 * functions described here can be used on it.
6559 * Any of the layout functions in @c Evas can be used here, as well as the
6560 * special elm_box_layout_transition().
6562 * The final @p data argument received by @p cb is the same @p data passed
6563 * here, and the @p free_data function will be called to free it
6564 * whenever the box is destroyed or another layout function is set.
6566 * Setting @p cb to NULL will revert back to the default layout function.
6568 * @param obj The box object
6569 * @param cb The callback function used for layout
6570 * @param data Data that will be passed to layout function
6571 * @param free_data Function called to free @p data
6573 * @see elm_box_layout_transition()
6575 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);
6578 * Special layout function that animates the transition from one layout to another
6580 * Normally, when switching the layout function for a box, this will be
6581 * reflected immediately on screen on the next render, but it's also
6582 * possible to do this through an animated transition.
6584 * This is done by creating an ::Elm_Box_Transition and setting the box
6585 * layout to this function.
6589 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6590 * evas_object_box_layout_vertical, // start
6591 * NULL, // data for initial layout
6592 * NULL, // free function for initial data
6593 * evas_object_box_layout_horizontal, // end
6594 * NULL, // data for final layout
6595 * NULL, // free function for final data
6596 * anim_end, // will be called when animation ends
6597 * NULL); // data for anim_end function\
6598 * elm_box_layout_set(box, elm_box_layout_transition, t,
6599 * elm_box_transition_free);
6602 * @note This function can only be used with elm_box_layout_set(). Calling
6603 * it directly will not have the expected results.
6605 * @see elm_box_transition_new
6606 * @see elm_box_transition_free
6607 * @see elm_box_layout_set
6609 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6612 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6614 * If you want to animate the change from one layout to another, you need
6615 * to set the layout function of the box to elm_box_layout_transition(),
6616 * passing as user data to it an instance of ::Elm_Box_Transition with the
6617 * necessary information to perform this animation. The free function to
6618 * set for the layout is elm_box_transition_free().
6620 * The parameters to create an ::Elm_Box_Transition sum up to how long
6621 * will it be, in seconds, a layout function to describe the initial point,
6622 * another for the final position of the children and one function to be
6623 * called when the whole animation ends. This last function is useful to
6624 * set the definitive layout for the box, usually the same as the end
6625 * layout for the animation, but could be used to start another transition.
6627 * @param start_layout The layout function that will be used to start the animation
6628 * @param start_layout_data The data to be passed the @p start_layout function
6629 * @param start_layout_free_data Function to free @p start_layout_data
6630 * @param end_layout The layout function that will be used to end the animation
6631 * @param end_layout_free_data The data to be passed the @p end_layout function
6632 * @param end_layout_free_data Function to free @p end_layout_data
6633 * @param transition_end_cb Callback function called when animation ends
6634 * @param transition_end_data Data to be passed to @p transition_end_cb
6635 * @return An instance of ::Elm_Box_Transition
6637 * @see elm_box_transition_new
6638 * @see elm_box_layout_transition
6640 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);
6643 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6645 * This function is mostly useful as the @c free_data parameter in
6646 * elm_box_layout_set() when elm_box_layout_transition().
6648 * @param data The Elm_Box_Transition instance to be freed.
6650 * @see elm_box_transition_new
6651 * @see elm_box_layout_transition
6653 EAPI void elm_box_transition_free(void *data);
6661 * @defgroup Button Button
6663 * @image html img/widget/button/preview-00.png
6664 * @image latex img/widget/button/preview-00.eps
6665 * @image html img/widget/button/preview-01.png
6666 * @image latex img/widget/button/preview-01.eps
6667 * @image html img/widget/button/preview-02.png
6668 * @image latex img/widget/button/preview-02.eps
6670 * This is a push-button. Press it and run some function. It can contain
6671 * a simple label and icon object and it also has an autorepeat feature.
6673 * This widgets emits the following signals:
6674 * @li "clicked": the user clicked the button (press/release).
6675 * @li "repeated": the user pressed the button without releasing it.
6676 * @li "pressed": button was pressed.
6677 * @li "unpressed": button was released after being pressed.
6678 * In all three cases, the @c event parameter of the callback will be
6681 * Also, defined in the default theme, the button has the following styles
6683 * @li default: a normal button.
6684 * @li anchor: Like default, but the button fades away when the mouse is not
6685 * over it, leaving only the text or icon.
6686 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6687 * continuous look across its options.
6688 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6690 * Default contents parts of the button widget that you can use for are:
6691 * @li "icon" - An icon of the button
6693 * Default text parts of the button widget that you can use for are:
6694 * @li "default" - Label of the button
6696 * Follow through a complete example @ref button_example_01 "here".
6701 * Add a new button to the parent's canvas
6703 * @param parent The parent object
6704 * @return The new object or NULL if it cannot be created
6706 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6709 * Set the label used in the button
6711 * The passed @p label can be NULL to clean any existing text in it and
6712 * leave the button as an icon only object.
6714 * @param obj The button object
6715 * @param label The text will be written on the button
6716 * @deprecated use elm_object_text_set() instead.
6718 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6721 * Get the label set for the button
6723 * The string returned is an internal pointer and should not be freed or
6724 * altered. It will also become invalid when the button is destroyed.
6725 * The string returned, if not NULL, is a stringshare, so if you need to
6726 * keep it around even after the button is destroyed, you can use
6727 * eina_stringshare_ref().
6729 * @param obj The button object
6730 * @return The text set to the label, or NULL if nothing is set
6731 * @deprecated use elm_object_text_set() instead.
6733 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6736 * Set the icon used for the button
6738 * Setting a new icon will delete any other that was previously set, making
6739 * any reference to them invalid. If you need to maintain the previous
6740 * object alive, unset it first with elm_button_icon_unset().
6742 * @param obj The button object
6743 * @param icon The icon object for the button
6744 * @deprecated use elm_object_part_content_set() instead.
6746 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6749 * Get the icon used for the button
6751 * Return the icon object which is set for this widget. If the button is
6752 * destroyed or another icon is set, the returned object will be deleted
6753 * and any reference to it will be invalid.
6755 * @param obj The button object
6756 * @return The icon object that is being used
6758 * @deprecated use elm_object_part_content_get() instead
6760 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6763 * Remove the icon set without deleting it and return the object
6765 * This function drops the reference the button holds of the icon object
6766 * and returns this last object. It is used in case you want to remove any
6767 * icon, or set another one, without deleting the actual object. The button
6768 * will be left without an icon set.
6770 * @param obj The button object
6771 * @return The icon object that was being used
6772 * @deprecated use elm_object_part_content_unset() instead.
6774 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6777 * Turn on/off the autorepeat event generated when the button is kept pressed
6779 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6780 * signal when they are clicked.
6782 * When on, keeping a button pressed will continuously emit a @c repeated
6783 * signal until the button is released. The time it takes until it starts
6784 * emitting the signal is given by
6785 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6786 * new emission by elm_button_autorepeat_gap_timeout_set().
6788 * @param obj The button object
6789 * @param on A bool to turn on/off the event
6791 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6794 * Get whether the autorepeat feature is enabled
6796 * @param obj The button object
6797 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6799 * @see elm_button_autorepeat_set()
6801 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6804 * Set the initial timeout before the autorepeat event is generated
6806 * Sets the timeout, in seconds, since the button is pressed until the
6807 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6808 * won't be any delay and the even will be fired the moment the button is
6811 * @param obj The button object
6812 * @param t Timeout in seconds
6814 * @see elm_button_autorepeat_set()
6815 * @see elm_button_autorepeat_gap_timeout_set()
6817 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6820 * Get the initial timeout before the autorepeat event is generated
6822 * @param obj The button object
6823 * @return Timeout in seconds
6825 * @see elm_button_autorepeat_initial_timeout_set()
6827 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6830 * Set the interval between each generated autorepeat event
6832 * After the first @c repeated event is fired, all subsequent ones will
6833 * follow after a delay of @p t seconds for each.
6835 * @param obj The button object
6836 * @param t Interval in seconds
6838 * @see elm_button_autorepeat_initial_timeout_set()
6840 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6843 * Get the interval between each generated autorepeat event
6845 * @param obj The button object
6846 * @return Interval in seconds
6848 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6855 * @defgroup File_Selector_Button File Selector Button
6857 * @image html img/widget/fileselector_button/preview-00.png
6858 * @image latex img/widget/fileselector_button/preview-00.eps
6859 * @image html img/widget/fileselector_button/preview-01.png
6860 * @image latex img/widget/fileselector_button/preview-01.eps
6861 * @image html img/widget/fileselector_button/preview-02.png
6862 * @image latex img/widget/fileselector_button/preview-02.eps
6864 * This is a button that, when clicked, creates an Elementary
6865 * window (or inner window) <b> with a @ref Fileselector "file
6866 * selector widget" within</b>. When a file is chosen, the (inner)
6867 * window is closed and the button emits a signal having the
6868 * selected file as it's @c event_info.
6870 * This widget encapsulates operations on its internal file
6871 * selector on its own API. There is less control over its file
6872 * selector than that one would have instatiating one directly.
6874 * The following styles are available for this button:
6877 * @li @c "hoversel_vertical"
6878 * @li @c "hoversel_vertical_entry"
6880 * Smart callbacks one can register to:
6881 * - @c "file,chosen" - the user has selected a path, whose string
6882 * pointer comes as the @c event_info data (a stringshared
6885 * Here is an example on its usage:
6886 * @li @ref fileselector_button_example
6888 * @see @ref File_Selector_Entry for a similar widget.
6893 * Add a new file selector button widget to the given parent
6894 * Elementary (container) object
6896 * @param parent The parent object
6897 * @return a new file selector button widget handle or @c NULL, on
6900 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6903 * Set the label for a given file selector button widget
6905 * @param obj The file selector button widget
6906 * @param label The text label to be displayed on @p obj
6908 * @deprecated use elm_object_text_set() instead.
6910 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6913 * Get the label set for a given file selector button widget
6915 * @param obj The file selector button widget
6916 * @return The button label
6918 * @deprecated use elm_object_text_set() instead.
6920 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6923 * Set the icon on a given file selector button widget
6925 * @param obj The file selector button widget
6926 * @param icon The icon object for the button
6928 * Once the icon object is set, a previously set one will be
6929 * deleted. If you want to keep the latter, use the
6930 * elm_fileselector_button_icon_unset() function.
6932 * @see elm_fileselector_button_icon_get()
6934 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6937 * Get the icon set for a given file selector button widget
6939 * @param obj The file selector button widget
6940 * @return The icon object currently set on @p obj or @c NULL, if
6943 * @see elm_fileselector_button_icon_set()
6945 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6948 * Unset the icon used in a given file selector button widget
6950 * @param obj The file selector button widget
6951 * @return The icon object that was being used on @p obj or @c
6954 * Unparent and return the icon object which was set for this
6957 * @see elm_fileselector_button_icon_set()
6959 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6962 * Set the title for a given file selector button widget's window
6964 * @param obj The file selector button widget
6965 * @param title The title string
6967 * This will change the window's title, when the file selector pops
6968 * out after a click on the button. Those windows have the default
6969 * (unlocalized) value of @c "Select a file" as titles.
6971 * @note It will only take any effect if the file selector
6972 * button widget is @b not under "inwin mode".
6974 * @see elm_fileselector_button_window_title_get()
6976 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6979 * Get the title set for a given file selector button widget's
6982 * @param obj The file selector button widget
6983 * @return Title of the file selector button's window
6985 * @see elm_fileselector_button_window_title_get() for more details
6987 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6990 * Set the size of a given file selector button widget's window,
6991 * holding the file selector itself.
6993 * @param obj The file selector button widget
6994 * @param width The window's width
6995 * @param height The window's height
6997 * @note it will only take any effect if the file selector button
6998 * widget is @b not under "inwin mode". The default size for the
6999 * window (when applicable) is 400x400 pixels.
7001 * @see elm_fileselector_button_window_size_get()
7003 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7006 * Get the size of a given file selector button widget's window,
7007 * holding the file selector itself.
7009 * @param obj The file selector button widget
7010 * @param width Pointer into which to store the width value
7011 * @param height Pointer into which to store the height value
7013 * @note Use @c NULL pointers on the size values you're not
7014 * interested in: they'll be ignored by the function.
7016 * @see elm_fileselector_button_window_size_set(), for more details
7018 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7021 * Set the initial file system path for a given file selector
7024 * @param obj The file selector button widget
7025 * @param path The path string
7027 * It must be a <b>directory</b> path, which will have the contents
7028 * displayed initially in the file selector's view, when invoked
7029 * from @p obj. The default initial path is the @c "HOME"
7030 * environment variable's value.
7032 * @see elm_fileselector_button_path_get()
7034 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7037 * Get the initial file system path set for a given file selector
7040 * @param obj The file selector button widget
7041 * @return path The path string
7043 * @see elm_fileselector_button_path_set() for more details
7045 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7048 * Enable/disable a tree view in the given file selector button
7049 * widget's internal file selector
7051 * @param obj The file selector button widget
7052 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7055 * This has the same effect as elm_fileselector_expandable_set(),
7056 * but now applied to a file selector button's internal file
7059 * @note There's no way to put a file selector button's internal
7060 * file selector in "grid mode", as one may do with "pure" file
7063 * @see elm_fileselector_expandable_get()
7065 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7068 * Get whether tree view is enabled for the given file selector
7069 * button widget's internal file selector
7071 * @param obj The file selector button widget
7072 * @return @c EINA_TRUE if @p obj widget's internal file selector
7073 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7075 * @see elm_fileselector_expandable_set() for more details
7077 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7080 * Set whether a given file selector button widget's internal file
7081 * selector is to display folders only or the directory contents,
7084 * @param obj The file selector button widget
7085 * @param only @c EINA_TRUE to make @p obj widget's internal file
7086 * selector only display directories, @c EINA_FALSE to make files
7087 * to be displayed in it too
7089 * This has the same effect as elm_fileselector_folder_only_set(),
7090 * but now applied to a file selector button's internal file
7093 * @see elm_fileselector_folder_only_get()
7095 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7098 * Get whether a given file selector button widget's internal file
7099 * selector is displaying folders only or the directory contents,
7102 * @param obj The file selector button widget
7103 * @return @c EINA_TRUE if @p obj widget's internal file
7104 * selector is only displaying directories, @c EINA_FALSE if files
7105 * are being displayed in it too (and on errors)
7107 * @see elm_fileselector_button_folder_only_set() for more details
7109 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7112 * Enable/disable the file name entry box where the user can type
7113 * in a name for a file, in a given file selector button widget's
7114 * internal file selector.
7116 * @param obj The file selector button widget
7117 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7118 * file selector a "saving dialog", @c EINA_FALSE otherwise
7120 * This has the same effect as elm_fileselector_is_save_set(),
7121 * but now applied to a file selector button's internal file
7124 * @see elm_fileselector_is_save_get()
7126 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7129 * Get whether the given file selector button widget's internal
7130 * file selector is in "saving dialog" mode
7132 * @param obj The file selector button widget
7133 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7134 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7137 * @see elm_fileselector_button_is_save_set() for more details
7139 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7142 * Set whether a given file selector button widget's internal file
7143 * selector will raise an Elementary "inner window", instead of a
7144 * dedicated Elementary window. By default, it won't.
7146 * @param obj The file selector button widget
7147 * @param value @c EINA_TRUE to make it use an inner window, @c
7148 * EINA_TRUE to make it use a dedicated window
7150 * @see elm_win_inwin_add() for more information on inner windows
7151 * @see elm_fileselector_button_inwin_mode_get()
7153 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7156 * Get whether a given file selector button widget's internal file
7157 * selector will raise an Elementary "inner window", instead of a
7158 * dedicated Elementary window.
7160 * @param obj The file selector button widget
7161 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7162 * if it will use a dedicated window
7164 * @see elm_fileselector_button_inwin_mode_set() for more details
7166 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7173 * @defgroup File_Selector_Entry File Selector Entry
7175 * @image html img/widget/fileselector_entry/preview-00.png
7176 * @image latex img/widget/fileselector_entry/preview-00.eps
7178 * This is an entry made to be filled with or display a <b>file
7179 * system path string</b>. Besides the entry itself, the widget has
7180 * a @ref File_Selector_Button "file selector button" on its side,
7181 * which will raise an internal @ref Fileselector "file selector widget",
7182 * when clicked, for path selection aided by file system
7185 * This file selector may appear in an Elementary window or in an
7186 * inner window. When a file is chosen from it, the (inner) window
7187 * is closed and the selected file's path string is exposed both as
7188 * an smart event and as the new text on the entry.
7190 * This widget encapsulates operations on its internal file
7191 * selector on its own API. There is less control over its file
7192 * selector than that one would have instatiating one directly.
7194 * Smart callbacks one can register to:
7195 * - @c "changed" - The text within the entry was changed
7196 * - @c "activated" - The entry has had editing finished and
7197 * changes are to be "committed"
7198 * - @c "press" - The entry has been clicked
7199 * - @c "longpressed" - The entry has been clicked (and held) for a
7201 * - @c "clicked" - The entry has been clicked
7202 * - @c "clicked,double" - The entry has been double clicked
7203 * - @c "focused" - The entry has received focus
7204 * - @c "unfocused" - The entry has lost focus
7205 * - @c "selection,paste" - A paste action has occurred on the
7207 * - @c "selection,copy" - A copy action has occurred on the entry
7208 * - @c "selection,cut" - A cut action has occurred on the entry
7209 * - @c "unpressed" - The file selector entry's button was released
7210 * after being pressed.
7211 * - @c "file,chosen" - The user has selected a path via the file
7212 * selector entry's internal file selector, whose string pointer
7213 * comes as the @c event_info data (a stringshared string)
7215 * Here is an example on its usage:
7216 * @li @ref fileselector_entry_example
7218 * @see @ref File_Selector_Button for a similar widget.
7223 * Add a new file selector entry widget to the given parent
7224 * Elementary (container) object
7226 * @param parent The parent object
7227 * @return a new file selector entry widget handle or @c NULL, on
7230 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7233 * Set the label for a given file selector entry widget's button
7235 * @param obj The file selector entry widget
7236 * @param label The text label to be displayed on @p obj widget's
7239 * @deprecated use elm_object_text_set() instead.
7241 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7244 * Get the label set for a given file selector entry widget's button
7246 * @param obj The file selector entry widget
7247 * @return The widget button's label
7249 * @deprecated use elm_object_text_set() instead.
7251 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7254 * Set the icon on a given file selector entry widget's button
7256 * @param obj The file selector entry widget
7257 * @param icon The icon object for the entry's button
7259 * Once the icon object is set, a previously set one will be
7260 * deleted. If you want to keep the latter, use the
7261 * elm_fileselector_entry_button_icon_unset() function.
7263 * @see elm_fileselector_entry_button_icon_get()
7265 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7268 * Get the icon set for a given file selector entry widget's button
7270 * @param obj The file selector entry widget
7271 * @return The icon object currently set on @p obj widget's button
7272 * or @c NULL, if none is
7274 * @see elm_fileselector_entry_button_icon_set()
7276 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7279 * Unset the icon used in a given file selector entry widget's
7282 * @param obj The file selector entry widget
7283 * @return The icon object that was being used on @p obj widget's
7284 * button or @c NULL, on errors
7286 * Unparent and return the icon object which was set for this
7289 * @see elm_fileselector_entry_button_icon_set()
7291 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7294 * Set the title for a given file selector entry widget's window
7296 * @param obj The file selector entry widget
7297 * @param title The title string
7299 * This will change the window's title, when the file selector pops
7300 * out after a click on the entry's button. Those windows have the
7301 * default (unlocalized) value of @c "Select a file" as titles.
7303 * @note It will only take any effect if the file selector
7304 * entry widget is @b not under "inwin mode".
7306 * @see elm_fileselector_entry_window_title_get()
7308 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7311 * Get the title set for a given file selector entry widget's
7314 * @param obj The file selector entry widget
7315 * @return Title of the file selector entry's window
7317 * @see elm_fileselector_entry_window_title_get() for more details
7319 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7322 * Set the size of a given file selector entry widget's window,
7323 * holding the file selector itself.
7325 * @param obj The file selector entry widget
7326 * @param width The window's width
7327 * @param height The window's height
7329 * @note it will only take any effect if the file selector entry
7330 * widget is @b not under "inwin mode". The default size for the
7331 * window (when applicable) is 400x400 pixels.
7333 * @see elm_fileselector_entry_window_size_get()
7335 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7338 * Get the size of a given file selector entry widget's window,
7339 * holding the file selector itself.
7341 * @param obj The file selector entry widget
7342 * @param width Pointer into which to store the width value
7343 * @param height Pointer into which to store the height value
7345 * @note Use @c NULL pointers on the size values you're not
7346 * interested in: they'll be ignored by the function.
7348 * @see elm_fileselector_entry_window_size_set(), for more details
7350 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7353 * Set the initial file system path and the entry's path string for
7354 * a given file selector entry widget
7356 * @param obj The file selector entry widget
7357 * @param path The path string
7359 * It must be a <b>directory</b> path, which will have the contents
7360 * displayed initially in the file selector's view, when invoked
7361 * from @p obj. The default initial path is the @c "HOME"
7362 * environment variable's value.
7364 * @see elm_fileselector_entry_path_get()
7366 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7369 * Get the entry's path string for a given file selector entry
7372 * @param obj The file selector entry widget
7373 * @return path The path string
7375 * @see elm_fileselector_entry_path_set() for more details
7377 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7380 * Enable/disable a tree view in the given file selector entry
7381 * widget's internal file selector
7383 * @param obj The file selector entry widget
7384 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7387 * This has the same effect as elm_fileselector_expandable_set(),
7388 * but now applied to a file selector entry's internal file
7391 * @note There's no way to put a file selector entry's internal
7392 * file selector in "grid mode", as one may do with "pure" file
7395 * @see elm_fileselector_expandable_get()
7397 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7400 * Get whether tree view is enabled for the given file selector
7401 * entry widget's internal file selector
7403 * @param obj The file selector entry widget
7404 * @return @c EINA_TRUE if @p obj widget's internal file selector
7405 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7407 * @see elm_fileselector_expandable_set() for more details
7409 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7412 * Set whether a given file selector entry widget's internal file
7413 * selector is to display folders only or the directory contents,
7416 * @param obj The file selector entry widget
7417 * @param only @c EINA_TRUE to make @p obj widget's internal file
7418 * selector only display directories, @c EINA_FALSE to make files
7419 * to be displayed in it too
7421 * This has the same effect as elm_fileselector_folder_only_set(),
7422 * but now applied to a file selector entry's internal file
7425 * @see elm_fileselector_folder_only_get()
7427 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7430 * Get whether a given file selector entry widget's internal file
7431 * selector is displaying folders only or the directory contents,
7434 * @param obj The file selector entry widget
7435 * @return @c EINA_TRUE if @p obj widget's internal file
7436 * selector is only displaying directories, @c EINA_FALSE if files
7437 * are being displayed in it too (and on errors)
7439 * @see elm_fileselector_entry_folder_only_set() for more details
7441 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7444 * Enable/disable the file name entry box where the user can type
7445 * in a name for a file, in a given file selector entry widget's
7446 * internal file selector.
7448 * @param obj The file selector entry widget
7449 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7450 * file selector a "saving dialog", @c EINA_FALSE otherwise
7452 * This has the same effect as elm_fileselector_is_save_set(),
7453 * but now applied to a file selector entry's internal file
7456 * @see elm_fileselector_is_save_get()
7458 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7461 * Get whether the given file selector entry widget's internal
7462 * file selector is in "saving dialog" mode
7464 * @param obj The file selector entry widget
7465 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7466 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7469 * @see elm_fileselector_entry_is_save_set() for more details
7471 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7474 * Set whether a given file selector entry widget's internal file
7475 * selector will raise an Elementary "inner window", instead of a
7476 * dedicated Elementary window. By default, it won't.
7478 * @param obj The file selector entry widget
7479 * @param value @c EINA_TRUE to make it use an inner window, @c
7480 * EINA_TRUE to make it use a dedicated window
7482 * @see elm_win_inwin_add() for more information on inner windows
7483 * @see elm_fileselector_entry_inwin_mode_get()
7485 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7488 * Get whether a given file selector entry widget's internal file
7489 * selector will raise an Elementary "inner window", instead of a
7490 * dedicated Elementary window.
7492 * @param obj The file selector entry widget
7493 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7494 * if it will use a dedicated window
7496 * @see elm_fileselector_entry_inwin_mode_set() for more details
7498 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7501 * Set the initial file system path for a given file selector entry
7504 * @param obj The file selector entry widget
7505 * @param path The path string
7507 * It must be a <b>directory</b> path, which will have the contents
7508 * displayed initially in the file selector's view, when invoked
7509 * from @p obj. The default initial path is the @c "HOME"
7510 * environment variable's value.
7512 * @see elm_fileselector_entry_path_get()
7514 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7517 * Get the parent directory's path to the latest file selection on
7518 * a given filer selector entry widget
7520 * @param obj The file selector object
7521 * @return The (full) path of the directory of the last selection
7522 * on @p obj widget, a @b stringshared string
7524 * @see elm_fileselector_entry_path_set()
7526 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7533 * @defgroup Scroller Scroller
7535 * A scroller holds a single object and "scrolls it around". This means that
7536 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7537 * region around, allowing to move through a much larger object that is
7538 * contained in the scroller. The scroller will always have a small minimum
7539 * size by default as it won't be limited by the contents of the scroller.
7541 * Signals that you can add callbacks for are:
7542 * @li "edge,left" - the left edge of the content has been reached
7543 * @li "edge,right" - the right edge of the content has been reached
7544 * @li "edge,top" - the top edge of the content has been reached
7545 * @li "edge,bottom" - the bottom edge of the content has been reached
7546 * @li "scroll" - the content has been scrolled (moved)
7547 * @li "scroll,anim,start" - scrolling animation has started
7548 * @li "scroll,anim,stop" - scrolling animation has stopped
7549 * @li "scroll,drag,start" - dragging the contents around has started
7550 * @li "scroll,drag,stop" - dragging the contents around has stopped
7551 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7554 * @note When Elemementary is in embedded mode the scrollbars will not be
7555 * dragable, they appear merely as indicators of how much has been scrolled.
7556 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7557 * fingerscroll) won't work.
7559 * Default contents parts of the scroller widget that you can use for are:
7560 * @li "default" - A content of the scroller
7562 * In @ref tutorial_scroller you'll find an example of how to use most of
7568 * @brief Type that controls when scrollbars should appear.
7570 * @see elm_scroller_policy_set()
7572 typedef enum _Elm_Scroller_Policy
7574 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7575 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7576 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7577 ELM_SCROLLER_POLICY_LAST
7578 } Elm_Scroller_Policy;
7581 * @brief Add a new scroller to the parent
7583 * @param parent The parent object
7584 * @return The new object or NULL if it cannot be created
7586 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7589 * @brief Set the content of the scroller widget (the object to be scrolled around).
7591 * @param obj The scroller object
7592 * @param content The new content object
7594 * Once the content object is set, a previously set one will be deleted.
7595 * If you want to keep that old content object, use the
7596 * elm_scroller_content_unset() function.
7597 * @deprecated use elm_object_content_set() instead
7599 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7602 * @brief Get the content of the scroller widget
7604 * @param obj The slider object
7605 * @return The content that is being used
7607 * Return the content object which is set for this widget
7609 * @see elm_scroller_content_set()
7610 * @deprecated use elm_object_content_get() instead.
7612 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7615 * @brief Unset the content of the scroller widget
7617 * @param obj The slider object
7618 * @return The content that was being used
7620 * Unparent and return the content object which was set for this widget
7622 * @see elm_scroller_content_set()
7623 * @deprecated use elm_object_content_unset() instead.
7625 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7628 * @brief Set custom theme elements for the scroller
7630 * @param obj The scroller object
7631 * @param widget The widget name to use (default is "scroller")
7632 * @param base The base name to use (default is "base")
7634 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7637 * @brief Make the scroller minimum size limited to the minimum size of the content
7639 * @param obj The scroller object
7640 * @param w Enable limiting minimum size horizontally
7641 * @param h Enable limiting minimum size vertically
7643 * By default the scroller will be as small as its design allows,
7644 * irrespective of its content. This will make the scroller minimum size the
7645 * right size horizontally and/or vertically to perfectly fit its content in
7648 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7651 * @brief Show a specific virtual region within the scroller content object
7653 * @param obj The scroller object
7654 * @param x X coordinate of the region
7655 * @param y Y coordinate of the region
7656 * @param w Width of the region
7657 * @param h Height of the region
7659 * This will ensure all (or part if it does not fit) of the designated
7660 * region in the virtual content object (0, 0 starting at the top-left of the
7661 * virtual content object) is shown within the scroller.
7663 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);
7666 * @brief Set the scrollbar visibility policy
7668 * @param obj The scroller object
7669 * @param policy_h Horizontal scrollbar policy
7670 * @param policy_v Vertical scrollbar policy
7672 * This sets the scrollbar visibility policy for the given scroller.
7673 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7674 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7675 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7676 * respectively for the horizontal and vertical scrollbars.
7678 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7681 * @brief Gets scrollbar visibility policy
7683 * @param obj The scroller object
7684 * @param policy_h Horizontal scrollbar policy
7685 * @param policy_v Vertical scrollbar policy
7687 * @see elm_scroller_policy_set()
7689 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7692 * @brief Get the currently visible content region
7694 * @param obj The scroller object
7695 * @param x X coordinate of the region
7696 * @param y Y coordinate of the region
7697 * @param w Width of the region
7698 * @param h Height of the region
7700 * This gets the current region in the content object that is visible through
7701 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7702 * w, @p h values pointed to.
7704 * @note All coordinates are relative to the content.
7706 * @see elm_scroller_region_show()
7708 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);
7711 * @brief Get the size of the content object
7713 * @param obj The scroller object
7714 * @param w Width of the content object.
7715 * @param h Height of the content object.
7717 * This gets the size of the content object of the scroller.
7719 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7722 * @brief Set bouncing behavior
7724 * @param obj The scroller object
7725 * @param h_bounce Allow bounce horizontally
7726 * @param v_bounce Allow bounce vertically
7728 * When scrolling, the scroller may "bounce" when reaching an edge of the
7729 * content object. This is a visual way to indicate the end has been reached.
7730 * This is enabled by default for both axis. This API will set if it is enabled
7731 * for the given axis with the boolean parameters for each axis.
7733 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7736 * @brief Get the bounce behaviour
7738 * @param obj The Scroller object
7739 * @param h_bounce Will the scroller bounce horizontally or not
7740 * @param v_bounce Will the scroller bounce vertically or not
7742 * @see elm_scroller_bounce_set()
7744 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7747 * @brief Set scroll page size relative to viewport size.
7749 * @param obj The scroller object
7750 * @param h_pagerel The horizontal page relative size
7751 * @param v_pagerel The vertical page relative size
7753 * The scroller is capable of limiting scrolling by the user to "pages". That
7754 * is to jump by and only show a "whole page" at a time as if the continuous
7755 * area of the scroller content is split into page sized pieces. This sets
7756 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7757 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7758 * axis. This is mutually exclusive with page size
7759 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7760 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7761 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7764 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7767 * @brief Set scroll page size.
7769 * @param obj The scroller object
7770 * @param h_pagesize The horizontal page size
7771 * @param v_pagesize The vertical page size
7773 * This sets the page size to an absolute fixed value, with 0 turning it off
7776 * @see elm_scroller_page_relative_set()
7778 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7781 * @brief Get scroll current page number.
7783 * @param obj The scroller object
7784 * @param h_pagenumber The horizontal page number
7785 * @param v_pagenumber The vertical page number
7787 * The page number starts from 0. 0 is the first page.
7788 * Current page means the page which meets the top-left of the viewport.
7789 * If there are two or more pages in the viewport, it returns the number of the page
7790 * which meets the top-left of the viewport.
7792 * @see elm_scroller_last_page_get()
7793 * @see elm_scroller_page_show()
7794 * @see elm_scroller_page_brint_in()
7796 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7799 * @brief Get scroll last page number.
7801 * @param obj The scroller object
7802 * @param h_pagenumber The horizontal page number
7803 * @param v_pagenumber The vertical page number
7805 * The page number starts from 0. 0 is the first page.
7806 * This returns the last page number among the pages.
7808 * @see elm_scroller_current_page_get()
7809 * @see elm_scroller_page_show()
7810 * @see elm_scroller_page_brint_in()
7812 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7815 * Show a specific virtual region within the scroller content object by page number.
7817 * @param obj The scroller object
7818 * @param h_pagenumber The horizontal page number
7819 * @param v_pagenumber The vertical page number
7821 * 0, 0 of the indicated page is located at the top-left of the viewport.
7822 * This will jump to the page directly without animation.
7827 * sc = elm_scroller_add(win);
7828 * elm_scroller_content_set(sc, content);
7829 * elm_scroller_page_relative_set(sc, 1, 0);
7830 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7831 * elm_scroller_page_show(sc, h_page + 1, v_page);
7834 * @see elm_scroller_page_bring_in()
7836 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7839 * Show a specific virtual region within the scroller content object by page number.
7841 * @param obj The scroller object
7842 * @param h_pagenumber The horizontal page number
7843 * @param v_pagenumber The vertical page number
7845 * 0, 0 of the indicated page is located at the top-left of the viewport.
7846 * This will slide to the page with animation.
7851 * sc = elm_scroller_add(win);
7852 * elm_scroller_content_set(sc, content);
7853 * elm_scroller_page_relative_set(sc, 1, 0);
7854 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7855 * elm_scroller_page_bring_in(sc, h_page, v_page);
7858 * @see elm_scroller_page_show()
7860 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7863 * @brief Show a specific virtual region within the scroller content object.
7865 * @param obj The scroller object
7866 * @param x X coordinate of the region
7867 * @param y Y coordinate of the region
7868 * @param w Width of the region
7869 * @param h Height of the region
7871 * This will ensure all (or part if it does not fit) of the designated
7872 * region in the virtual content object (0, 0 starting at the top-left of the
7873 * virtual content object) is shown within the scroller. Unlike
7874 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7875 * to this location (if configuration in general calls for transitions). It
7876 * may not jump immediately to the new location and make take a while and
7877 * show other content along the way.
7879 * @see elm_scroller_region_show()
7881 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);
7884 * @brief Set event propagation on a scroller
7886 * @param obj The scroller object
7887 * @param propagation If propagation is enabled or not
7889 * This enables or disabled event propagation from the scroller content to
7890 * the scroller and its parent. By default event propagation is disabled.
7892 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7895 * @brief Get event propagation for a scroller
7897 * @param obj The scroller object
7898 * @return The propagation state
7900 * This gets the event propagation for a scroller.
7902 * @see elm_scroller_propagate_events_set()
7904 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7907 * @brief Set scrolling gravity on a scroller
7909 * @param obj The scroller object
7910 * @param x The scrolling horizontal gravity
7911 * @param y The scrolling vertical gravity
7913 * The gravity, defines how the scroller will adjust its view
7914 * when the size of the scroller contents increase.
7916 * The scroller will adjust the view to glue itself as follows.
7918 * x=0.0, for showing the left most region of the content.
7919 * x=1.0, for showing the right most region of the content.
7920 * y=0.0, for showing the bottom most region of the content.
7921 * y=1.0, for showing the top most region of the content.
7923 * Default values for x and y are 0.0
7925 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7928 * @brief Get scrolling gravity values for a scroller
7930 * @param obj The scroller object
7931 * @param x The scrolling horizontal gravity
7932 * @param y The scrolling vertical gravity
7934 * This gets gravity values for a scroller.
7936 * @see elm_scroller_gravity_set()
7939 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7946 * @defgroup Label Label
7948 * @image html img/widget/label/preview-00.png
7949 * @image latex img/widget/label/preview-00.eps
7951 * @brief Widget to display text, with simple html-like markup.
7953 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7954 * text doesn't fit the geometry of the label it will be ellipsized or be
7955 * cut. Elementary provides several styles for this widget:
7956 * @li default - No animation
7957 * @li marker - Centers the text in the label and make it bold by default
7958 * @li slide_long - The entire text appears from the right of the screen and
7959 * slides until it disappears in the left of the screen(reappering on the
7961 * @li slide_short - The text appears in the left of the label and slides to
7962 * the right to show the overflow. When all of the text has been shown the
7963 * position is reset.
7964 * @li slide_bounce - The text appears in the left of the label and slides to
7965 * the right to show the overflow. When all of the text has been shown the
7966 * animation reverses, moving the text to the left.
7968 * Custom themes can of course invent new markup tags and style them any way
7971 * The following signals may be emitted by the label widget:
7972 * @li "language,changed": The program's language changed.
7974 * See @ref tutorial_label for a demonstration of how to use a label widget.
7979 * @brief Add a new label to the parent
7981 * @param parent The parent object
7982 * @return The new object or NULL if it cannot be created
7984 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7987 * @brief Set the label on the label object
7989 * @param obj The label object
7990 * @param label The label will be used on the label object
7991 * @deprecated See elm_object_text_set()
7993 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7996 * @brief Get the label used on the label object
7998 * @param obj The label object
7999 * @return The string inside the label
8000 * @deprecated See elm_object_text_get()
8002 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8005 * @brief Set the wrapping behavior of the label
8007 * @param obj The label object
8008 * @param wrap To wrap text or not
8010 * By default no wrapping is done. Possible values for @p wrap are:
8011 * @li ELM_WRAP_NONE - No wrapping
8012 * @li ELM_WRAP_CHAR - wrap between characters
8013 * @li ELM_WRAP_WORD - wrap between words
8014 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
8016 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8019 * @brief Get the wrapping behavior of the label
8021 * @param obj The label object
8024 * @see elm_label_line_wrap_set()
8026 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8029 * @brief Set wrap width of the label
8031 * @param obj The label object
8032 * @param w The wrap width in pixels at a minimum where words need to wrap
8034 * This function sets the maximum width size hint of the label.
8036 * @warning This is only relevant if the label is inside a container.
8038 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
8041 * @brief Get wrap width of the label
8043 * @param obj The label object
8044 * @return The wrap width in pixels at a minimum where words need to wrap
8046 * @see elm_label_wrap_width_set()
8048 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8051 * @brief Set wrap height of the label
8053 * @param obj The label object
8054 * @param h The wrap height in pixels at a minimum where words need to wrap
8056 * This function sets the maximum height size hint of the label.
8058 * @warning This is only relevant if the label is inside a container.
8060 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
8063 * @brief get wrap width of the label
8065 * @param obj The label object
8066 * @return The wrap height in pixels at a minimum where words need to wrap
8068 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8071 * @brief Set the font size on the label object.
8073 * @param obj The label object
8074 * @param size font size
8076 * @warning NEVER use this. It is for hyper-special cases only. use styles
8077 * instead. e.g. "default", "marker", "slide_long" etc.
8079 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
8082 * @brief Set the text color on the label object
8084 * @param obj The label object
8085 * @param r Red property background color of The label object
8086 * @param g Green property background color of The label object
8087 * @param b Blue property background color of The label object
8088 * @param a Alpha property background color of The label object
8090 * @warning NEVER use this. It is for hyper-special cases only. use styles
8091 * instead. e.g. "default", "marker", "slide_long" etc.
8093 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);
8096 * @brief Set the text align on the label object
8098 * @param obj The label object
8099 * @param align align mode ("left", "center", "right")
8101 * @warning NEVER use this. It is for hyper-special cases only. use styles
8102 * instead. e.g. "default", "marker", "slide_long" etc.
8104 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
8107 * @brief Set background color of the label
8109 * @param obj The label object
8110 * @param r Red property background color of The label object
8111 * @param g Green property background color of The label object
8112 * @param b Blue property background color of The label object
8113 * @param a Alpha property background alpha of The label object
8115 * @warning NEVER use this. It is for hyper-special cases only. use styles
8116 * instead. e.g. "default", "marker", "slide_long" etc.
8118 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);
8121 * @brief Set the ellipsis behavior of the label
8123 * @param obj The label object
8124 * @param ellipsis To ellipsis text or not
8126 * If set to true and the text doesn't fit in the label an ellipsis("...")
8127 * will be shown at the end of the widget.
8129 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
8130 * choosen wrap method was ELM_WRAP_WORD.
8132 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
8135 * @brief Set the text slide of the label
8137 * @param obj The label object
8138 * @param slide To start slide or stop
8140 * If set to true, the text of the label will slide/scroll through the length of
8143 * @warning This only works with the themes "slide_short", "slide_long" and
8146 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
8149 * @brief Get the text slide mode of the label
8151 * @param obj The label object
8152 * @return slide slide mode value
8154 * @see elm_label_slide_set()
8156 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8159 * @brief Set the slide duration(speed) of the label
8161 * @param obj The label object
8162 * @return The duration in seconds in moving text from slide begin position
8163 * to slide end position
8165 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
8168 * @brief Get the slide duration(speed) of the label
8170 * @param obj The label object
8171 * @return The duration time in moving text from slide begin position to slide end position
8173 * @see elm_label_slide_duration_set()
8175 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8182 * @defgroup Toggle Toggle
8184 * @image html img/widget/toggle/preview-00.png
8185 * @image latex img/widget/toggle/preview-00.eps
8187 * @brief A toggle is a slider which can be used to toggle between
8188 * two values. It has two states: on and off.
8190 * This widget is deprecated. Please use elm_check_add() instead using the
8191 * toggle style like:
8194 * obj = elm_check_add(parent);
8195 * elm_object_style_set(obj, "toggle");
8196 * elm_object_part_text_set(obj, "on", "ON");
8197 * elm_object_part_text_set(obj, "off", "OFF");
8200 * Signals that you can add callbacks for are:
8201 * @li "changed" - Whenever the toggle value has been changed. Is not called
8202 * until the toggle is released by the cursor (assuming it
8203 * has been triggered by the cursor in the first place).
8205 * Default contents parts of the toggle widget that you can use for are:
8206 * @li "icon" - An icon of the toggle
8208 * Default text parts of the toggle widget that you can use for are:
8209 * @li "elm.text" - Label of the toggle
8211 * @ref tutorial_toggle show how to use a toggle.
8216 * @brief Add a toggle to @p parent.
8218 * @param parent The parent object
8220 * @return The toggle object
8222 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8225 * @brief Sets the label to be displayed with the toggle.
8227 * @param obj The toggle object
8228 * @param label The label to be displayed
8230 * @deprecated use elm_object_text_set() instead.
8232 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8235 * @brief Gets the label of the toggle
8237 * @param obj toggle object
8238 * @return The label of the toggle
8240 * @deprecated use elm_object_text_get() instead.
8242 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8245 * @brief Set the icon used for the toggle
8247 * @param obj The toggle object
8248 * @param icon The icon object for the button
8250 * Once the icon object is set, a previously set one will be deleted
8251 * If you want to keep that old content object, use the
8252 * elm_toggle_icon_unset() function.
8254 * @deprecated use elm_object_part_content_set() instead.
8256 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8259 * @brief Get the icon used for the toggle
8261 * @param obj The toggle object
8262 * @return The icon object that is being used
8264 * Return the icon object which is set for this widget.
8266 * @see elm_toggle_icon_set()
8268 * @deprecated use elm_object_part_content_get() instead.
8270 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8273 * @brief Unset the icon used for the toggle
8275 * @param obj The toggle object
8276 * @return The icon object that was being used
8278 * Unparent and return the icon object which was set for this widget.
8280 * @see elm_toggle_icon_set()
8282 * @deprecated use elm_object_part_content_unset() instead.
8284 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8287 * @brief Sets the labels to be associated with the on and off states of the toggle.
8289 * @param obj The toggle object
8290 * @param onlabel The label displayed when the toggle is in the "on" state
8291 * @param offlabel The label displayed when the toggle is in the "off" state
8293 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8296 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8299 * @brief Gets the labels associated with the on and off states of the
8302 * @param obj The toggle object
8303 * @param onlabel A char** to place the onlabel of @p obj into
8304 * @param offlabel A char** to place the offlabel of @p obj into
8306 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8309 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8312 * @brief Sets the state of the toggle to @p state.
8314 * @param obj The toggle object
8315 * @param state The state of @p obj
8317 * @deprecated use elm_check_state_set() instead.
8319 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8322 * @brief Gets the state of the toggle to @p state.
8324 * @param obj The toggle object
8325 * @return The state of @p obj
8327 * @deprecated use elm_check_state_get() instead.
8329 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8332 * @brief Sets the state pointer of the toggle to @p statep.
8334 * @param obj The toggle object
8335 * @param statep The state pointer of @p obj
8337 * @deprecated use elm_check_state_pointer_set() instead.
8339 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8346 * @defgroup Frame Frame
8348 * @image html img/widget/frame/preview-00.png
8349 * @image latex img/widget/frame/preview-00.eps
8351 * @brief Frame is a widget that holds some content and has a title.
8353 * The default look is a frame with a title, but Frame supports multple
8361 * @li outdent_bottom
8363 * Of all this styles only default shows the title. Frame emits no signals.
8365 * Default contents parts of the frame widget that you can use for are:
8366 * @li "default" - A content of the frame
8368 * Default text parts of the frame widget that you can use for are:
8369 * @li "elm.text" - Label of the frame
8371 * For a detailed example see the @ref tutorial_frame.
8377 * @brief Add a new frame to the parent
8379 * @param parent The parent object
8380 * @return The new object or NULL if it cannot be created
8382 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8385 * @brief Set the frame label
8387 * @param obj The frame object
8388 * @param label The label of this frame object
8390 * @deprecated use elm_object_text_set() instead.
8392 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8395 * @brief Get the frame label
8397 * @param obj The frame object
8399 * @return The label of this frame objet or NULL if unable to get frame
8401 * @deprecated use elm_object_text_get() instead.
8403 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8406 * @brief Set the content of the frame widget
8408 * Once the content object is set, a previously set one will be deleted.
8409 * If you want to keep that old content object, use the
8410 * elm_frame_content_unset() function.
8412 * @param obj The frame object
8413 * @param content The content will be filled in this frame object
8415 * @deprecated use elm_object_content_set() instead.
8417 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8420 * @brief Get the content of the frame widget
8422 * Return the content object which is set for this widget
8424 * @param obj The frame object
8425 * @return The content that is being used
8427 * @deprecated use elm_object_content_get() instead.
8429 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8432 * @brief Unset the content of the frame widget
8434 * Unparent and return the content object which was set for this widget
8436 * @param obj The frame object
8437 * @return The content that was being used
8439 * @deprecated use elm_object_content_unset() instead.
8441 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8448 * @defgroup Table Table
8450 * A container widget to arrange other widgets in a table where items can
8451 * also span multiple columns or rows - even overlap (and then be raised or
8452 * lowered accordingly to adjust stacking if they do overlap).
8454 * For a Table widget the row/column count is not fixed.
8455 * The table widget adjusts itself when subobjects are added to it dynamically.
8457 * The followin are examples of how to use a table:
8458 * @li @ref tutorial_table_01
8459 * @li @ref tutorial_table_02
8465 * @brief Add a new table to the parent
8467 * @param parent The parent object
8468 * @return The new object or NULL if it cannot be created
8470 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8473 * @brief Set the homogeneous layout in the table
8475 * @param obj The layout object
8476 * @param homogeneous A boolean to set if the layout is homogeneous in the
8477 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8479 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8482 * @brief Get the current table homogeneous mode.
8484 * @param obj The table object
8485 * @return A boolean to indicating if the layout is homogeneous in the table
8486 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8488 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8491 * @brief Set padding between cells.
8493 * @param obj The layout object.
8494 * @param horizontal set the horizontal padding.
8495 * @param vertical set the vertical padding.
8497 * Default value is 0.
8499 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8502 * @brief Get padding between cells.
8504 * @param obj The layout object.
8505 * @param horizontal set the horizontal padding.
8506 * @param vertical set the vertical padding.
8508 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8511 * @brief Add a subobject on the table with the coordinates passed
8513 * @param obj The table object
8514 * @param subobj The subobject to be added to the table
8515 * @param x Row number
8516 * @param y Column number
8520 * @note All positioning inside the table is relative to rows and columns, so
8521 * a value of 0 for x and y, means the top left cell of the table, and a
8522 * value of 1 for w and h means @p subobj only takes that 1 cell.
8524 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8527 * @brief Remove child from table.
8529 * @param obj The table object
8530 * @param subobj The subobject
8532 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8535 * @brief Faster way to remove all child objects from a table object.
8537 * @param obj The table object
8538 * @param clear If true, will delete children, else just remove from table.
8540 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8543 * @brief Set the packing location of an existing child of the table
8545 * @param subobj The subobject to be modified in the table
8546 * @param x Row number
8547 * @param y Column number
8551 * Modifies the position of an object already in the table.
8553 * @note All positioning inside the table is relative to rows and columns, so
8554 * a value of 0 for x and y, means the top left cell of the table, and a
8555 * value of 1 for w and h means @p subobj only takes that 1 cell.
8557 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8560 * @brief Get the packing location of an existing child of the table
8562 * @param subobj The subobject to be modified in the table
8563 * @param x Row number
8564 * @param y Column number
8568 * @see elm_table_pack_set()
8570 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8576 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8577 typedef struct Elm_Gen_Item Elm_Gen_Item;
8578 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8579 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8580 typedef char *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8581 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. */
8582 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. */
8583 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8584 struct _Elm_Gen_Item_Class
8586 const char *item_style;
8587 struct _Elm_Gen_Item_Class_Func
8589 Elm_Gen_Item_Text_Get_Cb text_get;
8590 Elm_Gen_Item_Content_Get_Cb content_get;
8591 Elm_Gen_Item_State_Get_Cb state_get;
8592 Elm_Gen_Item_Del_Cb del;
8595 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8596 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8597 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8598 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8599 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8600 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8601 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8602 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8603 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8604 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8605 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8607 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8608 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8609 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8610 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8611 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8612 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8613 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8614 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8615 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8616 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8619 * @defgroup Gengrid Gengrid (Generic grid)
8621 * This widget aims to position objects in a grid layout while
8622 * actually creating and rendering only the visible ones, using the
8623 * same idea as the @ref Genlist "genlist": the user defines a @b
8624 * class for each item, specifying functions that will be called at
8625 * object creation, deletion, etc. When those items are selected by
8626 * the user, a callback function is issued. Users may interact with
8627 * a gengrid via the mouse (by clicking on items to select them and
8628 * clicking on the grid's viewport and swiping to pan the whole
8629 * view) or via the keyboard, navigating through item with the
8632 * @section Gengrid_Layouts Gengrid layouts
8634 * Gengrid may layout its items in one of two possible layouts:
8638 * When in "horizontal mode", items will be placed in @b columns,
8639 * from top to bottom and, when the space for a column is filled,
8640 * another one is started on the right, thus expanding the grid
8641 * horizontally, making for horizontal scrolling. When in "vertical
8642 * mode" , though, items will be placed in @b rows, from left to
8643 * right and, when the space for a row is filled, another one is
8644 * started below, thus expanding the grid vertically (and making
8645 * for vertical scrolling).
8647 * @section Gengrid_Items Gengrid items
8649 * An item in a gengrid can have 0 or more texts (they can be
8650 * regular text or textblock Evas objects - that's up to the style
8651 * to determine), 0 or more contents (which are simply objects
8652 * swallowed into the gengrid item's theming Edje object) and 0 or
8653 * more <b>boolean states</b>, which have the behavior left to the
8654 * user to define. The Edje part names for each of these properties
8655 * will be looked up, in the theme file for the gengrid, under the
8656 * Edje (string) data items named @c "texts", @c "contents" and @c
8657 * "states", respectively. For each of those properties, if more
8658 * than one part is provided, they must have names listed separated
8659 * by spaces in the data fields. For the default gengrid item
8660 * theme, we have @b one text part (@c "elm.text"), @b two content
8661 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8664 * A gengrid item may be at one of several styles. Elementary
8665 * provides one by default - "default", but this can be extended by
8666 * system or application custom themes/overlays/extensions (see
8667 * @ref Theme "themes" for more details).
8669 * @section Gengrid_Item_Class Gengrid item classes
8671 * In order to have the ability to add and delete items on the fly,
8672 * gengrid implements a class (callback) system where the
8673 * application provides a structure with information about that
8674 * type of item (gengrid may contain multiple different items with
8675 * different classes, states and styles). Gengrid will call the
8676 * functions in this struct (methods) when an item is "realized"
8677 * (i.e., created dynamically, while the user is scrolling the
8678 * grid). All objects will simply be deleted when no longer needed
8679 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8680 * contains the following members:
8681 * - @c item_style - This is a constant string and simply defines
8682 * the name of the item style. It @b must be specified and the
8683 * default should be @c "default".
8684 * - @c func.text_get - This function is called when an item
8685 * object is actually created. The @c data parameter will point to
8686 * the same data passed to elm_gengrid_item_append() and related
8687 * item creation functions. The @c obj parameter is the gengrid
8688 * object itself, while the @c part one is the name string of one
8689 * of the existing text parts in the Edje group implementing the
8690 * item's theme. This function @b must return a strdup'()ed string,
8691 * as the caller will free() it when done. See
8692 * #Elm_Gengrid_Item_Text_Get_Cb.
8693 * - @c func.content_get - This function is called when an item object
8694 * is actually created. The @c data parameter will point to the
8695 * same data passed to elm_gengrid_item_append() and related item
8696 * creation functions. The @c obj parameter is the gengrid object
8697 * itself, while the @c part one is the name string of one of the
8698 * existing (content) swallow parts in the Edje group implementing the
8699 * item's theme. It must return @c NULL, when no content is desired,
8700 * or a valid object handle, otherwise. The object will be deleted
8701 * by the gengrid on its deletion or when the item is "unrealized".
8702 * See #Elm_Gengrid_Item_Content_Get_Cb.
8703 * - @c func.state_get - This function is called when an item
8704 * object is actually created. The @c data parameter will point to
8705 * the same data passed to elm_gengrid_item_append() and related
8706 * item creation functions. The @c obj parameter is the gengrid
8707 * object itself, while the @c part one is the name string of one
8708 * of the state parts in the Edje group implementing the item's
8709 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8710 * true/on. Gengrids will emit a signal to its theming Edje object
8711 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8712 * "source" arguments, respectively, when the state is true (the
8713 * default is false), where @c XXX is the name of the (state) part.
8714 * See #Elm_Gengrid_Item_State_Get_Cb.
8715 * - @c func.del - This is called when elm_gengrid_item_del() is
8716 * called on an item or elm_gengrid_clear() is called on the
8717 * gengrid. This is intended for use when gengrid items are
8718 * deleted, so any data attached to the item (e.g. its data
8719 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8721 * @section Gengrid_Usage_Hints Usage hints
8723 * If the user wants to have multiple items selected at the same
8724 * time, elm_gengrid_multi_select_set() will permit it. If the
8725 * gengrid is single-selection only (the default), then
8726 * elm_gengrid_select_item_get() will return the selected item or
8727 * @c NULL, if none is selected. If the gengrid is under
8728 * multi-selection, then elm_gengrid_selected_items_get() will
8729 * return a list (that is only valid as long as no items are
8730 * modified (added, deleted, selected or unselected) of child items
8733 * If an item changes (internal (boolean) state, text or content
8734 * changes), then use elm_gengrid_item_update() to have gengrid
8735 * update the item with the new state. A gengrid will re-"realize"
8736 * the item, thus calling the functions in the
8737 * #Elm_Gengrid_Item_Class set for that item.
8739 * To programmatically (un)select an item, use
8740 * elm_gengrid_item_selected_set(). To get its selected state use
8741 * elm_gengrid_item_selected_get(). To make an item disabled
8742 * (unable to be selected and appear differently) use
8743 * elm_gengrid_item_disabled_set() to set this and
8744 * elm_gengrid_item_disabled_get() to get the disabled state.
8746 * Grid cells will only have their selection smart callbacks called
8747 * when firstly getting selected. Any further clicks will do
8748 * nothing, unless you enable the "always select mode", with
8749 * elm_gengrid_always_select_mode_set(), thus making every click to
8750 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8751 * turn off the ability to select items entirely in the widget and
8752 * they will neither appear selected nor call the selection smart
8755 * Remember that you can create new styles and add your own theme
8756 * augmentation per application with elm_theme_extension_add(). If
8757 * you absolutely must have a specific style that overrides any
8758 * theme the user or system sets up you can use
8759 * elm_theme_overlay_add() to add such a file.
8761 * @section Gengrid_Smart_Events Gengrid smart events
8763 * Smart events that you can add callbacks for are:
8764 * - @c "activated" - The user has double-clicked or pressed
8765 * (enter|return|spacebar) on an item. The @c event_info parameter
8766 * is the gengrid item that was activated.
8767 * - @c "clicked,double" - The user has double-clicked an item.
8768 * The @c event_info parameter is the gengrid item that was double-clicked.
8769 * - @c "longpressed" - This is called when the item is pressed for a certain
8770 * amount of time. By default it's 1 second.
8771 * - @c "selected" - The user has made an item selected. The
8772 * @c event_info parameter is the gengrid item that was selected.
8773 * - @c "unselected" - The user has made an item unselected. The
8774 * @c event_info parameter is the gengrid item that was unselected.
8775 * - @c "realized" - This is called when the item in the gengrid
8776 * has its implementing Evas object instantiated, de facto. @c
8777 * event_info is the gengrid item that was created. The object
8778 * may be deleted at any time, so it is highly advised to the
8779 * caller @b not to use the object pointer returned from
8780 * elm_gengrid_item_object_get(), because it may point to freed
8782 * - @c "unrealized" - This is called when the implementing Evas
8783 * object for this item is deleted. @c event_info is the gengrid
8784 * item that was deleted.
8785 * - @c "changed" - Called when an item is added, removed, resized
8786 * or moved and when the gengrid is resized or gets "horizontal"
8788 * - @c "scroll,anim,start" - This is called when scrolling animation has
8790 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8792 * - @c "drag,start,up" - Called when the item in the gengrid has
8793 * been dragged (not scrolled) up.
8794 * - @c "drag,start,down" - Called when the item in the gengrid has
8795 * been dragged (not scrolled) down.
8796 * - @c "drag,start,left" - Called when the item in the gengrid has
8797 * been dragged (not scrolled) left.
8798 * - @c "drag,start,right" - Called when the item in the gengrid has
8799 * been dragged (not scrolled) right.
8800 * - @c "drag,stop" - Called when the item in the gengrid has
8801 * stopped being dragged.
8802 * - @c "drag" - Called when the item in the gengrid is being
8804 * - @c "scroll" - called when the content has been scrolled
8806 * - @c "scroll,drag,start" - called when dragging the content has
8808 * - @c "scroll,drag,stop" - called when dragging the content has
8810 * - @c "edge,top" - This is called when the gengrid is scrolled until
8812 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8813 * until the bottom edge.
8814 * - @c "edge,left" - This is called when the gengrid is scrolled
8815 * until the left edge.
8816 * - @c "edge,right" - This is called when the gengrid is scrolled
8817 * until the right edge.
8819 * List of gengrid examples:
8820 * @li @ref gengrid_example
8824 * @addtogroup Gengrid
8828 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8829 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8830 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8831 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8832 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8835 * Text fetching class function for Elm_Gen_Item_Class.
8836 * @param data The data passed in the item creation function
8837 * @param obj The base widget object
8838 * @param part The part name of the swallow
8839 * @return The allocated (NOT stringshared) string to set as the text
8841 typedef char *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8844 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8845 * @param data The data passed in the item creation function
8846 * @param obj The base widget object
8847 * @param part The part name of the swallow
8848 * @return The content object to swallow
8850 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8853 * State fetching class function for Elm_Gen_Item_Class.
8854 * @param data The data passed in the item creation function
8855 * @param obj The base widget object
8856 * @param part The part name of the swallow
8857 * @return The hell if I know
8859 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8862 * Deletion class function for Elm_Gen_Item_Class.
8863 * @param data The data passed in the item creation function
8864 * @param obj The base widget object
8866 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8869 * @struct _Elm_Gengrid_Item_Class
8871 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8874 struct _Elm_Gengrid_Item_Class
8876 const char *item_style;
8877 struct _Elm_Gengrid_Item_Class_Func
8879 Elm_Gengrid_Item_Text_Get_Cb text_get; /**< Text fetching class function for gengrid item classes.*/
8880 Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8881 Elm_Gengrid_Item_State_Get_Cb state_get; /**< State fetching class function for gengrid item classes. */
8882 Elm_Gengrid_Item_Del_Cb del; /**< Deletion class function for gengrid item classes. */
8884 }; /**< #Elm_Gengrid_Item_Class member definitions */
8885 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8888 * Add a new gengrid widget to the given parent Elementary
8889 * (container) object
8891 * @param parent The parent object
8892 * @return a new gengrid widget handle or @c NULL, on errors
8894 * This function inserts a new gengrid widget on the canvas.
8896 * @see elm_gengrid_item_size_set()
8897 * @see elm_gengrid_group_item_size_set()
8898 * @see elm_gengrid_horizontal_set()
8899 * @see elm_gengrid_item_append()
8900 * @see elm_gengrid_item_del()
8901 * @see elm_gengrid_clear()
8905 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8908 * Set the size for the items of a given gengrid widget
8910 * @param obj The gengrid object.
8911 * @param w The items' width.
8912 * @param h The items' height;
8914 * A gengrid, after creation, has still no information on the size
8915 * to give to each of its cells. So, you most probably will end up
8916 * with squares one @ref Fingers "finger" wide, the default
8917 * size. Use this function to force a custom size for you items,
8918 * making them as big as you wish.
8920 * @see elm_gengrid_item_size_get()
8924 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8927 * Get the size set for the items of a given gengrid widget
8929 * @param obj The gengrid object.
8930 * @param w Pointer to a variable where to store the items' width.
8931 * @param h Pointer to a variable where to store the items' height.
8933 * @note Use @c NULL pointers on the size values you're not
8934 * interested in: they'll be ignored by the function.
8936 * @see elm_gengrid_item_size_get() for more details
8940 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8943 * Set the size for the group items of a given gengrid widget
8945 * @param obj The gengrid object.
8946 * @param w The group items' width.
8947 * @param h The group items' height;
8949 * A gengrid, after creation, has still no information on the size
8950 * to give to each of its cells. So, you most probably will end up
8951 * with squares one @ref Fingers "finger" wide, the default
8952 * size. Use this function to force a custom size for you group items,
8953 * making them as big as you wish.
8955 * @see elm_gengrid_group_item_size_get()
8959 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8962 * Get the size set for the group items of a given gengrid widget
8964 * @param obj The gengrid object.
8965 * @param w Pointer to a variable where to store the group items' width.
8966 * @param h Pointer to a variable where to store the group items' height.
8968 * @note Use @c NULL pointers on the size values you're not
8969 * interested in: they'll be ignored by the function.
8971 * @see elm_gengrid_group_item_size_get() for more details
8975 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8978 * Set the items grid's alignment within a given gengrid widget
8980 * @param obj The gengrid object.
8981 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8982 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8984 * This sets the alignment of the whole grid of items of a gengrid
8985 * within its given viewport. By default, those values are both
8986 * 0.5, meaning that the gengrid will have its items grid placed
8987 * exactly in the middle of its viewport.
8989 * @note If given alignment values are out of the cited ranges,
8990 * they'll be changed to the nearest boundary values on the valid
8993 * @see elm_gengrid_align_get()
8997 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
9000 * Get the items grid's alignment values within a given gengrid
9003 * @param obj The gengrid object.
9004 * @param align_x Pointer to a variable where to store the
9005 * horizontal alignment.
9006 * @param align_y Pointer to a variable where to store the vertical
9009 * @note Use @c NULL pointers on the alignment values you're not
9010 * interested in: they'll be ignored by the function.
9012 * @see elm_gengrid_align_set() for more details
9016 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
9019 * Set whether a given gengrid widget is or not able have items
9022 * @param obj The gengrid object
9023 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
9024 * @c EINA_FALSE to turn it off
9026 * If a gengrid is set to allow reordering, a click held for more
9027 * than 0.5 over a given item will highlight it specially,
9028 * signalling the gengrid has entered the reordering state. From
9029 * that time on, the user will be able to, while still holding the
9030 * mouse button down, move the item freely in the gengrid's
9031 * viewport, replacing to said item to the locations it goes to.
9032 * The replacements will be animated and, whenever the user
9033 * releases the mouse button, the item being replaced gets a new
9034 * definitive place in the grid.
9036 * @see elm_gengrid_reorder_mode_get()
9040 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
9043 * Get whether a given gengrid widget is or not able have items
9046 * @param obj The gengrid object
9047 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
9050 * @see elm_gengrid_reorder_mode_set() for more details
9054 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9057 * Append a new item in a given gengrid widget.
9059 * @param obj The gengrid object.
9060 * @param gic The item class for the item.
9061 * @param data The item data.
9062 * @param func Convenience function called when the item is
9064 * @param func_data Data to be passed to @p func.
9065 * @return A handle to the item added or @c NULL, on errors.
9067 * This adds an item to the beginning of the gengrid.
9069 * @see elm_gengrid_item_prepend()
9070 * @see elm_gengrid_item_insert_before()
9071 * @see elm_gengrid_item_insert_after()
9072 * @see elm_gengrid_item_del()
9076 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);
9079 * Prepend a new item in a given gengrid widget.
9081 * @param obj The gengrid object.
9082 * @param gic The item class for the item.
9083 * @param data The item data.
9084 * @param func Convenience function called when the item is
9086 * @param func_data Data to be passed to @p func.
9087 * @return A handle to the item added or @c NULL, on errors.
9089 * This adds an item to the end of the gengrid.
9091 * @see elm_gengrid_item_append()
9092 * @see elm_gengrid_item_insert_before()
9093 * @see elm_gengrid_item_insert_after()
9094 * @see elm_gengrid_item_del()
9098 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);
9101 * Insert an item before another in a gengrid widget
9103 * @param obj The gengrid object.
9104 * @param gic The item class for the item.
9105 * @param data The item data.
9106 * @param relative The item to place this new one before.
9107 * @param func Convenience function called when the item is
9109 * @param func_data Data to be passed to @p func.
9110 * @return A handle to the item added or @c NULL, on errors.
9112 * This inserts an item before another in the gengrid.
9114 * @see elm_gengrid_item_append()
9115 * @see elm_gengrid_item_prepend()
9116 * @see elm_gengrid_item_insert_after()
9117 * @see elm_gengrid_item_del()
9121 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);
9124 * Insert an item after another in a gengrid widget
9126 * @param obj The gengrid object.
9127 * @param gic The item class for the item.
9128 * @param data The item data.
9129 * @param relative The item to place this new one after.
9130 * @param func Convenience function called when the item is
9132 * @param func_data Data to be passed to @p func.
9133 * @return A handle to the item added or @c NULL, on errors.
9135 * This inserts an item after another in the gengrid.
9137 * @see elm_gengrid_item_append()
9138 * @see elm_gengrid_item_prepend()
9139 * @see elm_gengrid_item_insert_after()
9140 * @see elm_gengrid_item_del()
9144 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);
9147 * Insert an item in a gengrid widget using a user-defined sort function.
9149 * @param obj The gengrid object.
9150 * @param gic The item class for the item.
9151 * @param data The item data.
9152 * @param comp User defined comparison function that defines the sort order based on
9153 * Elm_Gen_Item and its data param.
9154 * @param func Convenience function called when the item is selected.
9155 * @param func_data Data to be passed to @p func.
9156 * @return A handle to the item added or @c NULL, on errors.
9158 * This inserts an item in the gengrid based on user defined comparison function.
9160 * @see elm_gengrid_item_append()
9161 * @see elm_gengrid_item_prepend()
9162 * @see elm_gengrid_item_insert_after()
9163 * @see elm_gengrid_item_del()
9164 * @see elm_gengrid_item_direct_sorted_insert()
9168 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);
9171 * Insert an item in a gengrid widget using a user-defined sort function.
9173 * @param obj The gengrid object.
9174 * @param gic The item class for the item.
9175 * @param data The item data.
9176 * @param comp User defined comparison function that defines the sort order based on
9178 * @param func Convenience function called when the item is selected.
9179 * @param func_data Data to be passed to @p func.
9180 * @return A handle to the item added or @c NULL, on errors.
9182 * This inserts an item in the gengrid based on user defined comparison function.
9184 * @see elm_gengrid_item_append()
9185 * @see elm_gengrid_item_prepend()
9186 * @see elm_gengrid_item_insert_after()
9187 * @see elm_gengrid_item_del()
9188 * @see elm_gengrid_item_sorted_insert()
9192 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);
9195 * Set whether items on a given gengrid widget are to get their
9196 * selection callbacks issued for @b every subsequent selection
9197 * click on them or just for the first click.
9199 * @param obj The gengrid object
9200 * @param always_select @c EINA_TRUE to make items "always
9201 * selected", @c EINA_FALSE, otherwise
9203 * By default, grid items will only call their selection callback
9204 * function when firstly getting selected, any subsequent further
9205 * clicks will do nothing. With this call, you make those
9206 * subsequent clicks also to issue the selection callbacks.
9208 * @note <b>Double clicks</b> will @b always be reported on items.
9210 * @see elm_gengrid_always_select_mode_get()
9214 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9217 * Get whether items on a given gengrid widget have their selection
9218 * callbacks issued for @b every subsequent selection click on them
9219 * or just for the first click.
9221 * @param obj The gengrid object.
9222 * @return @c EINA_TRUE if the gengrid items are "always selected",
9223 * @c EINA_FALSE, otherwise
9225 * @see elm_gengrid_always_select_mode_set() for more details
9229 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9232 * Set whether items on a given gengrid widget can be selected or not.
9234 * @param obj The gengrid object
9235 * @param no_select @c EINA_TRUE to make items selectable,
9236 * @c EINA_FALSE otherwise
9238 * This will make items in @p obj selectable or not. In the latter
9239 * case, any user interaction on the gengrid items will neither make
9240 * them appear selected nor them call their selection callback
9243 * @see elm_gengrid_no_select_mode_get()
9247 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9250 * Get whether items on a given gengrid widget can be selected or
9253 * @param obj The gengrid object
9254 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
9257 * @see elm_gengrid_no_select_mode_set() for more details
9261 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9264 * Enable or disable multi-selection in a given gengrid widget
9266 * @param obj The gengrid object.
9267 * @param multi @c EINA_TRUE, to enable multi-selection,
9268 * @c EINA_FALSE to disable it.
9270 * Multi-selection is the ability to have @b more than one
9271 * item selected, on a given gengrid, simultaneously. When it is
9272 * enabled, a sequence of clicks on different items will make them
9273 * all selected, progressively. A click on an already selected item
9274 * will unselect it. If interacting via the keyboard,
9275 * multi-selection is enabled while holding the "Shift" key.
9277 * @note By default, multi-selection is @b disabled on gengrids
9279 * @see elm_gengrid_multi_select_get()
9283 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9286 * Get whether multi-selection is enabled or disabled for a given
9289 * @param obj The gengrid object.
9290 * @return @c EINA_TRUE, if multi-selection is enabled, @c
9291 * EINA_FALSE otherwise
9293 * @see elm_gengrid_multi_select_set() for more details
9297 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9300 * Enable or disable bouncing effect for a given gengrid widget
9302 * @param obj The gengrid object
9303 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9304 * @c EINA_FALSE to disable it
9305 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9306 * @c EINA_FALSE to disable it
9308 * The bouncing effect occurs whenever one reaches the gengrid's
9309 * edge's while panning it -- it will scroll past its limits a
9310 * little bit and return to the edge again, in a animated for,
9313 * @note By default, gengrids have bouncing enabled on both axis
9315 * @see elm_gengrid_bounce_get()
9319 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9322 * Get whether bouncing effects are enabled or disabled, for a
9323 * given gengrid widget, on each axis
9325 * @param obj The gengrid object
9326 * @param h_bounce Pointer to a variable where to store the
9327 * horizontal bouncing flag.
9328 * @param v_bounce Pointer to a variable where to store the
9329 * vertical bouncing flag.
9331 * @see elm_gengrid_bounce_set() for more details
9335 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9338 * Set a given gengrid widget's scrolling page size, relative to
9339 * its viewport size.
9341 * @param obj The gengrid object
9342 * @param h_pagerel The horizontal page (relative) size
9343 * @param v_pagerel The vertical page (relative) size
9345 * The gengrid's scroller is capable of binding scrolling by the
9346 * user to "pages". It means that, while scrolling and, specially
9347 * after releasing the mouse button, the grid will @b snap to the
9348 * nearest displaying page's area. When page sizes are set, the
9349 * grid's continuous content area is split into (equal) page sized
9352 * This function sets the size of a page <b>relatively to the
9353 * viewport dimensions</b> of the gengrid, for each axis. A value
9354 * @c 1.0 means "the exact viewport's size", in that axis, while @c
9355 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9356 * a viewport". Sane usable values are, than, between @c 0.0 and @c
9357 * 1.0. Values beyond those will make it behave behave
9358 * inconsistently. If you only want one axis to snap to pages, use
9359 * the value @c 0.0 for the other one.
9361 * There is a function setting page size values in @b absolute
9362 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9363 * is mutually exclusive to this one.
9365 * @see elm_gengrid_page_relative_get()
9369 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9372 * Get a given gengrid widget's scrolling page size, relative to
9373 * its viewport size.
9375 * @param obj The gengrid object
9376 * @param h_pagerel Pointer to a variable where to store the
9377 * horizontal page (relative) size
9378 * @param v_pagerel Pointer to a variable where to store the
9379 * vertical page (relative) size
9381 * @see elm_gengrid_page_relative_set() for more details
9385 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9388 * Set a given gengrid widget's scrolling page size
9390 * @param obj The gengrid object
9391 * @param h_pagerel The horizontal page size, in pixels
9392 * @param v_pagerel The vertical page size, in pixels
9394 * The gengrid's scroller is capable of binding scrolling by the
9395 * user to "pages". It means that, while scrolling and, specially
9396 * after releasing the mouse button, the grid will @b snap to the
9397 * nearest displaying page's area. When page sizes are set, the
9398 * grid's continuous content area is split into (equal) page sized
9401 * This function sets the size of a page of the gengrid, in pixels,
9402 * for each axis. Sane usable values are, between @c 0 and the
9403 * dimensions of @p obj, for each axis. Values beyond those will
9404 * make it behave behave inconsistently. If you only want one axis
9405 * to snap to pages, use the value @c 0 for the other one.
9407 * There is a function setting page size values in @b relative
9408 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9409 * use is mutually exclusive to this one.
9413 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9416 * @brief Get gengrid current page number.
9418 * @param obj The gengrid object
9419 * @param h_pagenumber The horizontal page number
9420 * @param v_pagenumber The vertical page number
9422 * The page number starts from 0. 0 is the first page.
9423 * Current page means the page which meet the top-left of the viewport.
9424 * If there are two or more pages in the viewport, it returns the number of page
9425 * which meet the top-left of the viewport.
9427 * @see elm_gengrid_last_page_get()
9428 * @see elm_gengrid_page_show()
9429 * @see elm_gengrid_page_brint_in()
9431 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9434 * @brief Get scroll last page number.
9436 * @param obj The gengrid object
9437 * @param h_pagenumber The horizontal page number
9438 * @param v_pagenumber The vertical page number
9440 * The page number starts from 0. 0 is the first page.
9441 * This returns the last page number among the pages.
9443 * @see elm_gengrid_current_page_get()
9444 * @see elm_gengrid_page_show()
9445 * @see elm_gengrid_page_brint_in()
9447 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9450 * Show a specific virtual region within the gengrid content object by page number.
9452 * @param obj The gengrid object
9453 * @param h_pagenumber The horizontal page number
9454 * @param v_pagenumber The vertical page number
9456 * 0, 0 of the indicated page is located at the top-left of the viewport.
9457 * This will jump to the page directly without animation.
9462 * sc = elm_gengrid_add(win);
9463 * elm_gengrid_content_set(sc, content);
9464 * elm_gengrid_page_relative_set(sc, 1, 0);
9465 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9466 * elm_gengrid_page_show(sc, h_page + 1, v_page);
9469 * @see elm_gengrid_page_bring_in()
9471 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9474 * Show a specific virtual region within the gengrid content object by page number.
9476 * @param obj The gengrid object
9477 * @param h_pagenumber The horizontal page number
9478 * @param v_pagenumber The vertical page number
9480 * 0, 0 of the indicated page is located at the top-left of the viewport.
9481 * This will slide to the page with animation.
9486 * sc = elm_gengrid_add(win);
9487 * elm_gengrid_content_set(sc, content);
9488 * elm_gengrid_page_relative_set(sc, 1, 0);
9489 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9490 * elm_gengrid_page_bring_in(sc, h_page, v_page);
9493 * @see elm_gengrid_page_show()
9495 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9498 * Set the direction in which a given gengrid widget will expand while
9499 * placing its items.
9501 * @param obj The gengrid object.
9502 * @param setting @c EINA_TRUE to make the gengrid expand
9503 * horizontally, @c EINA_FALSE to expand vertically.
9505 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9506 * in @b columns, from top to bottom and, when the space for a
9507 * column is filled, another one is started on the right, thus
9508 * expanding the grid horizontally. When in "vertical mode"
9509 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9510 * to right and, when the space for a row is filled, another one is
9511 * started below, thus expanding the grid vertically.
9513 * @see elm_gengrid_horizontal_get()
9517 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9520 * Get for what direction a given gengrid widget will expand while
9521 * placing its items.
9523 * @param obj The gengrid object.
9524 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9525 * @c EINA_FALSE if it's set to expand vertically.
9527 * @see elm_gengrid_horizontal_set() for more detais
9531 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9534 * Get the first item in a given gengrid widget
9536 * @param obj The gengrid object
9537 * @return The first item's handle or @c NULL, if there are no
9538 * items in @p obj (and on errors)
9540 * This returns the first item in the @p obj's internal list of
9543 * @see elm_gengrid_last_item_get()
9547 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9550 * Get the last item in a given gengrid widget
9552 * @param obj The gengrid object
9553 * @return The last item's handle or @c NULL, if there are no
9554 * items in @p obj (and on errors)
9556 * This returns the last item in the @p obj's internal list of
9559 * @see elm_gengrid_first_item_get()
9563 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9566 * Get the @b next item in a gengrid widget's internal list of items,
9567 * given a handle to one of those items.
9569 * @param item The gengrid item to fetch next from
9570 * @return The item after @p item, or @c NULL if there's none (and
9573 * This returns the item placed after the @p item, on the container
9576 * @see elm_gengrid_item_prev_get()
9580 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9583 * Get the @b previous item in a gengrid widget's internal list of items,
9584 * given a handle to one of those items.
9586 * @param item The gengrid item to fetch previous from
9587 * @return The item before @p item, or @c NULL if there's none (and
9590 * This returns the item placed before the @p item, on the container
9593 * @see elm_gengrid_item_next_get()
9597 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9600 * Get the gengrid object's handle which contains a given gengrid
9603 * @param item The item to fetch the container from
9604 * @return The gengrid (parent) object
9606 * This returns the gengrid object itself that an item belongs to.
9610 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9613 * Remove a gengrid item from its parent, deleting it.
9615 * @param item The item to be removed.
9616 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9618 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9623 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9626 * Update the contents of a given gengrid item
9628 * @param item The gengrid item
9630 * This updates an item by calling all the item class functions
9631 * again to get the contents, texts and states. Use this when the
9632 * original item data has changed and you want the changes to be
9637 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9640 * Get the Gengrid Item class for the given Gengrid Item.
9642 * @param item The gengrid item
9644 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9645 * the function pointers and item_style.
9649 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9652 * Get the Gengrid Item class for the given Gengrid Item.
9654 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9655 * the function pointers and item_style.
9657 * @param item The gengrid item
9658 * @param gic The gengrid item class describing the function pointers and the item style.
9662 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9665 * Return the data associated to a given gengrid item
9667 * @param item The gengrid item.
9668 * @return the data associated with this item.
9670 * This returns the @c data value passed on the
9671 * elm_gengrid_item_append() and related item addition calls.
9673 * @see elm_gengrid_item_append()
9674 * @see elm_gengrid_item_data_set()
9678 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9681 * Set the data associated with a given gengrid item
9683 * @param item The gengrid item
9684 * @param data The data pointer to set on it
9686 * This @b overrides the @c data value passed on the
9687 * elm_gengrid_item_append() and related item addition calls. This
9688 * function @b won't call elm_gengrid_item_update() automatically,
9689 * so you'd issue it afterwards if you want to have the item
9690 * updated to reflect the new data.
9692 * @see elm_gengrid_item_data_get()
9693 * @see elm_gengrid_item_update()
9697 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9700 * Get a given gengrid item's position, relative to the whole
9701 * gengrid's grid area.
9703 * @param item The Gengrid item.
9704 * @param x Pointer to variable to store the item's <b>row number</b>.
9705 * @param y Pointer to variable to store the item's <b>column number</b>.
9707 * This returns the "logical" position of the item within the
9708 * gengrid. For example, @c (0, 1) would stand for first row,
9713 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9716 * Set whether a given gengrid item is selected or not
9718 * @param item The gengrid item
9719 * @param selected Use @c EINA_TRUE, to make it selected, @c
9720 * EINA_FALSE to make it unselected
9722 * This sets the selected state of an item. If multi-selection is
9723 * not enabled on the containing gengrid and @p selected is @c
9724 * EINA_TRUE, any other previously selected items will get
9725 * unselected in favor of this new one.
9727 * @see elm_gengrid_item_selected_get()
9731 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9734 * Get whether a given gengrid item is selected or not
9736 * @param item The gengrid item
9737 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9739 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9741 * @see elm_gengrid_item_selected_set() for more details
9745 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9748 * Get the real Evas object created to implement the view of a
9749 * given gengrid item
9751 * @param item The gengrid item.
9752 * @return the Evas object implementing this item's view.
9754 * This returns the actual Evas object used to implement the
9755 * specified gengrid item's view. This may be @c NULL, as it may
9756 * not have been created or may have been deleted, at any time, by
9757 * the gengrid. <b>Do not modify this object</b> (move, resize,
9758 * show, hide, etc.), as the gengrid is controlling it. This
9759 * function is for querying, emitting custom signals or hooking
9760 * lower level callbacks for events on that object. Do not delete
9761 * this object under any circumstances.
9763 * @see elm_gengrid_item_data_get()
9767 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9770 * Show the portion of a gengrid's internal grid containing a given
9771 * item, @b immediately.
9773 * @param item The item to display
9775 * This causes gengrid to @b redraw its viewport's contents to the
9776 * region contining the given @p item item, if it is not fully
9779 * @see elm_gengrid_item_bring_in()
9783 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9786 * Animatedly bring in, to the visible area of a gengrid, a given
9789 * @param item The gengrid item to display
9791 * This causes gengrid to jump to the given @p item and show
9792 * it (by scrolling), if it is not fully visible. This will use
9793 * animation to do so and take a period of time to complete.
9795 * @see elm_gengrid_item_show()
9799 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9802 * Set whether a given gengrid item is disabled or not.
9804 * @param item The gengrid item
9805 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9806 * to enable it back.
9808 * A disabled item cannot be selected or unselected. It will also
9809 * change its appearance, to signal the user it's disabled.
9811 * @see elm_gengrid_item_disabled_get()
9815 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9818 * Get whether a given gengrid item is disabled or not.
9820 * @param item The gengrid item
9821 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9824 * @see elm_gengrid_item_disabled_set() for more details
9828 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9831 * Set the text to be shown in a given gengrid item's tooltips.
9833 * @param item The gengrid item
9834 * @param text The text to set in the content
9836 * This call will setup the text to be used as tooltip to that item
9837 * (analogous to elm_object_tooltip_text_set(), but being item
9838 * tooltips with higher precedence than object tooltips). It can
9839 * have only one tooltip at a time, so any previous tooltip data
9844 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9847 * Set the content to be shown in a given gengrid item's tooltip
9849 * @param item The gengrid item.
9850 * @param func The function returning the tooltip contents.
9851 * @param data What to provide to @a func as callback data/context.
9852 * @param del_cb Called when data is not needed anymore, either when
9853 * another callback replaces @p func, the tooltip is unset with
9854 * elm_gengrid_item_tooltip_unset() or the owner @p item
9855 * dies. This callback receives as its first parameter the
9856 * given @p data, being @c event_info the item handle.
9858 * This call will setup the tooltip's contents to @p item
9859 * (analogous to elm_object_tooltip_content_cb_set(), but being
9860 * item tooltips with higher precedence than object tooltips). It
9861 * can have only one tooltip at a time, so any previous tooltip
9862 * content will get removed. @p func (with @p data) will be called
9863 * every time Elementary needs to show the tooltip and it should
9864 * return a valid Evas object, which will be fully managed by the
9865 * tooltip system, getting deleted when the tooltip is gone.
9869 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);
9872 * Unset a tooltip from a given gengrid item
9874 * @param item gengrid item to remove a previously set tooltip from.
9876 * This call removes any tooltip set on @p item. The callback
9877 * provided as @c del_cb to
9878 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9879 * notify it is not used anymore (and have resources cleaned, if
9882 * @see elm_gengrid_item_tooltip_content_cb_set()
9886 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9889 * Set a different @b style for a given gengrid item's tooltip.
9891 * @param item gengrid item with tooltip set
9892 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9893 * "default", @c "transparent", etc)
9895 * Tooltips can have <b>alternate styles</b> to be displayed on,
9896 * which are defined by the theme set on Elementary. This function
9897 * works analogously as elm_object_tooltip_style_set(), but here
9898 * applied only to gengrid item objects. The default style for
9899 * tooltips is @c "default".
9901 * @note before you set a style you should define a tooltip with
9902 * elm_gengrid_item_tooltip_content_cb_set() or
9903 * elm_gengrid_item_tooltip_text_set()
9905 * @see elm_gengrid_item_tooltip_style_get()
9909 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9912 * Get the style set a given gengrid item's tooltip.
9914 * @param item gengrid item with tooltip already set on.
9915 * @return style the theme style in use, which defaults to
9916 * "default". If the object does not have a tooltip set,
9917 * then @c NULL is returned.
9919 * @see elm_gengrid_item_tooltip_style_set() for more details
9923 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9926 * @brief Disable size restrictions on an object's tooltip
9927 * @param item The tooltip's anchor object
9928 * @param disable If EINA_TRUE, size restrictions are disabled
9929 * @return EINA_FALSE on failure, EINA_TRUE on success
9931 * This function allows a tooltip to expand beyond its parant window's canvas.
9932 * It will instead be limited only by the size of the display.
9934 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Gengrid_Item *item, Eina_Bool disable);
9937 * @brief Retrieve size restriction state of an object's tooltip
9938 * @param item The tooltip's anchor object
9939 * @return If EINA_TRUE, size restrictions are disabled
9941 * This function returns whether a tooltip is allowed to expand beyond
9942 * its parant window's canvas.
9943 * It will instead be limited only by the size of the display.
9945 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_get(const Elm_Gengrid_Item *item);
9948 * Set the type of mouse pointer/cursor decoration to be shown,
9949 * when the mouse pointer is over the given gengrid widget item
9951 * @param item gengrid item to customize cursor on
9952 * @param cursor the cursor type's name
9954 * This function works analogously as elm_object_cursor_set(), but
9955 * here the cursor's changing area is restricted to the item's
9956 * area, and not the whole widget's. Note that that item cursors
9957 * have precedence over widget cursors, so that a mouse over @p
9958 * item will always show cursor @p type.
9960 * If this function is called twice for an object, a previously set
9961 * cursor will be unset on the second call.
9963 * @see elm_object_cursor_set()
9964 * @see elm_gengrid_item_cursor_get()
9965 * @see elm_gengrid_item_cursor_unset()
9969 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9972 * Get the type of mouse pointer/cursor decoration set to be shown,
9973 * when the mouse pointer is over the given gengrid widget item
9975 * @param item gengrid item with custom cursor set
9976 * @return the cursor type's name or @c NULL, if no custom cursors
9977 * were set to @p item (and on errors)
9979 * @see elm_object_cursor_get()
9980 * @see elm_gengrid_item_cursor_set() for more details
9981 * @see elm_gengrid_item_cursor_unset()
9985 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9988 * Unset any custom mouse pointer/cursor decoration set to be
9989 * shown, when the mouse pointer is over the given gengrid widget
9990 * item, thus making it show the @b default cursor again.
9992 * @param item a gengrid item
9994 * Use this call to undo any custom settings on this item's cursor
9995 * decoration, bringing it back to defaults (no custom style set).
9997 * @see elm_object_cursor_unset()
9998 * @see elm_gengrid_item_cursor_set() for more details
10002 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10005 * Set a different @b style for a given custom cursor set for a
10008 * @param item gengrid item with custom cursor set
10009 * @param style the <b>theme style</b> to use (e.g. @c "default",
10010 * @c "transparent", etc)
10012 * This function only makes sense when one is using custom mouse
10013 * cursor decorations <b>defined in a theme file</b> , which can
10014 * have, given a cursor name/type, <b>alternate styles</b> on
10015 * it. It works analogously as elm_object_cursor_style_set(), but
10016 * here applied only to gengrid item objects.
10018 * @warning Before you set a cursor style you should have defined a
10019 * custom cursor previously on the item, with
10020 * elm_gengrid_item_cursor_set()
10022 * @see elm_gengrid_item_cursor_engine_only_set()
10023 * @see elm_gengrid_item_cursor_style_get()
10027 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
10030 * Get the current @b style set for a given gengrid item's custom
10033 * @param item gengrid item with custom cursor set.
10034 * @return style the cursor style in use. If the object does not
10035 * have a cursor set, then @c NULL is returned.
10037 * @see elm_gengrid_item_cursor_style_set() for more details
10041 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10044 * Set if the (custom) cursor for a given gengrid item should be
10045 * searched in its theme, also, or should only rely on the
10046 * rendering engine.
10048 * @param item item with custom (custom) cursor already set on
10049 * @param engine_only Use @c EINA_TRUE to have cursors looked for
10050 * only on those provided by the rendering engine, @c EINA_FALSE to
10051 * have them searched on the widget's theme, as well.
10053 * @note This call is of use only if you've set a custom cursor
10054 * for gengrid items, with elm_gengrid_item_cursor_set().
10056 * @note By default, cursors will only be looked for between those
10057 * provided by the rendering engine.
10061 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10064 * Get if the (custom) cursor for a given gengrid item is being
10065 * searched in its theme, also, or is only relying on the rendering
10068 * @param item a gengrid item
10069 * @return @c EINA_TRUE, if cursors are being looked for only on
10070 * those provided by the rendering engine, @c EINA_FALSE if they
10071 * are being searched on the widget's theme, as well.
10073 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
10077 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10080 * Remove all items from a given gengrid widget
10082 * @param obj The gengrid object.
10084 * This removes (and deletes) all items in @p obj, leaving it
10087 * @see elm_gengrid_item_del(), to remove just one item.
10091 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10094 * Get the selected item in a given gengrid widget
10096 * @param obj The gengrid object.
10097 * @return The selected item's handleor @c NULL, if none is
10098 * selected at the moment (and on errors)
10100 * This returns the selected item in @p obj. If multi selection is
10101 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
10102 * the first item in the list is selected, which might not be very
10103 * useful. For that case, see elm_gengrid_selected_items_get().
10107 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10110 * Get <b>a list</b> of selected items in a given gengrid
10112 * @param obj The gengrid object.
10113 * @return The list of selected items or @c NULL, if none is
10114 * selected at the moment (and on errors)
10116 * This returns a list of the selected items, in the order that
10117 * they appear in the grid. This list is only valid as long as no
10118 * more items are selected or unselected (or unselected implictly
10119 * by deletion). The list contains #Elm_Gengrid_Item pointers as
10122 * @see elm_gengrid_selected_item_get()
10126 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10133 * @defgroup Clock Clock
10135 * @image html img/widget/clock/preview-00.png
10136 * @image latex img/widget/clock/preview-00.eps
10138 * This is a @b digital clock widget. In its default theme, it has a
10139 * vintage "flipping numbers clock" appearance, which will animate
10140 * sheets of individual algarisms individually as time goes by.
10142 * A newly created clock will fetch system's time (already
10143 * considering local time adjustments) to start with, and will tick
10144 * accondingly. It may or may not show seconds.
10146 * Clocks have an @b edition mode. When in it, the sheets will
10147 * display extra arrow indications on the top and bottom and the
10148 * user may click on them to raise or lower the time values. After
10149 * it's told to exit edition mode, it will keep ticking with that
10150 * new time set (it keeps the difference from local time).
10152 * Also, when under edition mode, user clicks on the cited arrows
10153 * which are @b held for some time will make the clock to flip the
10154 * sheet, thus editing the time, continuosly and automatically for
10155 * the user. The interval between sheet flips will keep growing in
10156 * time, so that it helps the user to reach a time which is distant
10157 * from the one set.
10159 * The time display is, by default, in military mode (24h), but an
10160 * am/pm indicator may be optionally shown, too, when it will
10163 * Smart callbacks one can register to:
10164 * - "changed" - the clock's user changed the time
10166 * Here is an example on its usage:
10167 * @li @ref clock_example
10171 * @addtogroup Clock
10176 * Identifiers for which clock digits should be editable, when a
10177 * clock widget is in edition mode. Values may be ORed together to
10178 * make a mask, naturally.
10180 * @see elm_clock_edit_set()
10181 * @see elm_clock_digit_edit_set()
10183 typedef enum _Elm_Clock_Digedit
10185 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
10186 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
10187 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
10188 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
10189 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
10190 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
10191 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
10192 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
10193 } Elm_Clock_Digedit;
10196 * Add a new clock widget to the given parent Elementary
10197 * (container) object
10199 * @param parent The parent object
10200 * @return a new clock widget handle or @c NULL, on errors
10202 * This function inserts a new clock widget on the canvas.
10206 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10209 * Set a clock widget's time, programmatically
10211 * @param obj The clock widget object
10212 * @param hrs The hours to set
10213 * @param min The minutes to set
10214 * @param sec The secondes to set
10216 * This function updates the time that is showed by the clock
10219 * Values @b must be set within the following ranges:
10220 * - 0 - 23, for hours
10221 * - 0 - 59, for minutes
10222 * - 0 - 59, for seconds,
10224 * even if the clock is not in "military" mode.
10226 * @warning The behavior for values set out of those ranges is @b
10231 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
10234 * Get a clock widget's time values
10236 * @param obj The clock object
10237 * @param[out] hrs Pointer to the variable to get the hours value
10238 * @param[out] min Pointer to the variable to get the minutes value
10239 * @param[out] sec Pointer to the variable to get the seconds value
10241 * This function gets the time set for @p obj, returning
10242 * it on the variables passed as the arguments to function
10244 * @note Use @c NULL pointers on the time values you're not
10245 * interested in: they'll be ignored by the function.
10249 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
10252 * Set whether a given clock widget is under <b>edition mode</b> or
10253 * under (default) displaying-only mode.
10255 * @param obj The clock object
10256 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
10257 * put it back to "displaying only" mode
10259 * This function makes a clock's time to be editable or not <b>by
10260 * user interaction</b>. When in edition mode, clocks @b stop
10261 * ticking, until one brings them back to canonical mode. The
10262 * elm_clock_digit_edit_set() function will influence which digits
10263 * of the clock will be editable. By default, all of them will be
10264 * (#ELM_CLOCK_NONE).
10266 * @note am/pm sheets, if being shown, will @b always be editable
10267 * under edition mode.
10269 * @see elm_clock_edit_get()
10273 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10276 * Retrieve whether a given clock widget is under <b>edition
10277 * mode</b> or under (default) displaying-only mode.
10279 * @param obj The clock object
10280 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
10283 * This function retrieves whether the clock's time can be edited
10284 * or not by user interaction.
10286 * @see elm_clock_edit_set() for more details
10290 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10293 * Set what digits of the given clock widget should be editable
10294 * when in edition mode.
10296 * @param obj The clock object
10297 * @param digedit Bit mask indicating the digits to be editable
10298 * (values in #Elm_Clock_Digedit).
10300 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10301 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10304 * @see elm_clock_digit_edit_get()
10308 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10311 * Retrieve what digits of the given clock widget should be
10312 * editable when in edition mode.
10314 * @param obj The clock object
10315 * @return Bit mask indicating the digits to be editable
10316 * (values in #Elm_Clock_Digedit).
10318 * @see elm_clock_digit_edit_set() for more details
10322 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10325 * Set if the given clock widget must show hours in military or
10328 * @param obj The clock object
10329 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10332 * This function sets if the clock must show hours in military or
10333 * am/pm mode. In some countries like Brazil the military mode
10334 * (00-24h-format) is used, in opposition to the USA, where the
10335 * am/pm mode is more commonly used.
10337 * @see elm_clock_show_am_pm_get()
10341 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10344 * Get if the given clock widget shows hours in military or am/pm
10347 * @param obj The clock object
10348 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10351 * This function gets if the clock shows hours in military or am/pm
10354 * @see elm_clock_show_am_pm_set() for more details
10358 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10361 * Set if the given clock widget must show time with seconds or not
10363 * @param obj The clock object
10364 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10366 * This function sets if the given clock must show or not elapsed
10367 * seconds. By default, they are @b not shown.
10369 * @see elm_clock_show_seconds_get()
10373 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10376 * Get whether the given clock widget is showing time with seconds
10379 * @param obj The clock object
10380 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10382 * This function gets whether @p obj is showing or not the elapsed
10385 * @see elm_clock_show_seconds_set()
10389 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10392 * Set the interval on time updates for an user mouse button hold
10393 * on clock widgets' time edition.
10395 * @param obj The clock object
10396 * @param interval The (first) interval value in seconds
10398 * This interval value is @b decreased while the user holds the
10399 * mouse pointer either incrementing or decrementing a given the
10400 * clock digit's value.
10402 * This helps the user to get to a given time distant from the
10403 * current one easier/faster, as it will start to flip quicker and
10404 * quicker on mouse button holds.
10406 * The calculation for the next flip interval value, starting from
10407 * the one set with this call, is the previous interval divided by
10408 * 1.05, so it decreases a little bit.
10410 * The default starting interval value for automatic flips is
10413 * @see elm_clock_interval_get()
10417 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10420 * Get the interval on time updates for an user mouse button hold
10421 * on clock widgets' time edition.
10423 * @param obj The clock object
10424 * @return The (first) interval value, in seconds, set on it
10426 * @see elm_clock_interval_set() for more details
10430 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10437 * @defgroup Layout Layout
10439 * @image html img/widget/layout/preview-00.png
10440 * @image latex img/widget/layout/preview-00.eps width=\textwidth
10442 * @image html img/layout-predefined.png
10443 * @image latex img/layout-predefined.eps width=\textwidth
10445 * This is a container widget that takes a standard Edje design file and
10446 * wraps it very thinly in a widget.
10448 * An Edje design (theme) file has a very wide range of possibilities to
10449 * describe the behavior of elements added to the Layout. Check out the Edje
10450 * documentation and the EDC reference to get more information about what can
10451 * be done with Edje.
10453 * Just like @ref List, @ref Box, and other container widgets, any
10454 * object added to the Layout will become its child, meaning that it will be
10455 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10457 * The Layout widget can contain as many Contents, Boxes or Tables as
10458 * described in its theme file. For instance, objects can be added to
10459 * different Tables by specifying the respective Table part names. The same
10460 * is valid for Content and Box.
10462 * The objects added as child of the Layout will behave as described in the
10463 * part description where they were added. There are 3 possible types of
10464 * parts where a child can be added:
10466 * @section secContent Content (SWALLOW part)
10468 * Only one object can be added to the @c SWALLOW part (but you still can
10469 * have many @c SWALLOW parts and one object on each of them). Use the @c
10470 * elm_object_content_set/get/unset functions to set, retrieve and unset
10471 * objects as content of the @c SWALLOW. After being set to this part, the
10472 * object size, position, visibility, clipping and other description
10473 * properties will be totally controlled by the description of the given part
10474 * (inside the Edje theme file).
10476 * One can use @c evas_object_size_hint_* functions on the child to have some
10477 * kind of control over its behavior, but the resulting behavior will still
10478 * depend heavily on the @c SWALLOW part description.
10480 * The Edje theme also can change the part description, based on signals or
10481 * scripts running inside the theme. This change can also be animated. All of
10482 * this will affect the child object set as content accordingly. The object
10483 * size will be changed if the part size is changed, it will animate move if
10484 * the part is moving, and so on.
10486 * The following picture demonstrates a Layout widget with a child object
10487 * added to its @c SWALLOW:
10489 * @image html layout_swallow.png
10490 * @image latex layout_swallow.eps width=\textwidth
10492 * @section secBox Box (BOX part)
10494 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10495 * allows one to add objects to the box and have them distributed along its
10496 * area, accordingly to the specified @a layout property (now by @a layout we
10497 * mean the chosen layouting design of the Box, not the Layout widget
10500 * A similar effect for having a box with its position, size and other things
10501 * controlled by the Layout theme would be to create an Elementary @ref Box
10502 * widget and add it as a Content in the @c SWALLOW part.
10504 * The main difference of using the Layout Box is that its behavior, the box
10505 * properties like layouting format, padding, align, etc. will be all
10506 * controlled by the theme. This means, for example, that a signal could be
10507 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10508 * handled the signal by changing the box padding, or align, or both. Using
10509 * the Elementary @ref Box widget is not necessarily harder or easier, it
10510 * just depends on the circunstances and requirements.
10512 * The Layout Box can be used through the @c elm_layout_box_* set of
10515 * The following picture demonstrates a Layout widget with many child objects
10516 * added to its @c BOX part:
10518 * @image html layout_box.png
10519 * @image latex layout_box.eps width=\textwidth
10521 * @section secTable Table (TABLE part)
10523 * Just like the @ref secBox, the Layout Table is very similar to the
10524 * Elementary @ref Table widget. It allows one to add objects to the Table
10525 * specifying the row and column where the object should be added, and any
10526 * column or row span if necessary.
10528 * Again, we could have this design by adding a @ref Table widget to the @c
10529 * SWALLOW part using elm_object_part_content_set(). The same difference happens
10530 * here when choosing to use the Layout Table (a @c TABLE part) instead of
10531 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10533 * The Layout Table can be used through the @c elm_layout_table_* set of
10536 * The following picture demonstrates a Layout widget with many child objects
10537 * added to its @c TABLE part:
10539 * @image html layout_table.png
10540 * @image latex layout_table.eps width=\textwidth
10542 * @section secPredef Predefined Layouts
10544 * Another interesting thing about the Layout widget is that it offers some
10545 * predefined themes that come with the default Elementary theme. These
10546 * themes can be set by the call elm_layout_theme_set(), and provide some
10547 * basic functionality depending on the theme used.
10549 * Most of them already send some signals, some already provide a toolbar or
10550 * back and next buttons.
10552 * These are available predefined theme layouts. All of them have class = @c
10553 * layout, group = @c application, and style = one of the following options:
10555 * @li @c toolbar-content - application with toolbar and main content area
10556 * @li @c toolbar-content-back - application with toolbar and main content
10557 * area with a back button and title area
10558 * @li @c toolbar-content-back-next - application with toolbar and main
10559 * content area with a back and next buttons and title area
10560 * @li @c content-back - application with a main content area with a back
10561 * button and title area
10562 * @li @c content-back-next - application with a main content area with a
10563 * back and next buttons and title area
10564 * @li @c toolbar-vbox - application with toolbar and main content area as a
10566 * @li @c toolbar-table - application with toolbar and main content area as a
10569 * @section secExamples Examples
10571 * Some examples of the Layout widget can be found here:
10572 * @li @ref layout_example_01
10573 * @li @ref layout_example_02
10574 * @li @ref layout_example_03
10575 * @li @ref layout_example_edc
10580 * Add a new layout to the parent
10582 * @param parent The parent object
10583 * @return The new object or NULL if it cannot be created
10585 * @see elm_layout_file_set()
10586 * @see elm_layout_theme_set()
10590 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10593 * Set the file that will be used as layout
10595 * @param obj The layout object
10596 * @param file The path to file (edj) that will be used as layout
10597 * @param group The group that the layout belongs in edje file
10599 * @return (1 = success, 0 = error)
10603 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10606 * Set the edje group from the elementary theme that will be used as layout
10608 * @param obj The layout object
10609 * @param clas the clas of the group
10610 * @param group the group
10611 * @param style the style to used
10613 * @return (1 = success, 0 = error)
10617 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10620 * Set the layout content.
10622 * @param obj The layout object
10623 * @param swallow The swallow part name in the edje file
10624 * @param content The child that will be added in this layout object
10626 * Once the content object is set, a previously set one will be deleted.
10627 * If you want to keep that old content object, use the
10628 * elm_object_part_content_unset() function.
10630 * @note In an Edje theme, the part used as a content container is called @c
10631 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10632 * expected to be a part name just like the second parameter of
10633 * elm_layout_box_append().
10635 * @see elm_layout_box_append()
10636 * @see elm_object_part_content_get()
10637 * @see elm_object_part_content_unset()
10639 * @deprecated use elm_object_part_content_set() instead
10643 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10646 * Get the child object in the given content part.
10648 * @param obj The layout object
10649 * @param swallow The SWALLOW part to get its content
10651 * @return The swallowed object or NULL if none or an error occurred
10653 * @deprecated use elm_object_part_content_get() instead
10657 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10660 * Unset the layout content.
10662 * @param obj The layout object
10663 * @param swallow The swallow part name in the edje file
10664 * @return The content that was being used
10666 * Unparent and return the content object which was set for this part.
10668 * @deprecated use elm_object_part_content_unset() instead
10672 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10675 * Set the text of the given part
10677 * @param obj The layout object
10678 * @param part The TEXT part where to set the text
10679 * @param text The text to set
10682 * @deprecated use elm_object_part_text_set() instead.
10684 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10687 * Get the text set in the given part
10689 * @param obj The layout object
10690 * @param part The TEXT part to retrieve the text off
10692 * @return The text set in @p part
10695 * @deprecated use elm_object_part_text_get() instead.
10697 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10700 * Append child to layout box part.
10702 * @param obj the layout object
10703 * @param part the box part to which the object will be appended.
10704 * @param child the child object to append to box.
10706 * Once the object is appended, it will become child of the layout. Its
10707 * lifetime will be bound to the layout, whenever the layout dies the child
10708 * will be deleted automatically. One should use elm_layout_box_remove() to
10709 * make this layout forget about the object.
10711 * @see elm_layout_box_prepend()
10712 * @see elm_layout_box_insert_before()
10713 * @see elm_layout_box_insert_at()
10714 * @see elm_layout_box_remove()
10718 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10721 * Prepend child to layout box part.
10723 * @param obj the layout object
10724 * @param part the box part to prepend.
10725 * @param child the child object to prepend to box.
10727 * Once the object is prepended, it will become child of the layout. Its
10728 * lifetime will be bound to the layout, whenever the layout dies the child
10729 * will be deleted automatically. One should use elm_layout_box_remove() to
10730 * make this layout forget about the object.
10732 * @see elm_layout_box_append()
10733 * @see elm_layout_box_insert_before()
10734 * @see elm_layout_box_insert_at()
10735 * @see elm_layout_box_remove()
10739 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10742 * Insert child to layout box part before a reference object.
10744 * @param obj the layout object
10745 * @param part the box part to insert.
10746 * @param child the child object to insert into box.
10747 * @param reference another reference object to insert before in box.
10749 * Once the object is inserted, it will become child of the layout. Its
10750 * lifetime will be bound to the layout, whenever the layout dies the child
10751 * will be deleted automatically. One should use elm_layout_box_remove() to
10752 * make this layout forget about the object.
10754 * @see elm_layout_box_append()
10755 * @see elm_layout_box_prepend()
10756 * @see elm_layout_box_insert_before()
10757 * @see elm_layout_box_remove()
10761 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10764 * Insert child to layout box part at a given position.
10766 * @param obj the layout object
10767 * @param part the box part to insert.
10768 * @param child the child object to insert into box.
10769 * @param pos the numeric position >=0 to insert the child.
10771 * Once the object is inserted, it will become child of the layout. Its
10772 * lifetime will be bound to the layout, whenever the layout dies the child
10773 * will be deleted automatically. One should use elm_layout_box_remove() to
10774 * make this layout forget about the object.
10776 * @see elm_layout_box_append()
10777 * @see elm_layout_box_prepend()
10778 * @see elm_layout_box_insert_before()
10779 * @see elm_layout_box_remove()
10783 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10786 * Remove a child of the given part box.
10788 * @param obj The layout object
10789 * @param part The box part name to remove child.
10790 * @param child The object to remove from box.
10791 * @return The object that was being used, or NULL if not found.
10793 * The object will be removed from the box part and its lifetime will
10794 * not be handled by the layout anymore. This is equivalent to
10795 * elm_object_part_content_unset() for box.
10797 * @see elm_layout_box_append()
10798 * @see elm_layout_box_remove_all()
10802 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10805 * Remove all children of the given part box.
10807 * @param obj The layout object
10808 * @param part The box part name to remove child.
10809 * @param clear If EINA_TRUE, then all objects will be deleted as
10810 * well, otherwise they will just be removed and will be
10811 * dangling on the canvas.
10813 * The objects will be removed from the box part and their lifetime will
10814 * not be handled by the layout anymore. This is equivalent to
10815 * elm_layout_box_remove() for all box children.
10817 * @see elm_layout_box_append()
10818 * @see elm_layout_box_remove()
10822 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10825 * Insert child to layout table part.
10827 * @param obj the layout object
10828 * @param part the box part to pack child.
10829 * @param child_obj the child object to pack into table.
10830 * @param col the column to which the child should be added. (>= 0)
10831 * @param row the row to which the child should be added. (>= 0)
10832 * @param colspan how many columns should be used to store this object. (>=
10834 * @param rowspan how many rows should be used to store this object. (>= 1)
10836 * Once the object is inserted, it will become child of the table. Its
10837 * lifetime will be bound to the layout, and whenever the layout dies the
10838 * child will be deleted automatically. One should use
10839 * elm_layout_table_remove() to make this layout forget about the object.
10841 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10842 * more space than a single cell. For instance, the following code:
10844 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10847 * Would result in an object being added like the following picture:
10849 * @image html layout_colspan.png
10850 * @image latex layout_colspan.eps width=\textwidth
10852 * @see elm_layout_table_unpack()
10853 * @see elm_layout_table_clear()
10857 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);
10860 * Unpack (remove) a child of the given part table.
10862 * @param obj The layout object
10863 * @param part The table part name to remove child.
10864 * @param child_obj The object to remove from table.
10865 * @return The object that was being used, or NULL if not found.
10867 * The object will be unpacked from the table part and its lifetime
10868 * will not be handled by the layout anymore. This is equivalent to
10869 * elm_object_part_content_unset() for table.
10871 * @see elm_layout_table_pack()
10872 * @see elm_layout_table_clear()
10876 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10879 * Remove all the child objects of the given part table.
10881 * @param obj The layout object
10882 * @param part The table part name to remove child.
10883 * @param clear If EINA_TRUE, then all objects will be deleted as
10884 * well, otherwise they will just be removed and will be
10885 * dangling on the canvas.
10887 * The objects will be removed from the table part and their lifetime will
10888 * not be handled by the layout anymore. This is equivalent to
10889 * elm_layout_table_unpack() for all table children.
10891 * @see elm_layout_table_pack()
10892 * @see elm_layout_table_unpack()
10896 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10899 * Get the edje layout
10901 * @param obj The layout object
10903 * @return A Evas_Object with the edje layout settings loaded
10904 * with function elm_layout_file_set
10906 * This returns the edje object. It is not expected to be used to then
10907 * swallow objects via edje_object_part_swallow() for example. Use
10908 * elm_object_part_content_set() instead so child object handling and sizing is
10911 * @note This function should only be used if you really need to call some
10912 * low level Edje function on this edje object. All the common stuff (setting
10913 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10914 * with proper elementary functions.
10916 * @see elm_object_signal_callback_add()
10917 * @see elm_object_signal_emit()
10918 * @see elm_object_part_text_set()
10919 * @see elm_object_part_content_set()
10920 * @see elm_layout_box_append()
10921 * @see elm_layout_table_pack()
10922 * @see elm_layout_data_get()
10926 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10929 * Get the edje data from the given layout
10931 * @param obj The layout object
10932 * @param key The data key
10934 * @return The edje data string
10936 * This function fetches data specified inside the edje theme of this layout.
10937 * This function return NULL if data is not found.
10939 * In EDC this comes from a data block within the group block that @p
10940 * obj was loaded from. E.g.
10947 * item: "key1" "value1";
10948 * item: "key2" "value2";
10956 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10961 * @param obj The layout object
10963 * Manually forces a sizing re-evaluation. This is useful when the minimum
10964 * size required by the edje theme of this layout has changed. The change on
10965 * the minimum size required by the edje theme is not immediately reported to
10966 * the elementary layout, so one needs to call this function in order to tell
10967 * the widget (layout) that it needs to reevaluate its own size.
10969 * The minimum size of the theme is calculated based on minimum size of
10970 * parts, the size of elements inside containers like box and table, etc. All
10971 * of this can change due to state changes, and that's when this function
10972 * should be called.
10974 * Also note that a standard signal of "size,eval" "elm" emitted from the
10975 * edje object will cause this to happen too.
10979 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10982 * Sets a specific cursor for an edje part.
10984 * @param obj The layout object.
10985 * @param part_name a part from loaded edje group.
10986 * @param cursor cursor name to use, see Elementary_Cursor.h
10988 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10989 * part not exists or it has "mouse_events: 0".
10993 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10996 * Get the cursor to be shown when mouse is over an edje part
10998 * @param obj The layout object.
10999 * @param part_name a part from loaded edje group.
11000 * @return the cursor name.
11004 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11007 * Unsets a cursor previously set with elm_layout_part_cursor_set().
11009 * @param obj The layout object.
11010 * @param part_name a part from loaded edje group, that had a cursor set
11011 * with elm_layout_part_cursor_set().
11015 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11018 * Sets a specific cursor style for an edje part.
11020 * @param obj The layout object.
11021 * @param part_name a part from loaded edje group.
11022 * @param style the theme style to use (default, transparent, ...)
11024 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11025 * part not exists or it did not had a cursor set.
11029 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
11032 * Gets a specific cursor style for an edje part.
11034 * @param obj The layout object.
11035 * @param part_name a part from loaded edje group.
11037 * @return the theme style in use, defaults to "default". If the
11038 * object does not have a cursor set, then NULL is returned.
11042 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11045 * Sets if the cursor set should be searched on the theme or should use
11046 * the provided by the engine, only.
11048 * @note before you set if should look on theme you should define a
11049 * cursor with elm_layout_part_cursor_set(). By default it will only
11050 * look for cursors provided by the engine.
11052 * @param obj The layout object.
11053 * @param part_name a part from loaded edje group.
11054 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
11055 * or should also search on widget's theme as well (EINA_FALSE)
11057 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11058 * part not exists or it did not had a cursor set.
11062 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);
11065 * Gets a specific cursor engine_only for an edje part.
11067 * @param obj The layout object.
11068 * @param part_name a part from loaded edje group.
11070 * @return whenever the cursor is just provided by engine or also from theme.
11074 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11077 * @def elm_layout_icon_set
11078 * Convenience macro to set the icon object in a layout that follows the
11079 * Elementary naming convention for its parts.
11083 #define elm_layout_icon_set(_ly, _obj) \
11086 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
11087 if ((_obj)) sig = "elm,state,icon,visible"; \
11088 else sig = "elm,state,icon,hidden"; \
11089 elm_object_signal_emit((_ly), sig, "elm"); \
11093 * @def elm_layout_icon_get
11094 * Convienience macro to get the icon object from a layout that follows the
11095 * Elementary naming convention for its parts.
11099 #define elm_layout_icon_get(_ly) \
11100 elm_object_part_content_get((_ly), "elm.swallow.icon")
11103 * @def elm_layout_end_set
11104 * Convienience macro to set the end object in a layout that follows the
11105 * Elementary naming convention for its parts.
11109 #define elm_layout_end_set(_ly, _obj) \
11112 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
11113 if ((_obj)) sig = "elm,state,end,visible"; \
11114 else sig = "elm,state,end,hidden"; \
11115 elm_object_signal_emit((_ly), sig, "elm"); \
11119 * @def elm_layout_end_get
11120 * Convienience macro to get the end object in a layout that follows the
11121 * Elementary naming convention for its parts.
11125 #define elm_layout_end_get(_ly) \
11126 elm_object_part_content_get((_ly), "elm.swallow.end")
11129 * @def elm_layout_label_set
11130 * Convienience macro to set the label in a layout that follows the
11131 * Elementary naming convention for its parts.
11134 * @deprecated use elm_object_text_set() instead.
11136 #define elm_layout_label_set(_ly, _txt) \
11137 elm_layout_text_set((_ly), "elm.text", (_txt))
11140 * @def elm_layout_label_get
11141 * Convenience macro to get the label in a layout that follows the
11142 * Elementary naming convention for its parts.
11145 * @deprecated use elm_object_text_set() instead.
11147 #define elm_layout_label_get(_ly) \
11148 elm_layout_text_get((_ly), "elm.text")
11150 /* smart callbacks called:
11151 * "theme,changed" - when elm theme is changed.
11155 * @defgroup Notify Notify
11157 * @image html img/widget/notify/preview-00.png
11158 * @image latex img/widget/notify/preview-00.eps
11160 * Display a container in a particular region of the parent(top, bottom,
11161 * etc). A timeout can be set to automatically hide the notify. This is so
11162 * that, after an evas_object_show() on a notify object, if a timeout was set
11163 * on it, it will @b automatically get hidden after that time.
11165 * Signals that you can add callbacks for are:
11166 * @li "timeout" - when timeout happens on notify and it's hidden
11167 * @li "block,clicked" - when a click outside of the notify happens
11169 * Default contents parts of the notify widget that you can use for are:
11170 * @li "default" - A content of the notify
11172 * @ref tutorial_notify show usage of the API.
11178 * @brief Possible orient values for notify.
11180 * This values should be used in conjunction to elm_notify_orient_set() to
11181 * set the position in which the notify should appear(relative to its parent)
11182 * and in conjunction with elm_notify_orient_get() to know where the notify
11185 typedef enum _Elm_Notify_Orient
11187 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
11188 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
11189 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
11190 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
11191 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
11192 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
11193 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
11194 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
11195 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
11196 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
11197 } Elm_Notify_Orient;
11200 * @brief Add a new notify to the parent
11202 * @param parent The parent object
11203 * @return The new object or NULL if it cannot be created
11205 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11208 * @brief Set the content of the notify widget
11210 * @param obj The notify object
11211 * @param content The content will be filled in this notify object
11213 * Once the content object is set, a previously set one will be deleted. If
11214 * you want to keep that old content object, use the
11215 * elm_notify_content_unset() function.
11217 * @deprecated use elm_object_content_set() instead
11220 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11223 * @brief Unset the content of the notify widget
11225 * @param obj The notify object
11226 * @return The content that was being used
11228 * Unparent and return the content object which was set for this widget
11230 * @see elm_notify_content_set()
11231 * @deprecated use elm_object_content_unset() instead
11234 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11237 * @brief Return the content of the notify widget
11239 * @param obj The notify object
11240 * @return The content that is being used
11242 * @see elm_notify_content_set()
11243 * @deprecated use elm_object_content_get() instead
11246 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11249 * @brief Set the notify parent
11251 * @param obj The notify object
11252 * @param content The new parent
11254 * Once the parent object is set, a previously set one will be disconnected
11257 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11260 * @brief Get the notify parent
11262 * @param obj The notify object
11263 * @return The parent
11265 * @see elm_notify_parent_set()
11267 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11270 * @brief Set the orientation
11272 * @param obj The notify object
11273 * @param orient The new orientation
11275 * Sets the position in which the notify will appear in its parent.
11277 * @see @ref Elm_Notify_Orient for possible values.
11279 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
11282 * @brief Return the orientation
11283 * @param obj The notify object
11284 * @return The orientation of the notification
11286 * @see elm_notify_orient_set()
11287 * @see Elm_Notify_Orient
11289 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11292 * @brief Set the time interval after which the notify window is going to be
11295 * @param obj The notify object
11296 * @param time The timeout in seconds
11298 * This function sets a timeout and starts the timer controlling when the
11299 * notify is hidden. Since calling evas_object_show() on a notify restarts
11300 * the timer controlling when the notify is hidden, setting this before the
11301 * notify is shown will in effect mean starting the timer when the notify is
11304 * @note Set a value <= 0.0 to disable a running timer.
11306 * @note If the value > 0.0 and the notify is previously visible, the
11307 * timer will be started with this value, canceling any running timer.
11309 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11312 * @brief Return the timeout value (in seconds)
11313 * @param obj the notify object
11315 * @see elm_notify_timeout_set()
11317 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11320 * @brief Sets whether events should be passed to by a click outside
11323 * @param obj The notify object
11324 * @param repeats EINA_TRUE Events are repeats, else no
11326 * When true if the user clicks outside the window the events will be caught
11327 * by the others widgets, else the events are blocked.
11329 * @note The default value is EINA_TRUE.
11331 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11334 * @brief Return true if events are repeat below the notify object
11335 * @param obj the notify object
11337 * @see elm_notify_repeat_events_set()
11339 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11346 * @defgroup Hover Hover
11348 * @image html img/widget/hover/preview-00.png
11349 * @image latex img/widget/hover/preview-00.eps
11351 * A Hover object will hover over its @p parent object at the @p target
11352 * location. Anything in the background will be given a darker coloring to
11353 * indicate that the hover object is on top (at the default theme). When the
11354 * hover is clicked it is dismissed(hidden), if the contents of the hover are
11355 * clicked that @b doesn't cause the hover to be dismissed.
11357 * A Hover object has two parents. One parent that owns it during creation
11358 * and the other parent being the one over which the hover object spans.
11361 * @note The hover object will take up the entire space of @p target
11364 * Elementary has the following styles for the hover widget:
11368 * @li hoversel_vertical
11370 * The following are the available position for content:
11382 * Signals that you can add callbacks for are:
11383 * @li "clicked" - the user clicked the empty space in the hover to dismiss
11384 * @li "smart,changed" - a content object placed under the "smart"
11385 * policy was replaced to a new slot direction.
11387 * See @ref tutorial_hover for more information.
11391 typedef enum _Elm_Hover_Axis
11393 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11394 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11395 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11396 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11400 * @brief Adds a hover object to @p parent
11402 * @param parent The parent object
11403 * @return The hover object or NULL if one could not be created
11405 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11408 * @brief Sets the target object for the hover.
11410 * @param obj The hover object
11411 * @param target The object to center the hover onto.
11413 * This function will cause the hover to be centered on the target object.
11415 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11418 * @brief Gets the target object for the hover.
11420 * @param obj The hover object
11421 * @return The target object for the hover.
11423 * @see elm_hover_target_set()
11425 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11428 * @brief Sets the parent object for the hover.
11430 * @param obj The hover object
11431 * @param parent The object to locate the hover over.
11433 * This function will cause the hover to take up the entire space that the
11434 * parent object fills.
11436 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11439 * @brief Gets the parent object for the hover.
11441 * @param obj The hover object
11442 * @return The parent object to locate the hover over.
11444 * @see elm_hover_parent_set()
11446 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11449 * @brief Sets the content of the hover object and the direction in which it
11452 * @param obj The hover object
11453 * @param swallow The direction that the object will be displayed
11454 * at. Accepted values are "left", "top-left", "top", "top-right",
11455 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11457 * @param content The content to place at @p swallow
11459 * Once the content object is set for a given direction, a previously
11460 * set one (on the same direction) will be deleted. If you want to
11461 * keep that old content object, use the elm_hover_content_unset()
11464 * All directions may have contents at the same time, except for
11465 * "smart". This is a special placement hint and its use case
11466 * independs of the calculations coming from
11467 * elm_hover_best_content_location_get(). Its use is for cases when
11468 * one desires only one hover content, but with a dynamic special
11469 * placement within the hover area. The content's geometry, whenever
11470 * it changes, will be used to decide on a best location, not
11471 * extrapolating the hover's parent object view to show it in (still
11472 * being the hover's target determinant of its medium part -- move and
11473 * resize it to simulate finger sizes, for example). If one of the
11474 * directions other than "smart" are used, a previously content set
11475 * using it will be deleted, and vice-versa.
11477 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11480 * @brief Get the content of the hover object, in a given direction.
11482 * Return the content object which was set for this widget in the
11483 * @p swallow direction.
11485 * @param obj The hover object
11486 * @param swallow The direction that the object was display at.
11487 * @return The content that was being used
11489 * @see elm_hover_content_set()
11491 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11494 * @brief Unset the content of the hover object, in a given direction.
11496 * Unparent and return the content object set at @p swallow direction.
11498 * @param obj The hover object
11499 * @param swallow The direction that the object was display at.
11500 * @return The content that was being used.
11502 * @see elm_hover_content_set()
11504 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11507 * @brief Returns the best swallow location for content in the hover.
11509 * @param obj The hover object
11510 * @param pref_axis The preferred orientation axis for the hover object to use
11511 * @return The edje location to place content into the hover or @c
11514 * Best is defined here as the location at which there is the most available
11517 * @p pref_axis may be one of
11518 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11519 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11520 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11521 * - @c ELM_HOVER_AXIS_BOTH -- both
11523 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11524 * nescessarily be along the horizontal axis("left" or "right"). If
11525 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11526 * be along the vertical axis("top" or "bottom"). Chossing
11527 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11528 * returned position may be in either axis.
11530 * @see elm_hover_content_set()
11532 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11540 * @defgroup Entry Entry
11542 * @image html img/widget/entry/preview-00.png
11543 * @image latex img/widget/entry/preview-00.eps width=\textwidth
11544 * @image html img/widget/entry/preview-01.png
11545 * @image latex img/widget/entry/preview-01.eps width=\textwidth
11546 * @image html img/widget/entry/preview-02.png
11547 * @image latex img/widget/entry/preview-02.eps width=\textwidth
11548 * @image html img/widget/entry/preview-03.png
11549 * @image latex img/widget/entry/preview-03.eps width=\textwidth
11551 * An entry is a convenience widget which shows a box that the user can
11552 * enter text into. Entries by default don't scroll, so they grow to
11553 * accomodate the entire text, resizing the parent window as needed. This
11554 * can be changed with the elm_entry_scrollable_set() function.
11556 * They can also be single line or multi line (the default) and when set
11557 * to multi line mode they support text wrapping in any of the modes
11558 * indicated by #Elm_Wrap_Type.
11560 * Other features include password mode, filtering of inserted text with
11561 * elm_entry_text_filter_append() and related functions, inline "items" and
11562 * formatted markup text.
11564 * @section entry-markup Formatted text
11566 * The markup tags supported by the Entry are defined by the theme, but
11567 * even when writing new themes or extensions it's a good idea to stick to
11568 * a sane default, to maintain coherency and avoid application breakages.
11569 * Currently defined by the default theme are the following tags:
11570 * @li \<br\>: Inserts a line break.
11571 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11573 * @li \<tab\>: Inserts a tab.
11574 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11576 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11577 * @li \<link\>...\</link\>: Underlines the enclosed text.
11578 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11580 * @section entry-special Special markups
11582 * Besides those used to format text, entries support two special markup
11583 * tags used to insert clickable portions of text or items inlined within
11586 * @subsection entry-anchors Anchors
11588 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11589 * \</a\> tags and an event will be generated when this text is clicked,
11593 * This text is outside <a href=anc-01>but this one is an anchor</a>
11596 * The @c href attribute in the opening tag gives the name that will be
11597 * used to identify the anchor and it can be any valid utf8 string.
11599 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11600 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11601 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11602 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11605 * @subsection entry-items Items
11607 * Inlined in the text, any other @c Evas_Object can be inserted by using
11608 * \<item\> tags this way:
11611 * <item size=16x16 vsize=full href=emoticon/haha></item>
11614 * Just like with anchors, the @c href identifies each item, but these need,
11615 * in addition, to indicate their size, which is done using any one of
11616 * @c size, @c absize or @c relsize attributes. These attributes take their
11617 * value in the WxH format, where W is the width and H the height of the
11620 * @li absize: Absolute pixel size for the item. Whatever value is set will
11621 * be the item's size regardless of any scale value the object may have
11622 * been set to. The final line height will be adjusted to fit larger items.
11623 * @li size: Similar to @c absize, but it's adjusted to the scale value set
11625 * @li relsize: Size is adjusted for the item to fit within the current
11628 * Besides their size, items are specificed a @c vsize value that affects
11629 * how their final size and position are calculated. The possible values
11631 * @li ascent: Item will be placed within the line's baseline and its
11632 * ascent. That is, the height between the line where all characters are
11633 * positioned and the highest point in the line. For @c size and @c absize
11634 * items, the descent value will be added to the total line height to make
11635 * them fit. @c relsize items will be adjusted to fit within this space.
11636 * @li full: Items will be placed between the descent and ascent, or the
11637 * lowest point in the line and its highest.
11639 * The next image shows different configurations of items and how
11640 * the previously mentioned options affect their sizes. In all cases,
11641 * the green line indicates the ascent, blue for the baseline and red for
11644 * @image html entry_item.png
11645 * @image latex entry_item.eps width=\textwidth
11647 * And another one to show how size differs from absize. In the first one,
11648 * the scale value is set to 1.0, while the second one is using one of 2.0.
11650 * @image html entry_item_scale.png
11651 * @image latex entry_item_scale.eps width=\textwidth
11653 * After the size for an item is calculated, the entry will request an
11654 * object to place in its space. For this, the functions set with
11655 * elm_entry_item_provider_append() and related functions will be called
11656 * in order until one of them returns a @c non-NULL value. If no providers
11657 * are available, or all of them return @c NULL, then the entry falls back
11658 * to one of the internal defaults, provided the name matches with one of
11661 * All of the following are currently supported:
11664 * - emoticon/angry-shout
11665 * - emoticon/crazy-laugh
11666 * - emoticon/evil-laugh
11668 * - emoticon/goggle-smile
11669 * - emoticon/grumpy
11670 * - emoticon/grumpy-smile
11671 * - emoticon/guilty
11672 * - emoticon/guilty-smile
11674 * - emoticon/half-smile
11675 * - emoticon/happy-panting
11677 * - emoticon/indifferent
11679 * - emoticon/knowing-grin
11681 * - emoticon/little-bit-sorry
11682 * - emoticon/love-lots
11684 * - emoticon/minimal-smile
11685 * - emoticon/not-happy
11686 * - emoticon/not-impressed
11688 * - emoticon/opensmile
11691 * - emoticon/squint-laugh
11692 * - emoticon/surprised
11693 * - emoticon/suspicious
11694 * - emoticon/tongue-dangling
11695 * - emoticon/tongue-poke
11697 * - emoticon/unhappy
11698 * - emoticon/very-sorry
11701 * - emoticon/worried
11704 * Alternatively, an item may reference an image by its path, using
11705 * the URI form @c file:///path/to/an/image.png and the entry will then
11706 * use that image for the item.
11708 * @section entry-files Loading and saving files
11710 * Entries have convinience functions to load text from a file and save
11711 * changes back to it after a short delay. The automatic saving is enabled
11712 * by default, but can be disabled with elm_entry_autosave_set() and files
11713 * can be loaded directly as plain text or have any markup in them
11714 * recognized. See elm_entry_file_set() for more details.
11716 * @section entry-signals Emitted signals
11718 * This widget emits the following signals:
11720 * @li "changed": The text within the entry was changed.
11721 * @li "changed,user": The text within the entry was changed because of user interaction.
11722 * @li "activated": The enter key was pressed on a single line entry.
11723 * @li "press": A mouse button has been pressed on the entry.
11724 * @li "longpressed": A mouse button has been pressed and held for a couple
11726 * @li "clicked": The entry has been clicked (mouse press and release).
11727 * @li "clicked,double": The entry has been double clicked.
11728 * @li "clicked,triple": The entry has been triple clicked.
11729 * @li "focused": The entry has received focus.
11730 * @li "unfocused": The entry has lost focus.
11731 * @li "selection,paste": A paste of the clipboard contents was requested.
11732 * @li "selection,copy": A copy of the selected text into the clipboard was
11734 * @li "selection,cut": A cut of the selected text into the clipboard was
11736 * @li "selection,start": A selection has begun and no previous selection
11738 * @li "selection,changed": The current selection has changed.
11739 * @li "selection,cleared": The current selection has been cleared.
11740 * @li "cursor,changed": The cursor has changed position.
11741 * @li "anchor,clicked": An anchor has been clicked. The event_info
11742 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11743 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11744 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11745 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11746 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11747 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11748 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11749 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11750 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11751 * @li "preedit,changed": The preedit string has changed.
11752 * @li "language,changed": Program language changed.
11754 * @section entry-examples
11756 * An overview of the Entry API can be seen in @ref entry_example_01
11762 * @typedef Elm_Entry_Anchor_Info
11764 * The info sent in the callback for the "anchor,clicked" signals emitted
11767 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11770 * @struct _Elm_Entry_Anchor_Info
11772 * The info sent in the callback for the "anchor,clicked" signals emitted
11775 struct _Elm_Entry_Anchor_Info
11777 const char *name; /**< The name of the anchor, as stated in its href */
11778 int button; /**< The mouse button used to click on it */
11779 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11780 y, /**< Anchor geometry, relative to canvas */
11781 w, /**< Anchor geometry, relative to canvas */
11782 h; /**< Anchor geometry, relative to canvas */
11786 * @typedef Elm_Entry_Filter_Cb
11787 * This callback type is used by entry filters to modify text.
11788 * @param data The data specified as the last param when adding the filter
11789 * @param entry The entry object
11790 * @param text A pointer to the location of the text being filtered. This data can be modified,
11791 * but any additional allocations must be managed by the user.
11792 * @see elm_entry_text_filter_append
11793 * @see elm_entry_text_filter_prepend
11795 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11798 * @typedef Elm_Entry_Change_Info
11799 * This corresponds to Edje_Entry_Change_Info. Includes information about
11800 * a change in the entry.
11802 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11806 * This adds an entry to @p parent object.
11808 * By default, entries are:
11812 * @li autosave is enabled
11814 * @param parent The parent object
11815 * @return The new object or NULL if it cannot be created
11817 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11820 * Sets the entry to single line mode.
11822 * In single line mode, entries don't ever wrap when the text reaches the
11823 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11824 * key will generate an @c "activate" event instead of adding a new line.
11826 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11827 * and pressing enter will break the text into a different line
11828 * without generating any events.
11830 * @param obj The entry object
11831 * @param single_line If true, the text in the entry
11832 * will be on a single line.
11834 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11837 * Gets whether the entry is set to be single line.
11839 * @param obj The entry object
11840 * @return single_line If true, the text in the entry is set to display
11841 * on a single line.
11843 * @see elm_entry_single_line_set()
11845 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11848 * Sets the entry to password mode.
11850 * In password mode, entries are implicitly single line and the display of
11851 * any text in them is replaced with asterisks (*).
11853 * @param obj The entry object
11854 * @param password If true, password mode is enabled.
11856 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11859 * Gets whether the entry is set to password mode.
11861 * @param obj The entry object
11862 * @return If true, the entry is set to display all characters
11863 * as asterisks (*).
11865 * @see elm_entry_password_set()
11867 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11870 * This sets the text displayed within the entry to @p entry.
11872 * @param obj The entry object
11873 * @param entry The text to be displayed
11875 * @deprecated Use elm_object_text_set() instead.
11876 * @note Using this function bypasses text filters
11878 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11881 * This returns the text currently shown in object @p entry.
11882 * See also elm_entry_entry_set().
11884 * @param obj The entry object
11885 * @return The currently displayed text or NULL on failure
11887 * @deprecated Use elm_object_text_get() instead.
11889 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11892 * Appends @p entry to the text of the entry.
11894 * Adds the text in @p entry to the end of any text already present in the
11897 * The appended text is subject to any filters set for the widget.
11899 * @param obj The entry object
11900 * @param entry The text to be displayed
11902 * @see elm_entry_text_filter_append()
11904 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11907 * Gets whether the entry is empty.
11909 * Empty means no text at all. If there are any markup tags, like an item
11910 * tag for which no provider finds anything, and no text is displayed, this
11911 * function still returns EINA_FALSE.
11913 * @param obj The entry object
11914 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11916 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11919 * Gets any selected text within the entry.
11921 * If there's any selected text in the entry, this function returns it as
11922 * a string in markup format. NULL is returned if no selection exists or
11923 * if an error occurred.
11925 * The returned value points to an internal string and should not be freed
11926 * or modified in any way. If the @p entry object is deleted or its
11927 * contents are changed, the returned pointer should be considered invalid.
11929 * @param obj The entry object
11930 * @return The selected text within the entry or NULL on failure
11932 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11935 * Returns the actual textblock object of the entry.
11937 * This function exposes the internal textblock object that actually
11938 * contains and draws the text. This should be used for low-level
11939 * manipulations that are otherwise not possible.
11941 * Changing the textblock directly from here will not notify edje/elm to
11942 * recalculate the textblock size automatically, so any modifications
11943 * done to the textblock returned by this function should be followed by
11944 * a call to elm_entry_calc_force().
11946 * The return value is marked as const as an additional warning.
11947 * One should not use the returned object with any of the generic evas
11948 * functions (geometry_get/resize/move and etc), but only with the textblock
11949 * functions; The former will either not work at all, or break the correct
11952 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11953 * the internal textblock object. Do NOT cache the returned object, and try
11954 * not to mix calls on this object with regular elm_entry calls (which may
11955 * change the internal textblock object). This applies to all cursors
11956 * returned from textblock calls, and all the other derivative values.
11958 * @param obj The entry object
11959 * @return The textblock object.
11961 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11964 * Forces calculation of the entry size and text layouting.
11966 * This should be used after modifying the textblock object directly. See
11967 * elm_entry_textblock_get() for more information.
11969 * @param obj The entry object
11971 * @see elm_entry_textblock_get()
11973 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11976 * Inserts the given text into the entry at the current cursor position.
11978 * This inserts text at the cursor position as if it was typed
11979 * by the user (note that this also allows markup which a user
11980 * can't just "type" as it would be converted to escaped text, so this
11981 * call can be used to insert things like emoticon items or bold push/pop
11982 * tags, other font and color change tags etc.)
11984 * If any selection exists, it will be replaced by the inserted text.
11986 * The inserted text is subject to any filters set for the widget.
11988 * @param obj The entry object
11989 * @param entry The text to insert
11991 * @see elm_entry_text_filter_append()
11993 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11996 * Set the line wrap type to use on multi-line entries.
11998 * Sets the wrap type used by the entry to any of the specified in
11999 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
12000 * line (without inserting a line break or paragraph separator) when it
12001 * reaches the far edge of the widget.
12003 * Note that this only makes sense for multi-line entries. A widget set
12004 * to be single line will never wrap.
12006 * @param obj The entry object
12007 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
12009 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
12012 * Gets the wrap mode the entry was set to use.
12014 * @param obj The entry object
12015 * @return Wrap type
12017 * @see also elm_entry_line_wrap_set()
12019 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12022 * Sets if the entry is to be editable or not.
12024 * By default, entries are editable and when focused, any text input by the
12025 * user will be inserted at the current cursor position. But calling this
12026 * function with @p editable as EINA_FALSE will prevent the user from
12027 * inputting text into the entry.
12029 * The only way to change the text of a non-editable entry is to use
12030 * elm_object_text_set(), elm_entry_entry_insert() and other related
12033 * @param obj The entry object
12034 * @param editable If EINA_TRUE, user input will be inserted in the entry,
12035 * if not, the entry is read-only and no user input is allowed.
12037 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12040 * Gets whether the entry is editable or not.
12042 * @param obj The entry object
12043 * @return If true, the entry is editable by the user.
12044 * If false, it is not editable by the user
12046 * @see elm_entry_editable_set()
12048 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12051 * This drops any existing text selection within the entry.
12053 * @param obj The entry object
12055 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12058 * This selects all text within the entry.
12060 * @param obj The entry object
12062 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12065 * This moves the cursor one place to the right within the entry.
12067 * @param obj The entry object
12068 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12070 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12073 * This moves the cursor one place to the left within the entry.
12075 * @param obj The entry object
12076 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12078 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12081 * This moves the cursor one line up within the entry.
12083 * @param obj The entry object
12084 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12086 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12089 * This moves the cursor one line down within the entry.
12091 * @param obj The entry object
12092 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12094 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12097 * This moves the cursor to the beginning of the entry.
12099 * @param obj The entry object
12101 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12104 * This moves the cursor to the end of the entry.
12106 * @param obj The entry object
12108 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12111 * This moves the cursor to the beginning of the current line.
12113 * @param obj The entry object
12115 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12118 * This moves the cursor to the end of the current line.
12120 * @param obj The entry object
12122 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12125 * This begins a selection within the entry as though
12126 * the user were holding down the mouse button to make a selection.
12128 * @param obj The entry object
12130 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12133 * This ends a selection within the entry as though
12134 * the user had just released the mouse button while making a selection.
12136 * @param obj The entry object
12138 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12141 * Gets whether a format node exists at the current cursor position.
12143 * A format node is anything that defines how the text is rendered. It can
12144 * be a visible format node, such as a line break or a paragraph separator,
12145 * or an invisible one, such as bold begin or end tag.
12146 * This function returns whether any format node exists at the current
12149 * @param obj The entry object
12150 * @return EINA_TRUE if the current cursor position contains a format node,
12151 * EINA_FALSE otherwise.
12153 * @see elm_entry_cursor_is_visible_format_get()
12155 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12158 * Gets if the current cursor position holds a visible format node.
12160 * @param obj The entry object
12161 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
12162 * if it's an invisible one or no format exists.
12164 * @see elm_entry_cursor_is_format_get()
12166 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12169 * Gets the character pointed by the cursor at its current position.
12171 * This function returns a string with the utf8 character stored at the
12172 * current cursor position.
12173 * Only the text is returned, any format that may exist will not be part
12174 * of the return value.
12176 * @param obj The entry object
12177 * @return The text pointed by the cursors.
12179 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12182 * This function returns the geometry of the cursor.
12184 * It's useful if you want to draw something on the cursor (or where it is),
12185 * or for example in the case of scrolled entry where you want to show the
12188 * @param obj The entry object
12189 * @param x returned geometry
12190 * @param y returned geometry
12191 * @param w returned geometry
12192 * @param h returned geometry
12193 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12195 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);
12198 * Sets the cursor position in the entry to the given value
12200 * The value in @p pos is the index of the character position within the
12201 * contents of the string as returned by elm_entry_cursor_pos_get().
12203 * @param obj The entry object
12204 * @param pos The position of the cursor
12206 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12209 * Retrieves the current position of the cursor in the entry
12211 * @param obj The entry object
12212 * @return The cursor position
12214 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12217 * This executes a "cut" action on the selected text in the entry.
12219 * @param obj The entry object
12221 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12224 * This executes a "copy" action on the selected text in the entry.
12226 * @param obj The entry object
12228 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12231 * This executes a "paste" action in the entry.
12233 * @param obj The entry object
12235 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12238 * This clears and frees the items in a entry's contextual (longpress)
12241 * @param obj The entry object
12243 * @see elm_entry_context_menu_item_add()
12245 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12248 * This adds an item to the entry's contextual menu.
12250 * A longpress on an entry will make the contextual menu show up, if this
12251 * hasn't been disabled with elm_entry_context_menu_disabled_set().
12252 * By default, this menu provides a few options like enabling selection mode,
12253 * which is useful on embedded devices that need to be explicit about it,
12254 * and when a selection exists it also shows the copy and cut actions.
12256 * With this function, developers can add other options to this menu to
12257 * perform any action they deem necessary.
12259 * @param obj The entry object
12260 * @param label The item's text label
12261 * @param icon_file The item's icon file
12262 * @param icon_type The item's icon type
12263 * @param func The callback to execute when the item is clicked
12264 * @param data The data to associate with the item for related functions
12266 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);
12269 * This disables the entry's contextual (longpress) menu.
12271 * @param obj The entry object
12272 * @param disabled If true, the menu is disabled
12274 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12277 * This returns whether the entry's contextual (longpress) menu is
12280 * @param obj The entry object
12281 * @return If true, the menu is disabled
12283 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12286 * This appends a custom item provider to the list for that entry
12288 * This appends the given callback. The list is walked from beginning to end
12289 * with each function called given the item href string in the text. If the
12290 * function returns an object handle other than NULL (it should create an
12291 * object to do this), then this object is used to replace that item. If
12292 * not the next provider is called until one provides an item object, or the
12293 * default provider in entry does.
12295 * @param obj The entry object
12296 * @param func The function called to provide the item object
12297 * @param data The data passed to @p func
12299 * @see @ref entry-items
12301 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);
12304 * This prepends a custom item provider to the list for that entry
12306 * This prepends the given callback. See elm_entry_item_provider_append() for
12309 * @param obj The entry object
12310 * @param func The function called to provide the item object
12311 * @param data The data passed to @p func
12313 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);
12316 * This removes a custom item provider to the list for that entry
12318 * This removes the given callback. See elm_entry_item_provider_append() for
12321 * @param obj The entry object
12322 * @param func The function called to provide the item object
12323 * @param data The data passed to @p func
12325 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);
12328 * Append a filter function for text inserted in the entry
12330 * Append the given callback to the list. This functions will be called
12331 * whenever any text is inserted into the entry, with the text to be inserted
12332 * as a parameter. The callback function is free to alter the text in any way
12333 * it wants, but it must remember to free the given pointer and update it.
12334 * If the new text is to be discarded, the function can free it and set its
12335 * text parameter to NULL. This will also prevent any following filters from
12338 * @param obj The entry object
12339 * @param func The function to use as text filter
12340 * @param data User data to pass to @p func
12342 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12345 * Prepend a filter function for text insdrted in the entry
12347 * Prepend the given callback to the list. See elm_entry_text_filter_append()
12348 * for more information
12350 * @param obj The entry object
12351 * @param func The function to use as text filter
12352 * @param data User data to pass to @p func
12354 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12357 * Remove a filter from the list
12359 * Removes the given callback from the filter list. See
12360 * elm_entry_text_filter_append() for more information.
12362 * @param obj The entry object
12363 * @param func The filter function to remove
12364 * @param data The user data passed when adding the function
12366 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12369 * This converts a markup (HTML-like) string into UTF-8.
12371 * The returned string is a malloc'ed buffer and it should be freed when
12372 * not needed anymore.
12374 * @param s The string (in markup) to be converted
12375 * @return The converted string (in UTF-8). It should be freed.
12377 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12380 * This converts a UTF-8 string into markup (HTML-like).
12382 * The returned string is a malloc'ed buffer and it should be freed when
12383 * not needed anymore.
12385 * @param s The string (in UTF-8) to be converted
12386 * @return The converted string (in markup). It should be freed.
12388 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12391 * This sets the file (and implicitly loads it) for the text to display and
12392 * then edit. All changes are written back to the file after a short delay if
12393 * the entry object is set to autosave (which is the default).
12395 * If the entry had any other file set previously, any changes made to it
12396 * will be saved if the autosave feature is enabled, otherwise, the file
12397 * will be silently discarded and any non-saved changes will be lost.
12399 * @param obj The entry object
12400 * @param file The path to the file to load and save
12401 * @param format The file format
12403 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12406 * Gets the file being edited by the entry.
12408 * This function can be used to retrieve any file set on the entry for
12409 * edition, along with the format used to load and save it.
12411 * @param obj The entry object
12412 * @param file The path to the file to load and save
12413 * @param format The file format
12415 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12418 * This function writes any changes made to the file set with
12419 * elm_entry_file_set()
12421 * @param obj The entry object
12423 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12426 * This sets the entry object to 'autosave' the loaded text file or not.
12428 * @param obj The entry object
12429 * @param autosave Autosave the loaded file or not
12431 * @see elm_entry_file_set()
12433 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12436 * This gets the entry object's 'autosave' status.
12438 * @param obj The entry object
12439 * @return Autosave the loaded file or not
12441 * @see elm_entry_file_set()
12443 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12446 * Control pasting of text and images for the widget.
12448 * Normally the entry allows both text and images to be pasted. By setting
12449 * textonly to be true, this prevents images from being pasted.
12451 * Note this only changes the behaviour of text.
12453 * @param obj The entry object
12454 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12455 * text+image+other.
12457 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12460 * Getting elm_entry text paste/drop mode.
12462 * In textonly mode, only text may be pasted or dropped into the widget.
12464 * @param obj The entry object
12465 * @return If the widget only accepts text from pastes.
12467 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12470 * Enable or disable scrolling in entry
12472 * Normally the entry is not scrollable unless you enable it with this call.
12474 * @param obj The entry object
12475 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12477 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12480 * Get the scrollable state of the entry
12482 * Normally the entry is not scrollable. This gets the scrollable state
12483 * of the entry. See elm_entry_scrollable_set() for more information.
12485 * @param obj The entry object
12486 * @return The scrollable state
12488 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
12491 * This sets a widget to be displayed to the left of a scrolled entry.
12493 * @param obj The scrolled entry object
12494 * @param icon The widget to display on the left side of the scrolled
12497 * @note A previously set widget will be destroyed.
12498 * @note If the object being set does not have minimum size hints set,
12499 * it won't get properly displayed.
12501 * @see elm_entry_end_set()
12503 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12506 * Gets the leftmost widget of the scrolled entry. This object is
12507 * owned by the scrolled entry and should not be modified.
12509 * @param obj The scrolled entry object
12510 * @return the left widget inside the scroller
12512 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12515 * Unset the leftmost widget of the scrolled entry, unparenting and
12518 * @param obj The scrolled entry object
12519 * @return the previously set icon sub-object of this entry, on
12522 * @see elm_entry_icon_set()
12524 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12527 * Sets the visibility of the left-side widget of the scrolled entry,
12528 * set by elm_entry_icon_set().
12530 * @param obj The scrolled entry object
12531 * @param setting EINA_TRUE if the object should be displayed,
12532 * EINA_FALSE if not.
12534 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12537 * This sets a widget to be displayed to the end of a scrolled entry.
12539 * @param obj The scrolled entry object
12540 * @param end The widget to display on the right side of the scrolled
12543 * @note A previously set widget will be destroyed.
12544 * @note If the object being set does not have minimum size hints set,
12545 * it won't get properly displayed.
12547 * @see elm_entry_icon_set
12549 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12552 * Gets the endmost widget of the scrolled entry. This object is owned
12553 * by the scrolled entry and should not be modified.
12555 * @param obj The scrolled entry object
12556 * @return the right widget inside the scroller
12558 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12561 * Unset the endmost widget of the scrolled entry, unparenting and
12564 * @param obj The scrolled entry object
12565 * @return the previously set icon sub-object of this entry, on
12568 * @see elm_entry_icon_set()
12570 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12573 * Sets the visibility of the end widget of the scrolled entry, set by
12574 * elm_entry_end_set().
12576 * @param obj The scrolled entry object
12577 * @param setting EINA_TRUE if the object should be displayed,
12578 * EINA_FALSE if not.
12580 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12583 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12586 * Setting an entry to single-line mode with elm_entry_single_line_set()
12587 * will automatically disable the display of scrollbars when the entry
12588 * moves inside its scroller.
12590 * @param obj The scrolled entry object
12591 * @param h The horizontal scrollbar policy to apply
12592 * @param v The vertical scrollbar policy to apply
12594 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12597 * This enables/disables bouncing within the entry.
12599 * This function sets whether the entry will bounce when scrolling reaches
12600 * the end of the contained entry.
12602 * @param obj The scrolled entry object
12603 * @param h The horizontal bounce state
12604 * @param v The vertical bounce state
12606 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12609 * Get the bounce mode
12611 * @param obj The Entry object
12612 * @param h_bounce Allow bounce horizontally
12613 * @param v_bounce Allow bounce vertically
12615 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12617 /* pre-made filters for entries */
12619 * @typedef Elm_Entry_Filter_Limit_Size
12621 * Data for the elm_entry_filter_limit_size() entry filter.
12623 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12626 * @struct _Elm_Entry_Filter_Limit_Size
12628 * Data for the elm_entry_filter_limit_size() entry filter.
12630 struct _Elm_Entry_Filter_Limit_Size
12632 int max_char_count; /**< The maximum number of characters allowed. */
12633 int max_byte_count; /**< The maximum number of bytes allowed*/
12637 * Filter inserted text based on user defined character and byte limits
12639 * Add this filter to an entry to limit the characters that it will accept
12640 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12641 * The funtion works on the UTF-8 representation of the string, converting
12642 * it from the set markup, thus not accounting for any format in it.
12644 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12645 * it as data when setting the filter. In it, it's possible to set limits
12646 * by character count or bytes (any of them is disabled if 0), and both can
12647 * be set at the same time. In that case, it first checks for characters,
12650 * The function will cut the inserted text in order to allow only the first
12651 * number of characters that are still allowed. The cut is made in
12652 * characters, even when limiting by bytes, in order to always contain
12653 * valid ones and avoid half unicode characters making it in.
12655 * This filter, like any others, does not apply when setting the entry text
12656 * directly with elm_object_text_set() (or the deprecated
12657 * elm_entry_entry_set()).
12659 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12662 * @typedef Elm_Entry_Filter_Accept_Set
12664 * Data for the elm_entry_filter_accept_set() entry filter.
12666 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12669 * @struct _Elm_Entry_Filter_Accept_Set
12671 * Data for the elm_entry_filter_accept_set() entry filter.
12673 struct _Elm_Entry_Filter_Accept_Set
12675 const char *accepted; /**< Set of characters accepted in the entry. */
12676 const char *rejected; /**< Set of characters rejected from the entry. */
12680 * Filter inserted text based on accepted or rejected sets of characters
12682 * Add this filter to an entry to restrict the set of accepted characters
12683 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12684 * This structure contains both accepted and rejected sets, but they are
12685 * mutually exclusive.
12687 * The @c accepted set takes preference, so if it is set, the filter will
12688 * only work based on the accepted characters, ignoring anything in the
12689 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12691 * In both cases, the function filters by matching utf8 characters to the
12692 * raw markup text, so it can be used to remove formatting tags.
12694 * This filter, like any others, does not apply when setting the entry text
12695 * directly with elm_object_text_set() (or the deprecated
12696 * elm_entry_entry_set()).
12698 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12700 * Set the input panel layout of the entry
12702 * @param obj The entry object
12703 * @param layout layout type
12705 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12708 * Get the input panel layout of the entry
12710 * @param obj The entry object
12711 * @return layout type
12713 * @see elm_entry_input_panel_layout_set
12715 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12718 * Set the autocapitalization type on the immodule.
12720 * @param obj The entry object
12721 * @param autocapital_type The type of autocapitalization
12723 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12726 * Retrieve the autocapitalization type on the immodule.
12728 * @param obj The entry object
12729 * @return autocapitalization type
12731 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12734 * Sets the attribute to show the input panel automatically.
12736 * @param obj The entry object
12737 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12739 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12742 * Retrieve the attribute to show the input panel automatically.
12744 * @param obj The entry object
12745 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12747 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12753 /* composite widgets - these basically put together basic widgets above
12754 * in convenient packages that do more than basic stuff */
12758 * @defgroup Anchorview Anchorview
12760 * @image html img/widget/anchorview/preview-00.png
12761 * @image latex img/widget/anchorview/preview-00.eps
12763 * Anchorview is for displaying text that contains markup with anchors
12764 * like <c>\<a href=1234\>something\</\></c> in it.
12766 * Besides being styled differently, the anchorview widget provides the
12767 * necessary functionality so that clicking on these anchors brings up a
12768 * popup with user defined content such as "call", "add to contacts" or
12769 * "open web page". This popup is provided using the @ref Hover widget.
12771 * This widget is very similar to @ref Anchorblock, so refer to that
12772 * widget for an example. The only difference Anchorview has is that the
12773 * widget is already provided with scrolling functionality, so if the
12774 * text set to it is too large to fit in the given space, it will scroll,
12775 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12776 * text can be displayed.
12778 * This widget emits the following signals:
12779 * @li "anchor,clicked": will be called when an anchor is clicked. The
12780 * @p event_info parameter on the callback will be a pointer of type
12781 * ::Elm_Entry_Anchorview_Info.
12783 * See @ref Anchorblock for an example on how to use both of them.
12793 * @typedef Elm_Entry_Anchorview_Info
12795 * The info sent in the callback for "anchor,clicked" signals emitted by
12796 * the Anchorview widget.
12798 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12801 * @struct _Elm_Entry_Anchorview_Info
12803 * The info sent in the callback for "anchor,clicked" signals emitted by
12804 * the Anchorview widget.
12806 struct _Elm_Entry_Anchorview_Info
12808 const char *name; /**< Name of the anchor, as indicated in its href
12810 int button; /**< The mouse button used to click on it */
12811 Evas_Object *hover; /**< The hover object to use for the popup */
12813 Evas_Coord x, y, w, h;
12814 } anchor, /**< Geometry selection of text used as anchor */
12815 hover_parent; /**< Geometry of the object used as parent by the
12817 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12818 for content on the left side of
12819 the hover. Before calling the
12820 callback, the widget will make the
12821 necessary calculations to check
12822 which sides are fit to be set with
12823 content, based on the position the
12824 hover is activated and its distance
12825 to the edges of its parent object
12827 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12828 the right side of the hover.
12829 See @ref hover_left */
12830 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12831 of the hover. See @ref hover_left */
12832 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12833 below the hover. See @ref
12838 * Add a new Anchorview object
12840 * @param parent The parent object
12841 * @return The new object or NULL if it cannot be created
12843 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12846 * Set the text to show in the anchorview
12848 * Sets the text of the anchorview to @p text. This text can include markup
12849 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12850 * text that will be specially styled and react to click events, ended with
12851 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12852 * "anchor,clicked" signal that you can attach a callback to with
12853 * evas_object_smart_callback_add(). The name of the anchor given in the
12854 * event info struct will be the one set in the href attribute, in this
12855 * case, anchorname.
12857 * Other markup can be used to style the text in different ways, but it's
12858 * up to the style defined in the theme which tags do what.
12859 * @deprecated use elm_object_text_set() instead.
12861 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12864 * Get the markup text set for the anchorview
12866 * Retrieves the text set on the anchorview, with markup tags included.
12868 * @param obj The anchorview object
12869 * @return The markup text set or @c NULL if nothing was set or an error
12871 * @deprecated use elm_object_text_set() instead.
12873 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12876 * Set the parent of the hover popup
12878 * Sets the parent object to use by the hover created by the anchorview
12879 * when an anchor is clicked. See @ref Hover for more details on this.
12880 * If no parent is set, the same anchorview object will be used.
12882 * @param obj The anchorview object
12883 * @param parent The object to use as parent for the hover
12885 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12888 * Get the parent of the hover popup
12890 * Get the object used as parent for the hover created by the anchorview
12891 * widget. See @ref Hover for more details on this.
12893 * @param obj The anchorview object
12894 * @return The object used as parent for the hover, NULL if none is set.
12896 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12899 * Set the style that the hover should use
12901 * When creating the popup hover, anchorview will request that it's
12902 * themed according to @p style.
12904 * @param obj The anchorview object
12905 * @param style The style to use for the underlying hover
12907 * @see elm_object_style_set()
12909 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12912 * Get the style that the hover should use
12914 * Get the style the hover created by anchorview will use.
12916 * @param obj The anchorview object
12917 * @return The style to use by the hover. NULL means the default is used.
12919 * @see elm_object_style_set()
12921 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12924 * Ends the hover popup in the anchorview
12926 * When an anchor is clicked, the anchorview widget will create a hover
12927 * object to use as a popup with user provided content. This function
12928 * terminates this popup, returning the anchorview to its normal state.
12930 * @param obj The anchorview object
12932 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12935 * Set bouncing behaviour when the scrolled content reaches an edge
12937 * Tell the internal scroller object whether it should bounce or not
12938 * when it reaches the respective edges for each axis.
12940 * @param obj The anchorview object
12941 * @param h_bounce Whether to bounce or not in the horizontal axis
12942 * @param v_bounce Whether to bounce or not in the vertical axis
12944 * @see elm_scroller_bounce_set()
12946 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12949 * Get the set bouncing behaviour of the internal scroller
12951 * Get whether the internal scroller should bounce when the edge of each
12952 * axis is reached scrolling.
12954 * @param obj The anchorview object
12955 * @param h_bounce Pointer where to store the bounce state of the horizontal
12957 * @param v_bounce Pointer where to store the bounce state of the vertical
12960 * @see elm_scroller_bounce_get()
12962 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12965 * Appends a custom item provider to the given anchorview
12967 * Appends the given function to the list of items providers. This list is
12968 * called, one function at a time, with the given @p data pointer, the
12969 * anchorview object and, in the @p item parameter, the item name as
12970 * referenced in its href string. Following functions in the list will be
12971 * called in order until one of them returns something different to NULL,
12972 * which should be an Evas_Object which will be used in place of the item
12975 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12976 * href=item/name\>\</item\>
12978 * @param obj The anchorview object
12979 * @param func The function to add to the list of providers
12980 * @param data User data that will be passed to the callback function
12982 * @see elm_entry_item_provider_append()
12984 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);
12987 * Prepend a custom item provider to the given anchorview
12989 * Like elm_anchorview_item_provider_append(), but it adds the function
12990 * @p func to the beginning of the list, instead of the end.
12992 * @param obj The anchorview object
12993 * @param func The function to add to the list of providers
12994 * @param data User data that will be passed to the callback function
12996 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);
12999 * Remove a custom item provider from the list of the given anchorview
13001 * Removes the function and data pairing that matches @p func and @p data.
13002 * That is, unless the same function and same user data are given, the
13003 * function will not be removed from the list. This allows us to add the
13004 * same callback several times, with different @p data pointers and be
13005 * able to remove them later without conflicts.
13007 * @param obj The anchorview object
13008 * @param func The function to remove from the list
13009 * @param data The data matching the function to remove from the list
13011 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);
13019 * @defgroup Anchorblock Anchorblock
13021 * @image html img/widget/anchorblock/preview-00.png
13022 * @image latex img/widget/anchorblock/preview-00.eps
13024 * Anchorblock is for displaying text that contains markup with anchors
13025 * like <c>\<a href=1234\>something\</\></c> in it.
13027 * Besides being styled differently, the anchorblock widget provides the
13028 * necessary functionality so that clicking on these anchors brings up a
13029 * popup with user defined content such as "call", "add to contacts" or
13030 * "open web page". This popup is provided using the @ref Hover widget.
13032 * This widget emits the following signals:
13033 * @li "anchor,clicked": will be called when an anchor is clicked. The
13034 * @p event_info parameter on the callback will be a pointer of type
13035 * ::Elm_Entry_Anchorblock_Info.
13041 * Since examples are usually better than plain words, we might as well
13042 * try @ref tutorial_anchorblock_example "one".
13046 * @addtogroup Anchorblock
13051 * @typedef Elm_Entry_Anchorblock_Info
13053 * The info sent in the callback for "anchor,clicked" signals emitted by
13054 * the Anchorblock widget.
13056 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
13059 * @struct _Elm_Entry_Anchorblock_Info
13061 * The info sent in the callback for "anchor,clicked" signals emitted by
13062 * the Anchorblock widget.
13064 struct _Elm_Entry_Anchorblock_Info
13066 const char *name; /**< Name of the anchor, as indicated in its href
13068 int button; /**< The mouse button used to click on it */
13069 Evas_Object *hover; /**< The hover object to use for the popup */
13071 Evas_Coord x, y, w, h;
13072 } anchor, /**< Geometry selection of text used as anchor */
13073 hover_parent; /**< Geometry of the object used as parent by the
13075 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
13076 for content on the left side of
13077 the hover. Before calling the
13078 callback, the widget will make the
13079 necessary calculations to check
13080 which sides are fit to be set with
13081 content, based on the position the
13082 hover is activated and its distance
13083 to the edges of its parent object
13085 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
13086 the right side of the hover.
13087 See @ref hover_left */
13088 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
13089 of the hover. See @ref hover_left */
13090 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
13091 below the hover. See @ref
13096 * Add a new Anchorblock object
13098 * @param parent The parent object
13099 * @return The new object or NULL if it cannot be created
13101 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13104 * Set the text to show in the anchorblock
13106 * Sets the text of the anchorblock to @p text. This text can include markup
13107 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
13108 * of text that will be specially styled and react to click events, ended
13109 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
13110 * "anchor,clicked" signal that you can attach a callback to with
13111 * evas_object_smart_callback_add(). The name of the anchor given in the
13112 * event info struct will be the one set in the href attribute, in this
13113 * case, anchorname.
13115 * Other markup can be used to style the text in different ways, but it's
13116 * up to the style defined in the theme which tags do what.
13117 * @deprecated use elm_object_text_set() instead.
13119 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
13122 * Get the markup text set for the anchorblock
13124 * Retrieves the text set on the anchorblock, with markup tags included.
13126 * @param obj The anchorblock object
13127 * @return The markup text set or @c NULL if nothing was set or an error
13129 * @deprecated use elm_object_text_set() instead.
13131 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13134 * Set the parent of the hover popup
13136 * Sets the parent object to use by the hover created by the anchorblock
13137 * when an anchor is clicked. See @ref Hover for more details on this.
13139 * @param obj The anchorblock object
13140 * @param parent The object to use as parent for the hover
13142 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13145 * Get the parent of the hover popup
13147 * Get the object used as parent for the hover created by the anchorblock
13148 * widget. See @ref Hover for more details on this.
13149 * If no parent is set, the same anchorblock object will be used.
13151 * @param obj The anchorblock object
13152 * @return The object used as parent for the hover, NULL if none is set.
13154 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13157 * Set the style that the hover should use
13159 * When creating the popup hover, anchorblock will request that it's
13160 * themed according to @p style.
13162 * @param obj The anchorblock object
13163 * @param style The style to use for the underlying hover
13165 * @see elm_object_style_set()
13167 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13170 * Get the style that the hover should use
13172 * Get the style, the hover created by anchorblock will use.
13174 * @param obj The anchorblock object
13175 * @return The style to use by the hover. NULL means the default is used.
13177 * @see elm_object_style_set()
13179 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13182 * Ends the hover popup in the anchorblock
13184 * When an anchor is clicked, the anchorblock widget will create a hover
13185 * object to use as a popup with user provided content. This function
13186 * terminates this popup, returning the anchorblock to its normal state.
13188 * @param obj The anchorblock object
13190 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13193 * Appends a custom item provider to the given anchorblock
13195 * Appends the given function to the list of items providers. This list is
13196 * called, one function at a time, with the given @p data pointer, the
13197 * anchorblock object and, in the @p item parameter, the item name as
13198 * referenced in its href string. Following functions in the list will be
13199 * called in order until one of them returns something different to NULL,
13200 * which should be an Evas_Object which will be used in place of the item
13203 * Items in the markup text take the form \<item relsize=16x16 vsize=full
13204 * href=item/name\>\</item\>
13206 * @param obj The anchorblock object
13207 * @param func The function to add to the list of providers
13208 * @param data User data that will be passed to the callback function
13210 * @see elm_entry_item_provider_append()
13212 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);
13215 * Prepend a custom item provider to the given anchorblock
13217 * Like elm_anchorblock_item_provider_append(), but it adds the function
13218 * @p func to the beginning of the list, instead of the end.
13220 * @param obj The anchorblock object
13221 * @param func The function to add to the list of providers
13222 * @param data User data that will be passed to the callback function
13224 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);
13227 * Remove a custom item provider from the list of the given anchorblock
13229 * Removes the function and data pairing that matches @p func and @p data.
13230 * That is, unless the same function and same user data are given, the
13231 * function will not be removed from the list. This allows us to add the
13232 * same callback several times, with different @p data pointers and be
13233 * able to remove them later without conflicts.
13235 * @param obj The anchorblock object
13236 * @param func The function to remove from the list
13237 * @param data The data matching the function to remove from the list
13239 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);
13246 * @defgroup Bubble Bubble
13248 * @image html img/widget/bubble/preview-00.png
13249 * @image latex img/widget/bubble/preview-00.eps
13250 * @image html img/widget/bubble/preview-01.png
13251 * @image latex img/widget/bubble/preview-01.eps
13252 * @image html img/widget/bubble/preview-02.png
13253 * @image latex img/widget/bubble/preview-02.eps
13255 * @brief The Bubble is a widget to show text similar to how speech is
13256 * represented in comics.
13258 * The bubble widget contains 5 important visual elements:
13259 * @li The frame is a rectangle with rounded edjes and an "arrow".
13260 * @li The @p icon is an image to which the frame's arrow points to.
13261 * @li The @p label is a text which appears to the right of the icon if the
13262 * corner is "top_left" or "bottom_left" and is right aligned to the frame
13264 * @li The @p info is a text which appears to the right of the label. Info's
13265 * font is of a ligther color than label.
13266 * @li The @p content is an evas object that is shown inside the frame.
13268 * The position of the arrow, icon, label and info depends on which corner is
13269 * selected. The four available corners are:
13270 * @li "top_left" - Default
13272 * @li "bottom_left"
13273 * @li "bottom_right"
13275 * Signals that you can add callbacks for are:
13276 * @li "clicked" - This is called when a user has clicked the bubble.
13278 * Default contents parts of the bubble that you can use for are:
13279 * @li "default" - A content of the bubble
13280 * @li "icon" - An icon of the bubble
13282 * Default text parts of the button widget that you can use for are:
13283 * @li NULL - Label of the bubble
13285 * For an example of using a buble see @ref bubble_01_example_page "this".
13291 * Add a new bubble to the parent
13293 * @param parent The parent object
13294 * @return The new object or NULL if it cannot be created
13296 * This function adds a text bubble to the given parent evas object.
13298 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13301 * Set the label of the bubble
13303 * @param obj The bubble object
13304 * @param label The string to set in the label
13306 * This function sets the title of the bubble. Where this appears depends on
13307 * the selected corner.
13308 * @deprecated use elm_object_text_set() instead.
13310 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13313 * Get the label of the bubble
13315 * @param obj The bubble object
13316 * @return The string of set in the label
13318 * This function gets the title of the bubble.
13319 * @deprecated use elm_object_text_get() instead.
13321 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13324 * Set the info of the bubble
13326 * @param obj The bubble object
13327 * @param info The given info about the bubble
13329 * This function sets the info of the bubble. Where this appears depends on
13330 * the selected corner.
13331 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
13333 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
13336 * Get the info of the bubble
13338 * @param obj The bubble object
13340 * @return The "info" string of the bubble
13342 * This function gets the info text.
13343 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
13345 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13348 * Set the content to be shown in the bubble
13350 * Once the content object is set, a previously set one will be deleted.
13351 * If you want to keep the old content object, use the
13352 * elm_bubble_content_unset() function.
13354 * @param obj The bubble object
13355 * @param content The given content of the bubble
13357 * This function sets the content shown on the middle of the bubble.
13359 * @deprecated use elm_object_content_set() instead
13362 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13365 * Get the content shown in the bubble
13367 * Return the content object which is set for this widget.
13369 * @param obj The bubble object
13370 * @return The content that is being used
13372 * @deprecated use elm_object_content_get() instead
13375 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13378 * Unset the content shown in the bubble
13380 * Unparent and return the content object which was set for this widget.
13382 * @param obj The bubble object
13383 * @return The content that was being used
13385 * @deprecated use elm_object_content_unset() instead
13388 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13391 * Set the icon of the bubble
13393 * Once the icon object is set, a previously set one will be deleted.
13394 * If you want to keep the old content object, use the
13395 * elm_icon_content_unset() function.
13397 * @param obj The bubble object
13398 * @param icon The given icon for the bubble
13400 * @deprecated use elm_object_part_content_set() instead
13403 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13406 * Get the icon of the bubble
13408 * @param obj The bubble object
13409 * @return The icon for the bubble
13411 * This function gets the icon shown on the top left of bubble.
13413 * @deprecated use elm_object_part_content_get() instead
13416 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13419 * Unset the icon of the bubble
13421 * Unparent and return the icon object which was set for this widget.
13423 * @param obj The bubble object
13424 * @return The icon that was being used
13426 * @deprecated use elm_object_part_content_unset() instead
13429 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13432 * Set the corner of the bubble
13434 * @param obj The bubble object.
13435 * @param corner The given corner for the bubble.
13437 * This function sets the corner of the bubble. The corner will be used to
13438 * determine where the arrow in the frame points to and where label, icon and
13441 * Possible values for corner are:
13442 * @li "top_left" - Default
13444 * @li "bottom_left"
13445 * @li "bottom_right"
13447 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
13450 * Get the corner of the bubble
13452 * @param obj The bubble object.
13453 * @return The given corner for the bubble.
13455 * This function gets the selected corner of the bubble.
13457 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13464 * @defgroup Photo Photo
13466 * For displaying the photo of a person (contact). Simple, yet
13467 * with a very specific purpose.
13469 * Signals that you can add callbacks for are:
13471 * "clicked" - This is called when a user has clicked the photo
13472 * "drag,start" - Someone started dragging the image out of the object
13473 * "drag,end" - Dragged item was dropped (somewhere)
13479 * Add a new photo to the parent
13481 * @param parent The parent object
13482 * @return The new object or NULL if it cannot be created
13486 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13489 * Set the file that will be used as photo
13491 * @param obj The photo object
13492 * @param file The path to file that will be used as photo
13494 * @return (1 = success, 0 = error)
13498 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13501 * Set the file that will be used as thumbnail in the photo.
13503 * @param obj The photo object.
13504 * @param file The path to file that will be used as thumb.
13505 * @param group The key used in case of an EET file.
13509 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13512 * Set the size that will be used on the photo
13514 * @param obj The photo object
13515 * @param size The size that the photo will be
13519 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13522 * Set if the photo should be completely visible or not.
13524 * @param obj The photo object
13525 * @param fill if true the photo will be completely visible
13529 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13532 * Set editability of the photo.
13534 * An editable photo can be dragged to or from, and can be cut or
13535 * pasted too. Note that pasting an image or dropping an item on
13536 * the image will delete the existing content.
13538 * @param obj The photo object.
13539 * @param set To set of clear editablity.
13541 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13547 /* gesture layer */
13549 * @defgroup Elm_Gesture_Layer Gesture Layer
13550 * Gesture Layer Usage:
13552 * Use Gesture Layer to detect gestures.
13553 * The advantage is that you don't have to implement
13554 * gesture detection, just set callbacks of gesture state.
13555 * By using gesture layer we make standard interface.
13557 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13558 * with a parent object parameter.
13559 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13560 * call. Usually with same object as target (2nd parameter).
13562 * Now you need to tell gesture layer what gestures you follow.
13563 * This is done with @ref elm_gesture_layer_cb_set call.
13564 * By setting the callback you actually saying to gesture layer:
13565 * I would like to know when the gesture @ref Elm_Gesture_Types
13566 * switches to state @ref Elm_Gesture_State.
13568 * Next, you need to implement the actual action that follows the input
13569 * in your callback.
13571 * Note that if you like to stop being reported about a gesture, just set
13572 * all callbacks referring this gesture to NULL.
13573 * (again with @ref elm_gesture_layer_cb_set)
13575 * The information reported by gesture layer to your callback is depending
13576 * on @ref Elm_Gesture_Types:
13577 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13578 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13579 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13581 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13582 * @ref ELM_GESTURE_MOMENTUM.
13584 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13585 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13586 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13587 * Note that we consider a flick as a line-gesture that should be completed
13588 * in flick-time-limit as defined in @ref Config.
13590 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13592 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13595 * Gesture Layer Tweaks:
13597 * Note that line, flick, gestures can start without the need to remove fingers from surface.
13598 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13600 * Setting glayer_continues_enable to false in @ref Config will change this behavior
13601 * so gesture starts when user touches (a *DOWN event) touch-surface
13602 * and ends when no fingers touches surface (a *UP event).
13606 * @enum _Elm_Gesture_Types
13607 * Enum of supported gesture types.
13608 * @ingroup Elm_Gesture_Layer
13610 enum _Elm_Gesture_Types
13612 ELM_GESTURE_FIRST = 0,
13614 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13615 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13616 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13617 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13619 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13621 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13622 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13624 ELM_GESTURE_ZOOM, /**< Zoom */
13625 ELM_GESTURE_ROTATE, /**< Rotate */
13631 * @typedef Elm_Gesture_Types
13632 * gesture types enum
13633 * @ingroup Elm_Gesture_Layer
13635 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13638 * @enum _Elm_Gesture_State
13639 * Enum of gesture states.
13640 * @ingroup Elm_Gesture_Layer
13642 enum _Elm_Gesture_State
13644 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13645 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
13646 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
13647 ELM_GESTURE_STATE_END, /**< Gesture completed */
13648 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
13652 * @typedef Elm_Gesture_State
13653 * gesture states enum
13654 * @ingroup Elm_Gesture_Layer
13656 typedef enum _Elm_Gesture_State Elm_Gesture_State;
13659 * @struct _Elm_Gesture_Taps_Info
13660 * Struct holds taps info for user
13661 * @ingroup Elm_Gesture_Layer
13663 struct _Elm_Gesture_Taps_Info
13665 Evas_Coord x, y; /**< Holds center point between fingers */
13666 unsigned int n; /**< Number of fingers tapped */
13667 unsigned int timestamp; /**< event timestamp */
13671 * @typedef Elm_Gesture_Taps_Info
13672 * holds taps info for user
13673 * @ingroup Elm_Gesture_Layer
13675 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13678 * @struct _Elm_Gesture_Momentum_Info
13679 * Struct holds momentum info for user
13680 * x1 and y1 are not necessarily in sync
13681 * x1 holds x value of x direction starting point
13682 * and same holds for y1.
13683 * This is noticeable when doing V-shape movement
13684 * @ingroup Elm_Gesture_Layer
13686 struct _Elm_Gesture_Momentum_Info
13687 { /* Report line ends, timestamps, and momentum computed */
13688 Evas_Coord x1; /**< Final-swipe direction starting point on X */
13689 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13690 Evas_Coord x2; /**< Final-swipe direction ending point on X */
13691 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
13693 unsigned int tx; /**< Timestamp of start of final x-swipe */
13694 unsigned int ty; /**< Timestamp of start of final y-swipe */
13696 Evas_Coord mx; /**< Momentum on X */
13697 Evas_Coord my; /**< Momentum on Y */
13699 unsigned int n; /**< Number of fingers */
13703 * @typedef Elm_Gesture_Momentum_Info
13704 * holds momentum info for user
13705 * @ingroup Elm_Gesture_Layer
13707 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13710 * @struct _Elm_Gesture_Line_Info
13711 * Struct holds line info for user
13712 * @ingroup Elm_Gesture_Layer
13714 struct _Elm_Gesture_Line_Info
13715 { /* Report line ends, timestamps, and momentum computed */
13716 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13717 double angle; /**< Angle (direction) of lines */
13721 * @typedef Elm_Gesture_Line_Info
13722 * Holds line info for user
13723 * @ingroup Elm_Gesture_Layer
13725 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13728 * @struct _Elm_Gesture_Zoom_Info
13729 * Struct holds zoom info for user
13730 * @ingroup Elm_Gesture_Layer
13732 struct _Elm_Gesture_Zoom_Info
13734 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13735 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13736 double zoom; /**< Zoom value: 1.0 means no zoom */
13737 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13741 * @typedef Elm_Gesture_Zoom_Info
13742 * Holds zoom info for user
13743 * @ingroup Elm_Gesture_Layer
13745 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13748 * @struct _Elm_Gesture_Rotate_Info
13749 * Struct holds rotation info for user
13750 * @ingroup Elm_Gesture_Layer
13752 struct _Elm_Gesture_Rotate_Info
13754 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13755 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13756 double base_angle; /**< Holds start-angle */
13757 double angle; /**< Rotation value: 0.0 means no rotation */
13758 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13762 * @typedef Elm_Gesture_Rotate_Info
13763 * Holds rotation info for user
13764 * @ingroup Elm_Gesture_Layer
13766 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13769 * @typedef Elm_Gesture_Event_Cb
13770 * User callback used to stream gesture info from gesture layer
13771 * @param data user data
13772 * @param event_info gesture report info
13773 * Returns a flag field to be applied on the causing event.
13774 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13775 * upon the event, in an irreversible way.
13777 * @ingroup Elm_Gesture_Layer
13779 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13782 * Use function to set callbacks to be notified about
13783 * change of state of gesture.
13784 * When a user registers a callback with this function
13785 * this means this gesture has to be tested.
13787 * When ALL callbacks for a gesture are set to NULL
13788 * it means user isn't interested in gesture-state
13789 * and it will not be tested.
13791 * @param obj Pointer to gesture-layer.
13792 * @param idx The gesture you would like to track its state.
13793 * @param cb callback function pointer.
13794 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13795 * @param data user info to be sent to callback (usually, Smart Data)
13797 * @ingroup Elm_Gesture_Layer
13799 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);
13802 * Call this function to get repeat-events settings.
13804 * @param obj Pointer to gesture-layer.
13806 * @return repeat events settings.
13807 * @see elm_gesture_layer_hold_events_set()
13808 * @ingroup Elm_Gesture_Layer
13810 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13813 * This function called in order to make gesture-layer repeat events.
13814 * Set this of you like to get the raw events only if gestures were not detected.
13815 * Clear this if you like gesture layer to fwd events as testing gestures.
13817 * @param obj Pointer to gesture-layer.
13818 * @param r Repeat: TRUE/FALSE
13820 * @ingroup Elm_Gesture_Layer
13822 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13825 * This function sets step-value for zoom action.
13826 * Set step to any positive value.
13827 * Cancel step setting by setting to 0.0
13829 * @param obj Pointer to gesture-layer.
13830 * @param s new zoom step value.
13832 * @ingroup Elm_Gesture_Layer
13834 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13837 * This function sets step-value for rotate action.
13838 * Set step to any positive value.
13839 * Cancel step setting by setting to 0.0
13841 * @param obj Pointer to gesture-layer.
13842 * @param s new roatate step value.
13844 * @ingroup Elm_Gesture_Layer
13846 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13849 * This function called to attach gesture-layer to an Evas_Object.
13850 * @param obj Pointer to gesture-layer.
13851 * @param t Pointer to underlying object (AKA Target)
13853 * @return TRUE, FALSE on success, failure.
13855 * @ingroup Elm_Gesture_Layer
13857 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13860 * Call this function to construct a new gesture-layer object.
13861 * This does not activate the gesture layer. You have to
13862 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13864 * @param parent the parent object.
13866 * @return Pointer to new gesture-layer object.
13868 * @ingroup Elm_Gesture_Layer
13870 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13873 * @defgroup Thumb Thumb
13875 * @image html img/widget/thumb/preview-00.png
13876 * @image latex img/widget/thumb/preview-00.eps
13878 * A thumb object is used for displaying the thumbnail of an image or video.
13879 * You must have compiled Elementary with Ethumb_Client support and the DBus
13880 * service must be present and auto-activated in order to have thumbnails to
13883 * Once the thumbnail object becomes visible, it will check if there is a
13884 * previously generated thumbnail image for the file set on it. If not, it
13885 * will start generating this thumbnail.
13887 * Different config settings will cause different thumbnails to be generated
13888 * even on the same file.
13890 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13891 * Ethumb documentation to change this path, and to see other configuration
13894 * Signals that you can add callbacks for are:
13896 * - "clicked" - This is called when a user has clicked the thumb without dragging
13898 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13899 * - "press" - This is called when a user has pressed down the thumb.
13900 * - "generate,start" - The thumbnail generation started.
13901 * - "generate,stop" - The generation process stopped.
13902 * - "generate,error" - The generation failed.
13903 * - "load,error" - The thumbnail image loading failed.
13905 * available styles:
13909 * An example of use of thumbnail:
13911 * - @ref thumb_example_01
13915 * @addtogroup Thumb
13920 * @enum _Elm_Thumb_Animation_Setting
13921 * @typedef Elm_Thumb_Animation_Setting
13923 * Used to set if a video thumbnail is animating or not.
13927 typedef enum _Elm_Thumb_Animation_Setting
13929 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13930 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13931 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13932 ELM_THUMB_ANIMATION_LAST
13933 } Elm_Thumb_Animation_Setting;
13936 * Add a new thumb object to the parent.
13938 * @param parent The parent object.
13939 * @return The new object or NULL if it cannot be created.
13941 * @see elm_thumb_file_set()
13942 * @see elm_thumb_ethumb_client_get()
13946 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13949 * Reload thumbnail if it was generated before.
13951 * @param obj The thumb object to reload
13953 * This is useful if the ethumb client configuration changed, like its
13954 * size, aspect or any other property one set in the handle returned
13955 * by elm_thumb_ethumb_client_get().
13957 * If the options didn't change, the thumbnail won't be generated again, but
13958 * the old one will still be used.
13960 * @see elm_thumb_file_set()
13964 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13967 * Set the file that will be used as thumbnail.
13969 * @param obj The thumb object.
13970 * @param file The path to file that will be used as thumb.
13971 * @param key The key used in case of an EET file.
13973 * The file can be an image or a video (in that case, acceptable extensions are:
13974 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13975 * function elm_thumb_animate().
13977 * @see elm_thumb_file_get()
13978 * @see elm_thumb_reload()
13979 * @see elm_thumb_animate()
13983 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13986 * Get the image or video path and key used to generate the thumbnail.
13988 * @param obj The thumb object.
13989 * @param file Pointer to filename.
13990 * @param key Pointer to key.
13992 * @see elm_thumb_file_set()
13993 * @see elm_thumb_path_get()
13997 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14000 * Get the path and key to the image or video generated by ethumb.
14002 * One just need to make sure that the thumbnail was generated before getting
14003 * its path; otherwise, the path will be NULL. One way to do that is by asking
14004 * for the path when/after the "generate,stop" smart callback is called.
14006 * @param obj The thumb object.
14007 * @param file Pointer to thumb path.
14008 * @param key Pointer to thumb key.
14010 * @see elm_thumb_file_get()
14014 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14017 * Set the animation state for the thumb object. If its content is an animated
14018 * video, you may start/stop the animation or tell it to play continuously and
14021 * @param obj The thumb object.
14022 * @param setting The animation setting.
14024 * @see elm_thumb_file_set()
14028 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
14031 * Get the animation state for the thumb object.
14033 * @param obj The thumb object.
14034 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
14037 * @see elm_thumb_animate_set()
14041 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14044 * Get the ethumb_client handle so custom configuration can be made.
14046 * @return Ethumb_Client instance or NULL.
14048 * This must be called before the objects are created to be sure no object is
14049 * visible and no generation started.
14051 * Example of usage:
14054 * #include <Elementary.h>
14055 * #ifndef ELM_LIB_QUICKLAUNCH
14057 * elm_main(int argc, char **argv)
14059 * Ethumb_Client *client;
14061 * elm_need_ethumb();
14065 * client = elm_thumb_ethumb_client_get();
14068 * ERR("could not get ethumb_client");
14071 * ethumb_client_size_set(client, 100, 100);
14072 * ethumb_client_crop_align_set(client, 0.5, 0.5);
14075 * // Create elm_thumb objects here
14085 * @note There's only one client handle for Ethumb, so once a configuration
14086 * change is done to it, any other request for thumbnails (for any thumbnail
14087 * object) will use that configuration. Thus, this configuration is global.
14091 EAPI void *elm_thumb_ethumb_client_get(void);
14094 * Get the ethumb_client connection state.
14096 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
14099 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
14102 * Make the thumbnail 'editable'.
14104 * @param obj Thumb object.
14105 * @param set Turn on or off editability. Default is @c EINA_FALSE.
14107 * This means the thumbnail is a valid drag target for drag and drop, and can be
14108 * cut or pasted too.
14110 * @see elm_thumb_editable_get()
14114 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
14117 * Make the thumbnail 'editable'.
14119 * @param obj Thumb object.
14120 * @return Editability.
14122 * This means the thumbnail is a valid drag target for drag and drop, and can be
14123 * cut or pasted too.
14125 * @see elm_thumb_editable_set()
14129 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14136 * @defgroup Web Web
14138 * @image html img/widget/web/preview-00.png
14139 * @image latex img/widget/web/preview-00.eps
14141 * A web object is used for displaying web pages (HTML/CSS/JS)
14142 * using WebKit-EFL. You must have compiled Elementary with
14145 * Signals that you can add callbacks for are:
14146 * @li "download,request": A file download has been requested. Event info is
14147 * a pointer to a Elm_Web_Download
14148 * @li "editorclient,contents,changed": Editor client's contents changed
14149 * @li "editorclient,selection,changed": Editor client's selection changed
14150 * @li "frame,created": A new frame was created. Event info is an
14151 * Evas_Object which can be handled with WebKit's ewk_frame API
14152 * @li "icon,received": An icon was received by the main frame
14153 * @li "inputmethod,changed": Input method changed. Event info is an
14154 * Eina_Bool indicating whether it's enabled or not
14155 * @li "js,windowobject,clear": JS window object has been cleared
14156 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
14157 * is a char *link[2], where the first string contains the URL the link
14158 * points to, and the second one the title of the link
14159 * @li "link,hover,out": Mouse cursor left the link
14160 * @li "load,document,finished": Loading of a document finished. Event info
14161 * is the frame that finished loading
14162 * @li "load,error": Load failed. Event info is a pointer to
14163 * Elm_Web_Frame_Load_Error
14164 * @li "load,finished": Load finished. Event info is NULL on success, on
14165 * error it's a pointer to Elm_Web_Frame_Load_Error
14166 * @li "load,newwindow,show": A new window was created and is ready to be
14168 * @li "load,progress": Overall load progress. Event info is a pointer to
14169 * a double containing a value between 0.0 and 1.0
14170 * @li "load,provisional": Started provisional load
14171 * @li "load,started": Loading of a document started
14172 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
14173 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
14174 * the menubar is visible, or EINA_FALSE in case it's not
14175 * @li "menubar,visible,set": Informs menubar visibility. Event info is
14176 * an Eina_Bool indicating the visibility
14177 * @li "popup,created": A dropdown widget was activated, requesting its
14178 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
14179 * @li "popup,willdelete": The web object is ready to destroy the popup
14180 * object created. Event info is a pointer to Elm_Web_Menu
14181 * @li "ready": Page is fully loaded
14182 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
14183 * info is a pointer to Eina_Bool where the visibility state should be set
14184 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
14185 * is an Eina_Bool with the visibility state set
14186 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
14187 * a string with the new text
14188 * @li "statusbar,visible,get": Queries visibility of the status bar.
14189 * Event info is a pointer to Eina_Bool where the visibility state should be
14191 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
14192 * an Eina_Bool with the visibility value
14193 * @li "title,changed": Title of the main frame changed. Event info is a
14194 * string with the new title
14195 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
14196 * is a pointer to Eina_Bool where the visibility state should be set
14197 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
14198 * info is an Eina_Bool with the visibility state
14199 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
14200 * a string with the text to show
14201 * @li "uri,changed": URI of the main frame changed. Event info is a string
14203 * @li "view,resized": The web object internal's view changed sized
14204 * @li "windows,close,request": A JavaScript request to close the current
14205 * window was requested
14206 * @li "zoom,animated,end": Animated zoom finished
14208 * available styles:
14211 * An example of use of web:
14213 * - @ref web_example_01 TBD
14222 * Structure used to report load errors.
14224 * Load errors are reported as signal by elm_web. All the strings are
14225 * temporary references and should @b not be used after the signal
14226 * callback returns. If it's required, make copies with strdup() or
14227 * eina_stringshare_add() (they are not even guaranteed to be
14228 * stringshared, so must use eina_stringshare_add() and not
14229 * eina_stringshare_ref()).
14231 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
14234 * Structure used to report load errors.
14236 * Load errors are reported as signal by elm_web. All the strings are
14237 * temporary references and should @b not be used after the signal
14238 * callback returns. If it's required, make copies with strdup() or
14239 * eina_stringshare_add() (they are not even guaranteed to be
14240 * stringshared, so must use eina_stringshare_add() and not
14241 * eina_stringshare_ref()).
14243 struct _Elm_Web_Frame_Load_Error
14245 int code; /**< Numeric error code */
14246 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
14247 const char *domain; /**< Error domain name */
14248 const char *description; /**< Error description (already localized) */
14249 const char *failing_url; /**< The URL that failed to load */
14250 Evas_Object *frame; /**< Frame object that produced the error */
14254 * The possibles types that the items in a menu can be
14256 typedef enum _Elm_Web_Menu_Item_Type
14258 ELM_WEB_MENU_SEPARATOR,
14259 ELM_WEB_MENU_GROUP,
14260 ELM_WEB_MENU_OPTION
14261 } Elm_Web_Menu_Item_Type;
14264 * Structure describing the items in a menu
14266 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
14269 * Structure describing the items in a menu
14271 struct _Elm_Web_Menu_Item
14273 const char *text; /**< The text for the item */
14274 Elm_Web_Menu_Item_Type type; /**< The type of the item */
14278 * Structure describing the menu of a popup
14280 * This structure will be passed as the @c event_info for the "popup,create"
14281 * signal, which is emitted when a dropdown menu is opened. Users wanting
14282 * to handle these popups by themselves should listen to this signal and
14283 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14284 * property as @c EINA_FALSE means that the user will not handle the popup
14285 * and the default implementation will be used.
14287 * When the popup is ready to be dismissed, a "popup,willdelete" signal
14288 * will be emitted to notify the user that it can destroy any objects and
14289 * free all data related to it.
14291 * @see elm_web_popup_selected_set()
14292 * @see elm_web_popup_destroy()
14294 typedef struct _Elm_Web_Menu Elm_Web_Menu;
14297 * Structure describing the menu of a popup
14299 * This structure will be passed as the @c event_info for the "popup,create"
14300 * signal, which is emitted when a dropdown menu is opened. Users wanting
14301 * to handle these popups by themselves should listen to this signal and
14302 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14303 * property as @c EINA_FALSE means that the user will not handle the popup
14304 * and the default implementation will be used.
14306 * When the popup is ready to be dismissed, a "popup,willdelete" signal
14307 * will be emitted to notify the user that it can destroy any objects and
14308 * free all data related to it.
14310 * @see elm_web_popup_selected_set()
14311 * @see elm_web_popup_destroy()
14313 struct _Elm_Web_Menu
14315 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
14316 int x; /**< The X position of the popup, relative to the elm_web object */
14317 int y; /**< The Y position of the popup, relative to the elm_web object */
14318 int width; /**< Width of the popup menu */
14319 int height; /**< Height of the popup menu */
14321 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. */
14324 typedef struct _Elm_Web_Download Elm_Web_Download;
14325 struct _Elm_Web_Download
14331 * Types of zoom available.
14333 typedef enum _Elm_Web_Zoom_Mode
14335 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
14336 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
14337 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
14338 ELM_WEB_ZOOM_MODE_LAST
14339 } Elm_Web_Zoom_Mode;
14342 * Opaque handler containing the features (such as statusbar, menubar, etc)
14343 * that are to be set on a newly requested window.
14345 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
14348 * Callback type for the create_window hook.
14350 * The function parameters are:
14351 * @li @p data User data pointer set when setting the hook function
14352 * @li @p obj The elm_web object requesting the new window
14353 * @li @p js Set to @c EINA_TRUE if the request was originated from
14354 * JavaScript. @c EINA_FALSE otherwise.
14355 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
14356 * the features requested for the new window.
14358 * The returned value of the function should be the @c elm_web widget where
14359 * the request will be loaded. That is, if a new window or tab is created,
14360 * the elm_web widget in it should be returned, and @b NOT the window
14362 * Returning @c NULL should cancel the request.
14364 * @see elm_web_window_create_hook_set()
14366 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
14369 * Callback type for the JS alert hook.
14371 * The function parameters are:
14372 * @li @p data User data pointer set when setting the hook function
14373 * @li @p obj The elm_web object requesting the new window
14374 * @li @p message The message to show in the alert dialog
14376 * The function should return the object representing the alert dialog.
14377 * Elm_Web will run a second main loop to handle the dialog and normal
14378 * flow of the application will be restored when the object is deleted, so
14379 * the user should handle the popup properly in order to delete the object
14380 * when the action is finished.
14381 * If the function returns @c NULL the popup will be ignored.
14383 * @see elm_web_dialog_alert_hook_set()
14385 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
14388 * Callback type for the JS confirm hook.
14390 * The function parameters are:
14391 * @li @p data User data pointer set when setting the hook function
14392 * @li @p obj The elm_web object requesting the new window
14393 * @li @p message The message to show in the confirm dialog
14394 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14395 * the user selected @c Ok, @c EINA_FALSE otherwise.
14397 * The function should return the object representing the confirm dialog.
14398 * Elm_Web will run a second main loop to handle the dialog and normal
14399 * flow of the application will be restored when the object is deleted, so
14400 * the user should handle the popup properly in order to delete the object
14401 * when the action is finished.
14402 * If the function returns @c NULL the popup will be ignored.
14404 * @see elm_web_dialog_confirm_hook_set()
14406 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
14409 * Callback type for the JS prompt hook.
14411 * The function parameters are:
14412 * @li @p data User data pointer set when setting the hook function
14413 * @li @p obj The elm_web object requesting the new window
14414 * @li @p message The message to show in the prompt dialog
14415 * @li @p def_value The default value to present the user in the entry
14416 * @li @p value Pointer where to store the value given by the user. Must
14417 * be a malloc'ed string or @c NULL if the user cancelled the popup.
14418 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14419 * the user selected @c Ok, @c EINA_FALSE otherwise.
14421 * The function should return the object representing the prompt dialog.
14422 * Elm_Web will run a second main loop to handle the dialog and normal
14423 * flow of the application will be restored when the object is deleted, so
14424 * the user should handle the popup properly in order to delete the object
14425 * when the action is finished.
14426 * If the function returns @c NULL the popup will be ignored.
14428 * @see elm_web_dialog_prompt_hook_set()
14430 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
14433 * Callback type for the JS file selector hook.
14435 * The function parameters are:
14436 * @li @p data User data pointer set when setting the hook function
14437 * @li @p obj The elm_web object requesting the new window
14438 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
14439 * @li @p accept_types Mime types accepted
14440 * @li @p selected Pointer where to store the list of malloc'ed strings
14441 * containing the path to each file selected. Must be @c NULL if the file
14442 * dialog is cancelled
14443 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14444 * the user selected @c Ok, @c EINA_FALSE otherwise.
14446 * The function should return the object representing the file selector
14448 * Elm_Web will run a second main loop to handle the dialog and normal
14449 * flow of the application will be restored when the object is deleted, so
14450 * the user should handle the popup properly in order to delete the object
14451 * when the action is finished.
14452 * If the function returns @c NULL the popup will be ignored.
14454 * @see elm_web_dialog_file selector_hook_set()
14456 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);
14459 * Callback type for the JS console message hook.
14461 * When a console message is added from JavaScript, any set function to the
14462 * console message hook will be called for the user to handle. There is no
14463 * default implementation of this hook.
14465 * The function parameters are:
14466 * @li @p data User data pointer set when setting the hook function
14467 * @li @p obj The elm_web object that originated the message
14468 * @li @p message The message sent
14469 * @li @p line_number The line number
14470 * @li @p source_id Source id
14472 * @see elm_web_console_message_hook_set()
14474 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
14477 * Add a new web object to the parent.
14479 * @param parent The parent object.
14480 * @return The new object or NULL if it cannot be created.
14482 * @see elm_web_uri_set()
14483 * @see elm_web_webkit_view_get()
14485 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14488 * Get internal ewk_view object from web object.
14490 * Elementary may not provide some low level features of EWebKit,
14491 * instead of cluttering the API with proxy methods we opted to
14492 * return the internal reference. Be careful using it as it may
14493 * interfere with elm_web behavior.
14495 * @param obj The web object.
14496 * @return The internal ewk_view object or NULL if it does not
14497 * exist. (Failure to create or Elementary compiled without
14500 * @see elm_web_add()
14502 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14505 * Sets the function to call when a new window is requested
14507 * This hook will be called when a request to create a new window is
14508 * issued from the web page loaded.
14509 * There is no default implementation for this feature, so leaving this
14510 * unset or passing @c NULL in @p func will prevent new windows from
14513 * @param obj The web object where to set the hook function
14514 * @param func The hook function to be called when a window is requested
14515 * @param data User data
14517 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14520 * Sets the function to call when an alert dialog
14522 * This hook will be called when a JavaScript alert dialog is requested.
14523 * If no function is set or @c NULL is passed in @p func, the default
14524 * implementation will take place.
14526 * @param obj The web object where to set the hook function
14527 * @param func The callback function to be used
14528 * @param data User data
14530 * @see elm_web_inwin_mode_set()
14532 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14535 * Sets the function to call when an confirm dialog
14537 * This hook will be called when a JavaScript confirm dialog is requested.
14538 * If no function is set or @c NULL is passed in @p func, the default
14539 * implementation will take place.
14541 * @param obj The web object where to set the hook function
14542 * @param func The callback function to be used
14543 * @param data User data
14545 * @see elm_web_inwin_mode_set()
14547 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14550 * Sets the function to call when an prompt dialog
14552 * This hook will be called when a JavaScript prompt dialog is requested.
14553 * If no function is set or @c NULL is passed in @p func, the default
14554 * implementation will take place.
14556 * @param obj The web object where to set the hook function
14557 * @param func The callback function to be used
14558 * @param data User data
14560 * @see elm_web_inwin_mode_set()
14562 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14565 * Sets the function to call when an file selector dialog
14567 * This hook will be called when a JavaScript file selector dialog is
14569 * If no function is set or @c NULL is passed in @p func, the default
14570 * implementation will take place.
14572 * @param obj The web object where to set the hook function
14573 * @param func The callback function to be used
14574 * @param data User data
14576 * @see elm_web_inwin_mode_set()
14578 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14581 * Sets the function to call when a console message is emitted from JS
14583 * This hook will be called when a console message is emitted from
14584 * JavaScript. There is no default implementation for this feature.
14586 * @param obj The web object where to set the hook function
14587 * @param func The callback function to be used
14588 * @param data User data
14590 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14593 * Gets the status of the tab propagation
14595 * @param obj The web object to query
14596 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14598 * @see elm_web_tab_propagate_set()
14600 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
14603 * Sets whether to use tab propagation
14605 * If tab propagation is enabled, whenever the user presses the Tab key,
14606 * Elementary will handle it and switch focus to the next widget.
14607 * The default value is disabled, where WebKit will handle the Tab key to
14608 * cycle focus though its internal objects, jumping to the next widget
14609 * only when that cycle ends.
14611 * @param obj The web object
14612 * @param propagate Whether to propagate Tab keys to Elementary or not
14614 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14617 * Sets the URI for the web object
14619 * It must be a full URI, with resource included, in the form
14620 * http://www.enlightenment.org or file:///tmp/something.html
14622 * @param obj The web object
14623 * @param uri The URI to set
14624 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14626 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
14629 * Gets the current URI for the object
14631 * The returned string must not be freed and is guaranteed to be
14634 * @param obj The web object
14635 * @return A stringshared internal string with the current URI, or NULL on
14638 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
14641 * Gets the current title
14643 * The returned string must not be freed and is guaranteed to be
14646 * @param obj The web object
14647 * @return A stringshared internal string with the current title, or NULL on
14650 EAPI const char *elm_web_title_get(const Evas_Object *obj);
14653 * Sets the background color to be used by the web object
14655 * This is the color that will be used by default when the loaded page
14656 * does not set it's own. Color values are pre-multiplied.
14658 * @param obj The web object
14659 * @param r Red component
14660 * @param g Green component
14661 * @param b Blue component
14662 * @param a Alpha component
14664 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14667 * Gets the background color to be used by the web object
14669 * This is the color that will be used by default when the loaded page
14670 * does not set it's own. Color values are pre-multiplied.
14672 * @param obj The web object
14673 * @param r Red component
14674 * @param g Green component
14675 * @param b Blue component
14676 * @param a Alpha component
14678 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14681 * Gets a copy of the currently selected text
14683 * The string returned must be freed by the user when it's done with it.
14685 * @param obj The web object
14686 * @return A newly allocated string, or NULL if nothing is selected or an
14689 EAPI char *elm_view_selection_get(const Evas_Object *obj);
14692 * Tells the web object which index in the currently open popup was selected
14694 * When the user handles the popup creation from the "popup,created" signal,
14695 * it needs to tell the web object which item was selected by calling this
14696 * function with the index corresponding to the item.
14698 * @param obj The web object
14699 * @param index The index selected
14701 * @see elm_web_popup_destroy()
14703 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
14706 * Dismisses an open dropdown popup
14708 * When the popup from a dropdown widget is to be dismissed, either after
14709 * selecting an option or to cancel it, this function must be called, which
14710 * will later emit an "popup,willdelete" signal to notify the user that
14711 * any memory and objects related to this popup can be freed.
14713 * @param obj The web object
14714 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14715 * if there was no menu to destroy
14717 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
14720 * Searches the given string in a document.
14722 * @param obj The web object where to search the text
14723 * @param string String to search
14724 * @param case_sensitive If search should be case sensitive or not
14725 * @param forward If search is from cursor and on or backwards
14726 * @param wrap If search should wrap at the end
14728 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14731 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14734 * Marks matches of the given string in a document.
14736 * @param obj The web object where to search text
14737 * @param string String to match
14738 * @param case_sensitive If match should be case sensitive or not
14739 * @param highlight If matches should be highlighted
14740 * @param limit Maximum amount of matches, or zero to unlimited
14742 * @return number of matched @a string
14744 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14747 * Clears all marked matches in the document
14749 * @param obj The web object
14751 * @return EINA_TRUE on success, EINA_FALSE otherwise
14753 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
14756 * Sets whether to highlight the matched marks
14758 * If enabled, marks set with elm_web_text_matches_mark() will be
14761 * @param obj The web object
14762 * @param highlight Whether to highlight the marks or not
14764 * @return EINA_TRUE on success, EINA_FALSE otherwise
14766 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14769 * Gets whether highlighting marks is enabled
14771 * @param The web object
14773 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14776 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
14779 * Gets the overall loading progress of the page
14781 * Returns the estimated loading progress of the page, with a value between
14782 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14783 * included in the page.
14785 * @param The web object
14787 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14790 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
14793 * Stops loading the current page
14795 * Cancels the loading of the current page in the web object. This will
14796 * cause a "load,error" signal to be emitted, with the is_cancellation
14797 * flag set to EINA_TRUE.
14799 * @param obj The web object
14801 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14803 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14806 * Requests a reload of the current document in the object
14808 * @param obj The web object
14810 * @return EINA_TRUE on success, EINA_FALSE otherwise
14812 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14815 * Requests a reload of the current document, avoiding any existing caches
14817 * @param obj The web object
14819 * @return EINA_TRUE on success, EINA_FALSE otherwise
14821 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14824 * Goes back one step in the browsing history
14826 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14828 * @param obj The web object
14830 * @return EINA_TRUE on success, EINA_FALSE otherwise
14832 * @see elm_web_history_enable_set()
14833 * @see elm_web_back_possible()
14834 * @see elm_web_forward()
14835 * @see elm_web_navigate()
14837 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14840 * Goes forward one step in the browsing history
14842 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14844 * @param obj The web object
14846 * @return EINA_TRUE on success, EINA_FALSE otherwise
14848 * @see elm_web_history_enable_set()
14849 * @see elm_web_forward_possible()
14850 * @see elm_web_back()
14851 * @see elm_web_navigate()
14853 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14856 * Jumps the given number of steps in the browsing history
14858 * The @p steps value can be a negative integer to back in history, or a
14859 * positive to move forward.
14861 * @param obj The web object
14862 * @param steps The number of steps to jump
14864 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14865 * history exists to jump the given number of steps
14867 * @see elm_web_history_enable_set()
14868 * @see elm_web_navigate_possible()
14869 * @see elm_web_back()
14870 * @see elm_web_forward()
14872 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14875 * Queries whether it's possible to go back in history
14877 * @param obj The web object
14879 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14882 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14885 * Queries whether it's possible to go forward in history
14887 * @param obj The web object
14889 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14892 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14895 * Queries whether it's possible to jump the given number of steps
14897 * The @p steps value can be a negative integer to back in history, or a
14898 * positive to move forward.
14900 * @param obj The web object
14901 * @param steps The number of steps to check for
14903 * @return EINA_TRUE if enough history exists to perform the given jump,
14904 * EINA_FALSE otherwise
14906 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14909 * Gets whether browsing history is enabled for the given object
14911 * @param obj The web object
14913 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14915 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14918 * Enables or disables the browsing history
14920 * @param obj The web object
14921 * @param enable Whether to enable or disable the browsing history
14923 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14926 * Sets the zoom level of the web object
14928 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14929 * values meaning zoom in and lower meaning zoom out. This function will
14930 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14931 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14933 * @param obj The web object
14934 * @param zoom The zoom level to set
14936 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14939 * Gets the current zoom level set on the web object
14941 * Note that this is the zoom level set on the web object and not that
14942 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14943 * the two zoom levels should match, but for the other two modes the
14944 * Webkit zoom is calculated internally to match the chosen mode without
14945 * changing the zoom level set for the web object.
14947 * @param obj The web object
14949 * @return The zoom level set on the object
14951 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14954 * Sets the zoom mode to use
14956 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14957 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14959 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14960 * with the elm_web_zoom_set() function.
14961 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14962 * make sure the entirety of the web object's contents are shown.
14963 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14964 * fit the contents in the web object's size, without leaving any space
14967 * @param obj The web object
14968 * @param mode The mode to set
14970 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14973 * Gets the currently set zoom mode
14975 * @param obj The web object
14977 * @return The current zoom mode set for the object, or
14978 * ::ELM_WEB_ZOOM_MODE_LAST on error
14980 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14983 * Shows the given region in the web object
14985 * @param obj The web object
14986 * @param x The x coordinate of the region to show
14987 * @param y The y coordinate of the region to show
14988 * @param w The width of the region to show
14989 * @param h The height of the region to show
14991 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14994 * Brings in the region to the visible area
14996 * Like elm_web_region_show(), but it animates the scrolling of the object
14999 * @param obj The web object
15000 * @param x The x coordinate of the region to show
15001 * @param y The y coordinate of the region to show
15002 * @param w The width of the region to show
15003 * @param h The height of the region to show
15005 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
15008 * Sets the default dialogs to use an Inwin instead of a normal window
15010 * If set, then the default implementation for the JavaScript dialogs and
15011 * file selector will be opened in an Inwin. Otherwise they will use a
15012 * normal separated window.
15014 * @param obj The web object
15015 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
15017 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
15020 * Gets whether Inwin mode is set for the current object
15022 * @param obj The web object
15024 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
15026 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
15028 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
15029 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
15030 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);
15031 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
15038 * @defgroup Hoversel Hoversel
15040 * @image html img/widget/hoversel/preview-00.png
15041 * @image latex img/widget/hoversel/preview-00.eps
15043 * A hoversel is a button that pops up a list of items (automatically
15044 * choosing the direction to display) that have a label and, optionally, an
15045 * icon to select from. It is a convenience widget to avoid the need to do
15046 * all the piecing together yourself. It is intended for a small number of
15047 * items in the hoversel menu (no more than 8), though is capable of many
15050 * Signals that you can add callbacks for are:
15051 * "clicked" - the user clicked the hoversel button and popped up the sel
15052 * "selected" - an item in the hoversel list is selected. event_info is the item
15053 * "dismissed" - the hover is dismissed
15055 * Default contents parts of the hoversel widget that you can use for are:
15056 * @li "icon" - An icon of the hoversel
15058 * Default text parts of the hoversel widget that you can use for are:
15059 * @li "default" - Label of the hoversel
15061 * Supported elm_object common APIs.
15062 * @li elm_object_disabled_set
15063 * @li elm_object_text_set
15064 * @li elm_object_part_text_set
15065 * @li elm_object_text_get
15066 * @li elm_object_part_text_get
15067 * @li elm_object_content_set
15068 * @li elm_object_part_content_set
15069 * @li elm_object_content_unset
15070 * @li elm_object_part_content_unset
15072 * Supported elm_object_item common APIs.
15073 * @li elm_object_item_text_get
15074 * @li elm_object_item_part_text_get
15076 * See @ref tutorial_hoversel for an example.
15081 * @brief Add a new Hoversel object
15083 * @param parent The parent object
15084 * @return The new object or NULL if it cannot be created
15086 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15089 * @brief This sets the hoversel to expand horizontally.
15091 * @param obj The hoversel object
15092 * @param horizontal If true, the hover will expand horizontally to the
15095 * @note The initial button will display horizontally regardless of this
15098 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15101 * @brief This returns whether the hoversel is set to expand horizontally.
15103 * @param obj The hoversel object
15104 * @return If true, the hover will expand horizontally to the right.
15106 * @see elm_hoversel_horizontal_set()
15108 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15111 * @brief Set the Hover parent
15113 * @param obj The hoversel object
15114 * @param parent The parent to use
15116 * Sets the hover parent object, the area that will be darkened when the
15117 * hoversel is clicked. Should probably be the window that the hoversel is
15118 * in. See @ref Hover objects for more information.
15120 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15122 * @brief Get the Hover parent
15124 * @param obj The hoversel object
15125 * @return The used parent
15127 * Gets the hover parent object.
15129 * @see elm_hoversel_hover_parent_set()
15131 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15134 * @brief Set the hoversel button label
15136 * @param obj The hoversel object
15137 * @param label The label text.
15139 * This sets the label of the button that is always visible (before it is
15140 * clicked and expanded).
15142 * @deprecated elm_object_text_set()
15144 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15147 * @brief Get the hoversel button label
15149 * @param obj The hoversel object
15150 * @return The label text.
15152 * @deprecated elm_object_text_get()
15154 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15157 * @brief Set the icon of the hoversel button
15159 * @param obj The hoversel object
15160 * @param icon The icon object
15162 * Sets the icon of the button that is always visible (before it is clicked
15163 * and expanded). Once the icon object is set, a previously set one will be
15164 * deleted, if you want to keep that old content object, use the
15165 * elm_hoversel_icon_unset() function.
15167 * @see elm_object_content_set() for the button widget
15168 * @deprecated Use elm_object_item_part_content_set() instead
15170 EINA_DEPRECATED EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15173 * @brief Get the icon of the hoversel button
15175 * @param obj The hoversel object
15176 * @return The icon object
15178 * Get the icon of the button that is always visible (before it is clicked
15179 * and expanded). Also see elm_object_content_get() for the button widget.
15181 * @see elm_hoversel_icon_set()
15182 * @deprecated Use elm_object_item_part_content_get() instead
15184 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15187 * @brief Get and unparent the icon of the hoversel button
15189 * @param obj The hoversel object
15190 * @return The icon object that was being used
15192 * Unparent and return the icon of the button that is always visible
15193 * (before it is clicked and expanded).
15195 * @see elm_hoversel_icon_set()
15196 * @see elm_object_content_unset() for the button widget
15197 * @deprecated Use elm_object_item_part_content_unset() instead
15199 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15202 * @brief This triggers the hoversel popup from code, the same as if the user
15203 * had clicked the button.
15205 * @param obj The hoversel object
15207 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
15210 * @brief This dismisses the hoversel popup as if the user had clicked
15211 * outside the hover.
15213 * @param obj The hoversel object
15215 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
15218 * @brief Returns whether the hoversel is expanded.
15220 * @param obj The hoversel object
15221 * @return This will return EINA_TRUE if the hoversel is expanded or
15222 * EINA_FALSE if it is not expanded.
15224 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15227 * @brief This will remove all the children items from the hoversel.
15229 * @param obj The hoversel object
15231 * @warning Should @b not be called while the hoversel is active; use
15232 * elm_hoversel_expanded_get() to check first.
15234 * @see elm_hoversel_item_del_cb_set()
15235 * @see elm_hoversel_item_del()
15237 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15240 * @brief Get the list of items within the given hoversel.
15242 * @param obj The hoversel object
15243 * @return Returns a list of Elm_Object_Item*
15245 * @see elm_hoversel_item_add()
15247 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15250 * @brief Add an item to the hoversel button
15252 * @param obj The hoversel object
15253 * @param label The text label to use for the item (NULL if not desired)
15254 * @param icon_file An image file path on disk to use for the icon or standard
15255 * icon name (NULL if not desired)
15256 * @param icon_type The icon type if relevant
15257 * @param func Convenience function to call when this item is selected
15258 * @param data Data to pass to item-related functions
15259 * @return A handle to the item added.
15261 * This adds an item to the hoversel to show when it is clicked. Note: if you
15262 * need to use an icon from an edje file then use
15263 * elm_hoversel_item_icon_set() right after the this function, and set
15264 * icon_file to NULL here.
15266 * For more information on what @p icon_file and @p icon_type are see the
15267 * @ref Icon "icon documentation".
15269 EAPI Elm_Object_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);
15272 * @brief Delete an item from the hoversel
15274 * @param it The item to delete
15276 * This deletes the item from the hoversel (should not be called while the
15277 * hoversel is active; use elm_hoversel_expanded_get() to check first).
15279 * @see elm_hoversel_item_add()
15280 * @see elm_hoversel_item_del_cb_set()
15282 EAPI void elm_hoversel_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15285 * @brief Set the function to be called when an item from the hoversel is
15288 * @param item The item to set the callback on
15289 * @param func The function called
15291 * That function will receive these parameters:
15292 * @li void * item data
15293 * @li Evas_Object * hoversel object
15294 * @li Elm_Object_Item * hoversel item
15296 * @see elm_hoversel_item_add()
15298 EAPI void elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15301 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
15302 * that will be passed to associated function callbacks.
15304 * @param it The item to get the data from
15305 * @return The data pointer set with elm_hoversel_item_add()
15307 * @see elm_hoversel_item_add()
15308 * @deprecated Use elm_object_item_data_get() instead
15310 EINA_DEPRECATED EAPI void *elm_hoversel_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15313 * @brief This returns the label text of the given hoversel item.
15315 * @param it The item to get the label
15316 * @return The label text of the hoversel item
15318 * @see elm_hoversel_item_add()
15319 * @deprecated Use elm_object_item_text_get() instead
15321 EINA_DEPRECATED EAPI const char *elm_hoversel_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15324 * @brief This sets the icon for the given hoversel item.
15326 * @param item The item to set the icon
15327 * @param icon_file An image file path on disk to use for the icon or standard
15329 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
15330 * to NULL if the icon is not an edje file
15331 * @param icon_type The icon type
15333 * The icon can be loaded from the standard set, from an image file, or from
15336 * @see elm_hoversel_item_add()
15338 EAPI void elm_hoversel_item_icon_set(Elm_Object_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
15341 * @brief Get the icon object of the hoversel item
15343 * @param item The item to get the icon from
15344 * @param icon_file The image file path on disk used for the icon or standard
15346 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
15347 * if the icon is not an edje file
15348 * @param icon_type The icon type
15350 * @see elm_hoversel_item_icon_set()
15351 * @see elm_hoversel_item_add()
15353 EAPI void elm_hoversel_item_icon_get(const Elm_Object_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
15360 * @defgroup Toolbar Toolbar
15361 * @ingroup Elementary
15363 * @image html img/widget/toolbar/preview-00.png
15364 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
15366 * @image html img/toolbar.png
15367 * @image latex img/toolbar.eps width=\textwidth
15369 * A toolbar is a widget that displays a list of items inside
15370 * a box. It can be scrollable, show a menu with items that don't fit
15371 * to toolbar size or even crop them.
15373 * Only one item can be selected at a time.
15375 * Items can have multiple states, or show menus when selected by the user.
15377 * Smart callbacks one can listen to:
15378 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
15379 * - "language,changed" - when the program language changes
15381 * Available styles for it:
15383 * - @c "transparent" - no background or shadow, just show the content
15385 * Default text parts of the toolbar items that you can use for are:
15386 * @li "default" - label of the toolbar item
15388 * Supported elm_object_item common APIs.
15389 * @li elm_object_item_disabled_set
15390 * @li elm_object_item_text_set
15391 * @li elm_object_item_part_text_set
15392 * @li elm_object_item_text_get
15393 * @li elm_object_item_part_text_get
15395 * List of examples:
15396 * @li @ref toolbar_example_01
15397 * @li @ref toolbar_example_02
15398 * @li @ref toolbar_example_03
15402 * @addtogroup Toolbar
15407 * @enum _Elm_Toolbar_Shrink_Mode
15408 * @typedef Elm_Toolbar_Shrink_Mode
15410 * Set toolbar's items display behavior, it can be scrollabel,
15411 * show a menu with exceeding items, or simply hide them.
15413 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
15416 * Values <b> don't </b> work as bitmask, only one can be choosen.
15418 * @see elm_toolbar_mode_shrink_set()
15419 * @see elm_toolbar_mode_shrink_get()
15423 typedef enum _Elm_Toolbar_Shrink_Mode
15425 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
15426 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
15427 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
15428 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
15429 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
15430 } Elm_Toolbar_Shrink_Mode;
15432 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(). */
15435 * Add a new toolbar widget to the given parent Elementary
15436 * (container) object.
15438 * @param parent The parent object.
15439 * @return a new toolbar widget handle or @c NULL, on errors.
15441 * This function inserts a new toolbar widget on the canvas.
15445 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15448 * Set the icon size, in pixels, to be used by toolbar items.
15450 * @param obj The toolbar object
15451 * @param icon_size The icon size in pixels
15453 * @note Default value is @c 32. It reads value from elm config.
15455 * @see elm_toolbar_icon_size_get()
15459 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
15462 * Get the icon size, in pixels, to be used by toolbar items.
15464 * @param obj The toolbar object.
15465 * @return The icon size in pixels.
15467 * @see elm_toolbar_icon_size_set() for details.
15471 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15474 * Sets icon lookup order, for toolbar items' icons.
15476 * @param obj The toolbar object.
15477 * @param order The icon lookup order.
15479 * Icons added before calling this function will not be affected.
15480 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
15482 * @see elm_toolbar_icon_order_lookup_get()
15486 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
15489 * Gets the icon lookup order.
15491 * @param obj The toolbar object.
15492 * @return The icon lookup order.
15494 * @see elm_toolbar_icon_order_lookup_set() for details.
15498 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15501 * Set whether the toolbar should always have an item selected.
15503 * @param obj The toolbar object.
15504 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
15507 * This will cause the toolbar to always have an item selected, and clicking
15508 * the selected item will not cause a selected event to be emitted. Enabling this mode
15509 * will immediately select the first toolbar item.
15511 * Always-selected is disabled by default.
15513 * @see elm_toolbar_always_select_mode_get().
15517 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15520 * Get whether the toolbar should always have an item selected.
15522 * @param obj The toolbar object.
15523 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
15524 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
15526 * @see elm_toolbar_always_select_mode_set() for details.
15530 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15533 * Set whether the toolbar items' should be selected by the user or not.
15535 * @param obj The toolbar object.
15536 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
15539 * This will turn off the ability to select items entirely and they will
15540 * neither appear selected nor emit selected signals. The clicked
15541 * callback function will still be called.
15543 * Selection is enabled by default.
15545 * @see elm_toolbar_no_select_mode_get().
15549 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
15552 * Set whether the toolbar items' should be selected by the user or not.
15554 * @param obj The toolbar object.
15555 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
15556 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
15558 * @see elm_toolbar_no_select_mode_set() for details.
15562 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15565 * Append item to the toolbar.
15567 * @param obj The toolbar object.
15568 * @param icon A string with icon name or the absolute path of an image file.
15569 * @param label The label of the item.
15570 * @param func The function to call when the item is clicked.
15571 * @param data The data to associate with the item for related callbacks.
15572 * @return The created item or @c NULL upon failure.
15574 * A new item will be created and appended to the toolbar, i.e., will
15575 * be set as @b last item.
15577 * Items created with this method can be deleted with
15578 * elm_toolbar_item_del().
15580 * Associated @p data can be properly freed when item is deleted if a
15581 * callback function is set with elm_toolbar_item_del_cb_set().
15583 * If a function is passed as argument, it will be called everytime this item
15584 * is selected, i.e., the user clicks over an unselected item.
15585 * If such function isn't needed, just passing
15586 * @c NULL as @p func is enough. The same should be done for @p data.
15588 * Toolbar will load icon image from fdo or current theme.
15589 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15590 * If an absolute path is provided it will load it direct from a file.
15592 * @see elm_toolbar_item_icon_set()
15593 * @see elm_toolbar_item_del()
15594 * @see elm_toolbar_item_del_cb_set()
15598 EAPI Elm_Object_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);
15601 * Prepend item to the toolbar.
15603 * @param obj The toolbar object.
15604 * @param icon A string with icon name or the absolute path of an image file.
15605 * @param label The label of the item.
15606 * @param func The function to call when the item is clicked.
15607 * @param data The data to associate with the item for related callbacks.
15608 * @return The created item or @c NULL upon failure.
15610 * A new item will be created and prepended to the toolbar, i.e., will
15611 * be set as @b first item.
15613 * Items created with this method can be deleted with
15614 * elm_toolbar_item_del().
15616 * Associated @p data can be properly freed when item is deleted if a
15617 * callback function is set with elm_toolbar_item_del_cb_set().
15619 * If a function is passed as argument, it will be called everytime this item
15620 * is selected, i.e., the user clicks over an unselected item.
15621 * If such function isn't needed, just passing
15622 * @c NULL as @p func is enough. The same should be done for @p data.
15624 * Toolbar will load icon image from fdo or current theme.
15625 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15626 * If an absolute path is provided it will load it direct from a file.
15628 * @see elm_toolbar_item_icon_set()
15629 * @see elm_toolbar_item_del()
15630 * @see elm_toolbar_item_del_cb_set()
15634 EAPI Elm_Object_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);
15637 * Insert a new item into the toolbar object before item @p before.
15639 * @param obj The toolbar object.
15640 * @param before The toolbar item to insert before.
15641 * @param icon A string with icon name or the absolute path of an image file.
15642 * @param label The label of the item.
15643 * @param func The function to call when the item is clicked.
15644 * @param data The data to associate with the item for related callbacks.
15645 * @return The created item or @c NULL upon failure.
15647 * A new item will be created and added to the toolbar. Its position in
15648 * this toolbar will be just before item @p before.
15650 * Items created with this method can be deleted with
15651 * elm_toolbar_item_del().
15653 * Associated @p data can be properly freed when item is deleted if a
15654 * callback function is set with elm_toolbar_item_del_cb_set().
15656 * If a function is passed as argument, it will be called everytime this item
15657 * is selected, i.e., the user clicks over an unselected item.
15658 * If such function isn't needed, just passing
15659 * @c NULL as @p func is enough. The same should be done for @p data.
15661 * Toolbar will load icon image from fdo or current theme.
15662 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15663 * If an absolute path is provided it will load it direct from a file.
15665 * @see elm_toolbar_item_icon_set()
15666 * @see elm_toolbar_item_del()
15667 * @see elm_toolbar_item_del_cb_set()
15671 EAPI Elm_Object_Item *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15674 * Insert a new item into the toolbar object after item @p after.
15676 * @param obj The toolbar object.
15677 * @param after The toolbar item to insert after.
15678 * @param icon A string with icon name or the absolute path of an image file.
15679 * @param label The label of the item.
15680 * @param func The function to call when the item is clicked.
15681 * @param data The data to associate with the item for related callbacks.
15682 * @return The created item or @c NULL upon failure.
15684 * A new item will be created and added to the toolbar. Its position in
15685 * this toolbar will be just after item @p after.
15687 * Items created with this method can be deleted with
15688 * elm_toolbar_item_del().
15690 * Associated @p data can be properly freed when item is deleted if a
15691 * callback function is set with elm_toolbar_item_del_cb_set().
15693 * If a function is passed as argument, it will be called everytime this item
15694 * is selected, i.e., the user clicks over an unselected item.
15695 * If such function isn't needed, just passing
15696 * @c NULL as @p func is enough. The same should be done for @p data.
15698 * Toolbar will load icon image from fdo or current theme.
15699 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15700 * If an absolute path is provided it will load it direct from a file.
15702 * @see elm_toolbar_item_icon_set()
15703 * @see elm_toolbar_item_del()
15704 * @see elm_toolbar_item_del_cb_set()
15708 EAPI Elm_Object_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15711 * Get the first item in the given toolbar widget's list of
15714 * @param obj The toolbar object
15715 * @return The first item or @c NULL, if it has no items (and on
15718 * @see elm_toolbar_item_append()
15719 * @see elm_toolbar_last_item_get()
15723 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15726 * Get the last item in the given toolbar widget's list of
15729 * @param obj The toolbar object
15730 * @return The last item or @c NULL, if it has no items (and on
15733 * @see elm_toolbar_item_prepend()
15734 * @see elm_toolbar_first_item_get()
15738 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15741 * Get the item after @p item in toolbar.
15743 * @param it The toolbar item.
15744 * @return The item after @p item, or @c NULL if none or on failure.
15746 * @note If it is the last item, @c NULL will be returned.
15748 * @see elm_toolbar_item_append()
15752 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15755 * Get the item before @p item in toolbar.
15757 * @param item The toolbar item.
15758 * @return The item before @p item, or @c NULL if none or on failure.
15760 * @note If it is the first item, @c NULL will be returned.
15762 * @see elm_toolbar_item_prepend()
15766 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15769 * Get the toolbar object from an item.
15771 * @param it The item.
15772 * @return The toolbar object.
15774 * This returns the toolbar object itself that an item belongs to.
15776 * @deprecated use elm_object_item_object_get() instead.
15779 EINA_DEPRECATED EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15782 * Set the priority of a toolbar item.
15784 * @param it The toolbar item.
15785 * @param priority The item priority. The default is zero.
15787 * This is used only when the toolbar shrink mode is set to
15788 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15789 * When space is less than required, items with low priority
15790 * will be removed from the toolbar and added to a dynamically-created menu,
15791 * while items with higher priority will remain on the toolbar,
15792 * with the same order they were added.
15794 * @see elm_toolbar_item_priority_get()
15798 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15801 * Get the priority of a toolbar item.
15803 * @param it The toolbar item.
15804 * @return The @p item priority, or @c 0 on failure.
15806 * @see elm_toolbar_item_priority_set() for details.
15810 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15813 * Get the label of item.
15815 * @param it The item of toolbar.
15816 * @return The label of item.
15818 * The return value is a pointer to the label associated to @p item when
15819 * it was created, with function elm_toolbar_item_append() or similar,
15821 * with function elm_toolbar_item_label_set. If no label
15822 * was passed as argument, it will return @c NULL.
15824 * @see elm_toolbar_item_label_set() for more details.
15825 * @see elm_toolbar_item_append()
15827 * @deprecated use elm_object_item_text_get() instead.
15830 EINA_DEPRECATED EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15833 * Set the label of item.
15835 * @param it The item of toolbar.
15836 * @param text The label of item.
15838 * The label to be displayed by the item.
15839 * Label will be placed at icons bottom (if set).
15841 * If a label was passed as argument on item creation, with function
15842 * elm_toolbar_item_append() or similar, it will be already
15843 * displayed by the item.
15845 * @see elm_toolbar_item_label_get()
15846 * @see elm_toolbar_item_append()
15848 * @deprecated use elm_object_item_text_set() instead
15851 EINA_DEPRECATED EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15854 * Return the data associated with a given toolbar widget item.
15856 * @param it The toolbar widget item handle.
15857 * @return The data associated with @p item.
15859 * @see elm_toolbar_item_data_set()
15861 * @deprecated use elm_object_item_data_get() instead.
15864 EINA_DEPRECATED EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15867 * Set the data associated with a given toolbar widget item.
15869 * @param it The toolbar widget item handle
15870 * @param data The new data pointer to set to @p item.
15872 * This sets new item data on @p item.
15874 * @warning The old data pointer won't be touched by this function, so
15875 * the user had better to free that old data himself/herself.
15877 * @deprecated use elm_object_item_data_set() instead.
15880 EINA_DEPRECATED EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15883 * Returns a pointer to a toolbar item by its label.
15885 * @param obj The toolbar object.
15886 * @param label The label of the item to find.
15888 * @return The pointer to the toolbar item matching @p label or @c NULL
15893 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15896 * Get whether the @p item is selected or not.
15898 * @param it The toolbar item.
15899 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15900 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15902 * @see elm_toolbar_selected_item_set() for details.
15903 * @see elm_toolbar_item_selected_get()
15907 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15910 * Set the selected state of an item.
15912 * @param it The toolbar item
15913 * @param selected The selected state
15915 * This sets the selected state of the given item @p it.
15916 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15918 * If a new item is selected the previosly selected will be unselected.
15919 * Previoulsy selected item can be get with function
15920 * elm_toolbar_selected_item_get().
15922 * Selected items will be highlighted.
15924 * @see elm_toolbar_item_selected_get()
15925 * @see elm_toolbar_selected_item_get()
15929 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15932 * Get the selected item.
15934 * @param obj The toolbar object.
15935 * @return The selected toolbar item.
15937 * The selected item can be unselected with function
15938 * elm_toolbar_item_selected_set().
15940 * The selected item always will be highlighted on toolbar.
15942 * @see elm_toolbar_selected_items_get()
15946 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15949 * Set the icon associated with @p item.
15951 * @param obj The parent of this item.
15952 * @param it The toolbar item.
15953 * @param icon A string with icon name or the absolute path of an image file.
15955 * Toolbar will load icon image from fdo or current theme.
15956 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15957 * If an absolute path is provided it will load it direct from a file.
15959 * @see elm_toolbar_icon_order_lookup_set()
15960 * @see elm_toolbar_icon_order_lookup_get()
15964 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15967 * Get the string used to set the icon of @p item.
15969 * @param it The toolbar item.
15970 * @return The string associated with the icon object.
15972 * @see elm_toolbar_item_icon_set() for details.
15976 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15979 * Get the object of @p item.
15981 * @param it The toolbar item.
15982 * @return The object
15986 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15989 * Get the icon object of @p item.
15991 * @param it The toolbar item.
15992 * @return The icon object
15994 * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15995 * or elm_toolbar_item_icon_memfile_set() for details.
15999 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16002 * Set the icon associated with @p item to an image in a binary buffer.
16004 * @param it The toolbar item.
16005 * @param img The binary data that will be used as an image
16006 * @param size The size of binary data @p img
16007 * @param format Optional format of @p img to pass to the image loader
16008 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16010 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16012 * @note The icon image set by this function can be changed by
16013 * elm_toolbar_item_icon_set().
16017 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Object_Item *it, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
16020 * Set the icon associated with @p item to an image in a binary buffer.
16022 * @param it The toolbar item.
16023 * @param file The file that contains the image
16024 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16026 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16028 * @note The icon image set by this function can be changed by
16029 * elm_toolbar_item_icon_set().
16033 EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
16036 * Delete them item from the toolbar.
16038 * @param it The item of toolbar to be deleted.
16040 * @see elm_toolbar_item_append()
16041 * @see elm_toolbar_item_del_cb_set()
16045 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16048 * Set the function called when a toolbar item is freed.
16050 * @param it The item to set the callback on.
16051 * @param func The function called.
16053 * If there is a @p func, then it will be called prior item's memory release.
16054 * That will be called with the following arguments:
16056 * @li item's Evas object;
16059 * This way, a data associated to a toolbar item could be properly freed.
16063 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16066 * Get a value whether toolbar item is disabled or not.
16068 * @param it The item.
16069 * @return The disabled state.
16071 * @see elm_toolbar_item_disabled_set() for more details.
16073 * @deprecated use elm_object_item_disabled_get() instead.
16076 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16079 * Sets the disabled/enabled state of a toolbar item.
16081 * @param it The item.
16082 * @param disabled The disabled state.
16084 * A disabled item cannot be selected or unselected. It will also
16085 * change its appearance (generally greyed out). This sets the
16086 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16089 * @deprecated use elm_object_item_disabled_set() instead.
16092 EINA_DEPRECATED EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16095 * Set or unset item as a separator.
16097 * @param it The toolbar item.
16098 * @param setting @c EINA_TRUE to set item @p item as separator or
16099 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16101 * Items aren't set as separator by default.
16103 * If set as separator it will display separator theme, so won't display
16106 * @see elm_toolbar_item_separator_get()
16110 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
16113 * Get a value whether item is a separator or not.
16115 * @param it The toolbar item.
16116 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16117 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16119 * @see elm_toolbar_item_separator_set() for details.
16123 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16126 * Set the shrink state of toolbar @p obj.
16128 * @param obj The toolbar object.
16129 * @param shrink_mode Toolbar's items display behavior.
16131 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
16132 * but will enforce a minimun size so all the items will fit, won't scroll
16133 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
16134 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
16135 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
16139 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
16142 * Get the shrink mode of toolbar @p obj.
16144 * @param obj The toolbar object.
16145 * @return Toolbar's items display behavior.
16147 * @see elm_toolbar_mode_shrink_set() for details.
16151 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16154 * Enable/disable homogeneous mode.
16156 * @param obj The toolbar object
16157 * @param homogeneous Assume the items within the toolbar are of the
16158 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
16160 * This will enable the homogeneous mode where items are of the same size.
16161 * @see elm_toolbar_homogeneous_get()
16165 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16168 * Get whether the homogeneous mode is enabled.
16170 * @param obj The toolbar object.
16171 * @return Assume the items within the toolbar are of the same height
16172 * and width (EINA_TRUE = on, EINA_FALSE = off).
16174 * @see elm_toolbar_homogeneous_set()
16178 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16181 * Set the parent object of the toolbar items' menus.
16183 * @param obj The toolbar object.
16184 * @param parent The parent of the menu objects.
16186 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
16188 * For more details about setting the parent for toolbar menus, see
16189 * elm_menu_parent_set().
16191 * @see elm_menu_parent_set() for details.
16192 * @see elm_toolbar_item_menu_set() for details.
16196 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16199 * Get the parent object of the toolbar items' menus.
16201 * @param obj The toolbar object.
16202 * @return The parent of the menu objects.
16204 * @see elm_toolbar_menu_parent_set() for details.
16208 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16211 * Set the alignment of the items.
16213 * @param obj The toolbar object.
16214 * @param align The new alignment, a float between <tt> 0.0 </tt>
16215 * and <tt> 1.0 </tt>.
16217 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
16218 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
16221 * Centered items by default.
16223 * @see elm_toolbar_align_get()
16227 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
16230 * Get the alignment of the items.
16232 * @param obj The toolbar object.
16233 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
16236 * @see elm_toolbar_align_set() for details.
16240 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16243 * Set whether the toolbar item opens a menu.
16245 * @param it The toolbar item.
16246 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
16248 * A toolbar item can be set to be a menu, using this function.
16250 * Once it is set to be a menu, it can be manipulated through the
16251 * menu-like function elm_toolbar_menu_parent_set() and the other
16252 * elm_menu functions, using the Evas_Object @c menu returned by
16253 * elm_toolbar_item_menu_get().
16255 * So, items to be displayed in this item's menu should be added with
16256 * elm_menu_item_add().
16258 * The following code exemplifies the most basic usage:
16260 * tb = elm_toolbar_add(win)
16261 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
16262 * elm_toolbar_item_menu_set(item, EINA_TRUE);
16263 * elm_toolbar_menu_parent_set(tb, win);
16264 * menu = elm_toolbar_item_menu_get(item);
16265 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
16266 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
16270 * @see elm_toolbar_item_menu_get()
16274 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
16277 * Get toolbar item's menu.
16279 * @param it The toolbar item.
16280 * @return Item's menu object or @c NULL on failure.
16282 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
16283 * this function will set it.
16285 * @see elm_toolbar_item_menu_set() for details.
16289 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16292 * Add a new state to @p item.
16294 * @param it The toolbar item.
16295 * @param icon A string with icon name or the absolute path of an image file.
16296 * @param label The label of the new state.
16297 * @param func The function to call when the item is clicked when this
16298 * state is selected.
16299 * @param data The data to associate with the state.
16300 * @return The toolbar item state, or @c NULL upon failure.
16302 * Toolbar will load icon image from fdo or current theme.
16303 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
16304 * If an absolute path is provided it will load it direct from a file.
16306 * States created with this function can be removed with
16307 * elm_toolbar_item_state_del().
16309 * @see elm_toolbar_item_state_del()
16310 * @see elm_toolbar_item_state_sel()
16311 * @see elm_toolbar_item_state_get()
16315 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16318 * Delete a previoulsy added state to @p item.
16320 * @param it The toolbar item.
16321 * @param state The state to be deleted.
16322 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16324 * @see elm_toolbar_item_state_add()
16326 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16329 * Set @p state as the current state of @p it.
16331 * @param it The toolbar item.
16332 * @param state The state to use.
16333 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16335 * If @p state is @c NULL, it won't select any state and the default item's
16336 * icon and label will be used. It's the same behaviour than
16337 * elm_toolbar_item_state_unser().
16339 * @see elm_toolbar_item_state_unset()
16343 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16346 * Unset the state of @p it.
16348 * @param it The toolbar item.
16350 * The default icon and label from this item will be displayed.
16352 * @see elm_toolbar_item_state_set() for more details.
16356 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16359 * Get the current state of @p it.
16361 * @param it The toolbar item.
16362 * @return The selected state or @c NULL if none is selected or on failure.
16364 * @see elm_toolbar_item_state_set() for details.
16365 * @see elm_toolbar_item_state_unset()
16366 * @see elm_toolbar_item_state_add()
16370 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16373 * Get the state after selected state in toolbar's @p item.
16375 * @param it The toolbar item to change state.
16376 * @return The state after current state, or @c NULL on failure.
16378 * If last state is selected, this function will return first state.
16380 * @see elm_toolbar_item_state_set()
16381 * @see elm_toolbar_item_state_add()
16385 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16388 * Get the state before selected state in toolbar's @p item.
16390 * @param it The toolbar item to change state.
16391 * @return The state before current state, or @c NULL on failure.
16393 * If first state is selected, this function will return last state.
16395 * @see elm_toolbar_item_state_set()
16396 * @see elm_toolbar_item_state_add()
16400 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16403 * Set the text to be shown in a given toolbar item's tooltips.
16405 * @param it toolbar item.
16406 * @param text The text to set in the content.
16408 * Setup the text as tooltip to object. The item can have only one tooltip,
16409 * so any previous tooltip data - set with this function or
16410 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
16412 * @see elm_object_tooltip_text_set() for more details.
16416 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
16419 * Set the content to be shown in the tooltip item.
16421 * Setup the tooltip to item. The item can have only one tooltip,
16422 * so any previous tooltip data is removed. @p func(with @p data) will
16423 * be called every time that need show the tooltip and it should
16424 * return a valid Evas_Object. This object is then managed fully by
16425 * tooltip system and is deleted when the tooltip is gone.
16427 * @param it the toolbar item being attached a tooltip.
16428 * @param func the function used to create the tooltip contents.
16429 * @param data what to provide to @a func as callback data/context.
16430 * @param del_cb called when data is not needed anymore, either when
16431 * another callback replaces @a func, the tooltip is unset with
16432 * elm_toolbar_item_tooltip_unset() or the owner @a item
16433 * dies. This callback receives as the first parameter the
16434 * given @a data, and @c event_info is the item.
16436 * @see elm_object_tooltip_content_cb_set() for more details.
16440 EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
16443 * Unset tooltip from item.
16445 * @param it toolbar item to remove previously set tooltip.
16447 * Remove tooltip from item. The callback provided as del_cb to
16448 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
16449 * it is not used anymore.
16451 * @see elm_object_tooltip_unset() for more details.
16452 * @see elm_toolbar_item_tooltip_content_cb_set()
16456 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16459 * Sets a different style for this item tooltip.
16461 * @note before you set a style you should define a tooltip with
16462 * elm_toolbar_item_tooltip_content_cb_set() or
16463 * elm_toolbar_item_tooltip_text_set()
16465 * @param it toolbar item with tooltip already set.
16466 * @param style the theme style to use (default, transparent, ...)
16468 * @see elm_object_tooltip_style_set() for more details.
16472 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16475 * Get the style for this item tooltip.
16477 * @param it toolbar item with tooltip already set.
16478 * @return style the theme style in use, defaults to "default". If the
16479 * object does not have a tooltip set, then NULL is returned.
16481 * @see elm_object_tooltip_style_get() for more details.
16482 * @see elm_toolbar_item_tooltip_style_set()
16486 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16489 * Set the type of mouse pointer/cursor decoration to be shown,
16490 * when the mouse pointer is over the given toolbar widget item
16492 * @param it toolbar item to customize cursor on
16493 * @param cursor the cursor type's name
16495 * This function works analogously as elm_object_cursor_set(), but
16496 * here the cursor's changing area is restricted to the item's
16497 * area, and not the whole widget's. Note that that item cursors
16498 * have precedence over widget cursors, so that a mouse over an
16499 * item with custom cursor set will always show @b that cursor.
16501 * If this function is called twice for an object, a previously set
16502 * cursor will be unset on the second call.
16504 * @see elm_object_cursor_set()
16505 * @see elm_toolbar_item_cursor_get()
16506 * @see elm_toolbar_item_cursor_unset()
16510 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
16513 * Get the type of mouse pointer/cursor decoration set to be shown,
16514 * when the mouse pointer is over the given toolbar widget item
16516 * @param it toolbar item with custom cursor set
16517 * @return the cursor type's name or @c NULL, if no custom cursors
16518 * were set to @p item (and on errors)
16520 * @see elm_object_cursor_get()
16521 * @see elm_toolbar_item_cursor_set()
16522 * @see elm_toolbar_item_cursor_unset()
16526 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16529 * Unset any custom mouse pointer/cursor decoration set to be
16530 * shown, when the mouse pointer is over the given toolbar widget
16531 * item, thus making it show the @b default cursor again.
16533 * @param it a toolbar item
16535 * Use this call to undo any custom settings on this item's cursor
16536 * decoration, bringing it back to defaults (no custom style set).
16538 * @see elm_object_cursor_unset()
16539 * @see elm_toolbar_item_cursor_set()
16543 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16546 * Set a different @b style for a given custom cursor set for a
16549 * @param it toolbar item with custom cursor set
16550 * @param style the <b>theme style</b> to use (e.g. @c "default",
16551 * @c "transparent", etc)
16553 * This function only makes sense when one is using custom mouse
16554 * cursor decorations <b>defined in a theme file</b>, which can have,
16555 * given a cursor name/type, <b>alternate styles</b> on it. It
16556 * works analogously as elm_object_cursor_style_set(), but here
16557 * applyed only to toolbar item objects.
16559 * @warning Before you set a cursor style you should have definen a
16560 * custom cursor previously on the item, with
16561 * elm_toolbar_item_cursor_set()
16563 * @see elm_toolbar_item_cursor_engine_only_set()
16564 * @see elm_toolbar_item_cursor_style_get()
16568 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16571 * Get the current @b style set for a given toolbar item's custom
16574 * @param it toolbar item with custom cursor set.
16575 * @return style the cursor style in use. If the object does not
16576 * have a cursor set, then @c NULL is returned.
16578 * @see elm_toolbar_item_cursor_style_set() for more details
16582 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16585 * Set if the (custom)cursor for a given toolbar item should be
16586 * searched in its theme, also, or should only rely on the
16587 * rendering engine.
16589 * @param it item with custom (custom) cursor already set on
16590 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16591 * only on those provided by the rendering engine, @c EINA_FALSE to
16592 * have them searched on the widget's theme, as well.
16594 * @note This call is of use only if you've set a custom cursor
16595 * for toolbar items, with elm_toolbar_item_cursor_set().
16597 * @note By default, cursors will only be looked for between those
16598 * provided by the rendering engine.
16602 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16605 * Get if the (custom) cursor for a given toolbar item is being
16606 * searched in its theme, also, or is only relying on the rendering
16609 * @param it a toolbar item
16610 * @return @c EINA_TRUE, if cursors are being looked for only on
16611 * those provided by the rendering engine, @c EINA_FALSE if they
16612 * are being searched on the widget's theme, as well.
16614 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
16618 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16621 * Change a toolbar's orientation
16622 * @param obj The toolbar object
16623 * @param vertical If @c EINA_TRUE, the toolbar is vertical
16624 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16626 * @deprecated use elm_toolbar_horizontal_set() instead.
16628 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
16631 * Change a toolbar's orientation
16632 * @param obj The toolbar object
16633 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
16634 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16637 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16640 * Get a toolbar's orientation
16641 * @param obj The toolbar object
16642 * @return If @c EINA_TRUE, the toolbar is vertical
16643 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16645 * @deprecated use elm_toolbar_horizontal_get() instead.
16647 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16650 * Get a toolbar's orientation
16651 * @param obj The toolbar object
16652 * @return If @c EINA_TRUE, the toolbar is horizontal
16653 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16656 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16662 * @defgroup Tooltips Tooltips
16664 * The Tooltip is an (internal, for now) smart object used to show a
16665 * content in a frame on mouse hover of objects(or widgets), with
16666 * tips/information about them.
16671 EAPI double elm_tooltip_delay_get(void);
16672 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
16673 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16674 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16675 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16676 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16677 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16678 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);
16679 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16680 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16681 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16682 EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16683 EAPI Eina_Bool elm_object_tooltip_window_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16690 * @defgroup Cursors Cursors
16692 * The Elementary cursor is an internal smart object used to
16693 * customize the mouse cursor displayed over objects (or
16694 * widgets). In the most common scenario, the cursor decoration
16695 * comes from the graphical @b engine Elementary is running
16696 * on. Those engines may provide different decorations for cursors,
16697 * and Elementary provides functions to choose them (think of X11
16698 * cursors, as an example).
16700 * There's also the possibility of, besides using engine provided
16701 * cursors, also use ones coming from Edje theming files. Both
16702 * globally and per widget, Elementary makes it possible for one to
16703 * make the cursors lookup to be held on engines only or on
16704 * Elementary's theme file, too. To set cursor's hot spot,
16705 * two data items should be added to cursor's theme: "hot_x" and
16706 * "hot_y", that are the offset from upper-left corner of the cursor
16707 * (coordinates 0,0).
16713 * Set the cursor to be shown when mouse is over the object
16715 * Set the cursor that will be displayed when mouse is over the
16716 * object. The object can have only one cursor set to it, so if
16717 * this function is called twice for an object, the previous set
16719 * If using X cursors, a definition of all the valid cursor names
16720 * is listed on Elementary_Cursors.h. If an invalid name is set
16721 * the default cursor will be used.
16723 * @param obj the object being set a cursor.
16724 * @param cursor the cursor name to be used.
16728 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16731 * Get the cursor to be shown when mouse is over the object
16733 * @param obj an object with cursor already set.
16734 * @return the cursor name.
16738 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16741 * Unset cursor for object
16743 * Unset cursor for object, and set the cursor to default if the mouse
16744 * was over this object.
16746 * @param obj Target object
16747 * @see elm_object_cursor_set()
16751 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16754 * Sets a different style for this object cursor.
16756 * @note before you set a style you should define a cursor with
16757 * elm_object_cursor_set()
16759 * @param obj an object with cursor already set.
16760 * @param style the theme style to use (default, transparent, ...)
16764 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16767 * Get the style for this object cursor.
16769 * @param obj an object with cursor already set.
16770 * @return style the theme style in use, defaults to "default". If the
16771 * object does not have a cursor set, then NULL is returned.
16775 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16778 * Set if the cursor set should be searched on the theme or should use
16779 * the provided by the engine, only.
16781 * @note before you set if should look on theme you should define a cursor
16782 * with elm_object_cursor_set(). By default it will only look for cursors
16783 * provided by the engine.
16785 * @param obj an object with cursor already set.
16786 * @param engine_only boolean to define it cursors should be looked only
16787 * between the provided by the engine or searched on widget's theme as well.
16791 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16794 * Get the cursor engine only usage for this object cursor.
16796 * @param obj an object with cursor already set.
16797 * @return engine_only boolean to define it cursors should be
16798 * looked only between the provided by the engine or searched on
16799 * widget's theme as well. If the object does not have a cursor
16800 * set, then EINA_FALSE is returned.
16804 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16807 * Get the configured cursor engine only usage
16809 * This gets the globally configured exclusive usage of engine cursors.
16811 * @return 1 if only engine cursors should be used
16814 EAPI int elm_cursor_engine_only_get(void);
16817 * Set the configured cursor engine only usage
16819 * This sets the globally configured exclusive usage of engine cursors.
16820 * It won't affect cursors set before changing this value.
16822 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16823 * look for them on theme before.
16824 * @return EINA_TRUE if value is valid and setted (0 or 1)
16827 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
16834 * @defgroup Menu Menu
16836 * @image html img/widget/menu/preview-00.png
16837 * @image latex img/widget/menu/preview-00.eps
16839 * A menu is a list of items displayed above its parent. When the menu is
16840 * showing its parent is darkened. Each item can have a sub-menu. The menu
16841 * object can be used to display a menu on a right click event, in a toolbar,
16844 * Signals that you can add callbacks for are:
16845 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16847 * Default contents parts of the menu items that you can use for are:
16848 * @li "default" - A main content of the menu item
16850 * Default text parts of the menu items that you can use for are:
16851 * @li "default" - label in the menu item
16853 * @see @ref tutorial_menu
16858 * @brief Add a new menu to the parent
16860 * @param parent The parent object.
16861 * @return The new object or NULL if it cannot be created.
16863 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16866 * @brief Set the parent for the given menu widget
16868 * @param obj The menu object.
16869 * @param parent The new parent.
16871 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16874 * @brief Get the parent for the given menu widget
16876 * @param obj The menu object.
16877 * @return The parent.
16879 * @see elm_menu_parent_set()
16881 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16884 * @brief Move the menu to a new position
16886 * @param obj The menu object.
16887 * @param x The new position.
16888 * @param y The new position.
16890 * Sets the top-left position of the menu to (@p x,@p y).
16892 * @note @p x and @p y coordinates are relative to parent.
16894 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16897 * @brief Close a opened menu
16899 * @param obj the menu object
16902 * Hides the menu and all it's sub-menus.
16904 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16907 * @brief Returns a list of @p item's items.
16909 * @param obj The menu object
16910 * @return An Eina_List* of @p item's items
16912 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16915 * @brief Get the Evas_Object of an Elm_Object_Item
16917 * @param it The menu item object.
16918 * @return The edje object containing the swallowed content
16920 * @warning Don't manipulate this object!
16923 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16926 * @brief Add an item at the end of the given menu widget
16928 * @param obj The menu object.
16929 * @param parent The parent menu item (optional)
16930 * @param icon An icon display on the item. The icon will be destryed by the menu.
16931 * @param label The label of the item.
16932 * @param func Function called when the user select the item.
16933 * @param data Data sent by the callback.
16934 * @return Returns the new item.
16936 EAPI Elm_Object_Item *elm_menu_item_add(Evas_Object *obj, Elm_Object_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16939 * @brief Add an object swallowed in an item at the end of the given menu
16942 * @param obj The menu object.
16943 * @param parent The parent menu item (optional)
16944 * @param subobj The object to swallow
16945 * @param func Function called when the user select the item.
16946 * @param data Data sent by the callback.
16947 * @return Returns the new item.
16949 * Add an evas object as an item to the menu.
16951 EAPI Elm_Object_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Object_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16954 * @brief Set the label of a menu item
16956 * @param it The menu item object.
16957 * @param label The label to set for @p item
16959 * @warning Don't use this funcion on items created with
16960 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16962 * @deprecated Use elm_object_item_text_set() instead
16964 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16967 * @brief Get the label of a menu item
16969 * @param it The menu item object.
16970 * @return The label of @p item
16971 * @deprecated Use elm_object_item_text_get() instead
16973 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16976 * @brief Set the icon of a menu item to the standard icon with name @p icon
16978 * @param it The menu item object.
16979 * @param icon The icon object to set for the content of @p item
16981 * Once this icon is set, any previously set icon will be deleted.
16983 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16986 * @brief Get the string representation from the icon of a menu item
16988 * @param it The menu item object.
16989 * @return The string representation of @p item's icon or NULL
16991 * @see elm_menu_item_object_icon_name_set()
16993 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16996 * @brief Set the content object of a menu item
16998 * @param it The menu item object
16999 * @param The content object or NULL
17000 * @return EINA_TRUE on success, else EINA_FALSE
17002 * Use this function to change the object swallowed by a menu item, deleting
17003 * any previously swallowed object.
17005 * @deprecated Use elm_object_item_content_set() instead
17007 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
17010 * @brief Get the content object of a menu item
17012 * @param it The menu item object
17013 * @return The content object or NULL
17014 * @note If @p item was added with elm_menu_item_add_object, this
17015 * function will return the object passed, else it will return the
17018 * @see elm_menu_item_object_content_set()
17020 * @deprecated Use elm_object_item_content_get() instead
17022 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17025 * @brief Set the selected state of @p item.
17027 * @param it The menu item object.
17028 * @param selected The selected/unselected state of the item
17030 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
17033 * @brief Get the selected state of @p item.
17035 * @param it The menu item object.
17036 * @return The selected/unselected state of the item
17038 * @see elm_menu_item_selected_set()
17040 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17043 * @brief Set the disabled state of @p item.
17045 * @param it The menu item object.
17046 * @param disabled The enabled/disabled state of the item
17047 * @deprecated Use elm_object_item_disabled_set() instead
17049 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17052 * @brief Get the disabled state of @p item.
17054 * @param it The menu item object.
17055 * @return The enabled/disabled state of the item
17057 * @see elm_menu_item_disabled_set()
17058 * @deprecated Use elm_object_item_disabled_get() instead
17060 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17063 * @brief Add a separator item to menu @p obj under @p parent.
17065 * @param obj The menu object
17066 * @param parent The item to add the separator under
17067 * @return The created item or NULL on failure
17069 * This is item is a @ref Separator.
17071 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
17074 * @brief Returns whether @p item is a separator.
17076 * @param it The item to check
17077 * @return If true, @p item is a separator
17079 * @see elm_menu_item_separator_add()
17081 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17084 * @brief Deletes an item from the menu.
17086 * @param it The item to delete.
17088 * @see elm_menu_item_add()
17090 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17093 * @brief Set the function called when a menu item is deleted.
17095 * @param it The item to set the callback on
17096 * @param func The function called
17098 * @see elm_menu_item_add()
17099 * @see elm_menu_item_del()
17101 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17104 * @brief Returns the data associated with menu item @p item.
17106 * @param it The item
17107 * @return The data associated with @p item or NULL if none was set.
17109 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
17111 * @deprecated Use elm_object_item_data_get() instead
17113 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17116 * @brief Sets the data to be associated with menu item @p item.
17118 * @param it The item
17119 * @param data The data to be associated with @p item
17121 * @deprecated Use elm_object_item_data_set() instead
17123 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
17126 * @brief Returns a list of @p item's subitems.
17128 * @param it The item
17129 * @return An Eina_List* of @p item's subitems
17131 * @see elm_menu_add()
17133 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17136 * @brief Get the position of a menu item
17138 * @param it The menu item
17139 * @return The item's index
17141 * This function returns the index position of a menu item in a menu.
17142 * For a sub-menu, this number is relative to the first item in the sub-menu.
17144 * @note Index values begin with 0
17146 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17149 * @brief @brief Return a menu item's owner menu
17151 * @param it The menu item
17152 * @return The menu object owning @p item, or NULL on failure
17154 * Use this function to get the menu object owning an item.
17156 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17159 * @brief Get the selected item in the menu
17161 * @param obj The menu object
17162 * @return The selected item, or NULL if none
17164 * @see elm_menu_item_selected_get()
17165 * @see elm_menu_item_selected_set()
17167 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17170 * @brief Get the last item in the menu
17172 * @param obj The menu object
17173 * @return The last item, or NULL if none
17175 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17178 * @brief Get the first item in the menu
17180 * @param obj The menu object
17181 * @return The first item, or NULL if none
17183 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17186 * @brief Get the next item in the menu.
17188 * @param it The menu item object.
17189 * @return The item after it, or NULL if none
17191 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17194 * @brief Get the previous item in the menu.
17196 * @param it The menu item object.
17197 * @return The item before it, or NULL if none
17199 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17206 * @defgroup List List
17207 * @ingroup Elementary
17209 * @image html img/widget/list/preview-00.png
17210 * @image latex img/widget/list/preview-00.eps width=\textwidth
17212 * @image html img/list.png
17213 * @image latex img/list.eps width=\textwidth
17215 * A list widget is a container whose children are displayed vertically or
17216 * horizontally, in order, and can be selected.
17217 * The list can accept only one or multiple items selection. Also has many
17218 * modes of items displaying.
17220 * A list is a very simple type of list widget. For more robust
17221 * lists, @ref Genlist should probably be used.
17223 * Smart callbacks one can listen to:
17224 * - @c "activated" - The user has double-clicked or pressed
17225 * (enter|return|spacebar) on an item. The @c event_info parameter
17226 * is the item that was activated.
17227 * - @c "clicked,double" - The user has double-clicked an item.
17228 * The @c event_info parameter is the item that was double-clicked.
17229 * - "selected" - when the user selected an item
17230 * - "unselected" - when the user unselected an item
17231 * - "longpressed" - an item in the list is long-pressed
17232 * - "edge,top" - the list is scrolled until the top edge
17233 * - "edge,bottom" - the list is scrolled until the bottom edge
17234 * - "edge,left" - the list is scrolled until the left edge
17235 * - "edge,right" - the list is scrolled until the right edge
17236 * - "language,changed" - the program's language changed
17238 * Available styles for it:
17241 * List of examples:
17242 * @li @ref list_example_01
17243 * @li @ref list_example_02
17244 * @li @ref list_example_03
17253 * @enum _Elm_List_Mode
17254 * @typedef Elm_List_Mode
17256 * Set list's resize behavior, transverse axis scroll and
17257 * items cropping. See each mode's description for more details.
17259 * @note Default value is #ELM_LIST_SCROLL.
17261 * Values <b> don't </b> work as bitmask, only one can be choosen.
17263 * @see elm_list_mode_set()
17264 * @see elm_list_mode_get()
17268 typedef enum _Elm_List_Mode
17270 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. */
17271 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). */
17272 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. */
17273 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. */
17274 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
17277 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(). */
17280 * Add a new list widget to the given parent Elementary
17281 * (container) object.
17283 * @param parent The parent object.
17284 * @return a new list widget handle or @c NULL, on errors.
17286 * This function inserts a new list widget on the canvas.
17290 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17295 * @param obj The list object
17297 * @note Call before running show() on the list object.
17298 * @warning If not called, it won't display the list properly.
17301 * li = elm_list_add(win);
17302 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
17303 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
17305 * evas_object_show(li);
17310 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
17313 * Enable or disable multiple items selection on the list object.
17315 * @param obj The list object
17316 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
17319 * Disabled by default. If disabled, the user can select a single item of
17320 * the list each time. Selected items are highlighted on list.
17321 * If enabled, many items can be selected.
17323 * If a selected item is selected again, it will be unselected.
17325 * @see elm_list_multi_select_get()
17329 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17332 * Get a value whether multiple items selection is enabled or not.
17334 * @see elm_list_multi_select_set() for details.
17336 * @param obj The list object.
17337 * @return @c EINA_TRUE means multiple items selection is enabled.
17338 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17339 * @c EINA_FALSE is returned.
17343 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17346 * Set which mode to use for the list object.
17348 * @param obj The list object
17349 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17350 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
17352 * Set list's resize behavior, transverse axis scroll and
17353 * items cropping. See each mode's description for more details.
17355 * @note Default value is #ELM_LIST_SCROLL.
17357 * Only one can be set, if a previous one was set, it will be changed
17358 * by the new mode set. Bitmask won't work as well.
17360 * @see elm_list_mode_get()
17364 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17367 * Get the mode the list is at.
17369 * @param obj The list object
17370 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17371 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
17373 * @note see elm_list_mode_set() for more information.
17377 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17380 * Enable or disable horizontal mode on the list object.
17382 * @param obj The list object.
17383 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
17384 * disable it, i.e., to enable vertical mode.
17386 * @note Vertical mode is set by default.
17388 * On horizontal mode items are displayed on list from left to right,
17389 * instead of from top to bottom. Also, the list will scroll horizontally.
17390 * Each item will presents left icon on top and right icon, or end, at
17393 * @see elm_list_horizontal_get()
17397 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17400 * Get a value whether horizontal mode is enabled or not.
17402 * @param obj The list object.
17403 * @return @c EINA_TRUE means horizontal mode selection is enabled.
17404 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17405 * @c EINA_FALSE is returned.
17407 * @see elm_list_horizontal_set() for details.
17411 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17414 * Enable or disable always select mode on the list object.
17416 * @param obj The list object
17417 * @param always_select @c EINA_TRUE to enable always select mode or
17418 * @c EINA_FALSE to disable it.
17420 * @note Always select mode is disabled by default.
17422 * Default behavior of list items is to only call its callback function
17423 * the first time it's pressed, i.e., when it is selected. If a selected
17424 * item is pressed again, and multi-select is disabled, it won't call
17425 * this function (if multi-select is enabled it will unselect the item).
17427 * If always select is enabled, it will call the callback function
17428 * everytime a item is pressed, so it will call when the item is selected,
17429 * and again when a selected item is pressed.
17431 * @see elm_list_always_select_mode_get()
17432 * @see elm_list_multi_select_set()
17436 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17439 * Get a value whether always select mode is enabled or not, meaning that
17440 * an item will always call its callback function, even if already selected.
17442 * @param obj The list object
17443 * @return @c EINA_TRUE means horizontal mode selection is enabled.
17444 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17445 * @c EINA_FALSE is returned.
17447 * @see elm_list_always_select_mode_set() for details.
17451 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17454 * Set bouncing behaviour when the scrolled content reaches an edge.
17456 * Tell the internal scroller object whether it should bounce or not
17457 * when it reaches the respective edges for each axis.
17459 * @param obj The list object
17460 * @param h_bounce Whether to bounce or not in the horizontal axis.
17461 * @param v_bounce Whether to bounce or not in the vertical axis.
17463 * @see elm_scroller_bounce_set()
17467 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17470 * Get the bouncing behaviour of the internal scroller.
17472 * Get whether the internal scroller should bounce when the edge of each
17473 * axis is reached scrolling.
17475 * @param obj The list object.
17476 * @param h_bounce Pointer where to store the bounce state of the horizontal
17478 * @param v_bounce Pointer where to store the bounce state of the vertical
17481 * @see elm_scroller_bounce_get()
17482 * @see elm_list_bounce_set()
17486 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17489 * Set the scrollbar policy.
17491 * @param obj The list object
17492 * @param policy_h Horizontal scrollbar policy.
17493 * @param policy_v Vertical scrollbar policy.
17495 * This sets the scrollbar visibility policy for the given scroller.
17496 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
17497 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
17498 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
17499 * This applies respectively for the horizontal and vertical scrollbars.
17501 * The both are disabled by default, i.e., are set to
17502 * #ELM_SCROLLER_POLICY_OFF.
17506 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17509 * Get the scrollbar policy.
17511 * @see elm_list_scroller_policy_get() for details.
17513 * @param obj The list object.
17514 * @param policy_h Pointer where to store horizontal scrollbar policy.
17515 * @param policy_v Pointer where to store vertical scrollbar policy.
17519 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);
17522 * Append a new item to the list object.
17524 * @param obj The list object.
17525 * @param label The label of the list item.
17526 * @param icon The icon object to use for the left side of the item. An
17527 * icon can be any Evas object, but usually it is an icon created
17528 * with elm_icon_add().
17529 * @param end The icon object to use for the right side of the item. An
17530 * icon can be any Evas object.
17531 * @param func The function to call when the item is clicked.
17532 * @param data The data to associate with the item for related callbacks.
17534 * @return The created item or @c NULL upon failure.
17536 * A new item will be created and appended to the list, i.e., will
17537 * be set as @b last item.
17539 * Items created with this method can be deleted with
17540 * elm_list_item_del().
17542 * Associated @p data can be properly freed when item is deleted if a
17543 * callback function is set with elm_list_item_del_cb_set().
17545 * If a function is passed as argument, it will be called everytime this item
17546 * is selected, i.e., the user clicks over an unselected item.
17547 * If always select is enabled it will call this function every time
17548 * user clicks over an item (already selected or not).
17549 * If such function isn't needed, just passing
17550 * @c NULL as @p func is enough. The same should be done for @p data.
17552 * Simple example (with no function callback or data associated):
17554 * li = elm_list_add(win);
17555 * ic = elm_icon_add(win);
17556 * elm_icon_file_set(ic, "path/to/image", NULL);
17557 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
17558 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
17560 * evas_object_show(li);
17563 * @see elm_list_always_select_mode_set()
17564 * @see elm_list_item_del()
17565 * @see elm_list_item_del_cb_set()
17566 * @see elm_list_clear()
17567 * @see elm_icon_add()
17571 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);
17574 * Prepend a new item to the list object.
17576 * @param obj The list object.
17577 * @param label The label of the list item.
17578 * @param icon The icon object to use for the left side of the item. An
17579 * icon can be any Evas object, but usually it is an icon created
17580 * with elm_icon_add().
17581 * @param end The icon object to use for the right side of the item. An
17582 * icon can be any Evas object.
17583 * @param func The function to call when the item is clicked.
17584 * @param data The data to associate with the item for related callbacks.
17586 * @return The created item or @c NULL upon failure.
17588 * A new item will be created and prepended to the list, i.e., will
17589 * be set as @b first item.
17591 * Items created with this method can be deleted with
17592 * elm_list_item_del().
17594 * Associated @p data can be properly freed when item is deleted if a
17595 * callback function is set with elm_list_item_del_cb_set().
17597 * If a function is passed as argument, it will be called everytime this item
17598 * is selected, i.e., the user clicks over an unselected item.
17599 * If always select is enabled it will call this function every time
17600 * user clicks over an item (already selected or not).
17601 * If such function isn't needed, just passing
17602 * @c NULL as @p func is enough. The same should be done for @p data.
17604 * @see elm_list_item_append() for a simple code example.
17605 * @see elm_list_always_select_mode_set()
17606 * @see elm_list_item_del()
17607 * @see elm_list_item_del_cb_set()
17608 * @see elm_list_clear()
17609 * @see elm_icon_add()
17613 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);
17616 * Insert a new item into the list object before item @p before.
17618 * @param obj The list object.
17619 * @param before The list item to insert before.
17620 * @param label The label of the list item.
17621 * @param icon The icon object to use for the left side of the item. An
17622 * icon can be any Evas object, but usually it is an icon created
17623 * with elm_icon_add().
17624 * @param end The icon object to use for the right side of the item. An
17625 * icon can be any Evas object.
17626 * @param func The function to call when the item is clicked.
17627 * @param data The data to associate with the item for related callbacks.
17629 * @return The created item or @c NULL upon failure.
17631 * A new item will be created and added to the list. Its position in
17632 * this list will be just before item @p before.
17634 * Items created with this method can be deleted with
17635 * elm_list_item_del().
17637 * Associated @p data can be properly freed when item is deleted if a
17638 * callback function is set with elm_list_item_del_cb_set().
17640 * If a function is passed as argument, it will be called everytime this item
17641 * is selected, i.e., the user clicks over an unselected item.
17642 * If always select is enabled it will call this function every time
17643 * user clicks over an item (already selected or not).
17644 * If such function isn't needed, just passing
17645 * @c NULL as @p func is enough. The same should be done for @p data.
17647 * @see elm_list_item_append() for a simple code example.
17648 * @see elm_list_always_select_mode_set()
17649 * @see elm_list_item_del()
17650 * @see elm_list_item_del_cb_set()
17651 * @see elm_list_clear()
17652 * @see elm_icon_add()
17656 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);
17659 * Insert a new item into the list object after item @p after.
17661 * @param obj The list object.
17662 * @param after The list item to insert after.
17663 * @param label The label of the list item.
17664 * @param icon The icon object to use for the left side of the item. An
17665 * icon can be any Evas object, but usually it is an icon created
17666 * with elm_icon_add().
17667 * @param end The icon object to use for the right side of the item. An
17668 * icon can be any Evas object.
17669 * @param func The function to call when the item is clicked.
17670 * @param data The data to associate with the item for related callbacks.
17672 * @return The created item or @c NULL upon failure.
17674 * A new item will be created and added to the list. Its position in
17675 * this list will be just after item @p after.
17677 * Items created with this method can be deleted with
17678 * elm_list_item_del().
17680 * Associated @p data can be properly freed when item is deleted if a
17681 * callback function is set with elm_list_item_del_cb_set().
17683 * If a function is passed as argument, it will be called everytime this item
17684 * is selected, i.e., the user clicks over an unselected item.
17685 * If always select is enabled it will call this function every time
17686 * user clicks over an item (already selected or not).
17687 * If such function isn't needed, just passing
17688 * @c NULL as @p func is enough. The same should be done for @p data.
17690 * @see elm_list_item_append() for a simple code example.
17691 * @see elm_list_always_select_mode_set()
17692 * @see elm_list_item_del()
17693 * @see elm_list_item_del_cb_set()
17694 * @see elm_list_clear()
17695 * @see elm_icon_add()
17699 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);
17702 * Insert a new item into the sorted list object.
17704 * @param obj The list object.
17705 * @param label The label of the list item.
17706 * @param icon The icon object to use for the left side of the item. An
17707 * icon can be any Evas object, but usually it is an icon created
17708 * with elm_icon_add().
17709 * @param end The icon object to use for the right side of the item. An
17710 * icon can be any Evas object.
17711 * @param func The function to call when the item is clicked.
17712 * @param data The data to associate with the item for related callbacks.
17713 * @param cmp_func The comparing function to be used to sort list
17714 * items <b>by #Elm_List_Item item handles</b>. This function will
17715 * receive two items and compare them, returning a non-negative integer
17716 * if the second item should be place after the first, or negative value
17717 * if should be placed before.
17719 * @return The created item or @c NULL upon failure.
17721 * @note This function inserts values into a list object assuming it was
17722 * sorted and the result will be sorted.
17724 * A new item will be created and added to the list. Its position in
17725 * this list will be found comparing the new item with previously inserted
17726 * items using function @p cmp_func.
17728 * Items created with this method can be deleted with
17729 * elm_list_item_del().
17731 * Associated @p data can be properly freed when item is deleted if a
17732 * callback function is set with elm_list_item_del_cb_set().
17734 * If a function is passed as argument, it will be called everytime this item
17735 * is selected, i.e., the user clicks over an unselected item.
17736 * If always select is enabled it will call this function every time
17737 * user clicks over an item (already selected or not).
17738 * If such function isn't needed, just passing
17739 * @c NULL as @p func is enough. The same should be done for @p data.
17741 * @see elm_list_item_append() for a simple code example.
17742 * @see elm_list_always_select_mode_set()
17743 * @see elm_list_item_del()
17744 * @see elm_list_item_del_cb_set()
17745 * @see elm_list_clear()
17746 * @see elm_icon_add()
17750 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);
17753 * Remove all list's items.
17755 * @param obj The list object
17757 * @see elm_list_item_del()
17758 * @see elm_list_item_append()
17762 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17765 * Get a list of all the list items.
17767 * @param obj The list object
17768 * @return An @c Eina_List of list items, #Elm_List_Item,
17769 * or @c NULL on failure.
17771 * @see elm_list_item_append()
17772 * @see elm_list_item_del()
17773 * @see elm_list_clear()
17777 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17780 * Get the selected item.
17782 * @param obj The list object.
17783 * @return The selected list item.
17785 * The selected item can be unselected with function
17786 * elm_list_item_selected_set().
17788 * The selected item always will be highlighted on list.
17790 * @see elm_list_selected_items_get()
17794 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17797 * Return a list of the currently selected list items.
17799 * @param obj The list object.
17800 * @return An @c Eina_List of list items, #Elm_List_Item,
17801 * or @c NULL on failure.
17803 * Multiple items can be selected if multi select is enabled. It can be
17804 * done with elm_list_multi_select_set().
17806 * @see elm_list_selected_item_get()
17807 * @see elm_list_multi_select_set()
17811 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17814 * Set the selected state of an item.
17816 * @param item The list item
17817 * @param selected The selected state
17819 * This sets the selected state of the given item @p it.
17820 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17822 * If a new item is selected the previosly selected will be unselected,
17823 * unless multiple selection is enabled with elm_list_multi_select_set().
17824 * Previoulsy selected item can be get with function
17825 * elm_list_selected_item_get().
17827 * Selected items will be highlighted.
17829 * @see elm_list_item_selected_get()
17830 * @see elm_list_selected_item_get()
17831 * @see elm_list_multi_select_set()
17835 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17838 * Get whether the @p item is selected or not.
17840 * @param item The list item.
17841 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17842 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17844 * @see elm_list_selected_item_set() for details.
17845 * @see elm_list_item_selected_get()
17849 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17852 * Set or unset item as a separator.
17854 * @param it The list item.
17855 * @param setting @c EINA_TRUE to set item @p it as separator or
17856 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17858 * Items aren't set as separator by default.
17860 * If set as separator it will display separator theme, so won't display
17863 * @see elm_list_item_separator_get()
17867 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17870 * Get a value whether item is a separator or not.
17872 * @see elm_list_item_separator_set() for details.
17874 * @param it The list item.
17875 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17876 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17880 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17883 * Show @p item in the list view.
17885 * @param item The list item to be shown.
17887 * It won't animate list until item is visible. If such behavior is wanted,
17888 * use elm_list_bring_in() intead.
17892 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17895 * Bring in the given item to list view.
17897 * @param item The item.
17899 * This causes list to jump to the given item @p item and show it
17900 * (by scrolling), if it is not fully visible.
17902 * This may use animation to do so and take a period of time.
17904 * If animation isn't wanted, elm_list_item_show() can be used.
17908 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17911 * Delete them item from the list.
17913 * @param item The item of list to be deleted.
17915 * If deleting all list items is required, elm_list_clear()
17916 * should be used instead of getting items list and deleting each one.
17918 * @see elm_list_clear()
17919 * @see elm_list_item_append()
17920 * @see elm_list_item_del_cb_set()
17924 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17927 * Set the function called when a list item is freed.
17929 * @param item The item to set the callback on
17930 * @param func The function called
17932 * If there is a @p func, then it will be called prior item's memory release.
17933 * That will be called with the following arguments:
17935 * @li item's Evas object;
17938 * This way, a data associated to a list item could be properly freed.
17942 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17945 * Get the data associated to the item.
17947 * @param item The list item
17948 * @return The data associated to @p item
17950 * The return value is a pointer to data associated to @p item when it was
17951 * created, with function elm_list_item_append() or similar. If no data
17952 * was passed as argument, it will return @c NULL.
17954 * @see elm_list_item_append()
17958 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17961 * Get the left side icon associated to the item.
17963 * @param item The list item
17964 * @return The left side icon associated to @p item
17966 * The return value is a pointer to the icon associated to @p item when
17968 * created, with function elm_list_item_append() or similar, or later
17969 * with function elm_list_item_icon_set(). If no icon
17970 * was passed as argument, it will return @c NULL.
17972 * @see elm_list_item_append()
17973 * @see elm_list_item_icon_set()
17977 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17980 * Set the left side icon associated to the item.
17982 * @param item The list item
17983 * @param icon The left side icon object to associate with @p item
17985 * The icon object to use at left side of the item. An
17986 * icon can be any Evas object, but usually it is an icon created
17987 * with elm_icon_add().
17989 * Once the icon object is set, a previously set one will be deleted.
17990 * @warning Setting the same icon for two items will cause the icon to
17991 * dissapear from the first item.
17993 * If an icon was passed as argument on item creation, with function
17994 * elm_list_item_append() or similar, it will be already
17995 * associated to the item.
17997 * @see elm_list_item_append()
17998 * @see elm_list_item_icon_get()
18002 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
18005 * Get the right side icon associated to the item.
18007 * @param item The list item
18008 * @return The right side icon associated to @p item
18010 * The return value is a pointer to the icon associated to @p item when
18012 * created, with function elm_list_item_append() or similar, or later
18013 * with function elm_list_item_icon_set(). If no icon
18014 * was passed as argument, it will return @c NULL.
18016 * @see elm_list_item_append()
18017 * @see elm_list_item_icon_set()
18021 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18024 * Set the right side icon associated to the item.
18026 * @param item The list item
18027 * @param end The right side icon object to associate with @p item
18029 * The icon object to use at right side of the item. An
18030 * icon can be any Evas object, but usually it is an icon created
18031 * with elm_icon_add().
18033 * Once the icon object is set, a previously set one will be deleted.
18034 * @warning Setting the same icon for two items will cause the icon to
18035 * dissapear from the first item.
18037 * If an icon was passed as argument on item creation, with function
18038 * elm_list_item_append() or similar, it will be already
18039 * associated to the item.
18041 * @see elm_list_item_append()
18042 * @see elm_list_item_end_get()
18046 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
18049 * Gets the base object of the item.
18051 * @param item The list item
18052 * @return The base object associated with @p item
18054 * Base object is the @c Evas_Object that represents that item.
18058 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18059 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18062 * Get the label of item.
18064 * @param item The item of list.
18065 * @return The label of item.
18067 * The return value is a pointer to the label associated to @p item when
18068 * it was created, with function elm_list_item_append(), or later
18069 * with function elm_list_item_label_set. If no label
18070 * was passed as argument, it will return @c NULL.
18072 * @see elm_list_item_label_set() for more details.
18073 * @see elm_list_item_append()
18077 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18080 * Set the label of item.
18082 * @param item The item of list.
18083 * @param text The label of item.
18085 * The label to be displayed by the item.
18086 * Label will be placed between left and right side icons (if set).
18088 * If a label was passed as argument on item creation, with function
18089 * elm_list_item_append() or similar, it will be already
18090 * displayed by the item.
18092 * @see elm_list_item_label_get()
18093 * @see elm_list_item_append()
18097 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18100 * Get the item before @p it in list.
18102 * @param it The list item.
18103 * @return The item before @p it, or @c NULL if none or on failure.
18105 * @note If it is the first item, @c NULL will be returned.
18107 * @see elm_list_item_append()
18108 * @see elm_list_items_get()
18112 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18115 * Get the item after @p it in list.
18117 * @param it The list item.
18118 * @return The item after @p it, or @c NULL if none or on failure.
18120 * @note If it is the last item, @c NULL will be returned.
18122 * @see elm_list_item_append()
18123 * @see elm_list_items_get()
18127 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18130 * Sets the disabled/enabled state of a list item.
18132 * @param it The item.
18133 * @param disabled The disabled state.
18135 * A disabled item cannot be selected or unselected. It will also
18136 * change its appearance (generally greyed out). This sets the
18137 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
18142 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18145 * Get a value whether list item is disabled or not.
18147 * @param it The item.
18148 * @return The disabled state.
18150 * @see elm_list_item_disabled_set() for more details.
18154 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18157 * Set the text to be shown in a given list item's tooltips.
18159 * @param item Target item.
18160 * @param text The text to set in the content.
18162 * Setup the text as tooltip to object. The item can have only one tooltip,
18163 * so any previous tooltip data - set with this function or
18164 * elm_list_item_tooltip_content_cb_set() - is removed.
18166 * @see elm_object_tooltip_text_set() for more details.
18170 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18173 * @brief Disable size restrictions on an object's tooltip
18174 * @param item The tooltip's anchor object
18175 * @param disable If EINA_TRUE, size restrictions are disabled
18176 * @return EINA_FALSE on failure, EINA_TRUE on success
18178 * This function allows a tooltip to expand beyond its parant window's canvas.
18179 * It will instead be limited only by the size of the display.
18181 EAPI Eina_Bool elm_list_item_tooltip_window_mode_set(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
18183 * @brief Retrieve size restriction state of an object's tooltip
18184 * @param obj The tooltip's anchor object
18185 * @return If EINA_TRUE, size restrictions are disabled
18187 * This function returns whether a tooltip is allowed to expand beyond
18188 * its parant window's canvas.
18189 * It will instead be limited only by the size of the display.
18191 EAPI Eina_Bool elm_list_item_tooltip_window_mode_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18194 * Set the content to be shown in the tooltip item.
18196 * Setup the tooltip to item. The item can have only one tooltip,
18197 * so any previous tooltip data is removed. @p func(with @p data) will
18198 * be called every time that need show the tooltip and it should
18199 * return a valid Evas_Object. This object is then managed fully by
18200 * tooltip system and is deleted when the tooltip is gone.
18202 * @param item the list item being attached a tooltip.
18203 * @param func the function used to create the tooltip contents.
18204 * @param data what to provide to @a func as callback data/context.
18205 * @param del_cb called when data is not needed anymore, either when
18206 * another callback replaces @a func, the tooltip is unset with
18207 * elm_list_item_tooltip_unset() or the owner @a item
18208 * dies. This callback receives as the first parameter the
18209 * given @a data, and @c event_info is the item.
18211 * @see elm_object_tooltip_content_cb_set() for more details.
18215 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);
18218 * Unset tooltip from item.
18220 * @param item list item to remove previously set tooltip.
18222 * Remove tooltip from item. The callback provided as del_cb to
18223 * elm_list_item_tooltip_content_cb_set() will be called to notify
18224 * it is not used anymore.
18226 * @see elm_object_tooltip_unset() for more details.
18227 * @see elm_list_item_tooltip_content_cb_set()
18231 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18234 * Sets a different style for this item tooltip.
18236 * @note before you set a style you should define a tooltip with
18237 * elm_list_item_tooltip_content_cb_set() or
18238 * elm_list_item_tooltip_text_set()
18240 * @param item list item with tooltip already set.
18241 * @param style the theme style to use (default, transparent, ...)
18243 * @see elm_object_tooltip_style_set() for more details.
18247 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18250 * Get the style for this item tooltip.
18252 * @param item list item with tooltip already set.
18253 * @return style the theme style in use, defaults to "default". If the
18254 * object does not have a tooltip set, then NULL is returned.
18256 * @see elm_object_tooltip_style_get() for more details.
18257 * @see elm_list_item_tooltip_style_set()
18261 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18264 * Set the type of mouse pointer/cursor decoration to be shown,
18265 * when the mouse pointer is over the given list widget item
18267 * @param item list item to customize cursor on
18268 * @param cursor the cursor type's name
18270 * This function works analogously as elm_object_cursor_set(), but
18271 * here the cursor's changing area is restricted to the item's
18272 * area, and not the whole widget's. Note that that item cursors
18273 * have precedence over widget cursors, so that a mouse over an
18274 * item with custom cursor set will always show @b that cursor.
18276 * If this function is called twice for an object, a previously set
18277 * cursor will be unset on the second call.
18279 * @see elm_object_cursor_set()
18280 * @see elm_list_item_cursor_get()
18281 * @see elm_list_item_cursor_unset()
18285 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18288 * Get the type of mouse pointer/cursor decoration set to be shown,
18289 * when the mouse pointer is over the given list widget item
18291 * @param item list item with custom cursor set
18292 * @return the cursor type's name or @c NULL, if no custom cursors
18293 * were set to @p item (and on errors)
18295 * @see elm_object_cursor_get()
18296 * @see elm_list_item_cursor_set()
18297 * @see elm_list_item_cursor_unset()
18301 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18304 * Unset any custom mouse pointer/cursor decoration set to be
18305 * shown, when the mouse pointer is over the given list widget
18306 * item, thus making it show the @b default cursor again.
18308 * @param item a list item
18310 * Use this call to undo any custom settings on this item's cursor
18311 * decoration, bringing it back to defaults (no custom style set).
18313 * @see elm_object_cursor_unset()
18314 * @see elm_list_item_cursor_set()
18318 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18321 * Set a different @b style for a given custom cursor set for a
18324 * @param item list item with custom cursor set
18325 * @param style the <b>theme style</b> to use (e.g. @c "default",
18326 * @c "transparent", etc)
18328 * This function only makes sense when one is using custom mouse
18329 * cursor decorations <b>defined in a theme file</b>, which can have,
18330 * given a cursor name/type, <b>alternate styles</b> on it. It
18331 * works analogously as elm_object_cursor_style_set(), but here
18332 * applyed only to list item objects.
18334 * @warning Before you set a cursor style you should have definen a
18335 * custom cursor previously on the item, with
18336 * elm_list_item_cursor_set()
18338 * @see elm_list_item_cursor_engine_only_set()
18339 * @see elm_list_item_cursor_style_get()
18343 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18346 * Get the current @b style set for a given list item's custom
18349 * @param item list item with custom cursor set.
18350 * @return style the cursor style in use. If the object does not
18351 * have a cursor set, then @c NULL is returned.
18353 * @see elm_list_item_cursor_style_set() for more details
18357 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18360 * Set if the (custom)cursor for a given list item should be
18361 * searched in its theme, also, or should only rely on the
18362 * rendering engine.
18364 * @param item item with custom (custom) cursor already set on
18365 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18366 * only on those provided by the rendering engine, @c EINA_FALSE to
18367 * have them searched on the widget's theme, as well.
18369 * @note This call is of use only if you've set a custom cursor
18370 * for list items, with elm_list_item_cursor_set().
18372 * @note By default, cursors will only be looked for between those
18373 * provided by the rendering engine.
18377 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18380 * Get if the (custom) cursor for a given list item is being
18381 * searched in its theme, also, or is only relying on the rendering
18384 * @param item a list item
18385 * @return @c EINA_TRUE, if cursors are being looked for only on
18386 * those provided by the rendering engine, @c EINA_FALSE if they
18387 * are being searched on the widget's theme, as well.
18389 * @see elm_list_item_cursor_engine_only_set(), for more details
18393 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18400 * @defgroup Slider Slider
18401 * @ingroup Elementary
18403 * @image html img/widget/slider/preview-00.png
18404 * @image latex img/widget/slider/preview-00.eps width=\textwidth
18406 * The slider adds a dragable āsliderā widget for selecting the value of
18407 * something within a range.
18409 * A slider can be horizontal or vertical. It can contain an Icon and has a
18410 * primary label as well as a units label (that is formatted with floating
18411 * point values and thus accepts a printf-style format string, like
18412 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
18413 * else (like on the slider itself) that also accepts a format string like
18414 * units. Label, Icon Unit and Indicator strings/objects are optional.
18416 * A slider may be inverted which means values invert, with high vales being
18417 * on the left or top and low values on the right or bottom (as opposed to
18418 * normally being low on the left or top and high on the bottom and right).
18420 * The slider should have its minimum and maximum values set by the
18421 * application with elm_slider_min_max_set() and value should also be set by
18422 * the application before use with elm_slider_value_set(). The span of the
18423 * slider is its length (horizontally or vertically). This will be scaled by
18424 * the object or applications scaling factor. At any point code can query the
18425 * slider for its value with elm_slider_value_get().
18427 * Smart callbacks one can listen to:
18428 * - "changed" - Whenever the slider value is changed by the user.
18429 * - "slider,drag,start" - dragging the slider indicator around has started.
18430 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
18431 * - "delay,changed" - A short time after the value is changed by the user.
18432 * This will be called only when the user stops dragging for
18433 * a very short period or when they release their
18434 * finger/mouse, so it avoids possibly expensive reactions to
18435 * the value change.
18437 * Available styles for it:
18440 * Default contents parts of the slider widget that you can use for are:
18441 * @li "icon" - An icon of the slider
18442 * @li "end" - A end part content of the slider
18444 * Default text parts of the silder widget that you can use for are:
18445 * @li "default" - Label of the silder
18446 * Here is an example on its usage:
18447 * @li @ref slider_example
18451 * @addtogroup Slider
18456 * Add a new slider widget to the given parent Elementary
18457 * (container) object.
18459 * @param parent The parent object.
18460 * @return a new slider widget handle or @c NULL, on errors.
18462 * This function inserts a new slider widget on the canvas.
18466 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18469 * Set the label of a given slider widget
18471 * @param obj The progress bar object
18472 * @param label The text label string, in UTF-8
18475 * @deprecated use elm_object_text_set() instead.
18477 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18480 * Get the label of a given slider widget
18482 * @param obj The progressbar object
18483 * @return The text label string, in UTF-8
18486 * @deprecated use elm_object_text_get() instead.
18488 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18491 * Set the icon object of the slider object.
18493 * @param obj The slider object.
18494 * @param icon The icon object.
18496 * On horizontal mode, icon is placed at left, and on vertical mode,
18499 * @note Once the icon object is set, a previously set one will be deleted.
18500 * If you want to keep that old content object, use the
18501 * elm_slider_icon_unset() function.
18503 * @warning If the object being set does not have minimum size hints set,
18504 * it won't get properly displayed.
18507 * @deprecated use elm_object_part_content_set() instead.
18509 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18512 * Unset an icon set on a given slider widget.
18514 * @param obj The slider object.
18515 * @return The icon object that was being used, if any was set, or
18516 * @c NULL, otherwise (and on errors).
18518 * On horizontal mode, icon is placed at left, and on vertical mode,
18521 * This call will unparent and return the icon object which was set
18522 * for this widget, previously, on success.
18524 * @see elm_slider_icon_set() for more details
18525 * @see elm_slider_icon_get()
18526 * @deprecated use elm_object_part_content_unset() instead.
18530 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18533 * Retrieve the icon object set for a given slider widget.
18535 * @param obj The slider object.
18536 * @return The icon object's handle, if @p obj had one set, or @c NULL,
18537 * otherwise (and on errors).
18539 * On horizontal mode, icon is placed at left, and on vertical mode,
18542 * @see elm_slider_icon_set() for more details
18543 * @see elm_slider_icon_unset()
18545 * @deprecated use elm_object_part_content_get() instead.
18549 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18552 * Set the end object of the slider object.
18554 * @param obj The slider object.
18555 * @param end The end object.
18557 * On horizontal mode, end is placed at left, and on vertical mode,
18558 * placed at bottom.
18560 * @note Once the icon object is set, a previously set one will be deleted.
18561 * If you want to keep that old content object, use the
18562 * elm_slider_end_unset() function.
18564 * @warning If the object being set does not have minimum size hints set,
18565 * it won't get properly displayed.
18567 * @deprecated use elm_object_part_content_set() instead.
18571 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
18574 * Unset an end object set on a given slider widget.
18576 * @param obj The slider object.
18577 * @return The end object that was being used, if any was set, or
18578 * @c NULL, otherwise (and on errors).
18580 * On horizontal mode, end is placed at left, and on vertical mode,
18581 * placed at bottom.
18583 * This call will unparent and return the icon object which was set
18584 * for this widget, previously, on success.
18586 * @see elm_slider_end_set() for more details.
18587 * @see elm_slider_end_get()
18589 * @deprecated use elm_object_part_content_unset() instead
18594 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18597 * Retrieve the end object set for a given slider widget.
18599 * @param obj The slider object.
18600 * @return The end object's handle, if @p obj had one set, or @c NULL,
18601 * otherwise (and on errors).
18603 * On horizontal mode, icon is placed at right, and on vertical mode,
18604 * placed at bottom.
18606 * @see elm_slider_end_set() for more details.
18607 * @see elm_slider_end_unset()
18610 * @deprecated use elm_object_part_content_get() instead
18615 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18618 * Set the (exact) length of the bar region of a given slider widget.
18620 * @param obj The slider object.
18621 * @param size The length of the slider's bar region.
18623 * This sets the minimum width (when in horizontal mode) or height
18624 * (when in vertical mode) of the actual bar area of the slider
18625 * @p obj. This in turn affects the object's minimum size. Use
18626 * this when you're not setting other size hints expanding on the
18627 * given direction (like weight and alignment hints) and you would
18628 * like it to have a specific size.
18630 * @note Icon, end, label, indicator and unit text around @p obj
18631 * will require their
18632 * own space, which will make @p obj to require more the @p size,
18635 * @see elm_slider_span_size_get()
18639 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
18642 * Get the length set for the bar region of a given slider widget
18644 * @param obj The slider object.
18645 * @return The length of the slider's bar region.
18647 * If that size was not set previously, with
18648 * elm_slider_span_size_set(), this call will return @c 0.
18652 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18655 * Set the format string for the unit label.
18657 * @param obj The slider object.
18658 * @param format The format string for the unit display.
18660 * Unit label is displayed all the time, if set, after slider's bar.
18661 * In horizontal mode, at right and in vertical mode, at bottom.
18663 * If @c NULL, unit label won't be visible. If not it sets the format
18664 * string for the label text. To the label text is provided a floating point
18665 * value, so the label text can display up to 1 floating point value.
18666 * Note that this is optional.
18668 * Use a format string such as "%1.2f meters" for example, and it will
18669 * display values like: "3.14 meters" for a value equal to 3.14159.
18671 * Default is unit label disabled.
18673 * @see elm_slider_indicator_format_get()
18677 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18680 * Get the unit label format of the slider.
18682 * @param obj The slider object.
18683 * @return The unit label format string in UTF-8.
18685 * Unit label is displayed all the time, if set, after slider's bar.
18686 * In horizontal mode, at right and in vertical mode, at bottom.
18688 * @see elm_slider_unit_format_set() for more
18689 * information on how this works.
18693 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18696 * Set the format string for the indicator label.
18698 * @param obj The slider object.
18699 * @param indicator The format string for the indicator display.
18701 * The slider may display its value somewhere else then unit label,
18702 * for example, above the slider knob that is dragged around. This function
18703 * sets the format string used for this.
18705 * If @c NULL, indicator label won't be visible. If not it sets the format
18706 * string for the label text. To the label text is provided a floating point
18707 * value, so the label text can display up to 1 floating point value.
18708 * Note that this is optional.
18710 * Use a format string such as "%1.2f meters" for example, and it will
18711 * display values like: "3.14 meters" for a value equal to 3.14159.
18713 * Default is indicator label disabled.
18715 * @see elm_slider_indicator_format_get()
18719 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18722 * Get the indicator label format of the slider.
18724 * @param obj The slider object.
18725 * @return The indicator label format string in UTF-8.
18727 * The slider may display its value somewhere else then unit label,
18728 * for example, above the slider knob that is dragged around. This function
18729 * gets the format string used for this.
18731 * @see elm_slider_indicator_format_set() for more
18732 * information on how this works.
18736 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18739 * Set the format function pointer for the indicator label
18741 * @param obj The slider object.
18742 * @param func The indicator format function.
18743 * @param free_func The freeing function for the format string.
18745 * Set the callback function to format the indicator string.
18747 * @see elm_slider_indicator_format_set() for more info on how this works.
18751 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);
18754 * Set the format function pointer for the units label
18756 * @param obj The slider object.
18757 * @param func The units format function.
18758 * @param free_func The freeing function for the format string.
18760 * Set the callback function to format the indicator string.
18762 * @see elm_slider_units_format_set() for more info on how this works.
18766 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);
18769 * Set the orientation of a given slider widget.
18771 * @param obj The slider object.
18772 * @param horizontal Use @c EINA_TRUE to make @p obj to be
18773 * @b horizontal, @c EINA_FALSE to make it @b vertical.
18775 * Use this function to change how your slider is to be
18776 * disposed: vertically or horizontally.
18778 * By default it's displayed horizontally.
18780 * @see elm_slider_horizontal_get()
18784 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18787 * Retrieve the orientation of a given slider widget
18789 * @param obj The slider object.
18790 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18791 * @c EINA_FALSE if it's @b vertical (and on errors).
18793 * @see elm_slider_horizontal_set() for more details.
18797 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18800 * Set the minimum and maximum values for the slider.
18802 * @param obj The slider object.
18803 * @param min The minimum value.
18804 * @param max The maximum value.
18806 * Define the allowed range of values to be selected by the user.
18808 * If actual value is less than @p min, it will be updated to @p min. If it
18809 * is bigger then @p max, will be updated to @p max. Actual value can be
18810 * get with elm_slider_value_get().
18812 * By default, min is equal to 0.0, and max is equal to 1.0.
18814 * @warning Maximum must be greater than minimum, otherwise behavior
18817 * @see elm_slider_min_max_get()
18821 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18824 * Get the minimum and maximum values of the slider.
18826 * @param obj The slider object.
18827 * @param min Pointer where to store the minimum value.
18828 * @param max Pointer where to store the maximum value.
18830 * @note If only one value is needed, the other pointer can be passed
18833 * @see elm_slider_min_max_set() for details.
18837 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18840 * Set the value the slider displays.
18842 * @param obj The slider object.
18843 * @param val The value to be displayed.
18845 * Value will be presented on the unit label following format specified with
18846 * elm_slider_unit_format_set() and on indicator with
18847 * elm_slider_indicator_format_set().
18849 * @warning The value must to be between min and max values. This values
18850 * are set by elm_slider_min_max_set().
18852 * @see elm_slider_value_get()
18853 * @see elm_slider_unit_format_set()
18854 * @see elm_slider_indicator_format_set()
18855 * @see elm_slider_min_max_set()
18859 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18862 * Get the value displayed by the spinner.
18864 * @param obj The spinner object.
18865 * @return The value displayed.
18867 * @see elm_spinner_value_set() for details.
18871 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18874 * Invert a given slider widget's displaying values order
18876 * @param obj The slider object.
18877 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18878 * @c EINA_FALSE to bring it back to default, non-inverted values.
18880 * A slider may be @b inverted, in which state it gets its
18881 * values inverted, with high vales being on the left or top and
18882 * low values on the right or bottom, as opposed to normally have
18883 * the low values on the former and high values on the latter,
18884 * respectively, for horizontal and vertical modes.
18886 * @see elm_slider_inverted_get()
18890 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18893 * Get whether a given slider widget's displaying values are
18896 * @param obj The slider object.
18897 * @return @c EINA_TRUE, if @p obj has inverted values,
18898 * @c EINA_FALSE otherwise (and on errors).
18900 * @see elm_slider_inverted_set() for more details.
18904 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18907 * Set whether to enlarge slider indicator (augmented knob) or not.
18909 * @param obj The slider object.
18910 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18911 * let the knob always at default size.
18913 * By default, indicator will be bigger while dragged by the user.
18915 * @warning It won't display values set with
18916 * elm_slider_indicator_format_set() if you disable indicator.
18920 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18923 * Get whether a given slider widget's enlarging indicator or not.
18925 * @param obj The slider object.
18926 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18927 * @c EINA_FALSE otherwise (and on errors).
18929 * @see elm_slider_indicator_show_set() for details.
18933 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18940 * @addtogroup Actionslider Actionslider
18942 * @image html img/widget/actionslider/preview-00.png
18943 * @image latex img/widget/actionslider/preview-00.eps
18945 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18946 * properties. The user drags and releases the indicator, to choose a label.
18948 * Labels occupy the following positions.
18953 * Positions can be enabled or disabled.
18955 * Magnets can be set on the above positions.
18957 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18959 * @note By default all positions are set as enabled.
18961 * Signals that you can add callbacks for are:
18963 * "selected" - when user selects an enabled position (the label is passed
18966 * "pos_changed" - when the indicator reaches any of the positions("left",
18967 * "right" or "center").
18969 * See an example of actionslider usage @ref actionslider_example_page "here"
18972 typedef enum _Elm_Actionslider_Pos
18974 ELM_ACTIONSLIDER_NONE = 0,
18975 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18976 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18977 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18978 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18979 } Elm_Actionslider_Pos;
18982 * Add a new actionslider to the parent.
18984 * @param parent The parent object
18985 * @return The new actionslider object or NULL if it cannot be created
18987 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18990 * Set actionslider labels.
18992 * @param obj The actionslider object
18993 * @param left_label The label to be set on the left.
18994 * @param center_label The label to be set on the center.
18995 * @param right_label The label to be set on the right.
18996 * @deprecated use elm_object_text_set() instead.
18998 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);
19001 * Get actionslider labels.
19003 * @param obj The actionslider object
19004 * @param left_label A char** to place the left_label of @p obj into.
19005 * @param center_label A char** to place the center_label of @p obj into.
19006 * @param right_label A char** to place the right_label of @p obj into.
19007 * @deprecated use elm_object_text_set() instead.
19009 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);
19012 * Get actionslider selected label.
19014 * @param obj The actionslider object
19015 * @return The selected label
19017 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19020 * Set actionslider indicator position.
19022 * @param obj The actionslider object.
19023 * @param pos The position of the indicator.
19025 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19028 * Get actionslider indicator position.
19030 * @param obj The actionslider object.
19031 * @return The position of the indicator.
19033 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19036 * Set actionslider magnet position. To make multiple positions magnets @c or
19037 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
19039 * @param obj The actionslider object.
19040 * @param pos Bit mask indicating the magnet positions.
19042 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19045 * Get actionslider magnet position.
19047 * @param obj The actionslider object.
19048 * @return The positions with magnet property.
19050 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19053 * Set actionslider enabled position. To set multiple positions as enabled @c or
19054 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
19056 * @note All the positions are enabled by default.
19058 * @param obj The actionslider object.
19059 * @param pos Bit mask indicating the enabled positions.
19061 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19064 * Get actionslider enabled position.
19066 * @param obj The actionslider object.
19067 * @return The enabled positions.
19069 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19072 * Set the label used on the indicator.
19074 * @param obj The actionslider object
19075 * @param label The label to be set on the indicator.
19076 * @deprecated use elm_object_text_set() instead.
19078 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19081 * Get the label used on the indicator object.
19083 * @param obj The actionslider object
19084 * @return The indicator label
19085 * @deprecated use elm_object_text_get() instead.
19087 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
19094 * @defgroup Genlist Genlist
19096 * @image html img/widget/genlist/preview-00.png
19097 * @image latex img/widget/genlist/preview-00.eps
19098 * @image html img/genlist.png
19099 * @image latex img/genlist.eps
19101 * This widget aims to have more expansive list than the simple list in
19102 * Elementary that could have more flexible items and allow many more entries
19103 * while still being fast and low on memory usage. At the same time it was
19104 * also made to be able to do tree structures. But the price to pay is more
19105 * complexity when it comes to usage. If all you want is a simple list with
19106 * icons and a single text, use the normal @ref List object.
19108 * Genlist has a fairly large API, mostly because it's relatively complex,
19109 * trying to be both expansive, powerful and efficient. First we will begin
19110 * an overview on the theory behind genlist.
19112 * @section Genlist_Item_Class Genlist item classes - creating items
19114 * In order to have the ability to add and delete items on the fly, genlist
19115 * implements a class (callback) system where the application provides a
19116 * structure with information about that type of item (genlist may contain
19117 * multiple different items with different classes, states and styles).
19118 * Genlist will call the functions in this struct (methods) when an item is
19119 * "realized" (i.e., created dynamically, while the user is scrolling the
19120 * grid). All objects will simply be deleted when no longer needed with
19121 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
19122 * following members:
19123 * - @c item_style - This is a constant string and simply defines the name
19124 * of the item style. It @b must be specified and the default should be @c
19127 * - @c func - A struct with pointers to functions that will be called when
19128 * an item is going to be actually created. All of them receive a @c data
19129 * parameter that will point to the same data passed to
19130 * elm_genlist_item_append() and related item creation functions, and a @c
19131 * obj parameter that points to the genlist object itself.
19133 * The function pointers inside @c func are @c text_get, @c content_get, @c
19134 * state_get and @c del. The 3 first functions also receive a @c part
19135 * parameter described below. A brief description of these functions follows:
19137 * - @c text_get - The @c part parameter is the name string of one of the
19138 * existing text parts in the Edje group implementing the item's theme.
19139 * This function @b must return a strdup'()ed string, as the caller will
19140 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
19141 * - @c content_get - The @c part parameter is the name string of one of the
19142 * existing (content) swallow parts in the Edje group implementing the item's
19143 * theme. It must return @c NULL, when no content is desired, or a valid
19144 * object handle, otherwise. The object will be deleted by the genlist on
19145 * its deletion or when the item is "unrealized". See
19146 * #Elm_Genlist_Item_Content_Get_Cb.
19147 * - @c func.state_get - The @c part parameter is the name string of one of
19148 * the state parts in the Edje group implementing the item's theme. Return
19149 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
19150 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
19151 * and @c "elm" as "emission" and "source" arguments, respectively, when
19152 * the state is true (the default is false), where @c XXX is the name of
19153 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
19154 * - @c func.del - This is intended for use when genlist items are deleted,
19155 * so any data attached to the item (e.g. its data parameter on creation)
19156 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
19158 * available item styles:
19160 * - default_style - The text part is a textblock
19162 * @image html img/widget/genlist/preview-04.png
19163 * @image latex img/widget/genlist/preview-04.eps
19167 * @image html img/widget/genlist/preview-01.png
19168 * @image latex img/widget/genlist/preview-01.eps
19170 * - icon_top_text_bottom
19172 * @image html img/widget/genlist/preview-02.png
19173 * @image latex img/widget/genlist/preview-02.eps
19177 * @image html img/widget/genlist/preview-03.png
19178 * @image latex img/widget/genlist/preview-03.eps
19180 * @section Genlist_Items Structure of items
19182 * An item in a genlist can have 0 or more texts (they can be regular
19183 * text or textblock Evas objects - that's up to the style to determine), 0
19184 * or more contents (which are simply objects swallowed into the genlist item's
19185 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
19186 * behavior left to the user to define. The Edje part names for each of
19187 * these properties will be looked up, in the theme file for the genlist,
19188 * under the Edje (string) data items named @c "labels", @c "contents" and @c
19189 * "states", respectively. For each of those properties, if more than one
19190 * part is provided, they must have names listed separated by spaces in the
19191 * data fields. For the default genlist item theme, we have @b one text
19192 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
19193 * "elm.swallow.end") and @b no state parts.
19195 * A genlist item may be at one of several styles. Elementary provides one
19196 * by default - "default", but this can be extended by system or application
19197 * custom themes/overlays/extensions (see @ref Theme "themes" for more
19200 * @section Genlist_Manipulation Editing and Navigating
19202 * Items can be added by several calls. All of them return a @ref
19203 * Elm_Genlist_Item handle that is an internal member inside the genlist.
19204 * They all take a data parameter that is meant to be used for a handle to
19205 * the applications internal data (eg the struct with the original item
19206 * data). The parent parameter is the parent genlist item this belongs to if
19207 * it is a tree or an indexed group, and NULL if there is no parent. The
19208 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
19209 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
19210 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
19211 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
19212 * is set then this item is group index item that is displayed at the top
19213 * until the next group comes. The func parameter is a convenience callback
19214 * that is called when the item is selected and the data parameter will be
19215 * the func_data parameter, obj be the genlist object and event_info will be
19216 * the genlist item.
19218 * elm_genlist_item_append() adds an item to the end of the list, or if
19219 * there is a parent, to the end of all the child items of the parent.
19220 * elm_genlist_item_prepend() is the same but adds to the beginning of
19221 * the list or children list. elm_genlist_item_insert_before() inserts at
19222 * item before another item and elm_genlist_item_insert_after() inserts after
19223 * the indicated item.
19225 * The application can clear the list with elm_genlist_clear() which deletes
19226 * all the items in the list and elm_genlist_item_del() will delete a specific
19227 * item. elm_genlist_item_subitems_clear() will clear all items that are
19228 * children of the indicated parent item.
19230 * To help inspect list items you can jump to the item at the top of the list
19231 * with elm_genlist_first_item_get() which will return the item pointer, and
19232 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
19233 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
19234 * and previous items respectively relative to the indicated item. Using
19235 * these calls you can walk the entire item list/tree. Note that as a tree
19236 * the items are flattened in the list, so elm_genlist_item_parent_get() will
19237 * let you know which item is the parent (and thus know how to skip them if
19240 * @section Genlist_Muti_Selection Multi-selection
19242 * If the application wants multiple items to be able to be selected,
19243 * elm_genlist_multi_select_set() can enable this. If the list is
19244 * single-selection only (the default), then elm_genlist_selected_item_get()
19245 * will return the selected item, if any, or NULL if none is selected. If the
19246 * list is multi-select then elm_genlist_selected_items_get() will return a
19247 * list (that is only valid as long as no items are modified (added, deleted,
19248 * selected or unselected)).
19250 * @section Genlist_Usage_Hints Usage hints
19252 * There are also convenience functions. elm_genlist_item_genlist_get() will
19253 * return the genlist object the item belongs to. elm_genlist_item_show()
19254 * will make the scroller scroll to show that specific item so its visible.
19255 * elm_genlist_item_data_get() returns the data pointer set by the item
19256 * creation functions.
19258 * If an item changes (state of boolean changes, text or contents change),
19259 * then use elm_genlist_item_update() to have genlist update the item with
19260 * the new state. Genlist will re-realize the item thus call the functions
19261 * in the _Elm_Genlist_Item_Class for that item.
19263 * To programmatically (un)select an item use elm_genlist_item_selected_set().
19264 * To get its selected state use elm_genlist_item_selected_get(). Similarly
19265 * to expand/contract an item and get its expanded state, use
19266 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
19267 * again to make an item disabled (unable to be selected and appear
19268 * differently) use elm_genlist_item_disabled_set() to set this and
19269 * elm_genlist_item_disabled_get() to get the disabled state.
19271 * In general to indicate how the genlist should expand items horizontally to
19272 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
19273 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
19274 * mode means that if items are too wide to fit, the scroller will scroll
19275 * horizontally. Otherwise items are expanded to fill the width of the
19276 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
19277 * to the viewport width and limited to that size. This can be combined with
19278 * a different style that uses edjes' ellipsis feature (cutting text off like
19281 * Items will only call their selection func and callback when first becoming
19282 * selected. Any further clicks will do nothing, unless you enable always
19283 * select with elm_genlist_always_select_mode_set(). This means even if
19284 * selected, every click will make the selected callbacks be called.
19285 * elm_genlist_no_select_mode_set() will turn off the ability to select
19286 * items entirely and they will neither appear selected nor call selected
19287 * callback functions.
19289 * Remember that you can create new styles and add your own theme augmentation
19290 * per application with elm_theme_extension_add(). If you absolutely must
19291 * have a specific style that overrides any theme the user or system sets up
19292 * you can use elm_theme_overlay_add() to add such a file.
19294 * @section Genlist_Implementation Implementation
19296 * Evas tracks every object you create. Every time it processes an event
19297 * (mouse move, down, up etc.) it needs to walk through objects and find out
19298 * what event that affects. Even worse every time it renders display updates,
19299 * in order to just calculate what to re-draw, it needs to walk through many
19300 * many many objects. Thus, the more objects you keep active, the more
19301 * overhead Evas has in just doing its work. It is advisable to keep your
19302 * active objects to the minimum working set you need. Also remember that
19303 * object creation and deletion carries an overhead, so there is a
19304 * middle-ground, which is not easily determined. But don't keep massive lists
19305 * of objects you can't see or use. Genlist does this with list objects. It
19306 * creates and destroys them dynamically as you scroll around. It groups them
19307 * into blocks so it can determine the visibility etc. of a whole block at
19308 * once as opposed to having to walk the whole list. This 2-level list allows
19309 * for very large numbers of items to be in the list (tests have used up to
19310 * 2,000,000 items). Also genlist employs a queue for adding items. As items
19311 * may be different sizes, every item added needs to be calculated as to its
19312 * size and thus this presents a lot of overhead on populating the list, this
19313 * genlist employs a queue. Any item added is queued and spooled off over
19314 * time, actually appearing some time later, so if your list has many members
19315 * you may find it takes a while for them to all appear, with your process
19316 * consuming a lot of CPU while it is busy spooling.
19318 * Genlist also implements a tree structure, but it does so with callbacks to
19319 * the application, with the application filling in tree structures when
19320 * requested (allowing for efficient building of a very deep tree that could
19321 * even be used for file-management). See the above smart signal callbacks for
19324 * @section Genlist_Smart_Events Genlist smart events
19326 * Signals that you can add callbacks for are:
19327 * - @c "activated" - The user has double-clicked or pressed
19328 * (enter|return|spacebar) on an item. The @c event_info parameter is the
19329 * item that was activated.
19330 * - @c "clicked,double" - The user has double-clicked an item. The @c
19331 * event_info parameter is the item that was double-clicked.
19332 * - @c "selected" - This is called when a user has made an item selected.
19333 * The event_info parameter is the genlist item that was selected.
19334 * - @c "unselected" - This is called when a user has made an item
19335 * unselected. The event_info parameter is the genlist item that was
19337 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
19338 * called and the item is now meant to be expanded. The event_info
19339 * parameter is the genlist item that was indicated to expand. It is the
19340 * job of this callback to then fill in the child items.
19341 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
19342 * called and the item is now meant to be contracted. The event_info
19343 * parameter is the genlist item that was indicated to contract. It is the
19344 * job of this callback to then delete the child items.
19345 * - @c "expand,request" - This is called when a user has indicated they want
19346 * to expand a tree branch item. The callback should decide if the item can
19347 * expand (has any children) and then call elm_genlist_item_expanded_set()
19348 * appropriately to set the state. The event_info parameter is the genlist
19349 * item that was indicated to expand.
19350 * - @c "contract,request" - This is called when a user has indicated they
19351 * want to contract a tree branch item. The callback should decide if the
19352 * item can contract (has any children) and then call
19353 * elm_genlist_item_expanded_set() appropriately to set the state. The
19354 * event_info parameter is the genlist item that was indicated to contract.
19355 * - @c "realized" - This is called when the item in the list is created as a
19356 * real evas object. event_info parameter is the genlist item that was
19357 * created. The object may be deleted at any time, so it is up to the
19358 * caller to not use the object pointer from elm_genlist_item_object_get()
19359 * in a way where it may point to freed objects.
19360 * - @c "unrealized" - This is called just before an item is unrealized.
19361 * After this call content objects provided will be deleted and the item
19362 * object itself delete or be put into a floating cache.
19363 * - @c "drag,start,up" - This is called when the item in the list has been
19364 * dragged (not scrolled) up.
19365 * - @c "drag,start,down" - This is called when the item in the list has been
19366 * dragged (not scrolled) down.
19367 * - @c "drag,start,left" - This is called when the item in the list has been
19368 * dragged (not scrolled) left.
19369 * - @c "drag,start,right" - This is called when the item in the list has
19370 * been dragged (not scrolled) right.
19371 * - @c "drag,stop" - This is called when the item in the list has stopped
19373 * - @c "drag" - This is called when the item in the list is being dragged.
19374 * - @c "longpressed" - This is called when the item is pressed for a certain
19375 * amount of time. By default it's 1 second.
19376 * - @c "scroll,anim,start" - This is called when scrolling animation has
19378 * - @c "scroll,anim,stop" - This is called when scrolling animation has
19380 * - @c "scroll,drag,start" - This is called when dragging the content has
19382 * - @c "scroll,drag,stop" - This is called when dragging the content has
19384 * - @c "edge,top" - This is called when the genlist is scrolled until
19386 * - @c "edge,bottom" - This is called when the genlist is scrolled
19387 * until the bottom edge.
19388 * - @c "edge,left" - This is called when the genlist is scrolled
19389 * until the left edge.
19390 * - @c "edge,right" - This is called when the genlist is scrolled
19391 * until the right edge.
19392 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
19394 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
19396 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
19398 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
19400 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
19401 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
19402 * multi-touch pinched in.
19403 * - @c "swipe" - This is called when the genlist is swiped.
19404 * - @c "moved" - This is called when a genlist item is moved.
19405 * - @c "language,changed" - This is called when the program's language is
19408 * @section Genlist_Examples Examples
19410 * Here is a list of examples that use the genlist, trying to show some of
19411 * its capabilities:
19412 * - @ref genlist_example_01
19413 * - @ref genlist_example_02
19414 * - @ref genlist_example_03
19415 * - @ref genlist_example_04
19416 * - @ref genlist_example_05
19420 * @addtogroup Genlist
19425 * @enum _Elm_Genlist_Item_Flags
19426 * @typedef Elm_Genlist_Item_Flags
19428 * Defines if the item is of any special type (has subitems or it's the
19429 * index of a group), or is just a simple item.
19433 typedef enum _Elm_Genlist_Item_Flags
19435 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
19436 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
19437 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
19438 } Elm_Genlist_Item_Flags;
19439 typedef enum _Elm_Genlist_Item_Field_Flags
19441 ELM_GENLIST_ITEM_FIELD_ALL = 0,
19442 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
19443 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
19444 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
19445 } Elm_Genlist_Item_Field_Flags;
19446 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
19447 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
19448 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19449 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19450 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
19453 * Text fetching class function for Elm_Gen_Item_Class.
19454 * @param data The data passed in the item creation function
19455 * @param obj The base widget object
19456 * @param part The part name of the swallow
19457 * @return The allocated (NOT stringshared) string to set as the text
19459 typedef char *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19462 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
19463 * @param data The data passed in the item creation function
19464 * @param obj The base widget object
19465 * @param part The part name of the swallow
19466 * @return The content object to swallow
19468 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19471 * State fetching class function for Elm_Gen_Item_Class.
19472 * @param data The data passed in the item creation function
19473 * @param obj The base widget object
19474 * @param part The part name of the swallow
19475 * @return The hell if I know
19477 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19480 * Deletion class function for Elm_Gen_Item_Class.
19481 * @param data The data passed in the item creation function
19482 * @param obj The base widget object
19484 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
19487 * @struct _Elm_Genlist_Item_Class
19489 * Genlist item class definition structs.
19491 * This struct contains the style and fetching functions that will define the
19492 * contents of each item.
19494 * @see @ref Genlist_Item_Class
19496 struct _Elm_Genlist_Item_Class
19498 const char *item_style; /**< style of this class. */
19499 struct Elm_Genlist_Item_Class_Func
19501 Elm_Genlist_Item_Text_Get_Cb text_get; /**< Text fetching class function for genlist item classes.*/
19502 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
19503 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
19504 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
19507 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
19509 * Add a new genlist widget to the given parent Elementary
19510 * (container) object
19512 * @param parent The parent object
19513 * @return a new genlist widget handle or @c NULL, on errors
19515 * This function inserts a new genlist widget on the canvas.
19517 * @see elm_genlist_item_append()
19518 * @see elm_genlist_item_del()
19519 * @see elm_genlist_clear()
19523 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19526 * Remove all items from a given genlist widget.
19528 * @param obj The genlist object
19530 * This removes (and deletes) all items in @p obj, leaving it empty.
19532 * @see elm_genlist_item_del(), to remove just one item.
19536 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19539 * Enable or disable multi-selection in the genlist
19541 * @param obj The genlist object
19542 * @param multi Multi-select enable/disable. Default is disabled.
19544 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
19545 * the list. This allows more than 1 item to be selected. To retrieve the list
19546 * of selected items, use elm_genlist_selected_items_get().
19548 * @see elm_genlist_selected_items_get()
19549 * @see elm_genlist_multi_select_get()
19553 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
19556 * Gets if multi-selection in genlist is enabled or disabled.
19558 * @param obj The genlist object
19559 * @return Multi-select enabled/disabled
19560 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
19562 * @see elm_genlist_multi_select_set()
19566 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19569 * This sets the horizontal stretching mode.
19571 * @param obj The genlist object
19572 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
19574 * This sets the mode used for sizing items horizontally. Valid modes
19575 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
19576 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
19577 * the scroller will scroll horizontally. Otherwise items are expanded
19578 * to fill the width of the viewport of the scroller. If it is
19579 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
19580 * limited to that size.
19582 * @see elm_genlist_horizontal_get()
19586 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19587 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19590 * Gets the horizontal stretching mode.
19592 * @param obj The genlist object
19593 * @return The mode to use
19594 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
19596 * @see elm_genlist_horizontal_set()
19600 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19601 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19604 * Set the always select mode.
19606 * @param obj The genlist object
19607 * @param always_select The always select mode (@c EINA_TRUE = on, @c
19608 * EINA_FALSE = off). Default is @c EINA_FALSE.
19610 * Items will only call their selection func and callback when first
19611 * becoming selected. Any further clicks will do nothing, unless you
19612 * enable always select with elm_genlist_always_select_mode_set().
19613 * This means that, even if selected, every click will make the selected
19614 * callbacks be called.
19616 * @see elm_genlist_always_select_mode_get()
19620 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
19623 * Get the always select mode.
19625 * @param obj The genlist object
19626 * @return The always select mode
19627 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19629 * @see elm_genlist_always_select_mode_set()
19633 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19636 * Enable/disable the no select mode.
19638 * @param obj The genlist object
19639 * @param no_select The no select mode
19640 * (EINA_TRUE = on, EINA_FALSE = off)
19642 * This will turn off the ability to select items entirely and they
19643 * will neither appear selected nor call selected callback functions.
19645 * @see elm_genlist_no_select_mode_get()
19649 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
19652 * Gets whether the no select mode is enabled.
19654 * @param obj The genlist object
19655 * @return The no select mode
19656 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19658 * @see elm_genlist_no_select_mode_set()
19662 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19665 * Enable/disable compress mode.
19667 * @param obj The genlist object
19668 * @param compress The compress mode
19669 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
19671 * This will enable the compress mode where items are "compressed"
19672 * horizontally to fit the genlist scrollable viewport width. This is
19673 * special for genlist. Do not rely on
19674 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
19675 * work as genlist needs to handle it specially.
19677 * @see elm_genlist_compress_mode_get()
19681 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
19684 * Get whether the compress mode is enabled.
19686 * @param obj The genlist object
19687 * @return The compress mode
19688 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19690 * @see elm_genlist_compress_mode_set()
19694 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19697 * Enable/disable height-for-width mode.
19699 * @param obj The genlist object
19700 * @param setting The height-for-width mode (@c EINA_TRUE = on,
19701 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19703 * With height-for-width mode the item width will be fixed (restricted
19704 * to a minimum of) to the list width when calculating its size in
19705 * order to allow the height to be calculated based on it. This allows,
19706 * for instance, text block to wrap lines if the Edje part is
19707 * configured with "text.min: 0 1".
19709 * @note This mode will make list resize slower as it will have to
19710 * recalculate every item height again whenever the list width
19713 * @note When height-for-width mode is enabled, it also enables
19714 * compress mode (see elm_genlist_compress_mode_set()) and
19715 * disables homogeneous (see elm_genlist_homogeneous_set()).
19719 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19722 * Get whether the height-for-width mode is enabled.
19724 * @param obj The genlist object
19725 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19730 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19733 * Enable/disable horizontal and vertical bouncing effect.
19735 * @param obj The genlist object
19736 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19737 * EINA_FALSE = off). Default is @c EINA_FALSE.
19738 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19739 * EINA_FALSE = off). Default is @c EINA_TRUE.
19741 * This will enable or disable the scroller bouncing effect for the
19742 * genlist. See elm_scroller_bounce_set() for details.
19744 * @see elm_scroller_bounce_set()
19745 * @see elm_genlist_bounce_get()
19749 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19752 * Get whether the horizontal and vertical bouncing effect is enabled.
19754 * @param obj The genlist object
19755 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19757 * @param v_bounce Pointer to a bool to receive if the bounce vertically
19760 * @see elm_genlist_bounce_set()
19764 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19767 * Enable/disable homogeneous mode.
19769 * @param obj The genlist object
19770 * @param homogeneous Assume the items within the genlist are of the
19771 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19774 * This will enable the homogeneous mode where items are of the same
19775 * height and width so that genlist may do the lazy-loading at its
19776 * maximum (which increases the performance for scrolling the list). This
19777 * implies 'compressed' mode.
19779 * @see elm_genlist_compress_mode_set()
19780 * @see elm_genlist_homogeneous_get()
19784 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19787 * Get whether the homogeneous mode is enabled.
19789 * @param obj The genlist object
19790 * @return Assume the items within the genlist are of the same height
19791 * and width (EINA_TRUE = on, EINA_FALSE = off)
19793 * @see elm_genlist_homogeneous_set()
19797 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19800 * Set the maximum number of items within an item block
19802 * @param obj The genlist object
19803 * @param n Maximum number of items within an item block. Default is 32.
19805 * This will configure the block count to tune to the target with
19806 * particular performance matrix.
19808 * A block of objects will be used to reduce the number of operations due to
19809 * many objects in the screen. It can determine the visibility, or if the
19810 * object has changed, it theme needs to be updated, etc. doing this kind of
19811 * calculation to the entire block, instead of per object.
19813 * The default value for the block count is enough for most lists, so unless
19814 * you know you will have a lot of objects visible in the screen at the same
19815 * time, don't try to change this.
19817 * @see elm_genlist_block_count_get()
19818 * @see @ref Genlist_Implementation
19822 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19825 * Get the maximum number of items within an item block
19827 * @param obj The genlist object
19828 * @return Maximum number of items within an item block
19830 * @see elm_genlist_block_count_set()
19834 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19837 * Set the timeout in seconds for the longpress event.
19839 * @param obj The genlist object
19840 * @param timeout timeout in seconds. Default is 1.
19842 * This option will change how long it takes to send an event "longpressed"
19843 * after the mouse down signal is sent to the list. If this event occurs, no
19844 * "clicked" event will be sent.
19846 * @see elm_genlist_longpress_timeout_set()
19850 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19853 * Get the timeout in seconds for the longpress event.
19855 * @param obj The genlist object
19856 * @return timeout in seconds
19858 * @see elm_genlist_longpress_timeout_get()
19862 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19865 * Append a new item in a given genlist widget.
19867 * @param obj The genlist object
19868 * @param itc The item class for the item
19869 * @param data The item data
19870 * @param parent The parent item, or NULL if none
19871 * @param flags Item flags
19872 * @param func Convenience function called when the item is selected
19873 * @param func_data Data passed to @p func above.
19874 * @return A handle to the item added or @c NULL if not possible
19876 * This adds the given item to the end of the list or the end of
19877 * the children list if the @p parent is given.
19879 * @see elm_genlist_item_prepend()
19880 * @see elm_genlist_item_insert_before()
19881 * @see elm_genlist_item_insert_after()
19882 * @see elm_genlist_item_del()
19886 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);
19889 * Prepend a new item in a given genlist widget.
19891 * @param obj The genlist object
19892 * @param itc The item class for the item
19893 * @param data The item data
19894 * @param parent The parent item, or NULL if none
19895 * @param flags Item flags
19896 * @param func Convenience function called when the item is selected
19897 * @param func_data Data passed to @p func above.
19898 * @return A handle to the item added or NULL if not possible
19900 * This adds an item to the beginning of the list or beginning of the
19901 * children of the parent if given.
19903 * @see elm_genlist_item_append()
19904 * @see elm_genlist_item_insert_before()
19905 * @see elm_genlist_item_insert_after()
19906 * @see elm_genlist_item_del()
19910 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);
19913 * Insert an item before another in a genlist widget
19915 * @param obj The genlist object
19916 * @param itc The item class for the item
19917 * @param data The item data
19918 * @param before The item to place this new one before.
19919 * @param flags Item flags
19920 * @param func Convenience function called when the item is selected
19921 * @param func_data Data passed to @p func above.
19922 * @return A handle to the item added or @c NULL if not possible
19924 * This inserts an item before another in the list. It will be in the
19925 * same tree level or group as the item it is inserted before.
19927 * @see elm_genlist_item_append()
19928 * @see elm_genlist_item_prepend()
19929 * @see elm_genlist_item_insert_after()
19930 * @see elm_genlist_item_del()
19934 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);
19937 * Insert an item after another in a genlist widget
19939 * @param obj The genlist object
19940 * @param itc The item class for the item
19941 * @param data The item data
19942 * @param after The item to place this new one after.
19943 * @param flags Item flags
19944 * @param func Convenience function called when the item is selected
19945 * @param func_data Data passed to @p func above.
19946 * @return A handle to the item added or @c NULL if not possible
19948 * This inserts an item after another in the list. It will be in the
19949 * same tree level or group as the item it is inserted after.
19951 * @see elm_genlist_item_append()
19952 * @see elm_genlist_item_prepend()
19953 * @see elm_genlist_item_insert_before()
19954 * @see elm_genlist_item_del()
19958 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);
19961 * Insert a new item into the sorted genlist object
19963 * @param obj The genlist object
19964 * @param itc The item class for the item
19965 * @param data The item data
19966 * @param parent The parent item, or NULL if none
19967 * @param flags Item flags
19968 * @param comp The function called for the sort
19969 * @param func Convenience function called when item selected
19970 * @param func_data Data passed to @p func above.
19971 * @return A handle to the item added or NULL if not possible
19975 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);
19976 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);
19978 /* operations to retrieve existing items */
19980 * Get the selectd item in the genlist.
19982 * @param obj The genlist object
19983 * @return The selected item, or NULL if none is selected.
19985 * This gets the selected item in the list (if multi-selection is enabled, only
19986 * the item that was first selected in the list is returned - which is not very
19987 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19990 * If no item is selected, NULL is returned.
19992 * @see elm_genlist_selected_items_get()
19996 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19999 * Get a list of selected items in the genlist.
20001 * @param obj The genlist object
20002 * @return The list of selected items, or NULL if none are selected.
20004 * It returns a list of the selected items. This list pointer is only valid so
20005 * long as the selection doesn't change (no items are selected or unselected, or
20006 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
20007 * pointers. The order of the items in this list is the order which they were
20008 * selected, i.e. the first item in this list is the first item that was
20009 * selected, and so on.
20011 * @note If not in multi-select mode, consider using function
20012 * elm_genlist_selected_item_get() instead.
20014 * @see elm_genlist_multi_select_set()
20015 * @see elm_genlist_selected_item_get()
20019 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20022 * Get the mode item style of items in the genlist
20023 * @param obj The genlist object
20024 * @return The mode item style string, or NULL if none is specified
20026 * This is a constant string and simply defines the name of the
20027 * style that will be used for mode animations. It can be
20028 * @c NULL if you don't plan to use Genlist mode. See
20029 * elm_genlist_item_mode_set() for more info.
20033 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20036 * Set the mode item style of items in the genlist
20037 * @param obj The genlist object
20038 * @param style The mode item style string, or NULL if none is desired
20040 * This is a constant string and simply defines the name of the
20041 * style that will be used for mode animations. It can be
20042 * @c NULL if you don't plan to use Genlist mode. See
20043 * elm_genlist_item_mode_set() for more info.
20047 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
20050 * Get a list of realized items in genlist
20052 * @param obj The genlist object
20053 * @return The list of realized items, nor NULL if none are realized.
20055 * This returns a list of the realized items in the genlist. The list
20056 * contains Elm_Genlist_Item pointers. The list must be freed by the
20057 * caller when done with eina_list_free(). The item pointers in the
20058 * list are only valid so long as those items are not deleted or the
20059 * genlist is not deleted.
20061 * @see elm_genlist_realized_items_update()
20065 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20068 * Get the item that is at the x, y canvas coords.
20070 * @param obj The gelinst object.
20071 * @param x The input x coordinate
20072 * @param y The input y coordinate
20073 * @param posret The position relative to the item returned here
20074 * @return The item at the coordinates or NULL if none
20076 * This returns the item at the given coordinates (which are canvas
20077 * relative, not object-relative). If an item is at that coordinate,
20078 * that item handle is returned, and if @p posret is not NULL, the
20079 * integer pointed to is set to a value of -1, 0 or 1, depending if
20080 * the coordinate is on the upper portion of that item (-1), on the
20081 * middle section (0) or on the lower part (1). If NULL is returned as
20082 * an item (no item found there), then posret may indicate -1 or 1
20083 * based if the coordinate is above or below all items respectively in
20088 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);
20091 * Get the first item in the genlist
20093 * This returns the first item in the list.
20095 * @param obj The genlist object
20096 * @return The first item, or NULL if none
20100 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20103 * Get the last item in the genlist
20105 * This returns the last item in the list.
20107 * @return The last item, or NULL if none
20111 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20114 * Set the scrollbar policy
20116 * @param obj The genlist object
20117 * @param policy_h Horizontal scrollbar policy.
20118 * @param policy_v Vertical scrollbar policy.
20120 * This sets the scrollbar visibility policy for the given genlist
20121 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
20122 * made visible if it is needed, and otherwise kept hidden.
20123 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
20124 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
20125 * respectively for the horizontal and vertical scrollbars. Default is
20126 * #ELM_SMART_SCROLLER_POLICY_AUTO
20128 * @see elm_genlist_scroller_policy_get()
20132 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
20135 * Get the scrollbar policy
20137 * @param obj The genlist object
20138 * @param policy_h Pointer to store the horizontal scrollbar policy.
20139 * @param policy_v Pointer to store the vertical scrollbar policy.
20141 * @see elm_genlist_scroller_policy_set()
20145 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);
20148 * Get the @b next item in a genlist widget's internal list of items,
20149 * given a handle to one of those items.
20151 * @param item The genlist item to fetch next from
20152 * @return The item after @p item, or @c NULL if there's none (and
20155 * This returns the item placed after the @p item, on the container
20158 * @see elm_genlist_item_prev_get()
20162 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20165 * Get the @b previous item in a genlist widget's internal list of items,
20166 * given a handle to one of those items.
20168 * @param item The genlist item to fetch previous from
20169 * @return The item before @p item, or @c NULL if there's none (and
20172 * This returns the item placed before the @p item, on the container
20175 * @see elm_genlist_item_next_get()
20179 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20182 * Get the genlist object's handle which contains a given genlist
20185 * @param item The item to fetch the container from
20186 * @return The genlist (parent) object
20188 * This returns the genlist object itself that an item belongs to.
20192 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20195 * Get the parent item of the given item
20197 * @param it The item
20198 * @return The parent of the item or @c NULL if it has no parent.
20200 * This returns the item that was specified as parent of the item @p it on
20201 * elm_genlist_item_append() and insertion related functions.
20205 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20208 * Remove all sub-items (children) of the given item
20210 * @param it The item
20212 * This removes all items that are children (and their descendants) of the
20213 * given item @p it.
20215 * @see elm_genlist_clear()
20216 * @see elm_genlist_item_del()
20220 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20223 * Set whether a given genlist item is selected or not
20225 * @param it The item
20226 * @param selected Use @c EINA_TRUE, to make it selected, @c
20227 * EINA_FALSE to make it unselected
20229 * This sets the selected state of an item. If multi selection is
20230 * not enabled on the containing genlist and @p selected is @c
20231 * EINA_TRUE, any other previously selected items will get
20232 * unselected in favor of this new one.
20234 * @see elm_genlist_item_selected_get()
20238 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20241 * Get whether a given genlist item is selected or not
20243 * @param it The item
20244 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20246 * @see elm_genlist_item_selected_set() for more details
20250 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20253 * Sets the expanded state of an item.
20255 * @param it The item
20256 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
20258 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
20261 * The theme will respond to this change visually, and a signal "expanded" or
20262 * "contracted" will be sent from the genlist with a pointer to the item that
20263 * has been expanded/contracted.
20265 * Calling this function won't show or hide any child of this item (if it is
20266 * a parent). You must manually delete and create them on the callbacks fo
20267 * the "expanded" or "contracted" signals.
20269 * @see elm_genlist_item_expanded_get()
20273 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
20276 * Get the expanded state of an item
20278 * @param it The item
20279 * @return The expanded state
20281 * This gets the expanded state of an item.
20283 * @see elm_genlist_item_expanded_set()
20287 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20290 * Get the depth of expanded item
20292 * @param it The genlist item object
20293 * @return The depth of expanded item
20297 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20300 * Set whether a given genlist item is disabled or not.
20302 * @param it The item
20303 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
20304 * to enable it back.
20306 * A disabled item cannot be selected or unselected. It will also
20307 * change its appearance, to signal the user it's disabled.
20309 * @see elm_genlist_item_disabled_get()
20313 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20316 * Get whether a given genlist item is disabled or not.
20318 * @param it The item
20319 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
20322 * @see elm_genlist_item_disabled_set() for more details
20326 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20329 * Sets the display only state of an item.
20331 * @param it The item
20332 * @param display_only @c EINA_TRUE if the item is display only, @c
20333 * EINA_FALSE otherwise.
20335 * A display only item cannot be selected or unselected. It is for
20336 * display only and not selecting or otherwise clicking, dragging
20337 * etc. by the user, thus finger size rules will not be applied to
20340 * It's good to set group index items to display only state.
20342 * @see elm_genlist_item_display_only_get()
20346 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
20349 * Get the display only state of an item
20351 * @param it The item
20352 * @return @c EINA_TRUE if the item is display only, @c
20353 * EINA_FALSE otherwise.
20355 * @see elm_genlist_item_display_only_set()
20359 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20362 * Show the portion of a genlist's internal list containing a given
20363 * item, immediately.
20365 * @param it The item to display
20367 * This causes genlist to jump to the given item @p it and show it (by
20368 * immediately scrolling to that position), if it is not fully visible.
20370 * @see elm_genlist_item_bring_in()
20371 * @see elm_genlist_item_top_show()
20372 * @see elm_genlist_item_middle_show()
20376 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20379 * Animatedly bring in, to the visible are of a genlist, a given
20382 * @param it The item to display
20384 * This causes genlist to jump to the given item @p it and show it (by
20385 * animatedly scrolling), if it is not fully visible. This may use animation
20386 * to do so and take a period of time
20388 * @see elm_genlist_item_show()
20389 * @see elm_genlist_item_top_bring_in()
20390 * @see elm_genlist_item_middle_bring_in()
20394 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20397 * Show the portion of a genlist's internal list containing a given
20398 * item, immediately.
20400 * @param it The item to display
20402 * This causes genlist to jump to the given item @p it and show it (by
20403 * immediately scrolling to that position), if it is not fully visible.
20405 * The item will be positioned at the top of the genlist viewport.
20407 * @see elm_genlist_item_show()
20408 * @see elm_genlist_item_top_bring_in()
20412 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20415 * Animatedly bring in, to the visible are of a genlist, a given
20418 * @param it The item
20420 * This causes genlist to jump to the given item @p it and show it (by
20421 * animatedly scrolling), if it is not fully visible. This may use animation
20422 * to do so and take a period of time
20424 * The item will be positioned at the top of the genlist viewport.
20426 * @see elm_genlist_item_bring_in()
20427 * @see elm_genlist_item_top_show()
20431 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20434 * Show the portion of a genlist's internal list containing a given
20435 * item, immediately.
20437 * @param it The item to display
20439 * This causes genlist to jump to the given item @p it and show it (by
20440 * immediately scrolling to that position), if it is not fully visible.
20442 * The item will be positioned at the middle of the genlist viewport.
20444 * @see elm_genlist_item_show()
20445 * @see elm_genlist_item_middle_bring_in()
20449 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20452 * Animatedly bring in, to the visible are of a genlist, a given
20455 * @param it The item
20457 * This causes genlist to jump to the given item @p it and show it (by
20458 * animatedly scrolling), if it is not fully visible. This may use animation
20459 * to do so and take a period of time
20461 * The item will be positioned at the middle of the genlist viewport.
20463 * @see elm_genlist_item_bring_in()
20464 * @see elm_genlist_item_middle_show()
20468 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20471 * Remove a genlist item from the its parent, deleting it.
20473 * @param item The item to be removed.
20474 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
20476 * @see elm_genlist_clear(), to remove all items in a genlist at
20481 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20484 * Return the data associated to a given genlist item
20486 * @param item The genlist item.
20487 * @return the data associated to this item.
20489 * This returns the @c data value passed on the
20490 * elm_genlist_item_append() and related item addition calls.
20492 * @see elm_genlist_item_append()
20493 * @see elm_genlist_item_data_set()
20497 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20500 * Set the data associated to a given genlist item
20502 * @param item The genlist item
20503 * @param data The new data pointer to set on it
20505 * This @b overrides the @c data value passed on the
20506 * elm_genlist_item_append() and related item addition calls. This
20507 * function @b won't call elm_genlist_item_update() automatically,
20508 * so you'd issue it afterwards if you want to hove the item
20509 * updated to reflect the that new data.
20511 * @see elm_genlist_item_data_get()
20515 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
20518 * Tells genlist to "orphan" contents fetchs by the item class
20520 * @param it The item
20522 * This instructs genlist to release references to contents in the item,
20523 * meaning that they will no longer be managed by genlist and are
20524 * floating "orphans" that can be re-used elsewhere if the user wants
20529 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20530 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20533 * Get the real Evas object created to implement the view of a
20534 * given genlist item
20536 * @param item The genlist item.
20537 * @return the Evas object implementing this item's view.
20539 * This returns the actual Evas object used to implement the
20540 * specified genlist item's view. This may be @c NULL, as it may
20541 * not have been created or may have been deleted, at any time, by
20542 * the genlist. <b>Do not modify this object</b> (move, resize,
20543 * show, hide, etc.), as the genlist is controlling it. This
20544 * function is for querying, emitting custom signals or hooking
20545 * lower level callbacks for events on that object. Do not delete
20546 * this object under any circumstances.
20548 * @see elm_genlist_item_data_get()
20552 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20555 * Update the contents of an item
20557 * @param it The item
20559 * This updates an item by calling all the item class functions again
20560 * to get the contents, texts and states. Use this when the original
20561 * item data has changed and the changes are desired to be reflected.
20563 * Use elm_genlist_realized_items_update() to update all already realized
20566 * @see elm_genlist_realized_items_update()
20570 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20573 * Promote an item to the top of the list
20575 * @param it The item
20579 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20582 * Demote an item to the end of the list
20584 * @param it The item
20588 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20591 * Update the part of an item
20593 * @param it The item
20594 * @param parts The name of item's part
20595 * @param itf The flags of item's part type
20597 * This updates an item's part by calling item's fetching functions again
20598 * to get the contents, texts and states. Use this when the original
20599 * item data has changed and the changes are desired to be reflected.
20600 * Second parts argument is used for globbing to match '*', '?', and '.'
20601 * It can be used at updating multi fields.
20603 * Use elm_genlist_realized_items_update() to update an item's all
20606 * @see elm_genlist_item_update()
20610 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
20613 * Update the item class of an item
20615 * @param it The item
20616 * @param itc The item class for the item
20618 * This sets another class fo the item, changing the way that it is
20619 * displayed. After changing the item class, elm_genlist_item_update() is
20620 * called on the item @p it.
20624 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
20625 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20628 * Set the text to be shown in a given genlist item's tooltips.
20630 * @param item The genlist item
20631 * @param text The text to set in the content
20633 * This call will setup the text to be used as tooltip to that item
20634 * (analogous to elm_object_tooltip_text_set(), but being item
20635 * tooltips with higher precedence than object tooltips). It can
20636 * have only one tooltip at a time, so any previous tooltip data
20637 * will get removed.
20639 * In order to set a content or something else as a tooltip, look at
20640 * elm_genlist_item_tooltip_content_cb_set().
20644 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
20647 * Set the content to be shown in a given genlist item's tooltips
20649 * @param item The genlist item.
20650 * @param func The function returning the tooltip contents.
20651 * @param data What to provide to @a func as callback data/context.
20652 * @param del_cb Called when data is not needed anymore, either when
20653 * another callback replaces @p func, the tooltip is unset with
20654 * elm_genlist_item_tooltip_unset() or the owner @p item
20655 * dies. This callback receives as its first parameter the
20656 * given @p data, being @c event_info the item handle.
20658 * This call will setup the tooltip's contents to @p item
20659 * (analogous to elm_object_tooltip_content_cb_set(), but being
20660 * item tooltips with higher precedence than object tooltips). It
20661 * can have only one tooltip at a time, so any previous tooltip
20662 * content will get removed. @p func (with @p data) will be called
20663 * every time Elementary needs to show the tooltip and it should
20664 * return a valid Evas object, which will be fully managed by the
20665 * tooltip system, getting deleted when the tooltip is gone.
20667 * In order to set just a text as a tooltip, look at
20668 * elm_genlist_item_tooltip_text_set().
20672 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);
20675 * Unset a tooltip from a given genlist item
20677 * @param item genlist item to remove a previously set tooltip from.
20679 * This call removes any tooltip set on @p item. The callback
20680 * provided as @c del_cb to
20681 * elm_genlist_item_tooltip_content_cb_set() will be called to
20682 * notify it is not used anymore (and have resources cleaned, if
20685 * @see elm_genlist_item_tooltip_content_cb_set()
20689 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20692 * Set a different @b style for a given genlist item's tooltip.
20694 * @param item genlist item with tooltip set
20695 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
20696 * "default", @c "transparent", etc)
20698 * Tooltips can have <b>alternate styles</b> to be displayed on,
20699 * which are defined by the theme set on Elementary. This function
20700 * works analogously as elm_object_tooltip_style_set(), but here
20701 * applied only to genlist item objects. The default style for
20702 * tooltips is @c "default".
20704 * @note before you set a style you should define a tooltip with
20705 * elm_genlist_item_tooltip_content_cb_set() or
20706 * elm_genlist_item_tooltip_text_set()
20708 * @see elm_genlist_item_tooltip_style_get()
20712 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20715 * Get the style set a given genlist item's tooltip.
20717 * @param item genlist item with tooltip already set on.
20718 * @return style the theme style in use, which defaults to
20719 * "default". If the object does not have a tooltip set,
20720 * then @c NULL is returned.
20722 * @see elm_genlist_item_tooltip_style_set() for more details
20726 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20729 * @brief Disable size restrictions on an object's tooltip
20730 * @param item The tooltip's anchor object
20731 * @param disable If EINA_TRUE, size restrictions are disabled
20732 * @return EINA_FALSE on failure, EINA_TRUE on success
20734 * This function allows a tooltip to expand beyond its parant window's canvas.
20735 * It will instead be limited only by the size of the display.
20737 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
20740 * @brief Retrieve size restriction state of an object's tooltip
20741 * @param item The tooltip's anchor object
20742 * @return If EINA_TRUE, size restrictions are disabled
20744 * This function returns whether a tooltip is allowed to expand beyond
20745 * its parant window's canvas.
20746 * It will instead be limited only by the size of the display.
20748 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
20751 * Set the type of mouse pointer/cursor decoration to be shown,
20752 * when the mouse pointer is over the given genlist widget item
20754 * @param item genlist item to customize cursor on
20755 * @param cursor the cursor type's name
20757 * This function works analogously as elm_object_cursor_set(), but
20758 * here the cursor's changing area is restricted to the item's
20759 * area, and not the whole widget's. Note that that item cursors
20760 * have precedence over widget cursors, so that a mouse over @p
20761 * item will always show cursor @p type.
20763 * If this function is called twice for an object, a previously set
20764 * cursor will be unset on the second call.
20766 * @see elm_object_cursor_set()
20767 * @see elm_genlist_item_cursor_get()
20768 * @see elm_genlist_item_cursor_unset()
20772 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20775 * Get the type of mouse pointer/cursor decoration set to be shown,
20776 * when the mouse pointer is over the given genlist widget item
20778 * @param item genlist item with custom cursor set
20779 * @return the cursor type's name or @c NULL, if no custom cursors
20780 * were set to @p item (and on errors)
20782 * @see elm_object_cursor_get()
20783 * @see elm_genlist_item_cursor_set() for more details
20784 * @see elm_genlist_item_cursor_unset()
20788 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20791 * Unset any custom mouse pointer/cursor decoration set to be
20792 * shown, when the mouse pointer is over the given genlist widget
20793 * item, thus making it show the @b default cursor again.
20795 * @param item a genlist item
20797 * Use this call to undo any custom settings on this item's cursor
20798 * decoration, bringing it back to defaults (no custom style set).
20800 * @see elm_object_cursor_unset()
20801 * @see elm_genlist_item_cursor_set() for more details
20805 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20808 * Set a different @b style for a given custom cursor set for a
20811 * @param item genlist item with custom cursor set
20812 * @param style the <b>theme style</b> to use (e.g. @c "default",
20813 * @c "transparent", etc)
20815 * This function only makes sense when one is using custom mouse
20816 * cursor decorations <b>defined in a theme file</b> , which can
20817 * have, given a cursor name/type, <b>alternate styles</b> on
20818 * it. It works analogously as elm_object_cursor_style_set(), but
20819 * here applied only to genlist item objects.
20821 * @warning Before you set a cursor style you should have defined a
20822 * custom cursor previously on the item, with
20823 * elm_genlist_item_cursor_set()
20825 * @see elm_genlist_item_cursor_engine_only_set()
20826 * @see elm_genlist_item_cursor_style_get()
20830 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20833 * Get the current @b style set for a given genlist item's custom
20836 * @param item genlist item with custom cursor set.
20837 * @return style the cursor style in use. If the object does not
20838 * have a cursor set, then @c NULL is returned.
20840 * @see elm_genlist_item_cursor_style_set() for more details
20844 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20847 * Set if the (custom) cursor for a given genlist item should be
20848 * searched in its theme, also, or should only rely on the
20849 * rendering engine.
20851 * @param item item with custom (custom) cursor already set on
20852 * @param engine_only Use @c EINA_TRUE to have cursors looked for
20853 * only on those provided by the rendering engine, @c EINA_FALSE to
20854 * have them searched on the widget's theme, as well.
20856 * @note This call is of use only if you've set a custom cursor
20857 * for genlist items, with elm_genlist_item_cursor_set().
20859 * @note By default, cursors will only be looked for between those
20860 * provided by the rendering engine.
20864 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20867 * Get if the (custom) cursor for a given genlist item is being
20868 * searched in its theme, also, or is only relying on the rendering
20871 * @param item a genlist item
20872 * @return @c EINA_TRUE, if cursors are being looked for only on
20873 * those provided by the rendering engine, @c EINA_FALSE if they
20874 * are being searched on the widget's theme, as well.
20876 * @see elm_genlist_item_cursor_engine_only_set(), for more details
20880 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20883 * Get the index of the item. It is only valid once displayed.
20885 * @param item a genlist item
20886 * @return the position inside the list of item.
20890 EAPI int elm_genlist_item_index_get(Elm_Gen_Item *it);
20893 * Update the contents of all realized items.
20895 * @param obj The genlist object.
20897 * This updates all realized items by calling all the item class functions again
20898 * to get the contents, texts and states. Use this when the original
20899 * item data has changed and the changes are desired to be reflected.
20901 * To update just one item, use elm_genlist_item_update().
20903 * @see elm_genlist_realized_items_get()
20904 * @see elm_genlist_item_update()
20908 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20911 * Activate a genlist mode on an item
20913 * @param item The genlist item
20914 * @param mode Mode name
20915 * @param mode_set Boolean to define set or unset mode.
20917 * A genlist mode is a different way of selecting an item. Once a mode is
20918 * activated on an item, any other selected item is immediately unselected.
20919 * This feature provides an easy way of implementing a new kind of animation
20920 * for selecting an item, without having to entirely rewrite the item style
20921 * theme. However, the elm_genlist_selected_* API can't be used to get what
20922 * item is activate for a mode.
20924 * The current item style will still be used, but applying a genlist mode to
20925 * an item will select it using a different kind of animation.
20927 * The current active item for a mode can be found by
20928 * elm_genlist_mode_item_get().
20930 * The characteristics of genlist mode are:
20931 * - Only one mode can be active at any time, and for only one item.
20932 * - Genlist handles deactivating other items when one item is activated.
20933 * - A mode is defined in the genlist theme (edc), and more modes can easily
20935 * - A mode style and the genlist item style are different things. They
20936 * can be combined to provide a default style to the item, with some kind
20937 * of animation for that item when the mode is activated.
20939 * When a mode is activated on an item, a new view for that item is created.
20940 * The theme of this mode defines the animation that will be used to transit
20941 * the item from the old view to the new view. This second (new) view will be
20942 * active for that item while the mode is active on the item, and will be
20943 * destroyed after the mode is totally deactivated from that item.
20945 * @see elm_genlist_mode_get()
20946 * @see elm_genlist_mode_item_get()
20950 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20953 * Get the last (or current) genlist mode used.
20955 * @param obj The genlist object
20957 * This function just returns the name of the last used genlist mode. It will
20958 * be the current mode if it's still active.
20960 * @see elm_genlist_item_mode_set()
20961 * @see elm_genlist_mode_item_get()
20965 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20968 * Get active genlist mode item
20970 * @param obj The genlist object
20971 * @return The active item for that current mode. Or @c NULL if no item is
20972 * activated with any mode.
20974 * This function returns the item that was activated with a mode, by the
20975 * function elm_genlist_item_mode_set().
20977 * @see elm_genlist_item_mode_set()
20978 * @see elm_genlist_mode_get()
20982 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20987 * @param obj The genlist object
20988 * @param reorder_mode The reorder mode
20989 * (EINA_TRUE = on, EINA_FALSE = off)
20993 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20996 * Get the reorder mode
20998 * @param obj The genlist object
20999 * @return The reorder mode
21000 * (EINA_TRUE = on, EINA_FALSE = off)
21004 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21011 * @defgroup Check Check
21013 * @image html img/widget/check/preview-00.png
21014 * @image latex img/widget/check/preview-00.eps
21015 * @image html img/widget/check/preview-01.png
21016 * @image latex img/widget/check/preview-01.eps
21017 * @image html img/widget/check/preview-02.png
21018 * @image latex img/widget/check/preview-02.eps
21020 * @brief The check widget allows for toggling a value between true and
21023 * Check objects are a lot like radio objects in layout and functionality
21024 * except they do not work as a group, but independently and only toggle the
21025 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
21026 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
21027 * returns the current state. For convenience, like the radio objects, you
21028 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
21029 * for it to modify.
21031 * Signals that you can add callbacks for are:
21032 * "changed" - This is called whenever the user changes the state of one of
21033 * the check object(event_info is NULL).
21035 * Default contents parts of the check widget that you can use for are:
21036 * @li "icon" - An icon of the check
21038 * Default text parts of the check widget that you can use for are:
21039 * @li "elm.text" - Label of the check
21041 * @ref tutorial_check should give you a firm grasp of how to use this widget
21046 * @brief Add a new Check object
21048 * @param parent The parent object
21049 * @return The new object or NULL if it cannot be created
21051 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21054 * @brief Set the text label of the check object
21056 * @param obj The check object
21057 * @param label The text label string in UTF-8
21059 * @deprecated use elm_object_text_set() instead.
21061 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21064 * @brief Get the text label of the check object
21066 * @param obj The check object
21067 * @return The text label string in UTF-8
21069 * @deprecated use elm_object_text_get() instead.
21071 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21074 * @brief Set the icon object of the check object
21076 * @param obj The check object
21077 * @param icon The icon object
21079 * Once the icon object is set, a previously set one will be deleted.
21080 * If you want to keep that old content object, use the
21081 * elm_object_content_unset() function.
21083 * @deprecated use elm_object_part_content_set() instead.
21086 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21089 * @brief Get the icon object of the check object
21091 * @param obj The check object
21092 * @return The icon object
21094 * @deprecated use elm_object_part_content_get() instead.
21097 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21100 * @brief Unset the icon used for the check object
21102 * @param obj The check object
21103 * @return The icon object that was being used
21105 * Unparent and return the icon object which was set for this widget.
21107 * @deprecated use elm_object_part_content_unset() instead.
21110 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21113 * @brief Set the on/off state of the check object
21115 * @param obj The check object
21116 * @param state The state to use (1 == on, 0 == off)
21118 * This sets the state of the check. If set
21119 * with elm_check_state_pointer_set() the state of that variable is also
21120 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
21122 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21125 * @brief Get the state of the check object
21127 * @param obj The check object
21128 * @return The boolean state
21130 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21133 * @brief Set a convenience pointer to a boolean to change
21135 * @param obj The check object
21136 * @param statep Pointer to the boolean to modify
21138 * This sets a pointer to a boolean, that, in addition to the check objects
21139 * state will also be modified directly. To stop setting the object pointed
21140 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
21141 * then when this is called, the check objects state will also be modified to
21142 * reflect the value of the boolean @p statep points to, just like calling
21143 * elm_check_state_set().
21145 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
21146 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
21147 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);
21154 * @defgroup Radio Radio
21156 * @image html img/widget/radio/preview-00.png
21157 * @image latex img/widget/radio/preview-00.eps
21159 * @brief Radio is a widget that allows for 1 or more options to be displayed
21160 * and have the user choose only 1 of them.
21162 * A radio object contains an indicator, an optional Label and an optional
21163 * icon object. While it's possible to have a group of only one radio they,
21164 * are normally used in groups of 2 or more. To add a radio to a group use
21165 * elm_radio_group_add(). The radio object(s) will select from one of a set
21166 * of integer values, so any value they are configuring needs to be mapped to
21167 * a set of integers. To configure what value that radio object represents,
21168 * use elm_radio_state_value_set() to set the integer it represents. To set
21169 * the value the whole group(which one is currently selected) is to indicate
21170 * use elm_radio_value_set() on any group member, and to get the groups value
21171 * use elm_radio_value_get(). For convenience the radio objects are also able
21172 * to directly set an integer(int) to the value that is selected. To specify
21173 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
21174 * The radio objects will modify this directly. That implies the pointer must
21175 * point to valid memory for as long as the radio objects exist.
21177 * Signals that you can add callbacks for are:
21178 * @li changed - This is called whenever the user changes the state of one of
21179 * the radio objects within the group of radio objects that work together.
21181 * Default contents parts of the radio widget that you can use for are:
21182 * @li "icon" - An icon of the radio
21184 * @ref tutorial_radio show most of this API in action.
21189 * @brief Add a new radio to the parent
21191 * @param parent The parent object
21192 * @return The new object or NULL if it cannot be created
21194 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21197 * @brief Set the text label of the radio object
21199 * @param obj The radio object
21200 * @param label The text label string in UTF-8
21202 * @deprecated use elm_object_text_set() instead.
21204 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21207 * @brief Get the text label of the radio object
21209 * @param obj The radio object
21210 * @return The text label string in UTF-8
21212 * @deprecated use elm_object_text_set() instead.
21214 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21217 * @brief Set the icon object of the radio object
21219 * @param obj The radio object
21220 * @param icon The icon object
21222 * Once the icon object is set, a previously set one will be deleted. If you
21223 * want to keep that old content object, use the elm_radio_icon_unset()
21226 * @deprecated use elm_object_part_content_set() instead.
21229 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21232 * @brief Get the icon object of the radio object
21234 * @param obj The radio object
21235 * @return The icon object
21237 * @see elm_radio_icon_set()
21239 * @deprecated use elm_object_part_content_get() instead.
21242 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21245 * @brief Unset the icon used for the radio object
21247 * @param obj The radio object
21248 * @return The icon object that was being used
21250 * Unparent and return the icon object which was set for this widget.
21252 * @see elm_radio_icon_set()
21253 * @deprecated use elm_object_part_content_unset() instead.
21256 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21259 * @brief Add this radio to a group of other radio objects
21261 * @param obj The radio object
21262 * @param group Any object whose group the @p obj is to join.
21264 * Radio objects work in groups. Each member should have a different integer
21265 * value assigned. In order to have them work as a group, they need to know
21266 * about each other. This adds the given radio object to the group of which
21267 * the group object indicated is a member.
21269 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
21272 * @brief Set the integer value that this radio object represents
21274 * @param obj The radio object
21275 * @param value The value to use if this radio object is selected
21277 * This sets the value of the radio.
21279 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21282 * @brief Get the integer value that this radio object represents
21284 * @param obj The radio object
21285 * @return The value used if this radio object is selected
21287 * This gets the value of the radio.
21289 * @see elm_radio_value_set()
21291 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21294 * @brief Set the value of the radio.
21296 * @param obj The radio object
21297 * @param value The value to use for the group
21299 * This sets the value of the radio group and will also set the value if
21300 * pointed to, to the value supplied, but will not call any callbacks.
21302 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21305 * @brief Get the state of the radio object
21307 * @param obj The radio object
21308 * @return The integer state
21310 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21313 * @brief Set a convenience pointer to a integer to change
21315 * @param obj The radio object
21316 * @param valuep Pointer to the integer to modify
21318 * This sets a pointer to a integer, that, in addition to the radio objects
21319 * state will also be modified directly. To stop setting the object pointed
21320 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
21321 * when this is called, the radio objects state will also be modified to
21322 * reflect the value of the integer valuep points to, just like calling
21323 * elm_radio_value_set().
21325 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
21332 * @defgroup Pager Pager
21334 * @image html img/widget/pager/preview-00.png
21335 * @image latex img/widget/pager/preview-00.eps
21337 * @brief Widget that allows flipping between one or more āpagesā
21340 * The flipping between pages of objects is animated. All content
21341 * in the pager is kept in a stack, being the last content added
21342 * (visible one) on the top of that stack.
21344 * Objects can be pushed or popped from the stack or deleted as
21345 * well. Pushes and pops will animate the widget accordingly to its
21346 * style (a pop will also delete the child object once the
21347 * animation is finished). Any object already in the pager can be
21348 * promoted to the top (from its current stacking position) through
21349 * the use of elm_pager_content_promote(). New objects are pushed
21350 * to the top with elm_pager_content_push(). When the top item is
21351 * no longer wanted, simply pop it with elm_pager_content_pop() and
21352 * it will also be deleted. If an object is no longer needed and is
21353 * not the top item, just delete it as normal. You can query which
21354 * objects are the top and bottom with
21355 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
21357 * Signals that you can add callbacks for are:
21358 * - @c "show,finished" - when a new page is actually shown on the top
21359 * - @c "hide,finished" - when a previous page is hidden
21361 * Only after the first of that signals the child object is
21362 * guaranteed to be visible, as in @c evas_object_visible_get().
21364 * This widget has the following styles available:
21367 * - @c "fade_translucide"
21368 * - @c "fade_invisible"
21370 * @note These styles affect only the flipping animations on the
21371 * default theme; the appearance when not animating is unaffected
21374 * @ref tutorial_pager gives a good overview of the usage of the API.
21379 * Add a new pager to the parent
21381 * @param parent The parent object
21382 * @return The new object or NULL if it cannot be created
21386 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21389 * @brief Push an object to the top of the pager stack (and show it).
21391 * @param obj The pager object
21392 * @param content The object to push
21394 * The object pushed becomes a child of the pager, it will be controlled and
21395 * deleted when the pager is deleted.
21397 * @note If the content is already in the stack use
21398 * elm_pager_content_promote().
21399 * @warning Using this function on @p content already in the stack results in
21400 * undefined behavior.
21402 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21405 * @brief Pop the object that is on top of the stack
21407 * @param obj The pager object
21409 * This pops the object that is on the top(visible) of the pager, makes it
21410 * disappear, then deletes the object. The object that was underneath it on
21411 * the stack will become visible.
21413 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
21416 * @brief Moves an object already in the pager stack to the top of the stack.
21418 * @param obj The pager object
21419 * @param content The object to promote
21421 * This will take the @p content and move it to the top of the stack as
21422 * if it had been pushed there.
21424 * @note If the content isn't already in the stack use
21425 * elm_pager_content_push().
21426 * @warning Using this function on @p content not already in the stack
21427 * results in undefined behavior.
21429 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21432 * @brief Return the object at the bottom of the pager stack
21434 * @param obj The pager object
21435 * @return The bottom object or NULL if none
21437 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21440 * @brief Return the object at the top of the pager stack
21442 * @param obj The pager object
21443 * @return The top object or NULL if none
21445 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21452 * @defgroup Slideshow Slideshow
21454 * @image html img/widget/slideshow/preview-00.png
21455 * @image latex img/widget/slideshow/preview-00.eps
21457 * This widget, as the name indicates, is a pre-made image
21458 * slideshow panel, with API functions acting on (child) image
21459 * items presentation. Between those actions, are:
21460 * - advance to next/previous image
21461 * - select the style of image transition animation
21462 * - set the exhibition time for each image
21463 * - start/stop the slideshow
21465 * The transition animations are defined in the widget's theme,
21466 * consequently new animations can be added without having to
21467 * update the widget's code.
21469 * @section Slideshow_Items Slideshow items
21471 * For slideshow items, just like for @ref Genlist "genlist" ones,
21472 * the user defines a @b classes, specifying functions that will be
21473 * called on the item's creation and deletion times.
21475 * The #Elm_Slideshow_Item_Class structure contains the following
21478 * - @c func.get - When an item is displayed, this function is
21479 * called, and it's where one should create the item object, de
21480 * facto. For example, the object can be a pure Evas image object
21481 * or an Elementary @ref Photocam "photocam" widget. See
21482 * #SlideshowItemGetFunc.
21483 * - @c func.del - When an item is no more displayed, this function
21484 * is called, where the user must delete any data associated to
21485 * the item. See #SlideshowItemDelFunc.
21487 * @section Slideshow_Caching Slideshow caching
21489 * The slideshow provides facilities to have items adjacent to the
21490 * one being displayed <b>already "realized"</b> (i.e. loaded) for
21491 * you, so that the system does not have to decode image data
21492 * anymore at the time it has to actually switch images on its
21493 * viewport. The user is able to set the numbers of items to be
21494 * cached @b before and @b after the current item, in the widget's
21497 * Smart events one can add callbacks for are:
21499 * - @c "changed" - when the slideshow switches its view to a new
21500 * item. event_info parameter in callback contains the current visible item
21501 * - @c "transition,end" - when a slide transition ends. event_info parameter
21502 * in callback contains the current visible item
21504 * List of examples for the slideshow widget:
21505 * @li @ref slideshow_example
21509 * @addtogroup Slideshow
21513 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
21514 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
21515 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
21516 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
21519 * @struct _Elm_Slideshow_Item_Class
21521 * Slideshow item class definition. See @ref Slideshow_Items for
21524 struct _Elm_Slideshow_Item_Class
21526 struct _Elm_Slideshow_Item_Class_Func
21528 SlideshowItemGetFunc get;
21529 SlideshowItemDelFunc del;
21531 }; /**< #Elm_Slideshow_Item_Class member definitions */
21534 * Add a new slideshow widget to the given parent Elementary
21535 * (container) object
21537 * @param parent The parent object
21538 * @return A new slideshow widget handle or @c NULL, on errors
21540 * This function inserts a new slideshow widget on the canvas.
21542 * @ingroup Slideshow
21544 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21547 * Add (append) a new item in a given slideshow widget.
21549 * @param obj The slideshow object
21550 * @param itc The item class for the item
21551 * @param data The item's data
21552 * @return A handle to the item added or @c NULL, on errors
21554 * Add a new item to @p obj's internal list of items, appending it.
21555 * The item's class must contain the function really fetching the
21556 * image object to show for this item, which could be an Evas image
21557 * object or an Elementary photo, for example. The @p data
21558 * parameter is going to be passed to both class functions of the
21561 * @see #Elm_Slideshow_Item_Class
21562 * @see elm_slideshow_item_sorted_insert()
21563 * @see elm_object_item_data_set()
21565 * @ingroup Slideshow
21567 EAPI Elm_Object_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
21570 * Insert a new item into the given slideshow widget, using the @p func
21571 * function to sort items (by item handles).
21573 * @param obj The slideshow object
21574 * @param itc The item class for the item
21575 * @param data The item's data
21576 * @param func The comparing function to be used to sort slideshow
21577 * items <b>by #Elm_Slideshow_Item item handles</b>
21578 * @return Returns The slideshow item handle, on success, or
21579 * @c NULL, on errors
21581 * Add a new item to @p obj's internal list of items, in a position
21582 * determined by the @p func comparing function. The item's class
21583 * must contain the function really fetching the image object to
21584 * show for this item, which could be an Evas image object or an
21585 * Elementary photo, for example. The @p data parameter is going to
21586 * be passed to both class functions of the item.
21588 * @see #Elm_Slideshow_Item_Class
21589 * @see elm_slideshow_item_add()
21591 * @ingroup Slideshow
21593 EAPI Elm_Object_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);
21596 * Display a given slideshow widget's item, programmatically.
21598 * @param it The item to display on @p obj's viewport
21600 * The change between the current item and @p item will use the
21601 * transition @p obj is set to use (@see
21602 * elm_slideshow_transition_set()).
21604 * @ingroup Slideshow
21606 EAPI void elm_slideshow_show(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21609 * Slide to the @b next item, in a given slideshow widget
21611 * @param obj The slideshow object
21613 * The sliding animation @p obj is set to use will be the
21614 * transition effect used, after this call is issued.
21616 * @note If the end of the slideshow's internal list of items is
21617 * reached, it'll wrap around to the list's beginning, again.
21619 * @ingroup Slideshow
21621 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21624 * Slide to the @b previous item, in a given slideshow widget
21626 * @param obj The slideshow object
21628 * The sliding animation @p obj is set to use will be the
21629 * transition effect used, after this call is issued.
21631 * @note If the beginning of the slideshow's internal list of items
21632 * is reached, it'll wrap around to the list's end, again.
21634 * @ingroup Slideshow
21636 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
21639 * Returns the list of sliding transition/effect names available, for a
21640 * given slideshow widget.
21642 * @param obj The slideshow object
21643 * @return The list of transitions (list of @b stringshared strings
21646 * The transitions, which come from @p obj's theme, must be an EDC
21647 * data item named @c "transitions" on the theme file, with (prefix)
21648 * names of EDC programs actually implementing them.
21650 * The available transitions for slideshows on the default theme are:
21651 * - @c "fade" - the current item fades out, while the new one
21652 * fades in to the slideshow's viewport.
21653 * - @c "black_fade" - the current item fades to black, and just
21654 * then, the new item will fade in.
21655 * - @c "horizontal" - the current item slides horizontally, until
21656 * it gets out of the slideshow's viewport, while the new item
21657 * comes from the left to take its place.
21658 * - @c "vertical" - the current item slides vertically, until it
21659 * gets out of the slideshow's viewport, while the new item comes
21660 * from the bottom to take its place.
21661 * - @c "square" - the new item starts to appear from the middle of
21662 * the current one, but with a tiny size, growing until its
21663 * target (full) size and covering the old one.
21665 * @warning The stringshared strings get no new references
21666 * exclusive to the user grabbing the list, here, so if you'd like
21667 * to use them out of this call's context, you'd better @c
21668 * eina_stringshare_ref() them.
21670 * @see elm_slideshow_transition_set()
21672 * @ingroup Slideshow
21674 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21677 * Set the current slide transition/effect in use for a given
21680 * @param obj The slideshow object
21681 * @param transition The new transition's name string
21683 * If @p transition is implemented in @p obj's theme (i.e., is
21684 * contained in the list returned by
21685 * elm_slideshow_transitions_get()), this new sliding effect will
21686 * be used on the widget.
21688 * @see elm_slideshow_transitions_get() for more details
21690 * @ingroup Slideshow
21692 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
21695 * Get the current slide transition/effect in use for a given
21698 * @param obj The slideshow object
21699 * @return The current transition's name
21701 * @see elm_slideshow_transition_set() for more details
21703 * @ingroup Slideshow
21705 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21708 * Set the interval between each image transition on a given
21709 * slideshow widget, <b>and start the slideshow, itself</b>
21711 * @param obj The slideshow object
21712 * @param timeout The new displaying timeout for images
21714 * After this call, the slideshow widget will start cycling its
21715 * view, sequentially and automatically, with the images of the
21716 * items it has. The time between each new image displayed is going
21717 * to be @p timeout, in @b seconds. If a different timeout was set
21718 * previously and an slideshow was in progress, it will continue
21719 * with the new time between transitions, after this call.
21721 * @note A value less than or equal to 0 on @p timeout will disable
21722 * the widget's internal timer, thus halting any slideshow which
21723 * could be happening on @p obj.
21725 * @see elm_slideshow_timeout_get()
21727 * @ingroup Slideshow
21729 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
21732 * Get the interval set for image transitions on a given slideshow
21735 * @param obj The slideshow object
21736 * @return Returns the timeout set on it
21738 * @see elm_slideshow_timeout_set() for more details
21740 * @ingroup Slideshow
21742 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21745 * Set if, after a slideshow is started, for a given slideshow
21746 * widget, its items should be displayed cyclically or not.
21748 * @param obj The slideshow object
21749 * @param loop Use @c EINA_TRUE to make it cycle through items or
21750 * @c EINA_FALSE for it to stop at the end of @p obj's internal
21753 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
21754 * ignore what is set by this functions, i.e., they'll @b always
21755 * cycle through items. This affects only the "automatic"
21756 * slideshow, as set by elm_slideshow_timeout_set().
21758 * @see elm_slideshow_loop_get()
21760 * @ingroup Slideshow
21762 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
21765 * Get if, after a slideshow is started, for a given slideshow
21766 * widget, its items are to be displayed cyclically or not.
21768 * @param obj The slideshow object
21769 * @return @c EINA_TRUE, if the items in @p obj will be cycled
21770 * through or @c EINA_FALSE, otherwise
21772 * @see elm_slideshow_loop_set() for more details
21774 * @ingroup Slideshow
21776 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21779 * Remove all items from a given slideshow widget
21781 * @param obj The slideshow object
21783 * This removes (and deletes) all items in @p obj, leaving it
21786 * @see elm_slideshow_item_del(), to remove just one item.
21788 * @ingroup Slideshow
21790 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21793 * Get the internal list of items in a given slideshow widget.
21795 * @param obj The slideshow object
21796 * @return The list of items (#Elm_Object_Item as data) or
21797 * @c NULL on errors.
21799 * This list is @b not to be modified in any way and must not be
21800 * freed. Use the list members with functions like
21801 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
21803 * @warning This list is only valid until @p obj object's internal
21804 * items list is changed. It should be fetched again with another
21805 * call to this function when changes happen.
21807 * @ingroup Slideshow
21809 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21812 * Delete a given item from a slideshow widget.
21814 * @param it The slideshow item
21816 * @ingroup Slideshow
21818 EAPI void elm_slideshow_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21821 * Return the data associated with a given slideshow item
21823 * @param it The slideshow item
21824 * @return Returns the data associated to this item
21826 * @deprecated use elm_object_item_data_get() instead
21827 * @ingroup Slideshow
21829 EINA_DEPRECATED EAPI void *elm_slideshow_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21832 * Returns the currently displayed item, in a given slideshow widget
21834 * @param obj The slideshow object
21835 * @return A handle to the item being displayed in @p obj or
21836 * @c NULL, if none is (and on errors)
21838 * @ingroup Slideshow
21840 EAPI Elm_Object_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21843 * Get the real Evas object created to implement the view of a
21844 * given slideshow item
21846 * @param item The slideshow item.
21847 * @return the Evas object implementing this item's view.
21849 * This returns the actual Evas object used to implement the
21850 * specified slideshow item's view. This may be @c NULL, as it may
21851 * not have been created or may have been deleted, at any time, by
21852 * the slideshow. <b>Do not modify this object</b> (move, resize,
21853 * show, hide, etc.), as the slideshow is controlling it. This
21854 * function is for querying, emitting custom signals or hooking
21855 * lower level callbacks for events on that object. Do not delete
21856 * this object under any circumstances.
21858 * @see elm_slideshow_item_data_get()
21860 * @ingroup Slideshow
21862 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Object_Item* it) EINA_ARG_NONNULL(1);
21865 * Get the the item, in a given slideshow widget, placed at
21866 * position @p nth, in its internal items list
21868 * @param obj The slideshow object
21869 * @param nth The number of the item to grab a handle to (0 being
21871 * @return The item stored in @p obj at position @p nth or @c NULL,
21872 * if there's no item with that index (and on errors)
21874 * @ingroup Slideshow
21876 EAPI Elm_Object_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21879 * Set the current slide layout in use for a given slideshow widget
21881 * @param obj The slideshow object
21882 * @param layout The new layout's name string
21884 * If @p layout is implemented in @p obj's theme (i.e., is contained
21885 * in the list returned by elm_slideshow_layouts_get()), this new
21886 * images layout will be used on the widget.
21888 * @see elm_slideshow_layouts_get() for more details
21890 * @ingroup Slideshow
21892 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21895 * Get the current slide layout in use for a given slideshow widget
21897 * @param obj The slideshow object
21898 * @return The current layout's name
21900 * @see elm_slideshow_layout_set() for more details
21902 * @ingroup Slideshow
21904 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21907 * Returns the list of @b layout names available, for a given
21908 * slideshow widget.
21910 * @param obj The slideshow object
21911 * @return The list of layouts (list of @b stringshared strings
21914 * Slideshow layouts will change how the widget is to dispose each
21915 * image item in its viewport, with regard to cropping, scaling,
21918 * The layouts, which come from @p obj's theme, must be an EDC
21919 * data item name @c "layouts" on the theme file, with (prefix)
21920 * names of EDC programs actually implementing them.
21922 * The available layouts for slideshows on the default theme are:
21923 * - @c "fullscreen" - item images with original aspect, scaled to
21924 * touch top and down slideshow borders or, if the image's heigh
21925 * is not enough, left and right slideshow borders.
21926 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21927 * one, but always leaving 10% of the slideshow's dimensions of
21928 * distance between the item image's borders and the slideshow
21929 * borders, for each axis.
21931 * @warning The stringshared strings get no new references
21932 * exclusive to the user grabbing the list, here, so if you'd like
21933 * to use them out of this call's context, you'd better @c
21934 * eina_stringshare_ref() them.
21936 * @see elm_slideshow_layout_set()
21938 * @ingroup Slideshow
21940 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21943 * Set the number of items to cache, on a given slideshow widget,
21944 * <b>before the current item</b>
21946 * @param obj The slideshow object
21947 * @param count Number of items to cache before the current one
21949 * The default value for this property is @c 2. See
21950 * @ref Slideshow_Caching "slideshow caching" for more details.
21952 * @see elm_slideshow_cache_before_get()
21954 * @ingroup Slideshow
21956 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21959 * Retrieve the number of items to cache, on a given slideshow widget,
21960 * <b>before the current item</b>
21962 * @param obj The slideshow object
21963 * @return The number of items set to be cached before the current one
21965 * @see elm_slideshow_cache_before_set() for more details
21967 * @ingroup Slideshow
21969 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21972 * Set the number of items to cache, on a given slideshow widget,
21973 * <b>after the current item</b>
21975 * @param obj The slideshow object
21976 * @param count Number of items to cache after the current one
21978 * The default value for this property is @c 2. See
21979 * @ref Slideshow_Caching "slideshow caching" for more details.
21981 * @see elm_slideshow_cache_after_get()
21983 * @ingroup Slideshow
21985 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21988 * Retrieve the number of items to cache, on a given slideshow widget,
21989 * <b>after the current item</b>
21991 * @param obj The slideshow object
21992 * @return The number of items set to be cached after the current one
21994 * @see elm_slideshow_cache_after_set() for more details
21996 * @ingroup Slideshow
21998 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22001 * Get the number of items stored in a given slideshow widget
22003 * @param obj The slideshow object
22004 * @return The number of items on @p obj, at the moment of this call
22006 * @ingroup Slideshow
22008 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22015 * @defgroup Fileselector File Selector
22017 * @image html img/widget/fileselector/preview-00.png
22018 * @image latex img/widget/fileselector/preview-00.eps
22020 * A file selector is a widget that allows a user to navigate
22021 * through a file system, reporting file selections back via its
22024 * It contains shortcut buttons for home directory (@c ~) and to
22025 * jump one directory upwards (..), as well as cancel/ok buttons to
22026 * confirm/cancel a given selection. After either one of those two
22027 * former actions, the file selector will issue its @c "done" smart
22030 * There's a text entry on it, too, showing the name of the current
22031 * selection. There's the possibility of making it editable, so it
22032 * is useful on file saving dialogs on applications, where one
22033 * gives a file name to save contents to, in a given directory in
22034 * the system. This custom file name will be reported on the @c
22035 * "done" smart callback (explained in sequence).
22037 * Finally, it has a view to display file system items into in two
22042 * If Elementary is built with support of the Ethumb thumbnailing
22043 * library, the second form of view will display preview thumbnails
22044 * of files which it supports.
22046 * Smart callbacks one can register to:
22048 * - @c "selected" - the user has clicked on a file (when not in
22049 * folders-only mode) or directory (when in folders-only mode)
22050 * - @c "directory,open" - the list has been populated with new
22051 * content (@c event_info is a pointer to the directory's
22052 * path, a @b stringshared string)
22053 * - @c "done" - the user has clicked on the "ok" or "cancel"
22054 * buttons (@c event_info is a pointer to the selection's
22055 * path, a @b stringshared string)
22057 * Here is an example on its usage:
22058 * @li @ref fileselector_example
22062 * @addtogroup Fileselector
22067 * Defines how a file selector widget is to layout its contents
22068 * (file system entries).
22070 typedef enum _Elm_Fileselector_Mode
22072 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
22073 ELM_FILESELECTOR_GRID, /**< layout as a grid */
22074 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
22075 } Elm_Fileselector_Mode;
22078 * Add a new file selector widget to the given parent Elementary
22079 * (container) object
22081 * @param parent The parent object
22082 * @return a new file selector widget handle or @c NULL, on errors
22084 * This function inserts a new file selector widget on the canvas.
22086 * @ingroup Fileselector
22088 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22091 * Enable/disable the file name entry box where the user can type
22092 * in a name for a file, in a given file selector widget
22094 * @param obj The file selector object
22095 * @param is_save @c EINA_TRUE to make the file selector a "saving
22096 * dialog", @c EINA_FALSE otherwise
22098 * Having the entry editable is useful on file saving dialogs on
22099 * applications, where one gives a file name to save contents to,
22100 * in a given directory in the system. This custom file name will
22101 * be reported on the @c "done" smart callback.
22103 * @see elm_fileselector_is_save_get()
22105 * @ingroup Fileselector
22107 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
22110 * Get whether the given file selector is in "saving dialog" mode
22112 * @param obj The file selector object
22113 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
22114 * mode, @c EINA_FALSE otherwise (and on errors)
22116 * @see elm_fileselector_is_save_set() for more details
22118 * @ingroup Fileselector
22120 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22123 * Enable/disable folder-only view for a given file selector widget
22125 * @param obj The file selector object
22126 * @param only @c EINA_TRUE to make @p obj only display
22127 * directories, @c EINA_FALSE to make files to be displayed in it
22130 * If enabled, the widget's view will only display folder items,
22133 * @see elm_fileselector_folder_only_get()
22135 * @ingroup Fileselector
22137 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
22140 * Get whether folder-only view is set for a given file selector
22143 * @param obj The file selector object
22144 * @return only @c EINA_TRUE if @p obj is only displaying
22145 * directories, @c EINA_FALSE if files are being displayed in it
22146 * too (and on errors)
22148 * @see elm_fileselector_folder_only_get()
22150 * @ingroup Fileselector
22152 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22155 * Enable/disable the "ok" and "cancel" buttons on a given file
22158 * @param obj The file selector object
22159 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
22161 * @note A file selector without those buttons will never emit the
22162 * @c "done" smart event, and is only usable if one is just hooking
22163 * to the other two events.
22165 * @see elm_fileselector_buttons_ok_cancel_get()
22167 * @ingroup Fileselector
22169 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
22172 * Get whether the "ok" and "cancel" buttons on a given file
22173 * selector widget are being shown.
22175 * @param obj The file selector object
22176 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
22177 * otherwise (and on errors)
22179 * @see elm_fileselector_buttons_ok_cancel_set() for more details
22181 * @ingroup Fileselector
22183 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22186 * Enable/disable a tree view in the given file selector widget,
22187 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
22189 * @param obj The file selector object
22190 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
22193 * In a tree view, arrows are created on the sides of directories,
22194 * allowing them to expand in place.
22196 * @note If it's in other mode, the changes made by this function
22197 * will only be visible when one switches back to "list" mode.
22199 * @see elm_fileselector_expandable_get()
22201 * @ingroup Fileselector
22203 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
22206 * Get whether tree view is enabled for the given file selector
22209 * @param obj The file selector object
22210 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
22211 * otherwise (and or errors)
22213 * @see elm_fileselector_expandable_set() for more details
22215 * @ingroup Fileselector
22217 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22220 * Set, programmatically, the @b directory that a given file
22221 * selector widget will display contents from
22223 * @param obj The file selector object
22224 * @param path The path to display in @p obj
22226 * This will change the @b directory that @p obj is displaying. It
22227 * will also clear the text entry area on the @p obj object, which
22228 * displays select files' names.
22230 * @see elm_fileselector_path_get()
22232 * @ingroup Fileselector
22234 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22237 * Get the parent directory's path that a given file selector
22238 * widget is displaying
22240 * @param obj The file selector object
22241 * @return The (full) path of the directory the file selector is
22242 * displaying, a @b stringshared string
22244 * @see elm_fileselector_path_set()
22246 * @ingroup Fileselector
22248 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22251 * Set, programmatically, the currently selected file/directory in
22252 * the given file selector widget
22254 * @param obj The file selector object
22255 * @param path The (full) path to a file or directory
22256 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
22257 * latter case occurs if the directory or file pointed to do not
22260 * @see elm_fileselector_selected_get()
22262 * @ingroup Fileselector
22264 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22267 * Get the currently selected item's (full) path, in the given file
22270 * @param obj The file selector object
22271 * @return The absolute path of the selected item, a @b
22272 * stringshared string
22274 * @note Custom editions on @p obj object's text entry, if made,
22275 * will appear on the return string of this function, naturally.
22277 * @see elm_fileselector_selected_set() for more details
22279 * @ingroup Fileselector
22281 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22284 * Set the mode in which a given file selector widget will display
22285 * (layout) file system entries in its view
22287 * @param obj The file selector object
22288 * @param mode The mode of the fileselector, being it one of
22289 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
22290 * first one, naturally, will display the files in a list. The
22291 * latter will make the widget to display its entries in a grid
22294 * @note By using elm_fileselector_expandable_set(), the user may
22295 * trigger a tree view for that list.
22297 * @note If Elementary is built with support of the Ethumb
22298 * thumbnailing library, the second form of view will display
22299 * preview thumbnails of files which it supports. You must have
22300 * elm_need_ethumb() called in your Elementary for thumbnailing to
22303 * @see elm_fileselector_expandable_set().
22304 * @see elm_fileselector_mode_get().
22306 * @ingroup Fileselector
22308 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
22311 * Get the mode in which a given file selector widget is displaying
22312 * (layouting) file system entries in its view
22314 * @param obj The fileselector object
22315 * @return The mode in which the fileselector is at
22317 * @see elm_fileselector_mode_set() for more details
22319 * @ingroup Fileselector
22321 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22328 * @defgroup Progressbar Progress bar
22330 * The progress bar is a widget for visually representing the
22331 * progress status of a given job/task.
22333 * A progress bar may be horizontal or vertical. It may display an
22334 * icon besides it, as well as primary and @b units labels. The
22335 * former is meant to label the widget as a whole, while the
22336 * latter, which is formatted with floating point values (and thus
22337 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
22338 * units"</c>), is meant to label the widget's <b>progress
22339 * value</b>. Label, icon and unit strings/objects are @b optional
22340 * for progress bars.
22342 * A progress bar may be @b inverted, in which state it gets its
22343 * values inverted, with high values being on the left or top and
22344 * low values on the right or bottom, as opposed to normally have
22345 * the low values on the former and high values on the latter,
22346 * respectively, for horizontal and vertical modes.
22348 * The @b span of the progress, as set by
22349 * elm_progressbar_span_size_set(), is its length (horizontally or
22350 * vertically), unless one puts size hints on the widget to expand
22351 * on desired directions, by any container. That length will be
22352 * scaled by the object or applications scaling factor. At any
22353 * point code can query the progress bar for its value with
22354 * elm_progressbar_value_get().
22356 * Available widget styles for progress bars:
22358 * - @c "wheel" (simple style, no text, no progression, only
22359 * "pulse" effect is available)
22361 * Default contents parts of the progressbar widget that you can use for are:
22362 * @li "icon" - An icon of the progressbar
22364 * Here is an example on its usage:
22365 * @li @ref progressbar_example
22369 * Add a new progress bar widget to the given parent Elementary
22370 * (container) object
22372 * @param parent The parent object
22373 * @return a new progress bar widget handle or @c NULL, on errors
22375 * This function inserts a new progress bar widget on the canvas.
22377 * @ingroup Progressbar
22379 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22382 * Set whether a given progress bar widget is at "pulsing mode" or
22385 * @param obj The progress bar object
22386 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
22387 * @c EINA_FALSE to put it back to its default one
22389 * By default, progress bars will display values from the low to
22390 * high value boundaries. There are, though, contexts in which the
22391 * state of progression of a given task is @b unknown. For those,
22392 * one can set a progress bar widget to a "pulsing state", to give
22393 * the user an idea that some computation is being held, but
22394 * without exact progress values. In the default theme it will
22395 * animate its bar with the contents filling in constantly and back
22396 * to non-filled, in a loop. To start and stop this pulsing
22397 * animation, one has to explicitly call elm_progressbar_pulse().
22399 * @see elm_progressbar_pulse_get()
22400 * @see elm_progressbar_pulse()
22402 * @ingroup Progressbar
22404 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
22407 * Get whether a given progress bar widget is at "pulsing mode" or
22410 * @param obj The progress bar object
22411 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
22412 * if it's in the default one (and on errors)
22414 * @ingroup Progressbar
22416 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22419 * Start/stop a given progress bar "pulsing" animation, if its
22422 * @param obj The progress bar object
22423 * @param state @c EINA_TRUE, to @b start the pulsing animation,
22424 * @c EINA_FALSE to @b stop it
22426 * @note This call won't do anything if @p obj is not under "pulsing mode".
22428 * @see elm_progressbar_pulse_set() for more details.
22430 * @ingroup Progressbar
22432 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
22435 * Set the progress value (in percentage) on a given progress bar
22438 * @param obj The progress bar object
22439 * @param val The progress value (@b must be between @c 0.0 and @c
22442 * Use this call to set progress bar levels.
22444 * @note If you passes a value out of the specified range for @p
22445 * val, it will be interpreted as the @b closest of the @b boundary
22446 * values in the range.
22448 * @ingroup Progressbar
22450 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22453 * Get the progress value (in percentage) on a given progress bar
22456 * @param obj The progress bar object
22457 * @return The value of the progressbar
22459 * @see elm_progressbar_value_set() for more details
22461 * @ingroup Progressbar
22463 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22466 * Set the label of a given progress bar widget
22468 * @param obj The progress bar object
22469 * @param label The text label string, in UTF-8
22471 * @ingroup Progressbar
22472 * @deprecated use elm_object_text_set() instead.
22474 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
22477 * Get the label of a given progress bar widget
22479 * @param obj The progressbar object
22480 * @return The text label string, in UTF-8
22482 * @ingroup Progressbar
22483 * @deprecated use elm_object_text_set() instead.
22485 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22488 * Set the icon object of a given progress bar widget
22490 * @param obj The progress bar object
22491 * @param icon The icon object
22493 * Use this call to decorate @p obj with an icon next to it.
22495 * @note Once the icon object is set, a previously set one will be
22496 * deleted. If you want to keep that old content object, use the
22497 * elm_progressbar_icon_unset() function.
22499 * @see elm_progressbar_icon_get()
22500 * @deprecated use elm_object_part_content_set() instead.
22502 * @ingroup Progressbar
22504 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
22507 * Retrieve the icon object set for a given progress bar widget
22509 * @param obj The progress bar object
22510 * @return The icon object's handle, if @p obj had one set, or @c NULL,
22511 * otherwise (and on errors)
22513 * @see elm_progressbar_icon_set() for more details
22514 * @deprecated use elm_object_part_content_get() instead.
22516 * @ingroup Progressbar
22518 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22521 * Unset an icon set on a given progress bar widget
22523 * @param obj The progress bar object
22524 * @return The icon object that was being used, if any was set, or
22525 * @c NULL, otherwise (and on errors)
22527 * This call will unparent and return the icon object which was set
22528 * for this widget, previously, on success.
22530 * @see elm_progressbar_icon_set() for more details
22531 * @deprecated use elm_object_part_content_unset() instead.
22533 * @ingroup Progressbar
22535 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22538 * Set the (exact) length of the bar region of a given progress bar
22541 * @param obj The progress bar object
22542 * @param size The length of the progress bar's bar region
22544 * This sets the minimum width (when in horizontal mode) or height
22545 * (when in vertical mode) of the actual bar area of the progress
22546 * bar @p obj. This in turn affects the object's minimum size. Use
22547 * this when you're not setting other size hints expanding on the
22548 * given direction (like weight and alignment hints) and you would
22549 * like it to have a specific size.
22551 * @note Icon, label and unit text around @p obj will require their
22552 * own space, which will make @p obj to require more the @p size,
22555 * @see elm_progressbar_span_size_get()
22557 * @ingroup Progressbar
22559 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
22562 * Get the length set for the bar region of a given progress bar
22565 * @param obj The progress bar object
22566 * @return The length of the progress bar's bar region
22568 * If that size was not set previously, with
22569 * elm_progressbar_span_size_set(), this call will return @c 0.
22571 * @ingroup Progressbar
22573 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22576 * Set the format string for a given progress bar widget's units
22579 * @param obj The progress bar object
22580 * @param format The format string for @p obj's units label
22582 * If @c NULL is passed on @p format, it will make @p obj's units
22583 * area to be hidden completely. If not, it'll set the <b>format
22584 * string</b> for the units label's @b text. The units label is
22585 * provided a floating point value, so the units text is up display
22586 * at most one floating point falue. Note that the units label is
22587 * optional. Use a format string such as "%1.2f meters" for
22590 * @note The default format string for a progress bar is an integer
22591 * percentage, as in @c "%.0f %%".
22593 * @see elm_progressbar_unit_format_get()
22595 * @ingroup Progressbar
22597 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
22600 * Retrieve the format string set for a given progress bar widget's
22603 * @param obj The progress bar object
22604 * @return The format set string for @p obj's units label or
22605 * @c NULL, if none was set (and on errors)
22607 * @see elm_progressbar_unit_format_set() for more details
22609 * @ingroup Progressbar
22611 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22614 * Set the orientation of a given progress bar widget
22616 * @param obj The progress bar object
22617 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22618 * @b horizontal, @c EINA_FALSE to make it @b vertical
22620 * Use this function to change how your progress bar is to be
22621 * disposed: vertically or horizontally.
22623 * @see elm_progressbar_horizontal_get()
22625 * @ingroup Progressbar
22627 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22630 * Retrieve the orientation of a given progress bar widget
22632 * @param obj The progress bar object
22633 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22634 * @c EINA_FALSE if it's @b vertical (and on errors)
22636 * @see elm_progressbar_horizontal_set() for more details
22638 * @ingroup Progressbar
22640 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22643 * Invert a given progress bar widget's displaying values order
22645 * @param obj The progress bar object
22646 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
22647 * @c EINA_FALSE to bring it back to default, non-inverted values.
22649 * A progress bar may be @b inverted, in which state it gets its
22650 * values inverted, with high values being on the left or top and
22651 * low values on the right or bottom, as opposed to normally have
22652 * the low values on the former and high values on the latter,
22653 * respectively, for horizontal and vertical modes.
22655 * @see elm_progressbar_inverted_get()
22657 * @ingroup Progressbar
22659 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
22662 * Get whether a given progress bar widget's displaying values are
22665 * @param obj The progress bar object
22666 * @return @c EINA_TRUE, if @p obj has inverted values,
22667 * @c EINA_FALSE otherwise (and on errors)
22669 * @see elm_progressbar_inverted_set() for more details
22671 * @ingroup Progressbar
22673 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22676 * @defgroup Separator Separator
22678 * @brief Separator is a very thin object used to separate other objects.
22680 * A separator can be vertical or horizontal.
22682 * @ref tutorial_separator is a good example of how to use a separator.
22686 * @brief Add a separator object to @p parent
22688 * @param parent The parent object
22690 * @return The separator object, or NULL upon failure
22692 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22694 * @brief Set the horizontal mode of a separator object
22696 * @param obj The separator object
22697 * @param horizontal If true, the separator is horizontal
22699 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22701 * @brief Get the horizontal mode of a separator object
22703 * @param obj The separator object
22704 * @return If true, the separator is horizontal
22706 * @see elm_separator_horizontal_set()
22708 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22714 * @defgroup Spinner Spinner
22715 * @ingroup Elementary
22717 * @image html img/widget/spinner/preview-00.png
22718 * @image latex img/widget/spinner/preview-00.eps
22720 * A spinner is a widget which allows the user to increase or decrease
22721 * numeric values using arrow buttons, or edit values directly, clicking
22722 * over it and typing the new value.
22724 * By default the spinner will not wrap and has a label
22725 * of "%.0f" (just showing the integer value of the double).
22727 * A spinner has a label that is formatted with floating
22728 * point values and thus accepts a printf-style format string, like
22729 * ā%1.2f unitsā.
22731 * It also allows specific values to be replaced by pre-defined labels.
22733 * Smart callbacks one can register to:
22735 * - "changed" - Whenever the spinner value is changed.
22736 * - "delay,changed" - A short time after the value is changed by the user.
22737 * This will be called only when the user stops dragging for a very short
22738 * period or when they release their finger/mouse, so it avoids possibly
22739 * expensive reactions to the value change.
22741 * Available styles for it:
22743 * - @c "vertical": up/down buttons at the right side and text left aligned.
22745 * Here is an example on its usage:
22746 * @ref spinner_example
22750 * @addtogroup Spinner
22755 * Add a new spinner widget to the given parent Elementary
22756 * (container) object.
22758 * @param parent The parent object.
22759 * @return a new spinner widget handle or @c NULL, on errors.
22761 * This function inserts a new spinner widget on the canvas.
22766 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22769 * Set the format string of the displayed label.
22771 * @param obj The spinner object.
22772 * @param fmt The format string for the label display.
22774 * If @c NULL, this sets the format to "%.0f". If not it sets the format
22775 * string for the label text. The label text is provided a floating point
22776 * value, so the label text can display up to 1 floating point value.
22777 * Note that this is optional.
22779 * Use a format string such as "%1.2f meters" for example, and it will
22780 * display values like: "3.14 meters" for a value equal to 3.14159.
22782 * Default is "%0.f".
22784 * @see elm_spinner_label_format_get()
22788 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
22791 * Get the label format of the spinner.
22793 * @param obj The spinner object.
22794 * @return The text label format string in UTF-8.
22796 * @see elm_spinner_label_format_set() for details.
22800 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22803 * Set the minimum and maximum values for the spinner.
22805 * @param obj The spinner object.
22806 * @param min The minimum value.
22807 * @param max The maximum value.
22809 * Define the allowed range of values to be selected by the user.
22811 * If actual value is less than @p min, it will be updated to @p min. If it
22812 * is bigger then @p max, will be updated to @p max. Actual value can be
22813 * get with elm_spinner_value_get().
22815 * By default, min is equal to 0, and max is equal to 100.
22817 * @warning Maximum must be greater than minimum.
22819 * @see elm_spinner_min_max_get()
22823 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22826 * Get the minimum and maximum values of the spinner.
22828 * @param obj The spinner object.
22829 * @param min Pointer where to store the minimum value.
22830 * @param max Pointer where to store the maximum value.
22832 * @note If only one value is needed, the other pointer can be passed
22835 * @see elm_spinner_min_max_set() for details.
22839 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22842 * Set the step used to increment or decrement the spinner value.
22844 * @param obj The spinner object.
22845 * @param step The step value.
22847 * This value will be incremented or decremented to the displayed value.
22848 * It will be incremented while the user keep right or top arrow pressed,
22849 * and will be decremented while the user keep left or bottom arrow pressed.
22851 * The interval to increment / decrement can be set with
22852 * elm_spinner_interval_set().
22854 * By default step value is equal to 1.
22856 * @see elm_spinner_step_get()
22860 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22863 * Get the step used to increment or decrement the spinner value.
22865 * @param obj The spinner object.
22866 * @return The step value.
22868 * @see elm_spinner_step_get() for more details.
22872 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22875 * Set the value the spinner displays.
22877 * @param obj The spinner object.
22878 * @param val The value to be displayed.
22880 * Value will be presented on the label following format specified with
22881 * elm_spinner_format_set().
22883 * @warning The value must to be between min and max values. This values
22884 * are set by elm_spinner_min_max_set().
22886 * @see elm_spinner_value_get().
22887 * @see elm_spinner_format_set().
22888 * @see elm_spinner_min_max_set().
22892 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22895 * Get the value displayed by the spinner.
22897 * @param obj The spinner object.
22898 * @return The value displayed.
22900 * @see elm_spinner_value_set() for details.
22904 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22907 * Set whether the spinner should wrap when it reaches its
22908 * minimum or maximum value.
22910 * @param obj The spinner object.
22911 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22914 * Disabled by default. If disabled, when the user tries to increment the
22916 * but displayed value plus step value is bigger than maximum value,
22918 * won't allow it. The same happens when the user tries to decrement it,
22919 * but the value less step is less than minimum value.
22921 * When wrap is enabled, in such situations it will allow these changes,
22922 * but will get the value that would be less than minimum and subtracts
22923 * from maximum. Or add the value that would be more than maximum to
22927 * @li min value = 10
22928 * @li max value = 50
22929 * @li step value = 20
22930 * @li displayed value = 20
22932 * When the user decrement value (using left or bottom arrow), it will
22933 * displays @c 40, because max - (min - (displayed - step)) is
22934 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22936 * @see elm_spinner_wrap_get().
22940 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22943 * Get whether the spinner should wrap when it reaches its
22944 * minimum or maximum value.
22946 * @param obj The spinner object
22947 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22948 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22950 * @see elm_spinner_wrap_set() for details.
22954 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22957 * Set whether the spinner can be directly edited by the user or not.
22959 * @param obj The spinner object.
22960 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
22961 * don't allow users to edit it directly.
22963 * Spinner objects can have edition @b disabled, in which state they will
22964 * be changed only by arrows.
22965 * Useful for contexts
22966 * where you don't want your users to interact with it writting the value.
22968 * when using special values, the user can see real value instead
22969 * of special label on edition.
22971 * It's enabled by default.
22973 * @see elm_spinner_editable_get()
22977 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22980 * Get whether the spinner can be directly edited by the user or not.
22982 * @param obj The spinner object.
22983 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22984 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22986 * @see elm_spinner_editable_set() for details.
22990 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22993 * Set a special string to display in the place of the numerical value.
22995 * @param obj The spinner object.
22996 * @param value The value to be replaced.
22997 * @param label The label to be used.
22999 * It's useful for cases when a user should select an item that is
23000 * better indicated by a label than a value. For example, weekdays or months.
23004 * sp = elm_spinner_add(win);
23005 * elm_spinner_min_max_set(sp, 1, 3);
23006 * elm_spinner_special_value_add(sp, 1, "January");
23007 * elm_spinner_special_value_add(sp, 2, "February");
23008 * elm_spinner_special_value_add(sp, 3, "March");
23009 * evas_object_show(sp);
23014 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
23017 * Set the interval on time updates for an user mouse button hold
23018 * on spinner widgets' arrows.
23020 * @param obj The spinner object.
23021 * @param interval The (first) interval value in seconds.
23023 * This interval value is @b decreased while the user holds the
23024 * mouse pointer either incrementing or decrementing spinner's value.
23026 * This helps the user to get to a given value distant from the
23027 * current one easier/faster, as it will start to change quicker and
23028 * quicker on mouse button holds.
23030 * The calculation for the next change interval value, starting from
23031 * the one set with this call, is the previous interval divided by
23032 * @c 1.05, so it decreases a little bit.
23034 * The default starting interval value for automatic changes is
23037 * @see elm_spinner_interval_get()
23041 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23044 * Get the interval on time updates for an user mouse button hold
23045 * on spinner widgets' arrows.
23047 * @param obj The spinner object.
23048 * @return The (first) interval value, in seconds, set on it.
23050 * @see elm_spinner_interval_set() for more details.
23054 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23061 * @defgroup Index Index
23063 * @image html img/widget/index/preview-00.png
23064 * @image latex img/widget/index/preview-00.eps
23066 * An index widget gives you an index for fast access to whichever
23067 * group of other UI items one might have. It's a list of text
23068 * items (usually letters, for alphabetically ordered access).
23070 * Index widgets are by default hidden and just appear when the
23071 * user clicks over it's reserved area in the canvas. In its
23072 * default theme, it's an area one @ref Fingers "finger" wide on
23073 * the right side of the index widget's container.
23075 * When items on the index are selected, smart callbacks get
23076 * called, so that its user can make other container objects to
23077 * show a given area or child object depending on the index item
23078 * selected. You'd probably be using an index together with @ref
23079 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
23082 * Smart events one can add callbacks for are:
23083 * - @c "changed" - When the selected index item changes. @c
23084 * event_info is the selected item's data pointer.
23085 * - @c "delay,changed" - When the selected index item changes, but
23086 * after a small idling period. @c event_info is the selected
23087 * item's data pointer.
23088 * - @c "selected" - When the user releases a mouse button and
23089 * selects an item. @c event_info is the selected item's data
23091 * - @c "level,up" - when the user moves a finger from the first
23092 * level to the second level
23093 * - @c "level,down" - when the user moves a finger from the second
23094 * level to the first level
23096 * The @c "delay,changed" event is so that it'll wait a small time
23097 * before actually reporting those events and, moreover, just the
23098 * last event happening on those time frames will actually be
23101 * Here are some examples on its usage:
23102 * @li @ref index_example_01
23103 * @li @ref index_example_02
23107 * @addtogroup Index
23111 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
23114 * Add a new index widget to the given parent Elementary
23115 * (container) object
23117 * @param parent The parent object
23118 * @return a new index widget handle or @c NULL, on errors
23120 * This function inserts a new index widget on the canvas.
23124 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23127 * Set whether a given index widget is or not visible,
23130 * @param obj The index object
23131 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
23133 * Not to be confused with visible as in @c evas_object_show() --
23134 * visible with regard to the widget's auto hiding feature.
23136 * @see elm_index_active_get()
23140 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
23143 * Get whether a given index widget is currently visible or not.
23145 * @param obj The index object
23146 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
23148 * @see elm_index_active_set() for more details
23152 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23155 * Set the items level for a given index widget.
23157 * @param obj The index object.
23158 * @param level @c 0 or @c 1, the currently implemented levels.
23160 * @see elm_index_item_level_get()
23164 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23167 * Get the items level set for a given index widget.
23169 * @param obj The index object.
23170 * @return @c 0 or @c 1, which are the levels @p obj might be at.
23172 * @see elm_index_item_level_set() for more information
23176 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23179 * Returns the last selected item, for a given index widget.
23181 * @param obj The index object.
23182 * @return The last item @b selected on @p obj (or @c NULL, on errors).
23186 EAPI Elm_Index_Item *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23189 * Append a new item on a given index widget.
23191 * @param obj The index object.
23192 * @param letter Letter under which the item should be indexed
23193 * @param item The item data to set for the index's item
23195 * Despite the most common usage of the @p letter argument is for
23196 * single char strings, one could use arbitrary strings as index
23199 * @c item will be the pointer returned back on @c "changed", @c
23200 * "delay,changed" and @c "selected" smart events.
23204 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23207 * Prepend a new item on a given index widget.
23209 * @param obj The index object.
23210 * @param letter Letter under which the item should be indexed
23211 * @param item The item data to set for the index's item
23213 * Despite the most common usage of the @p letter argument is for
23214 * single char strings, one could use arbitrary strings as index
23217 * @c item will be the pointer returned back on @c "changed", @c
23218 * "delay,changed" and @c "selected" smart events.
23222 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23225 * Append a new item, on a given index widget, <b>after the item
23226 * having @p relative as data</b>.
23228 * @param obj The index object.
23229 * @param letter Letter under which the item should be indexed
23230 * @param item The item data to set for the index's item
23231 * @param relative The index item to be the predecessor of this new one
23233 * Despite the most common usage of the @p letter argument is for
23234 * single char strings, one could use arbitrary strings as index
23237 * @c item will be the pointer returned back on @c "changed", @c
23238 * "delay,changed" and @c "selected" smart events.
23240 * @note If @p relative is @c NULL this function will behave as
23241 * elm_index_item_append().
23245 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23248 * Prepend a new item, on a given index widget, <b>after the item
23249 * having @p relative as data</b>.
23251 * @param obj The index object.
23252 * @param letter Letter under which the item should be indexed
23253 * @param item The item data to set for the index's item
23254 * @param relative The index item to be the successor of this new one
23256 * Despite the most common usage of the @p letter argument is for
23257 * single char strings, one could use arbitrary strings as index
23260 * @c item will be the pointer returned back on @c "changed", @c
23261 * "delay,changed" and @c "selected" smart events.
23263 * @note If @p relative is @c NULL this function will behave as
23264 * elm_index_item_prepend().
23268 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23271 * Insert a new item into the given index widget, using @p cmp_func
23272 * function to sort items (by item handles).
23274 * @param obj The index object.
23275 * @param letter Letter under which the item should be indexed
23276 * @param item The item data to set for the index's item
23277 * @param cmp_func The comparing function to be used to sort index
23278 * items <b>by #Elm_Index_Item item handles</b>
23279 * @param cmp_data_func A @b fallback function to be called for the
23280 * sorting of index items <b>by item data</b>). It will be used
23281 * when @p cmp_func returns @c 0 (equality), which means an index
23282 * item with provided item data already exists. To decide which
23283 * data item should be pointed to by the index item in question, @p
23284 * cmp_data_func will be used. If @p cmp_data_func returns a
23285 * non-negative value, the previous index item data will be
23286 * replaced by the given @p item pointer. If the previous data need
23287 * to be freed, it should be done by the @p cmp_data_func function,
23288 * because all references to it will be lost. If this function is
23289 * not provided (@c NULL is given), index items will be @b
23290 * duplicated, if @p cmp_func returns @c 0.
23292 * Despite the most common usage of the @p letter argument is for
23293 * single char strings, one could use arbitrary strings as index
23296 * @c item will be the pointer returned back on @c "changed", @c
23297 * "delay,changed" and @c "selected" smart events.
23301 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);
23304 * Remove an item from a given index widget, <b>to be referenced by
23305 * it's data value</b>.
23307 * @param obj The index object
23308 * @param item The item to be removed from @p obj
23310 * If a deletion callback is set, via elm_index_item_del_cb_set(),
23311 * that callback function will be called by this one.
23315 EAPI void elm_index_item_del(Evas_Object *obj, Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23318 * Find a given index widget's item, <b>using item data</b>.
23320 * @param obj The index object
23321 * @param item The item data pointed to by the desired index item
23322 * @return The index item handle, if found, or @c NULL otherwise
23326 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
23329 * Removes @b all items from a given index widget.
23331 * @param obj The index object.
23333 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
23334 * that callback function will be called for each item in @p obj.
23338 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23341 * Go to a given items level on a index widget
23343 * @param obj The index object
23344 * @param level The index level (one of @c 0 or @c 1)
23348 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23351 * Return the data associated with a given index widget item
23353 * @param it The index widget item handle
23354 * @return The data associated with @p it
23356 * @see elm_index_item_data_set()
23360 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23363 * Set the data associated with a given index widget item
23365 * @param it The index widget item handle
23366 * @param data The new data pointer to set to @p it
23368 * This sets new item data on @p it.
23370 * @warning The old data pointer won't be touched by this function, so
23371 * the user had better to free that old data himself/herself.
23375 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
23378 * Set the function to be called when a given index widget item is freed.
23380 * @param it The item to set the callback on
23381 * @param func The function to call on the item's deletion
23383 * When called, @p func will have both @c data and @c event_info
23384 * arguments with the @p it item's data value and, naturally, the
23385 * @c obj argument with a handle to the parent index widget.
23389 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23392 * Get the letter (string) set on a given index widget item.
23394 * @param it The index item handle
23395 * @return The letter string set on @p it
23399 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23406 * @defgroup Photocam Photocam
23408 * @image html img/widget/photocam/preview-00.png
23409 * @image latex img/widget/photocam/preview-00.eps
23411 * This is a widget specifically for displaying high-resolution digital
23412 * camera photos giving speedy feedback (fast load), low memory footprint
23413 * and zooming and panning as well as fitting logic. It is entirely focused
23414 * on jpeg images, and takes advantage of properties of the jpeg format (via
23415 * evas loader features in the jpeg loader).
23417 * Signals that you can add callbacks for are:
23418 * @li "clicked" - This is called when a user has clicked the photo without
23420 * @li "press" - This is called when a user has pressed down on the photo.
23421 * @li "longpressed" - This is called when a user has pressed down on the
23422 * photo for a long time without dragging around.
23423 * @li "clicked,double" - This is called when a user has double-clicked the
23425 * @li "load" - Photo load begins.
23426 * @li "loaded" - This is called when the image file load is complete for the
23427 * first view (low resolution blurry version).
23428 * @li "load,detail" - Photo detailed data load begins.
23429 * @li "loaded,detail" - This is called when the image file load is complete
23430 * for the detailed image data (full resolution needed).
23431 * @li "zoom,start" - Zoom animation started.
23432 * @li "zoom,stop" - Zoom animation stopped.
23433 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
23434 * @li "scroll" - the content has been scrolled (moved)
23435 * @li "scroll,anim,start" - scrolling animation has started
23436 * @li "scroll,anim,stop" - scrolling animation has stopped
23437 * @li "scroll,drag,start" - dragging the contents around has started
23438 * @li "scroll,drag,stop" - dragging the contents around has stopped
23440 * @ref tutorial_photocam shows the API in action.
23445 * @brief Types of zoom available.
23447 typedef enum _Elm_Photocam_Zoom_Mode
23449 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
23450 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
23451 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
23452 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Unzoom until photo fits in photocam */
23453 ELM_PHOTOCAM_ZOOM_MODE_LAST
23454 } Elm_Photocam_Zoom_Mode;
23457 * @brief Add a new Photocam object
23459 * @param parent The parent object
23460 * @return The new object or NULL if it cannot be created
23462 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23465 * @brief Set the photo file to be shown
23467 * @param obj The photocam object
23468 * @param file The photo file
23469 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
23471 * This sets (and shows) the specified file (with a relative or absolute
23472 * path) and will return a load error (same error that
23473 * evas_object_image_load_error_get() will return). The image will change and
23474 * adjust its size at this point and begin a background load process for this
23475 * photo that at some time in the future will be displayed at the full
23478 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
23481 * @brief Returns the path of the current image file
23483 * @param obj The photocam object
23484 * @return Returns the path
23486 * @see elm_photocam_file_set()
23488 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23491 * @brief Set the zoom level of the photo
23493 * @param obj The photocam object
23494 * @param zoom The zoom level to set
23496 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
23497 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
23498 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
23499 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
23502 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
23505 * @brief Get the zoom level of the photo
23507 * @param obj The photocam object
23508 * @return The current zoom level
23510 * This returns the current zoom level of the photocam object. Note that if
23511 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
23512 * (which is the default), the zoom level may be changed at any time by the
23513 * photocam object itself to account for photo size and photocam viewpoer
23516 * @see elm_photocam_zoom_set()
23517 * @see elm_photocam_zoom_mode_set()
23519 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23522 * @brief Set the zoom mode
23524 * @param obj The photocam object
23525 * @param mode The desired mode
23527 * This sets the zoom mode to manual or one of several automatic levels.
23528 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
23529 * elm_photocam_zoom_set() and will stay at that level until changed by code
23530 * or until zoom mode is changed. This is the default mode. The Automatic
23531 * modes will allow the photocam object to automatically adjust zoom mode
23532 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
23533 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
23534 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
23535 * pixels within the frame are left unfilled.
23537 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23540 * @brief Get the zoom mode
23542 * @param obj The photocam object
23543 * @return The current zoom mode
23545 * This gets the current zoom mode of the photocam object.
23547 * @see elm_photocam_zoom_mode_set()
23549 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23552 * @brief Get the current image pixel width and height
23554 * @param obj The photocam object
23555 * @param w A pointer to the width return
23556 * @param h A pointer to the height return
23558 * This gets the current photo pixel width and height (for the original).
23559 * The size will be returned in the integers @p w and @p h that are pointed
23562 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
23565 * @brief Get the area of the image that is currently shown
23568 * @param x A pointer to the X-coordinate of region
23569 * @param y A pointer to the Y-coordinate of region
23570 * @param w A pointer to the width
23571 * @param h A pointer to the height
23573 * @see elm_photocam_image_region_show()
23574 * @see elm_photocam_image_region_bring_in()
23576 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
23579 * @brief Set the viewed portion of the image
23581 * @param obj The photocam object
23582 * @param x X-coordinate of region in image original pixels
23583 * @param y Y-coordinate of region in image original pixels
23584 * @param w Width of region in image original pixels
23585 * @param h Height of region in image original pixels
23587 * This shows the region of the image without using animation.
23589 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23592 * @brief Bring in the viewed portion of the image
23594 * @param obj The photocam object
23595 * @param x X-coordinate of region in image original pixels
23596 * @param y Y-coordinate of region in image original pixels
23597 * @param w Width of region in image original pixels
23598 * @param h Height of region in image original pixels
23600 * This shows the region of the image using animation.
23602 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23605 * @brief Set the paused state for photocam
23607 * @param obj The photocam object
23608 * @param paused The pause state to set
23610 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
23611 * photocam. The default is off. This will stop zooming using animation on
23612 * zoom levels changes and change instantly. This will stop any existing
23613 * animations that are running.
23615 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23618 * @brief Get the paused state for photocam
23620 * @param obj The photocam object
23621 * @return The current paused state
23623 * This gets the current paused state for the photocam object.
23625 * @see elm_photocam_paused_set()
23627 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23630 * @brief Get the internal low-res image used for photocam
23632 * @param obj The photocam object
23633 * @return The internal image object handle, or NULL if none exists
23635 * This gets the internal image object inside photocam. Do not modify it. It
23636 * is for inspection only, and hooking callbacks to. Nothing else. It may be
23637 * deleted at any time as well.
23639 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23642 * @brief Set the photocam scrolling bouncing.
23644 * @param obj The photocam object
23645 * @param h_bounce bouncing for horizontal
23646 * @param v_bounce bouncing for vertical
23648 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23651 * @brief Get the photocam scrolling bouncing.
23653 * @param obj The photocam object
23654 * @param h_bounce bouncing for horizontal
23655 * @param v_bounce bouncing for vertical
23657 * @see elm_photocam_bounce_set()
23659 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23666 * @defgroup Map Map
23667 * @ingroup Elementary
23669 * @image html img/widget/map/preview-00.png
23670 * @image latex img/widget/map/preview-00.eps
23672 * This is a widget specifically for displaying a map. It uses basically
23673 * OpenStreetMap provider http://www.openstreetmap.org/,
23674 * but custom providers can be added.
23676 * It supports some basic but yet nice features:
23677 * @li zoom and scroll
23678 * @li markers with content to be displayed when user clicks over it
23679 * @li group of markers
23682 * Smart callbacks one can listen to:
23684 * - "clicked" - This is called when a user has clicked the map without
23686 * - "press" - This is called when a user has pressed down on the map.
23687 * - "longpressed" - This is called when a user has pressed down on the map
23688 * for a long time without dragging around.
23689 * - "clicked,double" - This is called when a user has double-clicked
23691 * - "load,detail" - Map detailed data load begins.
23692 * - "loaded,detail" - This is called when all currently visible parts of
23693 * the map are loaded.
23694 * - "zoom,start" - Zoom animation started.
23695 * - "zoom,stop" - Zoom animation stopped.
23696 * - "zoom,change" - Zoom changed when using an auto zoom mode.
23697 * - "scroll" - the content has been scrolled (moved).
23698 * - "scroll,anim,start" - scrolling animation has started.
23699 * - "scroll,anim,stop" - scrolling animation has stopped.
23700 * - "scroll,drag,start" - dragging the contents around has started.
23701 * - "scroll,drag,stop" - dragging the contents around has stopped.
23702 * - "downloaded" - This is called when all currently required map images
23704 * - "route,load" - This is called when route request begins.
23705 * - "route,loaded" - This is called when route request ends.
23706 * - "name,load" - This is called when name request begins.
23707 * - "name,loaded- This is called when name request ends.
23709 * Available style for map widget:
23712 * Available style for markers:
23717 * Available style for marker bubble:
23720 * List of examples:
23721 * @li @ref map_example_01
23722 * @li @ref map_example_02
23723 * @li @ref map_example_03
23732 * @enum _Elm_Map_Zoom_Mode
23733 * @typedef Elm_Map_Zoom_Mode
23735 * Set map's zoom behavior. It can be set to manual or automatic.
23737 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
23739 * Values <b> don't </b> work as bitmask, only one can be choosen.
23741 * @note Valid sizes are 2^zoom, consequently the map may be smaller
23742 * than the scroller view.
23744 * @see elm_map_zoom_mode_set()
23745 * @see elm_map_zoom_mode_get()
23749 typedef enum _Elm_Map_Zoom_Mode
23751 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
23752 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
23753 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
23754 ELM_MAP_ZOOM_MODE_LAST
23755 } Elm_Map_Zoom_Mode;
23758 * @enum _Elm_Map_Route_Sources
23759 * @typedef Elm_Map_Route_Sources
23761 * Set route service to be used. By default used source is
23762 * #ELM_MAP_ROUTE_SOURCE_YOURS.
23764 * @see elm_map_route_source_set()
23765 * @see elm_map_route_source_get()
23769 typedef enum _Elm_Map_Route_Sources
23771 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
23772 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. */
23773 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
23774 ELM_MAP_ROUTE_SOURCE_LAST
23775 } Elm_Map_Route_Sources;
23777 typedef enum _Elm_Map_Name_Sources
23779 ELM_MAP_NAME_SOURCE_NOMINATIM,
23780 ELM_MAP_NAME_SOURCE_LAST
23781 } Elm_Map_Name_Sources;
23784 * @enum _Elm_Map_Route_Type
23785 * @typedef Elm_Map_Route_Type
23787 * Set type of transport used on route.
23789 * @see elm_map_route_add()
23793 typedef enum _Elm_Map_Route_Type
23795 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
23796 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
23797 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
23798 ELM_MAP_ROUTE_TYPE_LAST
23799 } Elm_Map_Route_Type;
23802 * @enum _Elm_Map_Route_Method
23803 * @typedef Elm_Map_Route_Method
23805 * Set the routing method, what should be priorized, time or distance.
23807 * @see elm_map_route_add()
23811 typedef enum _Elm_Map_Route_Method
23813 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23814 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23815 ELM_MAP_ROUTE_METHOD_LAST
23816 } Elm_Map_Route_Method;
23818 typedef enum _Elm_Map_Name_Method
23820 ELM_MAP_NAME_METHOD_SEARCH,
23821 ELM_MAP_NAME_METHOD_REVERSE,
23822 ELM_MAP_NAME_METHOD_LAST
23823 } Elm_Map_Name_Method;
23825 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(). */
23826 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(). */
23827 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(). */
23828 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(). */
23829 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
23830 typedef struct _Elm_Map_Track Elm_Map_Track;
23832 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. */
23833 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23834 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23835 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23837 typedef char *(*ElmMapModuleSourceFunc) (void);
23838 typedef int (*ElmMapModuleZoomMinFunc) (void);
23839 typedef int (*ElmMapModuleZoomMaxFunc) (void);
23840 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23841 typedef int (*ElmMapModuleRouteSourceFunc) (void);
23842 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23843 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23844 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23845 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23848 * Add a new map widget to the given parent Elementary (container) object.
23850 * @param parent The parent object.
23851 * @return a new map widget handle or @c NULL, on errors.
23853 * This function inserts a new map widget on the canvas.
23857 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23860 * Set the zoom level of the map.
23862 * @param obj The map object.
23863 * @param zoom The zoom level to set.
23865 * This sets the zoom level.
23867 * It will respect limits defined by elm_map_source_zoom_min_set() and
23868 * elm_map_source_zoom_max_set().
23870 * By default these values are 0 (world map) and 18 (maximum zoom).
23872 * This function should be used when zoom mode is set to
23873 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23874 * with elm_map_zoom_mode_set().
23876 * @see elm_map_zoom_mode_set().
23877 * @see elm_map_zoom_get().
23881 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23884 * Get the zoom level of the map.
23886 * @param obj The map object.
23887 * @return The current zoom level.
23889 * This returns the current zoom level of the map object.
23891 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23892 * (which is the default), the zoom level may be changed at any time by the
23893 * map object itself to account for map size and map viewport size.
23895 * @see elm_map_zoom_set() for details.
23899 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23902 * Set the zoom mode used by the map object.
23904 * @param obj The map object.
23905 * @param mode The zoom mode of the map, being it one of
23906 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23907 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23909 * This sets the zoom mode to manual or one of the automatic levels.
23910 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23911 * elm_map_zoom_set() and will stay at that level until changed by code
23912 * or until zoom mode is changed. This is the default mode.
23914 * The Automatic modes will allow the map object to automatically
23915 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23916 * adjust zoom so the map fits inside the scroll frame with no pixels
23917 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23918 * ensure no pixels within the frame are left unfilled. Do not forget that
23919 * the valid sizes are 2^zoom, consequently the map may be smaller than
23920 * the scroller view.
23922 * @see elm_map_zoom_set()
23926 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23929 * Get the zoom mode used by the map object.
23931 * @param obj The map object.
23932 * @return The zoom mode of the map, being it one of
23933 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23934 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23936 * This function returns the current zoom mode used by the map object.
23938 * @see elm_map_zoom_mode_set() for more details.
23942 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23945 * Get the current coordinates of the map.
23947 * @param obj The map object.
23948 * @param lon Pointer where to store longitude.
23949 * @param lat Pointer where to store latitude.
23951 * This gets the current center coordinates of the map object. It can be
23952 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23954 * @see elm_map_geo_region_bring_in()
23955 * @see elm_map_geo_region_show()
23959 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23962 * Animatedly bring in given coordinates to the center of the map.
23964 * @param obj The map object.
23965 * @param lon Longitude to center at.
23966 * @param lat Latitude to center at.
23968 * This causes map to jump to the given @p lat and @p lon coordinates
23969 * and show it (by scrolling) in the center of the viewport, if it is not
23970 * already centered. This will use animation to do so and take a period
23971 * of time to complete.
23973 * @see elm_map_geo_region_show() for a function to avoid animation.
23974 * @see elm_map_geo_region_get()
23978 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23981 * Show the given coordinates at the center of the map, @b immediately.
23983 * @param obj The map object.
23984 * @param lon Longitude to center at.
23985 * @param lat Latitude to center at.
23987 * This causes map to @b redraw its viewport's contents to the
23988 * region contining the given @p lat and @p lon, that will be moved to the
23989 * center of the map.
23991 * @see elm_map_geo_region_bring_in() for a function to move with animation.
23992 * @see elm_map_geo_region_get()
23996 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23999 * Pause or unpause the map.
24001 * @param obj The map object.
24002 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
24005 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24008 * The default is off.
24010 * This will stop zooming using animation, changing zoom levels will
24011 * change instantly. This will stop any existing animations that are running.
24013 * @see elm_map_paused_get()
24017 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24020 * Get a value whether map is paused or not.
24022 * @param obj The map object.
24023 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
24024 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24026 * This gets the current paused state for the map object.
24028 * @see elm_map_paused_set() for details.
24032 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24035 * Set to show markers during zoom level changes or not.
24037 * @param obj The map object.
24038 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
24041 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24044 * The default is off.
24046 * This will stop zooming using animation, changing zoom levels will
24047 * change instantly. This will stop any existing animations that are running.
24049 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24052 * The default is off.
24054 * Enabling it will force the map to stop displaying the markers during
24055 * zoom level changes. Set to on if you have a large number of markers.
24057 * @see elm_map_paused_markers_get()
24061 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24064 * Get a value whether markers will be displayed on zoom level changes or not
24066 * @param obj The map object.
24067 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
24068 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
24070 * This gets the current markers paused state for the map object.
24072 * @see elm_map_paused_markers_set() for details.
24076 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24079 * Get the information of downloading status.
24081 * @param obj The map object.
24082 * @param try_num Pointer where to store number of tiles being downloaded.
24083 * @param finish_num Pointer where to store number of tiles successfully
24086 * This gets the current downloading status for the map object, the number
24087 * of tiles being downloaded and the number of tiles already downloaded.
24091 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
24094 * Convert a pixel coordinate (x,y) into a geographic coordinate
24095 * (longitude, latitude).
24097 * @param obj The map object.
24098 * @param x the coordinate.
24099 * @param y the coordinate.
24100 * @param size the size in pixels of the map.
24101 * The map is a square and generally his size is : pow(2.0, zoom)*256.
24102 * @param lon Pointer where to store the longitude that correspond to x.
24103 * @param lat Pointer where to store the latitude that correspond to y.
24105 * @note Origin pixel point is the top left corner of the viewport.
24106 * Map zoom and size are taken on account.
24108 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
24112 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);
24115 * Convert a geographic coordinate (longitude, latitude) into a pixel
24116 * coordinate (x, y).
24118 * @param obj The map object.
24119 * @param lon the longitude.
24120 * @param lat the latitude.
24121 * @param size the size in pixels of the map. The map is a square
24122 * and generally his size is : pow(2.0, zoom)*256.
24123 * @param x Pointer where to store the horizontal pixel coordinate that
24124 * correspond to the longitude.
24125 * @param y Pointer where to store the vertical pixel coordinate that
24126 * correspond to the latitude.
24128 * @note Origin pixel point is the top left corner of the viewport.
24129 * Map zoom and size are taken on account.
24131 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
24135 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);
24138 * Convert a geographic coordinate (longitude, latitude) into a name
24141 * @param obj The map object.
24142 * @param lon the longitude.
24143 * @param lat the latitude.
24144 * @return name A #Elm_Map_Name handle for this coordinate.
24146 * To get the string for this address, elm_map_name_address_get()
24149 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
24153 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24156 * Convert a name (address) into a geographic coordinate
24157 * (longitude, latitude).
24159 * @param obj The map object.
24160 * @param name The address.
24161 * @return name A #Elm_Map_Name handle for this address.
24163 * To get the longitude and latitude, elm_map_name_region_get()
24166 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
24170 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
24173 * Convert a pixel coordinate into a rotated pixel coordinate.
24175 * @param obj The map object.
24176 * @param x horizontal coordinate of the point to rotate.
24177 * @param y vertical coordinate of the point to rotate.
24178 * @param cx rotation's center horizontal position.
24179 * @param cy rotation's center vertical position.
24180 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
24181 * @param xx Pointer where to store rotated x.
24182 * @param yy Pointer where to store rotated y.
24186 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);
24189 * Add a new marker to the map object.
24191 * @param obj The map object.
24192 * @param lon The longitude of the marker.
24193 * @param lat The latitude of the marker.
24194 * @param clas The class, to use when marker @b isn't grouped to others.
24195 * @param clas_group The class group, to use when marker is grouped to others
24196 * @param data The data passed to the callbacks.
24198 * @return The created marker or @c NULL upon failure.
24200 * A marker will be created and shown in a specific point of the map, defined
24201 * by @p lon and @p lat.
24203 * It will be displayed using style defined by @p class when this marker
24204 * is displayed alone (not grouped). A new class can be created with
24205 * elm_map_marker_class_new().
24207 * If the marker is grouped to other markers, it will be displayed with
24208 * style defined by @p class_group. Markers with the same group are grouped
24209 * if they are close. A new group class can be created with
24210 * elm_map_marker_group_class_new().
24212 * Markers created with this method can be deleted with
24213 * elm_map_marker_remove().
24215 * A marker can have associated content to be displayed by a bubble,
24216 * when a user click over it, as well as an icon. These objects will
24217 * be fetch using class' callback functions.
24219 * @see elm_map_marker_class_new()
24220 * @see elm_map_marker_group_class_new()
24221 * @see elm_map_marker_remove()
24225 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);
24228 * Set the maximum numbers of markers' content to be displayed in a group.
24230 * @param obj The map object.
24231 * @param max The maximum numbers of items displayed in a bubble.
24233 * A bubble will be displayed when the user clicks over the group,
24234 * and will place the content of markers that belong to this group
24237 * A group can have a long list of markers, consequently the creation
24238 * of the content of the bubble can be very slow.
24240 * In order to avoid this, a maximum number of items is displayed
24243 * By default this number is 30.
24245 * Marker with the same group class are grouped if they are close.
24247 * @see elm_map_marker_add()
24251 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
24254 * Remove a marker from the map.
24256 * @param marker The marker to remove.
24258 * @see elm_map_marker_add()
24262 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24265 * Get the current coordinates of the marker.
24267 * @param marker marker.
24268 * @param lat Pointer where to store the marker's latitude.
24269 * @param lon Pointer where to store the marker's longitude.
24271 * These values are set when adding markers, with function
24272 * elm_map_marker_add().
24274 * @see elm_map_marker_add()
24278 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
24281 * Animatedly bring in given marker to the center of the map.
24283 * @param marker The marker to center at.
24285 * This causes map to jump to the given @p marker's coordinates
24286 * and show it (by scrolling) in the center of the viewport, if it is not
24287 * already centered. This will use animation to do so and take a period
24288 * of time to complete.
24290 * @see elm_map_marker_show() for a function to avoid animation.
24291 * @see elm_map_marker_region_get()
24295 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24298 * Show the given marker at the center of the map, @b immediately.
24300 * @param marker The marker to center at.
24302 * This causes map to @b redraw its viewport's contents to the
24303 * region contining the given @p marker's coordinates, that will be
24304 * moved to the center of the map.
24306 * @see elm_map_marker_bring_in() for a function to move with animation.
24307 * @see elm_map_markers_list_show() if more than one marker need to be
24309 * @see elm_map_marker_region_get()
24313 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24316 * Move and zoom the map to display a list of markers.
24318 * @param markers A list of #Elm_Map_Marker handles.
24320 * The map will be centered on the center point of the markers in the list.
24321 * Then the map will be zoomed in order to fit the markers using the maximum
24322 * zoom which allows display of all the markers.
24324 * @warning All the markers should belong to the same map object.
24326 * @see elm_map_marker_show() to show a single marker.
24327 * @see elm_map_marker_bring_in()
24331 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
24334 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
24336 * @param marker The marker wich content should be returned.
24337 * @return Return the evas object if it exists, else @c NULL.
24339 * To set callback function #ElmMapMarkerGetFunc for the marker class,
24340 * elm_map_marker_class_get_cb_set() should be used.
24342 * This content is what will be inside the bubble that will be displayed
24343 * when an user clicks over the marker.
24345 * This returns the actual Evas object used to be placed inside
24346 * the bubble. This may be @c NULL, as it may
24347 * not have been created or may have been deleted, at any time, by
24348 * the map. <b>Do not modify this object</b> (move, resize,
24349 * show, hide, etc.), as the map is controlling it. This
24350 * function is for querying, emitting custom signals or hooking
24351 * lower level callbacks for events on that object. Do not delete
24352 * this object under any circumstances.
24356 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24359 * Update the marker
24361 * @param marker The marker to be updated.
24363 * If a content is set to this marker, it will call function to delete it,
24364 * #ElmMapMarkerDelFunc, and then will fetch the content again with
24365 * #ElmMapMarkerGetFunc.
24367 * These functions are set for the marker class with
24368 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
24372 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24375 * Close all the bubbles opened by the user.
24377 * @param obj The map object.
24379 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
24380 * when the user clicks on a marker.
24382 * This functions is set for the marker class with
24383 * elm_map_marker_class_get_cb_set().
24387 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
24390 * Create a new group class.
24392 * @param obj The map object.
24393 * @return Returns the new group class.
24395 * Each marker must be associated to a group class. Markers in the same
24396 * group are grouped if they are close.
24398 * The group class defines the style of the marker when a marker is grouped
24399 * to others markers. When it is alone, another class will be used.
24401 * A group class will need to be provided when creating a marker with
24402 * elm_map_marker_add().
24404 * Some properties and functions can be set by class, as:
24405 * - style, with elm_map_group_class_style_set()
24406 * - data - to be associated to the group class. It can be set using
24407 * elm_map_group_class_data_set().
24408 * - min zoom to display markers, set with
24409 * elm_map_group_class_zoom_displayed_set().
24410 * - max zoom to group markers, set using
24411 * elm_map_group_class_zoom_grouped_set().
24412 * - visibility - set if markers will be visible or not, set with
24413 * elm_map_group_class_hide_set().
24414 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
24415 * It can be set using elm_map_group_class_icon_cb_set().
24417 * @see elm_map_marker_add()
24418 * @see elm_map_group_class_style_set()
24419 * @see elm_map_group_class_data_set()
24420 * @see elm_map_group_class_zoom_displayed_set()
24421 * @see elm_map_group_class_zoom_grouped_set()
24422 * @see elm_map_group_class_hide_set()
24423 * @see elm_map_group_class_icon_cb_set()
24427 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24430 * Set the marker's style of a group class.
24432 * @param clas The group class.
24433 * @param style The style to be used by markers.
24435 * Each marker must be associated to a group class, and will use the style
24436 * defined by such class when grouped to other markers.
24438 * The following styles are provided by default theme:
24439 * @li @c radio - blue circle
24440 * @li @c radio2 - green circle
24443 * @see elm_map_group_class_new() for more details.
24444 * @see elm_map_marker_add()
24448 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24451 * Set the icon callback function of a group class.
24453 * @param clas The group class.
24454 * @param icon_get The callback function that will return the icon.
24456 * Each marker must be associated to a group class, and it can display a
24457 * custom icon. The function @p icon_get must return this icon.
24459 * @see elm_map_group_class_new() for more details.
24460 * @see elm_map_marker_add()
24464 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24467 * Set the data associated to the group class.
24469 * @param clas The group class.
24470 * @param data The new user data.
24472 * This data will be passed for callback functions, like icon get callback,
24473 * that can be set with elm_map_group_class_icon_cb_set().
24475 * If a data was previously set, the object will lose the pointer for it,
24476 * so if needs to be freed, you must do it yourself.
24478 * @see elm_map_group_class_new() for more details.
24479 * @see elm_map_group_class_icon_cb_set()
24480 * @see elm_map_marker_add()
24484 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
24487 * Set the minimum zoom from where the markers are displayed.
24489 * @param clas The group class.
24490 * @param zoom The minimum zoom.
24492 * Markers only will be displayed when the map is displayed at @p zoom
24495 * @see elm_map_group_class_new() for more details.
24496 * @see elm_map_marker_add()
24500 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24503 * Set the zoom from where the markers are no more grouped.
24505 * @param clas The group class.
24506 * @param zoom The maximum zoom.
24508 * Markers only will be grouped when the map is displayed at
24509 * less than @p zoom.
24511 * @see elm_map_group_class_new() for more details.
24512 * @see elm_map_marker_add()
24516 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24519 * Set if the markers associated to the group class @clas are hidden or not.
24521 * @param clas The group class.
24522 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
24525 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
24530 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
24533 * Create a new marker class.
24535 * @param obj The map object.
24536 * @return Returns the new group class.
24538 * Each marker must be associated to a class.
24540 * The marker class defines the style of the marker when a marker is
24541 * displayed alone, i.e., not grouped to to others markers. When grouped
24542 * it will use group class style.
24544 * A marker class will need to be provided when creating a marker with
24545 * elm_map_marker_add().
24547 * Some properties and functions can be set by class, as:
24548 * - style, with elm_map_marker_class_style_set()
24549 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
24550 * It can be set using elm_map_marker_class_icon_cb_set().
24551 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
24552 * Set using elm_map_marker_class_get_cb_set().
24553 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
24554 * Set using elm_map_marker_class_del_cb_set().
24556 * @see elm_map_marker_add()
24557 * @see elm_map_marker_class_style_set()
24558 * @see elm_map_marker_class_icon_cb_set()
24559 * @see elm_map_marker_class_get_cb_set()
24560 * @see elm_map_marker_class_del_cb_set()
24564 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24567 * Set the marker's style of a marker class.
24569 * @param clas The marker class.
24570 * @param style The style to be used by markers.
24572 * Each marker must be associated to a marker class, and will use the style
24573 * defined by such class when alone, i.e., @b not grouped to other markers.
24575 * The following styles are provided by default theme:
24580 * @see elm_map_marker_class_new() for more details.
24581 * @see elm_map_marker_add()
24585 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24588 * Set the icon callback function of a marker class.
24590 * @param clas The marker class.
24591 * @param icon_get The callback function that will return the icon.
24593 * Each marker must be associated to a marker class, and it can display a
24594 * custom icon. The function @p icon_get must return this icon.
24596 * @see elm_map_marker_class_new() for more details.
24597 * @see elm_map_marker_add()
24601 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24604 * Set the bubble content callback function of a marker class.
24606 * @param clas The marker class.
24607 * @param get The callback function that will return the content.
24609 * Each marker must be associated to a marker class, and it can display a
24610 * a content on a bubble that opens when the user click over the marker.
24611 * The function @p get must return this content object.
24613 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
24616 * @see elm_map_marker_class_new() for more details.
24617 * @see elm_map_marker_class_del_cb_set()
24618 * @see elm_map_marker_add()
24622 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
24625 * Set the callback function used to delete bubble content of a marker class.
24627 * @param clas The marker class.
24628 * @param del The callback function that will delete the content.
24630 * Each marker must be associated to a marker class, and it can display a
24631 * a content on a bubble that opens when the user click over the marker.
24632 * The function to return such content can be set with
24633 * elm_map_marker_class_get_cb_set().
24635 * If this content must be freed, a callback function need to be
24636 * set for that task with this function.
24638 * If this callback is defined it will have to delete (or not) the
24639 * object inside, but if the callback is not defined the object will be
24640 * destroyed with evas_object_del().
24642 * @see elm_map_marker_class_new() for more details.
24643 * @see elm_map_marker_class_get_cb_set()
24644 * @see elm_map_marker_add()
24648 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
24651 * Get the list of available sources.
24653 * @param obj The map object.
24654 * @return The source names list.
24656 * It will provide a list with all available sources, that can be set as
24657 * current source with elm_map_source_name_set(), or get with
24658 * elm_map_source_name_get().
24660 * Available sources:
24666 * @see elm_map_source_name_set() for more details.
24667 * @see elm_map_source_name_get()
24671 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24674 * Set the source of the map.
24676 * @param obj The map object.
24677 * @param source The source to be used.
24679 * Map widget retrieves images that composes the map from a web service.
24680 * This web service can be set with this method.
24682 * A different service can return a different maps with different
24683 * information and it can use different zoom values.
24685 * The @p source_name need to match one of the names provided by
24686 * elm_map_source_names_get().
24688 * The current source can be get using elm_map_source_name_get().
24690 * @see elm_map_source_names_get()
24691 * @see elm_map_source_name_get()
24696 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
24699 * Get the name of currently used source.
24701 * @param obj The map object.
24702 * @return Returns the name of the source in use.
24704 * @see elm_map_source_name_set() for more details.
24708 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24711 * Set the source of the route service to be used by the map.
24713 * @param obj The map object.
24714 * @param source The route service to be used, being it one of
24715 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
24716 * and #ELM_MAP_ROUTE_SOURCE_ORS.
24718 * Each one has its own algorithm, so the route retrieved may
24719 * differ depending on the source route. Now, only the default is working.
24721 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
24722 * http://www.yournavigation.org/.
24724 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
24725 * assumptions. Its routing core is based on Contraction Hierarchies.
24727 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
24729 * @see elm_map_route_source_get().
24733 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
24736 * Get the current route source.
24738 * @param obj The map object.
24739 * @return The source of the route service used by the map.
24741 * @see elm_map_route_source_set() for details.
24745 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24748 * Set the minimum zoom of the source.
24750 * @param obj The map object.
24751 * @param zoom New minimum zoom value to be used.
24753 * By default, it's 0.
24757 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24760 * Get the minimum zoom of the source.
24762 * @param obj The map object.
24763 * @return Returns the minimum zoom of the source.
24765 * @see elm_map_source_zoom_min_set() for details.
24769 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24772 * Set the maximum zoom of the source.
24774 * @param obj The map object.
24775 * @param zoom New maximum zoom value to be used.
24777 * By default, it's 18.
24781 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24784 * Get the maximum zoom of the source.
24786 * @param obj The map object.
24787 * @return Returns the maximum zoom of the source.
24789 * @see elm_map_source_zoom_min_set() for details.
24793 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24796 * Set the user agent used by the map object to access routing services.
24798 * @param obj The map object.
24799 * @param user_agent The user agent to be used by the map.
24801 * User agent is a client application implementing a network protocol used
24802 * in communications within a clientāserver distributed computing system
24804 * The @p user_agent identification string will transmitted in a header
24805 * field @c User-Agent.
24807 * @see elm_map_user_agent_get()
24811 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24814 * Get the user agent used by the map object.
24816 * @param obj The map object.
24817 * @return The user agent identification string used by the map.
24819 * @see elm_map_user_agent_set() for details.
24823 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24826 * Add a new route to the map object.
24828 * @param obj The map object.
24829 * @param type The type of transport to be considered when tracing a route.
24830 * @param method The routing method, what should be priorized.
24831 * @param flon The start longitude.
24832 * @param flat The start latitude.
24833 * @param tlon The destination longitude.
24834 * @param tlat The destination latitude.
24836 * @return The created route or @c NULL upon failure.
24838 * A route will be traced by point on coordinates (@p flat, @p flon)
24839 * to point on coordinates (@p tlat, @p tlon), using the route service
24840 * set with elm_map_route_source_set().
24842 * It will take @p type on consideration to define the route,
24843 * depending if the user will be walking or driving, the route may vary.
24844 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24845 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24847 * Another parameter is what the route should priorize, the minor distance
24848 * or the less time to be spend on the route. So @p method should be one
24849 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24851 * Routes created with this method can be deleted with
24852 * elm_map_route_remove(), colored with elm_map_route_color_set(),
24853 * and distance can be get with elm_map_route_distance_get().
24855 * @see elm_map_route_remove()
24856 * @see elm_map_route_color_set()
24857 * @see elm_map_route_distance_get()
24858 * @see elm_map_route_source_set()
24862 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);
24865 * Remove a route from the map.
24867 * @param route The route to remove.
24869 * @see elm_map_route_add()
24873 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24876 * Set the route color.
24878 * @param route The route object.
24879 * @param r Red channel value, from 0 to 255.
24880 * @param g Green channel value, from 0 to 255.
24881 * @param b Blue channel value, from 0 to 255.
24882 * @param a Alpha channel value, from 0 to 255.
24884 * It uses an additive color model, so each color channel represents
24885 * how much of each primary colors must to be used. 0 represents
24886 * ausence of this color, so if all of the three are set to 0,
24887 * the color will be black.
24889 * These component values should be integers in the range 0 to 255,
24890 * (single 8-bit byte).
24892 * This sets the color used for the route. By default, it is set to
24893 * solid red (r = 255, g = 0, b = 0, a = 255).
24895 * For alpha channel, 0 represents completely transparent, and 255, opaque.
24897 * @see elm_map_route_color_get()
24901 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24904 * Get the route color.
24906 * @param route The route object.
24907 * @param r Pointer where to store the red channel value.
24908 * @param g Pointer where to store the green channel value.
24909 * @param b Pointer where to store the blue channel value.
24910 * @param a Pointer where to store the alpha channel value.
24912 * @see elm_map_route_color_set() for details.
24916 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24919 * Get the route distance in kilometers.
24921 * @param route The route object.
24922 * @return The distance of route (unit : km).
24926 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24929 * Get the information of route nodes.
24931 * @param route The route object.
24932 * @return Returns a string with the nodes of route.
24936 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24939 * Get the information of route waypoint.
24941 * @param route the route object.
24942 * @return Returns a string with information about waypoint of route.
24946 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24949 * Get the address of the name.
24951 * @param name The name handle.
24952 * @return Returns the address string of @p name.
24954 * This gets the coordinates of the @p name, created with one of the
24955 * conversion functions.
24957 * @see elm_map_utils_convert_name_into_coord()
24958 * @see elm_map_utils_convert_coord_into_name()
24962 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24965 * Get the current coordinates of the name.
24967 * @param name The name handle.
24968 * @param lat Pointer where to store the latitude.
24969 * @param lon Pointer where to store The longitude.
24971 * This gets the coordinates of the @p name, created with one of the
24972 * conversion functions.
24974 * @see elm_map_utils_convert_name_into_coord()
24975 * @see elm_map_utils_convert_coord_into_name()
24979 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24982 * Remove a name from the map.
24984 * @param name The name to remove.
24986 * Basically the struct handled by @p name will be freed, so convertions
24987 * between address and coordinates will be lost.
24989 * @see elm_map_utils_convert_name_into_coord()
24990 * @see elm_map_utils_convert_coord_into_name()
24994 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24999 * @param obj The map object.
25000 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
25001 * @param cx Rotation's center horizontal position.
25002 * @param cy Rotation's center vertical position.
25004 * @see elm_map_rotate_get()
25008 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
25011 * Get the rotate degree of the map
25013 * @param obj The map object
25014 * @param degree Pointer where to store degrees from 0.0 to 360.0
25015 * to rotate arount Z axis.
25016 * @param cx Pointer where to store rotation's center horizontal position.
25017 * @param cy Pointer where to store rotation's center vertical position.
25019 * @see elm_map_rotate_set() to set map rotation.
25023 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);
25026 * Enable or disable mouse wheel to be used to zoom in / out the map.
25028 * @param obj The map object.
25029 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
25032 * Mouse wheel can be used for the user to zoom in or zoom out the map.
25034 * It's disabled by default.
25036 * @see elm_map_wheel_disabled_get()
25040 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25043 * Get a value whether mouse wheel is enabled or not.
25045 * @param obj The map object.
25046 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
25047 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25049 * Mouse wheel can be used for the user to zoom in or zoom out the map.
25051 * @see elm_map_wheel_disabled_set() for details.
25055 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25059 * Add a track on the map
25061 * @param obj The map object.
25062 * @param emap The emap route object.
25063 * @return The route object. This is an elm object of type Route.
25065 * @see elm_route_add() for details.
25069 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
25073 * Remove a track from the map
25075 * @param obj The map object.
25076 * @param route The track to remove.
25080 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
25087 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
25089 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
25091 EAPI double elm_route_lon_min_get(Evas_Object *obj);
25092 EAPI double elm_route_lat_min_get(Evas_Object *obj);
25093 EAPI double elm_route_lon_max_get(Evas_Object *obj);
25094 EAPI double elm_route_lat_max_get(Evas_Object *obj);
25098 * @defgroup Panel Panel
25100 * @image html img/widget/panel/preview-00.png
25101 * @image latex img/widget/panel/preview-00.eps
25103 * @brief A panel is a type of animated container that contains subobjects.
25104 * It can be expanded or contracted by clicking the button on it's edge.
25106 * Orientations are as follows:
25107 * @li ELM_PANEL_ORIENT_TOP
25108 * @li ELM_PANEL_ORIENT_LEFT
25109 * @li ELM_PANEL_ORIENT_RIGHT
25111 * Default contents parts of the panel widget that you can use for are:
25112 * @li "default" - A content of the panel
25114 * @ref tutorial_panel shows one way to use this widget.
25117 typedef enum _Elm_Panel_Orient
25119 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
25120 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
25121 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
25122 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
25123 } Elm_Panel_Orient;
25126 * @brief Adds a panel object
25128 * @param parent The parent object
25130 * @return The panel object, or NULL on failure
25132 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25135 * @brief Sets the orientation of the panel
25137 * @param parent The parent object
25138 * @param orient The panel orientation. Can be one of the following:
25139 * @li ELM_PANEL_ORIENT_TOP
25140 * @li ELM_PANEL_ORIENT_LEFT
25141 * @li ELM_PANEL_ORIENT_RIGHT
25143 * Sets from where the panel will (dis)appear.
25145 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
25148 * @brief Get the orientation of the panel.
25150 * @param obj The panel object
25151 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
25153 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25156 * @brief Set the content of the panel.
25158 * @param obj The panel object
25159 * @param content The panel content
25161 * Once the content object is set, a previously set one will be deleted.
25162 * If you want to keep that old content object, use the
25163 * elm_panel_content_unset() function.
25165 * @deprecated use elm_object_content_set() instead
25168 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25171 * @brief Get the content of the panel.
25173 * @param obj The panel object
25174 * @return The content that is being used
25176 * Return the content object which is set for this widget.
25178 * @see elm_panel_content_set()
25180 * @deprecated use elm_object_content_get() instead
25183 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25186 * @brief Unset the content of the panel.
25188 * @param obj The panel object
25189 * @return The content that was being used
25191 * Unparent and return the content object which was set for this widget.
25193 * @see elm_panel_content_set()
25195 * @deprecated use elm_object_content_unset() instead
25198 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25201 * @brief Set the state of the panel.
25203 * @param obj The panel object
25204 * @param hidden If true, the panel will run the animation to contract
25206 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
25209 * @brief Get the state of the panel.
25211 * @param obj The panel object
25212 * @param hidden If true, the panel is in the "hide" state
25214 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25217 * @brief Toggle the hidden state of the panel from code
25219 * @param obj The panel object
25221 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
25228 * @defgroup Panes Panes
25229 * @ingroup Elementary
25231 * @image html img/widget/panes/preview-00.png
25232 * @image latex img/widget/panes/preview-00.eps width=\textwidth
25234 * @image html img/panes.png
25235 * @image latex img/panes.eps width=\textwidth
25237 * The panes adds a dragable bar between two contents. When dragged
25238 * this bar will resize contents size.
25240 * Panes can be displayed vertically or horizontally, and contents
25241 * size proportion can be customized (homogeneous by default).
25243 * Smart callbacks one can listen to:
25244 * - "press" - The panes has been pressed (button wasn't released yet).
25245 * - "unpressed" - The panes was released after being pressed.
25246 * - "clicked" - The panes has been clicked>
25247 * - "clicked,double" - The panes has been double clicked
25249 * Available styles for it:
25252 * Default contents parts of the panes widget that you can use for are:
25253 * @li "left" - A leftside content of the panes
25254 * @li "right" - A rightside content of the panes
25256 * If panes is displayed vertically, left content will be displayed at
25259 * Here is an example on its usage:
25260 * @li @ref panes_example
25264 * @addtogroup Panes
25269 * Add a new panes widget to the given parent Elementary
25270 * (container) object.
25272 * @param parent The parent object.
25273 * @return a new panes widget handle or @c NULL, on errors.
25275 * This function inserts a new panes widget on the canvas.
25279 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25282 * Set the left content of the panes widget.
25284 * @param obj The panes object.
25285 * @param content The new left content object.
25287 * Once the content object is set, a previously set one will be deleted.
25288 * If you want to keep that old content object, use the
25289 * elm_panes_content_left_unset() function.
25291 * If panes is displayed vertically, left content will be displayed at
25294 * @see elm_panes_content_left_get()
25295 * @see elm_panes_content_right_set() to set content on the other side.
25297 * @deprecated use elm_object_part_content_set() instead
25301 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25304 * Set the right content of the panes widget.
25306 * @param obj The panes object.
25307 * @param content The new right content object.
25309 * Once the content object is set, a previously set one will be deleted.
25310 * If you want to keep that old content object, use the
25311 * elm_panes_content_right_unset() function.
25313 * If panes is displayed vertically, left content will be displayed at
25316 * @see elm_panes_content_right_get()
25317 * @see elm_panes_content_left_set() to set content on the other side.
25319 * @deprecated use elm_object_part_content_set() instead
25323 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25326 * Get the left content of the panes.
25328 * @param obj The panes object.
25329 * @return The left content object that is being used.
25331 * Return the left content object which is set for this widget.
25333 * @see elm_panes_content_left_set() for details.
25335 * @deprecated use elm_object_part_content_get() instead
25339 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25342 * Get the right content of the panes.
25344 * @param obj The panes object
25345 * @return The right content object that is being used
25347 * Return the right content object which is set for this widget.
25349 * @see elm_panes_content_right_set() for details.
25351 * @deprecated use elm_object_part_content_get() instead
25355 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25358 * Unset the left content used for the panes.
25360 * @param obj The panes object.
25361 * @return The left content object that was being used.
25363 * Unparent and return the left content object which was set for this widget.
25365 * @see elm_panes_content_left_set() for details.
25366 * @see elm_panes_content_left_get().
25368 * @deprecated use elm_object_part_content_unset() instead
25372 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25375 * Unset the right content used for the panes.
25377 * @param obj The panes object.
25378 * @return The right content object that was being used.
25380 * Unparent and return the right content object which was set for this
25383 * @see elm_panes_content_right_set() for details.
25384 * @see elm_panes_content_right_get().
25386 * @deprecated use elm_object_part_content_unset() instead
25390 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25393 * Get the size proportion of panes widget's left side.
25395 * @param obj The panes object.
25396 * @return float value between 0.0 and 1.0 representing size proportion
25399 * @see elm_panes_content_left_size_set() for more details.
25403 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25406 * Set the size proportion of panes widget's left side.
25408 * @param obj The panes object.
25409 * @param size Value between 0.0 and 1.0 representing size proportion
25412 * By default it's homogeneous, i.e., both sides have the same size.
25414 * If something different is required, it can be set with this function.
25415 * For example, if the left content should be displayed over
25416 * 75% of the panes size, @p size should be passed as @c 0.75.
25417 * This way, right content will be resized to 25% of panes size.
25419 * If displayed vertically, left content is displayed at top, and
25420 * right content at bottom.
25422 * @note This proportion will change when user drags the panes bar.
25424 * @see elm_panes_content_left_size_get()
25428 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
25431 * Set the orientation of a given panes widget.
25433 * @param obj The panes object.
25434 * @param horizontal Use @c EINA_TRUE to make @p obj to be
25435 * @b horizontal, @c EINA_FALSE to make it @b vertical.
25437 * Use this function to change how your panes is to be
25438 * disposed: vertically or horizontally.
25440 * By default it's displayed horizontally.
25442 * @see elm_panes_horizontal_get()
25446 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25449 * Retrieve the orientation of a given panes widget.
25451 * @param obj The panes object.
25452 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
25453 * @c EINA_FALSE if it's @b vertical (and on errors).
25455 * @see elm_panes_horizontal_set() for more details.
25459 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25460 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
25461 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25468 * @defgroup Flip Flip
25470 * @image html img/widget/flip/preview-00.png
25471 * @image latex img/widget/flip/preview-00.eps
25473 * This widget holds 2 content objects(Evas_Object): one on the front and one
25474 * on the back. It allows you to flip from front to back and vice-versa using
25475 * various animations.
25477 * If either the front or back contents are not set the flip will treat that
25478 * as transparent. So if you wore to set the front content but not the back,
25479 * and then call elm_flip_go() you would see whatever is below the flip.
25481 * For a list of supported animations see elm_flip_go().
25483 * Signals that you can add callbacks for are:
25484 * "animate,begin" - when a flip animation was started
25485 * "animate,done" - when a flip animation is finished
25487 * @ref tutorial_flip show how to use most of the API.
25491 typedef enum _Elm_Flip_Mode
25493 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
25494 ELM_FLIP_ROTATE_X_CENTER_AXIS,
25495 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
25496 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
25497 ELM_FLIP_CUBE_LEFT,
25498 ELM_FLIP_CUBE_RIGHT,
25500 ELM_FLIP_CUBE_DOWN,
25501 ELM_FLIP_PAGE_LEFT,
25502 ELM_FLIP_PAGE_RIGHT,
25506 typedef enum _Elm_Flip_Interaction
25508 ELM_FLIP_INTERACTION_NONE,
25509 ELM_FLIP_INTERACTION_ROTATE,
25510 ELM_FLIP_INTERACTION_CUBE,
25511 ELM_FLIP_INTERACTION_PAGE
25512 } Elm_Flip_Interaction;
25513 typedef enum _Elm_Flip_Direction
25515 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
25516 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
25517 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
25518 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
25519 } Elm_Flip_Direction;
25522 * @brief Add a new flip to the parent
25524 * @param parent The parent object
25525 * @return The new object or NULL if it cannot be created
25527 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25530 * @brief Set the front content of the flip widget.
25532 * @param obj The flip object
25533 * @param content The new front content object
25535 * Once the content object is set, a previously set one will be deleted.
25536 * If you want to keep that old content object, use the
25537 * elm_flip_content_front_unset() function.
25539 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25542 * @brief Set the back content of the flip widget.
25544 * @param obj The flip object
25545 * @param content The new back content object
25547 * Once the content object is set, a previously set one will be deleted.
25548 * If you want to keep that old content object, use the
25549 * elm_flip_content_back_unset() function.
25551 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25554 * @brief Get the front content used for the flip
25556 * @param obj The flip object
25557 * @return The front content object that is being used
25559 * Return the front content object which is set for this widget.
25561 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25564 * @brief Get the back content used for the flip
25566 * @param obj The flip object
25567 * @return The back content object that is being used
25569 * Return the back content object which is set for this widget.
25571 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25574 * @brief Unset the front content used for the flip
25576 * @param obj The flip object
25577 * @return The front content object that was being used
25579 * Unparent and return the front content object which was set for this widget.
25581 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25584 * @brief Unset the back content used for the flip
25586 * @param obj The flip object
25587 * @return The back content object that was being used
25589 * Unparent and return the back content object which was set for this widget.
25591 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25594 * @brief Get flip front visibility state
25596 * @param obj The flip objct
25597 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
25600 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25603 * @brief Set flip perspective
25605 * @param obj The flip object
25606 * @param foc The coordinate to set the focus on
25607 * @param x The X coordinate
25608 * @param y The Y coordinate
25610 * @warning This function currently does nothing.
25612 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
25615 * @brief Runs the flip animation
25617 * @param obj The flip object
25618 * @param mode The mode type
25620 * Flips the front and back contents using the @p mode animation. This
25621 * efectively hides the currently visible content and shows the hidden one.
25623 * There a number of possible animations to use for the flipping:
25624 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
25625 * around a horizontal axis in the middle of its height, the other content
25626 * is shown as the other side of the flip.
25627 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
25628 * around a vertical axis in the middle of its width, the other content is
25629 * shown as the other side of the flip.
25630 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
25631 * around a diagonal axis in the middle of its width, the other content is
25632 * shown as the other side of the flip.
25633 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
25634 * around a diagonal axis in the middle of its height, the other content is
25635 * shown as the other side of the flip.
25636 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
25637 * as if the flip was a cube, the other content is show as the right face of
25639 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
25640 * right as if the flip was a cube, the other content is show as the left
25641 * face of the cube.
25642 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
25643 * flip was a cube, the other content is show as the bottom face of the cube.
25644 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
25645 * the flip was a cube, the other content is show as the upper face of the
25647 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
25648 * if the flip was a book, the other content is shown as the page below that.
25649 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
25650 * as if the flip was a book, the other content is shown as the page below
25652 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
25653 * flip was a book, the other content is shown as the page below that.
25654 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
25655 * flip was a book, the other content is shown as the page below that.
25657 * @image html elm_flip.png
25658 * @image latex elm_flip.eps width=\textwidth
25660 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
25663 * @brief Set the interactive flip mode
25665 * @param obj The flip object
25666 * @param mode The interactive flip mode to use
25668 * This sets if the flip should be interactive (allow user to click and
25669 * drag a side of the flip to reveal the back page and cause it to flip).
25670 * By default a flip is not interactive. You may also need to set which
25671 * sides of the flip are "active" for flipping and how much space they use
25672 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
25673 * and elm_flip_interacton_direction_hitsize_set()
25675 * The four avilable mode of interaction are:
25676 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
25677 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
25678 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
25679 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
25681 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
25682 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
25683 * happen, those can only be acheived with elm_flip_go();
25685 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
25688 * @brief Get the interactive flip mode
25690 * @param obj The flip object
25691 * @return The interactive flip mode
25693 * Returns the interactive flip mode set by elm_flip_interaction_set()
25695 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
25698 * @brief Set which directions of the flip respond to interactive flip
25700 * @param obj The flip object
25701 * @param dir The direction to change
25702 * @param enabled If that direction is enabled or not
25704 * By default all directions are disabled, so you may want to enable the
25705 * desired directions for flipping if you need interactive flipping. You must
25706 * call this function once for each direction that should be enabled.
25708 * @see elm_flip_interaction_set()
25710 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
25713 * @brief Get the enabled state of that flip direction
25715 * @param obj The flip object
25716 * @param dir The direction to check
25717 * @return If that direction is enabled or not
25719 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
25721 * @see elm_flip_interaction_set()
25723 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
25726 * @brief Set the amount of the flip that is sensitive to interactive flip
25728 * @param obj The flip object
25729 * @param dir The direction to modify
25730 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
25732 * Set the amount of the flip that is sensitive to interactive flip, with 0
25733 * representing no area in the flip and 1 representing the entire flip. There
25734 * is however a consideration to be made in that the area will never be
25735 * smaller than the finger size set(as set in your Elementary configuration).
25737 * @see elm_flip_interaction_set()
25739 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
25742 * @brief Get the amount of the flip that is sensitive to interactive flip
25744 * @param obj The flip object
25745 * @param dir The direction to check
25746 * @return The size set for that direction
25748 * Returns the amount os sensitive area set by
25749 * elm_flip_interacton_direction_hitsize_set().
25751 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
25757 /* scrolledentry */
25758 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25759 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
25760 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25761 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
25762 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25763 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25764 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25765 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25766 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25767 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25768 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25769 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
25770 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
25771 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25772 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
25773 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
25774 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25775 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25776 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
25777 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
25778 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25779 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25780 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25781 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25782 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
25783 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
25784 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25785 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25786 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25787 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25788 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25789 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
25790 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
25791 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
25792 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25793 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);
25794 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25795 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25796 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);
25797 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25798 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);
25799 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
25800 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25801 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25802 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25803 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
25804 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25805 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25806 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25807 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);
25808 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);
25809 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);
25810 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);
25811 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);
25812 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);
25813 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
25814 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
25815 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
25816 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
25817 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25818 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
25819 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
25822 * @defgroup Conformant Conformant
25823 * @ingroup Elementary
25825 * @image html img/widget/conformant/preview-00.png
25826 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
25828 * @image html img/conformant.png
25829 * @image latex img/conformant.eps width=\textwidth
25831 * The aim is to provide a widget that can be used in elementary apps to
25832 * account for space taken up by the indicator, virtual keypad & softkey
25833 * windows when running the illume2 module of E17.
25835 * So conformant content will be sized and positioned considering the
25836 * space required for such stuff, and when they popup, as a keyboard
25837 * shows when an entry is selected, conformant content won't change.
25839 * Available styles for it:
25842 * Default contents parts of the conformant widget that you can use for are:
25843 * @li "default" - A content of the conformant
25845 * See how to use this widget in this example:
25846 * @ref conformant_example
25850 * @addtogroup Conformant
25855 * Add a new conformant widget to the given parent Elementary
25856 * (container) object.
25858 * @param parent The parent object.
25859 * @return A new conformant widget handle or @c NULL, on errors.
25861 * This function inserts a new conformant widget on the canvas.
25863 * @ingroup Conformant
25865 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25868 * Set the content of the conformant widget.
25870 * @param obj The conformant object.
25871 * @param content The content to be displayed by the conformant.
25873 * Content will be sized and positioned considering the space required
25874 * to display a virtual keyboard. So it won't fill all the conformant
25875 * size. This way is possible to be sure that content won't resize
25876 * or be re-positioned after the keyboard is displayed.
25878 * Once the content object is set, a previously set one will be deleted.
25879 * If you want to keep that old content object, use the
25880 * elm_object_content_unset() function.
25882 * @see elm_object_content_unset()
25883 * @see elm_object_content_get()
25885 * @deprecated use elm_object_content_set() instead
25887 * @ingroup Conformant
25889 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25892 * Get the content of the conformant widget.
25894 * @param obj The conformant object.
25895 * @return The content that is being used.
25897 * Return the content object which is set for this widget.
25898 * It won't be unparent from conformant. For that, use
25899 * elm_object_content_unset().
25901 * @see elm_object_content_set().
25902 * @see elm_object_content_unset()
25904 * @deprecated use elm_object_content_get() instead
25906 * @ingroup Conformant
25908 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25911 * Unset the content of the conformant widget.
25913 * @param obj The conformant object.
25914 * @return The content that was being used.
25916 * Unparent and return the content object which was set for this widget.
25918 * @see elm_object_content_set().
25920 * @deprecated use elm_object_content_unset() instead
25922 * @ingroup Conformant
25924 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25927 * Returns the Evas_Object that represents the content area.
25929 * @param obj The conformant object.
25930 * @return The content area of the widget.
25932 * @ingroup Conformant
25934 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25941 * @defgroup Mapbuf Mapbuf
25942 * @ingroup Elementary
25944 * @image html img/widget/mapbuf/preview-00.png
25945 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25947 * This holds one content object and uses an Evas Map of transformation
25948 * points to be later used with this content. So the content will be
25949 * moved, resized, etc as a single image. So it will improve performance
25950 * when you have a complex interafce, with a lot of elements, and will
25951 * need to resize or move it frequently (the content object and its
25954 * Default contents parts of the mapbuf widget that you can use for are:
25955 * @li "default" - A content of the mapbuf
25957 * To enable map, elm_mapbuf_enabled_set() should be used.
25959 * See how to use this widget in this example:
25960 * @ref mapbuf_example
25964 * @addtogroup Mapbuf
25969 * Add a new mapbuf widget to the given parent Elementary
25970 * (container) object.
25972 * @param parent The parent object.
25973 * @return A new mapbuf widget handle or @c NULL, on errors.
25975 * This function inserts a new mapbuf widget on the canvas.
25979 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25982 * Set the content of the mapbuf.
25984 * @param obj The mapbuf object.
25985 * @param content The content that will be filled in this mapbuf object.
25987 * Once the content object is set, a previously set one will be deleted.
25988 * If you want to keep that old content object, use the
25989 * elm_mapbuf_content_unset() function.
25991 * To enable map, elm_mapbuf_enabled_set() should be used.
25993 * @deprecated use elm_object_content_set() instead
25997 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
26000 * Get the content of the mapbuf.
26002 * @param obj The mapbuf object.
26003 * @return The content that is being used.
26005 * Return the content object which is set for this widget.
26007 * @see elm_mapbuf_content_set() for details.
26009 * @deprecated use elm_object_content_get() instead
26013 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26016 * Unset the content of the mapbuf.
26018 * @param obj The mapbuf object.
26019 * @return The content that was being used.
26021 * Unparent and return the content object which was set for this widget.
26023 * @see elm_mapbuf_content_set() for details.
26025 * @deprecated use elm_object_content_unset() instead
26029 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26032 * Enable or disable the map.
26034 * @param obj The mapbuf object.
26035 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
26037 * This enables the map that is set or disables it. On enable, the object
26038 * geometry will be saved, and the new geometry will change (position and
26039 * size) to reflect the map geometry set.
26041 * Also, when enabled, alpha and smooth states will be used, so if the
26042 * content isn't solid, alpha should be enabled, for example, otherwise
26043 * a black retangle will fill the content.
26045 * When disabled, the stored map will be freed and geometry prior to
26046 * enabling the map will be restored.
26048 * It's disabled by default.
26050 * @see elm_mapbuf_alpha_set()
26051 * @see elm_mapbuf_smooth_set()
26055 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26058 * Get a value whether map is enabled or not.
26060 * @param obj The mapbuf object.
26061 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
26062 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26064 * @see elm_mapbuf_enabled_set() for details.
26068 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26071 * Enable or disable smooth map rendering.
26073 * @param obj The mapbuf object.
26074 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
26077 * This sets smoothing for map rendering. If the object is a type that has
26078 * its own smoothing settings, then both the smooth settings for this object
26079 * and the map must be turned off.
26081 * By default smooth maps are enabled.
26085 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
26088 * Get a value whether smooth map rendering is enabled or not.
26090 * @param obj The mapbuf object.
26091 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
26092 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26094 * @see elm_mapbuf_smooth_set() for details.
26098 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26101 * Set or unset alpha flag for map rendering.
26103 * @param obj The mapbuf object.
26104 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
26107 * This sets alpha flag for map rendering. If the object is a type that has
26108 * its own alpha settings, then this will take precedence. Only image objects
26109 * have this currently. It stops alpha blending of the map area, and is
26110 * useful if you know the object and/or all sub-objects is 100% solid.
26112 * Alpha is enabled by default.
26116 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
26119 * Get a value whether alpha blending is enabled or not.
26121 * @param obj The mapbuf object.
26122 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
26123 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26125 * @see elm_mapbuf_alpha_set() for details.
26129 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26136 * @defgroup Flipselector Flip Selector
26138 * @image html img/widget/flipselector/preview-00.png
26139 * @image latex img/widget/flipselector/preview-00.eps
26141 * A flip selector is a widget to show a set of @b text items, one
26142 * at a time, with the same sheet switching style as the @ref Clock
26143 * "clock" widget, when one changes the current displaying sheet
26144 * (thus, the "flip" in the name).
26146 * User clicks to flip sheets which are @b held for some time will
26147 * make the flip selector to flip continuosly and automatically for
26148 * the user. The interval between flips will keep growing in time,
26149 * so that it helps the user to reach an item which is distant from
26150 * the current selection.
26152 * Smart callbacks one can register to:
26153 * - @c "selected" - when the widget's selected text item is changed
26154 * - @c "overflowed" - when the widget's current selection is changed
26155 * from the first item in its list to the last
26156 * - @c "underflowed" - when the widget's current selection is changed
26157 * from the last item in its list to the first
26159 * Available styles for it:
26162 * To set/get the label of the flipselector item, you can use
26163 * elm_object_item_text_set/get APIs.
26164 * Once the text is set, a previously set one will be deleted.
26166 * Here is an example on its usage:
26167 * @li @ref flipselector_example
26171 * @addtogroup Flipselector
26176 * Add a new flip selector widget to the given parent Elementary
26177 * (container) widget
26179 * @param parent The parent object
26180 * @return a new flip selector widget handle or @c NULL, on errors
26182 * This function inserts a new flip selector widget on the canvas.
26184 * @ingroup Flipselector
26186 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26189 * Programmatically select the next item of a flip selector widget
26191 * @param obj The flipselector object
26193 * @note The selection will be animated. Also, if it reaches the
26194 * end of its list of member items, it will continue with the first
26197 * @ingroup Flipselector
26199 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
26202 * Programmatically select the previous item of a flip selector
26205 * @param obj The flipselector object
26207 * @note The selection will be animated. Also, if it reaches the
26208 * beginning of its list of member items, it will continue with the
26209 * last one backwards.
26211 * @ingroup Flipselector
26213 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
26216 * Append a (text) item to a flip selector widget
26218 * @param obj The flipselector object
26219 * @param label The (text) label of the new item
26220 * @param func Convenience callback function to take place when
26222 * @param data Data passed to @p func, above
26223 * @return A handle to the item added or @c NULL, on errors
26225 * The widget's list of labels to show will be appended with the
26226 * given value. If the user wishes so, a callback function pointer
26227 * can be passed, which will get called when this same item is
26230 * @note The current selection @b won't be modified by appending an
26231 * element to the list.
26233 * @note The maximum length of the text label is going to be
26234 * determined <b>by the widget's theme</b>. Strings larger than
26235 * that value are going to be @b truncated.
26237 * @ingroup Flipselector
26239 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26242 * Prepend a (text) item to a flip selector widget
26244 * @param obj The flipselector object
26245 * @param label The (text) label of the new item
26246 * @param func Convenience callback function to take place when
26248 * @param data Data passed to @p func, above
26249 * @return A handle to the item added or @c NULL, on errors
26251 * The widget's list of labels to show will be prepended with the
26252 * given value. If the user wishes so, a callback function pointer
26253 * can be passed, which will get called when this same item is
26256 * @note The current selection @b won't be modified by prepending
26257 * an element to the list.
26259 * @note The maximum length of the text label is going to be
26260 * determined <b>by the widget's theme</b>. Strings larger than
26261 * that value are going to be @b truncated.
26263 * @ingroup Flipselector
26265 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26268 * Get the internal list of items in a given flip selector widget.
26270 * @param obj The flipselector object
26271 * @return The list of items (#Elm_Object_Item as data) or
26272 * @c NULL on errors.
26274 * This list is @b not to be modified in any way and must not be
26275 * freed. Use the list members with functions like
26276 * elm_object_item_text_set(),
26277 * elm_object_item_text_get(),
26278 * elm_flipselector_item_del(),
26279 * elm_flipselector_item_selected_get(),
26280 * elm_flipselector_item_selected_set().
26282 * @warning This list is only valid until @p obj object's internal
26283 * items list is changed. It should be fetched again with another
26284 * call to this function when changes happen.
26286 * @ingroup Flipselector
26288 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26291 * Get the first item in the given flip selector widget's list of
26294 * @param obj The flipselector object
26295 * @return The first item or @c NULL, if it has no items (and on
26298 * @see elm_flipselector_item_append()
26299 * @see elm_flipselector_last_item_get()
26301 * @ingroup Flipselector
26303 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26306 * Get the last item in the given flip selector widget's list of
26309 * @param obj The flipselector object
26310 * @return The last item or @c NULL, if it has no items (and on
26313 * @see elm_flipselector_item_prepend()
26314 * @see elm_flipselector_first_item_get()
26316 * @ingroup Flipselector
26318 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26321 * Get the currently selected item in a flip selector widget.
26323 * @param obj The flipselector object
26324 * @return The selected item or @c NULL, if the widget has no items
26327 * @ingroup Flipselector
26329 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26332 * Set whether a given flip selector widget's item should be the
26333 * currently selected one.
26335 * @param it The flip selector item
26336 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
26338 * This sets whether @p item is or not the selected (thus, under
26339 * display) one. If @p item is different than one under display,
26340 * the latter will be unselected. If the @p item is set to be
26341 * unselected, on the other hand, the @b first item in the widget's
26342 * internal members list will be the new selected one.
26344 * @see elm_flipselector_item_selected_get()
26346 * @ingroup Flipselector
26348 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
26351 * Get whether a given flip selector widget's item is the currently
26354 * @param it The flip selector item
26355 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
26358 * @see elm_flipselector_item_selected_set()
26360 * @ingroup Flipselector
26362 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26365 * Delete a given item from a flip selector widget.
26367 * @param it The item to delete
26369 * @ingroup Flipselector
26371 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26374 * Get the label of a given flip selector widget's item.
26376 * @param it The item to get label from
26377 * @return The text label of @p item or @c NULL, on errors
26379 * @see elm_object_item_text_set()
26381 * @deprecated see elm_object_item_text_get() instead
26382 * @ingroup Flipselector
26384 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26387 * Set the label of a given flip selector widget's item.
26389 * @param it The item to set label on
26390 * @param label The text label string, in UTF-8 encoding
26392 * @see elm_object_item_text_get()
26394 * @deprecated see elm_object_item_text_set() instead
26395 * @ingroup Flipselector
26397 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26400 * Gets the item before @p item in a flip selector widget's
26401 * internal list of items.
26403 * @param it The item to fetch previous from
26404 * @return The item before the @p item, in its parent's list. If
26405 * there is no previous item for @p item or there's an
26406 * error, @c NULL is returned.
26408 * @see elm_flipselector_item_next_get()
26410 * @ingroup Flipselector
26412 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26415 * Gets the item after @p item in a flip selector widget's
26416 * internal list of items.
26418 * @param it The item to fetch next from
26419 * @return The item after the @p item, in its parent's list. If
26420 * there is no next item for @p item or there's an
26421 * error, @c NULL is returned.
26423 * @see elm_flipselector_item_next_get()
26425 * @ingroup Flipselector
26427 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26430 * Set the interval on time updates for an user mouse button hold
26431 * on a flip selector widget.
26433 * @param obj The flip selector object
26434 * @param interval The (first) interval value in seconds
26436 * This interval value is @b decreased while the user holds the
26437 * mouse pointer either flipping up or flipping doww a given flip
26440 * This helps the user to get to a given item distant from the
26441 * current one easier/faster, as it will start to flip quicker and
26442 * quicker on mouse button holds.
26444 * The calculation for the next flip interval value, starting from
26445 * the one set with this call, is the previous interval divided by
26446 * 1.05, so it decreases a little bit.
26448 * The default starting interval value for automatic flips is
26451 * @see elm_flipselector_interval_get()
26453 * @ingroup Flipselector
26455 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26458 * Get the interval on time updates for an user mouse button hold
26459 * on a flip selector widget.
26461 * @param obj The flip selector object
26462 * @return The (first) interval value, in seconds, set on it
26464 * @see elm_flipselector_interval_set() for more details
26466 * @ingroup Flipselector
26468 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26474 * @addtogroup Calendar
26479 * @enum _Elm_Calendar_Mark_Repeat
26480 * @typedef Elm_Calendar_Mark_Repeat
26482 * Event periodicity, used to define if a mark should be repeated
26483 * @b beyond event's day. It's set when a mark is added.
26485 * So, for a mark added to 13th May with periodicity set to WEEKLY,
26486 * there will be marks every week after this date. Marks will be displayed
26487 * at 13th, 20th, 27th, 3rd June ...
26489 * Values don't work as bitmask, only one can be choosen.
26491 * @see elm_calendar_mark_add()
26493 * @ingroup Calendar
26495 typedef enum _Elm_Calendar_Mark_Repeat
26497 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
26498 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
26499 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
26500 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*/
26501 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. */
26502 } Elm_Calendar_Mark_Repeat;
26504 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(). */
26507 * Add a new calendar widget to the given parent Elementary
26508 * (container) object.
26510 * @param parent The parent object.
26511 * @return a new calendar widget handle or @c NULL, on errors.
26513 * This function inserts a new calendar widget on the canvas.
26515 * @ref calendar_example_01
26517 * @ingroup Calendar
26519 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26522 * Get weekdays names displayed by the calendar.
26524 * @param obj The calendar object.
26525 * @return Array of seven strings to be used as weekday names.
26527 * By default, weekdays abbreviations get from system are displayed:
26528 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26529 * The first string is related to Sunday, the second to Monday...
26531 * @see elm_calendar_weekdays_name_set()
26533 * @ref calendar_example_05
26535 * @ingroup Calendar
26537 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26540 * Set weekdays names to be displayed by the calendar.
26542 * @param obj The calendar object.
26543 * @param weekdays Array of seven strings to be used as weekday names.
26544 * @warning It must have 7 elements, or it will access invalid memory.
26545 * @warning The strings must be NULL terminated ('@\0').
26547 * By default, weekdays abbreviations get from system are displayed:
26548 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26550 * The first string should be related to Sunday, the second to Monday...
26552 * The usage should be like this:
26554 * const char *weekdays[] =
26556 * "Sunday", "Monday", "Tuesday", "Wednesday",
26557 * "Thursday", "Friday", "Saturday"
26559 * elm_calendar_weekdays_names_set(calendar, weekdays);
26562 * @see elm_calendar_weekdays_name_get()
26564 * @ref calendar_example_02
26566 * @ingroup Calendar
26568 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
26571 * Set the minimum and maximum values for the year
26573 * @param obj The calendar object
26574 * @param min The minimum year, greater than 1901;
26575 * @param max The maximum year;
26577 * Maximum must be greater than minimum, except if you don't wan't to set
26579 * Default values are 1902 and -1.
26581 * If the maximum year is a negative value, it will be limited depending
26582 * on the platform architecture (year 2037 for 32 bits);
26584 * @see elm_calendar_min_max_year_get()
26586 * @ref calendar_example_03
26588 * @ingroup Calendar
26590 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
26593 * Get the minimum and maximum values for the year
26595 * @param obj The calendar object.
26596 * @param min The minimum year.
26597 * @param max The maximum year.
26599 * Default values are 1902 and -1.
26601 * @see elm_calendar_min_max_year_get() for more details.
26603 * @ref calendar_example_05
26605 * @ingroup Calendar
26607 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
26610 * Enable or disable day selection
26612 * @param obj The calendar object.
26613 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
26616 * Enabled by default. If disabled, the user still can select months,
26617 * but not days. Selected days are highlighted on calendar.
26618 * It should be used if you won't need such selection for the widget usage.
26620 * When a day is selected, or month is changed, smart callbacks for
26621 * signal "changed" will be called.
26623 * @see elm_calendar_day_selection_enable_get()
26625 * @ref calendar_example_04
26627 * @ingroup Calendar
26629 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26632 * Get a value whether day selection is enabled or not.
26634 * @see elm_calendar_day_selection_enable_set() for details.
26636 * @param obj The calendar object.
26637 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
26638 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
26640 * @ref calendar_example_05
26642 * @ingroup Calendar
26644 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26648 * Set selected date to be highlighted on calendar.
26650 * @param obj The calendar object.
26651 * @param selected_time A @b tm struct to represent the selected date.
26653 * Set the selected date, changing the displayed month if needed.
26654 * Selected date changes when the user goes to next/previous month or
26655 * select a day pressing over it on calendar.
26657 * @see elm_calendar_selected_time_get()
26659 * @ref calendar_example_04
26661 * @ingroup Calendar
26663 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
26666 * Get selected date.
26668 * @param obj The calendar object
26669 * @param selected_time A @b tm struct to point to selected date
26670 * @return EINA_FALSE means an error ocurred and returned time shouldn't
26673 * Get date selected by the user or set by function
26674 * elm_calendar_selected_time_set().
26675 * Selected date changes when the user goes to next/previous month or
26676 * select a day pressing over it on calendar.
26678 * @see elm_calendar_selected_time_get()
26680 * @ref calendar_example_05
26682 * @ingroup Calendar
26684 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
26687 * Set a function to format the string that will be used to display
26690 * @param obj The calendar object
26691 * @param format_function Function to set the month-year string given
26692 * the selected date
26694 * By default it uses strftime with "%B %Y" format string.
26695 * It should allocate the memory that will be used by the string,
26696 * that will be freed by the widget after usage.
26697 * A pointer to the string and a pointer to the time struct will be provided.
26702 * _format_month_year(struct tm *selected_time)
26705 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
26706 * return strdup(buf);
26709 * elm_calendar_format_function_set(calendar, _format_month_year);
26712 * @ref calendar_example_02
26714 * @ingroup Calendar
26716 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
26719 * Add a new mark to the calendar
26721 * @param obj The calendar object
26722 * @param mark_type A string used to define the type of mark. It will be
26723 * emitted to the theme, that should display a related modification on these
26724 * days representation.
26725 * @param mark_time A time struct to represent the date of inclusion of the
26726 * mark. For marks that repeats it will just be displayed after the inclusion
26727 * date in the calendar.
26728 * @param repeat Repeat the event following this periodicity. Can be a unique
26729 * mark (that don't repeat), daily, weekly, monthly or annually.
26730 * @return The created mark or @p NULL upon failure.
26732 * Add a mark that will be drawn in the calendar respecting the insertion
26733 * time and periodicity. It will emit the type as signal to the widget theme.
26734 * Default theme supports "holiday" and "checked", but it can be extended.
26736 * It won't immediately update the calendar, drawing the marks.
26737 * For this, call elm_calendar_marks_draw(). However, when user selects
26738 * next or previous month calendar forces marks drawn.
26740 * Marks created with this method can be deleted with
26741 * elm_calendar_mark_del().
26745 * struct tm selected_time;
26746 * time_t current_time;
26748 * current_time = time(NULL) + 5 * 84600;
26749 * localtime_r(¤t_time, &selected_time);
26750 * elm_calendar_mark_add(cal, "holiday", selected_time,
26751 * ELM_CALENDAR_ANNUALLY);
26753 * current_time = time(NULL) + 1 * 84600;
26754 * localtime_r(¤t_time, &selected_time);
26755 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
26757 * elm_calendar_marks_draw(cal);
26760 * @see elm_calendar_marks_draw()
26761 * @see elm_calendar_mark_del()
26763 * @ref calendar_example_06
26765 * @ingroup Calendar
26767 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);
26770 * Delete mark from the calendar.
26772 * @param mark The mark to be deleted.
26774 * If deleting all calendar marks is required, elm_calendar_marks_clear()
26775 * should be used instead of getting marks list and deleting each one.
26777 * @see elm_calendar_mark_add()
26779 * @ref calendar_example_06
26781 * @ingroup Calendar
26783 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
26786 * Remove all calendar's marks
26788 * @param obj The calendar object.
26790 * @see elm_calendar_mark_add()
26791 * @see elm_calendar_mark_del()
26793 * @ingroup Calendar
26795 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26798 * Get a list of all the calendar marks.
26800 * @param obj The calendar object.
26801 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
26803 * @see elm_calendar_mark_add()
26804 * @see elm_calendar_mark_del()
26805 * @see elm_calendar_marks_clear()
26807 * @ingroup Calendar
26809 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26812 * Draw calendar marks.
26814 * @param obj The calendar object.
26816 * Should be used after adding, removing or clearing marks.
26817 * It will go through the entire marks list updating the calendar.
26818 * If lots of marks will be added, add all the marks and then call
26821 * When the month is changed, i.e. user selects next or previous month,
26822 * marks will be drawed.
26824 * @see elm_calendar_mark_add()
26825 * @see elm_calendar_mark_del()
26826 * @see elm_calendar_marks_clear()
26828 * @ref calendar_example_06
26830 * @ingroup Calendar
26832 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
26835 * Set a day text color to the same that represents Saturdays.
26837 * @param obj The calendar object.
26838 * @param pos The text position. Position is the cell counter, from left
26839 * to right, up to down. It starts on 0 and ends on 41.
26841 * @deprecated use elm_calendar_mark_add() instead like:
26844 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26845 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26848 * @see elm_calendar_mark_add()
26850 * @ingroup Calendar
26852 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26855 * Set a day text color to the same that represents Sundays.
26857 * @param obj The calendar object.
26858 * @param pos The text position. Position is the cell counter, from left
26859 * to right, up to down. It starts on 0 and ends on 41.
26861 * @deprecated use elm_calendar_mark_add() instead like:
26864 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26865 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26868 * @see elm_calendar_mark_add()
26870 * @ingroup Calendar
26872 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26875 * Set a day text color to the same that represents Weekdays.
26877 * @param obj The calendar object
26878 * @param pos The text position. Position is the cell counter, from left
26879 * to right, up to down. It starts on 0 and ends on 41.
26881 * @deprecated use elm_calendar_mark_add() instead like:
26884 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26886 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26887 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26888 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26889 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26890 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26891 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26892 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26893 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26894 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26897 * @see elm_calendar_mark_add()
26899 * @ingroup Calendar
26901 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26904 * Set the interval on time updates for an user mouse button hold
26905 * on calendar widgets' month selection.
26907 * @param obj The calendar object
26908 * @param interval The (first) interval value in seconds
26910 * This interval value is @b decreased while the user holds the
26911 * mouse pointer either selecting next or previous month.
26913 * This helps the user to get to a given month distant from the
26914 * current one easier/faster, as it will start to change quicker and
26915 * quicker on mouse button holds.
26917 * The calculation for the next change interval value, starting from
26918 * the one set with this call, is the previous interval divided by
26919 * 1.05, so it decreases a little bit.
26921 * The default starting interval value for automatic changes is
26924 * @see elm_calendar_interval_get()
26926 * @ingroup Calendar
26928 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26931 * Get the interval on time updates for an user mouse button hold
26932 * on calendar widgets' month selection.
26934 * @param obj The calendar object
26935 * @return The (first) interval value, in seconds, set on it
26937 * @see elm_calendar_interval_set() for more details
26939 * @ingroup Calendar
26941 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26948 * @defgroup Diskselector Diskselector
26949 * @ingroup Elementary
26951 * @image html img/widget/diskselector/preview-00.png
26952 * @image latex img/widget/diskselector/preview-00.eps
26954 * A diskselector is a kind of list widget. It scrolls horizontally,
26955 * and can contain label and icon objects. Three items are displayed
26956 * with the selected one in the middle.
26958 * It can act like a circular list with round mode and labels can be
26959 * reduced for a defined length for side items.
26961 * Smart callbacks one can listen to:
26962 * - "selected" - when item is selected, i.e. scroller stops.
26964 * Available styles for it:
26967 * List of examples:
26968 * @li @ref diskselector_example_01
26969 * @li @ref diskselector_example_02
26973 * @addtogroup Diskselector
26977 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(). */
26980 * Add a new diskselector widget to the given parent Elementary
26981 * (container) object.
26983 * @param parent The parent object.
26984 * @return a new diskselector widget handle or @c NULL, on errors.
26986 * This function inserts a new diskselector widget on the canvas.
26988 * @ingroup Diskselector
26990 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26993 * Enable or disable round mode.
26995 * @param obj The diskselector object.
26996 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
26999 * Disabled by default. If round mode is enabled the items list will
27000 * work like a circle list, so when the user reaches the last item,
27001 * the first one will popup.
27003 * @see elm_diskselector_round_get()
27005 * @ingroup Diskselector
27007 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
27010 * Get a value whether round mode is enabled or not.
27012 * @see elm_diskselector_round_set() for details.
27014 * @param obj The diskselector object.
27015 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
27016 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
27018 * @ingroup Diskselector
27020 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27023 * Get the side labels max length.
27025 * @deprecated use elm_diskselector_side_label_length_get() instead:
27027 * @param obj The diskselector object.
27028 * @return The max length defined for side labels, or 0 if not a valid
27031 * @ingroup Diskselector
27033 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27036 * Set the side labels max length.
27038 * @deprecated use elm_diskselector_side_label_length_set() instead:
27040 * @param obj The diskselector object.
27041 * @param len The max length defined for side labels.
27043 * @ingroup Diskselector
27045 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27048 * Get the side labels max length.
27050 * @see elm_diskselector_side_label_length_set() for details.
27052 * @param obj The diskselector object.
27053 * @return The max length defined for side labels, or 0 if not a valid
27056 * @ingroup Diskselector
27058 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27061 * Set the side labels max length.
27063 * @param obj The diskselector object.
27064 * @param len The max length defined for side labels.
27066 * Length is the number of characters of items' label that will be
27067 * visible when it's set on side positions. It will just crop
27068 * the string after defined size. E.g.:
27070 * An item with label "January" would be displayed on side position as
27071 * "Jan" if max length is set to 3, or "Janu", if this property
27074 * When it's selected, the entire label will be displayed, except for
27075 * width restrictions. In this case label will be cropped and "..."
27076 * will be concatenated.
27078 * Default side label max length is 3.
27080 * This property will be applyed over all items, included before or
27081 * later this function call.
27083 * @ingroup Diskselector
27085 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27088 * Set the number of items to be displayed.
27090 * @param obj The diskselector object.
27091 * @param num The number of items the diskselector will display.
27093 * Default value is 3, and also it's the minimun. If @p num is less
27094 * than 3, it will be set to 3.
27096 * Also, it can be set on theme, using data item @c display_item_num
27097 * on group "elm/diskselector/item/X", where X is style set.
27100 * group { name: "elm/diskselector/item/X";
27102 * item: "display_item_num" "5";
27105 * @ingroup Diskselector
27107 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
27110 * Get the number of items in the diskselector object.
27112 * @param obj The diskselector object.
27114 * @ingroup Diskselector
27116 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27119 * Set bouncing behaviour when the scrolled content reaches an edge.
27121 * Tell the internal scroller object whether it should bounce or not
27122 * when it reaches the respective edges for each axis.
27124 * @param obj The diskselector object.
27125 * @param h_bounce Whether to bounce or not in the horizontal axis.
27126 * @param v_bounce Whether to bounce or not in the vertical axis.
27128 * @see elm_scroller_bounce_set()
27130 * @ingroup Diskselector
27132 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
27135 * Get the bouncing behaviour of the internal scroller.
27137 * Get whether the internal scroller should bounce when the edge of each
27138 * axis is reached scrolling.
27140 * @param obj The diskselector object.
27141 * @param h_bounce Pointer where to store the bounce state of the horizontal
27143 * @param v_bounce Pointer where to store the bounce state of the vertical
27146 * @see elm_scroller_bounce_get()
27147 * @see elm_diskselector_bounce_set()
27149 * @ingroup Diskselector
27151 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
27154 * Get the scrollbar policy.
27156 * @see elm_diskselector_scroller_policy_get() for details.
27158 * @param obj The diskselector object.
27159 * @param policy_h Pointer where to store horizontal scrollbar policy.
27160 * @param policy_v Pointer where to store vertical scrollbar policy.
27162 * @ingroup Diskselector
27164 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);
27167 * Set the scrollbar policy.
27169 * @param obj The diskselector object.
27170 * @param policy_h Horizontal scrollbar policy.
27171 * @param policy_v Vertical scrollbar policy.
27173 * This sets the scrollbar visibility policy for the given scroller.
27174 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
27175 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
27176 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
27177 * This applies respectively for the horizontal and vertical scrollbars.
27179 * The both are disabled by default, i.e., are set to
27180 * #ELM_SCROLLER_POLICY_OFF.
27182 * @ingroup Diskselector
27184 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
27187 * Remove all diskselector's items.
27189 * @param obj The diskselector object.
27191 * @see elm_diskselector_item_del()
27192 * @see elm_diskselector_item_append()
27194 * @ingroup Diskselector
27196 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27199 * Get a list of all the diskselector items.
27201 * @param obj The diskselector object.
27202 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
27203 * or @c NULL on failure.
27205 * @see elm_diskselector_item_append()
27206 * @see elm_diskselector_item_del()
27207 * @see elm_diskselector_clear()
27209 * @ingroup Diskselector
27211 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27214 * Appends a new item to the diskselector object.
27216 * @param obj The diskselector object.
27217 * @param label The label of the diskselector item.
27218 * @param icon The icon object to use at left side of the item. An
27219 * icon can be any Evas object, but usually it is an icon created
27220 * with elm_icon_add().
27221 * @param func The function to call when the item is selected.
27222 * @param data The data to associate with the item for related callbacks.
27224 * @return The created item or @c NULL upon failure.
27226 * A new item will be created and appended to the diskselector, i.e., will
27227 * be set as last item. Also, if there is no selected item, it will
27228 * be selected. This will always happens for the first appended item.
27230 * If no icon is set, label will be centered on item position, otherwise
27231 * the icon will be placed at left of the label, that will be shifted
27234 * Items created with this method can be deleted with
27235 * elm_diskselector_item_del().
27237 * Associated @p data can be properly freed when item is deleted if a
27238 * callback function is set with elm_diskselector_item_del_cb_set().
27240 * If a function is passed as argument, it will be called everytime this item
27241 * is selected, i.e., the user stops the diskselector with this
27242 * item on center position. If such function isn't needed, just passing
27243 * @c NULL as @p func is enough. The same should be done for @p data.
27245 * Simple example (with no function callback or data associated):
27247 * disk = elm_diskselector_add(win);
27248 * ic = elm_icon_add(win);
27249 * elm_icon_file_set(ic, "path/to/image", NULL);
27250 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27251 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
27254 * @see elm_diskselector_item_del()
27255 * @see elm_diskselector_item_del_cb_set()
27256 * @see elm_diskselector_clear()
27257 * @see elm_icon_add()
27259 * @ingroup Diskselector
27261 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);
27265 * Delete them item from the diskselector.
27267 * @param it The item of diskselector to be deleted.
27269 * If deleting all diskselector items is required, elm_diskselector_clear()
27270 * should be used instead of getting items list and deleting each one.
27272 * @see elm_diskselector_clear()
27273 * @see elm_diskselector_item_append()
27274 * @see elm_diskselector_item_del_cb_set()
27276 * @ingroup Diskselector
27278 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27281 * Set the function called when a diskselector item is freed.
27283 * @param it The item to set the callback on
27284 * @param func The function called
27286 * If there is a @p func, then it will be called prior item's memory release.
27287 * That will be called with the following arguments:
27289 * @li item's Evas object;
27292 * This way, a data associated to a diskselector item could be properly
27295 * @ingroup Diskselector
27297 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
27300 * Get the data associated to the item.
27302 * @param it The diskselector item
27303 * @return The data associated to @p it
27305 * The return value is a pointer to data associated to @p item when it was
27306 * created, with function elm_diskselector_item_append(). If no data
27307 * was passed as argument, it will return @c NULL.
27309 * @see elm_diskselector_item_append()
27311 * @ingroup Diskselector
27313 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27316 * Set the icon associated to the item.
27318 * @param it The diskselector item
27319 * @param icon The icon object to associate with @p it
27321 * The icon object to use at left side of the item. An
27322 * icon can be any Evas object, but usually it is an icon created
27323 * with elm_icon_add().
27325 * Once the icon object is set, a previously set one will be deleted.
27326 * @warning Setting the same icon for two items will cause the icon to
27327 * dissapear from the first item.
27329 * If an icon was passed as argument on item creation, with function
27330 * elm_diskselector_item_append(), it will be already
27331 * associated to the item.
27333 * @see elm_diskselector_item_append()
27334 * @see elm_diskselector_item_icon_get()
27336 * @ingroup Diskselector
27338 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
27341 * Get the icon associated to the item.
27343 * @param it The diskselector item
27344 * @return The icon associated to @p it
27346 * The return value is a pointer to the icon associated to @p item when it was
27347 * created, with function elm_diskselector_item_append(), or later
27348 * with function elm_diskselector_item_icon_set. If no icon
27349 * was passed as argument, it will return @c NULL.
27351 * @see elm_diskselector_item_append()
27352 * @see elm_diskselector_item_icon_set()
27354 * @ingroup Diskselector
27356 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27359 * Set the label of item.
27361 * @param it The item of diskselector.
27362 * @param label The label of item.
27364 * The label to be displayed by the item.
27366 * If no icon is set, label will be centered on item position, otherwise
27367 * the icon will be placed at left of the label, that will be shifted
27370 * An item with label "January" would be displayed on side position as
27371 * "Jan" if max length is set to 3 with function
27372 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
27375 * When this @p item is selected, the entire label will be displayed,
27376 * except for width restrictions.
27377 * In this case label will be cropped and "..." will be concatenated,
27378 * but only for display purposes. It will keep the entire string, so
27379 * if diskselector is resized the remaining characters will be displayed.
27381 * If a label was passed as argument on item creation, with function
27382 * elm_diskselector_item_append(), it will be already
27383 * displayed by the item.
27385 * @see elm_diskselector_side_label_lenght_set()
27386 * @see elm_diskselector_item_label_get()
27387 * @see elm_diskselector_item_append()
27389 * @ingroup Diskselector
27391 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
27394 * Get the label of item.
27396 * @param it The item of diskselector.
27397 * @return The label of item.
27399 * The return value is a pointer to the label associated to @p item when it was
27400 * created, with function elm_diskselector_item_append(), or later
27401 * with function elm_diskselector_item_label_set. If no label
27402 * was passed as argument, it will return @c NULL.
27404 * @see elm_diskselector_item_label_set() for more details.
27405 * @see elm_diskselector_item_append()
27407 * @ingroup Diskselector
27409 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27412 * Get the selected item.
27414 * @param obj The diskselector object.
27415 * @return The selected diskselector item.
27417 * The selected item can be unselected with function
27418 * elm_diskselector_item_selected_set(), and the first item of
27419 * diskselector will be selected.
27421 * The selected item always will be centered on diskselector, with
27422 * full label displayed, i.e., max lenght set to side labels won't
27423 * apply on the selected item. More details on
27424 * elm_diskselector_side_label_length_set().
27426 * @ingroup Diskselector
27428 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27431 * Set the selected state of an item.
27433 * @param it The diskselector item
27434 * @param selected The selected state
27436 * This sets the selected state of the given item @p it.
27437 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27439 * If a new item is selected the previosly selected will be unselected.
27440 * Previoulsy selected item can be get with function
27441 * elm_diskselector_selected_item_get().
27443 * If the item @p it is unselected, the first item of diskselector will
27446 * Selected items will be visible on center position of diskselector.
27447 * So if it was on another position before selected, or was invisible,
27448 * diskselector will animate items until the selected item reaches center
27451 * @see elm_diskselector_item_selected_get()
27452 * @see elm_diskselector_selected_item_get()
27454 * @ingroup Diskselector
27456 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
27459 * Get whether the @p item is selected or not.
27461 * @param it The diskselector item.
27462 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
27463 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
27465 * @see elm_diskselector_selected_item_set() for details.
27466 * @see elm_diskselector_item_selected_get()
27468 * @ingroup Diskselector
27470 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27473 * Get the first item of the diskselector.
27475 * @param obj The diskselector object.
27476 * @return The first item, or @c NULL if none.
27478 * The list of items follows append order. So it will return the first
27479 * item appended to the widget that wasn't deleted.
27481 * @see elm_diskselector_item_append()
27482 * @see elm_diskselector_items_get()
27484 * @ingroup Diskselector
27486 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27489 * Get the last item of the diskselector.
27491 * @param obj The diskselector object.
27492 * @return The last item, or @c NULL if none.
27494 * The list of items follows append order. So it will return last first
27495 * item appended to the widget that wasn't deleted.
27497 * @see elm_diskselector_item_append()
27498 * @see elm_diskselector_items_get()
27500 * @ingroup Diskselector
27502 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27505 * Get the item before @p item in diskselector.
27507 * @param it The diskselector item.
27508 * @return The item before @p item, or @c NULL if none or on failure.
27510 * The list of items follows append order. So it will return item appended
27511 * just before @p item and that wasn't deleted.
27513 * If it is the first item, @c NULL will be returned.
27514 * First item can be get by elm_diskselector_first_item_get().
27516 * @see elm_diskselector_item_append()
27517 * @see elm_diskselector_items_get()
27519 * @ingroup Diskselector
27521 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27524 * Get the item after @p item in diskselector.
27526 * @param it The diskselector item.
27527 * @return The item after @p item, or @c NULL if none or on failure.
27529 * The list of items follows append order. So it will return item appended
27530 * just after @p item and that wasn't deleted.
27532 * If it is the last item, @c NULL will be returned.
27533 * Last item can be get by elm_diskselector_last_item_get().
27535 * @see elm_diskselector_item_append()
27536 * @see elm_diskselector_items_get()
27538 * @ingroup Diskselector
27540 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27543 * Set the text to be shown in the diskselector item.
27545 * @param item Target item
27546 * @param text The text to set in the content
27548 * Setup the text as tooltip to object. The item can have only one tooltip,
27549 * so any previous tooltip data is removed.
27551 * @see elm_object_tooltip_text_set() for more details.
27553 * @ingroup Diskselector
27555 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
27558 * Set the content to be shown in the tooltip item.
27560 * Setup the tooltip to item. The item can have only one tooltip,
27561 * so any previous tooltip data is removed. @p func(with @p data) will
27562 * be called every time that need show the tooltip and it should
27563 * return a valid Evas_Object. This object is then managed fully by
27564 * tooltip system and is deleted when the tooltip is gone.
27566 * @param item the diskselector item being attached a tooltip.
27567 * @param func the function used to create the tooltip contents.
27568 * @param data what to provide to @a func as callback data/context.
27569 * @param del_cb called when data is not needed anymore, either when
27570 * another callback replaces @p func, the tooltip is unset with
27571 * elm_diskselector_item_tooltip_unset() or the owner @a item
27572 * dies. This callback receives as the first parameter the
27573 * given @a data, and @c event_info is the item.
27575 * @see elm_object_tooltip_content_cb_set() for more details.
27577 * @ingroup Diskselector
27579 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);
27582 * Unset tooltip from item.
27584 * @param item diskselector item to remove previously set tooltip.
27586 * Remove tooltip from item. The callback provided as del_cb to
27587 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
27588 * it is not used anymore.
27590 * @see elm_object_tooltip_unset() for more details.
27591 * @see elm_diskselector_item_tooltip_content_cb_set()
27593 * @ingroup Diskselector
27595 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27598 * Sets a different style for this item tooltip.
27600 * @note before you set a style you should define a tooltip with
27601 * elm_diskselector_item_tooltip_content_cb_set() or
27602 * elm_diskselector_item_tooltip_text_set()
27604 * @param item diskselector item with tooltip already set.
27605 * @param style the theme style to use (default, transparent, ...)
27607 * @see elm_object_tooltip_style_set() for more details.
27609 * @ingroup Diskselector
27611 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27614 * Get the style for this item tooltip.
27616 * @param item diskselector item with tooltip already set.
27617 * @return style the theme style in use, defaults to "default". If the
27618 * object does not have a tooltip set, then NULL is returned.
27620 * @see elm_object_tooltip_style_get() for more details.
27621 * @see elm_diskselector_item_tooltip_style_set()
27623 * @ingroup Diskselector
27625 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27628 * Set the cursor to be shown when mouse is over the diskselector item
27630 * @param item Target item
27631 * @param cursor the cursor name to be used.
27633 * @see elm_object_cursor_set() for more details.
27635 * @ingroup Diskselector
27637 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
27640 * Get the cursor to be shown when mouse is over the diskselector item
27642 * @param item diskselector item with cursor already set.
27643 * @return the cursor name.
27645 * @see elm_object_cursor_get() for more details.
27646 * @see elm_diskselector_cursor_set()
27648 * @ingroup Diskselector
27650 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27653 * Unset the cursor to be shown when mouse is over the diskselector item
27655 * @param item Target item
27657 * @see elm_object_cursor_unset() for more details.
27658 * @see elm_diskselector_cursor_set()
27660 * @ingroup Diskselector
27662 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27665 * Sets a different style for this item cursor.
27667 * @note before you set a style you should define a cursor with
27668 * elm_diskselector_item_cursor_set()
27670 * @param item diskselector item with cursor already set.
27671 * @param style the theme style to use (default, transparent, ...)
27673 * @see elm_object_cursor_style_set() for more details.
27675 * @ingroup Diskselector
27677 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27680 * Get the style for this item cursor.
27682 * @param item diskselector item with cursor already set.
27683 * @return style the theme style in use, defaults to "default". If the
27684 * object does not have a cursor set, then @c NULL is returned.
27686 * @see elm_object_cursor_style_get() for more details.
27687 * @see elm_diskselector_item_cursor_style_set()
27689 * @ingroup Diskselector
27691 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27695 * Set if the cursor set should be searched on the theme or should use
27696 * the provided by the engine, only.
27698 * @note before you set if should look on theme you should define a cursor
27699 * with elm_diskselector_item_cursor_set().
27700 * By default it will only look for cursors provided by the engine.
27702 * @param item widget item with cursor already set.
27703 * @param engine_only boolean to define if cursors set with
27704 * elm_diskselector_item_cursor_set() should be searched only
27705 * between cursors provided by the engine or searched on widget's
27708 * @see elm_object_cursor_engine_only_set() for more details.
27710 * @ingroup Diskselector
27712 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
27715 * Get the cursor engine only usage for this item cursor.
27717 * @param item widget item with cursor already set.
27718 * @return engine_only boolean to define it cursors should be looked only
27719 * between the provided by the engine or searched on widget's theme as well.
27720 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
27722 * @see elm_object_cursor_engine_only_get() for more details.
27723 * @see elm_diskselector_item_cursor_engine_only_set()
27725 * @ingroup Diskselector
27727 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27734 * @defgroup Colorselector Colorselector
27738 * @image html img/widget/colorselector/preview-00.png
27739 * @image latex img/widget/colorselector/preview-00.eps
27741 * @brief Widget for user to select a color.
27743 * Signals that you can add callbacks for are:
27744 * "changed" - When the color value changes(event_info is NULL).
27746 * See @ref tutorial_colorselector.
27749 * @brief Add a new colorselector to the parent
27751 * @param parent The parent object
27752 * @return The new object or NULL if it cannot be created
27754 * @ingroup Colorselector
27756 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27758 * Set a color for the colorselector
27760 * @param obj Colorselector object
27761 * @param r r-value of color
27762 * @param g g-value of color
27763 * @param b b-value of color
27764 * @param a a-value of color
27766 * @ingroup Colorselector
27768 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
27770 * Get a color from the colorselector
27772 * @param obj Colorselector object
27773 * @param r integer pointer for r-value of color
27774 * @param g integer pointer for g-value of color
27775 * @param b integer pointer for b-value of color
27776 * @param a integer pointer for a-value of color
27778 * @ingroup Colorselector
27780 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
27786 * @defgroup Ctxpopup Ctxpopup
27788 * @image html img/widget/ctxpopup/preview-00.png
27789 * @image latex img/widget/ctxpopup/preview-00.eps
27791 * @brief Context popup widet.
27793 * A ctxpopup is a widget that, when shown, pops up a list of items.
27794 * It automatically chooses an area inside its parent object's view
27795 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
27796 * optimally fit into it. In the default theme, it will also point an
27797 * arrow to it's top left position at the time one shows it. Ctxpopup
27798 * items have a label and/or an icon. It is intended for a small
27799 * number of items (hence the use of list, not genlist).
27801 * @note Ctxpopup is a especialization of @ref Hover.
27803 * Signals that you can add callbacks for are:
27804 * "dismissed" - the ctxpopup was dismissed
27806 * Default contents parts of the ctxpopup widget that you can use for are:
27807 * @li "default" - A content of the ctxpopup
27809 * Default contents parts of the ctxpopup items that you can use for are:
27810 * @li "icon" - An icon in the title area
27812 * Default text parts of the ctxpopup items that you can use for are:
27813 * @li "default" - Title label in the title area
27815 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
27820 * @addtogroup Ctxpopup
27824 typedef enum _Elm_Ctxpopup_Direction
27826 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
27828 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
27829 the clicked area */
27830 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
27831 the clicked area */
27832 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
27834 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
27835 } Elm_Ctxpopup_Direction;
27838 * @brief Add a new Ctxpopup object to the parent.
27840 * @param parent Parent object
27841 * @return New object or @c NULL, if it cannot be created
27843 * @ingroup Ctxpopup
27845 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27848 * @brief Set the Ctxpopup's parent
27850 * @param obj The ctxpopup object
27851 * @param area The parent to use
27853 * Set the parent object.
27855 * @note elm_ctxpopup_add() will automatically call this function
27856 * with its @c parent argument.
27858 * @see elm_ctxpopup_add()
27859 * @see elm_hover_parent_set()
27861 * @ingroup Ctxpopup
27863 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27866 * @brief Get the Ctxpopup's parent
27868 * @param obj The ctxpopup object
27870 * @see elm_ctxpopup_hover_parent_set() for more information
27872 * @ingroup Ctxpopup
27874 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27877 * @brief Clear all items in the given ctxpopup object.
27879 * @param obj Ctxpopup object
27881 * @ingroup Ctxpopup
27883 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27886 * @brief Change the ctxpopup's orientation to horizontal or vertical.
27888 * @param obj Ctxpopup object
27889 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27891 * @ingroup Ctxpopup
27893 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27896 * @brief Get the value of current ctxpopup object's orientation.
27898 * @param obj Ctxpopup object
27899 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27901 * @see elm_ctxpopup_horizontal_set()
27903 * @ingroup Ctxpopup
27905 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27908 * @brief Add a new item to a ctxpopup object.
27910 * @param obj Ctxpopup object
27911 * @param icon Icon to be set on new item
27912 * @param label The Label of the new item
27913 * @param func Convenience function called when item selected
27914 * @param data Data passed to @p func
27915 * @return A handle to the item added or @c NULL, on errors
27917 * @warning Ctxpopup can't hold both an item list and a content at the same
27918 * time. When an item is added, any previous content will be removed.
27920 * @see elm_ctxpopup_content_set()
27922 * @ingroup Ctxpopup
27924 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);
27927 * @brief Delete the given item in a ctxpopup object.
27929 * @param it Ctxpopup item to be deleted
27931 * @see elm_ctxpopup_item_append()
27933 * @ingroup Ctxpopup
27935 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27938 * @brief Set the ctxpopup item's state as disabled or enabled.
27940 * @param it Ctxpopup item to be enabled/disabled
27941 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27943 * When disabled the item is greyed out to indicate it's state.
27944 * @deprecated use elm_object_item_disabled_set() instead
27946 * @ingroup Ctxpopup
27948 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27951 * @brief Get the ctxpopup item's disabled/enabled state.
27953 * @param it Ctxpopup item to be enabled/disabled
27954 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27956 * @see elm_ctxpopup_item_disabled_set()
27957 * @deprecated use elm_object_item_disabled_get() instead
27959 * @ingroup Ctxpopup
27961 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27964 * @brief Get the icon object for the given ctxpopup item.
27966 * @param it Ctxpopup item
27967 * @return icon object or @c NULL, if the item does not have icon or an error
27970 * @see elm_ctxpopup_item_append()
27971 * @see elm_ctxpopup_item_icon_set()
27973 * @deprecated use elm_object_item_part_content_get() instead
27975 * @ingroup Ctxpopup
27977 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27980 * @brief Sets the side icon associated with the ctxpopup item
27982 * @param it Ctxpopup item
27983 * @param icon Icon object to be set
27985 * Once the icon object is set, a previously set one will be deleted.
27986 * @warning Setting the same icon for two items will cause the icon to
27987 * dissapear from the first item.
27989 * @see elm_ctxpopup_item_append()
27991 * @deprecated use elm_object_item_part_content_set() instead
27993 * @ingroup Ctxpopup
27995 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27998 * @brief Get the label for the given ctxpopup item.
28000 * @param it Ctxpopup item
28001 * @return label string or @c NULL, if the item does not have label or an
28004 * @see elm_ctxpopup_item_append()
28005 * @see elm_ctxpopup_item_label_set()
28007 * @deprecated use elm_object_item_text_get() instead
28009 * @ingroup Ctxpopup
28011 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28014 * @brief (Re)set the label on the given ctxpopup item.
28016 * @param it Ctxpopup item
28017 * @param label String to set as label
28019 * @deprecated use elm_object_item_text_set() instead
28021 * @ingroup Ctxpopup
28023 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
28026 * @brief Set an elm widget as the content of the ctxpopup.
28028 * @param obj Ctxpopup object
28029 * @param content Content to be swallowed
28031 * If the content object is already set, a previous one will bedeleted. If
28032 * you want to keep that old content object, use the
28033 * elm_ctxpopup_content_unset() function.
28035 * @warning Ctxpopup can't hold both a item list and a content at the same
28036 * time. When a content is set, any previous items will be removed.
28038 * @deprecated use elm_object_content_set() instead
28040 * @ingroup Ctxpopup
28042 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
28045 * @brief Unset the ctxpopup content
28047 * @param obj Ctxpopup object
28048 * @return The content that was being used
28050 * Unparent and return the content object which was set for this widget.
28052 * @deprecated use elm_object_content_unset()
28054 * @see elm_ctxpopup_content_set()
28056 * @deprecated use elm_object_content_unset() instead
28058 * @ingroup Ctxpopup
28060 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
28063 * @brief Set the direction priority of a ctxpopup.
28065 * @param obj Ctxpopup object
28066 * @param first 1st priority of direction
28067 * @param second 2nd priority of direction
28068 * @param third 3th priority of direction
28069 * @param fourth 4th priority of direction
28071 * This functions gives a chance to user to set the priority of ctxpopup
28072 * showing direction. This doesn't guarantee the ctxpopup will appear in the
28073 * requested direction.
28075 * @see Elm_Ctxpopup_Direction
28077 * @ingroup Ctxpopup
28079 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);
28082 * @brief Get the direction priority of a ctxpopup.
28084 * @param obj Ctxpopup object
28085 * @param first 1st priority of direction to be returned
28086 * @param second 2nd priority of direction to be returned
28087 * @param third 3th priority of direction to be returned
28088 * @param fourth 4th priority of direction to be returned
28090 * @see elm_ctxpopup_direction_priority_set() for more information.
28092 * @ingroup Ctxpopup
28094 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);
28097 * @brief Get the current direction of a ctxpopup.
28099 * @param obj Ctxpopup object
28100 * @return current direction of a ctxpopup
28102 * @warning Once the ctxpopup showed up, the direction would be determined
28104 * @ingroup Ctxpopup
28106 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28115 * @defgroup Transit Transit
28116 * @ingroup Elementary
28118 * Transit is designed to apply various animated transition effects to @c
28119 * Evas_Object, such like translation, rotation, etc. For using these
28120 * effects, create an @ref Elm_Transit and add the desired transition effects.
28122 * Once the effects are added into transit, they will be automatically
28123 * managed (their callback will be called until the duration is ended, and
28124 * they will be deleted on completion).
28128 * Elm_Transit *trans = elm_transit_add();
28129 * elm_transit_object_add(trans, obj);
28130 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
28131 * elm_transit_duration_set(transit, 1);
28132 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
28133 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
28134 * elm_transit_repeat_times_set(transit, 3);
28137 * Some transition effects are used to change the properties of objects. They
28139 * @li @ref elm_transit_effect_translation_add
28140 * @li @ref elm_transit_effect_color_add
28141 * @li @ref elm_transit_effect_rotation_add
28142 * @li @ref elm_transit_effect_wipe_add
28143 * @li @ref elm_transit_effect_zoom_add
28144 * @li @ref elm_transit_effect_resizing_add
28146 * Other transition effects are used to make one object disappear and another
28147 * object appear on its old place. These effects are:
28149 * @li @ref elm_transit_effect_flip_add
28150 * @li @ref elm_transit_effect_resizable_flip_add
28151 * @li @ref elm_transit_effect_fade_add
28152 * @li @ref elm_transit_effect_blend_add
28154 * It's also possible to make a transition chain with @ref
28155 * elm_transit_chain_transit_add.
28157 * @warning We strongly recommend to use elm_transit just when edje can not do
28158 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
28159 * animations can be manipulated inside the theme.
28161 * List of examples:
28162 * @li @ref transit_example_01_explained
28163 * @li @ref transit_example_02_explained
28164 * @li @ref transit_example_03_c
28165 * @li @ref transit_example_04_c
28171 * @enum Elm_Transit_Tween_Mode
28173 * The type of acceleration used in the transition.
28177 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
28178 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
28179 over time, then decrease again
28181 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
28183 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
28185 } Elm_Transit_Tween_Mode;
28188 * @enum Elm_Transit_Effect_Flip_Axis
28190 * The axis where flip effect should be applied.
28194 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
28195 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
28196 } Elm_Transit_Effect_Flip_Axis;
28199 * @enum Elm_Transit_Effect_Wipe_Dir
28201 * The direction where the wipe effect should occur.
28205 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
28206 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
28207 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
28208 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
28209 } Elm_Transit_Effect_Wipe_Dir;
28211 /** @enum Elm_Transit_Effect_Wipe_Type
28213 * Whether the wipe effect should show or hide the object.
28217 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
28219 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
28221 } Elm_Transit_Effect_Wipe_Type;
28224 * @typedef Elm_Transit
28226 * The Transit created with elm_transit_add(). This type has the information
28227 * about the objects which the transition will be applied, and the
28228 * transition effects that will be used. It also contains info about
28229 * duration, number of repetitions, auto-reverse, etc.
28231 typedef struct _Elm_Transit Elm_Transit;
28232 typedef void Elm_Transit_Effect;
28235 * @typedef Elm_Transit_Effect_Transition_Cb
28237 * Transition callback called for this effect on each transition iteration.
28239 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
28242 * Elm_Transit_Effect_End_Cb
28244 * Transition callback called for this effect when the transition is over.
28246 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
28249 * Elm_Transit_Del_Cb
28251 * A callback called when the transit is deleted.
28253 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
28258 * @note Is not necessary to delete the transit object, it will be deleted at
28259 * the end of its operation.
28260 * @note The transit will start playing when the program enter in the main loop, is not
28261 * necessary to give a start to the transit.
28263 * @return The transit object.
28267 EAPI Elm_Transit *elm_transit_add(void);
28270 * Stops the animation and delete the @p transit object.
28272 * Call this function if you wants to stop the animation before the duration
28273 * time. Make sure the @p transit object is still alive with
28274 * elm_transit_del_cb_set() function.
28275 * All added effects will be deleted, calling its repective data_free_cb
28276 * functions. The function setted by elm_transit_del_cb_set() will be called.
28278 * @see elm_transit_del_cb_set()
28280 * @param transit The transit object to be deleted.
28283 * @warning Just call this function if you are sure the transit is alive.
28285 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28288 * Add a new effect to the transit.
28290 * @note The cb function and the data are the key to the effect. If you try to
28291 * add an already added effect, nothing is done.
28292 * @note After the first addition of an effect in @p transit, if its
28293 * effect list become empty again, the @p transit will be killed by
28294 * elm_transit_del(transit) function.
28298 * Elm_Transit *transit = elm_transit_add();
28299 * elm_transit_effect_add(transit,
28300 * elm_transit_effect_blend_op,
28301 * elm_transit_effect_blend_context_new(),
28302 * elm_transit_effect_blend_context_free);
28305 * @param transit The transit object.
28306 * @param transition_cb The operation function. It is called when the
28307 * animation begins, it is the function that actually performs the animation.
28308 * It is called with the @p data, @p transit and the time progression of the
28309 * animation (a double value between 0.0 and 1.0).
28310 * @param effect The context data of the effect.
28311 * @param end_cb The function to free the context data, it will be called
28312 * at the end of the effect, it must finalize the animation and free the
28316 * @warning The transit free the context data at the and of the transition with
28317 * the data_free_cb function, do not use the context data in another transit.
28319 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);
28322 * Delete an added effect.
28324 * This function will remove the effect from the @p transit, calling the
28325 * data_free_cb to free the @p data.
28327 * @see elm_transit_effect_add()
28329 * @note If the effect is not found, nothing is done.
28330 * @note If the effect list become empty, this function will call
28331 * elm_transit_del(transit), that is, it will kill the @p transit.
28333 * @param transit The transit object.
28334 * @param transition_cb The operation function.
28335 * @param effect The context data of the effect.
28339 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);
28342 * Add new object to apply the effects.
28344 * @note After the first addition of an object in @p transit, if its
28345 * object list become empty again, the @p transit will be killed by
28346 * elm_transit_del(transit) function.
28347 * @note If the @p obj belongs to another transit, the @p obj will be
28348 * removed from it and it will only belong to the @p transit. If the old
28349 * transit stays without objects, it will die.
28350 * @note When you add an object into the @p transit, its state from
28351 * evas_object_pass_events_get(obj) is saved, and it is applied when the
28352 * transit ends, if you change this state whith evas_object_pass_events_set()
28353 * after add the object, this state will change again when @p transit stops to
28356 * @param transit The transit object.
28357 * @param obj Object to be animated.
28360 * @warning It is not allowed to add a new object after transit begins to go.
28362 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28365 * Removes an added object from the transit.
28367 * @note If the @p obj is not in the @p transit, nothing is done.
28368 * @note If the list become empty, this function will call
28369 * elm_transit_del(transit), that is, it will kill the @p transit.
28371 * @param transit The transit object.
28372 * @param obj Object to be removed from @p transit.
28375 * @warning It is not allowed to remove objects after transit begins to go.
28377 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28380 * Get the objects of the transit.
28382 * @param transit The transit object.
28383 * @return a Eina_List with the objects from the transit.
28387 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28390 * Enable/disable keeping up the objects states.
28391 * If it is not kept, the objects states will be reset when transition ends.
28393 * @note @p transit can not be NULL.
28394 * @note One state includes geometry, color, map data.
28396 * @param transit The transit object.
28397 * @param state_keep Keeping or Non Keeping.
28401 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
28404 * Get a value whether the objects states will be reset or not.
28406 * @note @p transit can not be NULL
28408 * @see elm_transit_objects_final_state_keep_set()
28410 * @param transit The transit object.
28411 * @return EINA_TRUE means the states of the objects will be reset.
28412 * If @p transit is NULL, EINA_FALSE is returned
28416 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28419 * Set the event enabled when transit is operating.
28421 * If @p enabled is EINA_TRUE, the objects of the transit will receives
28422 * events from mouse and keyboard during the animation.
28423 * @note When you add an object with elm_transit_object_add(), its state from
28424 * evas_object_pass_events_get(obj) is saved, and it is applied when the
28425 * transit ends, if you change this state with evas_object_pass_events_set()
28426 * after adding the object, this state will change again when @p transit stops
28429 * @param transit The transit object.
28430 * @param enabled Events are received when enabled is @c EINA_TRUE, and
28431 * ignored otherwise.
28435 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
28438 * Get the value of event enabled status.
28440 * @see elm_transit_event_enabled_set()
28442 * @param transit The Transit object
28443 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
28444 * EINA_FALSE is returned
28448 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28451 * Set the user-callback function when the transit is deleted.
28453 * @note Using this function twice will overwrite the first function setted.
28454 * @note the @p transit object will be deleted after call @p cb function.
28456 * @param transit The transit object.
28457 * @param cb Callback function pointer. This function will be called before
28458 * the deletion of the transit.
28459 * @param data Callback funtion user data. It is the @p op parameter.
28463 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
28466 * Set reverse effect automatically.
28468 * If auto reverse is setted, after running the effects with the progress
28469 * parameter from 0 to 1, it will call the effecs again with the progress
28470 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
28471 * where the duration was setted with the function elm_transit_add and
28472 * the repeat with the function elm_transit_repeat_times_set().
28474 * @param transit The transit object.
28475 * @param reverse EINA_TRUE means the auto_reverse is on.
28479 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
28482 * Get if the auto reverse is on.
28484 * @see elm_transit_auto_reverse_set()
28486 * @param transit The transit object.
28487 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
28488 * EINA_FALSE is returned
28492 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28495 * Set the transit repeat count. Effect will be repeated by repeat count.
28497 * This function sets the number of repetition the transit will run after
28498 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
28499 * If the @p repeat is a negative number, it will repeat infinite times.
28501 * @note If this function is called during the transit execution, the transit
28502 * will run @p repeat times, ignoring the times it already performed.
28504 * @param transit The transit object
28505 * @param repeat Repeat count
28509 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
28512 * Get the transit repeat count.
28514 * @see elm_transit_repeat_times_set()
28516 * @param transit The Transit object.
28517 * @return The repeat count. If @p transit is NULL
28522 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28525 * Set the transit animation acceleration type.
28527 * This function sets the tween mode of the transit that can be:
28528 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
28529 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
28530 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
28531 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
28533 * @param transit The transit object.
28534 * @param tween_mode The tween type.
28538 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
28541 * Get the transit animation acceleration type.
28543 * @note @p transit can not be NULL
28545 * @param transit The transit object.
28546 * @return The tween type. If @p transit is NULL
28547 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
28551 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28554 * Set the transit animation time
28556 * @note @p transit can not be NULL
28558 * @param transit The transit object.
28559 * @param duration The animation time.
28563 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
28566 * Get the transit animation time
28568 * @note @p transit can not be NULL
28570 * @param transit The transit object.
28572 * @return The transit animation time.
28576 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28579 * Starts the transition.
28580 * Once this API is called, the transit begins to measure the time.
28582 * @note @p transit can not be NULL
28584 * @param transit The transit object.
28588 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28591 * Pause/Resume the transition.
28593 * If you call elm_transit_go again, the transit will be started from the
28594 * beginning, and will be unpaused.
28596 * @note @p transit can not be NULL
28598 * @param transit The transit object.
28599 * @param paused Whether the transition should be paused or not.
28603 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
28606 * Get the value of paused status.
28608 * @see elm_transit_paused_set()
28610 * @note @p transit can not be NULL
28612 * @param transit The transit object.
28613 * @return EINA_TRUE means transition is paused. If @p transit is NULL
28614 * EINA_FALSE is returned
28618 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28621 * Get the time progression of the animation (a double value between 0.0 and 1.0).
28623 * The value returned is a fraction (current time / total time). It
28624 * represents the progression position relative to the total.
28626 * @note @p transit can not be NULL
28628 * @param transit The transit object.
28630 * @return The time progression value. If @p transit is NULL
28635 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28638 * Makes the chain relationship between two transits.
28640 * @note @p transit can not be NULL. Transit would have multiple chain transits.
28641 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
28643 * @param transit The transit object.
28644 * @param chain_transit The chain transit object. This transit will be operated
28645 * after transit is done.
28647 * This function adds @p chain_transit transition to a chain after the @p
28648 * transit, and will be started as soon as @p transit ends. See @ref
28649 * transit_example_02_explained for a full example.
28653 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
28656 * Cut off the chain relationship between two transits.
28658 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
28659 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
28661 * @param transit The transit object.
28662 * @param chain_transit The chain transit object.
28664 * This function remove the @p chain_transit transition from the @p transit.
28668 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
28671 * Get the current chain transit list.
28673 * @note @p transit can not be NULL.
28675 * @param transit The transit object.
28676 * @return chain transit list.
28680 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
28683 * Add the Resizing Effect to Elm_Transit.
28685 * @note This API is one of the facades. It creates resizing effect context
28686 * and add it's required APIs to elm_transit_effect_add.
28688 * @see elm_transit_effect_add()
28690 * @param transit Transit object.
28691 * @param from_w Object width size when effect begins.
28692 * @param from_h Object height size when effect begins.
28693 * @param to_w Object width size when effect ends.
28694 * @param to_h Object height size when effect ends.
28695 * @return Resizing effect context data.
28699 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);
28702 * Add the Translation Effect to Elm_Transit.
28704 * @note This API is one of the facades. It creates translation effect context
28705 * and add it's required APIs to elm_transit_effect_add.
28707 * @see elm_transit_effect_add()
28709 * @param transit Transit object.
28710 * @param from_dx X Position variation when effect begins.
28711 * @param from_dy Y Position variation when effect begins.
28712 * @param to_dx X Position variation when effect ends.
28713 * @param to_dy Y Position variation when effect ends.
28714 * @return Translation effect context data.
28717 * @warning It is highly recommended just create a transit with this effect when
28718 * the window that the objects of the transit belongs has already been created.
28719 * This is because this effect needs the geometry information about the objects,
28720 * and if the window was not created yet, it can get a wrong information.
28722 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);
28725 * Add the Zoom Effect to Elm_Transit.
28727 * @note This API is one of the facades. It creates zoom effect context
28728 * and add it's required APIs to elm_transit_effect_add.
28730 * @see elm_transit_effect_add()
28732 * @param transit Transit object.
28733 * @param from_rate Scale rate when effect begins (1 is current rate).
28734 * @param to_rate Scale rate when effect ends.
28735 * @return Zoom effect context data.
28738 * @warning It is highly recommended just create a transit with this effect when
28739 * the window that the objects of the transit belongs has already been created.
28740 * This is because this effect needs the geometry information about the objects,
28741 * and if the window was not created yet, it can get a wrong information.
28743 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
28746 * Add the Flip Effect to Elm_Transit.
28748 * @note This API is one of the facades. It creates flip effect context
28749 * and add it's required APIs to elm_transit_effect_add.
28750 * @note This effect is applied to each pair of objects in the order they are listed
28751 * in the transit list of objects. The first object in the pair will be the
28752 * "front" object and the second will be the "back" object.
28754 * @see elm_transit_effect_add()
28756 * @param transit Transit object.
28757 * @param axis Flipping Axis(X or Y).
28758 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28759 * @return Flip effect context data.
28762 * @warning It is highly recommended just create a transit with this effect when
28763 * the window that the objects of the transit belongs has already been created.
28764 * This is because this effect needs the geometry information about the objects,
28765 * and if the window was not created yet, it can get a wrong information.
28767 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28770 * Add the Resizable Flip Effect to Elm_Transit.
28772 * @note This API is one of the facades. It creates resizable flip effect context
28773 * and add it's required APIs to elm_transit_effect_add.
28774 * @note This effect is applied to each pair of objects in the order they are listed
28775 * in the transit list of objects. The first object in the pair will be the
28776 * "front" object and the second will be the "back" object.
28778 * @see elm_transit_effect_add()
28780 * @param transit Transit object.
28781 * @param axis Flipping Axis(X or Y).
28782 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28783 * @return Resizable flip effect context data.
28786 * @warning It is highly recommended just create a transit with this effect when
28787 * the window that the objects of the transit belongs has already been created.
28788 * This is because this effect needs the geometry information about the objects,
28789 * and if the window was not created yet, it can get a wrong information.
28791 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28794 * Add the Wipe Effect to Elm_Transit.
28796 * @note This API is one of the facades. It creates wipe effect context
28797 * and add it's required APIs to elm_transit_effect_add.
28799 * @see elm_transit_effect_add()
28801 * @param transit Transit object.
28802 * @param type Wipe type. Hide or show.
28803 * @param dir Wipe Direction.
28804 * @return Wipe effect context data.
28807 * @warning It is highly recommended just create a transit with this effect when
28808 * the window that the objects of the transit belongs has already been created.
28809 * This is because this effect needs the geometry information about the objects,
28810 * and if the window was not created yet, it can get a wrong information.
28812 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
28815 * Add the Color Effect to Elm_Transit.
28817 * @note This API is one of the facades. It creates color effect context
28818 * and add it's required APIs to elm_transit_effect_add.
28820 * @see elm_transit_effect_add()
28822 * @param transit Transit object.
28823 * @param from_r RGB R when effect begins.
28824 * @param from_g RGB G when effect begins.
28825 * @param from_b RGB B when effect begins.
28826 * @param from_a RGB A when effect begins.
28827 * @param to_r RGB R when effect ends.
28828 * @param to_g RGB G when effect ends.
28829 * @param to_b RGB B when effect ends.
28830 * @param to_a RGB A when effect ends.
28831 * @return Color effect context data.
28835 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);
28838 * Add the Fade Effect to Elm_Transit.
28840 * @note This API is one of the facades. It creates fade effect context
28841 * and add it's required APIs to elm_transit_effect_add.
28842 * @note This effect is applied to each pair of objects in the order they are listed
28843 * in the transit list of objects. The first object in the pair will be the
28844 * "before" object and the second will be the "after" object.
28846 * @see elm_transit_effect_add()
28848 * @param transit Transit object.
28849 * @return Fade effect context data.
28852 * @warning It is highly recommended just create a transit with this effect when
28853 * the window that the objects of the transit belongs has already been created.
28854 * This is because this effect needs the color information about the objects,
28855 * and if the window was not created yet, it can get a wrong information.
28857 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
28860 * Add the Blend Effect to Elm_Transit.
28862 * @note This API is one of the facades. It creates blend effect context
28863 * and add it's required APIs to elm_transit_effect_add.
28864 * @note This effect is applied to each pair of objects in the order they are listed
28865 * in the transit list of objects. The first object in the pair will be the
28866 * "before" object and the second will be the "after" object.
28868 * @see elm_transit_effect_add()
28870 * @param transit Transit object.
28871 * @return Blend effect context data.
28874 * @warning It is highly recommended just create a transit with this effect when
28875 * the window that the objects of the transit belongs has already been created.
28876 * This is because this effect needs the color information about the objects,
28877 * and if the window was not created yet, it can get a wrong information.
28879 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
28882 * Add the Rotation Effect to Elm_Transit.
28884 * @note This API is one of the facades. It creates rotation effect context
28885 * and add it's required APIs to elm_transit_effect_add.
28887 * @see elm_transit_effect_add()
28889 * @param transit Transit object.
28890 * @param from_degree Degree when effect begins.
28891 * @param to_degree Degree when effect is ends.
28892 * @return Rotation effect context data.
28895 * @warning It is highly recommended just create a transit with this effect when
28896 * the window that the objects of the transit belongs has already been created.
28897 * This is because this effect needs the geometry information about the objects,
28898 * and if the window was not created yet, it can get a wrong information.
28900 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28903 * Add the ImageAnimation Effect to Elm_Transit.
28905 * @note This API is one of the facades. It creates image animation effect context
28906 * and add it's required APIs to elm_transit_effect_add.
28907 * The @p images parameter is a list images paths. This list and
28908 * its contents will be deleted at the end of the effect by
28909 * elm_transit_effect_image_animation_context_free() function.
28913 * char buf[PATH_MAX];
28914 * Eina_List *images = NULL;
28915 * Elm_Transit *transi = elm_transit_add();
28917 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28918 * images = eina_list_append(images, eina_stringshare_add(buf));
28920 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28921 * images = eina_list_append(images, eina_stringshare_add(buf));
28922 * elm_transit_effect_image_animation_add(transi, images);
28926 * @see elm_transit_effect_add()
28928 * @param transit Transit object.
28929 * @param images Eina_List of images file paths. This list and
28930 * its contents will be deleted at the end of the effect by
28931 * elm_transit_effect_image_animation_context_free() function.
28932 * @return Image Animation effect context data.
28936 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28941 typedef struct _Elm_Store Elm_Store;
28942 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
28943 typedef struct _Elm_Store_Item Elm_Store_Item;
28944 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
28945 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
28946 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28947 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
28948 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
28949 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
28950 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
28951 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
28953 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28954 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28955 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28956 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28960 ELM_STORE_ITEM_MAPPING_NONE = 0,
28961 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
28962 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
28963 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
28964 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
28965 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
28966 // can add more here as needed by common apps
28967 ELM_STORE_ITEM_MAPPING_LAST
28968 } Elm_Store_Item_Mapping_Type;
28970 struct _Elm_Store_Item_Mapping_Icon
28972 // FIXME: allow edje file icons
28974 Elm_Icon_Lookup_Order lookup_order;
28975 Eina_Bool standard_name : 1;
28976 Eina_Bool no_scale : 1;
28977 Eina_Bool smooth : 1;
28978 Eina_Bool scale_up : 1;
28979 Eina_Bool scale_down : 1;
28982 struct _Elm_Store_Item_Mapping_Empty
28987 struct _Elm_Store_Item_Mapping_Photo
28992 struct _Elm_Store_Item_Mapping_Custom
28994 Elm_Store_Item_Mapping_Cb func;
28997 struct _Elm_Store_Item_Mapping
28999 Elm_Store_Item_Mapping_Type type;
29004 Elm_Store_Item_Mapping_Empty empty;
29005 Elm_Store_Item_Mapping_Icon icon;
29006 Elm_Store_Item_Mapping_Photo photo;
29007 Elm_Store_Item_Mapping_Custom custom;
29008 // add more types here
29012 struct _Elm_Store_Item_Info
29014 Elm_Genlist_Item_Class *item_class;
29015 const Elm_Store_Item_Mapping *mapping;
29020 struct _Elm_Store_Item_Info_Filesystem
29022 Elm_Store_Item_Info base;
29026 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
29027 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
29029 EAPI void elm_store_free(Elm_Store *st);
29031 EAPI Elm_Store *elm_store_filesystem_new(void);
29032 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
29033 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29034 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29036 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
29038 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
29039 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29040 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29041 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29042 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
29043 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29045 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29046 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
29047 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29048 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
29049 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29050 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29051 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29054 * @defgroup SegmentControl SegmentControl
29055 * @ingroup Elementary
29057 * @image html img/widget/segment_control/preview-00.png
29058 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
29060 * @image html img/segment_control.png
29061 * @image latex img/segment_control.eps width=\textwidth
29063 * Segment control widget is a horizontal control made of multiple segment
29064 * items, each segment item functioning similar to discrete two state button.
29065 * A segment control groups the items together and provides compact
29066 * single button with multiple equal size segments.
29068 * Segment item size is determined by base widget
29069 * size and the number of items added.
29070 * Only one segment item can be at selected state. A segment item can display
29071 * combination of Text and any Evas_Object like Images or other widget.
29073 * Smart callbacks one can listen to:
29074 * - "changed" - When the user clicks on a segment item which is not
29075 * previously selected and get selected. The event_info parameter is the
29076 * segment item pointer.
29078 * Available styles for it:
29081 * Here is an example on its usage:
29082 * @li @ref segment_control_example
29086 * @addtogroup SegmentControl
29090 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
29093 * Add a new segment control widget to the given parent Elementary
29094 * (container) object.
29096 * @param parent The parent object.
29097 * @return a new segment control widget handle or @c NULL, on errors.
29099 * This function inserts a new segment control widget on the canvas.
29101 * @ingroup SegmentControl
29103 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29106 * Append a new item to the segment control object.
29108 * @param obj The segment control object.
29109 * @param icon The icon object to use for the left side of the item. An
29110 * icon can be any Evas object, but usually it is an icon created
29111 * with elm_icon_add().
29112 * @param label The label of the item.
29113 * Note that, NULL is different from empty string "".
29114 * @return The created item or @c NULL upon failure.
29116 * A new item will be created and appended to the segment control, i.e., will
29117 * be set as @b last item.
29119 * If it should be inserted at another position,
29120 * elm_segment_control_item_insert_at() should be used instead.
29122 * Items created with this function can be deleted with function
29123 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29125 * @note @p label set to @c NULL is different from empty string "".
29127 * only has icon, it will be displayed bigger and centered. If it has
29128 * icon and label, even that an empty string, icon will be smaller and
29129 * positioned at left.
29133 * sc = elm_segment_control_add(win);
29134 * ic = elm_icon_add(win);
29135 * elm_icon_file_set(ic, "path/to/image", NULL);
29136 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
29137 * elm_segment_control_item_add(sc, ic, "label");
29138 * evas_object_show(sc);
29141 * @see elm_segment_control_item_insert_at()
29142 * @see elm_segment_control_item_del()
29144 * @ingroup SegmentControl
29146 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
29149 * Insert a new item to the segment control object at specified position.
29151 * @param obj The segment control object.
29152 * @param icon The icon object to use for the left side of the item. An
29153 * icon can be any Evas object, but usually it is an icon created
29154 * with elm_icon_add().
29155 * @param label The label of the item.
29156 * @param index Item position. Value should be between 0 and items count.
29157 * @return The created item or @c NULL upon failure.
29159 * Index values must be between @c 0, when item will be prepended to
29160 * segment control, and items count, that can be get with
29161 * elm_segment_control_item_count_get(), case when item will be appended
29162 * to segment control, just like elm_segment_control_item_add().
29164 * Items created with this function can be deleted with function
29165 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29167 * @note @p label set to @c NULL is different from empty string "".
29169 * only has icon, it will be displayed bigger and centered. If it has
29170 * icon and label, even that an empty string, icon will be smaller and
29171 * positioned at left.
29173 * @see elm_segment_control_item_add()
29174 * @see elm_segment_control_item_count_get()
29175 * @see elm_segment_control_item_del()
29177 * @ingroup SegmentControl
29179 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);
29182 * Remove a segment control item from its parent, deleting it.
29184 * @param it The item to be removed.
29186 * Items can be added with elm_segment_control_item_add() or
29187 * elm_segment_control_item_insert_at().
29189 * @ingroup SegmentControl
29191 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29194 * Remove a segment control item at given index from its parent,
29197 * @param obj The segment control object.
29198 * @param index The position of the segment control item to be deleted.
29200 * Items can be added with elm_segment_control_item_add() or
29201 * elm_segment_control_item_insert_at().
29203 * @ingroup SegmentControl
29205 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29208 * Get the Segment items count from segment control.
29210 * @param obj The segment control object.
29211 * @return Segment items count.
29213 * It will just return the number of items added to segment control @p obj.
29215 * @ingroup SegmentControl
29217 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29220 * Get the item placed at specified index.
29222 * @param obj The segment control object.
29223 * @param index The index of the segment item.
29224 * @return The segment control item or @c NULL on failure.
29226 * Index is the position of an item in segment control widget. Its
29227 * range is from @c 0 to <tt> count - 1 </tt>.
29228 * Count is the number of items, that can be get with
29229 * elm_segment_control_item_count_get().
29231 * @ingroup SegmentControl
29233 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29236 * Get the label of item.
29238 * @param obj The segment control object.
29239 * @param index The index of the segment item.
29240 * @return The label of the item at @p index.
29242 * The return value is a pointer to the label associated to the item when
29243 * it was created, with function elm_segment_control_item_add(), or later
29244 * with function elm_segment_control_item_label_set. If no label
29245 * was passed as argument, it will return @c NULL.
29247 * @see elm_segment_control_item_label_set() for more details.
29248 * @see elm_segment_control_item_add()
29250 * @ingroup SegmentControl
29252 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29255 * Set the label of item.
29257 * @param it The item of segment control.
29258 * @param text The label of item.
29260 * The label to be displayed by the item.
29261 * Label will be at right of the icon (if set).
29263 * If a label was passed as argument on item creation, with function
29264 * elm_control_segment_item_add(), it will be already
29265 * displayed by the item.
29267 * @see elm_segment_control_item_label_get()
29268 * @see elm_segment_control_item_add()
29270 * @ingroup SegmentControl
29272 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
29275 * Get the icon associated to the item.
29277 * @param obj The segment control object.
29278 * @param index The index of the segment item.
29279 * @return The left side icon associated to the item at @p index.
29281 * The return value is a pointer to the icon associated to the item when
29282 * it was created, with function elm_segment_control_item_add(), or later
29283 * with function elm_segment_control_item_icon_set(). If no icon
29284 * was passed as argument, it will return @c NULL.
29286 * @see elm_segment_control_item_add()
29287 * @see elm_segment_control_item_icon_set()
29289 * @ingroup SegmentControl
29291 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29294 * Set the icon associated to the item.
29296 * @param it The segment control item.
29297 * @param icon The icon object to associate with @p it.
29299 * The icon object to use at left side of the item. An
29300 * icon can be any Evas object, but usually it is an icon created
29301 * with elm_icon_add().
29303 * Once the icon object is set, a previously set one will be deleted.
29304 * @warning Setting the same icon for two items will cause the icon to
29305 * dissapear from the first item.
29307 * If an icon was passed as argument on item creation, with function
29308 * elm_segment_control_item_add(), it will be already
29309 * associated to the item.
29311 * @see elm_segment_control_item_add()
29312 * @see elm_segment_control_item_icon_get()
29314 * @ingroup SegmentControl
29316 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
29319 * Get the index of an item.
29321 * @param it The segment control item.
29322 * @return The position of item in segment control widget.
29324 * Index is the position of an item in segment control widget. Its
29325 * range is from @c 0 to <tt> count - 1 </tt>.
29326 * Count is the number of items, that can be get with
29327 * elm_segment_control_item_count_get().
29329 * @ingroup SegmentControl
29331 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29334 * Get the base object of the item.
29336 * @param it The segment control item.
29337 * @return The base object associated with @p it.
29339 * Base object is the @c Evas_Object that represents that item.
29341 * @ingroup SegmentControl
29343 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29346 * Get the selected item.
29348 * @param obj The segment control object.
29349 * @return The selected item or @c NULL if none of segment items is
29352 * The selected item can be unselected with function
29353 * elm_segment_control_item_selected_set().
29355 * The selected item always will be highlighted on segment control.
29357 * @ingroup SegmentControl
29359 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29362 * Set the selected state of an item.
29364 * @param it The segment control item
29365 * @param select The selected state
29367 * This sets the selected state of the given item @p it.
29368 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
29370 * If a new item is selected the previosly selected will be unselected.
29371 * Previoulsy selected item can be get with function
29372 * elm_segment_control_item_selected_get().
29374 * The selected item always will be highlighted on segment control.
29376 * @see elm_segment_control_item_selected_get()
29378 * @ingroup SegmentControl
29380 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
29387 * @defgroup Grid Grid
29389 * The grid is a grid layout widget that lays out a series of children as a
29390 * fixed "grid" of widgets using a given percentage of the grid width and
29391 * height each using the child object.
29393 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
29394 * widgets size itself. The default is 100 x 100, so that means the
29395 * position and sizes of children will effectively be percentages (0 to 100)
29396 * of the width or height of the grid widget
29402 * Add a new grid to the parent
29404 * @param parent The parent object
29405 * @return The new object or NULL if it cannot be created
29409 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
29412 * Set the virtual size of the grid
29414 * @param obj The grid object
29415 * @param w The virtual width of the grid
29416 * @param h The virtual height of the grid
29420 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
29423 * Get the virtual size of the grid
29425 * @param obj The grid object
29426 * @param w Pointer to integer to store the virtual width of the grid
29427 * @param h Pointer to integer to store the virtual height of the grid
29431 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
29434 * Pack child at given position and size
29436 * @param obj The grid object
29437 * @param subobj The child to pack
29438 * @param x The virtual x coord at which to pack it
29439 * @param y The virtual y coord at which to pack it
29440 * @param w The virtual width at which to pack it
29441 * @param h The virtual height at which to pack it
29445 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
29448 * Unpack a child from a grid object
29450 * @param obj The grid object
29451 * @param subobj The child to unpack
29455 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
29458 * Faster way to remove all child objects from a grid object.
29460 * @param obj The grid object
29461 * @param clear If true, it will delete just removed children
29465 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
29468 * Set packing of an existing child at to position and size
29470 * @param subobj The child to set packing of
29471 * @param x The virtual x coord at which to pack it
29472 * @param y The virtual y coord at which to pack it
29473 * @param w The virtual width at which to pack it
29474 * @param h The virtual height at which to pack it
29478 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
29481 * get packing of a child
29483 * @param subobj The child to query
29484 * @param x Pointer to integer to store the virtual x coord
29485 * @param y Pointer to integer to store the virtual y coord
29486 * @param w Pointer to integer to store the virtual width
29487 * @param h Pointer to integer to store the virtual height
29491 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
29497 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
29498 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
29499 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
29500 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
29501 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
29502 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
29505 * @defgroup Video Video
29507 * @addtogroup Video
29510 * Elementary comes with two object that help design application that need
29511 * to display video. The main one, Elm_Video, display a video by using Emotion.
29512 * It does embedded the video inside an Edje object, so you can do some
29513 * animation depending on the video state change. It does also implement a
29514 * ressource management policy to remove this burden from the application writer.
29516 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
29517 * It take care of updating its content according to Emotion event and provide a
29518 * way to theme itself. It also does automatically raise the priority of the
29519 * linked Elm_Video so it will use the video decoder if available. It also does
29520 * activate the remember function on the linked Elm_Video object.
29522 * Signals that you can add callback for are :
29524 * "forward,clicked" - the user clicked the forward button.
29525 * "info,clicked" - the user clicked the info button.
29526 * "next,clicked" - the user clicked the next button.
29527 * "pause,clicked" - the user clicked the pause button.
29528 * "play,clicked" - the user clicked the play button.
29529 * "prev,clicked" - the user clicked the prev button.
29530 * "rewind,clicked" - the user clicked the rewind button.
29531 * "stop,clicked" - the user clicked the stop button.
29533 * Default contents parts of the player widget that you can use for are:
29534 * @li "video" - A video of the player
29539 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
29541 * @param parent The parent object
29542 * @return a new player widget handle or @c NULL, on errors.
29544 * This function inserts a new player widget on the canvas.
29546 * @see elm_object_part_content_set()
29550 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
29553 * @brief Link a Elm_Payer with an Elm_Video object.
29555 * @param player the Elm_Player object.
29556 * @param video The Elm_Video object.
29558 * This mean that action on the player widget will affect the
29559 * video object and the state of the video will be reflected in
29560 * the player itself.
29562 * @see elm_player_add()
29563 * @see elm_video_add()
29564 * @deprecated use elm_object_part_content_set() instead
29568 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
29571 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
29573 * @param parent The parent object
29574 * @return a new video widget handle or @c NULL, on errors.
29576 * This function inserts a new video widget on the canvas.
29578 * @seeelm_video_file_set()
29579 * @see elm_video_uri_set()
29583 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
29586 * @brief Define the file that will be the video source.
29588 * @param video The video object to define the file for.
29589 * @param filename The file to target.
29591 * This function will explicitly define a filename as a source
29592 * for the video of the Elm_Video object.
29594 * @see elm_video_uri_set()
29595 * @see elm_video_add()
29596 * @see elm_player_add()
29600 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
29603 * @brief Define the uri that will be the video source.
29605 * @param video The video object to define the file for.
29606 * @param uri The uri to target.
29608 * This function will define an uri as a source for the video of the
29609 * Elm_Video object. URI could be remote source of video, like http:// or local source
29610 * like for example WebCam who are most of the time v4l2:// (but that depend and
29611 * you should use Emotion API to request and list the available Webcam on your system).
29613 * @see elm_video_file_set()
29614 * @see elm_video_add()
29615 * @see elm_player_add()
29619 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
29622 * @brief Get the underlying Emotion object.
29624 * @param video The video object to proceed the request on.
29625 * @return the underlying Emotion object.
29629 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
29632 * @brief Start to play the video
29634 * @param video The video object to proceed the request on.
29636 * Start to play the video and cancel all suspend state.
29640 EAPI void elm_video_play(Evas_Object *video);
29643 * @brief Pause the video
29645 * @param video The video object to proceed the request on.
29647 * Pause the video and start a timer to trigger suspend mode.
29651 EAPI void elm_video_pause(Evas_Object *video);
29654 * @brief Stop the video
29656 * @param video The video object to proceed the request on.
29658 * Stop the video and put the emotion in deep sleep mode.
29662 EAPI void elm_video_stop(Evas_Object *video);
29665 * @brief Is the video actually playing.
29667 * @param video The video object to proceed the request on.
29668 * @return EINA_TRUE if the video is actually playing.
29670 * You should consider watching event on the object instead of polling
29671 * the object state.
29675 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
29678 * @brief Is it possible to seek inside the video.
29680 * @param video The video object to proceed the request on.
29681 * @return EINA_TRUE if is possible to seek inside the video.
29685 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
29688 * @brief Is the audio muted.
29690 * @param video The video object to proceed the request on.
29691 * @return EINA_TRUE if the audio is muted.
29695 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
29698 * @brief Change the mute state of the Elm_Video object.
29700 * @param video The video object to proceed the request on.
29701 * @param mute The new mute state.
29705 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
29708 * @brief Get the audio level of the current video.
29710 * @param video The video object to proceed the request on.
29711 * @return the current audio level.
29715 EAPI double elm_video_audio_level_get(const Evas_Object *video);
29718 * @brief Set the audio level of anElm_Video object.
29720 * @param video The video object to proceed the request on.
29721 * @param volume The new audio volume.
29725 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
29727 EAPI double elm_video_play_position_get(const Evas_Object *video);
29728 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
29729 EAPI double elm_video_play_length_get(const Evas_Object *video);
29730 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
29731 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
29732 EAPI const char *elm_video_title_get(const Evas_Object *video);
29738 * @defgroup Naviframe Naviframe
29739 * @ingroup Elementary
29741 * @brief Naviframe is a kind of view manager for the applications.
29743 * Naviframe provides functions to switch different pages with stack
29744 * mechanism. It means if one page(item) needs to be changed to the new one,
29745 * then naviframe would push the new page to it's internal stack. Of course,
29746 * it can be back to the previous page by popping the top page. Naviframe
29747 * provides some transition effect while the pages are switching (same as
29750 * Since each item could keep the different styles, users could keep the
29751 * same look & feel for the pages or different styles for the items in it's
29754 * Signals that you can add callback for are:
29755 * @li "transition,finished" - When the transition is finished in changing
29757 * @li "title,clicked" - User clicked title area
29759 * Default contents parts of the naviframe items that you can use for are:
29760 * @li "default" - A main content of the page
29761 * @li "icon" - An icon in the title area
29762 * @li "prev_btn" - A button to go to the previous page
29763 * @li "next_btn" - A button to go to the next page
29765 * Default text parts of the naviframe items that you can use for are:
29766 * @li "default" - Title label in the title area
29767 * @li "subtitle" - Sub-title label in the title area
29769 * Supported elm_object common APIs.
29770 * @li elm_object_signal_emit
29772 * Supported elm_object_item common APIs.
29773 * @li elm_object_item_text_set
29774 * @li elm_object_item_part_text_set
29775 * @li elm_object_item_text_get
29776 * @li elm_object_item_part_text_get
29777 * @li elm_object_item_content_set
29778 * @li elm_object_item_part_content_set
29779 * @li elm_object_item_content_get
29780 * @li elm_object_item_part_content_get
29781 * @li elm_object_item_content_unset
29782 * @li elm_object_item_part_content_unset
29783 * @li elm_object_item_signal_emit
29785 * @ref tutorial_naviframe gives a good overview of the usage of the API.
29789 * @addtogroup Naviframe
29794 * @brief Add a new Naviframe object to the parent.
29796 * @param parent Parent object
29797 * @return New object or @c NULL, if it cannot be created
29799 * @ingroup Naviframe
29801 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29804 * @brief Push a new item to the top of the naviframe stack (and show it).
29806 * @param obj The naviframe object
29807 * @param title_label The label in the title area. The name of the title
29808 * label part is "elm.text.title"
29809 * @param prev_btn The button to go to the previous item. If it is NULL,
29810 * then naviframe will create a back button automatically. The name of
29811 * the prev_btn part is "elm.swallow.prev_btn"
29812 * @param next_btn The button to go to the next item. Or It could be just an
29813 * extra function button. The name of the next_btn part is
29814 * "elm.swallow.next_btn"
29815 * @param content The main content object. The name of content part is
29816 * "elm.swallow.content"
29817 * @param item_style The current item style name. @c NULL would be default.
29818 * @return The created item or @c NULL upon failure.
29820 * The item pushed becomes one page of the naviframe, this item will be
29821 * deleted when it is popped.
29823 * @see also elm_naviframe_item_style_set()
29824 * @see also elm_naviframe_item_insert_before()
29825 * @see also elm_naviframe_item_insert_after()
29827 * The following styles are available for this item:
29830 * @ingroup Naviframe
29832 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);
29835 * @brief Insert a new item into the naviframe before item @p before.
29837 * @param before The naviframe item to insert before.
29838 * @param title_label The label in the title area. The name of the title
29839 * label part is "elm.text.title"
29840 * @param prev_btn The button to go to the previous item. If it is NULL,
29841 * then naviframe will create a back button automatically. The name of
29842 * the prev_btn part is "elm.swallow.prev_btn"
29843 * @param next_btn The button to go to the next item. Or It could be just an
29844 * extra function button. The name of the next_btn part is
29845 * "elm.swallow.next_btn"
29846 * @param content The main content object. The name of content part is
29847 * "elm.swallow.content"
29848 * @param item_style The current item style name. @c NULL would be default.
29849 * @return The created item or @c NULL upon failure.
29851 * The item is inserted into the naviframe straight away without any
29852 * transition operations. This item will be deleted when it is popped.
29854 * @see also elm_naviframe_item_style_set()
29855 * @see also elm_naviframe_item_push()
29856 * @see also elm_naviframe_item_insert_after()
29858 * The following styles are available for this item:
29861 * @ingroup Naviframe
29863 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);
29866 * @brief Insert a new item into the naviframe after item @p after.
29868 * @param after The naviframe item to insert after.
29869 * @param title_label The label in the title area. The name of the title
29870 * label part is "elm.text.title"
29871 * @param prev_btn The button to go to the previous item. If it is NULL,
29872 * then naviframe will create a back button automatically. The name of
29873 * the prev_btn part is "elm.swallow.prev_btn"
29874 * @param next_btn The button to go to the next item. Or It could be just an
29875 * extra function button. The name of the next_btn part is
29876 * "elm.swallow.next_btn"
29877 * @param content The main content object. The name of content part is
29878 * "elm.swallow.content"
29879 * @param item_style The current item style name. @c NULL would be default.
29880 * @return The created item or @c NULL upon failure.
29882 * The item is inserted into the naviframe straight away without any
29883 * transition operations. This item will be deleted when it is popped.
29885 * @see also elm_naviframe_item_style_set()
29886 * @see also elm_naviframe_item_push()
29887 * @see also elm_naviframe_item_insert_before()
29889 * The following styles are available for this item:
29892 * @ingroup Naviframe
29894 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);
29897 * @brief Pop an item that is on top of the stack
29899 * @param obj The naviframe object
29900 * @return @c NULL or the content object(if the
29901 * elm_naviframe_content_preserve_on_pop_get is true).
29903 * This pops an item that is on the top(visible) of the naviframe, makes it
29904 * disappear, then deletes the item. The item that was underneath it on the
29905 * stack will become visible.
29907 * @see also elm_naviframe_content_preserve_on_pop_get()
29909 * @ingroup Naviframe
29911 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29914 * @brief Pop the items between the top and the above one on the given item.
29916 * @param it The naviframe item
29918 * @ingroup Naviframe
29920 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29923 * Promote an item already in the naviframe stack to the top of the stack
29925 * @param it The naviframe item
29927 * This will take the indicated item and promote it to the top of the stack
29928 * as if it had been pushed there. The item must already be inside the
29929 * naviframe stack to work.
29932 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29935 * @brief Delete the given item instantly.
29937 * @param it The naviframe item
29939 * This just deletes the given item from the naviframe item list instantly.
29940 * So this would not emit any signals for view transitions but just change
29941 * the current view if the given item is a top one.
29943 * @ingroup Naviframe
29945 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29948 * @brief preserve the content objects when items are popped.
29950 * @param obj The naviframe object
29951 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29953 * @see also elm_naviframe_content_preserve_on_pop_get()
29955 * @ingroup Naviframe
29957 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29960 * @brief Get a value whether preserve mode is enabled or not.
29962 * @param obj The naviframe object
29963 * @return If @c EINA_TRUE, preserve mode is enabled
29965 * @see also elm_naviframe_content_preserve_on_pop_set()
29967 * @ingroup Naviframe
29969 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29972 * @brief Get a top item on the naviframe stack
29974 * @param obj The naviframe object
29975 * @return The top item on the naviframe stack or @c NULL, if the stack is
29978 * @ingroup Naviframe
29980 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29983 * @brief Get a bottom item on the naviframe stack
29985 * @param obj The naviframe object
29986 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29989 * @ingroup Naviframe
29991 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29994 * @brief Set an item style
29996 * @param obj The naviframe item
29997 * @param item_style The current item style name. @c NULL would be default
29999 * The following styles are available for this item:
30002 * @see also elm_naviframe_item_style_get()
30004 * @ingroup Naviframe
30006 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
30009 * @brief Get an item style
30011 * @param obj The naviframe item
30012 * @return The current item style name
30014 * @see also elm_naviframe_item_style_set()
30016 * @ingroup Naviframe
30018 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30021 * @brief Show/Hide the title area
30023 * @param it The naviframe item
30024 * @param visible If @c EINA_TRUE, title area will be visible, hidden
30027 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
30029 * @see also elm_naviframe_item_title_visible_get()
30031 * @ingroup Naviframe
30033 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
30036 * @brief Get a value whether title area is visible or not.
30038 * @param it The naviframe item
30039 * @return If @c EINA_TRUE, title area is visible
30041 * @see also elm_naviframe_item_title_visible_set()
30043 * @ingroup Naviframe
30045 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30048 * @brief Set creating prev button automatically or not
30050 * @param obj The naviframe object
30051 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
30052 * be created internally when you pass the @c NULL to the prev_btn
30053 * parameter in elm_naviframe_item_push
30055 * @see also elm_naviframe_item_push()
30057 * @ingroup Naviframe
30059 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
30062 * @brief Get a value whether prev button(back button) will be auto pushed or
30065 * @param obj The naviframe object
30066 * @return If @c EINA_TRUE, prev button will be auto pushed.
30068 * @see also elm_naviframe_item_push()
30069 * elm_naviframe_prev_btn_auto_pushed_set()
30071 * @ingroup Naviframe
30073 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30076 * @brief Get a list of all the naviframe items.
30078 * @param obj The naviframe object
30079 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
30080 * or @c NULL on failure.
30082 * @ingroup Naviframe
30084 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30087 * @brief Set the event enabled when pushing/popping items
30089 * If @c enabled is EINA_TRUE, the contents of the naviframe item will
30090 * receives events from mouse and keyboard during view changing such as
30093 * @param obj The naviframe object
30094 * @param enabled Events are received when enabled is @c EINA_TRUE, and
30095 * ignored otherwise.
30097 * @warning Events will be blocked by calling evas_object_freeze_events_set()
30098 * internally. So don't call the API whiling pushing/popping items.
30100 * @see elm_naviframe_event_enabled_get()
30101 * @see evas_object_freeze_events_set()
30103 * @ingroup Naviframe
30105 EAPI void elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
30108 * @brief Get the value of event enabled status.
30110 * @param obj The naviframe object
30111 * @return EINA_TRUE, when event is enabled
30113 * @see elm_naviframe_event_enabled_set()
30115 * @ingroup Naviframe
30117 EAPI Eina_Bool elm_naviframe_event_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30124 * @defgroup Multibuttonentry Multibuttonentry
30126 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
30127 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
30128 * a new button is added to the next row. When a text button is pressed, it will become focused.
30129 * Backspace removes the focus.
30130 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
30132 * Smart callbacks one can register:
30133 * - @c "item,selected" - when item is selected. May be called on backspace key.
30134 * - @c "item,added" - when a new multibuttonentry item is added.
30135 * - @c "item,deleted" - when a multibuttonentry item is deleted.
30136 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
30137 * - @c "clicked" - when multibuttonentry is clicked.
30138 * - @c "focused" - when multibuttonentry is focused.
30139 * - @c "unfocused" - when multibuttonentry is unfocused.
30140 * - @c "expanded" - when multibuttonentry is expanded.
30141 * - @c "shrank" - when multibuttonentry is shrank.
30142 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
30144 * Here is an example on its usage:
30145 * @li @ref multibuttonentry_example
30149 * @addtogroup Multibuttonentry
30153 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30154 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30157 * @brief Add a new multibuttonentry to the parent
30159 * @param parent The parent object
30160 * @return The new object or NULL if it cannot be created
30163 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30168 * @param obj The multibuttonentry object
30169 * @return The label, or NULL if none
30172 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30177 * @param obj The multibuttonentry object
30178 * @param label The text label string
30181 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
30184 * Get the entry of the multibuttonentry object
30186 * @param obj The multibuttonentry object
30187 * @return The entry object, or NULL if none
30190 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30193 * Get the guide text
30195 * @param obj The multibuttonentry object
30196 * @return The guide text, or NULL if none
30199 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30202 * Set the guide text
30204 * @param obj The multibuttonentry object
30205 * @param label The guide text string
30208 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
30211 * Get the value of shrink_mode state.
30213 * @param obj The multibuttonentry object
30214 * @param the value of shrink mode state.
30217 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30220 * Set/Unset the multibuttonentry to shrink mode state of single line
30222 * @param obj The multibuttonentry object
30223 * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state.
30226 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
30229 * Prepend a new item to the multibuttonentry
30231 * @param obj The multibuttonentry object
30232 * @param label The label of new item
30233 * @param data The ponter to the data to be attached
30234 * @return A handle to the item added or NULL if not possible
30237 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30240 * Append a new item to the multibuttonentry
30242 * @param obj The multibuttonentry object
30243 * @param label The label of new item
30244 * @param data The ponter to the data to be attached
30245 * @return A handle to the item added or NULL if not possible
30248 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30251 * Add a new item to the multibuttonentry before the indicated object
30254 * @param obj The multibuttonentry object
30255 * @param before The item before which to add it
30256 * @param label The label of new item
30257 * @param data The ponter to the data to be attached
30258 * @return A handle to the item added or NULL if not possible
30261 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_before(Evas_Object *obj, Elm_Multibuttonentry_Item *before, const char *label, void *data) EINA_ARG_NONNULL(1);
30264 * Add a new item to the multibuttonentry after the indicated object
30266 * @param obj The multibuttonentry object
30267 * @param after The item after which to add it
30268 * @param label The label of new item
30269 * @param data The ponter to the data to be attached
30270 * @return A handle to the item added or NULL if not possible
30273 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_after(Evas_Object *obj, Elm_Multibuttonentry_Item *after, const char *label, void *data) EINA_ARG_NONNULL(1);
30276 * Get a list of items in the multibuttonentry
30278 * @param obj The multibuttonentry object
30279 * @return The list of items, or NULL if none
30282 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30285 * Get the first item in the multibuttonentry
30287 * @param obj The multibuttonentry object
30288 * @return The first item, or NULL if none
30291 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30294 * Get the last item in the multibuttonentry
30296 * @param obj The multibuttonentry object
30297 * @return The last item, or NULL if none
30300 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30303 * Get the selected item in the multibuttonentry
30305 * @param obj The multibuttonentry object
30306 * @return The selected item, or NULL if none
30309 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30312 * Set the selected state of an item
30314 * @param item The item
30315 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30318 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
30321 * unselect all items.
30323 * @param obj The multibuttonentry object
30326 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
30329 * Delete a given item
30331 * @param item The item
30334 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30337 * Remove all items in the multibuttonentry.
30339 * @param obj The multibuttonentry object
30342 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
30345 * Get the label of a given item
30347 * @param item The item
30348 * @return The label of a given item, or NULL if none
30351 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30354 * Set the label of a given item
30356 * @param item The item
30357 * @param label The text label string
30360 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
30363 * Get the previous item in the multibuttonentry
30365 * @param item The item
30366 * @return The item before the item @p item
30369 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30372 * Get the next item in the multibuttonentry
30374 * @param item The item
30375 * @return The item after the item @p item
30378 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30381 * Append a item filter function for text inserted in the Multibuttonentry
30383 * Append the given callback to the list. This functions will be called
30384 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
30385 * as a parameter. The callback function is free to alter the text in any way
30386 * it wants, but it must remember to free the given pointer and update it.
30387 * If the new text is to be discarded, the function can free it and set it text
30388 * parameter to NULL. This will also prevent any following filters from being
30391 * @param obj The multibuttonentryentry object
30392 * @param func The function to use as item filter
30393 * @param data User data to pass to @p func
30396 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30399 * Prepend a filter function for text inserted in the Multibuttentry
30401 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
30402 * for more information
30404 * @param obj The multibuttonentry object
30405 * @param func The function to use as text filter
30406 * @param data User data to pass to @p func
30409 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30412 * Remove a filter from the list
30414 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
30415 * for more information.
30417 * @param obj The multibuttonentry object
30418 * @param func The filter function to remove
30419 * @param data The user data passed when adding the function
30422 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30429 * @addtogroup CopyPaste
30433 typedef struct _Elm_Selection_Data Elm_Selection_Data;
30434 typedef Eina_Bool (*Elm_Drop_Cb) (void *d, Evas_Object *o, Elm_Selection_Data *data);
30436 typedef enum _Elm_Sel_Type
30438 ELM_SEL_TYPE_PRIMARY,
30439 ELM_SEL_TYPE_SECONDARY,
30440 ELM_SEL_TYPE_CLIPBOARD,
30446 typedef enum _Elm_Sel_Format
30448 /** Targets: for matching every atom requesting */
30449 ELM_SEL_FORMAT_TARGETS = -1,
30450 /** they come from outside of elm */
30451 ELM_SEL_FORMAT_NONE = 0x0,
30452 /** Plain unformated text: Used for things that don't want rich markup */
30453 ELM_SEL_FORMAT_TEXT = 0x01,
30454 /** Edje textblock markup, including inline images */
30455 ELM_SEL_FORMAT_MARKUP = 0x02,
30457 ELM_SEL_FORMAT_IMAGE = 0x04,
30459 ELM_SEL_FORMAT_VCARD = 0x08,
30460 /** Raw HTMLish things for widgets that want that stuff (hello webkit!) */
30461 ELM_SEL_FORMAT_HTML = 0x10,
30466 struct _Elm_Selection_Data
30469 Elm_Sel_Format format;
30475 * @brief Set a data of a widget to copy and paste.
30477 * Append the given callback to the list. This functions will be called
30480 * @param selection selection type for copying and pasting
30481 * @param widget The source widget pointer
30482 * @param format Type of selection format
30483 * @param buf The pointer of data source
30484 * @return If EINA_TRUE, setting data is success.
30486 * @ingroup CopyPaste
30490 EAPI Eina_Bool elm_cnp_selection_set(Elm_Sel_Type selection, Evas_Object *widget, Elm_Sel_Format format, const void *buf, size_t buflen);
30493 * @brief Retrive the data from the widget which is set for copying and pasting.
30495 * Getting the data from the widget which is set for copying and pasting.
30496 * Mainly the widget is elm_entry. If then @p datacb and @p udata are
30497 * can be NULL. If not, @p datacb and @p udata are used for retriving data.
30499 * @see also elm_cnp_selection_set()
30501 * @param selection selection type for copying and pasting
30502 * @param widget The source widget pointer
30503 * @param datacb The user data callback if the target widget isn't elm_entry
30504 * @param udata The user data pointer for @p datacb
30505 * @return If EINA_TRUE, getting data is success.
30507 * @ingroup CopyPaste
30511 EAPI Eina_Bool elm_cnp_selection_get(Elm_Sel_Type selection, Elm_Sel_Format format, Evas_Object *widget, Elm_Drop_Cb datacb, void *udata);
30514 * @brief Clear the data in the widget which is set for copying and pasting.
30516 * Clear the data in the widget. Normally this function isn't need to call.
30518 * @see also elm_cnp_selection_set()
30520 * @param selection selection type for copying and pasting
30521 * @param widget The source widget pointer
30522 * @return If EINA_TRUE, clearing data is success.
30524 * @ingroup CopyPaste
30528 EAPI Eina_Bool elm_cnp_selection_clear(Elm_Sel_Type selection, Evas_Object *widget);