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
372 // disabled - evas 1.1 won't have this.
373 //#include <Evas_GL.h>
375 #include <Ecore_Evas.h>
376 #include <Ecore_File.h>
377 @ELEMENTARY_ECORE_IMF_INC@
378 @ELEMENTARY_ECORE_CON_INC@
387 # include <Efreet_Mime.h>
388 # include <Efreet_Trash.h>
392 # include <Ethumb_Client.h>
404 # ifdef ELEMENTARY_BUILD
406 # define EAPI __declspec(dllexport)
409 # endif /* ! DLL_EXPORT */
411 # define EAPI __declspec(dllimport)
412 # endif /* ! EFL_EVAS_BUILD */
416 # define EAPI __attribute__ ((visibility("default")))
423 #endif /* ! _WIN32 */
428 # define EAPI_MAIN EAPI
431 /* allow usage from c++ */
436 #define ELM_VERSION_MAJOR @VMAJ@
437 #define ELM_VERSION_MINOR @VMIN@
439 typedef struct _Elm_Version
447 EAPI extern Elm_Version *elm_version;
450 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
451 #define ELM_PI 3.14159265358979323846
454 * @defgroup General General
456 * @brief General Elementary API. Functions that don't relate to
457 * Elementary objects specifically.
459 * Here are documented functions which init/shutdown the library,
460 * that apply to generic Elementary objects, that deal with
461 * configuration, et cetera.
463 * @ref general_functions_example_page "This" example contemplates
464 * some of these functions.
468 * @addtogroup General
473 * Defines couple of standard Evas_Object layers to be used
474 * with evas_object_layer_set().
476 * @note whenever extending with new values, try to keep some padding
477 * to siblings so there is room for further extensions.
479 typedef enum _Elm_Object_Layer
481 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
482 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
483 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
484 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
485 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
486 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
489 /**************************************************************************/
490 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
493 * Emitted when the application has reconfigured elementary settings due
494 * to an external configuration tool asking it to.
496 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
499 * Emitted when any Elementary's policy value is changed.
501 EAPI extern int ELM_EVENT_POLICY_CHANGED;
504 * @typedef Elm_Event_Policy_Changed
506 * Data on the event when an Elementary policy has changed
508 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
511 * @struct _Elm_Event_Policy_Changed
513 * Data on the event when an Elementary policy has changed
515 struct _Elm_Event_Policy_Changed
517 unsigned int policy; /**< the policy identifier */
518 int new_value; /**< value the policy had before the change */
519 int old_value; /**< new value the policy got */
523 * Policy identifiers.
525 typedef enum _Elm_Policy
527 ELM_POLICY_QUIT, /**< under which circumstances the application
528 * should quit automatically. @see
532 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
535 typedef enum _Elm_Policy_Quit
537 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
539 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
541 * window is closed */
542 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
544 typedef enum _Elm_Focus_Direction
548 } Elm_Focus_Direction;
550 typedef enum _Elm_Text_Format
552 ELM_TEXT_FORMAT_PLAIN_UTF8,
553 ELM_TEXT_FORMAT_MARKUP_UTF8
557 * Line wrapping types.
559 typedef enum _Elm_Wrap_Type
561 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
562 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
563 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
564 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
570 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
571 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
572 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
573 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
574 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
575 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
576 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
577 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
578 ELM_INPUT_PANEL_LAYOUT_INVALID
579 } Elm_Input_Panel_Layout;
583 ELM_AUTOCAPITAL_TYPE_NONE,
584 ELM_AUTOCAPITAL_TYPE_WORD,
585 ELM_AUTOCAPITAL_TYPE_SENTENCE,
586 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
587 } Elm_Autocapital_Type;
590 * @typedef Elm_Object_Item
591 * An Elementary Object item handle.
594 typedef struct _Elm_Object_Item Elm_Object_Item;
598 * Called back when a widget's tooltip is activated and needs content.
599 * @param data user-data given to elm_object_tooltip_content_cb_set()
600 * @param obj owner widget.
601 * @param tooltip The tooltip object (affix content to this!)
603 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
606 * Called back when a widget's item tooltip is activated and needs content.
607 * @param data user-data given to elm_object_tooltip_content_cb_set()
608 * @param obj owner widget.
609 * @param tooltip The tooltip object (affix content to this!)
610 * @param item context dependent item. As an example, if tooltip was
611 * set on Elm_List_Item, then it is of this type.
613 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
615 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. */
617 #ifndef ELM_LIB_QUICKLAUNCH
618 #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 */
620 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
623 /**************************************************************************/
627 * Initialize Elementary
629 * @param[in] argc System's argument count value
630 * @param[in] argv System's pointer to array of argument strings
631 * @return The init counter value.
633 * This function initializes Elementary and increments a counter of
634 * the number of calls to it. It returns the new counter's value.
636 * @warning This call is exported only for use by the @c ELM_MAIN()
637 * macro. There is no need to use this if you use this macro (which
638 * is highly advisable). An elm_main() should contain the entry
639 * point code for your application, having the same prototype as
640 * elm_init(), and @b not being static (putting the @c EAPI symbol
641 * in front of its type declaration is advisable). The @c
642 * ELM_MAIN() call should be placed just after it.
645 * @dontinclude bg_example_01.c
649 * See the full @ref bg_example_01_c "example".
651 * @see elm_shutdown().
654 EAPI int elm_init(int argc, char **argv);
657 * Shut down Elementary
659 * @return The init counter value.
661 * This should be called at the end of your application, just
662 * before it ceases to do any more processing. This will clean up
663 * any permanent resources your application may have allocated via
664 * Elementary that would otherwise persist.
666 * @see elm_init() for an example
670 EAPI int elm_shutdown(void);
673 * Run Elementary's main loop
675 * This call should be issued just after all initialization is
676 * completed. This function will not return until elm_exit() is
677 * called. It will keep looping, running the main
678 * (event/processing) loop for Elementary.
680 * @see elm_init() for an example
684 EAPI void elm_run(void);
687 * Exit Elementary's main loop
689 * If this call is issued, it will flag the main loop to cease
690 * processing and return back to its parent function (usually your
691 * elm_main() function).
693 * @see elm_init() for an example. There, just after a request to
694 * close the window comes, the main loop will be left.
696 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
697 * applications, you'll be able to get this function called automatically for you.
701 EAPI void elm_exit(void);
704 * Provide information in order to make Elementary determine the @b
705 * run time location of the software in question, so other data files
706 * such as images, sound files, executable utilities, libraries,
707 * modules and locale files can be found.
709 * @param mainfunc This is your application's main function name,
710 * whose binary's location is to be found. Providing @c NULL
711 * will make Elementary not to use it
712 * @param dom This will be used as the application's "domain", in the
713 * form of a prefix to any environment variables that may
714 * override prefix detection and the directory name, inside the
715 * standard share or data directories, where the software's
716 * data files will be looked for.
717 * @param checkfile This is an (optional) magic file's path to check
718 * for existence (and it must be located in the data directory,
719 * under the share directory provided above). Its presence will
720 * help determine the prefix found was correct. Pass @c NULL if
721 * the check is not to be done.
723 * This function allows one to re-locate the application somewhere
724 * else after compilation, if the developer wishes for easier
725 * distribution of pre-compiled binaries.
727 * The prefix system is designed to locate where the given software is
728 * installed (under a common path prefix) at run time and then report
729 * specific locations of this prefix and common directories inside
730 * this prefix like the binary, library, data and locale directories,
731 * through the @c elm_app_*_get() family of functions.
733 * Call elm_app_info_set() early on before you change working
734 * directory or anything about @c argv[0], so it gets accurate
737 * It will then try and trace back which file @p mainfunc comes from,
738 * if provided, to determine the application's prefix directory.
740 * The @p dom parameter provides a string prefix to prepend before
741 * environment variables, allowing a fallback to @b specific
742 * environment variables to locate the software. You would most
743 * probably provide a lowercase string there, because it will also
744 * serve as directory domain, explained next. For environment
745 * variables purposes, this string is made uppercase. For example if
746 * @c "myapp" is provided as the prefix, then the program would expect
747 * @c "MYAPP_PREFIX" as a master environment variable to specify the
748 * exact install prefix for the software, or more specific environment
749 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
750 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
751 * the user or scripts before launching. If not provided (@c NULL),
752 * environment variables will not be used to override compiled-in
753 * defaults or auto detections.
755 * The @p dom string also provides a subdirectory inside the system
756 * shared data directory for data files. For example, if the system
757 * directory is @c /usr/local/share, then this directory name is
758 * appended, creating @c /usr/local/share/myapp, if it @p was @c
759 * "myapp". It is expected that the application installs data files in
762 * The @p checkfile is a file name or path of something inside the
763 * share or data directory to be used to test that the prefix
764 * detection worked. For example, your app will install a wallpaper
765 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
766 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
769 * @see elm_app_compile_bin_dir_set()
770 * @see elm_app_compile_lib_dir_set()
771 * @see elm_app_compile_data_dir_set()
772 * @see elm_app_compile_locale_set()
773 * @see elm_app_prefix_dir_get()
774 * @see elm_app_bin_dir_get()
775 * @see elm_app_lib_dir_get()
776 * @see elm_app_data_dir_get()
777 * @see elm_app_locale_dir_get()
779 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
782 * Provide information on the @b fallback application's binaries
783 * directory, in scenarios where they get overriden by
784 * elm_app_info_set().
786 * @param dir The path to the default binaries directory (compile time
789 * @note Elementary will as well use this path to determine actual
790 * names of binaries' directory paths, maybe changing it to be @c
791 * something/local/bin instead of @c something/bin, only, for
794 * @warning You should call this function @b before
795 * elm_app_info_set().
797 EAPI void elm_app_compile_bin_dir_set(const char *dir);
800 * Provide information on the @b fallback application's libraries
801 * directory, on scenarios where they get overriden by
802 * elm_app_info_set().
804 * @param dir The path to the default libraries directory (compile
807 * @note Elementary will as well use this path to determine actual
808 * names of libraries' directory paths, maybe changing it to be @c
809 * something/lib32 or @c something/lib64 instead of @c something/lib,
812 * @warning You should call this function @b before
813 * elm_app_info_set().
815 EAPI void elm_app_compile_lib_dir_set(const char *dir);
818 * Provide information on the @b fallback application's data
819 * directory, on scenarios where they get overriden by
820 * elm_app_info_set().
822 * @param dir The path to the default data directory (compile time
825 * @note Elementary will as well use this path to determine actual
826 * names of data directory paths, maybe changing it to be @c
827 * something/local/share instead of @c something/share, only, for
830 * @warning You should call this function @b before
831 * elm_app_info_set().
833 EAPI void elm_app_compile_data_dir_set(const char *dir);
836 * Provide information on the @b fallback application's locale
837 * directory, on scenarios where they get overriden by
838 * elm_app_info_set().
840 * @param dir The path to the default locale directory (compile time
843 * @warning You should call this function @b before
844 * elm_app_info_set().
846 EAPI void elm_app_compile_locale_set(const char *dir);
849 * Retrieve the application's run time prefix directory, as set by
850 * elm_app_info_set() and the way (environment) the application was
853 * @return The directory prefix the application is actually using.
855 EAPI const char *elm_app_prefix_dir_get(void);
858 * Retrieve the application's run time binaries prefix directory, as
859 * set by elm_app_info_set() and the way (environment) the application
862 * @return The binaries directory prefix the application is actually
865 EAPI const char *elm_app_bin_dir_get(void);
868 * Retrieve the application's run time libraries prefix directory, as
869 * set by elm_app_info_set() and the way (environment) the application
872 * @return The libraries directory prefix the application is actually
875 EAPI const char *elm_app_lib_dir_get(void);
878 * Retrieve the application's run time data prefix directory, as
879 * set by elm_app_info_set() and the way (environment) the application
882 * @return The data directory prefix the application is actually
885 EAPI const char *elm_app_data_dir_get(void);
888 * Retrieve the application's run time locale prefix directory, as
889 * set by elm_app_info_set() and the way (environment) the application
892 * @return The locale directory prefix the application is actually
895 EAPI const char *elm_app_locale_dir_get(void);
898 * Exposed symbol used only by macros and should not be used by apps
900 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
903 * Exposed symbol used only by macros and should not be used by apps
905 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
908 * Exposed symbol used only by macros and should not be used by apps
910 EAPI int elm_quicklaunch_init(int argc, char **argv);
913 * Exposed symbol used only by macros and should not be used by apps
915 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
918 * Exposed symbol used only by macros and should not be used by apps
920 EAPI int elm_quicklaunch_sub_shutdown(void);
923 * Exposed symbol used only by macros and should not be used by apps
925 EAPI int elm_quicklaunch_shutdown(void);
928 * Exposed symbol used only by macros and should not be used by apps
930 EAPI void elm_quicklaunch_seed(void);
933 * Exposed symbol used only by macros and should not be used by apps
935 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
938 * Exposed symbol used only by macros and should not be used by apps
940 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
943 * Exposed symbol used only by macros and should not be used by apps
945 EAPI void elm_quicklaunch_cleanup(void);
948 * Exposed symbol used only by macros and should not be used by apps
950 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
953 * Exposed symbol used only by macros and should not be used by apps
955 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
958 * Request that your elementary application needs efreet
960 * This initializes the Efreet library when called and if support exists
961 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
962 * before any efreet calls.
964 * @return EINA_TRUE if support exists and initialization succeeded.
968 EAPI Eina_Bool elm_need_efreet(void);
971 * Request that your elementary application needs e_dbus
973 * This initializes the E_dbus library when called and if support exists
974 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
975 * before any e_dbus calls.
977 * @return EINA_TRUE if support exists and initialization succeeded.
981 EAPI Eina_Bool elm_need_e_dbus(void);
984 * Request that your elementary application needs ethumb
986 * This initializes the Ethumb library when called and if support exists
987 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
988 * This must be called before any other function that deals with
989 * elm_thumb objects or ethumb_client instances.
993 EAPI Eina_Bool elm_need_ethumb(void);
996 * Request that your elementary application needs web support
998 * This initializes the Ewebkit library when called and if support exists
999 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
1000 * This must be called before any other function that deals with
1001 * elm_web objects or ewk_view instances.
1005 EAPI Eina_Bool elm_need_web(void);
1008 * Set a new policy's value (for a given policy group/identifier).
1010 * @param policy policy identifier, as in @ref Elm_Policy.
1011 * @param value policy value, which depends on the identifier
1013 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1015 * Elementary policies define applications' behavior,
1016 * somehow. These behaviors are divided in policy groups (see
1017 * #Elm_Policy enumeration). This call will emit the Ecore event
1018 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1019 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1022 * @note Currently, we have only one policy identifier/group
1023 * (#ELM_POLICY_QUIT), which has two possible values.
1027 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
1030 * Gets the policy value for given policy identifier.
1032 * @param policy policy identifier, as in #Elm_Policy.
1033 * @return The currently set policy value, for that
1034 * identifier. Will be @c 0 if @p policy passed is invalid.
1038 EAPI int elm_policy_get(unsigned int policy);
1041 * Change the language of the current application
1043 * The @p lang passed must be the full name of the locale to use, for
1044 * example "en_US.utf8" or "es_ES@euro".
1046 * Changing language with this function will make Elementary run through
1047 * all its widgets, translating strings set with
1048 * elm_object_domain_translatable_text_part_set(). This way, an entire
1049 * UI can have its language changed without having to restart the program.
1051 * For more complex cases, like having formatted strings that need
1052 * translation, widgets will also emit a "language,changed" signal that
1053 * the user can listen to to manually translate the text.
1055 * @param lang Language to set, must be the full name of the locale
1059 EAPI void elm_language_set(const char *lang);
1062 * Set a label of an object
1064 * @param obj The Elementary object
1065 * @param part The text part name to set (NULL for the default label)
1066 * @param label The new text of the label
1068 * @note Elementary objects may have many labels (e.g. Action Slider)
1069 * @deprecated Use elm_object_part_text_set() instead.
1072 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1075 * Set a label of an object
1077 * @param obj The Elementary object
1078 * @param part The text part name to set (NULL for the default label)
1079 * @param label The new text of the label
1081 * @note Elementary objects may have many labels (e.g. Action Slider)
1085 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1087 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1090 * Get a label of an object
1092 * @param obj The Elementary object
1093 * @param part The text part name to get (NULL for the default label)
1094 * @return text of the label or NULL for any error
1096 * @note Elementary objects may have many labels (e.g. Action Slider)
1097 * @deprecated Use elm_object_part_text_get() instead.
1100 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1103 * Get a label of an object
1105 * @param obj The Elementary object
1106 * @param part The text part name to get (NULL for the default label)
1107 * @return text of the label or NULL for any error
1109 * @note Elementary objects may have many labels (e.g. Action Slider)
1113 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1115 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1118 * Set the text for an objects' part, marking it as translatable.
1120 * The string to set as @p text must be the original one. Do not pass the
1121 * return of @c gettext() here. Elementary will translate the string
1122 * internally and set it on the object using elm_object_part_text_set(),
1123 * also storing the original string so that it can be automatically
1124 * translated when the language is changed with elm_language_set().
1126 * The @p domain will be stored along to find the translation in the
1127 * correct catalog. It can be NULL, in which case it will use whatever
1128 * domain was set by the application with @c textdomain(). This is useful
1129 * in case you are building a library on top of Elementary that will have
1130 * its own translatable strings, that should not be mixed with those of
1131 * programs using the library.
1133 * @param obj The object containing the text part
1134 * @param part The name of the part to set
1135 * @param domain The translation domain to use
1136 * @param text The original, non-translated text to set
1140 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1142 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1144 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1147 * Gets the original string set as translatable for an object
1149 * When setting translated strings, the function elm_object_part_text_get()
1150 * will return the translation returned by @c gettext(). To get the
1151 * original string use this function.
1153 * @param obj The object
1154 * @param part The name of the part that was set
1156 * @return The original, untranslated string
1160 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1162 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1165 * Set a content of an object
1167 * @param obj The Elementary object
1168 * @param part The content part name to set (NULL for the default content)
1169 * @param content The new content of the object
1171 * @note Elementary objects may have many contents
1172 * @deprecated Use elm_object_part_content_set instead.
1175 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1178 * Set a content of an object
1180 * @param obj The Elementary object
1181 * @param part The content part name to set (NULL for the default content)
1182 * @param content The new content of the object
1184 * @note Elementary objects may have many contents
1188 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1190 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1193 * Get a content of an object
1195 * @param obj The Elementary object
1196 * @param item The content part name to get (NULL for the default content)
1197 * @return content of the object or NULL for any error
1199 * @note Elementary objects may have many contents
1200 * @deprecated Use elm_object_part_content_get instead.
1203 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1206 * Get a content of an object
1208 * @param obj The Elementary object
1209 * @param item The content part name to get (NULL for the default content)
1210 * @return content of the object or NULL for any error
1212 * @note Elementary objects may have many contents
1216 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1218 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1221 * Unset a content of an object
1223 * @param obj The Elementary object
1224 * @param item The content part name to unset (NULL for the default content)
1226 * @note Elementary objects may have many contents
1227 * @deprecated Use elm_object_part_content_unset instead.
1230 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1233 * Unset a content of an object
1235 * @param obj The Elementary object
1236 * @param item The content part name to unset (NULL for the default content)
1238 * @note Elementary objects may have many contents
1242 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1244 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1247 * Set the text to read out when in accessibility mode
1249 * @param obj The object which is to be described
1250 * @param txt The text that describes the widget to people with poor or no vision
1254 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1257 * Get the widget object's handle which contains a given item
1259 * @param item The Elementary object item
1260 * @return The widget object
1262 * @note This returns the widget object itself that an item belongs to.
1266 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1269 * Set a content of an object item
1271 * @param it The Elementary object item
1272 * @param part The content part name to set (NULL for the default content)
1273 * @param content The new content of the object item
1275 * @note Elementary object items may have many contents
1276 * @deprecated Use elm_object_item_part_content_set instead.
1279 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1282 * Set a content of an object item
1284 * @param it The Elementary object item
1285 * @param part The content part name to set (NULL for the default content)
1286 * @param content The new content of the object item
1288 * @note Elementary object items may have many contents
1292 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1294 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1297 * Get a content of an object item
1299 * @param it The Elementary object item
1300 * @param part The content part name to unset (NULL for the default content)
1301 * @return content of the object item or NULL for any error
1303 * @note Elementary object items may have many contents
1304 * @deprecated Use elm_object_item_part_content_get instead.
1307 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1310 * Get a content of an object item
1312 * @param it The Elementary object item
1313 * @param part The content part name to unset (NULL for the default content)
1314 * @return content of the object item or NULL for any error
1316 * @note Elementary object items may have many contents
1320 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1322 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1325 * Unset a content of an object item
1327 * @param it The Elementary object item
1328 * @param part The content part name to unset (NULL for the default content)
1330 * @note Elementary object items may have many contents
1331 * @deprecated Use elm_object_item_part_content_unset instead.
1334 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1337 * Unset a content of an object item
1339 * @param it The Elementary object item
1340 * @param part The content part name to unset (NULL for the default content)
1342 * @note Elementary object items may have many contents
1346 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1348 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1351 * Set a label of an object item
1353 * @param it The Elementary object item
1354 * @param part The text part name to set (NULL for the default label)
1355 * @param label The new text of the label
1357 * @note Elementary object items may have many labels
1358 * @deprecated Use elm_object_item_part_text_set instead.
1361 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1364 * Set a label of an object item
1366 * @param it The Elementary object item
1367 * @param part The text part name to set (NULL for the default label)
1368 * @param label The new text of the label
1370 * @note Elementary object items may have many labels
1374 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1376 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1379 * Get a label of an object item
1381 * @param it The Elementary object item
1382 * @param part The text part name to get (NULL for the default label)
1383 * @return text of the label or NULL for any error
1385 * @note Elementary object items may have many labels
1386 * @deprecated Use elm_object_item_part_text_get instead.
1389 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1391 * Get a label of an object item
1393 * @param it The Elementary object item
1394 * @param part The text part name to get (NULL for the default label)
1395 * @return text of the label or NULL for any error
1397 * @note Elementary object items may have many labels
1401 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1403 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1406 * Set the text to read out when in accessibility mode
1408 * @param it The object item which is to be described
1409 * @param txt The text that describes the widget to people with poor or no vision
1413 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1416 * Get the data associated with an object item
1417 * @param it The Elementary object item
1418 * @return The data associated with @p it
1422 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1425 * Set the data associated with an object item
1426 * @param it The Elementary object item
1427 * @param data The data to be associated with @p it
1431 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1434 * Send a signal to the edje object of the widget item.
1436 * This function sends a signal to the edje object of the obj item. An
1437 * edje program can respond to a signal by specifying matching
1438 * 'signal' and 'source' fields.
1440 * @param it The Elementary object item
1441 * @param emission The signal's name.
1442 * @param source The signal's source.
1445 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1448 * Set the disabled state of an widget item.
1450 * @param obj The Elementary object item
1451 * @param disabled The state to put in in: @c EINA_TRUE for
1452 * disabled, @c EINA_FALSE for enabled
1454 * Elementary object item can be @b disabled, in which state they won't
1455 * receive input and, in general, will be themed differently from
1456 * their normal state, usually greyed out. Useful for contexts
1457 * where you don't want your users to interact with some of the
1458 * parts of you interface.
1460 * This sets the state for the widget item, either disabling it or
1465 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1468 * Get the disabled state of an widget item.
1470 * @param obj The Elementary object
1471 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1472 * if it's enabled (or on errors)
1474 * This gets the state of the widget, which might be enabled or disabled.
1478 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1485 * @defgroup Caches Caches
1487 * These are functions which let one fine-tune some cache values for
1488 * Elementary applications, thus allowing for performance adjustments.
1494 * @brief Flush all caches.
1496 * Frees all data that was in cache and is not currently being used to reduce
1497 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1498 * to calling all of the following functions:
1499 * @li edje_file_cache_flush()
1500 * @li edje_collection_cache_flush()
1501 * @li eet_clearcache()
1502 * @li evas_image_cache_flush()
1503 * @li evas_font_cache_flush()
1504 * @li evas_render_dump()
1505 * @note Evas caches are flushed for every canvas associated with a window.
1509 EAPI void elm_all_flush(void);
1512 * Get the configured cache flush interval time
1514 * This gets the globally configured cache flush interval time, in
1517 * @return The cache flush interval time
1520 * @see elm_all_flush()
1522 EAPI int elm_cache_flush_interval_get(void);
1525 * Set the configured cache flush interval time
1527 * This sets the globally configured cache flush interval time, in ticks
1529 * @param size The cache flush interval time
1532 * @see elm_all_flush()
1534 EAPI void elm_cache_flush_interval_set(int size);
1537 * Set the configured cache flush interval time for all applications on the
1540 * This sets the globally configured cache flush interval time -- in ticks
1541 * -- for all applications on the display.
1543 * @param size The cache flush interval time
1546 EAPI void elm_cache_flush_interval_all_set(int size);
1549 * Get the configured cache flush enabled state
1551 * This gets the globally configured cache flush state - if it is enabled
1552 * or not. When cache flushing is enabled, elementary will regularly
1553 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1554 * memory and allow usage to re-seed caches and data in memory where it
1555 * can do so. An idle application will thus minimise its memory usage as
1556 * data will be freed from memory and not be re-loaded as it is idle and
1557 * not rendering or doing anything graphically right now.
1559 * @return The cache flush state
1562 * @see elm_all_flush()
1564 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1567 * Set the configured cache flush enabled state
1569 * This sets the globally configured cache flush enabled state.
1571 * @param size The cache flush enabled state
1574 * @see elm_all_flush()
1576 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1579 * Set the configured cache flush enabled state for all applications on the
1582 * This sets the globally configured cache flush enabled state for all
1583 * applications on the display.
1585 * @param size The cache flush enabled state
1588 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1591 * Get the configured font cache size
1593 * This gets the globally configured font cache size, in bytes.
1595 * @return The font cache size
1598 EAPI int elm_font_cache_get(void);
1601 * Set the configured font cache size
1603 * This sets the globally configured font cache size, in bytes
1605 * @param size The font cache size
1608 EAPI void elm_font_cache_set(int size);
1611 * Set the configured font cache size for all applications on the
1614 * This sets the globally configured font cache size -- in bytes
1615 * -- for all applications on the display.
1617 * @param size The font cache size
1620 EAPI void elm_font_cache_all_set(int size);
1623 * Get the configured image cache size
1625 * This gets the globally configured image cache size, in bytes
1627 * @return The image cache size
1630 EAPI int elm_image_cache_get(void);
1633 * Set the configured image cache size
1635 * This sets the globally configured image cache size, in bytes
1637 * @param size The image cache size
1640 EAPI void elm_image_cache_set(int size);
1643 * Set the configured image cache size for all applications on the
1646 * This sets the globally configured image cache size -- in bytes
1647 * -- for all applications on the display.
1649 * @param size The image cache size
1652 EAPI void elm_image_cache_all_set(int size);
1655 * Get the configured edje file cache size.
1657 * This gets the globally configured edje file cache size, in number
1660 * @return The edje file cache size
1663 EAPI int elm_edje_file_cache_get(void);
1666 * Set the configured edje file cache size
1668 * This sets the globally configured edje file cache size, in number
1671 * @param size The edje file cache size
1674 EAPI void elm_edje_file_cache_set(int size);
1677 * Set the configured edje file cache size for all applications on the
1680 * This sets the globally configured edje file cache size -- in number
1681 * of files -- for all applications on the display.
1683 * @param size The edje file cache size
1686 EAPI void elm_edje_file_cache_all_set(int size);
1689 * Get the configured edje collections (groups) cache size.
1691 * This gets the globally configured edje collections cache size, in
1692 * number of collections.
1694 * @return The edje collections cache size
1697 EAPI int elm_edje_collection_cache_get(void);
1700 * Set the configured edje collections (groups) cache size
1702 * This sets the globally configured edje collections cache size, in
1703 * number of collections.
1705 * @param size The edje collections cache size
1708 EAPI void elm_edje_collection_cache_set(int size);
1711 * Set the configured edje collections (groups) cache size for all
1712 * applications on the display
1714 * This sets the globally configured edje collections cache size -- in
1715 * number of collections -- for all applications on the display.
1717 * @param size The edje collections cache size
1720 EAPI void elm_edje_collection_cache_all_set(int size);
1727 * @defgroup Scaling Widget Scaling
1729 * Different widgets can be scaled independently. These functions
1730 * allow you to manipulate this scaling on a per-widget basis. The
1731 * object and all its children get their scaling factors multiplied
1732 * by the scale factor set. This is multiplicative, in that if a
1733 * child also has a scale size set it is in turn multiplied by its
1734 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1735 * double size, @c 0.5 is half, etc.
1737 * @ref general_functions_example_page "This" example contemplates
1738 * some of these functions.
1742 * Get the global scaling factor
1744 * This gets the globally configured scaling factor that is applied to all
1747 * @return The scaling factor
1750 EAPI double elm_scale_get(void);
1753 * Set the global scaling factor
1755 * This sets the globally configured scaling factor that is applied to all
1758 * @param scale The scaling factor to set
1761 EAPI void elm_scale_set(double scale);
1764 * Set the global scaling factor for all applications on the display
1766 * This sets the globally configured scaling factor that is applied to all
1767 * objects for all applications.
1768 * @param scale The scaling factor to set
1771 EAPI void elm_scale_all_set(double scale);
1774 * Set the scaling factor for a given Elementary object
1776 * @param obj The Elementary to operate on
1777 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1782 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1785 * Get the scaling factor for a given Elementary object
1787 * @param obj The object
1788 * @return The scaling factor set by elm_object_scale_set()
1792 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1795 * @defgroup Password_last_show Password last input show
1797 * Last show feature of password mode enables user to view
1798 * the last input entered for few seconds before masking it.
1799 * These functions allow to set this feature in password mode
1800 * of entry widget and also allow to manipulate the duration
1801 * for which the input has to be visible.
1807 * Get show last setting of password mode.
1809 * This gets the show last input setting of password mode which might be
1810 * enabled or disabled.
1812 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1814 * @ingroup Password_last_show
1816 EAPI Eina_Bool elm_password_show_last_get(void);
1819 * Set show last setting in password mode.
1821 * This enables or disables show last setting of password mode.
1823 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1824 * @see elm_password_show_last_timeout_set()
1825 * @ingroup Password_last_show
1827 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1830 * Get's the timeout value in last show password mode.
1832 * This gets the time out value for which the last input entered in password
1833 * mode will be visible.
1835 * @return The timeout value of last show password mode.
1836 * @ingroup Password_last_show
1838 EAPI double elm_password_show_last_timeout_get(void);
1841 * Set's the timeout value in last show password mode.
1843 * This sets the time out value for which the last input entered in password
1844 * mode will be visible.
1846 * @param password_show_last_timeout The timeout value.
1847 * @see elm_password_show_last_set()
1848 * @ingroup Password_last_show
1850 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1857 * @defgroup UI-Mirroring Selective Widget mirroring
1859 * These functions allow you to set ui-mirroring on specific
1860 * widgets or the whole interface. Widgets can be in one of two
1861 * modes, automatic and manual. Automatic means they'll be changed
1862 * according to the system mirroring mode and manual means only
1863 * explicit changes will matter. You are not supposed to change
1864 * mirroring state of a widget set to automatic, will mostly work,
1865 * but the behavior is not really defined.
1870 EAPI Eina_Bool elm_mirrored_get(void);
1871 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1874 * Get the system mirrored mode. This determines the default mirrored mode
1877 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1879 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1882 * Set the system mirrored mode. This determines the default mirrored mode
1885 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1887 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1890 * Returns the widget's mirrored mode setting.
1892 * @param obj The widget.
1893 * @return mirrored mode setting of the object.
1896 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1899 * Sets the widget's mirrored mode setting.
1900 * When widget in automatic mode, it follows the system mirrored mode set by
1901 * elm_mirrored_set().
1902 * @param obj The widget.
1903 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1905 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1912 * Set the style to use by a widget
1914 * Sets the style name that will define the appearance of a widget. Styles
1915 * vary from widget to widget and may also be defined by other themes
1916 * by means of extensions and overlays.
1918 * @param obj The Elementary widget to style
1919 * @param style The style name to use
1921 * @see elm_theme_extension_add()
1922 * @see elm_theme_extension_del()
1923 * @see elm_theme_overlay_add()
1924 * @see elm_theme_overlay_del()
1928 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1930 * Get the style used by the widget
1932 * This gets the style being used for that widget. Note that the string
1933 * pointer is only valid as longas the object is valid and the style doesn't
1936 * @param obj The Elementary widget to query for its style
1937 * @return The style name used
1939 * @see elm_object_style_set()
1943 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1946 * @defgroup Styles Styles
1948 * Widgets can have different styles of look. These generic API's
1949 * set styles of widgets, if they support them (and if the theme(s)
1952 * @ref general_functions_example_page "This" example contemplates
1953 * some of these functions.
1957 * Set the disabled state of an Elementary object.
1959 * @param obj The Elementary object to operate on
1960 * @param disabled The state to put in in: @c EINA_TRUE for
1961 * disabled, @c EINA_FALSE for enabled
1963 * Elementary objects can be @b disabled, in which state they won't
1964 * receive input and, in general, will be themed differently from
1965 * their normal state, usually greyed out. Useful for contexts
1966 * where you don't want your users to interact with some of the
1967 * parts of you interface.
1969 * This sets the state for the widget, either disabling it or
1974 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1977 * Get the disabled state of an Elementary object.
1979 * @param obj The Elementary object to operate on
1980 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1981 * if it's enabled (or on errors)
1983 * This gets the state of the widget, which might be enabled or disabled.
1987 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1990 * @defgroup WidgetNavigation Widget Tree Navigation.
1992 * How to check if an Evas Object is an Elementary widget? How to
1993 * get the first elementary widget that is parent of the given
1994 * object? These are all covered in widget tree navigation.
1996 * @ref general_functions_example_page "This" example contemplates
1997 * some of these functions.
2001 * Check if the given Evas Object is an Elementary widget.
2003 * @param obj the object to query.
2004 * @return @c EINA_TRUE if it is an elementary widget variant,
2005 * @c EINA_FALSE otherwise
2006 * @ingroup WidgetNavigation
2008 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2011 * Get the first parent of the given object that is an Elementary
2014 * @param obj the Elementary object to query parent from.
2015 * @return the parent object that is an Elementary widget, or @c
2016 * NULL, if it was not found.
2018 * Use this to query for an object's parent widget.
2020 * @note Most of Elementary users wouldn't be mixing non-Elementary
2021 * smart objects in the objects tree of an application, as this is
2022 * an advanced usage of Elementary with Evas. So, except for the
2023 * application's window, which is the root of that tree, all other
2024 * objects would have valid Elementary widget parents.
2026 * @ingroup WidgetNavigation
2028 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2031 * Get the top level parent of an Elementary widget.
2033 * @param obj The object to query.
2034 * @return The top level Elementary widget, or @c NULL if parent cannot be
2036 * @ingroup WidgetNavigation
2038 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2041 * Get the string that represents this Elementary widget.
2043 * @note Elementary is weird and exposes itself as a single
2044 * Evas_Object_Smart_Class of type "elm_widget", so
2045 * evas_object_type_get() always return that, making debug and
2046 * language bindings hard. This function tries to mitigate this
2047 * problem, but the solution is to change Elementary to use
2048 * proper inheritance.
2050 * @param obj the object to query.
2051 * @return Elementary widget name, or @c NULL if not a valid widget.
2052 * @ingroup WidgetNavigation
2054 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2057 * @defgroup Config Elementary Config
2059 * Elementary configuration is formed by a set options bounded to a
2060 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2061 * "finger size", etc. These are functions with which one syncronizes
2062 * changes made to those values to the configuration storing files, de
2063 * facto. You most probably don't want to use the functions in this
2064 * group unlees you're writing an elementary configuration manager.
2070 * Save back Elementary's configuration, so that it will persist on
2073 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2076 * This function will take effect -- thus, do I/O -- immediately. Use
2077 * it when you want to apply all configuration changes at once. The
2078 * current configuration set will get saved onto the current profile
2079 * configuration file.
2082 EAPI Eina_Bool elm_config_save(void);
2085 * Reload Elementary's configuration, bounded to current selected
2088 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2091 * Useful when you want to force reloading of configuration values for
2092 * a profile. If one removes user custom configuration directories,
2093 * for example, it will force a reload with system values instead.
2096 EAPI void elm_config_reload(void);
2103 * @defgroup Profile Elementary Profile
2105 * Profiles are pre-set options that affect the whole look-and-feel of
2106 * Elementary-based applications. There are, for example, profiles
2107 * aimed at desktop computer applications and others aimed at mobile,
2108 * touchscreen-based ones. You most probably don't want to use the
2109 * functions in this group unlees you're writing an elementary
2110 * configuration manager.
2116 * Get Elementary's profile in use.
2118 * This gets the global profile that is applied to all Elementary
2121 * @return The profile's name
2124 EAPI const char *elm_profile_current_get(void);
2127 * Get an Elementary's profile directory path in the filesystem. One
2128 * may want to fetch a system profile's dir or an user one (fetched
2131 * @param profile The profile's name
2132 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2133 * or a system one (@c EINA_FALSE)
2134 * @return The profile's directory path.
2137 * @note You must free it with elm_profile_dir_free().
2139 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2142 * Free an Elementary's profile directory path, as returned by
2143 * elm_profile_dir_get().
2145 * @param p_dir The profile's path
2149 EAPI void elm_profile_dir_free(const char *p_dir);
2152 * Get Elementary's list of available profiles.
2154 * @return The profiles list. List node data are the profile name
2158 * @note One must free this list, after usage, with the function
2159 * elm_profile_list_free().
2161 EAPI Eina_List *elm_profile_list_get(void);
2164 * Free Elementary's list of available profiles.
2166 * @param l The profiles list, as returned by elm_profile_list_get().
2170 EAPI void elm_profile_list_free(Eina_List *l);
2173 * Set Elementary's profile.
2175 * This sets the global profile that is applied to Elementary
2176 * applications. Just the process the call comes from will be
2179 * @param profile The profile's name
2183 EAPI void elm_profile_set(const char *profile);
2186 * Set Elementary's profile.
2188 * This sets the global profile that is applied to all Elementary
2189 * applications. All running Elementary windows will be affected.
2191 * @param profile The profile's name
2195 EAPI void elm_profile_all_set(const char *profile);
2202 * @defgroup Engine Elementary Engine
2204 * These are functions setting and querying which rendering engine
2205 * Elementary will use for drawing its windows' pixels.
2207 * The following are the available engines:
2208 * @li "software_x11"
2211 * @li "software_16_x11"
2212 * @li "software_8_x11"
2215 * @li "software_gdi"
2216 * @li "software_16_wince_gdi"
2218 * @li "software_16_sdl"
2222 * @li "opengl_cocoa"
2229 * @brief Get Elementary's rendering engine in use.
2231 * @return The rendering engine's name
2232 * @note there's no need to free the returned string, here.
2234 * This gets the global rendering engine that is applied to all Elementary
2237 * @see elm_engine_set()
2239 EAPI const char *elm_engine_current_get(void);
2242 * @brief Set Elementary's rendering engine for use.
2244 * @param engine The rendering engine's name
2246 * This sets global rendering engine that is applied to all Elementary
2247 * applications. Note that it will take effect only to Elementary windows
2248 * created after this is called.
2250 * @see elm_win_add()
2252 EAPI void elm_engine_set(const char *engine);
2259 * @defgroup Fonts Elementary Fonts
2261 * These are functions dealing with font rendering, selection and the
2262 * like for Elementary applications. One might fetch which system
2263 * fonts are there to use and set custom fonts for individual classes
2264 * of UI items containing text (text classes).
2269 typedef struct _Elm_Text_Class
2275 typedef struct _Elm_Font_Overlay
2277 const char *text_class;
2279 Evas_Font_Size size;
2282 typedef struct _Elm_Font_Properties
2286 } Elm_Font_Properties;
2289 * Get Elementary's list of supported text classes.
2291 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2294 * Release the list with elm_text_classes_list_free().
2296 EAPI const Eina_List *elm_text_classes_list_get(void);
2299 * Free Elementary's list of supported text classes.
2303 * @see elm_text_classes_list_get().
2305 EAPI void elm_text_classes_list_free(const Eina_List *list);
2308 * Get Elementary's list of font overlays, set with
2309 * elm_font_overlay_set().
2311 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2316 * For each text class, one can set a <b>font overlay</b> for it,
2317 * overriding the default font properties for that class coming from
2318 * the theme in use. There is no need to free this list.
2320 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2322 EAPI const Eina_List *elm_font_overlay_list_get(void);
2325 * Set a font overlay for a given Elementary text class.
2327 * @param text_class Text class name
2328 * @param font Font name and style string
2329 * @param size Font size
2333 * @p font has to be in the format returned by
2334 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2335 * and elm_font_overlay_unset().
2337 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2340 * Unset a font overlay for a given Elementary text class.
2342 * @param text_class Text class name
2346 * This will bring back text elements belonging to text class
2347 * @p text_class back to their default font settings.
2349 EAPI void elm_font_overlay_unset(const char *text_class);
2352 * Apply the changes made with elm_font_overlay_set() and
2353 * elm_font_overlay_unset() on the current Elementary window.
2357 * This applies all font overlays set to all objects in the UI.
2359 EAPI void elm_font_overlay_apply(void);
2362 * Apply the changes made with elm_font_overlay_set() and
2363 * elm_font_overlay_unset() on all Elementary application windows.
2367 * This applies all font overlays set to all objects in the UI.
2369 EAPI void elm_font_overlay_all_apply(void);
2372 * Translate a font (family) name string in fontconfig's font names
2373 * syntax into an @c Elm_Font_Properties struct.
2375 * @param font The font name and styles string
2376 * @return the font properties struct
2380 * @note The reverse translation can be achived with
2381 * elm_font_fontconfig_name_get(), for one style only (single font
2382 * instance, not family).
2384 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2387 * Free font properties return by elm_font_properties_get().
2389 * @param efp the font properties struct
2393 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2396 * Translate a font name, bound to a style, into fontconfig's font names
2399 * @param name The font (family) name
2400 * @param style The given style (may be @c NULL)
2402 * @return the font name and style string
2406 * @note The reverse translation can be achived with
2407 * elm_font_properties_get(), for one style only (single font
2408 * instance, not family).
2410 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2413 * Free the font string return by elm_font_fontconfig_name_get().
2415 * @param efp the font properties struct
2419 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2422 * Create a font hash table of available system fonts.
2424 * One must call it with @p list being the return value of
2425 * evas_font_available_list(). The hash will be indexed by font
2426 * (family) names, being its values @c Elm_Font_Properties blobs.
2428 * @param list The list of available system fonts, as returned by
2429 * evas_font_available_list().
2430 * @return the font hash.
2434 * @note The user is supposed to get it populated at least with 3
2435 * default font families (Sans, Serif, Monospace), which should be
2436 * present on most systems.
2438 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2441 * Free the hash return by elm_font_available_hash_add().
2443 * @param hash the hash to be freed.
2447 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2454 * @defgroup Fingers Fingers
2456 * Elementary is designed to be finger-friendly for touchscreens,
2457 * and so in addition to scaling for display resolution, it can
2458 * also scale based on finger "resolution" (or size). You can then
2459 * customize the granularity of the areas meant to receive clicks
2462 * Different profiles may have pre-set values for finger sizes.
2464 * @ref general_functions_example_page "This" example contemplates
2465 * some of these functions.
2471 * Get the configured "finger size"
2473 * @return The finger size
2475 * This gets the globally configured finger size, <b>in pixels</b>
2479 EAPI Evas_Coord elm_finger_size_get(void);
2482 * Set the configured finger size
2484 * This sets the globally configured finger size in pixels
2486 * @param size The finger size
2489 EAPI void elm_finger_size_set(Evas_Coord size);
2492 * Set the configured finger size for all applications on the display
2494 * This sets the globally configured finger size in pixels for all
2495 * applications on the display
2497 * @param size The finger size
2500 EAPI void elm_finger_size_all_set(Evas_Coord size);
2507 * @defgroup Focus Focus
2509 * An Elementary application has, at all times, one (and only one)
2510 * @b focused object. This is what determines where the input
2511 * events go to within the application's window. Also, focused
2512 * objects can be decorated differently, in order to signal to the
2513 * user where the input is, at a given moment.
2515 * Elementary applications also have the concept of <b>focus
2516 * chain</b>: one can cycle through all the windows' focusable
2517 * objects by input (tab key) or programmatically. The default
2518 * focus chain for an application is the one define by the order in
2519 * which the widgets where added in code. One will cycle through
2520 * top level widgets, and, for each one containg sub-objects, cycle
2521 * through them all, before returning to the level
2522 * above. Elementary also allows one to set @b custom focus chains
2523 * for their applications.
2525 * Besides the focused decoration a widget may exhibit, when it
2526 * gets focus, Elementary has a @b global focus highlight object
2527 * that can be enabled for a window. If one chooses to do so, this
2528 * extra highlight effect will surround the current focused object,
2531 * @note Some Elementary widgets are @b unfocusable, after
2532 * creation, by their very nature: they are not meant to be
2533 * interacted with input events, but are there just for visual
2536 * @ref general_functions_example_page "This" example contemplates
2537 * some of these functions.
2541 * Get the enable status of the focus highlight
2543 * This gets whether the highlight on focused objects is enabled or not
2546 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2549 * Set the enable status of the focus highlight
2551 * Set whether to show or not the highlight on focused objects
2552 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2555 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2558 * Get the enable status of the highlight animation
2560 * Get whether the focus highlight, if enabled, will animate its switch from
2561 * one object to the next
2564 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2567 * Set the enable status of the highlight animation
2569 * Set whether the focus highlight, if enabled, will animate its switch from
2570 * one object to the next
2571 * @param animate Enable animation if EINA_TRUE, disable otherwise
2574 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2577 * Get the whether an Elementary object has the focus or not.
2579 * @param obj The Elementary object to get the information from
2580 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2581 * not (and on errors).
2583 * @see elm_object_focus_set()
2587 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2590 * Set/unset focus to a given Elementary object.
2592 * @param obj The Elementary object to operate on.
2593 * @param enable @c EINA_TRUE Set focus to a given object,
2594 * @c EINA_FALSE Unset focus to a given object.
2596 * @note When you set focus to this object, if it can handle focus, will
2597 * take the focus away from the one who had it previously and will, for
2598 * now on, be the one receiving input events. Unsetting focus will remove
2599 * the focus from @p obj, passing it back to the previous element in the
2602 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2606 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2609 * Make a given Elementary object the focused one.
2611 * @param obj The Elementary object to make focused.
2613 * @note This object, if it can handle focus, will take the focus
2614 * away from the one who had it previously and will, for now on, be
2615 * the one receiving input events.
2617 * @see elm_object_focus_get()
2618 * @deprecated use elm_object_focus_set() instead.
2622 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2625 * Remove the focus from an Elementary object
2627 * @param obj The Elementary to take focus from
2629 * This removes the focus from @p obj, passing it back to the
2630 * previous element in the focus chain list.
2632 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2633 * @deprecated use elm_object_focus_set() instead.
2637 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2640 * Set the ability for an Element object to be focused
2642 * @param obj The Elementary object to operate on
2643 * @param enable @c EINA_TRUE if the object can be focused, @c
2644 * EINA_FALSE if not (and on errors)
2646 * This sets whether the object @p obj is able to take focus or
2647 * not. Unfocusable objects do nothing when programmatically
2648 * focused, being the nearest focusable parent object the one
2649 * really getting focus. Also, when they receive mouse input, they
2650 * will get the event, but not take away the focus from where it
2655 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2658 * Get whether an Elementary object is focusable or not
2660 * @param obj The Elementary object to operate on
2661 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2662 * EINA_FALSE if not (and on errors)
2664 * @note Objects which are meant to be interacted with by input
2665 * events are created able to be focused, by default. All the
2670 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2673 * Set custom focus chain.
2675 * This function overwrites any previous custom focus chain within
2676 * the list of objects. The previous list will be deleted and this list
2677 * will be managed by elementary. After it is set, don't modify it.
2679 * @note On focus cycle, only will be evaluated children of this container.
2681 * @param obj The container object
2682 * @param objs Chain of objects to pass focus
2685 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2688 * Unset a custom focus chain on a given Elementary widget
2690 * @param obj The container object to remove focus chain from
2692 * Any focus chain previously set on @p obj (for its child objects)
2693 * is removed entirely after this call.
2697 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2700 * Get custom focus chain
2702 * @param obj The container object
2705 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2708 * Append object to custom focus chain.
2710 * @note If relative_child equal to NULL or not in custom chain, the object
2711 * will be added in end.
2713 * @note On focus cycle, only will be evaluated children of this container.
2715 * @param obj The container object
2716 * @param child The child to be added in custom chain
2717 * @param relative_child The relative object to position the child
2720 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2723 * Prepend object to custom focus chain.
2725 * @note If relative_child equal to NULL or not in custom chain, the object
2726 * will be added in begin.
2728 * @note On focus cycle, only will be evaluated children of this container.
2730 * @param obj The container object
2731 * @param child The child to be added in custom chain
2732 * @param relative_child The relative object to position the child
2735 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2738 * Give focus to next object in object tree.
2740 * Give focus to next object in focus chain of one object sub-tree.
2741 * If the last object of chain already have focus, the focus will go to the
2742 * first object of chain.
2744 * @param obj The object root of sub-tree
2745 * @param dir Direction to cycle the focus
2749 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2752 * Give focus to near object in one direction.
2754 * Give focus to near object in direction of one object.
2755 * If none focusable object in given direction, the focus will not change.
2757 * @param obj The reference object
2758 * @param x Horizontal component of direction to focus
2759 * @param y Vertical component of direction to focus
2763 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2766 * Make the elementary object and its children to be unfocusable
2769 * @param obj The Elementary object to operate on
2770 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2771 * @c EINA_FALSE for focusable.
2773 * This sets whether the object @p obj and its children objects
2774 * are able to take focus or not. If the tree is set as unfocusable,
2775 * newest focused object which is not in this tree will get focus.
2776 * This API can be helpful for an object to be deleted.
2777 * When an object will be deleted soon, it and its children may not
2778 * want to get focus (by focus reverting or by other focus controls).
2779 * Then, just use this API before deleting.
2781 * @see elm_object_tree_unfocusable_get()
2785 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2788 * Get whether an Elementary object and its children are unfocusable or not.
2790 * @param obj The Elementary object to get the information from
2791 * @return @c EINA_TRUE, if the tree is unfocussable,
2792 * @c EINA_FALSE if not (and on errors).
2794 * @see elm_object_tree_unfocusable_set()
2798 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2801 * @defgroup Scrolling Scrolling
2803 * These are functions setting how scrollable views in Elementary
2804 * widgets should behave on user interaction.
2810 * Get whether scrollers should bounce when they reach their
2811 * viewport's edge during a scroll.
2813 * @return the thumb scroll bouncing state
2815 * This is the default behavior for touch screens, in general.
2816 * @ingroup Scrolling
2818 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2821 * Set whether scrollers should bounce when they reach their
2822 * viewport's edge during a scroll.
2824 * @param enabled the thumb scroll bouncing state
2826 * @see elm_thumbscroll_bounce_enabled_get()
2827 * @ingroup Scrolling
2829 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2832 * Set whether scrollers should bounce when they reach their
2833 * viewport's edge during a scroll, for all Elementary application
2836 * @param enabled the thumb scroll bouncing state
2838 * @see elm_thumbscroll_bounce_enabled_get()
2839 * @ingroup Scrolling
2841 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2844 * Get the amount of inertia a scroller will impose at bounce
2847 * @return the thumb scroll bounce friction
2849 * @ingroup Scrolling
2851 EAPI double elm_scroll_bounce_friction_get(void);
2854 * Set the amount of inertia a scroller will impose at bounce
2857 * @param friction the thumb scroll bounce friction
2859 * @see elm_thumbscroll_bounce_friction_get()
2860 * @ingroup Scrolling
2862 EAPI void elm_scroll_bounce_friction_set(double friction);
2865 * Set the amount of inertia a scroller will impose at bounce
2866 * animations, for all Elementary application windows.
2868 * @param friction the thumb scroll bounce friction
2870 * @see elm_thumbscroll_bounce_friction_get()
2871 * @ingroup Scrolling
2873 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2876 * Get the amount of inertia a <b>paged</b> scroller will impose at
2877 * page fitting animations.
2879 * @return the page scroll friction
2881 * @ingroup Scrolling
2883 EAPI double elm_scroll_page_scroll_friction_get(void);
2886 * Set the amount of inertia a <b>paged</b> scroller will impose at
2887 * page fitting animations.
2889 * @param friction the page scroll friction
2891 * @see elm_thumbscroll_page_scroll_friction_get()
2892 * @ingroup Scrolling
2894 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2897 * Set the amount of inertia a <b>paged</b> scroller will impose at
2898 * page fitting animations, for all Elementary application windows.
2900 * @param friction the page scroll friction
2902 * @see elm_thumbscroll_page_scroll_friction_get()
2903 * @ingroup Scrolling
2905 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2908 * Get the amount of inertia a scroller will impose at region bring
2911 * @return the bring in scroll friction
2913 * @ingroup Scrolling
2915 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2918 * Set the amount of inertia a scroller will impose at region bring
2921 * @param friction the bring in scroll friction
2923 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2924 * @ingroup Scrolling
2926 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2929 * Set the amount of inertia a scroller will impose at region bring
2930 * animations, for all Elementary application windows.
2932 * @param friction the bring in scroll friction
2934 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2935 * @ingroup Scrolling
2937 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2940 * Get the amount of inertia scrollers will impose at animations
2941 * triggered by Elementary widgets' zooming API.
2943 * @return the zoom friction
2945 * @ingroup Scrolling
2947 EAPI double elm_scroll_zoom_friction_get(void);
2950 * Set the amount of inertia scrollers will impose at animations
2951 * triggered by Elementary widgets' zooming API.
2953 * @param friction the zoom friction
2955 * @see elm_thumbscroll_zoom_friction_get()
2956 * @ingroup Scrolling
2958 EAPI void elm_scroll_zoom_friction_set(double friction);
2961 * Set the amount of inertia scrollers will impose at animations
2962 * triggered by Elementary widgets' zooming API, for all Elementary
2963 * application windows.
2965 * @param friction the zoom friction
2967 * @see elm_thumbscroll_zoom_friction_get()
2968 * @ingroup Scrolling
2970 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2973 * Get whether scrollers should be draggable from any point in their
2976 * @return the thumb scroll state
2978 * @note This is the default behavior for touch screens, in general.
2979 * @note All other functions namespaced with "thumbscroll" will only
2980 * have effect if this mode is enabled.
2982 * @ingroup Scrolling
2984 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2987 * Set whether scrollers should be draggable from any point in their
2990 * @param enabled the thumb scroll state
2992 * @see elm_thumbscroll_enabled_get()
2993 * @ingroup Scrolling
2995 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2998 * Set whether scrollers should be draggable from any point in their
2999 * views, for all Elementary application windows.
3001 * @param enabled the thumb scroll state
3003 * @see elm_thumbscroll_enabled_get()
3004 * @ingroup Scrolling
3006 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3009 * Get the number of pixels one should travel while dragging a
3010 * scroller's view to actually trigger scrolling.
3012 * @return the thumb scroll threshould
3014 * One would use higher values for touch screens, in general, because
3015 * of their inherent imprecision.
3016 * @ingroup Scrolling
3018 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
3021 * Set the number of pixels one should travel while dragging a
3022 * scroller's view to actually trigger scrolling.
3024 * @param threshold the thumb scroll threshould
3026 * @see elm_thumbscroll_threshould_get()
3027 * @ingroup Scrolling
3029 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3032 * Set the number of pixels one should travel while dragging a
3033 * scroller's view to actually trigger scrolling, for all Elementary
3034 * application windows.
3036 * @param threshold the thumb scroll threshould
3038 * @see elm_thumbscroll_threshould_get()
3039 * @ingroup Scrolling
3041 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3044 * Get the minimum speed of mouse cursor movement which will trigger
3045 * list self scrolling animation after a mouse up event
3048 * @return the thumb scroll momentum threshould
3050 * @ingroup Scrolling
3052 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
3055 * Set the minimum speed of mouse cursor movement which will trigger
3056 * list self scrolling animation after a mouse up event
3059 * @param threshold the thumb scroll momentum threshould
3061 * @see elm_thumbscroll_momentum_threshould_get()
3062 * @ingroup Scrolling
3064 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3067 * Set the minimum speed of mouse cursor movement which will trigger
3068 * list self scrolling animation after a mouse up event
3069 * (pixels/second), for all Elementary application windows.
3071 * @param threshold the thumb scroll momentum threshould
3073 * @see elm_thumbscroll_momentum_threshould_get()
3074 * @ingroup Scrolling
3076 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3079 * Get the amount of inertia a scroller will impose at self scrolling
3082 * @return the thumb scroll friction
3084 * @ingroup Scrolling
3086 EAPI double elm_scroll_thumbscroll_friction_get(void);
3089 * Set the amount of inertia a scroller will impose at self scrolling
3092 * @param friction the thumb scroll friction
3094 * @see elm_thumbscroll_friction_get()
3095 * @ingroup Scrolling
3097 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3100 * Set the amount of inertia a scroller will impose at self scrolling
3101 * animations, for all Elementary application windows.
3103 * @param friction the thumb scroll friction
3105 * @see elm_thumbscroll_friction_get()
3106 * @ingroup Scrolling
3108 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3111 * Get the amount of lag between your actual mouse cursor dragging
3112 * movement and a scroller's view movement itself, while pushing it
3113 * into bounce state manually.
3115 * @return the thumb scroll border friction
3117 * @ingroup Scrolling
3119 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3122 * Set the amount of lag between your actual mouse cursor dragging
3123 * movement and a scroller's view movement itself, while pushing it
3124 * into bounce state manually.
3126 * @param friction the thumb scroll border friction. @c 0.0 for
3127 * perfect synchrony between two movements, @c 1.0 for maximum
3130 * @see elm_thumbscroll_border_friction_get()
3131 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3133 * @ingroup Scrolling
3135 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3138 * Set the amount of lag between your actual mouse cursor dragging
3139 * movement and a scroller's view movement itself, while pushing it
3140 * into bounce state manually, for all Elementary application windows.
3142 * @param friction the thumb scroll border friction. @c 0.0 for
3143 * perfect synchrony between two movements, @c 1.0 for maximum
3146 * @see elm_thumbscroll_border_friction_get()
3147 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3149 * @ingroup Scrolling
3151 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3154 * Get the sensitivity amount which is be multiplied by the length of
3157 * @return the thumb scroll sensitivity friction
3159 * @ingroup Scrolling
3161 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3164 * Set the sensitivity amount which is be multiplied by the length of
3167 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3168 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3171 * @see elm_thumbscroll_sensitivity_friction_get()
3172 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3174 * @ingroup Scrolling
3176 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3179 * Set the sensitivity amount which is be multiplied by the length of
3180 * mouse dragging, for all Elementary application windows.
3182 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3183 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3186 * @see elm_thumbscroll_sensitivity_friction_get()
3187 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3189 * @ingroup Scrolling
3191 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3198 * @defgroup Scrollhints Scrollhints
3200 * Objects when inside a scroller can scroll, but this may not always be
3201 * desirable in certain situations. This allows an object to hint to itself
3202 * and parents to "not scroll" in one of 2 ways. If any child object of a
3203 * scroller has pushed a scroll freeze or hold then it affects all parent
3204 * scrollers until all children have released them.
3206 * 1. To hold on scrolling. This means just flicking and dragging may no
3207 * longer scroll, but pressing/dragging near an edge of the scroller will
3208 * still scroll. This is automatically used by the entry object when
3211 * 2. To totally freeze scrolling. This means it stops. until
3218 * Push the scroll hold by 1
3220 * This increments the scroll hold count by one. If it is more than 0 it will
3221 * take effect on the parents of the indicated object.
3223 * @param obj The object
3224 * @ingroup Scrollhints
3226 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3229 * Pop the scroll hold by 1
3231 * This decrements the scroll hold count by one. If it is more than 0 it will
3232 * take effect on the parents of the indicated object.
3234 * @param obj The object
3235 * @ingroup Scrollhints
3237 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3240 * Push the scroll freeze by 1
3242 * This increments the scroll freeze count by one. If it is more
3243 * than 0 it will take effect on the parents of the indicated
3246 * @param obj The object
3247 * @ingroup Scrollhints
3249 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3252 * Pop the scroll freeze by 1
3254 * This decrements the scroll freeze count by one. If it is more
3255 * than 0 it will take effect on the parents of the indicated
3258 * @param obj The object
3259 * @ingroup Scrollhints
3261 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3264 * Lock the scrolling of the given widget (and thus all parents)
3266 * This locks the given object from scrolling in the X axis (and implicitly
3267 * also locks all parent scrollers too from doing the same).
3269 * @param obj The object
3270 * @param lock The lock state (1 == locked, 0 == unlocked)
3271 * @ingroup Scrollhints
3273 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3276 * Lock the scrolling of the given widget (and thus all parents)
3278 * This locks the given object from scrolling in the Y axis (and implicitly
3279 * also locks all parent scrollers too from doing the same).
3281 * @param obj The object
3282 * @param lock The lock state (1 == locked, 0 == unlocked)
3283 * @ingroup Scrollhints
3285 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3288 * Get the scrolling lock of the given widget
3290 * This gets the lock for X axis scrolling.
3292 * @param obj The object
3293 * @ingroup Scrollhints
3295 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3298 * Get the scrolling lock of the given widget
3300 * This gets the lock for X axis scrolling.
3302 * @param obj The object
3303 * @ingroup Scrollhints
3305 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3312 * Send a signal to the widget edje object.
3314 * This function sends a signal to the edje object of the obj. An
3315 * edje program can respond to a signal by specifying matching
3316 * 'signal' and 'source' fields.
3318 * @param obj The object
3319 * @param emission The signal's name.
3320 * @param source The signal's source.
3323 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3326 * Add a callback for a signal emitted by widget edje object.
3328 * This function connects a callback function to a signal emitted by the
3329 * edje object of the obj.
3330 * Globs can occur in either the emission or source name.
3332 * @param obj The object
3333 * @param emission The signal's name.
3334 * @param source The signal's source.
3335 * @param func The callback function to be executed when the signal is
3337 * @param data A pointer to data to pass in to the callback function.
3340 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);
3343 * Remove a signal-triggered callback from a widget edje object.
3345 * This function removes a callback, previoulsy attached to a
3346 * signal emitted by the edje object of the obj. The parameters
3347 * emission, source and func must match exactly those passed to a
3348 * previous call to elm_object_signal_callback_add(). The data
3349 * pointer that was passed to this call will be returned.
3351 * @param obj The object
3352 * @param emission The signal's name.
3353 * @param source The signal's source.
3354 * @param func The callback function to be executed when the signal is
3356 * @return The data pointer
3359 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);
3362 * Add a callback for input events (key up, key down, mouse wheel)
3363 * on a given Elementary widget
3365 * @param obj The widget to add an event callback on
3366 * @param func The callback function to be executed when the event
3368 * @param data Data to pass in to @p func
3370 * Every widget in an Elementary interface set to receive focus,
3371 * with elm_object_focus_allow_set(), will propagate @b all of its
3372 * key up, key down and mouse wheel input events up to its parent
3373 * object, and so on. All of the focusable ones in this chain which
3374 * had an event callback set, with this call, will be able to treat
3375 * those events. There are two ways of making the propagation of
3376 * these event upwards in the tree of widgets to @b cease:
3377 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3378 * the event was @b not processed, so the propagation will go on.
3379 * - The @c event_info pointer passed to @p func will contain the
3380 * event's structure and, if you OR its @c event_flags inner
3381 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3382 * one has already handled it, thus killing the event's
3385 * @note Your event callback will be issued on those events taking
3386 * place only if no other child widget of @obj has consumed the
3389 * @note Not to be confused with @c
3390 * evas_object_event_callback_add(), which will add event callbacks
3391 * per type on general Evas objects (no event propagation
3392 * infrastructure taken in account).
3394 * @note Not to be confused with @c
3395 * elm_object_signal_callback_add(), which will add callbacks to @b
3396 * signals coming from a widget's theme, not input events.
3398 * @note Not to be confused with @c
3399 * edje_object_signal_callback_add(), which does the same as
3400 * elm_object_signal_callback_add(), but directly on an Edje
3403 * @note Not to be confused with @c
3404 * evas_object_smart_callback_add(), which adds callbacks to smart
3405 * objects' <b>smart events</b>, and not input events.
3407 * @see elm_object_event_callback_del()
3411 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3414 * Remove an event callback from a widget.
3416 * This function removes a callback, previoulsy attached to event emission
3418 * The parameters func and data must match exactly those passed to
3419 * a previous call to elm_object_event_callback_add(). The data pointer that
3420 * was passed to this call will be returned.
3422 * @param obj The object
3423 * @param func The callback function to be executed when the event is
3425 * @param data Data to pass in to the callback function.
3426 * @return The data pointer
3429 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3432 * Adjust size of an element for finger usage.
3434 * @param times_w How many fingers should fit horizontally
3435 * @param w Pointer to the width size to adjust
3436 * @param times_h How many fingers should fit vertically
3437 * @param h Pointer to the height size to adjust
3439 * This takes width and height sizes (in pixels) as input and a
3440 * size multiple (which is how many fingers you want to place
3441 * within the area, being "finger" the size set by
3442 * elm_finger_size_set()), and adjusts the size to be large enough
3443 * to accommodate the resulting size -- if it doesn't already
3444 * accommodate it. On return the @p w and @p h sizes pointed to by
3445 * these parameters will be modified, on those conditions.
3447 * @note This is kind of a low level Elementary call, most useful
3448 * on size evaluation times for widgets. An external user wouldn't
3449 * be calling, most of the time.
3453 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3456 * Get the duration for occuring long press event.
3458 * @return Timeout for long press event
3459 * @ingroup Longpress
3461 EAPI double elm_longpress_timeout_get(void);
3464 * Set the duration for occuring long press event.
3466 * @param lonpress_timeout Timeout for long press event
3467 * @ingroup Longpress
3469 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3472 * @defgroup Debug Debug
3473 * don't use it unless you are sure
3479 * Print Tree object hierarchy in stdout
3481 * @param obj The root object
3484 EAPI void elm_object_tree_dump(const Evas_Object *top);
3487 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3489 * @param obj The root object
3490 * @param file The path of output file
3493 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3500 * @defgroup Theme Theme
3502 * Elementary uses Edje to theme its widgets, naturally. But for the most
3503 * part this is hidden behind a simpler interface that lets the user set
3504 * extensions and choose the style of widgets in a much easier way.
3506 * Instead of thinking in terms of paths to Edje files and their groups
3507 * each time you want to change the appearance of a widget, Elementary
3508 * works so you can add any theme file with extensions or replace the
3509 * main theme at one point in the application, and then just set the style
3510 * of widgets with elm_object_style_set() and related functions. Elementary
3511 * will then look in its list of themes for a matching group and apply it,
3512 * and when the theme changes midway through the application, all widgets
3513 * will be updated accordingly.
3515 * There are three concepts you need to know to understand how Elementary
3516 * theming works: default theme, extensions and overlays.
3518 * Default theme, obviously enough, is the one that provides the default
3519 * look of all widgets. End users can change the theme used by Elementary
3520 * by setting the @c ELM_THEME environment variable before running an
3521 * application, or globally for all programs using the @c elementary_config
3522 * utility. Applications can change the default theme using elm_theme_set(),
3523 * but this can go against the user wishes, so it's not an adviced practice.
3525 * Ideally, applications should find everything they need in the already
3526 * provided theme, but there may be occasions when that's not enough and
3527 * custom styles are required to correctly express the idea. For this
3528 * cases, Elementary has extensions.
3530 * Extensions allow the application developer to write styles of its own
3531 * to apply to some widgets. This requires knowledge of how each widget
3532 * is themed, as extensions will always replace the entire group used by
3533 * the widget, so important signals and parts need to be there for the
3534 * object to behave properly (see documentation of Edje for details).
3535 * Once the theme for the extension is done, the application needs to add
3536 * it to the list of themes Elementary will look into, using
3537 * elm_theme_extension_add(), and set the style of the desired widgets as
3538 * he would normally with elm_object_style_set().
3540 * Overlays, on the other hand, can replace the look of all widgets by
3541 * overriding the default style. Like extensions, it's up to the application
3542 * developer to write the theme for the widgets it wants, the difference
3543 * being that when looking for the theme, Elementary will check first the
3544 * list of overlays, then the set theme and lastly the list of extensions,
3545 * so with overlays it's possible to replace the default view and every
3546 * widget will be affected. This is very much alike to setting the whole
3547 * theme for the application and will probably clash with the end user
3548 * options, not to mention the risk of ending up with not matching styles
3549 * across the program. Unless there's a very special reason to use them,
3550 * overlays should be avoided for the resons exposed before.
3552 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3553 * keeps one default internally and every function that receives one of
3554 * these can be called with NULL to refer to this default (except for
3555 * elm_theme_free()). It's possible to create a new instance of a
3556 * ::Elm_Theme to set other theme for a specific widget (and all of its
3557 * children), but this is as discouraged, if not even more so, than using
3558 * overlays. Don't use this unless you really know what you are doing.
3560 * But to be less negative about things, you can look at the following
3562 * @li @ref theme_example_01 "Using extensions"
3563 * @li @ref theme_example_02 "Using overlays"
3568 * @typedef Elm_Theme
3570 * Opaque handler for the list of themes Elementary looks for when
3571 * rendering widgets.
3573 * Stay out of this unless you really know what you are doing. For most
3574 * cases, sticking to the default is all a developer needs.
3576 typedef struct _Elm_Theme Elm_Theme;
3579 * Create a new specific theme
3581 * This creates an empty specific theme that only uses the default theme. A
3582 * specific theme has its own private set of extensions and overlays too
3583 * (which are empty by default). Specific themes do not fall back to themes
3584 * of parent objects. They are not intended for this use. Use styles, overlays
3585 * and extensions when needed, but avoid specific themes unless there is no
3586 * other way (example: you want to have a preview of a new theme you are
3587 * selecting in a "theme selector" window. The preview is inside a scroller
3588 * and should display what the theme you selected will look like, but not
3589 * actually apply it yet. The child of the scroller will have a specific
3590 * theme set to show this preview before the user decides to apply it to all
3593 EAPI Elm_Theme *elm_theme_new(void);
3595 * Free a specific theme
3597 * @param th The theme to free
3599 * This frees a theme created with elm_theme_new().
3601 EAPI void elm_theme_free(Elm_Theme *th);
3603 * Copy the theme fom the source to the destination theme
3605 * @param th The source theme to copy from
3606 * @param thdst The destination theme to copy data to
3608 * This makes a one-time static copy of all the theme config, extensions
3609 * and overlays from @p th to @p thdst. If @p th references a theme, then
3610 * @p thdst is also set to reference it, with all the theme settings,
3611 * overlays and extensions that @p th had.
3613 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3615 * Tell the source theme to reference the ref theme
3617 * @param th The theme that will do the referencing
3618 * @param thref The theme that is the reference source
3620 * This clears @p th to be empty and then sets it to refer to @p thref
3621 * so @p th acts as an override to @p thref, but where its overrides
3622 * don't apply, it will fall through to @p thref for configuration.
3624 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3626 * Return the theme referred to
3628 * @param th The theme to get the reference from
3629 * @return The referenced theme handle
3631 * This gets the theme set as the reference theme by elm_theme_ref_set().
3632 * If no theme is set as a reference, NULL is returned.
3634 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3636 * Return the default theme
3638 * @return The default theme handle
3640 * This returns the internal default theme setup handle that all widgets
3641 * use implicitly unless a specific theme is set. This is also often use
3642 * as a shorthand of NULL.
3644 EAPI Elm_Theme *elm_theme_default_get(void);
3646 * Prepends a theme overlay to the list of overlays
3648 * @param th The theme to add to, or if NULL, the default theme
3649 * @param item The Edje file path to be used
3651 * Use this if your application needs to provide some custom overlay theme
3652 * (An Edje file that replaces some default styles of widgets) where adding
3653 * new styles, or changing system theme configuration is not possible. Do
3654 * NOT use this instead of a proper system theme configuration. Use proper
3655 * configuration files, profiles, environment variables etc. to set a theme
3656 * so that the theme can be altered by simple confiugration by a user. Using
3657 * this call to achieve that effect is abusing the API and will create lots
3660 * @see elm_theme_extension_add()
3662 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3664 * Delete a theme overlay from the list of overlays
3666 * @param th The theme to delete from, or if NULL, the default theme
3667 * @param item The name of the theme overlay
3669 * @see elm_theme_overlay_add()
3671 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3673 * Appends a theme extension to the list of extensions.
3675 * @param th The theme to add to, or if NULL, the default theme
3676 * @param item The Edje file path to be used
3678 * This is intended when an application needs more styles of widgets or new
3679 * widget themes that the default does not provide (or may not provide). The
3680 * application has "extended" usage by coming up with new custom style names
3681 * for widgets for specific uses, but as these are not "standard", they are
3682 * not guaranteed to be provided by a default theme. This means the
3683 * application is required to provide these extra elements itself in specific
3684 * Edje files. This call adds one of those Edje files to the theme search
3685 * path to be search after the default theme. The use of this call is
3686 * encouraged when default styles do not meet the needs of the application.
3687 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3689 * @see elm_object_style_set()
3691 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3693 * Deletes a theme extension from the list of extensions.
3695 * @param th The theme to delete from, or if NULL, the default theme
3696 * @param item The name of the theme extension
3698 * @see elm_theme_extension_add()
3700 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3702 * Set the theme search order for the given theme
3704 * @param th The theme to set the search order, or if NULL, the default theme
3705 * @param theme Theme search string
3707 * This sets the search string for the theme in path-notation from first
3708 * theme to search, to last, delimited by the : character. Example:
3710 * "shiny:/path/to/file.edj:default"
3712 * See the ELM_THEME environment variable for more information.
3714 * @see elm_theme_get()
3715 * @see elm_theme_list_get()
3717 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3719 * Return the theme search order
3721 * @param th The theme to get the search order, or if NULL, the default theme
3722 * @return The internal search order path
3724 * This function returns a colon separated string of theme elements as
3725 * returned by elm_theme_list_get().
3727 * @see elm_theme_set()
3728 * @see elm_theme_list_get()
3730 EAPI const char *elm_theme_get(Elm_Theme *th);
3732 * Return a list of theme elements to be used in a theme.
3734 * @param th Theme to get the list of theme elements from.
3735 * @return The internal list of theme elements
3737 * This returns the internal list of theme elements (will only be valid as
3738 * long as the theme is not modified by elm_theme_set() or theme is not
3739 * freed by elm_theme_free(). This is a list of strings which must not be
3740 * altered as they are also internal. If @p th is NULL, then the default
3741 * theme element list is returned.
3743 * A theme element can consist of a full or relative path to a .edj file,
3744 * or a name, without extension, for a theme to be searched in the known
3745 * theme paths for Elemementary.
3747 * @see elm_theme_set()
3748 * @see elm_theme_get()
3750 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3752 * Return the full patrh for a theme element
3754 * @param f The theme element name
3755 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3756 * @return The full path to the file found.
3758 * This returns a string you should free with free() on success, NULL on
3759 * failure. This will search for the given theme element, and if it is a
3760 * full or relative path element or a simple searchable name. The returned
3761 * path is the full path to the file, if searched, and the file exists, or it
3762 * is simply the full path given in the element or a resolved path if
3763 * relative to home. The @p in_search_path boolean pointed to is set to
3764 * EINA_TRUE if the file was a searchable file andis in the search path,
3765 * and EINA_FALSE otherwise.
3767 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3769 * Flush the current theme.
3771 * @param th Theme to flush
3773 * This flushes caches that let elementary know where to find theme elements
3774 * in the given theme. If @p th is NULL, then the default theme is flushed.
3775 * Call this function if source theme data has changed in such a way as to
3776 * make any caches Elementary kept invalid.
3778 EAPI void elm_theme_flush(Elm_Theme *th);
3780 * This flushes all themes (default and specific ones).
3782 * This will flush all themes in the current application context, by calling
3783 * elm_theme_flush() on each of them.
3785 EAPI void elm_theme_full_flush(void);
3787 * Set the theme for all elementary using applications on the current display
3789 * @param theme The name of the theme to use. Format same as the ELM_THEME
3790 * environment variable.
3792 EAPI void elm_theme_all_set(const char *theme);
3794 * Return a list of theme elements in the theme search path
3796 * @return A list of strings that are the theme element names.
3798 * This lists all available theme files in the standard Elementary search path
3799 * for theme elements, and returns them in alphabetical order as theme
3800 * element names in a list of strings. Free this with
3801 * elm_theme_name_available_list_free() when you are done with the list.
3803 EAPI Eina_List *elm_theme_name_available_list_new(void);
3805 * Free the list returned by elm_theme_name_available_list_new()
3807 * This frees the list of themes returned by
3808 * elm_theme_name_available_list_new(). Once freed the list should no longer
3809 * be used. a new list mys be created.
3811 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3813 * Set a specific theme to be used for this object and its children
3815 * @param obj The object to set the theme on
3816 * @param th The theme to set
3818 * This sets a specific theme that will be used for the given object and any
3819 * child objects it has. If @p th is NULL then the theme to be used is
3820 * cleared and the object will inherit its theme from its parent (which
3821 * ultimately will use the default theme if no specific themes are set).
3823 * Use special themes with great care as this will annoy users and make
3824 * configuration difficult. Avoid any custom themes at all if it can be
3827 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3829 * Get the specific theme to be used
3831 * @param obj The object to get the specific theme from
3832 * @return The specifc theme set.
3834 * This will return a specific theme set, or NULL if no specific theme is
3835 * set on that object. It will not return inherited themes from parents, only
3836 * the specific theme set for that specific object. See elm_object_theme_set()
3837 * for more information.
3839 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3842 * Get a data item from a theme
3844 * @param th The theme, or NULL for default theme
3845 * @param key The data key to search with
3846 * @return The data value, or NULL on failure
3848 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3849 * It works the same way as edje_file_data_get() except that the return is stringshared.
3851 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3857 /** @defgroup Win Win
3859 * @image html img/widget/win/preview-00.png
3860 * @image latex img/widget/win/preview-00.eps
3862 * The window class of Elementary. Contains functions to manipulate
3863 * windows. The Evas engine used to render the window contents is specified
3864 * in the system or user elementary config files (whichever is found last),
3865 * and can be overridden with the ELM_ENGINE environment variable for
3866 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3867 * compilation setup and modules actually installed at runtime) are (listed
3868 * in order of best supported and most likely to be complete and work to
3871 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3872 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3874 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3876 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3878 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3880 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3881 * rendering using SDL as the buffer)
3882 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3883 * GDI with software)
3884 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3885 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3886 * grayscale using dedicated 8bit software engine in X11)
3887 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3888 * X11 using 16bit software engine)
3889 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3890 * (Windows CE rendering via GDI with 16bit software renderer)
3891 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3892 * buffer with 16bit software renderer)
3893 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3894 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3895 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3897 * All engines use a simple string to select the engine to render, EXCEPT
3898 * the "shot" engine. This actually encodes the output of the virtual
3899 * screenshot and how long to delay in the engine string. The engine string
3900 * is encoded in the following way:
3902 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3904 * Where options are separated by a ":" char if more than one option is
3905 * given, with delay, if provided being the first option and file the last
3906 * (order is important). The delay specifies how long to wait after the
3907 * window is shown before doing the virtual "in memory" rendering and then
3908 * save the output to the file specified by the file option (and then exit).
3909 * If no delay is given, the default is 0.5 seconds. If no file is given the
3910 * default output file is "out.png". Repeat option is for continous
3911 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3912 * fixed to "out001.png" Some examples of using the shot engine:
3914 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3915 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3916 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3917 * ELM_ENGINE="shot:delay=2.0" elementary_test
3918 * ELM_ENGINE="shot:" elementary_test
3920 * Signals that you can add callbacks for are:
3922 * @li "delete,request": the user requested to close the window. See
3923 * elm_win_autodel_set().
3924 * @li "focus,in": window got focus
3925 * @li "focus,out": window lost focus
3926 * @li "moved": window that holds the canvas was moved
3929 * @li @ref win_example_01
3934 * Defines the types of window that can be created
3936 * These are hints set on the window so that a running Window Manager knows
3937 * how the window should be handled and/or what kind of decorations it
3940 * Currently, only the X11 backed engines use them.
3942 typedef enum _Elm_Win_Type
3944 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3945 window. Almost every window will be created with this
3947 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3948 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3949 window holding desktop icons. */
3950 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3951 be kept on top of any other window by the Window
3953 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3955 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3956 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3958 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3959 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3960 entry in a menubar is clicked. Typically used
3961 with elm_win_override_set(). This hint exists
3962 for completion only, as the EFL way of
3963 implementing a menu would not normally use a
3964 separate window for its contents. */
3965 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3966 triggered by right-clicking an object. */
3967 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3968 explanatory text that typically appear after the
3969 mouse cursor hovers over an object for a while.
3970 Typically used with elm_win_override_set() and also
3971 not very commonly used in the EFL. */
3972 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3973 battery life or a new E-Mail received. */
3974 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3975 usually used in the EFL. */
3976 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3977 object being dragged across different windows, or even
3978 applications. Typically used with
3979 elm_win_override_set(). */
3980 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3981 buffer. No actual window is created for this
3982 type, instead the window and all of its
3983 contents will be rendered to an image buffer.
3984 This allows to have children window inside a
3985 parent one just like any other object would
3986 be, and do other things like applying @c
3987 Evas_Map effects to it. This is the only type
3988 of window that requires the @c parent
3989 parameter of elm_win_add() to be a valid @c
3994 * The differents layouts that can be requested for the virtual keyboard.
3996 * When the application window is being managed by Illume, it may request
3997 * any of the following layouts for the virtual keyboard.
3999 typedef enum _Elm_Win_Keyboard_Mode
4001 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4002 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4003 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4004 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4005 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4006 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4007 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4008 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4009 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4010 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4011 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4012 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4013 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4014 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4015 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4016 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4017 } Elm_Win_Keyboard_Mode;
4020 * Available commands that can be sent to the Illume manager.
4022 * When running under an Illume session, a window may send commands to the
4023 * Illume manager to perform different actions.
4025 typedef enum _Elm_Illume_Command
4027 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4029 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4031 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4033 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4034 } Elm_Illume_Command;
4037 * Adds a window object. If this is the first window created, pass NULL as
4040 * @param parent Parent object to add the window to, or NULL
4041 * @param name The name of the window
4042 * @param type The window type, one of #Elm_Win_Type.
4044 * The @p parent paramter can be @c NULL for every window @p type except
4045 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4046 * which the image object will be created.
4048 * @return The created object, or NULL on failure
4050 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4052 * Adds a window object with standard setup
4054 * @param name The name of the window
4055 * @param title The title for the window
4057 * This creates a window like elm_win_add() but also puts in a standard
4058 * background with elm_bg_add(), as well as setting the window title to
4059 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4060 * as the parent widget.
4062 * @return The created object, or NULL on failure
4064 * @see elm_win_add()
4066 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4068 * Add @p subobj as a resize object of window @p obj.
4071 * Setting an object as a resize object of the window means that the
4072 * @p subobj child's size and position will be controlled by the window
4073 * directly. That is, the object will be resized to match the window size
4074 * and should never be moved or resized manually by the developer.
4076 * In addition, resize objects of the window control what the minimum size
4077 * of it will be, as well as whether it can or not be resized by the user.
4079 * For the end user to be able to resize a window by dragging the handles
4080 * or borders provided by the Window Manager, or using any other similar
4081 * mechanism, all of the resize objects in the window should have their
4082 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4084 * Also notice that the window can get resized to the current size of the
4085 * object if the EVAS_HINT_EXPAND is set @b after the call to
4086 * elm_win_resize_object_add(). So if the object should get resized to the
4087 * size of the window, set this hint @b before adding it as a resize object
4088 * (this happens because the size of the window and the object are evaluated
4089 * as soon as the object is added to the window).
4091 * @param obj The window object
4092 * @param subobj The resize object to add
4094 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4096 * Delete @p subobj as a resize object of window @p obj.
4098 * This function removes the object @p subobj from the resize objects of
4099 * the window @p obj. It will not delete the object itself, which will be
4100 * left unmanaged and should be deleted by the developer, manually handled
4101 * or set as child of some other container.
4103 * @param obj The window object
4104 * @param subobj The resize object to add
4106 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4108 * Set the title of the window
4110 * @param obj The window object
4111 * @param title The title to set
4113 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4115 * Get the title of the window
4117 * The returned string is an internal one and should not be freed or
4118 * modified. It will also be rendered invalid if a new title is set or if
4119 * the window is destroyed.
4121 * @param obj The window object
4124 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4126 * Set the window's autodel state.
4128 * When closing the window in any way outside of the program control, like
4129 * pressing the X button in the titlebar or using a command from the
4130 * Window Manager, a "delete,request" signal is emitted to indicate that
4131 * this event occurred and the developer can take any action, which may
4132 * include, or not, destroying the window object.
4134 * When the @p autodel parameter is set, the window will be automatically
4135 * destroyed when this event occurs, after the signal is emitted.
4136 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4137 * and is up to the program to do so when it's required.
4139 * @param obj The window object
4140 * @param autodel If true, the window will automatically delete itself when
4143 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4145 * Get the window's autodel state.
4147 * @param obj The window object
4148 * @return If the window will automatically delete itself when closed
4150 * @see elm_win_autodel_set()
4152 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4154 * Activate a window object.
4156 * This function sends a request to the Window Manager to activate the
4157 * window pointed by @p obj. If honored by the WM, the window will receive
4158 * the keyboard focus.
4160 * @note This is just a request that a Window Manager may ignore, so calling
4161 * this function does not ensure in any way that the window will be the
4162 * active one after it.
4164 * @param obj The window object
4166 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4168 * Lower a window object.
4170 * Places the window pointed by @p obj at the bottom of the stack, so that
4171 * no other window is covered by it.
4173 * If elm_win_override_set() is not set, the Window Manager may ignore this
4176 * @param obj The window object
4178 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4180 * Raise a window object.
4182 * Places the window pointed by @p obj at the top of the stack, so that it's
4183 * not covered by any other window.
4185 * If elm_win_override_set() is not set, the Window Manager may ignore this
4188 * @param obj The window object
4190 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4192 * Set the borderless state of a window.
4194 * This function requests the Window Manager to not draw any decoration
4195 * around the window.
4197 * @param obj The window object
4198 * @param borderless If true, the window is borderless
4200 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4202 * Get the borderless state of a window.
4204 * @param obj The window object
4205 * @return If true, the window is borderless
4207 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4209 * Set the shaped state of a window.
4211 * Shaped windows, when supported, will render the parts of the window that
4212 * has no content, transparent.
4214 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4215 * background object or cover the entire window in any other way, or the
4216 * parts of the canvas that have no data will show framebuffer artifacts.
4218 * @param obj The window object
4219 * @param shaped If true, the window is shaped
4221 * @see elm_win_alpha_set()
4223 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4225 * Get the shaped state of a window.
4227 * @param obj The window object
4228 * @return If true, the window is shaped
4230 * @see elm_win_shaped_set()
4232 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4234 * Set the alpha channel state of a window.
4236 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4237 * possibly making parts of the window completely or partially transparent.
4238 * This is also subject to the underlying system supporting it, like for
4239 * example, running under a compositing manager. If no compositing is
4240 * available, enabling this option will instead fallback to using shaped
4241 * windows, with elm_win_shaped_set().
4243 * @param obj The window object
4244 * @param alpha If true, the window has an alpha channel
4246 * @see elm_win_alpha_set()
4248 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4250 * Get the transparency state of a window.
4252 * @param obj The window object
4253 * @return If true, the window is transparent
4255 * @see elm_win_transparent_set()
4257 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4259 * Set the transparency state of a window.
4261 * Use elm_win_alpha_set() instead.
4263 * @param obj The window object
4264 * @param transparent If true, the window is transparent
4266 * @see elm_win_alpha_set()
4268 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4270 * Get the alpha channel state of a window.
4272 * @param obj The window object
4273 * @return If true, the window has an alpha channel
4275 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4277 * Set the override state of a window.
4279 * A window with @p override set to EINA_TRUE will not be managed by the
4280 * Window Manager. This means that no decorations of any kind will be shown
4281 * for it, moving and resizing must be handled by the application, as well
4282 * as the window visibility.
4284 * This should not be used for normal windows, and even for not so normal
4285 * ones, it should only be used when there's a good reason and with a lot
4286 * of care. Mishandling override windows may result situations that
4287 * disrupt the normal workflow of the end user.
4289 * @param obj The window object
4290 * @param override If true, the window is overridden
4292 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4294 * Get the override state of a window.
4296 * @param obj The window object
4297 * @return If true, the window is overridden
4299 * @see elm_win_override_set()
4301 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4303 * Set the fullscreen state of a window.
4305 * @param obj The window object
4306 * @param fullscreen If true, the window is fullscreen
4308 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4310 * Get the fullscreen state of a window.
4312 * @param obj The window object
4313 * @return If true, the window is fullscreen
4315 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4317 * Set the maximized state of a window.
4319 * @param obj The window object
4320 * @param maximized If true, the window is maximized
4322 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4324 * Get the maximized state of a window.
4326 * @param obj The window object
4327 * @return If true, the window is maximized
4329 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4331 * Set the iconified state of a window.
4333 * @param obj The window object
4334 * @param iconified If true, the window is iconified
4336 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4338 * Get the iconified state of a window.
4340 * @param obj The window object
4341 * @return If true, the window is iconified
4343 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4345 * Set the layer of the window.
4347 * What this means exactly will depend on the underlying engine used.
4349 * In the case of X11 backed engines, the value in @p layer has the
4350 * following meanings:
4351 * @li < 3: The window will be placed below all others.
4352 * @li > 5: The window will be placed above all others.
4353 * @li other: The window will be placed in the default layer.
4355 * @param obj The window object
4356 * @param layer The layer of the window
4358 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4360 * Get the layer of the window.
4362 * @param obj The window object
4363 * @return The layer of the window
4365 * @see elm_win_layer_set()
4367 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4369 * Set the rotation of the window.
4371 * Most engines only work with multiples of 90.
4373 * This function is used to set the orientation of the window @p obj to
4374 * match that of the screen. The window itself will be resized to adjust
4375 * to the new geometry of its contents. If you want to keep the window size,
4376 * see elm_win_rotation_with_resize_set().
4378 * @param obj The window object
4379 * @param rotation The rotation of the window, in degrees (0-360),
4380 * counter-clockwise.
4382 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4384 * Rotates the window and resizes it.
4386 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4387 * that they fit inside the current window geometry.
4389 * @param obj The window object
4390 * @param layer The rotation of the window in degrees (0-360),
4391 * counter-clockwise.
4393 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4395 * Get the rotation of the window.
4397 * @param obj The window object
4398 * @return The rotation of the window in degrees (0-360)
4400 * @see elm_win_rotation_set()
4401 * @see elm_win_rotation_with_resize_set()
4403 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4405 * Set the sticky state of the window.
4407 * Hints the Window Manager that the window in @p obj should be left fixed
4408 * at its position even when the virtual desktop it's on moves or changes.
4410 * @param obj The window object
4411 * @param sticky If true, the window's sticky state is enabled
4413 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4415 * Get the sticky state of the window.
4417 * @param obj The window object
4418 * @return If true, the window's sticky state is enabled
4420 * @see elm_win_sticky_set()
4422 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4424 * Set if this window is an illume conformant window
4426 * @param obj The window object
4427 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4429 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4431 * Get if this window is an illume conformant window
4433 * @param obj The window object
4434 * @return A boolean if this window is illume conformant or not
4436 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4438 * Set a window to be an illume quickpanel window
4440 * By default window objects are not quickpanel windows.
4442 * @param obj The window object
4443 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4445 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4447 * Get if this window is a quickpanel or not
4449 * @param obj The window object
4450 * @return A boolean if this window is a quickpanel or not
4452 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4454 * Set the major priority of a quickpanel window
4456 * @param obj The window object
4457 * @param priority The major priority for this quickpanel
4459 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4461 * Get the major priority of a quickpanel window
4463 * @param obj The window object
4464 * @return The major priority of this quickpanel
4466 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4468 * Set the minor priority of a quickpanel window
4470 * @param obj The window object
4471 * @param priority The minor priority for this quickpanel
4473 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4475 * Get the minor priority of a quickpanel window
4477 * @param obj The window object
4478 * @return The minor priority of this quickpanel
4480 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4482 * Set which zone this quickpanel should appear in
4484 * @param obj The window object
4485 * @param zone The requested zone for this quickpanel
4487 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4489 * Get which zone this quickpanel should appear in
4491 * @param obj The window object
4492 * @return The requested zone for this quickpanel
4494 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4496 * Set the window to be skipped by keyboard focus
4498 * This sets the window to be skipped by normal keyboard input. This means
4499 * a window manager will be asked to not focus this window as well as omit
4500 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4502 * Call this and enable it on a window BEFORE you show it for the first time,
4503 * otherwise it may have no effect.
4505 * Use this for windows that have only output information or might only be
4506 * interacted with by the mouse or fingers, and never for typing input.
4507 * Be careful that this may have side-effects like making the window
4508 * non-accessible in some cases unless the window is specially handled. Use
4511 * @param obj The window object
4512 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4514 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4516 * Send a command to the windowing environment
4518 * This is intended to work in touchscreen or small screen device
4519 * environments where there is a more simplistic window management policy in
4520 * place. This uses the window object indicated to select which part of the
4521 * environment to control (the part that this window lives in), and provides
4522 * a command and an optional parameter structure (use NULL for this if not
4525 * @param obj The window object that lives in the environment to control
4526 * @param command The command to send
4527 * @param params Optional parameters for the command
4529 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4531 * Get the inlined image object handle
4533 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4534 * then the window is in fact an evas image object inlined in the parent
4535 * canvas. You can get this object (be careful to not manipulate it as it
4536 * is under control of elementary), and use it to do things like get pixel
4537 * data, save the image to a file, etc.
4539 * @param obj The window object to get the inlined image from
4540 * @return The inlined image object, or NULL if none exists
4542 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4544 * Determine whether a window has focus
4545 * @param obj The window to query
4546 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4548 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4550 * Get screen geometry details for the screen that a window is on
4551 * @param obj The window to query
4552 * @param x where to return the horizontal offset value. May be NULL.
4553 * @param y where to return the vertical offset value. May be NULL.
4554 * @param w where to return the width value. May be NULL.
4555 * @param h where to return the height value. May be NULL.
4557 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4559 * Set the enabled status for the focus highlight in a window
4561 * This function will enable or disable the focus highlight only for the
4562 * given window, regardless of the global setting for it
4564 * @param obj The window where to enable the highlight
4565 * @param enabled The enabled value for the highlight
4567 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4569 * Get the enabled value of the focus highlight for this window
4571 * @param obj The window in which to check if the focus highlight is enabled
4573 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4575 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4577 * Set the style for the focus highlight on this window
4579 * Sets the style to use for theming the highlight of focused objects on
4580 * the given window. If @p style is NULL, the default will be used.
4582 * @param obj The window where to set the style
4583 * @param style The style to set
4585 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4587 * Get the style set for the focus highlight object
4589 * Gets the style set for this windows highilght object, or NULL if none
4592 * @param obj The window to retrieve the highlights style from
4594 * @return The style set or NULL if none was. Default is used in that case.
4596 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4598 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4599 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4600 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4601 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4602 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4603 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4604 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4606 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4607 * (blank mouse, private mouse obj, defaultmouse)
4611 * Sets the keyboard mode of the window.
4613 * @param obj The window object
4614 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4616 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4618 * Gets the keyboard mode of the window.
4620 * @param obj The window object
4621 * @return The mode, one of #Elm_Win_Keyboard_Mode
4623 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4625 * Sets whether the window is a keyboard.
4627 * @param obj The window object
4628 * @param is_keyboard If true, the window is a virtual keyboard
4630 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4632 * Gets whether the window is a keyboard.
4634 * @param obj The window object
4635 * @return If the window is a virtual keyboard
4637 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4640 * Get the screen position of a window.
4642 * @param obj The window object
4643 * @param x The int to store the x coordinate to
4644 * @param y The int to store the y coordinate to
4646 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4652 * @defgroup Inwin Inwin
4654 * @image html img/widget/inwin/preview-00.png
4655 * @image latex img/widget/inwin/preview-00.eps
4656 * @image html img/widget/inwin/preview-01.png
4657 * @image latex img/widget/inwin/preview-01.eps
4658 * @image html img/widget/inwin/preview-02.png
4659 * @image latex img/widget/inwin/preview-02.eps
4661 * An inwin is a window inside a window that is useful for a quick popup.
4662 * It does not hover.
4664 * It works by creating an object that will occupy the entire window, so it
4665 * must be created using an @ref Win "elm_win" as parent only. The inwin
4666 * object can be hidden or restacked below every other object if it's
4667 * needed to show what's behind it without destroying it. If this is done,
4668 * the elm_win_inwin_activate() function can be used to bring it back to
4669 * full visibility again.
4671 * There are three styles available in the default theme. These are:
4672 * @li default: The inwin is sized to take over most of the window it's
4674 * @li minimal: The size of the inwin will be the minimum necessary to show
4676 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4677 * possible, but it's sized vertically the most it needs to fit its\
4680 * Some examples of Inwin can be found in the following:
4681 * @li @ref inwin_example_01
4686 * Adds an inwin to the current window
4688 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4689 * Never call this function with anything other than the top-most window
4690 * as its parameter, unless you are fond of undefined behavior.
4692 * After creating the object, the widget will set itself as resize object
4693 * for the window with elm_win_resize_object_add(), so when shown it will
4694 * appear to cover almost the entire window (how much of it depends on its
4695 * content and the style used). It must not be added into other container
4696 * objects and it needs not be moved or resized manually.
4698 * @param parent The parent object
4699 * @return The new object or NULL if it cannot be created
4701 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4703 * Activates an inwin object, ensuring its visibility
4705 * This function will make sure that the inwin @p obj is completely visible
4706 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4707 * to the front. It also sets the keyboard focus to it, which will be passed
4710 * The object's theme will also receive the signal "elm,action,show" with
4713 * @param obj The inwin to activate
4715 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4717 * Set the content of an inwin object.
4719 * Once the content object is set, a previously set one will be deleted.
4720 * If you want to keep that old content object, use the
4721 * elm_win_inwin_content_unset() function.
4723 * @param obj The inwin object
4724 * @param content The object to set as content
4726 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4728 * Get the content of an inwin object.
4730 * Return the content object which is set for this widget.
4732 * The returned object is valid as long as the inwin is still alive and no
4733 * other content is set on it. Deleting the object will notify the inwin
4734 * about it and this one will be left empty.
4736 * If you need to remove an inwin's content to be reused somewhere else,
4737 * see elm_win_inwin_content_unset().
4739 * @param obj The inwin object
4740 * @return The content that is being used
4742 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4744 * Unset the content of an inwin object.
4746 * Unparent and return the content object which was set for this widget.
4748 * @param obj The inwin object
4749 * @return The content that was being used
4751 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4755 /* X specific calls - won't work on non-x engines (return 0) */
4758 * Get the Ecore_X_Window of an Evas_Object
4760 * @param obj The object
4762 * @return The Ecore_X_Window of @p obj
4766 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4768 /* smart callbacks called:
4769 * "delete,request" - the user requested to delete the window
4770 * "focus,in" - window got focus
4771 * "focus,out" - window lost focus
4772 * "moved" - window that holds the canvas was moved
4778 * @image html img/widget/bg/preview-00.png
4779 * @image latex img/widget/bg/preview-00.eps
4781 * @brief Background object, used for setting a solid color, image or Edje
4782 * group as background to a window or any container object.
4784 * The bg object is used for setting a solid background to a window or
4785 * packing into any container object. It works just like an image, but has
4786 * some properties useful to a background, like setting it to tiled,
4787 * centered, scaled or stretched.
4789 * Default contents parts of the bg widget that you can use for are:
4790 * @li "overlay" - overlay of the bg
4792 * Here is some sample code using it:
4793 * @li @ref bg_01_example_page
4794 * @li @ref bg_02_example_page
4795 * @li @ref bg_03_example_page
4799 typedef enum _Elm_Bg_Option
4801 ELM_BG_OPTION_CENTER, /**< center the background */
4802 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4803 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4804 ELM_BG_OPTION_TILE /**< tile background at its original size */
4808 * Add a new background to the parent
4810 * @param parent The parent object
4811 * @return The new object or NULL if it cannot be created
4815 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4818 * Set the file (image or edje) used for the background
4820 * @param obj The bg object
4821 * @param file The file path
4822 * @param group Optional key (group in Edje) within the file
4824 * This sets the image file used in the background object. The image (or edje)
4825 * will be stretched (retaining aspect if its an image file) to completely fill
4826 * the bg object. This may mean some parts are not visible.
4828 * @note Once the image of @p obj is set, a previously set one will be deleted,
4829 * even if @p file is NULL.
4833 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4836 * Get the file (image or edje) used for the background
4838 * @param obj The bg object
4839 * @param file The file path
4840 * @param group Optional key (group in Edje) within the file
4844 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4847 * Set the option used for the background image
4849 * @param obj The bg object
4850 * @param option The desired background option (TILE, SCALE)
4852 * This sets the option used for manipulating the display of the background
4853 * image. The image can be tiled or scaled.
4857 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4860 * Get the option used for the background image
4862 * @param obj The bg object
4863 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4867 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4869 * Set the option used for the background color
4871 * @param obj The bg object
4876 * This sets the color used for the background rectangle. Its range goes
4881 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4883 * Get the option used for the background color
4885 * @param obj The bg object
4892 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4895 * Set the overlay object used for the background object.
4897 * @param obj The bg object
4898 * @param overlay The overlay object
4900 * This provides a way for elm_bg to have an 'overlay' that will be on top
4901 * of the bg. Once the over object is set, a previously set one will be
4902 * deleted, even if you set the new one to NULL. If you want to keep that
4903 * old content object, use the elm_bg_overlay_unset() function.
4905 * @deprecated use elm_object_part_content_set() instead
4910 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4913 * Get the overlay object used for the background object.
4915 * @param obj The bg object
4916 * @return The content that is being used
4918 * Return the content object which is set for this widget
4920 * @deprecated use elm_object_part_content_get() instead
4924 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4927 * Get the overlay object used for the background object.
4929 * @param obj The bg object
4930 * @return The content that was being used
4932 * Unparent and return the overlay object which was set for this widget
4934 * @deprecated use elm_object_part_content_unset() instead
4938 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4941 * Set the size of the pixmap representation of the image.
4943 * This option just makes sense if an image is going to be set in the bg.
4945 * @param obj The bg object
4946 * @param w The new width of the image pixmap representation.
4947 * @param h The new height of the image pixmap representation.
4949 * This function sets a new size for pixmap representation of the given bg
4950 * image. It allows the image to be loaded already in the specified size,
4951 * reducing the memory usage and load time when loading a big image with load
4952 * size set to a smaller size.
4954 * NOTE: this is just a hint, the real size of the pixmap may differ
4955 * depending on the type of image being loaded, being bigger than requested.
4959 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4960 /* smart callbacks called:
4964 * @defgroup Icon Icon
4966 * @image html img/widget/icon/preview-00.png
4967 * @image latex img/widget/icon/preview-00.eps
4969 * An object that provides standard icon images (delete, edit, arrows, etc.)
4970 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4972 * The icon image requested can be in the elementary theme, or in the
4973 * freedesktop.org paths. It's possible to set the order of preference from
4974 * where the image will be used.
4976 * This API is very similar to @ref Image, but with ready to use images.
4978 * Default images provided by the theme are described below.
4980 * The first list contains icons that were first intended to be used in
4981 * toolbars, but can be used in many other places too:
4997 * Now some icons that were designed to be used in menus (but again, you can
4998 * use them anywhere else):
5003 * @li menu/arrow_down
5004 * @li menu/arrow_left
5005 * @li menu/arrow_right
5014 * And here we have some media player specific icons:
5015 * @li media_player/forward
5016 * @li media_player/info
5017 * @li media_player/next
5018 * @li media_player/pause
5019 * @li media_player/play
5020 * @li media_player/prev
5021 * @li media_player/rewind
5022 * @li media_player/stop
5024 * Signals that you can add callbacks for are:
5026 * "clicked" - This is called when a user has clicked the icon
5028 * An example of usage for this API follows:
5029 * @li @ref tutorial_icon
5037 typedef enum _Elm_Icon_Type
5044 * @enum _Elm_Icon_Lookup_Order
5045 * @typedef Elm_Icon_Lookup_Order
5047 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5048 * theme, FDO paths, or both?
5052 typedef enum _Elm_Icon_Lookup_Order
5054 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5055 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5056 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
5057 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
5058 } Elm_Icon_Lookup_Order;
5061 * Add a new icon object to the parent.
5063 * @param parent The parent object
5064 * @return The new object or NULL if it cannot be created
5066 * @see elm_icon_file_set()
5070 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5072 * Set the file that will be used as icon.
5074 * @param obj The icon object
5075 * @param file The path to file that will be used as icon image
5076 * @param group The group that the icon belongs to an edje file
5078 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5080 * @note The icon image set by this function can be changed by
5081 * elm_icon_standard_set().
5083 * @see elm_icon_file_get()
5087 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5089 * Set a location in memory to be used as an icon
5091 * @param obj The icon object
5092 * @param img The binary data that will be used as an image
5093 * @param size The size of binary data @p img
5094 * @param format Optional format of @p img to pass to the image loader
5095 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5097 * The @p format string should be something like "png", "jpg", "tga",
5098 * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5099 * the loader performance as it tries the "correct" loader first before
5100 * trying a range of other possible loaders until one succeeds.
5102 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5104 * @note The icon image set by this function can be changed by
5105 * elm_icon_standard_set().
5109 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);
5111 * Get the file that will be used as icon.
5113 * @param obj The icon object
5114 * @param file The path to file that will be used as the icon image
5115 * @param group The group that the icon belongs to, in edje file
5117 * @see elm_icon_file_set()
5121 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5123 * Set the file that will be used, but use a generated thumbnail.
5125 * @param obj The icon object
5126 * @param file The path to file that will be used as icon image
5127 * @param group The group that the icon belongs to an edje file
5129 * This functions like elm_icon_file_set() but requires the Ethumb library
5130 * support to be enabled successfully with elm_need_ethumb(). When set
5131 * the file indicated has a thumbnail generated and cached on disk for
5132 * future use or will directly use an existing cached thumbnail if it
5135 * @see elm_icon_file_set()
5139 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5141 * Set the icon by icon standards names.
5143 * @param obj The icon object
5144 * @param name The icon name
5146 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5148 * For example, freedesktop.org defines standard icon names such as "home",
5149 * "network", etc. There can be different icon sets to match those icon
5150 * keys. The @p name given as parameter is one of these "keys", and will be
5151 * used to look in the freedesktop.org paths and elementary theme. One can
5152 * change the lookup order with elm_icon_order_lookup_set().
5154 * If name is not found in any of the expected locations and it is the
5155 * absolute path of an image file, this image will be used.
5157 * @note The icon image set by this function can be changed by
5158 * elm_icon_file_set().
5160 * @see elm_icon_standard_get()
5161 * @see elm_icon_file_set()
5165 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5167 * Get the icon name set by icon standard names.
5169 * @param obj The icon object
5170 * @return The icon name
5172 * If the icon image was set using elm_icon_file_set() instead of
5173 * elm_icon_standard_set(), then this function will return @c NULL.
5175 * @see elm_icon_standard_set()
5179 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5181 * Set the smooth scaling for an icon object.
5183 * @param obj The icon object
5184 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5185 * otherwise. Default is @c EINA_TRUE.
5187 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5188 * scaling provides a better resulting image, but is slower.
5190 * The smooth scaling should be disabled when making animations that change
5191 * the icon size, since they will be faster. Animations that don't require
5192 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5193 * is already scaled, since the scaled icon image will be cached).
5195 * @see elm_icon_smooth_get()
5199 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5201 * Get whether smooth scaling is enabled for an icon object.
5203 * @param obj The icon object
5204 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5206 * @see elm_icon_smooth_set()
5210 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5212 * Disable scaling of this object.
5214 * @param obj The icon object.
5215 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5216 * otherwise. Default is @c EINA_FALSE.
5218 * This function disables scaling of the icon object through the function
5219 * elm_object_scale_set(). However, this does not affect the object
5220 * size/resize in any way. For that effect, take a look at
5221 * elm_icon_scale_set().
5223 * @see elm_icon_no_scale_get()
5224 * @see elm_icon_scale_set()
5225 * @see elm_object_scale_set()
5229 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5231 * Get whether scaling is disabled on the object.
5233 * @param obj The icon object
5234 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5236 * @see elm_icon_no_scale_set()
5240 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5242 * Set if the object is (up/down) resizable.
5244 * @param obj The icon object
5245 * @param scale_up A bool to set if the object is resizable up. Default is
5247 * @param scale_down A bool to set if the object is resizable down. Default
5250 * This function limits the icon object resize ability. If @p scale_up is set to
5251 * @c EINA_FALSE, the object can't have its height or width resized to a value
5252 * higher than the original icon size. Same is valid for @p scale_down.
5254 * @see elm_icon_scale_get()
5258 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5260 * Get if the object is (up/down) resizable.
5262 * @param obj The icon object
5263 * @param scale_up A bool to set if the object is resizable up
5264 * @param scale_down A bool to set if the object is resizable down
5266 * @see elm_icon_scale_set()
5270 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5272 * Get the object's image size
5274 * @param obj The icon object
5275 * @param w A pointer to store the width in
5276 * @param h A pointer to store the height in
5280 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5282 * Set if the icon fill the entire object area.
5284 * @param obj The icon object
5285 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5286 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5288 * When the icon object is resized to a different aspect ratio from the
5289 * original icon image, the icon image will still keep its aspect. This flag
5290 * tells how the image should fill the object's area. They are: keep the
5291 * entire icon inside the limits of height and width of the object (@p
5292 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5293 * of the object, and the icon will fill the entire object (@p fill_outside
5296 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5297 * retain property to false. Thus, the icon image will always keep its
5298 * original aspect ratio.
5300 * @see elm_icon_fill_outside_get()
5301 * @see elm_image_fill_outside_set()
5305 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5307 * Get if the object is filled outside.
5309 * @param obj The icon object
5310 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5312 * @see elm_icon_fill_outside_set()
5316 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5318 * Set the prescale size for the icon.
5320 * @param obj The icon object
5321 * @param size The prescale size. This value is used for both width and
5324 * This function sets a new size for pixmap representation of the given
5325 * icon. It allows the icon to be loaded already in the specified size,
5326 * reducing the memory usage and load time when loading a big icon with load
5327 * size set to a smaller size.
5329 * It's equivalent to the elm_bg_load_size_set() function for bg.
5331 * @note this is just a hint, the real size of the pixmap may differ
5332 * depending on the type of icon being loaded, being bigger than requested.
5334 * @see elm_icon_prescale_get()
5335 * @see elm_bg_load_size_set()
5339 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5341 * Get the prescale size for the icon.
5343 * @param obj The icon object
5344 * @return The prescale size
5346 * @see elm_icon_prescale_set()
5350 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5352 * Gets the image object of the icon. DO NOT MODIFY THIS.
5354 * @param obj The icon object
5355 * @return The internal icon object
5359 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5361 * Sets the icon lookup order used by elm_icon_standard_set().
5363 * @param obj The icon object
5364 * @param order The icon lookup order (can be one of
5365 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5366 * or ELM_ICON_LOOKUP_THEME)
5368 * @see elm_icon_order_lookup_get()
5369 * @see Elm_Icon_Lookup_Order
5373 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5375 * Gets the icon lookup order.
5377 * @param obj The icon object
5378 * @return The icon lookup order
5380 * @see elm_icon_order_lookup_set()
5381 * @see Elm_Icon_Lookup_Order
5385 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5387 * Enable or disable preloading of the icon
5389 * @param obj The icon object
5390 * @param disable If EINA_TRUE, preloading will be disabled
5393 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5395 * Get if the icon supports animation or not.
5397 * @param obj The icon object
5398 * @return @c EINA_TRUE if the icon supports animation,
5399 * @c EINA_FALSE otherwise.
5401 * Return if this elm icon's image can be animated. Currently Evas only
5402 * supports gif animation. If the return value is EINA_FALSE, other
5403 * elm_icon_animated_XXX APIs won't work.
5406 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5408 * Set animation mode of the icon.
5410 * @param obj The icon object
5411 * @param anim @c EINA_TRUE if the object do animation job,
5412 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5414 * Since the default animation mode is set to EINA_FALSE,
5415 * the icon is shown without animation. Files like animated GIF files
5416 * can animate, and this is supported if you enable animated support
5418 * Set it to EINA_TRUE when the icon needs to be animated.
5421 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5423 * Get animation mode of the icon.
5425 * @param obj The icon object
5426 * @return The animation mode of the icon object
5427 * @see elm_icon_animated_set
5430 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5432 * Set animation play mode of the icon.
5434 * @param obj The icon object
5435 * @param play @c EINA_TRUE the object play animation images,
5436 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5438 * To play elm icon's animation, set play to EINA_TURE.
5439 * For example, you make gif player using this set/get API and click event.
5440 * This literally lets you control current play or paused state. To have
5441 * this work with animated GIF files for example, you first, before
5442 * setting the file have to use elm_icon_animated_set() to enable animation
5443 * at all on the icon.
5445 * 1. Click event occurs
5446 * 2. Check play flag using elm_icon_animaged_play_get
5447 * 3. If elm icon was playing, set play to EINA_FALSE.
5448 * Then animation will be stopped and vice versa
5451 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5453 * Get animation play mode of the icon.
5455 * @param obj The icon object
5456 * @return The play mode of the icon object
5458 * @see elm_icon_animated_play_get
5461 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5468 * @defgroup Image Image
5470 * @image html img/widget/image/preview-00.png
5471 * @image latex img/widget/image/preview-00.eps
5474 * An object that allows one to load an image file to it. It can be used
5475 * anywhere like any other elementary widget.
5477 * This widget provides most of the functionality provided from @ref Bg or @ref
5478 * Icon, but with a slightly different API (use the one that fits better your
5481 * The features not provided by those two other image widgets are:
5482 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5483 * @li change the object orientation with elm_image_orient_set();
5484 * @li and turning the image editable with elm_image_editable_set().
5486 * Signals that you can add callbacks for are:
5488 * @li @c "clicked" - This is called when a user has clicked the image
5490 * An example of usage for this API follows:
5491 * @li @ref tutorial_image
5500 * @enum _Elm_Image_Orient
5501 * @typedef Elm_Image_Orient
5503 * Possible orientation options for elm_image_orient_set().
5505 * @image html elm_image_orient_set.png
5506 * @image latex elm_image_orient_set.eps width=\textwidth
5510 typedef enum _Elm_Image_Orient
5512 ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5513 ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5514 ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5515 ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5516 ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5517 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5518 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5519 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5520 ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5521 ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5522 ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5523 ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5527 * Add a new image to the parent.
5529 * @param parent The parent object
5530 * @return The new object or NULL if it cannot be created
5532 * @see elm_image_file_set()
5536 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5538 * Set the file that will be used as image.
5540 * @param obj The image object
5541 * @param file The path to file that will be used as image
5542 * @param group The group that the image belongs in edje file (if it's an
5545 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5547 * @see elm_image_file_get()
5551 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5553 * Get the file that will be used as image.
5555 * @param obj The image object
5556 * @param file The path to file
5557 * @param group The group that the image belongs in edje file
5559 * @see elm_image_file_set()
5563 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5565 * Set the smooth effect for an image.
5567 * @param obj The image object
5568 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5569 * otherwise. Default is @c EINA_TRUE.
5571 * Set the scaling algorithm to be used when scaling the image. Smooth
5572 * scaling provides a better resulting image, but is slower.
5574 * The smooth scaling should be disabled when making animations that change
5575 * the image size, since it will be faster. Animations that don't require
5576 * resizing of the image can keep the smooth scaling enabled (even if the
5577 * image is already scaled, since the scaled image will be cached).
5579 * @see elm_image_smooth_get()
5583 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5585 * Get the smooth effect for an image.
5587 * @param obj The image object
5588 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5590 * @see elm_image_smooth_get()
5594 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5597 * Gets the current size of the image.
5599 * @param obj The image object.
5600 * @param w Pointer to store width, or NULL.
5601 * @param h Pointer to store height, or NULL.
5603 * This is the real size of the image, not the size of the object.
5605 * On error, neither w and h will be fileld with 0.
5609 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5611 * Disable scaling of this object.
5613 * @param obj The image object.
5614 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5615 * otherwise. Default is @c EINA_FALSE.
5617 * This function disables scaling of the elm_image widget through the
5618 * function elm_object_scale_set(). However, this does not affect the widget
5619 * size/resize in any way. For that effect, take a look at
5620 * elm_image_scale_set().
5622 * @see elm_image_no_scale_get()
5623 * @see elm_image_scale_set()
5624 * @see elm_object_scale_set()
5628 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5630 * Get whether scaling is disabled on the object.
5632 * @param obj The image object
5633 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5635 * @see elm_image_no_scale_set()
5639 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5641 * Set if the object is (up/down) resizable.
5643 * @param obj The image object
5644 * @param scale_up A bool to set if the object is resizable up. Default is
5646 * @param scale_down A bool to set if the object is resizable down. Default
5649 * This function limits the image resize ability. If @p scale_up is set to
5650 * @c EINA_FALSE, the object can't have its height or width resized to a value
5651 * higher than the original image size. Same is valid for @p scale_down.
5653 * @see elm_image_scale_get()
5657 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5659 * Get if the object is (up/down) resizable.
5661 * @param obj The image object
5662 * @param scale_up A bool to set if the object is resizable up
5663 * @param scale_down A bool to set if the object is resizable down
5665 * @see elm_image_scale_set()
5669 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5671 * Set if the image fills the entire object area, when keeping the aspect ratio.
5673 * @param obj The image object
5674 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5675 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5677 * When the image should keep its aspect ratio even if resized to another
5678 * aspect ratio, there are two possibilities to resize it: keep the entire
5679 * image inside the limits of height and width of the object (@p fill_outside
5680 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5681 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5683 * @note This option will have no effect if
5684 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5686 * @see elm_image_fill_outside_get()
5687 * @see elm_image_aspect_ratio_retained_set()
5691 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5693 * Get if the object is filled outside
5695 * @param obj The image object
5696 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5698 * @see elm_image_fill_outside_set()
5702 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5704 * Set the prescale size for the image
5706 * @param obj The image object
5707 * @param size The prescale size. This value is used for both width and
5710 * This function sets a new size for pixmap representation of the given
5711 * image. It allows the image to be loaded already in the specified size,
5712 * reducing the memory usage and load time when loading a big image with load
5713 * size set to a smaller size.
5715 * It's equivalent to the elm_bg_load_size_set() function for bg.
5717 * @note this is just a hint, the real size of the pixmap may differ
5718 * depending on the type of image being loaded, being bigger than requested.
5720 * @see elm_image_prescale_get()
5721 * @see elm_bg_load_size_set()
5725 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5727 * Get the prescale size for the image
5729 * @param obj The image object
5730 * @return The prescale size
5732 * @see elm_image_prescale_set()
5736 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5738 * Set the image orientation.
5740 * @param obj The image object
5741 * @param orient The image orientation @ref Elm_Image_Orient
5742 * Default is #ELM_IMAGE_ORIENT_NONE.
5744 * This function allows to rotate or flip the given image.
5746 * @see elm_image_orient_get()
5747 * @see @ref Elm_Image_Orient
5751 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5753 * Get the image orientation.
5755 * @param obj The image object
5756 * @return The image orientation @ref Elm_Image_Orient
5758 * @see elm_image_orient_set()
5759 * @see @ref Elm_Image_Orient
5763 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5765 * Make the image 'editable'.
5767 * @param obj Image object.
5768 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5770 * This means the image is a valid drag target for drag and drop, and can be
5771 * cut or pasted too.
5775 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5777 * Check if the image 'editable'.
5779 * @param obj Image object.
5780 * @return Editability.
5782 * A return value of EINA_TRUE means the image is a valid drag target
5783 * for drag and drop, and can be cut or pasted too.
5787 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5789 * Get the basic Evas_Image object from this object (widget).
5791 * @param obj The image object to get the inlined image from
5792 * @return The inlined image object, or NULL if none exists
5794 * This function allows one to get the underlying @c Evas_Object of type
5795 * Image from this elementary widget. It can be useful to do things like get
5796 * the pixel data, save the image to a file, etc.
5798 * @note Be careful to not manipulate it, as it is under control of
5803 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5805 * Set whether the original aspect ratio of the image should be kept on resize.
5807 * @param obj The image object.
5808 * @param retained @c EINA_TRUE if the image should retain the aspect,
5809 * @c EINA_FALSE otherwise.
5811 * The original aspect ratio (width / height) of the image is usually
5812 * distorted to match the object's size. Enabling this option will retain
5813 * this original aspect, and the way that the image is fit into the object's
5814 * area depends on the option set by elm_image_fill_outside_set().
5816 * @see elm_image_aspect_ratio_retained_get()
5817 * @see elm_image_fill_outside_set()
5821 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5823 * Get if the object retains the original aspect ratio.
5825 * @param obj The image object.
5826 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5831 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5841 * @image html img/widget/box/preview-00.png
5842 * @image latex img/widget/box/preview-00.eps width=\textwidth
5844 * @image html img/box.png
5845 * @image latex img/box.eps width=\textwidth
5847 * A box arranges objects in a linear fashion, governed by a layout function
5848 * that defines the details of this arrangement.
5850 * By default, the box will use an internal function to set the layout to
5851 * a single row, either vertical or horizontal. This layout is affected
5852 * by a number of parameters, such as the homogeneous flag set by
5853 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5854 * elm_box_align_set() and the hints set to each object in the box.
5856 * For this default layout, it's possible to change the orientation with
5857 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5858 * placing its elements ordered from top to bottom. When horizontal is set,
5859 * the order will go from left to right. If the box is set to be
5860 * homogeneous, every object in it will be assigned the same space, that
5861 * of the largest object. Padding can be used to set some spacing between
5862 * the cell given to each object. The alignment of the box, set with
5863 * elm_box_align_set(), determines how the bounding box of all the elements
5864 * will be placed within the space given to the box widget itself.
5866 * The size hints of each object also affect how they are placed and sized
5867 * within the box. evas_object_size_hint_min_set() will give the minimum
5868 * size the object can have, and the box will use it as the basis for all
5869 * latter calculations. Elementary widgets set their own minimum size as
5870 * needed, so there's rarely any need to use it manually.
5872 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5873 * used to tell whether the object will be allocated the minimum size it
5874 * needs or if the space given to it should be expanded. It's important
5875 * to realize that expanding the size given to the object is not the same
5876 * thing as resizing the object. It could very well end being a small
5877 * widget floating in a much larger empty space. If not set, the weight
5878 * for objects will normally be 0.0 for both axis, meaning the widget will
5879 * not be expanded. To take as much space possible, set the weight to
5880 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5882 * Besides how much space each object is allocated, it's possible to control
5883 * how the widget will be placed within that space using
5884 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5885 * for both axis, meaning the object will be centered, but any value from
5886 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5887 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5888 * is -1.0, means the object will be resized to fill the entire space it
5891 * In addition, customized functions to define the layout can be set, which
5892 * allow the application developer to organize the objects within the box
5893 * in any number of ways.
5895 * The special elm_box_layout_transition() function can be used
5896 * to switch from one layout to another, animating the motion of the
5897 * children of the box.
5899 * @note Objects should not be added to box objects using _add() calls.
5901 * Some examples on how to use boxes follow:
5902 * @li @ref box_example_01
5903 * @li @ref box_example_02
5908 * @typedef Elm_Box_Transition
5910 * Opaque handler containing the parameters to perform an animated
5911 * transition of the layout the box uses.
5913 * @see elm_box_transition_new()
5914 * @see elm_box_layout_set()
5915 * @see elm_box_layout_transition()
5917 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5920 * Add a new box to the parent
5922 * By default, the box will be in vertical mode and non-homogeneous.
5924 * @param parent The parent object
5925 * @return The new object or NULL if it cannot be created
5927 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5929 * Set the horizontal orientation
5931 * By default, box object arranges their contents vertically from top to
5933 * By calling this function with @p horizontal as EINA_TRUE, the box will
5934 * become horizontal, arranging contents from left to right.
5936 * @note This flag is ignored if a custom layout function is set.
5938 * @param obj The box object
5939 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5940 * EINA_FALSE = vertical)
5942 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5944 * Get the horizontal orientation
5946 * @param obj The box object
5947 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5949 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5951 * Set the box to arrange its children homogeneously
5953 * If enabled, homogeneous layout makes all items the same size, according
5954 * to the size of the largest of its children.
5956 * @note This flag is ignored if a custom layout function is set.
5958 * @param obj The box object
5959 * @param homogeneous The homogeneous flag
5961 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5963 * Get whether the box is using homogeneous mode or not
5965 * @param obj The box object
5966 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5968 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5970 * Add an object to the beginning of the pack list
5972 * Pack @p subobj into the box @p obj, placing it first in the list of
5973 * children objects. The actual position the object will get on screen
5974 * depends on the layout used. If no custom layout is set, it will be at
5975 * the top or left, depending if the box is vertical or horizontal,
5978 * @param obj The box object
5979 * @param subobj The object to add to the box
5981 * @see elm_box_pack_end()
5982 * @see elm_box_pack_before()
5983 * @see elm_box_pack_after()
5984 * @see elm_box_unpack()
5985 * @see elm_box_unpack_all()
5986 * @see elm_box_clear()
5988 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5990 * Add an object at the end of the pack list
5992 * Pack @p subobj into the box @p obj, placing it last in the list of
5993 * children objects. The actual position the object will get on screen
5994 * depends on the layout used. If no custom layout is set, it will be at
5995 * the bottom or right, depending if the box is vertical or horizontal,
5998 * @param obj The box object
5999 * @param subobj The object to add to the box
6001 * @see elm_box_pack_start()
6002 * @see elm_box_pack_before()
6003 * @see elm_box_pack_after()
6004 * @see elm_box_unpack()
6005 * @see elm_box_unpack_all()
6006 * @see elm_box_clear()
6008 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6010 * Adds an object to the box before the indicated object
6012 * This will add the @p subobj to the box indicated before the object
6013 * indicated with @p before. If @p before is not already in the box, results
6014 * are undefined. Before means either to the left of the indicated object or
6015 * above it depending on orientation.
6017 * @param obj The box object
6018 * @param subobj The object to add to the box
6019 * @param before The object before which to add it
6021 * @see elm_box_pack_start()
6022 * @see elm_box_pack_end()
6023 * @see elm_box_pack_after()
6024 * @see elm_box_unpack()
6025 * @see elm_box_unpack_all()
6026 * @see elm_box_clear()
6028 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6030 * Adds an object to the box after the indicated object
6032 * This will add the @p subobj to the box indicated after the object
6033 * indicated with @p after. If @p after is not already in the box, results
6034 * are undefined. After means either to the right of the indicated object or
6035 * below it depending on orientation.
6037 * @param obj The box object
6038 * @param subobj The object to add to the box
6039 * @param after The object after which to add it
6041 * @see elm_box_pack_start()
6042 * @see elm_box_pack_end()
6043 * @see elm_box_pack_before()
6044 * @see elm_box_unpack()
6045 * @see elm_box_unpack_all()
6046 * @see elm_box_clear()
6048 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6050 * Clear the box of all children
6052 * Remove all the elements contained by the box, deleting the respective
6055 * @param obj The box object
6057 * @see elm_box_unpack()
6058 * @see elm_box_unpack_all()
6060 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6064 * Remove the object given by @p subobj from the box @p obj without
6067 * @param obj The box object
6069 * @see elm_box_unpack_all()
6070 * @see elm_box_clear()
6072 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6074 * Remove all items from the box, without deleting them
6076 * Clear the box from all children, but don't delete the respective objects.
6077 * If no other references of the box children exist, the objects will never
6078 * be deleted, and thus the application will leak the memory. Make sure
6079 * when using this function that you hold a reference to all the objects
6080 * in the box @p obj.
6082 * @param obj The box object
6084 * @see elm_box_clear()
6085 * @see elm_box_unpack()
6087 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6089 * Retrieve a list of the objects packed into the box
6091 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6092 * The order of the list corresponds to the packing order the box uses.
6094 * You must free this list with eina_list_free() once you are done with it.
6096 * @param obj The box object
6098 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6100 * Set the space (padding) between the box's elements.
6102 * Extra space in pixels that will be added between a box child and its
6103 * neighbors after its containing cell has been calculated. This padding
6104 * is set for all elements in the box, besides any possible padding that
6105 * individual elements may have through their size hints.
6107 * @param obj The box object
6108 * @param horizontal The horizontal space between elements
6109 * @param vertical The vertical space between elements
6111 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6113 * Get the space (padding) between the box's elements.
6115 * @param obj The box object
6116 * @param horizontal The horizontal space between elements
6117 * @param vertical The vertical space between elements
6119 * @see elm_box_padding_set()
6121 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6123 * Set the alignment of the whole bouding box of contents.
6125 * Sets how the bounding box containing all the elements of the box, after
6126 * their sizes and position has been calculated, will be aligned within
6127 * the space given for the whole box widget.
6129 * @param obj The box object
6130 * @param horizontal The horizontal alignment of elements
6131 * @param vertical The vertical alignment of elements
6133 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6135 * Get the alignment of the whole bouding box of contents.
6137 * @param obj The box object
6138 * @param horizontal The horizontal alignment of elements
6139 * @param vertical The vertical alignment of elements
6141 * @see elm_box_align_set()
6143 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6146 * Force the box to recalculate its children packing.
6148 * If any children was added or removed, box will not calculate the
6149 * values immediately rather leaving it to the next main loop
6150 * iteration. While this is great as it would save lots of
6151 * recalculation, whenever you need to get the position of a just
6152 * added item you must force recalculate before doing so.
6154 * @param obj The box object.
6156 EAPI void elm_box_recalculate(Evas_Object *obj);
6159 * Set the layout defining function to be used by the box
6161 * Whenever anything changes that requires the box in @p obj to recalculate
6162 * the size and position of its elements, the function @p cb will be called
6163 * to determine what the layout of the children will be.
6165 * Once a custom function is set, everything about the children layout
6166 * is defined by it. The flags set by elm_box_horizontal_set() and
6167 * elm_box_homogeneous_set() no longer have any meaning, and the values
6168 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6169 * layout function to decide if they are used and how. These last two
6170 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6171 * passed to @p cb. The @c Evas_Object the function receives is not the
6172 * Elementary widget, but the internal Evas Box it uses, so none of the
6173 * functions described here can be used on it.
6175 * Any of the layout functions in @c Evas can be used here, as well as the
6176 * special elm_box_layout_transition().
6178 * The final @p data argument received by @p cb is the same @p data passed
6179 * here, and the @p free_data function will be called to free it
6180 * whenever the box is destroyed or another layout function is set.
6182 * Setting @p cb to NULL will revert back to the default layout function.
6184 * @param obj The box object
6185 * @param cb The callback function used for layout
6186 * @param data Data that will be passed to layout function
6187 * @param free_data Function called to free @p data
6189 * @see elm_box_layout_transition()
6191 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);
6193 * Special layout function that animates the transition from one layout to another
6195 * Normally, when switching the layout function for a box, this will be
6196 * reflected immediately on screen on the next render, but it's also
6197 * possible to do this through an animated transition.
6199 * This is done by creating an ::Elm_Box_Transition and setting the box
6200 * layout to this function.
6204 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6205 * evas_object_box_layout_vertical, // start
6206 * NULL, // data for initial layout
6207 * NULL, // free function for initial data
6208 * evas_object_box_layout_horizontal, // end
6209 * NULL, // data for final layout
6210 * NULL, // free function for final data
6211 * anim_end, // will be called when animation ends
6212 * NULL); // data for anim_end function\
6213 * elm_box_layout_set(box, elm_box_layout_transition, t,
6214 * elm_box_transition_free);
6217 * @note This function can only be used with elm_box_layout_set(). Calling
6218 * it directly will not have the expected results.
6220 * @see elm_box_transition_new
6221 * @see elm_box_transition_free
6222 * @see elm_box_layout_set
6224 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6226 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6228 * If you want to animate the change from one layout to another, you need
6229 * to set the layout function of the box to elm_box_layout_transition(),
6230 * passing as user data to it an instance of ::Elm_Box_Transition with the
6231 * necessary information to perform this animation. The free function to
6232 * set for the layout is elm_box_transition_free().
6234 * The parameters to create an ::Elm_Box_Transition sum up to how long
6235 * will it be, in seconds, a layout function to describe the initial point,
6236 * another for the final position of the children and one function to be
6237 * called when the whole animation ends. This last function is useful to
6238 * set the definitive layout for the box, usually the same as the end
6239 * layout for the animation, but could be used to start another transition.
6241 * @param start_layout The layout function that will be used to start the animation
6242 * @param start_layout_data The data to be passed the @p start_layout function
6243 * @param start_layout_free_data Function to free @p start_layout_data
6244 * @param end_layout The layout function that will be used to end the animation
6245 * @param end_layout_free_data The data to be passed the @p end_layout function
6246 * @param end_layout_free_data Function to free @p end_layout_data
6247 * @param transition_end_cb Callback function called when animation ends
6248 * @param transition_end_data Data to be passed to @p transition_end_cb
6249 * @return An instance of ::Elm_Box_Transition
6251 * @see elm_box_transition_new
6252 * @see elm_box_layout_transition
6254 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);
6256 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6258 * This function is mostly useful as the @c free_data parameter in
6259 * elm_box_layout_set() when elm_box_layout_transition().
6261 * @param data The Elm_Box_Transition instance to be freed.
6263 * @see elm_box_transition_new
6264 * @see elm_box_layout_transition
6266 EAPI void elm_box_transition_free(void *data);
6273 * @defgroup Button Button
6275 * @image html img/widget/button/preview-00.png
6276 * @image latex img/widget/button/preview-00.eps
6277 * @image html img/widget/button/preview-01.png
6278 * @image latex img/widget/button/preview-01.eps
6279 * @image html img/widget/button/preview-02.png
6280 * @image latex img/widget/button/preview-02.eps
6282 * This is a push-button. Press it and run some function. It can contain
6283 * a simple label and icon object and it also has an autorepeat feature.
6285 * This widgets emits the following signals:
6286 * @li "clicked": the user clicked the button (press/release).
6287 * @li "repeated": the user pressed the button without releasing it.
6288 * @li "pressed": button was pressed.
6289 * @li "unpressed": button was released after being pressed.
6290 * In all three cases, the @c event parameter of the callback will be
6293 * Also, defined in the default theme, the button has the following styles
6295 * @li default: a normal button.
6296 * @li anchor: Like default, but the button fades away when the mouse is not
6297 * over it, leaving only the text or icon.
6298 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6299 * continuous look across its options.
6300 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6302 * Default contents parts of the button widget that you can use for are:
6303 * @li "icon" - An icon of the button
6305 * Default text parts of the button widget that you can use for are:
6306 * @li "default" - Label of the button
6308 * Follow through a complete example @ref button_example_01 "here".
6312 * Add a new button to the parent's canvas
6314 * @param parent The parent object
6315 * @return The new object or NULL if it cannot be created
6317 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6319 * Set the label used in the button
6321 * The passed @p label can be NULL to clean any existing text in it and
6322 * leave the button as an icon only object.
6324 * @param obj The button object
6325 * @param label The text will be written on the button
6326 * @deprecated use elm_object_text_set() instead.
6328 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6330 * Get the label set for the button
6332 * The string returned is an internal pointer and should not be freed or
6333 * altered. It will also become invalid when the button is destroyed.
6334 * The string returned, if not NULL, is a stringshare, so if you need to
6335 * keep it around even after the button is destroyed, you can use
6336 * eina_stringshare_ref().
6338 * @param obj The button object
6339 * @return The text set to the label, or NULL if nothing is set
6340 * @deprecated use elm_object_text_set() instead.
6342 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6344 * Set the icon used for the button
6346 * Setting a new icon will delete any other that was previously set, making
6347 * any reference to them invalid. If you need to maintain the previous
6348 * object alive, unset it first with elm_button_icon_unset().
6350 * @param obj The button object
6351 * @param icon The icon object for the button
6352 * @deprecated use elm_object_part_content_set() instead.
6354 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6356 * Get the icon used for the button
6358 * Return the icon object which is set for this widget. If the button is
6359 * destroyed or another icon is set, the returned object will be deleted
6360 * and any reference to it will be invalid.
6362 * @param obj The button object
6363 * @return The icon object that is being used
6365 * @deprecated use elm_object_part_content_get() instead
6367 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6369 * Remove the icon set without deleting it and return the object
6371 * This function drops the reference the button holds of the icon object
6372 * and returns this last object. It is used in case you want to remove any
6373 * icon, or set another one, without deleting the actual object. The button
6374 * will be left without an icon set.
6376 * @param obj The button object
6377 * @return The icon object that was being used
6378 * @deprecated use elm_object_part_content_unset() instead.
6380 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6382 * Turn on/off the autorepeat event generated when the button is kept pressed
6384 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6385 * signal when they are clicked.
6387 * When on, keeping a button pressed will continuously emit a @c repeated
6388 * signal until the button is released. The time it takes until it starts
6389 * emitting the signal is given by
6390 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6391 * new emission by elm_button_autorepeat_gap_timeout_set().
6393 * @param obj The button object
6394 * @param on A bool to turn on/off the event
6396 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6398 * Get whether the autorepeat feature is enabled
6400 * @param obj The button object
6401 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6403 * @see elm_button_autorepeat_set()
6405 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6407 * Set the initial timeout before the autorepeat event is generated
6409 * Sets the timeout, in seconds, since the button is pressed until the
6410 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6411 * won't be any delay and the even will be fired the moment the button is
6414 * @param obj The button object
6415 * @param t Timeout in seconds
6417 * @see elm_button_autorepeat_set()
6418 * @see elm_button_autorepeat_gap_timeout_set()
6420 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6422 * Get the initial timeout before the autorepeat event is generated
6424 * @param obj The button object
6425 * @return Timeout in seconds
6427 * @see elm_button_autorepeat_initial_timeout_set()
6429 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6431 * Set the interval between each generated autorepeat event
6433 * After the first @c repeated event is fired, all subsequent ones will
6434 * follow after a delay of @p t seconds for each.
6436 * @param obj The button object
6437 * @param t Interval in seconds
6439 * @see elm_button_autorepeat_initial_timeout_set()
6441 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6443 * Get the interval between each generated autorepeat event
6445 * @param obj The button object
6446 * @return Interval in seconds
6448 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6454 * @defgroup File_Selector_Button File Selector Button
6456 * @image html img/widget/fileselector_button/preview-00.png
6457 * @image latex img/widget/fileselector_button/preview-00.eps
6458 * @image html img/widget/fileselector_button/preview-01.png
6459 * @image latex img/widget/fileselector_button/preview-01.eps
6460 * @image html img/widget/fileselector_button/preview-02.png
6461 * @image latex img/widget/fileselector_button/preview-02.eps
6463 * This is a button that, when clicked, creates an Elementary
6464 * window (or inner window) <b> with a @ref Fileselector "file
6465 * selector widget" within</b>. When a file is chosen, the (inner)
6466 * window is closed and the button emits a signal having the
6467 * selected file as it's @c event_info.
6469 * This widget encapsulates operations on its internal file
6470 * selector on its own API. There is less control over its file
6471 * selector than that one would have instatiating one directly.
6473 * The following styles are available for this button:
6476 * @li @c "hoversel_vertical"
6477 * @li @c "hoversel_vertical_entry"
6479 * Smart callbacks one can register to:
6480 * - @c "file,chosen" - the user has selected a path, whose string
6481 * pointer comes as the @c event_info data (a stringshared
6484 * Here is an example on its usage:
6485 * @li @ref fileselector_button_example
6487 * @see @ref File_Selector_Entry for a similar widget.
6492 * Add a new file selector button widget to the given parent
6493 * Elementary (container) object
6495 * @param parent The parent object
6496 * @return a new file selector button widget handle or @c NULL, on
6499 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6502 * Set the label for a given file selector button widget
6504 * @param obj The file selector button widget
6505 * @param label The text label to be displayed on @p obj
6507 * @deprecated use elm_object_text_set() instead.
6509 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6512 * Get the label set for a given file selector button widget
6514 * @param obj The file selector button widget
6515 * @return The button label
6517 * @deprecated use elm_object_text_set() instead.
6519 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6522 * Set the icon on a given file selector button widget
6524 * @param obj The file selector button widget
6525 * @param icon The icon object for the button
6527 * Once the icon object is set, a previously set one will be
6528 * deleted. If you want to keep the latter, use the
6529 * elm_fileselector_button_icon_unset() function.
6531 * @see elm_fileselector_button_icon_get()
6533 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6536 * Get the icon set for a given file selector button widget
6538 * @param obj The file selector button widget
6539 * @return The icon object currently set on @p obj or @c NULL, if
6542 * @see elm_fileselector_button_icon_set()
6544 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6547 * Unset the icon used in a given file selector button widget
6549 * @param obj The file selector button widget
6550 * @return The icon object that was being used on @p obj or @c
6553 * Unparent and return the icon object which was set for this
6556 * @see elm_fileselector_button_icon_set()
6558 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6561 * Set the title for a given file selector button widget's window
6563 * @param obj The file selector button widget
6564 * @param title The title string
6566 * This will change the window's title, when the file selector pops
6567 * out after a click on the button. Those windows have the default
6568 * (unlocalized) value of @c "Select a file" as titles.
6570 * @note It will only take any effect if the file selector
6571 * button widget is @b not under "inwin mode".
6573 * @see elm_fileselector_button_window_title_get()
6575 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6578 * Get the title set for a given file selector button widget's
6581 * @param obj The file selector button widget
6582 * @return Title of the file selector button's window
6584 * @see elm_fileselector_button_window_title_get() for more details
6586 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6589 * Set the size of a given file selector button widget's window,
6590 * holding the file selector itself.
6592 * @param obj The file selector button widget
6593 * @param width The window's width
6594 * @param height The window's height
6596 * @note it will only take any effect if the file selector button
6597 * widget is @b not under "inwin mode". The default size for the
6598 * window (when applicable) is 400x400 pixels.
6600 * @see elm_fileselector_button_window_size_get()
6602 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6605 * Get the size of a given file selector button widget's window,
6606 * holding the file selector itself.
6608 * @param obj The file selector button widget
6609 * @param width Pointer into which to store the width value
6610 * @param height Pointer into which to store the height value
6612 * @note Use @c NULL pointers on the size values you're not
6613 * interested in: they'll be ignored by the function.
6615 * @see elm_fileselector_button_window_size_set(), for more details
6617 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6620 * Set the initial file system path for a given file selector
6623 * @param obj The file selector button widget
6624 * @param path The path string
6626 * It must be a <b>directory</b> path, which will have the contents
6627 * displayed initially in the file selector's view, when invoked
6628 * from @p obj. The default initial path is the @c "HOME"
6629 * environment variable's value.
6631 * @see elm_fileselector_button_path_get()
6633 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6636 * Get the initial file system path set for a given file selector
6639 * @param obj The file selector button widget
6640 * @return path The path string
6642 * @see elm_fileselector_button_path_set() for more details
6644 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6647 * Enable/disable a tree view in the given file selector button
6648 * widget's internal file selector
6650 * @param obj The file selector button widget
6651 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6654 * This has the same effect as elm_fileselector_expandable_set(),
6655 * but now applied to a file selector button's internal file
6658 * @note There's no way to put a file selector button's internal
6659 * file selector in "grid mode", as one may do with "pure" file
6662 * @see elm_fileselector_expandable_get()
6664 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6667 * Get whether tree view is enabled for the given file selector
6668 * button widget's internal file selector
6670 * @param obj The file selector button widget
6671 * @return @c EINA_TRUE if @p obj widget's internal file selector
6672 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6674 * @see elm_fileselector_expandable_set() for more details
6676 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6679 * Set whether a given file selector button widget's internal file
6680 * selector is to display folders only or the directory contents,
6683 * @param obj The file selector button widget
6684 * @param only @c EINA_TRUE to make @p obj widget's internal file
6685 * selector only display directories, @c EINA_FALSE to make files
6686 * to be displayed in it too
6688 * This has the same effect as elm_fileselector_folder_only_set(),
6689 * but now applied to a file selector button's internal file
6692 * @see elm_fileselector_folder_only_get()
6694 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6697 * Get whether a given file selector button widget's internal file
6698 * selector is displaying folders only or the directory contents,
6701 * @param obj The file selector button widget
6702 * @return @c EINA_TRUE if @p obj widget's internal file
6703 * selector is only displaying directories, @c EINA_FALSE if files
6704 * are being displayed in it too (and on errors)
6706 * @see elm_fileselector_button_folder_only_set() for more details
6708 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6711 * Enable/disable the file name entry box where the user can type
6712 * in a name for a file, in a given file selector button widget's
6713 * internal file selector.
6715 * @param obj The file selector button widget
6716 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6717 * file selector a "saving dialog", @c EINA_FALSE otherwise
6719 * This has the same effect as elm_fileselector_is_save_set(),
6720 * but now applied to a file selector button's internal file
6723 * @see elm_fileselector_is_save_get()
6725 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6728 * Get whether the given file selector button widget's internal
6729 * file selector is in "saving dialog" mode
6731 * @param obj The file selector button widget
6732 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6733 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6736 * @see elm_fileselector_button_is_save_set() for more details
6738 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6741 * Set whether a given file selector button widget's internal file
6742 * selector will raise an Elementary "inner window", instead of a
6743 * dedicated Elementary window. By default, it won't.
6745 * @param obj The file selector button widget
6746 * @param value @c EINA_TRUE to make it use an inner window, @c
6747 * EINA_TRUE to make it use a dedicated window
6749 * @see elm_win_inwin_add() for more information on inner windows
6750 * @see elm_fileselector_button_inwin_mode_get()
6752 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6755 * Get whether a given file selector button widget's internal file
6756 * selector will raise an Elementary "inner window", instead of a
6757 * dedicated Elementary window.
6759 * @param obj The file selector button widget
6760 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6761 * if it will use a dedicated window
6763 * @see elm_fileselector_button_inwin_mode_set() for more details
6765 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6772 * @defgroup File_Selector_Entry File Selector Entry
6774 * @image html img/widget/fileselector_entry/preview-00.png
6775 * @image latex img/widget/fileselector_entry/preview-00.eps
6777 * This is an entry made to be filled with or display a <b>file
6778 * system path string</b>. Besides the entry itself, the widget has
6779 * a @ref File_Selector_Button "file selector button" on its side,
6780 * which will raise an internal @ref Fileselector "file selector widget",
6781 * when clicked, for path selection aided by file system
6784 * This file selector may appear in an Elementary window or in an
6785 * inner window. When a file is chosen from it, the (inner) window
6786 * is closed and the selected file's path string is exposed both as
6787 * an smart event and as the new text on the entry.
6789 * This widget encapsulates operations on its internal file
6790 * selector on its own API. There is less control over its file
6791 * selector than that one would have instatiating one directly.
6793 * Smart callbacks one can register to:
6794 * - @c "changed" - The text within the entry was changed
6795 * - @c "activated" - The entry has had editing finished and
6796 * changes are to be "committed"
6797 * - @c "press" - The entry has been clicked
6798 * - @c "longpressed" - The entry has been clicked (and held) for a
6800 * - @c "clicked" - The entry has been clicked
6801 * - @c "clicked,double" - The entry has been double clicked
6802 * - @c "focused" - The entry has received focus
6803 * - @c "unfocused" - The entry has lost focus
6804 * - @c "selection,paste" - A paste action has occurred on the
6806 * - @c "selection,copy" - A copy action has occurred on the entry
6807 * - @c "selection,cut" - A cut action has occurred on the entry
6808 * - @c "unpressed" - The file selector entry's button was released
6809 * after being pressed.
6810 * - @c "file,chosen" - The user has selected a path via the file
6811 * selector entry's internal file selector, whose string pointer
6812 * comes as the @c event_info data (a stringshared string)
6814 * Here is an example on its usage:
6815 * @li @ref fileselector_entry_example
6817 * @see @ref File_Selector_Button for a similar widget.
6822 * Add a new file selector entry widget to the given parent
6823 * Elementary (container) object
6825 * @param parent The parent object
6826 * @return a new file selector entry widget handle or @c NULL, on
6829 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6832 * Set the label for a given file selector entry widget's button
6834 * @param obj The file selector entry widget
6835 * @param label The text label to be displayed on @p obj widget's
6838 * @deprecated use elm_object_text_set() instead.
6840 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6843 * Get the label set for a given file selector entry widget's button
6845 * @param obj The file selector entry widget
6846 * @return The widget button's label
6848 * @deprecated use elm_object_text_set() instead.
6850 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6853 * Set the icon on a given file selector entry widget's button
6855 * @param obj The file selector entry widget
6856 * @param icon The icon object for the entry's button
6858 * Once the icon object is set, a previously set one will be
6859 * deleted. If you want to keep the latter, use the
6860 * elm_fileselector_entry_button_icon_unset() function.
6862 * @see elm_fileselector_entry_button_icon_get()
6864 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6867 * Get the icon set for a given file selector entry widget's button
6869 * @param obj The file selector entry widget
6870 * @return The icon object currently set on @p obj widget's button
6871 * or @c NULL, if none is
6873 * @see elm_fileselector_entry_button_icon_set()
6875 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6878 * Unset the icon used in a given file selector entry widget's
6881 * @param obj The file selector entry widget
6882 * @return The icon object that was being used on @p obj widget's
6883 * button or @c NULL, on errors
6885 * Unparent and return the icon object which was set for this
6888 * @see elm_fileselector_entry_button_icon_set()
6890 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6893 * Set the title for a given file selector entry widget's window
6895 * @param obj The file selector entry widget
6896 * @param title The title string
6898 * This will change the window's title, when the file selector pops
6899 * out after a click on the entry's button. Those windows have the
6900 * default (unlocalized) value of @c "Select a file" as titles.
6902 * @note It will only take any effect if the file selector
6903 * entry widget is @b not under "inwin mode".
6905 * @see elm_fileselector_entry_window_title_get()
6907 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6910 * Get the title set for a given file selector entry widget's
6913 * @param obj The file selector entry widget
6914 * @return Title of the file selector entry's window
6916 * @see elm_fileselector_entry_window_title_get() for more details
6918 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6921 * Set the size of a given file selector entry widget's window,
6922 * holding the file selector itself.
6924 * @param obj The file selector entry widget
6925 * @param width The window's width
6926 * @param height The window's height
6928 * @note it will only take any effect if the file selector entry
6929 * widget is @b not under "inwin mode". The default size for the
6930 * window (when applicable) is 400x400 pixels.
6932 * @see elm_fileselector_entry_window_size_get()
6934 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6937 * Get the size of a given file selector entry widget's window,
6938 * holding the file selector itself.
6940 * @param obj The file selector entry widget
6941 * @param width Pointer into which to store the width value
6942 * @param height Pointer into which to store the height value
6944 * @note Use @c NULL pointers on the size values you're not
6945 * interested in: they'll be ignored by the function.
6947 * @see elm_fileselector_entry_window_size_set(), for more details
6949 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6952 * Set the initial file system path and the entry's path string for
6953 * a given file selector entry widget
6955 * @param obj The file selector entry widget
6956 * @param path The path string
6958 * It must be a <b>directory</b> path, which will have the contents
6959 * displayed initially in the file selector's view, when invoked
6960 * from @p obj. The default initial path is the @c "HOME"
6961 * environment variable's value.
6963 * @see elm_fileselector_entry_path_get()
6965 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6968 * Get the entry's path string for a given file selector entry
6971 * @param obj The file selector entry widget
6972 * @return path The path string
6974 * @see elm_fileselector_entry_path_set() for more details
6976 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6979 * Enable/disable a tree view in the given file selector entry
6980 * widget's internal file selector
6982 * @param obj The file selector entry widget
6983 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6986 * This has the same effect as elm_fileselector_expandable_set(),
6987 * but now applied to a file selector entry's internal file
6990 * @note There's no way to put a file selector entry's internal
6991 * file selector in "grid mode", as one may do with "pure" file
6994 * @see elm_fileselector_expandable_get()
6996 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6999 * Get whether tree view is enabled for the given file selector
7000 * entry widget's internal file selector
7002 * @param obj The file selector entry widget
7003 * @return @c EINA_TRUE if @p obj widget's internal file selector
7004 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7006 * @see elm_fileselector_expandable_set() for more details
7008 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7011 * Set whether a given file selector entry widget's internal file
7012 * selector is to display folders only or the directory contents,
7015 * @param obj The file selector entry widget
7016 * @param only @c EINA_TRUE to make @p obj widget's internal file
7017 * selector only display directories, @c EINA_FALSE to make files
7018 * to be displayed in it too
7020 * This has the same effect as elm_fileselector_folder_only_set(),
7021 * but now applied to a file selector entry's internal file
7024 * @see elm_fileselector_folder_only_get()
7026 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7029 * Get whether a given file selector entry widget's internal file
7030 * selector is displaying folders only or the directory contents,
7033 * @param obj The file selector entry widget
7034 * @return @c EINA_TRUE if @p obj widget's internal file
7035 * selector is only displaying directories, @c EINA_FALSE if files
7036 * are being displayed in it too (and on errors)
7038 * @see elm_fileselector_entry_folder_only_set() for more details
7040 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7043 * Enable/disable the file name entry box where the user can type
7044 * in a name for a file, in a given file selector entry widget's
7045 * internal file selector.
7047 * @param obj The file selector entry widget
7048 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7049 * file selector a "saving dialog", @c EINA_FALSE otherwise
7051 * This has the same effect as elm_fileselector_is_save_set(),
7052 * but now applied to a file selector entry's internal file
7055 * @see elm_fileselector_is_save_get()
7057 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7060 * Get whether the given file selector entry widget's internal
7061 * file selector is in "saving dialog" mode
7063 * @param obj The file selector entry widget
7064 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7065 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7068 * @see elm_fileselector_entry_is_save_set() for more details
7070 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7073 * Set whether a given file selector entry widget's internal file
7074 * selector will raise an Elementary "inner window", instead of a
7075 * dedicated Elementary window. By default, it won't.
7077 * @param obj The file selector entry widget
7078 * @param value @c EINA_TRUE to make it use an inner window, @c
7079 * EINA_TRUE to make it use a dedicated window
7081 * @see elm_win_inwin_add() for more information on inner windows
7082 * @see elm_fileselector_entry_inwin_mode_get()
7084 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7087 * Get whether a given file selector entry widget's internal file
7088 * selector will raise an Elementary "inner window", instead of a
7089 * dedicated Elementary window.
7091 * @param obj The file selector entry widget
7092 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7093 * if it will use a dedicated window
7095 * @see elm_fileselector_entry_inwin_mode_set() for more details
7097 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7100 * Set the initial file system path for a given file selector entry
7103 * @param obj The file selector entry widget
7104 * @param path The path string
7106 * It must be a <b>directory</b> path, which will have the contents
7107 * displayed initially in the file selector's view, when invoked
7108 * from @p obj. The default initial path is the @c "HOME"
7109 * environment variable's value.
7111 * @see elm_fileselector_entry_path_get()
7113 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7116 * Get the parent directory's path to the latest file selection on
7117 * a given filer selector entry widget
7119 * @param obj The file selector object
7120 * @return The (full) path of the directory of the last selection
7121 * on @p obj widget, a @b stringshared string
7123 * @see elm_fileselector_entry_path_set()
7125 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7132 * @defgroup Scroller Scroller
7134 * A scroller holds a single object and "scrolls it around". This means that
7135 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7136 * region around, allowing to move through a much larger object that is
7137 * contained in the scroller. The scroller will always have a small minimum
7138 * size by default as it won't be limited by the contents of the scroller.
7140 * Signals that you can add callbacks for are:
7141 * @li "edge,left" - the left edge of the content has been reached
7142 * @li "edge,right" - the right edge of the content has been reached
7143 * @li "edge,top" - the top edge of the content has been reached
7144 * @li "edge,bottom" - the bottom edge of the content has been reached
7145 * @li "scroll" - the content has been scrolled (moved)
7146 * @li "scroll,anim,start" - scrolling animation has started
7147 * @li "scroll,anim,stop" - scrolling animation has stopped
7148 * @li "scroll,drag,start" - dragging the contents around has started
7149 * @li "scroll,drag,stop" - dragging the contents around has stopped
7150 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7153 * @note When Elemementary is in embedded mode the scrollbars will not be
7154 * dragable, they appear merely as indicators of how much has been scrolled.
7155 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7156 * fingerscroll) won't work.
7158 * Default contents parts of the scroller widget that you can use for are:
7159 * @li "default" - A content of the scroller
7161 * In @ref tutorial_scroller you'll find an example of how to use most of
7166 * @brief Type that controls when scrollbars should appear.
7168 * @see elm_scroller_policy_set()
7170 typedef enum _Elm_Scroller_Policy
7172 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7173 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7174 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7175 ELM_SCROLLER_POLICY_LAST
7176 } Elm_Scroller_Policy;
7178 * @brief Add a new scroller to the parent
7180 * @param parent The parent object
7181 * @return The new object or NULL if it cannot be created
7183 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7185 * @brief Set the content of the scroller widget (the object to be scrolled around).
7187 * @param obj The scroller object
7188 * @param content The new content object
7190 * Once the content object is set, a previously set one will be deleted.
7191 * If you want to keep that old content object, use the
7192 * elm_scroller_content_unset() function.
7193 * @deprecated use elm_object_content_set() instead
7195 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7197 * @brief Get the content of the scroller widget
7199 * @param obj The slider object
7200 * @return The content that is being used
7202 * Return the content object which is set for this widget
7204 * @see elm_scroller_content_set()
7205 * @deprecated use elm_object_content_get() instead.
7207 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7209 * @brief Unset the content of the scroller widget
7211 * @param obj The slider object
7212 * @return The content that was being used
7214 * Unparent and return the content object which was set for this widget
7216 * @see elm_scroller_content_set()
7217 * @deprecated use elm_object_content_unset() instead.
7219 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7221 * @brief Set custom theme elements for the scroller
7223 * @param obj The scroller object
7224 * @param widget The widget name to use (default is "scroller")
7225 * @param base The base name to use (default is "base")
7227 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7229 * @brief Make the scroller minimum size limited to the minimum size of the content
7231 * @param obj The scroller object
7232 * @param w Enable limiting minimum size horizontally
7233 * @param h Enable limiting minimum size vertically
7235 * By default the scroller will be as small as its design allows,
7236 * irrespective of its content. This will make the scroller minimum size the
7237 * right size horizontally and/or vertically to perfectly fit its content in
7240 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7242 * @brief Show a specific virtual region within the scroller content object
7244 * @param obj The scroller object
7245 * @param x X coordinate of the region
7246 * @param y Y coordinate of the region
7247 * @param w Width of the region
7248 * @param h Height of the region
7250 * This will ensure all (or part if it does not fit) of the designated
7251 * region in the virtual content object (0, 0 starting at the top-left of the
7252 * virtual content object) is shown within the scroller.
7254 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);
7256 * @brief Set the scrollbar visibility policy
7258 * @param obj The scroller object
7259 * @param policy_h Horizontal scrollbar policy
7260 * @param policy_v Vertical scrollbar policy
7262 * This sets the scrollbar visibility policy for the given scroller.
7263 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7264 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7265 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7266 * respectively for the horizontal and vertical scrollbars.
7268 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7270 * @brief Gets scrollbar visibility policy
7272 * @param obj The scroller object
7273 * @param policy_h Horizontal scrollbar policy
7274 * @param policy_v Vertical scrollbar policy
7276 * @see elm_scroller_policy_set()
7278 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7280 * @brief Get the currently visible content region
7282 * @param obj The scroller object
7283 * @param x X coordinate of the region
7284 * @param y Y coordinate of the region
7285 * @param w Width of the region
7286 * @param h Height of the region
7288 * This gets the current region in the content object that is visible through
7289 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7290 * w, @p h values pointed to.
7292 * @note All coordinates are relative to the content.
7294 * @see elm_scroller_region_show()
7296 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);
7298 * @brief Get the size of the content object
7300 * @param obj The scroller object
7301 * @param w Width of the content object.
7302 * @param h Height of the content object.
7304 * This gets the size of the content object of the scroller.
7306 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7308 * @brief Set bouncing behavior
7310 * @param obj The scroller object
7311 * @param h_bounce Allow bounce horizontally
7312 * @param v_bounce Allow bounce vertically
7314 * When scrolling, the scroller may "bounce" when reaching an edge of the
7315 * content object. This is a visual way to indicate the end has been reached.
7316 * This is enabled by default for both axis. This API will set if it is enabled
7317 * for the given axis with the boolean parameters for each axis.
7319 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7321 * @brief Get the bounce behaviour
7323 * @param obj The Scroller object
7324 * @param h_bounce Will the scroller bounce horizontally or not
7325 * @param v_bounce Will the scroller bounce vertically or not
7327 * @see elm_scroller_bounce_set()
7329 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7331 * @brief Set scroll page size relative to viewport size.
7333 * @param obj The scroller object
7334 * @param h_pagerel The horizontal page relative size
7335 * @param v_pagerel The vertical page relative size
7337 * The scroller is capable of limiting scrolling by the user to "pages". That
7338 * is to jump by and only show a "whole page" at a time as if the continuous
7339 * area of the scroller content is split into page sized pieces. This sets
7340 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7341 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7342 * axis. This is mutually exclusive with page size
7343 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7344 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7345 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7348 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7350 * @brief Set scroll page size.
7352 * @param obj The scroller object
7353 * @param h_pagesize The horizontal page size
7354 * @param v_pagesize The vertical page size
7356 * This sets the page size to an absolute fixed value, with 0 turning it off
7359 * @see elm_scroller_page_relative_set()
7361 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7363 * @brief Get scroll current page number.
7365 * @param obj The scroller object
7366 * @param h_pagenumber The horizontal page number
7367 * @param v_pagenumber The vertical page number
7369 * The page number starts from 0. 0 is the first page.
7370 * Current page means the page which meets the top-left of the viewport.
7371 * If there are two or more pages in the viewport, it returns the number of the page
7372 * which meets the top-left of the viewport.
7374 * @see elm_scroller_last_page_get()
7375 * @see elm_scroller_page_show()
7376 * @see elm_scroller_page_brint_in()
7378 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7380 * @brief Get scroll last page number.
7382 * @param obj The scroller object
7383 * @param h_pagenumber The horizontal page number
7384 * @param v_pagenumber The vertical page number
7386 * The page number starts from 0. 0 is the first page.
7387 * This returns the last page number among the pages.
7389 * @see elm_scroller_current_page_get()
7390 * @see elm_scroller_page_show()
7391 * @see elm_scroller_page_brint_in()
7393 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7395 * Show a specific virtual region within the scroller content object by page number.
7397 * @param obj The scroller object
7398 * @param h_pagenumber The horizontal page number
7399 * @param v_pagenumber The vertical page number
7401 * 0, 0 of the indicated page is located at the top-left of the viewport.
7402 * This will jump to the page directly without animation.
7407 * sc = elm_scroller_add(win);
7408 * elm_scroller_content_set(sc, content);
7409 * elm_scroller_page_relative_set(sc, 1, 0);
7410 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7411 * elm_scroller_page_show(sc, h_page + 1, v_page);
7414 * @see elm_scroller_page_bring_in()
7416 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7418 * Show a specific virtual region within the scroller content object by page number.
7420 * @param obj The scroller object
7421 * @param h_pagenumber The horizontal page number
7422 * @param v_pagenumber The vertical page number
7424 * 0, 0 of the indicated page is located at the top-left of the viewport.
7425 * This will slide to the page with animation.
7430 * sc = elm_scroller_add(win);
7431 * elm_scroller_content_set(sc, content);
7432 * elm_scroller_page_relative_set(sc, 1, 0);
7433 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7434 * elm_scroller_page_bring_in(sc, h_page, v_page);
7437 * @see elm_scroller_page_show()
7439 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7441 * @brief Show a specific virtual region within the scroller content object.
7443 * @param obj The scroller object
7444 * @param x X coordinate of the region
7445 * @param y Y coordinate of the region
7446 * @param w Width of the region
7447 * @param h Height of the region
7449 * This will ensure all (or part if it does not fit) of the designated
7450 * region in the virtual content object (0, 0 starting at the top-left of the
7451 * virtual content object) is shown within the scroller. Unlike
7452 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7453 * to this location (if configuration in general calls for transitions). It
7454 * may not jump immediately to the new location and make take a while and
7455 * show other content along the way.
7457 * @see elm_scroller_region_show()
7459 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);
7461 * @brief Set event propagation on a scroller
7463 * @param obj The scroller object
7464 * @param propagation If propagation is enabled or not
7466 * This enables or disabled event propagation from the scroller content to
7467 * the scroller and its parent. By default event propagation is disabled.
7469 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7471 * @brief Get event propagation for a scroller
7473 * @param obj The scroller object
7474 * @return The propagation state
7476 * This gets the event propagation for a scroller.
7478 * @see elm_scroller_propagate_events_set()
7480 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7482 * @brief Set scrolling gravity on a scroller
7484 * @param obj The scroller object
7485 * @param x The scrolling horizontal gravity
7486 * @param y The scrolling vertical gravity
7488 * The gravity, defines how the scroller will adjust its view
7489 * when the size of the scroller contents increase.
7491 * The scroller will adjust the view to glue itself as follows.
7493 * x=0.0, for showing the left most region of the content.
7494 * x=1.0, for showing the right most region of the content.
7495 * y=0.0, for showing the bottom most region of the content.
7496 * y=1.0, for showing the top most region of the content.
7498 * Default values for x and y are 0.0
7500 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7502 * @brief Get scrolling gravity values for a scroller
7504 * @param obj The scroller object
7505 * @param x The scrolling horizontal gravity
7506 * @param y The scrolling vertical gravity
7508 * This gets gravity values for a scroller.
7510 * @see elm_scroller_gravity_set()
7513 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7519 * @defgroup Label Label
7521 * @image html img/widget/label/preview-00.png
7522 * @image latex img/widget/label/preview-00.eps
7524 * @brief Widget to display text, with simple html-like markup.
7526 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7527 * text doesn't fit the geometry of the label it will be ellipsized or be
7528 * cut. Elementary provides several styles for this widget:
7529 * @li default - No animation
7530 * @li marker - Centers the text in the label and make it bold by default
7531 * @li slide_long - The entire text appears from the right of the screen and
7532 * slides until it disappears in the left of the screen(reappering on the
7534 * @li slide_short - The text appears in the left of the label and slides to
7535 * the right to show the overflow. When all of the text has been shown the
7536 * position is reset.
7537 * @li slide_bounce - The text appears in the left of the label and slides to
7538 * the right to show the overflow. When all of the text has been shown the
7539 * animation reverses, moving the text to the left.
7541 * Custom themes can of course invent new markup tags and style them any way
7544 * The following signals may be emitted by the label widget:
7545 * @li "language,changed": The program's language changed.
7547 * See @ref tutorial_label for a demonstration of how to use a label widget.
7551 * @brief Add a new label to the parent
7553 * @param parent The parent object
7554 * @return The new object or NULL if it cannot be created
7556 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7558 * @brief Set the label on the label object
7560 * @param obj The label object
7561 * @param label The label will be used on the label object
7562 * @deprecated See elm_object_text_set()
7564 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
7566 * @brief Get the label used on the label object
7568 * @param obj The label object
7569 * @return The string inside the label
7570 * @deprecated See elm_object_text_get()
7572 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7574 * @brief Set the wrapping behavior of the label
7576 * @param obj The label object
7577 * @param wrap To wrap text or not
7579 * By default no wrapping is done. Possible values for @p wrap are:
7580 * @li ELM_WRAP_NONE - No wrapping
7581 * @li ELM_WRAP_CHAR - wrap between characters
7582 * @li ELM_WRAP_WORD - wrap between words
7583 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7585 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7587 * @brief Get the wrapping behavior of the label
7589 * @param obj The label object
7592 * @see elm_label_line_wrap_set()
7594 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7596 * @brief Set wrap width of the label
7598 * @param obj The label object
7599 * @param w The wrap width in pixels at a minimum where words need to wrap
7601 * This function sets the maximum width size hint of the label.
7603 * @warning This is only relevant if the label is inside a container.
7605 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7607 * @brief Get wrap width of the label
7609 * @param obj The label object
7610 * @return The wrap width in pixels at a minimum where words need to wrap
7612 * @see elm_label_wrap_width_set()
7614 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7616 * @brief Set wrap height of the label
7618 * @param obj The label object
7619 * @param h The wrap height in pixels at a minimum where words need to wrap
7621 * This function sets the maximum height size hint of the label.
7623 * @warning This is only relevant if the label is inside a container.
7625 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7627 * @brief get wrap width of the label
7629 * @param obj The label object
7630 * @return The wrap height in pixels at a minimum where words need to wrap
7632 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7634 * @brief Set the font size on the label object.
7636 * @param obj The label object
7637 * @param size font size
7639 * @warning NEVER use this. It is for hyper-special cases only. use styles
7640 * instead. e.g. "default", "marker", "slide_long" etc.
7642 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7644 * @brief Set the text color on the label object
7646 * @param obj The label object
7647 * @param r Red property background color of The label object
7648 * @param g Green property background color of The label object
7649 * @param b Blue property background color of The label object
7650 * @param a Alpha property background color of The label object
7652 * @warning NEVER use this. It is for hyper-special cases only. use styles
7653 * instead. e.g. "default", "marker", "slide_long" etc.
7655 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);
7657 * @brief Set the text align on the label object
7659 * @param obj The label object
7660 * @param align align mode ("left", "center", "right")
7662 * @warning NEVER use this. It is for hyper-special cases only. use styles
7663 * instead. e.g. "default", "marker", "slide_long" etc.
7665 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7667 * @brief Set background color of the label
7669 * @param obj The label object
7670 * @param r Red property background color of The label object
7671 * @param g Green property background color of The label object
7672 * @param b Blue property background color of The label object
7673 * @param a Alpha property background alpha of The label object
7675 * @warning NEVER use this. It is for hyper-special cases only. use styles
7676 * instead. e.g. "default", "marker", "slide_long" etc.
7678 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);
7680 * @brief Set the ellipsis behavior of the label
7682 * @param obj The label object
7683 * @param ellipsis To ellipsis text or not
7685 * If set to true and the text doesn't fit in the label an ellipsis("...")
7686 * will be shown at the end of the widget.
7688 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7689 * choosen wrap method was ELM_WRAP_WORD.
7691 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7693 * @brief Set the text slide of the label
7695 * @param obj The label object
7696 * @param slide To start slide or stop
7698 * If set to true, the text of the label will slide/scroll through the length of
7701 * @warning This only works with the themes "slide_short", "slide_long" and
7704 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7706 * @brief Get the text slide mode of the label
7708 * @param obj The label object
7709 * @return slide slide mode value
7711 * @see elm_label_slide_set()
7713 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7715 * @brief Set the slide duration(speed) of the label
7717 * @param obj The label object
7718 * @return The duration in seconds in moving text from slide begin position
7719 * to slide end position
7721 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7723 * @brief Get the slide duration(speed) of the label
7725 * @param obj The label object
7726 * @return The duration time in moving text from slide begin position to slide end position
7728 * @see elm_label_slide_duration_set()
7730 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7736 * @defgroup Toggle Toggle
7738 * @image html img/widget/toggle/preview-00.png
7739 * @image latex img/widget/toggle/preview-00.eps
7741 * @brief A toggle is a slider which can be used to toggle between
7742 * two values. It has two states: on and off.
7744 * This widget is deprecated. Please use elm_check_add() instead using the
7745 * toggle style like:
7748 * obj = elm_check_add(parent);
7749 * elm_object_style_set(obj, "toggle");
7750 * elm_object_part_text_set(obj, "on", "ON");
7751 * elm_object_part_text_set(obj, "off", "OFF");
7754 * Signals that you can add callbacks for are:
7755 * @li "changed" - Whenever the toggle value has been changed. Is not called
7756 * until the toggle is released by the cursor (assuming it
7757 * has been triggered by the cursor in the first place).
7759 * Default contents parts of the toggle widget that you can use for are:
7760 * @li "icon" - An icon of the toggle
7762 * Default text parts of the toggle widget that you can use for are:
7763 * @li "elm.text" - Label of the toggle
7765 * @ref tutorial_toggle show how to use a toggle.
7769 * @brief Add a toggle to @p parent.
7771 * @param parent The parent object
7773 * @return The toggle object
7775 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7777 * @brief Sets the label to be displayed with the toggle.
7779 * @param obj The toggle object
7780 * @param label The label to be displayed
7782 * @deprecated use elm_object_text_set() instead.
7784 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7786 * @brief Gets the label of the toggle
7788 * @param obj toggle object
7789 * @return The label of the toggle
7791 * @deprecated use elm_object_text_get() instead.
7793 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7795 * @brief Set the icon used for the toggle
7797 * @param obj The toggle object
7798 * @param icon The icon object for the button
7800 * Once the icon object is set, a previously set one will be deleted
7801 * If you want to keep that old content object, use the
7802 * elm_toggle_icon_unset() function.
7804 * @deprecated use elm_object_part_content_set() instead.
7806 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7808 * @brief Get the icon used for the toggle
7810 * @param obj The toggle object
7811 * @return The icon object that is being used
7813 * Return the icon object which is set for this widget.
7815 * @see elm_toggle_icon_set()
7817 * @deprecated use elm_object_part_content_get() instead.
7819 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7821 * @brief Unset the icon used for the toggle
7823 * @param obj The toggle object
7824 * @return The icon object that was being used
7826 * Unparent and return the icon object which was set for this widget.
7828 * @see elm_toggle_icon_set()
7830 * @deprecated use elm_object_part_content_unset() instead.
7832 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7834 * @brief Sets the labels to be associated with the on and off states of the toggle.
7836 * @param obj The toggle object
7837 * @param onlabel The label displayed when the toggle is in the "on" state
7838 * @param offlabel The label displayed when the toggle is in the "off" state
7840 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7843 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7845 * @brief Gets the labels associated with the on and off states of the
7848 * @param obj The toggle object
7849 * @param onlabel A char** to place the onlabel of @p obj into
7850 * @param offlabel A char** to place the offlabel of @p obj into
7852 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7855 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7857 * @brief Sets the state of the toggle to @p state.
7859 * @param obj The toggle object
7860 * @param state The state of @p obj
7862 * @deprecated use elm_check_state_set() instead.
7864 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7866 * @brief Gets the state of the toggle to @p state.
7868 * @param obj The toggle object
7869 * @return The state of @p obj
7871 * @deprecated use elm_check_state_get() instead.
7873 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7875 * @brief Sets the state pointer of the toggle to @p statep.
7877 * @param obj The toggle object
7878 * @param statep The state pointer of @p obj
7880 * @deprecated use elm_check_state_pointer_set() instead.
7882 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7888 * @defgroup Frame Frame
7890 * @image html img/widget/frame/preview-00.png
7891 * @image latex img/widget/frame/preview-00.eps
7893 * @brief Frame is a widget that holds some content and has a title.
7895 * The default look is a frame with a title, but Frame supports multple
7903 * @li outdent_bottom
7905 * Of all this styles only default shows the title. Frame emits no signals.
7907 * Default contents parts of the frame widget that you can use for are:
7908 * @li "default" - A content of the frame
7910 * Default text parts of the frame widget that you can use for are:
7911 * @li "elm.text" - Label of the frame
7913 * For a detailed example see the @ref tutorial_frame.
7918 * @brief Add a new frame to the parent
7920 * @param parent The parent object
7921 * @return The new object or NULL if it cannot be created
7923 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7925 * @brief Set the frame label
7927 * @param obj The frame object
7928 * @param label The label of this frame object
7930 * @deprecated use elm_object_text_set() instead.
7932 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7934 * @brief Get the frame label
7936 * @param obj The frame object
7938 * @return The label of this frame objet or NULL if unable to get frame
7940 * @deprecated use elm_object_text_get() instead.
7942 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7944 * @brief Set the content of the frame widget
7946 * Once the content object is set, a previously set one will be deleted.
7947 * If you want to keep that old content object, use the
7948 * elm_frame_content_unset() function.
7950 * @param obj The frame object
7951 * @param content The content will be filled in this frame object
7953 * @deprecated use elm_object_content_set() instead.
7955 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7957 * @brief Get the content of the frame widget
7959 * Return the content object which is set for this widget
7961 * @param obj The frame object
7962 * @return The content that is being used
7964 * @deprecated use elm_object_content_get() instead.
7966 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7968 * @brief Unset the content of the frame widget
7970 * Unparent and return the content object which was set for this widget
7972 * @param obj The frame object
7973 * @return The content that was being used
7975 * @deprecated use elm_object_content_unset() instead.
7977 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7983 * @defgroup Table Table
7985 * A container widget to arrange other widgets in a table where items can
7986 * also span multiple columns or rows - even overlap (and then be raised or
7987 * lowered accordingly to adjust stacking if they do overlap).
7989 * For a Table widget the row/column count is not fixed.
7990 * The table widget adjusts itself when subobjects are added to it dynamically.
7992 * The followin are examples of how to use a table:
7993 * @li @ref tutorial_table_01
7994 * @li @ref tutorial_table_02
7999 * @brief Add a new table to the parent
8001 * @param parent The parent object
8002 * @return The new object or NULL if it cannot be created
8004 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8006 * @brief Set the homogeneous layout in the table
8008 * @param obj The layout object
8009 * @param homogeneous A boolean to set if the layout is homogeneous in the
8010 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8012 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8014 * @brief Get the current table homogeneous mode.
8016 * @param obj The table object
8017 * @return A boolean to indicating if the layout is homogeneous in the table
8018 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8020 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8022 * @brief Set padding between cells.
8024 * @param obj The layout object.
8025 * @param horizontal set the horizontal padding.
8026 * @param vertical set the vertical padding.
8028 * Default value is 0.
8030 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8032 * @brief Get padding between cells.
8034 * @param obj The layout object.
8035 * @param horizontal set the horizontal padding.
8036 * @param vertical set the vertical padding.
8038 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8040 * @brief Add a subobject on the table with the coordinates passed
8042 * @param obj The table object
8043 * @param subobj The subobject to be added to the table
8044 * @param x Row number
8045 * @param y Column number
8049 * @note All positioning inside the table is relative to rows and columns, so
8050 * a value of 0 for x and y, means the top left cell of the table, and a
8051 * value of 1 for w and h means @p subobj only takes that 1 cell.
8053 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8055 * @brief Remove child from table.
8057 * @param obj The table object
8058 * @param subobj The subobject
8060 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8062 * @brief Faster way to remove all child objects from a table object.
8064 * @param obj The table object
8065 * @param clear If true, will delete children, else just remove from table.
8067 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8069 * @brief Set the packing location of an existing child of the table
8071 * @param subobj The subobject to be modified in the table
8072 * @param x Row number
8073 * @param y Column number
8077 * Modifies the position of an object already in the table.
8079 * @note All positioning inside the table is relative to rows and columns, so
8080 * a value of 0 for x and y, means the top left cell of the table, and a
8081 * value of 1 for w and h means @p subobj only takes that 1 cell.
8083 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8085 * @brief Get the packing location of an existing child of the table
8087 * @param subobj The subobject to be modified in the table
8088 * @param x Row number
8089 * @param y Column number
8093 * @see elm_table_pack_set()
8095 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8100 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8101 typedef struct Elm_Gen_Item Elm_Gen_Item;
8102 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8103 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8104 typedef char *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8105 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. */
8106 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. */
8107 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8108 struct _Elm_Gen_Item_Class
8110 const char *item_style;
8111 struct _Elm_Gen_Item_Class_Func
8113 Elm_Gen_Item_Text_Get_Cb text_get;
8114 Elm_Gen_Item_Content_Get_Cb content_get;
8115 Elm_Gen_Item_State_Get_Cb state_get;
8116 Elm_Gen_Item_Del_Cb del;
8119 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8120 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8121 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8122 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8123 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8124 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8125 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8126 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8127 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8128 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8129 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8131 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8132 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8133 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8134 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8135 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8136 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8137 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8138 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8139 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8140 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8143 * @defgroup Gengrid Gengrid (Generic grid)
8145 * This widget aims to position objects in a grid layout while
8146 * actually creating and rendering only the visible ones, using the
8147 * same idea as the @ref Genlist "genlist": the user defines a @b
8148 * class for each item, specifying functions that will be called at
8149 * object creation, deletion, etc. When those items are selected by
8150 * the user, a callback function is issued. Users may interact with
8151 * a gengrid via the mouse (by clicking on items to select them and
8152 * clicking on the grid's viewport and swiping to pan the whole
8153 * view) or via the keyboard, navigating through item with the
8156 * @section Gengrid_Layouts Gengrid layouts
8158 * Gengrid may layout its items in one of two possible layouts:
8162 * When in "horizontal mode", items will be placed in @b columns,
8163 * from top to bottom and, when the space for a column is filled,
8164 * another one is started on the right, thus expanding the grid
8165 * horizontally, making for horizontal scrolling. When in "vertical
8166 * mode" , though, items will be placed in @b rows, from left to
8167 * right and, when the space for a row is filled, another one is
8168 * started below, thus expanding the grid vertically (and making
8169 * for vertical scrolling).
8171 * @section Gengrid_Items Gengrid items
8173 * An item in a gengrid can have 0 or more texts (they can be
8174 * regular text or textblock Evas objects - that's up to the style
8175 * to determine), 0 or more contents (which are simply objects
8176 * swallowed into the gengrid item's theming Edje object) and 0 or
8177 * more <b>boolean states</b>, which have the behavior left to the
8178 * user to define. The Edje part names for each of these properties
8179 * will be looked up, in the theme file for the gengrid, under the
8180 * Edje (string) data items named @c "texts", @c "contents" and @c
8181 * "states", respectively. For each of those properties, if more
8182 * than one part is provided, they must have names listed separated
8183 * by spaces in the data fields. For the default gengrid item
8184 * theme, we have @b one text part (@c "elm.text"), @b two content
8185 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8188 * A gengrid item may be at one of several styles. Elementary
8189 * provides one by default - "default", but this can be extended by
8190 * system or application custom themes/overlays/extensions (see
8191 * @ref Theme "themes" for more details).
8193 * @section Gengrid_Item_Class Gengrid item classes
8195 * In order to have the ability to add and delete items on the fly,
8196 * gengrid implements a class (callback) system where the
8197 * application provides a structure with information about that
8198 * type of item (gengrid may contain multiple different items with
8199 * different classes, states and styles). Gengrid will call the
8200 * functions in this struct (methods) when an item is "realized"
8201 * (i.e., created dynamically, while the user is scrolling the
8202 * grid). All objects will simply be deleted when no longer needed
8203 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8204 * contains the following members:
8205 * - @c item_style - This is a constant string and simply defines
8206 * the name of the item style. It @b must be specified and the
8207 * default should be @c "default".
8208 * - @c func.text_get - This function is called when an item
8209 * object is actually created. The @c data parameter will point to
8210 * the same data passed to elm_gengrid_item_append() and related
8211 * item creation functions. The @c obj parameter is the gengrid
8212 * object itself, while the @c part one is the name string of one
8213 * of the existing text parts in the Edje group implementing the
8214 * item's theme. This function @b must return a strdup'()ed string,
8215 * as the caller will free() it when done. See
8216 * #Elm_Gengrid_Item_Text_Get_Cb.
8217 * - @c func.content_get - This function is called when an item object
8218 * is actually created. The @c data parameter will point to the
8219 * same data passed to elm_gengrid_item_append() and related item
8220 * creation functions. The @c obj parameter is the gengrid object
8221 * itself, while the @c part one is the name string of one of the
8222 * existing (content) swallow parts in the Edje group implementing the
8223 * item's theme. It must return @c NULL, when no content is desired,
8224 * or a valid object handle, otherwise. The object will be deleted
8225 * by the gengrid on its deletion or when the item is "unrealized".
8226 * See #Elm_Gengrid_Item_Content_Get_Cb.
8227 * - @c func.state_get - This function is called when an item
8228 * object is actually created. The @c data parameter will point to
8229 * the same data passed to elm_gengrid_item_append() and related
8230 * item creation functions. The @c obj parameter is the gengrid
8231 * object itself, while the @c part one is the name string of one
8232 * of the state parts in the Edje group implementing the item's
8233 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8234 * true/on. Gengrids will emit a signal to its theming Edje object
8235 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8236 * "source" arguments, respectively, when the state is true (the
8237 * default is false), where @c XXX is the name of the (state) part.
8238 * See #Elm_Gengrid_Item_State_Get_Cb.
8239 * - @c func.del - This is called when elm_gengrid_item_del() is
8240 * called on an item or elm_gengrid_clear() is called on the
8241 * gengrid. This is intended for use when gengrid items are
8242 * deleted, so any data attached to the item (e.g. its data
8243 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8245 * @section Gengrid_Usage_Hints Usage hints
8247 * If the user wants to have multiple items selected at the same
8248 * time, elm_gengrid_multi_select_set() will permit it. If the
8249 * gengrid is single-selection only (the default), then
8250 * elm_gengrid_select_item_get() will return the selected item or
8251 * @c NULL, if none is selected. If the gengrid is under
8252 * multi-selection, then elm_gengrid_selected_items_get() will
8253 * return a list (that is only valid as long as no items are
8254 * modified (added, deleted, selected or unselected) of child items
8257 * If an item changes (internal (boolean) state, text or content
8258 * changes), then use elm_gengrid_item_update() to have gengrid
8259 * update the item with the new state. A gengrid will re-"realize"
8260 * the item, thus calling the functions in the
8261 * #Elm_Gengrid_Item_Class set for that item.
8263 * To programmatically (un)select an item, use
8264 * elm_gengrid_item_selected_set(). To get its selected state use
8265 * elm_gengrid_item_selected_get(). To make an item disabled
8266 * (unable to be selected and appear differently) use
8267 * elm_gengrid_item_disabled_set() to set this and
8268 * elm_gengrid_item_disabled_get() to get the disabled state.
8270 * Grid cells will only have their selection smart callbacks called
8271 * when firstly getting selected. Any further clicks will do
8272 * nothing, unless you enable the "always select mode", with
8273 * elm_gengrid_always_select_mode_set(), thus making every click to
8274 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8275 * turn off the ability to select items entirely in the widget and
8276 * they will neither appear selected nor call the selection smart
8279 * Remember that you can create new styles and add your own theme
8280 * augmentation per application with elm_theme_extension_add(). If
8281 * you absolutely must have a specific style that overrides any
8282 * theme the user or system sets up you can use
8283 * elm_theme_overlay_add() to add such a file.
8285 * @section Gengrid_Smart_Events Gengrid smart events
8287 * Smart events that you can add callbacks for are:
8288 * - @c "activated" - The user has double-clicked or pressed
8289 * (enter|return|spacebar) on an item. The @c event_info parameter
8290 * is the gengrid item that was activated.
8291 * - @c "clicked,double" - The user has double-clicked an item.
8292 * The @c event_info parameter is the gengrid item that was double-clicked.
8293 * - @c "longpressed" - This is called when the item is pressed for a certain
8294 * amount of time. By default it's 1 second.
8295 * - @c "selected" - The user has made an item selected. The
8296 * @c event_info parameter is the gengrid item that was selected.
8297 * - @c "unselected" - The user has made an item unselected. The
8298 * @c event_info parameter is the gengrid item that was unselected.
8299 * - @c "realized" - This is called when the item in the gengrid
8300 * has its implementing Evas object instantiated, de facto. @c
8301 * event_info is the gengrid item that was created. The object
8302 * may be deleted at any time, so it is highly advised to the
8303 * caller @b not to use the object pointer returned from
8304 * elm_gengrid_item_object_get(), because it may point to freed
8306 * - @c "unrealized" - This is called when the implementing Evas
8307 * object for this item is deleted. @c event_info is the gengrid
8308 * item that was deleted.
8309 * - @c "changed" - Called when an item is added, removed, resized
8310 * or moved and when the gengrid is resized or gets "horizontal"
8312 * - @c "scroll,anim,start" - This is called when scrolling animation has
8314 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8316 * - @c "drag,start,up" - Called when the item in the gengrid has
8317 * been dragged (not scrolled) up.
8318 * - @c "drag,start,down" - Called when the item in the gengrid has
8319 * been dragged (not scrolled) down.
8320 * - @c "drag,start,left" - Called when the item in the gengrid has
8321 * been dragged (not scrolled) left.
8322 * - @c "drag,start,right" - Called when the item in the gengrid has
8323 * been dragged (not scrolled) right.
8324 * - @c "drag,stop" - Called when the item in the gengrid has
8325 * stopped being dragged.
8326 * - @c "drag" - Called when the item in the gengrid is being
8328 * - @c "scroll" - called when the content has been scrolled
8330 * - @c "scroll,drag,start" - called when dragging the content has
8332 * - @c "scroll,drag,stop" - called when dragging the content has
8334 * - @c "edge,top" - This is called when the gengrid is scrolled until
8336 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8337 * until the bottom edge.
8338 * - @c "edge,left" - This is called when the gengrid is scrolled
8339 * until the left edge.
8340 * - @c "edge,right" - This is called when the gengrid is scrolled
8341 * until the right edge.
8343 * List of gengrid examples:
8344 * @li @ref gengrid_example
8348 * @addtogroup Gengrid
8352 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8353 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8354 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8355 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8356 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8358 * Text fetching class function for Elm_Gen_Item_Class.
8359 * @param data The data passed in the item creation function
8360 * @param obj The base widget object
8361 * @param part The part name of the swallow
8362 * @return The allocated (NOT stringshared) string to set as the text
8364 typedef char *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8366 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8367 * @param data The data passed in the item creation function
8368 * @param obj The base widget object
8369 * @param part The part name of the swallow
8370 * @return The content object to swallow
8372 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8374 * State fetching class function for Elm_Gen_Item_Class.
8375 * @param data The data passed in the item creation function
8376 * @param obj The base widget object
8377 * @param part The part name of the swallow
8378 * @return The hell if I know
8380 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8382 * Deletion class function for Elm_Gen_Item_Class.
8383 * @param data The data passed in the item creation function
8384 * @param obj The base widget object
8386 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8389 * @struct _Elm_Gengrid_Item_Class
8391 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8394 struct _Elm_Gengrid_Item_Class
8396 const char *item_style;
8397 struct _Elm_Gengrid_Item_Class_Func
8399 Elm_Gengrid_Item_Text_Get_Cb text_get; /**< Text fetching class function for gengrid item classes.*/
8400 Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8401 Elm_Gengrid_Item_State_Get_Cb state_get; /**< State fetching class function for gengrid item classes. */
8402 Elm_Gengrid_Item_Del_Cb del; /**< Deletion class function for gengrid item classes. */
8404 }; /**< #Elm_Gengrid_Item_Class member definitions */
8405 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8407 * Add a new gengrid widget to the given parent Elementary
8408 * (container) object
8410 * @param parent The parent object
8411 * @return a new gengrid widget handle or @c NULL, on errors
8413 * This function inserts a new gengrid widget on the canvas.
8415 * @see elm_gengrid_item_size_set()
8416 * @see elm_gengrid_group_item_size_set()
8417 * @see elm_gengrid_horizontal_set()
8418 * @see elm_gengrid_item_append()
8419 * @see elm_gengrid_item_del()
8420 * @see elm_gengrid_clear()
8424 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8427 * Set the size for the items of a given gengrid widget
8429 * @param obj The gengrid object.
8430 * @param w The items' width.
8431 * @param h The items' height;
8433 * A gengrid, after creation, has still no information on the size
8434 * to give to each of its cells. So, you most probably will end up
8435 * with squares one @ref Fingers "finger" wide, the default
8436 * size. Use this function to force a custom size for you items,
8437 * making them as big as you wish.
8439 * @see elm_gengrid_item_size_get()
8443 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8446 * Get the size set for the items of a given gengrid widget
8448 * @param obj The gengrid object.
8449 * @param w Pointer to a variable where to store the items' width.
8450 * @param h Pointer to a variable where to store the items' height.
8452 * @note Use @c NULL pointers on the size values you're not
8453 * interested in: they'll be ignored by the function.
8455 * @see elm_gengrid_item_size_get() for more details
8459 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8462 * Set the size for the group items of a given gengrid widget
8464 * @param obj The gengrid object.
8465 * @param w The group items' width.
8466 * @param h The group items' height;
8468 * A gengrid, after creation, has still no information on the size
8469 * to give to each of its cells. So, you most probably will end up
8470 * with squares one @ref Fingers "finger" wide, the default
8471 * size. Use this function to force a custom size for you group items,
8472 * making them as big as you wish.
8474 * @see elm_gengrid_group_item_size_get()
8478 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8481 * Get the size set for the group items of a given gengrid widget
8483 * @param obj The gengrid object.
8484 * @param w Pointer to a variable where to store the group items' width.
8485 * @param h Pointer to a variable where to store the group items' height.
8487 * @note Use @c NULL pointers on the size values you're not
8488 * interested in: they'll be ignored by the function.
8490 * @see elm_gengrid_group_item_size_get() for more details
8494 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8497 * Set the items grid's alignment within a given gengrid widget
8499 * @param obj The gengrid object.
8500 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8501 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8503 * This sets the alignment of the whole grid of items of a gengrid
8504 * within its given viewport. By default, those values are both
8505 * 0.5, meaning that the gengrid will have its items grid placed
8506 * exactly in the middle of its viewport.
8508 * @note If given alignment values are out of the cited ranges,
8509 * they'll be changed to the nearest boundary values on the valid
8512 * @see elm_gengrid_align_get()
8516 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8519 * Get the items grid's alignment values within a given gengrid
8522 * @param obj The gengrid object.
8523 * @param align_x Pointer to a variable where to store the
8524 * horizontal alignment.
8525 * @param align_y Pointer to a variable where to store the vertical
8528 * @note Use @c NULL pointers on the alignment values you're not
8529 * interested in: they'll be ignored by the function.
8531 * @see elm_gengrid_align_set() for more details
8535 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8538 * Set whether a given gengrid widget is or not able have items
8541 * @param obj The gengrid object
8542 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8543 * @c EINA_FALSE to turn it off
8545 * If a gengrid is set to allow reordering, a click held for more
8546 * than 0.5 over a given item will highlight it specially,
8547 * signalling the gengrid has entered the reordering state. From
8548 * that time on, the user will be able to, while still holding the
8549 * mouse button down, move the item freely in the gengrid's
8550 * viewport, replacing to said item to the locations it goes to.
8551 * The replacements will be animated and, whenever the user
8552 * releases the mouse button, the item being replaced gets a new
8553 * definitive place in the grid.
8555 * @see elm_gengrid_reorder_mode_get()
8559 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8562 * Get whether a given gengrid widget is or not able have items
8565 * @param obj The gengrid object
8566 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8569 * @see elm_gengrid_reorder_mode_set() for more details
8573 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8576 * Append a new item in a given gengrid widget.
8578 * @param obj The gengrid object.
8579 * @param gic The item class for the item.
8580 * @param data The item data.
8581 * @param func Convenience function called when the item is
8583 * @param func_data Data to be passed to @p func.
8584 * @return A handle to the item added or @c NULL, on errors.
8586 * This adds an item to the beginning of the gengrid.
8588 * @see elm_gengrid_item_prepend()
8589 * @see elm_gengrid_item_insert_before()
8590 * @see elm_gengrid_item_insert_after()
8591 * @see elm_gengrid_item_del()
8595 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);
8598 * Prepend a new item in a given gengrid widget.
8600 * @param obj The gengrid object.
8601 * @param gic The item class for the item.
8602 * @param data The item data.
8603 * @param func Convenience function called when the item is
8605 * @param func_data Data to be passed to @p func.
8606 * @return A handle to the item added or @c NULL, on errors.
8608 * This adds an item to the end of the gengrid.
8610 * @see elm_gengrid_item_append()
8611 * @see elm_gengrid_item_insert_before()
8612 * @see elm_gengrid_item_insert_after()
8613 * @see elm_gengrid_item_del()
8617 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);
8620 * Insert an item before another in a gengrid widget
8622 * @param obj The gengrid object.
8623 * @param gic The item class for the item.
8624 * @param data The item data.
8625 * @param relative The item to place this new one before.
8626 * @param func Convenience function called when the item is
8628 * @param func_data Data to be passed to @p func.
8629 * @return A handle to the item added or @c NULL, on errors.
8631 * This inserts an item before another in the gengrid.
8633 * @see elm_gengrid_item_append()
8634 * @see elm_gengrid_item_prepend()
8635 * @see elm_gengrid_item_insert_after()
8636 * @see elm_gengrid_item_del()
8640 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);
8643 * Insert an item after another in a gengrid widget
8645 * @param obj The gengrid object.
8646 * @param gic The item class for the item.
8647 * @param data The item data.
8648 * @param relative The item to place this new one after.
8649 * @param func Convenience function called when the item is
8651 * @param func_data Data to be passed to @p func.
8652 * @return A handle to the item added or @c NULL, on errors.
8654 * This inserts an item after another in the gengrid.
8656 * @see elm_gengrid_item_append()
8657 * @see elm_gengrid_item_prepend()
8658 * @see elm_gengrid_item_insert_after()
8659 * @see elm_gengrid_item_del()
8663 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);
8666 * Insert an item in a gengrid widget using a user-defined sort function.
8668 * @param obj The gengrid object.
8669 * @param gic The item class for the item.
8670 * @param data The item data.
8671 * @param comp User defined comparison function that defines the sort order based on
8672 * Elm_Gen_Item and its data param.
8673 * @param func Convenience function called when the item is selected.
8674 * @param func_data Data to be passed to @p func.
8675 * @return A handle to the item added or @c NULL, on errors.
8677 * This inserts an item in the gengrid based on user defined comparison function.
8679 * @see elm_gengrid_item_append()
8680 * @see elm_gengrid_item_prepend()
8681 * @see elm_gengrid_item_insert_after()
8682 * @see elm_gengrid_item_del()
8683 * @see elm_gengrid_item_direct_sorted_insert()
8687 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);
8690 * Insert an item in a gengrid widget using a user-defined sort function.
8692 * @param obj The gengrid object.
8693 * @param gic The item class for the item.
8694 * @param data The item data.
8695 * @param comp User defined comparison function that defines the sort order based on
8697 * @param func Convenience function called when the item is selected.
8698 * @param func_data Data to be passed to @p func.
8699 * @return A handle to the item added or @c NULL, on errors.
8701 * This inserts an item in the gengrid based on user defined comparison function.
8703 * @see elm_gengrid_item_append()
8704 * @see elm_gengrid_item_prepend()
8705 * @see elm_gengrid_item_insert_after()
8706 * @see elm_gengrid_item_del()
8707 * @see elm_gengrid_item_sorted_insert()
8711 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);
8714 * Set whether items on a given gengrid widget are to get their
8715 * selection callbacks issued for @b every subsequent selection
8716 * click on them or just for the first click.
8718 * @param obj The gengrid object
8719 * @param always_select @c EINA_TRUE to make items "always
8720 * selected", @c EINA_FALSE, otherwise
8722 * By default, grid items will only call their selection callback
8723 * function when firstly getting selected, any subsequent further
8724 * clicks will do nothing. With this call, you make those
8725 * subsequent clicks also to issue the selection callbacks.
8727 * @note <b>Double clicks</b> will @b always be reported on items.
8729 * @see elm_gengrid_always_select_mode_get()
8733 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8736 * Get whether items on a given gengrid widget have their selection
8737 * callbacks issued for @b every subsequent selection click on them
8738 * or just for the first click.
8740 * @param obj The gengrid object.
8741 * @return @c EINA_TRUE if the gengrid items are "always selected",
8742 * @c EINA_FALSE, otherwise
8744 * @see elm_gengrid_always_select_mode_set() for more details
8748 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8751 * Set whether items on a given gengrid widget can be selected or not.
8753 * @param obj The gengrid object
8754 * @param no_select @c EINA_TRUE to make items selectable,
8755 * @c EINA_FALSE otherwise
8757 * This will make items in @p obj selectable or not. In the latter
8758 * case, any user interaction on the gengrid items will neither make
8759 * them appear selected nor them call their selection callback
8762 * @see elm_gengrid_no_select_mode_get()
8766 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8769 * Get whether items on a given gengrid widget can be selected or
8772 * @param obj The gengrid object
8773 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8776 * @see elm_gengrid_no_select_mode_set() for more details
8780 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8783 * Enable or disable multi-selection in a given gengrid widget
8785 * @param obj The gengrid object.
8786 * @param multi @c EINA_TRUE, to enable multi-selection,
8787 * @c EINA_FALSE to disable it.
8789 * Multi-selection is the ability to have @b more than one
8790 * item selected, on a given gengrid, simultaneously. When it is
8791 * enabled, a sequence of clicks on different items will make them
8792 * all selected, progressively. A click on an already selected item
8793 * will unselect it. If interacting via the keyboard,
8794 * multi-selection is enabled while holding the "Shift" key.
8796 * @note By default, multi-selection is @b disabled on gengrids
8798 * @see elm_gengrid_multi_select_get()
8802 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8805 * Get whether multi-selection is enabled or disabled for a given
8808 * @param obj The gengrid object.
8809 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8810 * EINA_FALSE otherwise
8812 * @see elm_gengrid_multi_select_set() for more details
8816 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8819 * Enable or disable bouncing effect for a given gengrid widget
8821 * @param obj The gengrid object
8822 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8823 * @c EINA_FALSE to disable it
8824 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8825 * @c EINA_FALSE to disable it
8827 * The bouncing effect occurs whenever one reaches the gengrid's
8828 * edge's while panning it -- it will scroll past its limits a
8829 * little bit and return to the edge again, in a animated for,
8832 * @note By default, gengrids have bouncing enabled on both axis
8834 * @see elm_gengrid_bounce_get()
8838 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8841 * Get whether bouncing effects are enabled or disabled, for a
8842 * given gengrid widget, on each axis
8844 * @param obj The gengrid object
8845 * @param h_bounce Pointer to a variable where to store the
8846 * horizontal bouncing flag.
8847 * @param v_bounce Pointer to a variable where to store the
8848 * vertical bouncing flag.
8850 * @see elm_gengrid_bounce_set() for more details
8854 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8857 * Set a given gengrid widget's scrolling page size, relative to
8858 * its viewport size.
8860 * @param obj The gengrid object
8861 * @param h_pagerel The horizontal page (relative) size
8862 * @param v_pagerel The vertical page (relative) size
8864 * The gengrid's scroller is capable of binding scrolling by the
8865 * user to "pages". It means that, while scrolling and, specially
8866 * after releasing the mouse button, the grid will @b snap to the
8867 * nearest displaying page's area. When page sizes are set, the
8868 * grid's continuous content area is split into (equal) page sized
8871 * This function sets the size of a page <b>relatively to the
8872 * viewport dimensions</b> of the gengrid, for each axis. A value
8873 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8874 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8875 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8876 * 1.0. Values beyond those will make it behave behave
8877 * inconsistently. If you only want one axis to snap to pages, use
8878 * the value @c 0.0 for the other one.
8880 * There is a function setting page size values in @b absolute
8881 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8882 * is mutually exclusive to this one.
8884 * @see elm_gengrid_page_relative_get()
8888 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8891 * Get a given gengrid widget's scrolling page size, relative to
8892 * its viewport size.
8894 * @param obj The gengrid object
8895 * @param h_pagerel Pointer to a variable where to store the
8896 * horizontal page (relative) size
8897 * @param v_pagerel Pointer to a variable where to store the
8898 * vertical page (relative) size
8900 * @see elm_gengrid_page_relative_set() for more details
8904 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8907 * Set a given gengrid widget's scrolling page size
8909 * @param obj The gengrid object
8910 * @param h_pagerel The horizontal page size, in pixels
8911 * @param v_pagerel The vertical page size, in pixels
8913 * The gengrid's scroller is capable of binding scrolling by the
8914 * user to "pages". It means that, while scrolling and, specially
8915 * after releasing the mouse button, the grid will @b snap to the
8916 * nearest displaying page's area. When page sizes are set, the
8917 * grid's continuous content area is split into (equal) page sized
8920 * This function sets the size of a page of the gengrid, in pixels,
8921 * for each axis. Sane usable values are, between @c 0 and the
8922 * dimensions of @p obj, for each axis. Values beyond those will
8923 * make it behave behave inconsistently. If you only want one axis
8924 * to snap to pages, use the value @c 0 for the other one.
8926 * There is a function setting page size values in @b relative
8927 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8928 * use is mutually exclusive to this one.
8932 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8935 * @brief Get gengrid current page number.
8937 * @param obj The gengrid object
8938 * @param h_pagenumber The horizontal page number
8939 * @param v_pagenumber The vertical page number
8941 * The page number starts from 0. 0 is the first page.
8942 * Current page means the page which meet the top-left of the viewport.
8943 * If there are two or more pages in the viewport, it returns the number of page
8944 * which meet the top-left of the viewport.
8946 * @see elm_gengrid_last_page_get()
8947 * @see elm_gengrid_page_show()
8948 * @see elm_gengrid_page_brint_in()
8950 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8953 * @brief Get scroll last page number.
8955 * @param obj The gengrid object
8956 * @param h_pagenumber The horizontal page number
8957 * @param v_pagenumber The vertical page number
8959 * The page number starts from 0. 0 is the first page.
8960 * This returns the last page number among the pages.
8962 * @see elm_gengrid_current_page_get()
8963 * @see elm_gengrid_page_show()
8964 * @see elm_gengrid_page_brint_in()
8966 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8969 * Show a specific virtual region within the gengrid content object by page number.
8971 * @param obj The gengrid object
8972 * @param h_pagenumber The horizontal page number
8973 * @param v_pagenumber The vertical page number
8975 * 0, 0 of the indicated page is located at the top-left of the viewport.
8976 * This will jump to the page directly without animation.
8981 * sc = elm_gengrid_add(win);
8982 * elm_gengrid_content_set(sc, content);
8983 * elm_gengrid_page_relative_set(sc, 1, 0);
8984 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8985 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8988 * @see elm_gengrid_page_bring_in()
8990 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8993 * Show a specific virtual region within the gengrid content object by page number.
8995 * @param obj The gengrid object
8996 * @param h_pagenumber The horizontal page number
8997 * @param v_pagenumber The vertical page number
8999 * 0, 0 of the indicated page is located at the top-left of the viewport.
9000 * This will slide to the page with animation.
9005 * sc = elm_gengrid_add(win);
9006 * elm_gengrid_content_set(sc, content);
9007 * elm_gengrid_page_relative_set(sc, 1, 0);
9008 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9009 * elm_gengrid_page_bring_in(sc, h_page, v_page);
9012 * @see elm_gengrid_page_show()
9014 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9017 * Set the direction in which a given gengrid widget will expand while
9018 * placing its items.
9020 * @param obj The gengrid object.
9021 * @param setting @c EINA_TRUE to make the gengrid expand
9022 * horizontally, @c EINA_FALSE to expand vertically.
9024 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9025 * in @b columns, from top to bottom and, when the space for a
9026 * column is filled, another one is started on the right, thus
9027 * expanding the grid horizontally. When in "vertical mode"
9028 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9029 * to right and, when the space for a row is filled, another one is
9030 * started below, thus expanding the grid vertically.
9032 * @see elm_gengrid_horizontal_get()
9036 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9039 * Get for what direction a given gengrid widget will expand while
9040 * placing its items.
9042 * @param obj The gengrid object.
9043 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9044 * @c EINA_FALSE if it's set to expand vertically.
9046 * @see elm_gengrid_horizontal_set() for more detais
9050 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9053 * Get the first item in a given gengrid widget
9055 * @param obj The gengrid object
9056 * @return The first item's handle or @c NULL, if there are no
9057 * items in @p obj (and on errors)
9059 * This returns the first item in the @p obj's internal list of
9062 * @see elm_gengrid_last_item_get()
9066 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9069 * Get the last item in a given gengrid widget
9071 * @param obj The gengrid object
9072 * @return The last item's handle or @c NULL, if there are no
9073 * items in @p obj (and on errors)
9075 * This returns the last item in the @p obj's internal list of
9078 * @see elm_gengrid_first_item_get()
9082 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9085 * Get the @b next item in a gengrid widget's internal list of items,
9086 * given a handle to one of those items.
9088 * @param item The gengrid item to fetch next from
9089 * @return The item after @p item, or @c NULL if there's none (and
9092 * This returns the item placed after the @p item, on the container
9095 * @see elm_gengrid_item_prev_get()
9099 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9102 * Get the @b previous item in a gengrid widget's internal list of items,
9103 * given a handle to one of those items.
9105 * @param item The gengrid item to fetch previous from
9106 * @return The item before @p item, or @c NULL if there's none (and
9109 * This returns the item placed before the @p item, on the container
9112 * @see elm_gengrid_item_next_get()
9116 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9119 * Get the gengrid object's handle which contains a given gengrid
9122 * @param item The item to fetch the container from
9123 * @return The gengrid (parent) object
9125 * This returns the gengrid object itself that an item belongs to.
9129 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9132 * Remove a gengrid item from its parent, deleting it.
9134 * @param item The item to be removed.
9135 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9137 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9142 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9145 * Update the contents of a given gengrid item
9147 * @param item The gengrid item
9149 * This updates an item by calling all the item class functions
9150 * again to get the contents, texts and states. Use this when the
9151 * original item data has changed and you want the changes to be
9156 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9159 * Get the Gengrid Item class for the given Gengrid Item.
9161 * @param item The gengrid item
9163 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9164 * the function pointers and item_style.
9168 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9171 * Get the Gengrid Item class for the given Gengrid Item.
9173 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9174 * the function pointers and item_style.
9176 * @param item The gengrid item
9177 * @param gic The gengrid item class describing the function pointers and the item style.
9181 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9184 * Return the data associated to a given gengrid item
9186 * @param item The gengrid item.
9187 * @return the data associated with this item.
9189 * This returns the @c data value passed on the
9190 * elm_gengrid_item_append() and related item addition calls.
9192 * @see elm_gengrid_item_append()
9193 * @see elm_gengrid_item_data_set()
9197 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9200 * Set the data associated with a given gengrid item
9202 * @param item The gengrid item
9203 * @param data The data pointer to set on it
9205 * This @b overrides the @c data value passed on the
9206 * elm_gengrid_item_append() and related item addition calls. This
9207 * function @b won't call elm_gengrid_item_update() automatically,
9208 * so you'd issue it afterwards if you want to have the item
9209 * updated to reflect the new data.
9211 * @see elm_gengrid_item_data_get()
9212 * @see elm_gengrid_item_update()
9216 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9219 * Get a given gengrid item's position, relative to the whole
9220 * gengrid's grid area.
9222 * @param item The Gengrid item.
9223 * @param x Pointer to variable to store the item's <b>row number</b>.
9224 * @param y Pointer to variable to store the item's <b>column number</b>.
9226 * This returns the "logical" position of the item within the
9227 * gengrid. For example, @c (0, 1) would stand for first row,
9232 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9235 * Set whether a given gengrid item is selected or not
9237 * @param item The gengrid item
9238 * @param selected Use @c EINA_TRUE, to make it selected, @c
9239 * EINA_FALSE to make it unselected
9241 * This sets the selected state of an item. If multi-selection is
9242 * not enabled on the containing gengrid and @p selected is @c
9243 * EINA_TRUE, any other previously selected items will get
9244 * unselected in favor of this new one.
9246 * @see elm_gengrid_item_selected_get()
9250 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9253 * Get whether a given gengrid item is selected or not
9255 * @param item The gengrid item
9256 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9258 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9260 * @see elm_gengrid_item_selected_set() for more details
9264 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9267 * Get the real Evas object created to implement the view of a
9268 * given gengrid item
9270 * @param item The gengrid item.
9271 * @return the Evas object implementing this item's view.
9273 * This returns the actual Evas object used to implement the
9274 * specified gengrid item's view. This may be @c NULL, as it may
9275 * not have been created or may have been deleted, at any time, by
9276 * the gengrid. <b>Do not modify this object</b> (move, resize,
9277 * show, hide, etc.), as the gengrid is controlling it. This
9278 * function is for querying, emitting custom signals or hooking
9279 * lower level callbacks for events on that object. Do not delete
9280 * this object under any circumstances.
9282 * @see elm_gengrid_item_data_get()
9286 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9289 * Show the portion of a gengrid's internal grid containing a given
9290 * item, @b immediately.
9292 * @param item The item to display
9294 * This causes gengrid to @b redraw its viewport's contents to the
9295 * region contining the given @p item item, if it is not fully
9298 * @see elm_gengrid_item_bring_in()
9302 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9305 * Animatedly bring in, to the visible area of a gengrid, a given
9308 * @param item The gengrid item to display
9310 * This causes gengrid to jump to the given @p item and show
9311 * it (by scrolling), if it is not fully visible. This will use
9312 * animation to do so and take a period of time to complete.
9314 * @see elm_gengrid_item_show()
9318 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9321 * Set whether a given gengrid item is disabled or not.
9323 * @param item The gengrid item
9324 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9325 * to enable it back.
9327 * A disabled item cannot be selected or unselected. It will also
9328 * change its appearance, to signal the user it's disabled.
9330 * @see elm_gengrid_item_disabled_get()
9334 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9337 * Get whether a given gengrid item is disabled or not.
9339 * @param item The gengrid item
9340 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9343 * @see elm_gengrid_item_disabled_set() for more details
9347 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9350 * Set the text to be shown in a given gengrid item's tooltips.
9352 * @param item The gengrid item
9353 * @param text The text to set in the content
9355 * This call will setup the text to be used as tooltip to that item
9356 * (analogous to elm_object_tooltip_text_set(), but being item
9357 * tooltips with higher precedence than object tooltips). It can
9358 * have only one tooltip at a time, so any previous tooltip data
9363 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9366 * Set the content to be shown in a given gengrid item's tooltip
9368 * @param item The gengrid item.
9369 * @param func The function returning the tooltip contents.
9370 * @param data What to provide to @a func as callback data/context.
9371 * @param del_cb Called when data is not needed anymore, either when
9372 * another callback replaces @p func, the tooltip is unset with
9373 * elm_gengrid_item_tooltip_unset() or the owner @p item
9374 * dies. This callback receives as its first parameter the
9375 * given @p data, being @c event_info the item handle.
9377 * This call will setup the tooltip's contents to @p item
9378 * (analogous to elm_object_tooltip_content_cb_set(), but being
9379 * item tooltips with higher precedence than object tooltips). It
9380 * can have only one tooltip at a time, so any previous tooltip
9381 * content will get removed. @p func (with @p data) will be called
9382 * every time Elementary needs to show the tooltip and it should
9383 * return a valid Evas object, which will be fully managed by the
9384 * tooltip system, getting deleted when the tooltip is gone.
9388 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);
9391 * Unset a tooltip from a given gengrid item
9393 * @param item gengrid item to remove a previously set tooltip from.
9395 * This call removes any tooltip set on @p item. The callback
9396 * provided as @c del_cb to
9397 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9398 * notify it is not used anymore (and have resources cleaned, if
9401 * @see elm_gengrid_item_tooltip_content_cb_set()
9405 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9408 * Set a different @b style for a given gengrid item's tooltip.
9410 * @param item gengrid item with tooltip set
9411 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9412 * "default", @c "transparent", etc)
9414 * Tooltips can have <b>alternate styles</b> to be displayed on,
9415 * which are defined by the theme set on Elementary. This function
9416 * works analogously as elm_object_tooltip_style_set(), but here
9417 * applied only to gengrid item objects. The default style for
9418 * tooltips is @c "default".
9420 * @note before you set a style you should define a tooltip with
9421 * elm_gengrid_item_tooltip_content_cb_set() or
9422 * elm_gengrid_item_tooltip_text_set()
9424 * @see elm_gengrid_item_tooltip_style_get()
9428 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9431 * Get the style set a given gengrid item's tooltip.
9433 * @param item gengrid item with tooltip already set on.
9434 * @return style the theme style in use, which defaults to
9435 * "default". If the object does not have a tooltip set,
9436 * then @c NULL is returned.
9438 * @see elm_gengrid_item_tooltip_style_set() for more details
9442 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9444 * @brief Disable size restrictions on an object's tooltip
9445 * @param item The tooltip's anchor object
9446 * @param disable If EINA_TRUE, size restrictions are disabled
9447 * @return EINA_FALSE on failure, EINA_TRUE on success
9449 * This function allows a tooltip to expand beyond its parant window's canvas.
9450 * It will instead be limited only by the size of the display.
9452 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9454 * @brief Retrieve size restriction state of an object's tooltip
9455 * @param item The tooltip's anchor object
9456 * @return If EINA_TRUE, size restrictions are disabled
9458 * This function returns whether a tooltip is allowed to expand beyond
9459 * its parant window's canvas.
9460 * It will instead be limited only by the size of the display.
9462 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9464 * Set the type of mouse pointer/cursor decoration to be shown,
9465 * when the mouse pointer is over the given gengrid widget item
9467 * @param item gengrid item to customize cursor on
9468 * @param cursor the cursor type's name
9470 * This function works analogously as elm_object_cursor_set(), but
9471 * here the cursor's changing area is restricted to the item's
9472 * area, and not the whole widget's. Note that that item cursors
9473 * have precedence over widget cursors, so that a mouse over @p
9474 * item will always show cursor @p type.
9476 * If this function is called twice for an object, a previously set
9477 * cursor will be unset on the second call.
9479 * @see elm_object_cursor_set()
9480 * @see elm_gengrid_item_cursor_get()
9481 * @see elm_gengrid_item_cursor_unset()
9485 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9488 * Get the type of mouse pointer/cursor decoration set to be shown,
9489 * when the mouse pointer is over the given gengrid widget item
9491 * @param item gengrid item with custom cursor set
9492 * @return the cursor type's name or @c NULL, if no custom cursors
9493 * were set to @p item (and on errors)
9495 * @see elm_object_cursor_get()
9496 * @see elm_gengrid_item_cursor_set() for more details
9497 * @see elm_gengrid_item_cursor_unset()
9501 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9504 * Unset any custom mouse pointer/cursor decoration set to be
9505 * shown, when the mouse pointer is over the given gengrid widget
9506 * item, thus making it show the @b default cursor again.
9508 * @param item a gengrid item
9510 * Use this call to undo any custom settings on this item's cursor
9511 * decoration, bringing it back to defaults (no custom style set).
9513 * @see elm_object_cursor_unset()
9514 * @see elm_gengrid_item_cursor_set() for more details
9518 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9521 * Set a different @b style for a given custom cursor set for a
9524 * @param item gengrid item with custom cursor set
9525 * @param style the <b>theme style</b> to use (e.g. @c "default",
9526 * @c "transparent", etc)
9528 * This function only makes sense when one is using custom mouse
9529 * cursor decorations <b>defined in a theme file</b> , which can
9530 * have, given a cursor name/type, <b>alternate styles</b> on
9531 * it. It works analogously as elm_object_cursor_style_set(), but
9532 * here applied only to gengrid item objects.
9534 * @warning Before you set a cursor style you should have defined a
9535 * custom cursor previously on the item, with
9536 * elm_gengrid_item_cursor_set()
9538 * @see elm_gengrid_item_cursor_engine_only_set()
9539 * @see elm_gengrid_item_cursor_style_get()
9543 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9546 * Get the current @b style set for a given gengrid item's custom
9549 * @param item gengrid item with custom cursor set.
9550 * @return style the cursor style in use. If the object does not
9551 * have a cursor set, then @c NULL is returned.
9553 * @see elm_gengrid_item_cursor_style_set() for more details
9557 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9560 * Set if the (custom) cursor for a given gengrid item should be
9561 * searched in its theme, also, or should only rely on the
9564 * @param item item with custom (custom) cursor already set on
9565 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9566 * only on those provided by the rendering engine, @c EINA_FALSE to
9567 * have them searched on the widget's theme, as well.
9569 * @note This call is of use only if you've set a custom cursor
9570 * for gengrid items, with elm_gengrid_item_cursor_set().
9572 * @note By default, cursors will only be looked for between those
9573 * provided by the rendering engine.
9577 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9580 * Get if the (custom) cursor for a given gengrid item is being
9581 * searched in its theme, also, or is only relying on the rendering
9584 * @param item a gengrid item
9585 * @return @c EINA_TRUE, if cursors are being looked for only on
9586 * those provided by the rendering engine, @c EINA_FALSE if they
9587 * are being searched on the widget's theme, as well.
9589 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9593 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9596 * Remove all items from a given gengrid widget
9598 * @param obj The gengrid object.
9600 * This removes (and deletes) all items in @p obj, leaving it
9603 * @see elm_gengrid_item_del(), to remove just one item.
9607 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9610 * Get the selected item in a given gengrid widget
9612 * @param obj The gengrid object.
9613 * @return The selected item's handleor @c NULL, if none is
9614 * selected at the moment (and on errors)
9616 * This returns the selected item in @p obj. If multi selection is
9617 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9618 * the first item in the list is selected, which might not be very
9619 * useful. For that case, see elm_gengrid_selected_items_get().
9623 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9626 * Get <b>a list</b> of selected items in a given gengrid
9628 * @param obj The gengrid object.
9629 * @return The list of selected items or @c NULL, if none is
9630 * selected at the moment (and on errors)
9632 * This returns a list of the selected items, in the order that
9633 * they appear in the grid. This list is only valid as long as no
9634 * more items are selected or unselected (or unselected implictly
9635 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9638 * @see elm_gengrid_selected_item_get()
9642 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9649 * @defgroup Clock Clock
9651 * @image html img/widget/clock/preview-00.png
9652 * @image latex img/widget/clock/preview-00.eps
9654 * This is a @b digital clock widget. In its default theme, it has a
9655 * vintage "flipping numbers clock" appearance, which will animate
9656 * sheets of individual algarisms individually as time goes by.
9658 * A newly created clock will fetch system's time (already
9659 * considering local time adjustments) to start with, and will tick
9660 * accondingly. It may or may not show seconds.
9662 * Clocks have an @b edition mode. When in it, the sheets will
9663 * display extra arrow indications on the top and bottom and the
9664 * user may click on them to raise or lower the time values. After
9665 * it's told to exit edition mode, it will keep ticking with that
9666 * new time set (it keeps the difference from local time).
9668 * Also, when under edition mode, user clicks on the cited arrows
9669 * which are @b held for some time will make the clock to flip the
9670 * sheet, thus editing the time, continuosly and automatically for
9671 * the user. The interval between sheet flips will keep growing in
9672 * time, so that it helps the user to reach a time which is distant
9675 * The time display is, by default, in military mode (24h), but an
9676 * am/pm indicator may be optionally shown, too, when it will
9679 * Smart callbacks one can register to:
9680 * - "changed" - the clock's user changed the time
9682 * Here is an example on its usage:
9683 * @li @ref clock_example
9692 * Identifiers for which clock digits should be editable, when a
9693 * clock widget is in edition mode. Values may be ORed together to
9694 * make a mask, naturally.
9696 * @see elm_clock_edit_set()
9697 * @see elm_clock_digit_edit_set()
9699 typedef enum _Elm_Clock_Digedit
9701 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9702 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9703 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9704 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9705 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9706 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9707 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9708 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9709 } Elm_Clock_Digedit;
9712 * Add a new clock widget to the given parent Elementary
9713 * (container) object
9715 * @param parent The parent object
9716 * @return a new clock widget handle or @c NULL, on errors
9718 * This function inserts a new clock widget on the canvas.
9722 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9725 * Set a clock widget's time, programmatically
9727 * @param obj The clock widget object
9728 * @param hrs The hours to set
9729 * @param min The minutes to set
9730 * @param sec The secondes to set
9732 * This function updates the time that is showed by the clock
9735 * Values @b must be set within the following ranges:
9736 * - 0 - 23, for hours
9737 * - 0 - 59, for minutes
9738 * - 0 - 59, for seconds,
9740 * even if the clock is not in "military" mode.
9742 * @warning The behavior for values set out of those ranges is @b
9747 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9750 * Get a clock widget's time values
9752 * @param obj The clock object
9753 * @param[out] hrs Pointer to the variable to get the hours value
9754 * @param[out] min Pointer to the variable to get the minutes value
9755 * @param[out] sec Pointer to the variable to get the seconds value
9757 * This function gets the time set for @p obj, returning
9758 * it on the variables passed as the arguments to function
9760 * @note Use @c NULL pointers on the time values you're not
9761 * interested in: they'll be ignored by the function.
9765 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9768 * Set whether a given clock widget is under <b>edition mode</b> or
9769 * under (default) displaying-only mode.
9771 * @param obj The clock object
9772 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9773 * put it back to "displaying only" mode
9775 * This function makes a clock's time to be editable or not <b>by
9776 * user interaction</b>. When in edition mode, clocks @b stop
9777 * ticking, until one brings them back to canonical mode. The
9778 * elm_clock_digit_edit_set() function will influence which digits
9779 * of the clock will be editable. By default, all of them will be
9780 * (#ELM_CLOCK_NONE).
9782 * @note am/pm sheets, if being shown, will @b always be editable
9783 * under edition mode.
9785 * @see elm_clock_edit_get()
9789 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9792 * Retrieve whether a given clock widget is under <b>edition
9793 * mode</b> or under (default) displaying-only mode.
9795 * @param obj The clock object
9796 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9799 * This function retrieves whether the clock's time can be edited
9800 * or not by user interaction.
9802 * @see elm_clock_edit_set() for more details
9806 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9809 * Set what digits of the given clock widget should be editable
9810 * when in edition mode.
9812 * @param obj The clock object
9813 * @param digedit Bit mask indicating the digits to be editable
9814 * (values in #Elm_Clock_Digedit).
9816 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9817 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9820 * @see elm_clock_digit_edit_get()
9824 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9827 * Retrieve what digits of the given clock widget should be
9828 * editable when in edition mode.
9830 * @param obj The clock object
9831 * @return Bit mask indicating the digits to be editable
9832 * (values in #Elm_Clock_Digedit).
9834 * @see elm_clock_digit_edit_set() for more details
9838 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9841 * Set if the given clock widget must show hours in military or
9844 * @param obj The clock object
9845 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9848 * This function sets if the clock must show hours in military or
9849 * am/pm mode. In some countries like Brazil the military mode
9850 * (00-24h-format) is used, in opposition to the USA, where the
9851 * am/pm mode is more commonly used.
9853 * @see elm_clock_show_am_pm_get()
9857 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9860 * Get if the given clock widget shows hours in military or am/pm
9863 * @param obj The clock object
9864 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9867 * This function gets if the clock shows hours in military or am/pm
9870 * @see elm_clock_show_am_pm_set() for more details
9874 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9877 * Set if the given clock widget must show time with seconds or not
9879 * @param obj The clock object
9880 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9882 * This function sets if the given clock must show or not elapsed
9883 * seconds. By default, they are @b not shown.
9885 * @see elm_clock_show_seconds_get()
9889 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9892 * Get whether the given clock widget is showing time with seconds
9895 * @param obj The clock object
9896 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9898 * This function gets whether @p obj is showing or not the elapsed
9901 * @see elm_clock_show_seconds_set()
9905 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9908 * Set the interval on time updates for an user mouse button hold
9909 * on clock widgets' time edition.
9911 * @param obj The clock object
9912 * @param interval The (first) interval value in seconds
9914 * This interval value is @b decreased while the user holds the
9915 * mouse pointer either incrementing or decrementing a given the
9916 * clock digit's value.
9918 * This helps the user to get to a given time distant from the
9919 * current one easier/faster, as it will start to flip quicker and
9920 * quicker on mouse button holds.
9922 * The calculation for the next flip interval value, starting from
9923 * the one set with this call, is the previous interval divided by
9924 * 1.05, so it decreases a little bit.
9926 * The default starting interval value for automatic flips is
9929 * @see elm_clock_interval_get()
9933 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9936 * Get the interval on time updates for an user mouse button hold
9937 * on clock widgets' time edition.
9939 * @param obj The clock object
9940 * @return The (first) interval value, in seconds, set on it
9942 * @see elm_clock_interval_set() for more details
9946 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9953 * @defgroup Layout Layout
9955 * @image html img/widget/layout/preview-00.png
9956 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9958 * @image html img/layout-predefined.png
9959 * @image latex img/layout-predefined.eps width=\textwidth
9961 * This is a container widget that takes a standard Edje design file and
9962 * wraps it very thinly in a widget.
9964 * An Edje design (theme) file has a very wide range of possibilities to
9965 * describe the behavior of elements added to the Layout. Check out the Edje
9966 * documentation and the EDC reference to get more information about what can
9967 * be done with Edje.
9969 * Just like @ref List, @ref Box, and other container widgets, any
9970 * object added to the Layout will become its child, meaning that it will be
9971 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9973 * The Layout widget can contain as many Contents, Boxes or Tables as
9974 * described in its theme file. For instance, objects can be added to
9975 * different Tables by specifying the respective Table part names. The same
9976 * is valid for Content and Box.
9978 * The objects added as child of the Layout will behave as described in the
9979 * part description where they were added. There are 3 possible types of
9980 * parts where a child can be added:
9982 * @section secContent Content (SWALLOW part)
9984 * Only one object can be added to the @c SWALLOW part (but you still can
9985 * have many @c SWALLOW parts and one object on each of them). Use the @c
9986 * elm_object_content_set/get/unset functions to set, retrieve and unset
9987 * objects as content of the @c SWALLOW. After being set to this part, the
9988 * object size, position, visibility, clipping and other description
9989 * properties will be totally controlled by the description of the given part
9990 * (inside the Edje theme file).
9992 * One can use @c evas_object_size_hint_* functions on the child to have some
9993 * kind of control over its behavior, but the resulting behavior will still
9994 * depend heavily on the @c SWALLOW part description.
9996 * The Edje theme also can change the part description, based on signals or
9997 * scripts running inside the theme. This change can also be animated. All of
9998 * this will affect the child object set as content accordingly. The object
9999 * size will be changed if the part size is changed, it will animate move if
10000 * the part is moving, and so on.
10002 * The following picture demonstrates a Layout widget with a child object
10003 * added to its @c SWALLOW:
10005 * @image html layout_swallow.png
10006 * @image latex layout_swallow.eps width=\textwidth
10008 * @section secBox Box (BOX part)
10010 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10011 * allows one to add objects to the box and have them distributed along its
10012 * area, accordingly to the specified @a layout property (now by @a layout we
10013 * mean the chosen layouting design of the Box, not the Layout widget
10016 * A similar effect for having a box with its position, size and other things
10017 * controlled by the Layout theme would be to create an Elementary @ref Box
10018 * widget and add it as a Content in the @c SWALLOW part.
10020 * The main difference of using the Layout Box is that its behavior, the box
10021 * properties like layouting format, padding, align, etc. will be all
10022 * controlled by the theme. This means, for example, that a signal could be
10023 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10024 * handled the signal by changing the box padding, or align, or both. Using
10025 * the Elementary @ref Box widget is not necessarily harder or easier, it
10026 * just depends on the circunstances and requirements.
10028 * The Layout Box can be used through the @c elm_layout_box_* set of
10031 * The following picture demonstrates a Layout widget with many child objects
10032 * added to its @c BOX part:
10034 * @image html layout_box.png
10035 * @image latex layout_box.eps width=\textwidth
10037 * @section secTable Table (TABLE part)
10039 * Just like the @ref secBox, the Layout Table is very similar to the
10040 * Elementary @ref Table widget. It allows one to add objects to the Table
10041 * specifying the row and column where the object should be added, and any
10042 * column or row span if necessary.
10044 * Again, we could have this design by adding a @ref Table widget to the @c
10045 * SWALLOW part using elm_object_part_content_set(). The same difference happens
10046 * here when choosing to use the Layout Table (a @c TABLE part) instead of
10047 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10049 * The Layout Table can be used through the @c elm_layout_table_* set of
10052 * The following picture demonstrates a Layout widget with many child objects
10053 * added to its @c TABLE part:
10055 * @image html layout_table.png
10056 * @image latex layout_table.eps width=\textwidth
10058 * @section secPredef Predefined Layouts
10060 * Another interesting thing about the Layout widget is that it offers some
10061 * predefined themes that come with the default Elementary theme. These
10062 * themes can be set by the call elm_layout_theme_set(), and provide some
10063 * basic functionality depending on the theme used.
10065 * Most of them already send some signals, some already provide a toolbar or
10066 * back and next buttons.
10068 * These are available predefined theme layouts. All of them have class = @c
10069 * layout, group = @c application, and style = one of the following options:
10071 * @li @c toolbar-content - application with toolbar and main content area
10072 * @li @c toolbar-content-back - application with toolbar and main content
10073 * area with a back button and title area
10074 * @li @c toolbar-content-back-next - application with toolbar and main
10075 * content area with a back and next buttons and title area
10076 * @li @c content-back - application with a main content area with a back
10077 * button and title area
10078 * @li @c content-back-next - application with a main content area with a
10079 * back and next buttons and title area
10080 * @li @c toolbar-vbox - application with toolbar and main content area as a
10082 * @li @c toolbar-table - application with toolbar and main content area as a
10085 * @section secExamples Examples
10087 * Some examples of the Layout widget can be found here:
10088 * @li @ref layout_example_01
10089 * @li @ref layout_example_02
10090 * @li @ref layout_example_03
10091 * @li @ref layout_example_edc
10096 * Add a new layout to the parent
10098 * @param parent The parent object
10099 * @return The new object or NULL if it cannot be created
10101 * @see elm_layout_file_set()
10102 * @see elm_layout_theme_set()
10106 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10108 * Set the file that will be used as layout
10110 * @param obj The layout object
10111 * @param file The path to file (edj) that will be used as layout
10112 * @param group The group that the layout belongs in edje file
10114 * @return (1 = success, 0 = error)
10118 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10120 * Set the edje group from the elementary theme that will be used as layout
10122 * @param obj The layout object
10123 * @param clas the clas of the group
10124 * @param group the group
10125 * @param style the style to used
10127 * @return (1 = success, 0 = error)
10131 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10133 * Set the layout content.
10135 * @param obj The layout object
10136 * @param swallow The swallow part name in the edje file
10137 * @param content The child that will be added in this layout object
10139 * Once the content object is set, a previously set one will be deleted.
10140 * If you want to keep that old content object, use the
10141 * elm_object_part_content_unset() function.
10143 * @note In an Edje theme, the part used as a content container is called @c
10144 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10145 * expected to be a part name just like the second parameter of
10146 * elm_layout_box_append().
10148 * @see elm_layout_box_append()
10149 * @see elm_object_part_content_get()
10150 * @see elm_object_part_content_unset()
10152 * @deprecated use elm_object_part_content_set() instead
10156 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10158 * Get the child object in the given content part.
10160 * @param obj The layout object
10161 * @param swallow The SWALLOW part to get its content
10163 * @return The swallowed object or NULL if none or an error occurred
10165 * @deprecated use elm_object_part_content_get() instead
10169 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10171 * Unset the layout content.
10173 * @param obj The layout object
10174 * @param swallow The swallow part name in the edje file
10175 * @return The content that was being used
10177 * Unparent and return the content object which was set for this part.
10179 * @deprecated use elm_object_part_content_unset() instead
10183 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10185 * Set the text of the given part
10187 * @param obj The layout object
10188 * @param part The TEXT part where to set the text
10189 * @param text The text to set
10192 * @deprecated use elm_object_part_text_set() instead.
10194 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10196 * Get the text set in the given part
10198 * @param obj The layout object
10199 * @param part The TEXT part to retrieve the text off
10201 * @return The text set in @p part
10204 * @deprecated use elm_object_part_text_get() instead.
10206 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10208 * Append child to layout box part.
10210 * @param obj the layout object
10211 * @param part the box part to which the object will be appended.
10212 * @param child the child object to append to box.
10214 * Once the object is appended, it will become child of the layout. Its
10215 * lifetime will be bound to the layout, whenever the layout dies the child
10216 * will be deleted automatically. One should use elm_layout_box_remove() to
10217 * make this layout forget about the object.
10219 * @see elm_layout_box_prepend()
10220 * @see elm_layout_box_insert_before()
10221 * @see elm_layout_box_insert_at()
10222 * @see elm_layout_box_remove()
10226 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10228 * Prepend child to layout box part.
10230 * @param obj the layout object
10231 * @param part the box part to prepend.
10232 * @param child the child object to prepend to box.
10234 * Once the object is prepended, it will become child of the layout. Its
10235 * lifetime will be bound to the layout, whenever the layout dies the child
10236 * will be deleted automatically. One should use elm_layout_box_remove() to
10237 * make this layout forget about the object.
10239 * @see elm_layout_box_append()
10240 * @see elm_layout_box_insert_before()
10241 * @see elm_layout_box_insert_at()
10242 * @see elm_layout_box_remove()
10246 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10248 * Insert child to layout box part before a reference object.
10250 * @param obj the layout object
10251 * @param part the box part to insert.
10252 * @param child the child object to insert into box.
10253 * @param reference another reference object to insert before in box.
10255 * Once the object is inserted, it will become child of the layout. Its
10256 * lifetime will be bound to the layout, whenever the layout dies the child
10257 * will be deleted automatically. One should use elm_layout_box_remove() to
10258 * make this layout forget about the object.
10260 * @see elm_layout_box_append()
10261 * @see elm_layout_box_prepend()
10262 * @see elm_layout_box_insert_before()
10263 * @see elm_layout_box_remove()
10267 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10269 * Insert child to layout box part at a given position.
10271 * @param obj the layout object
10272 * @param part the box part to insert.
10273 * @param child the child object to insert into box.
10274 * @param pos the numeric position >=0 to insert the child.
10276 * Once the object is inserted, it will become child of the layout. Its
10277 * lifetime will be bound to the layout, whenever the layout dies the child
10278 * will be deleted automatically. One should use elm_layout_box_remove() to
10279 * make this layout forget about the object.
10281 * @see elm_layout_box_append()
10282 * @see elm_layout_box_prepend()
10283 * @see elm_layout_box_insert_before()
10284 * @see elm_layout_box_remove()
10288 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10290 * Remove a child of the given part box.
10292 * @param obj The layout object
10293 * @param part The box part name to remove child.
10294 * @param child The object to remove from box.
10295 * @return The object that was being used, or NULL if not found.
10297 * The object will be removed from the box part and its lifetime will
10298 * not be handled by the layout anymore. This is equivalent to
10299 * elm_object_part_content_unset() for box.
10301 * @see elm_layout_box_append()
10302 * @see elm_layout_box_remove_all()
10306 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10308 * Remove all children of the given part box.
10310 * @param obj The layout object
10311 * @param part The box part name to remove child.
10312 * @param clear If EINA_TRUE, then all objects will be deleted as
10313 * well, otherwise they will just be removed and will be
10314 * dangling on the canvas.
10316 * The objects will be removed from the box part and their lifetime will
10317 * not be handled by the layout anymore. This is equivalent to
10318 * elm_layout_box_remove() for all box children.
10320 * @see elm_layout_box_append()
10321 * @see elm_layout_box_remove()
10325 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10327 * Insert child to layout table part.
10329 * @param obj the layout object
10330 * @param part the box part to pack child.
10331 * @param child_obj the child object to pack into table.
10332 * @param col the column to which the child should be added. (>= 0)
10333 * @param row the row to which the child should be added. (>= 0)
10334 * @param colspan how many columns should be used to store this object. (>=
10336 * @param rowspan how many rows should be used to store this object. (>= 1)
10338 * Once the object is inserted, it will become child of the table. Its
10339 * lifetime will be bound to the layout, and whenever the layout dies the
10340 * child will be deleted automatically. One should use
10341 * elm_layout_table_remove() to make this layout forget about the object.
10343 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10344 * more space than a single cell. For instance, the following code:
10346 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10349 * Would result in an object being added like the following picture:
10351 * @image html layout_colspan.png
10352 * @image latex layout_colspan.eps width=\textwidth
10354 * @see elm_layout_table_unpack()
10355 * @see elm_layout_table_clear()
10359 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);
10361 * Unpack (remove) a child of the given part table.
10363 * @param obj The layout object
10364 * @param part The table part name to remove child.
10365 * @param child_obj The object to remove from table.
10366 * @return The object that was being used, or NULL if not found.
10368 * The object will be unpacked from the table part and its lifetime
10369 * will not be handled by the layout anymore. This is equivalent to
10370 * elm_object_part_content_unset() for table.
10372 * @see elm_layout_table_pack()
10373 * @see elm_layout_table_clear()
10377 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10379 * Remove all the child objects of the given part table.
10381 * @param obj The layout object
10382 * @param part The table part name to remove child.
10383 * @param clear If EINA_TRUE, then all objects will be deleted as
10384 * well, otherwise they will just be removed and will be
10385 * dangling on the canvas.
10387 * The objects will be removed from the table part and their lifetime will
10388 * not be handled by the layout anymore. This is equivalent to
10389 * elm_layout_table_unpack() for all table children.
10391 * @see elm_layout_table_pack()
10392 * @see elm_layout_table_unpack()
10396 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10398 * Get the edje layout
10400 * @param obj The layout object
10402 * @return A Evas_Object with the edje layout settings loaded
10403 * with function elm_layout_file_set
10405 * This returns the edje object. It is not expected to be used to then
10406 * swallow objects via edje_object_part_swallow() for example. Use
10407 * elm_object_part_content_set() instead so child object handling and sizing is
10410 * @note This function should only be used if you really need to call some
10411 * low level Edje function on this edje object. All the common stuff (setting
10412 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10413 * with proper elementary functions.
10415 * @see elm_object_signal_callback_add()
10416 * @see elm_object_signal_emit()
10417 * @see elm_object_part_text_set()
10418 * @see elm_object_part_content_set()
10419 * @see elm_layout_box_append()
10420 * @see elm_layout_table_pack()
10421 * @see elm_layout_data_get()
10425 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10427 * Get the edje data from the given layout
10429 * @param obj The layout object
10430 * @param key The data key
10432 * @return The edje data string
10434 * This function fetches data specified inside the edje theme of this layout.
10435 * This function return NULL if data is not found.
10437 * In EDC this comes from a data block within the group block that @p
10438 * obj was loaded from. E.g.
10445 * item: "key1" "value1";
10446 * item: "key2" "value2";
10454 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10458 * @param obj The layout object
10460 * Manually forces a sizing re-evaluation. This is useful when the minimum
10461 * size required by the edje theme of this layout has changed. The change on
10462 * the minimum size required by the edje theme is not immediately reported to
10463 * the elementary layout, so one needs to call this function in order to tell
10464 * the widget (layout) that it needs to reevaluate its own size.
10466 * The minimum size of the theme is calculated based on minimum size of
10467 * parts, the size of elements inside containers like box and table, etc. All
10468 * of this can change due to state changes, and that's when this function
10469 * should be called.
10471 * Also note that a standard signal of "size,eval" "elm" emitted from the
10472 * edje object will cause this to happen too.
10476 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10479 * Sets a specific cursor for an edje part.
10481 * @param obj The layout object.
10482 * @param part_name a part from loaded edje group.
10483 * @param cursor cursor name to use, see Elementary_Cursor.h
10485 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10486 * part not exists or it has "mouse_events: 0".
10490 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10493 * Get the cursor to be shown when mouse is over an edje part
10495 * @param obj The layout object.
10496 * @param part_name a part from loaded edje group.
10497 * @return the cursor name.
10501 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10504 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10506 * @param obj The layout object.
10507 * @param part_name a part from loaded edje group, that had a cursor set
10508 * with elm_layout_part_cursor_set().
10512 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10515 * Sets a specific cursor style for an edje part.
10517 * @param obj The layout object.
10518 * @param part_name a part from loaded edje group.
10519 * @param style the theme style to use (default, transparent, ...)
10521 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10522 * part not exists or it did not had a cursor set.
10526 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10529 * Gets a specific cursor style for an edje part.
10531 * @param obj The layout object.
10532 * @param part_name a part from loaded edje group.
10534 * @return the theme style in use, defaults to "default". If the
10535 * object does not have a cursor set, then NULL is returned.
10539 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10542 * Sets if the cursor set should be searched on the theme or should use
10543 * the provided by the engine, only.
10545 * @note before you set if should look on theme you should define a
10546 * cursor with elm_layout_part_cursor_set(). By default it will only
10547 * look for cursors provided by the engine.
10549 * @param obj The layout object.
10550 * @param part_name a part from loaded edje group.
10551 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10552 * or should also search on widget's theme as well (EINA_FALSE)
10554 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10555 * part not exists or it did not had a cursor set.
10559 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);
10562 * Gets a specific cursor engine_only for an edje part.
10564 * @param obj The layout object.
10565 * @param part_name a part from loaded edje group.
10567 * @return whenever the cursor is just provided by engine or also from theme.
10571 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10574 * @def elm_layout_icon_set
10575 * Convenience macro to set the icon object in a layout that follows the
10576 * Elementary naming convention for its parts.
10580 #define elm_layout_icon_set(_ly, _obj) \
10583 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10584 if ((_obj)) sig = "elm,state,icon,visible"; \
10585 else sig = "elm,state,icon,hidden"; \
10586 elm_object_signal_emit((_ly), sig, "elm"); \
10590 * @def elm_layout_icon_get
10591 * Convienience macro to get the icon object from a layout that follows the
10592 * Elementary naming convention for its parts.
10596 #define elm_layout_icon_get(_ly) \
10597 elm_object_part_content_get((_ly), "elm.swallow.icon")
10600 * @def elm_layout_end_set
10601 * Convienience macro to set the end object in a layout that follows the
10602 * Elementary naming convention for its parts.
10606 #define elm_layout_end_set(_ly, _obj) \
10609 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10610 if ((_obj)) sig = "elm,state,end,visible"; \
10611 else sig = "elm,state,end,hidden"; \
10612 elm_object_signal_emit((_ly), sig, "elm"); \
10616 * @def elm_layout_end_get
10617 * Convienience macro to get the end object in a layout that follows the
10618 * Elementary naming convention for its parts.
10622 #define elm_layout_end_get(_ly) \
10623 elm_object_part_content_get((_ly), "elm.swallow.end")
10626 * @def elm_layout_label_set
10627 * Convienience macro to set the label in a layout that follows the
10628 * Elementary naming convention for its parts.
10631 * @deprecated use elm_object_text_set() instead.
10633 #define elm_layout_label_set(_ly, _txt) \
10634 elm_layout_text_set((_ly), "elm.text", (_txt))
10637 * @def elm_layout_label_get
10638 * Convenience macro to get the label in a layout that follows the
10639 * Elementary naming convention for its parts.
10642 * @deprecated use elm_object_text_set() instead.
10644 #define elm_layout_label_get(_ly) \
10645 elm_layout_text_get((_ly), "elm.text")
10647 /* smart callbacks called:
10648 * "theme,changed" - when elm theme is changed.
10652 * @defgroup Notify Notify
10654 * @image html img/widget/notify/preview-00.png
10655 * @image latex img/widget/notify/preview-00.eps
10657 * Display a container in a particular region of the parent(top, bottom,
10658 * etc). A timeout can be set to automatically hide the notify. This is so
10659 * that, after an evas_object_show() on a notify object, if a timeout was set
10660 * on it, it will @b automatically get hidden after that time.
10662 * Signals that you can add callbacks for are:
10663 * @li "timeout" - when timeout happens on notify and it's hidden
10664 * @li "block,clicked" - when a click outside of the notify happens
10666 * Default contents parts of the notify widget that you can use for are:
10667 * @li "default" - A content of the notify
10669 * @ref tutorial_notify show usage of the API.
10674 * @brief Possible orient values for notify.
10676 * This values should be used in conjunction to elm_notify_orient_set() to
10677 * set the position in which the notify should appear(relative to its parent)
10678 * and in conjunction with elm_notify_orient_get() to know where the notify
10681 typedef enum _Elm_Notify_Orient
10683 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10684 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10685 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10686 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10687 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10688 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10689 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10690 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10691 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10692 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10693 } Elm_Notify_Orient;
10695 * @brief Add a new notify to the parent
10697 * @param parent The parent object
10698 * @return The new object or NULL if it cannot be created
10700 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10702 * @brief Set the content of the notify widget
10704 * @param obj The notify object
10705 * @param content The content will be filled in this notify object
10707 * Once the content object is set, a previously set one will be deleted. If
10708 * you want to keep that old content object, use the
10709 * elm_notify_content_unset() function.
10711 * @deprecated use elm_object_content_set() instead
10714 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10716 * @brief Unset the content of the notify widget
10718 * @param obj The notify object
10719 * @return The content that was being used
10721 * Unparent and return the content object which was set for this widget
10723 * @see elm_notify_content_set()
10724 * @deprecated use elm_object_content_unset() instead
10727 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10729 * @brief Return the content of the notify widget
10731 * @param obj The notify object
10732 * @return The content that is being used
10734 * @see elm_notify_content_set()
10735 * @deprecated use elm_object_content_get() instead
10738 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10740 * @brief Set the notify parent
10742 * @param obj The notify object
10743 * @param content The new parent
10745 * Once the parent object is set, a previously set one will be disconnected
10748 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10750 * @brief Get the notify parent
10752 * @param obj The notify object
10753 * @return The parent
10755 * @see elm_notify_parent_set()
10757 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10759 * @brief Set the orientation
10761 * @param obj The notify object
10762 * @param orient The new orientation
10764 * Sets the position in which the notify will appear in its parent.
10766 * @see @ref Elm_Notify_Orient for possible values.
10768 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10770 * @brief Return the orientation
10771 * @param obj The notify object
10772 * @return The orientation of the notification
10774 * @see elm_notify_orient_set()
10775 * @see Elm_Notify_Orient
10777 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10779 * @brief Set the time interval after which the notify window is going to be
10782 * @param obj The notify object
10783 * @param time The timeout in seconds
10785 * This function sets a timeout and starts the timer controlling when the
10786 * notify is hidden. Since calling evas_object_show() on a notify restarts
10787 * the timer controlling when the notify is hidden, setting this before the
10788 * notify is shown will in effect mean starting the timer when the notify is
10791 * @note Set a value <= 0.0 to disable a running timer.
10793 * @note If the value > 0.0 and the notify is previously visible, the
10794 * timer will be started with this value, canceling any running timer.
10796 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10798 * @brief Return the timeout value (in seconds)
10799 * @param obj the notify object
10801 * @see elm_notify_timeout_set()
10803 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10805 * @brief Sets whether events should be passed to by a click outside
10808 * @param obj The notify object
10809 * @param repeats EINA_TRUE Events are repeats, else no
10811 * When true if the user clicks outside the window the events will be caught
10812 * by the others widgets, else the events are blocked.
10814 * @note The default value is EINA_TRUE.
10816 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10818 * @brief Return true if events are repeat below the notify object
10819 * @param obj the notify object
10821 * @see elm_notify_repeat_events_set()
10823 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10829 * @defgroup Hover Hover
10831 * @image html img/widget/hover/preview-00.png
10832 * @image latex img/widget/hover/preview-00.eps
10834 * A Hover object will hover over its @p parent object at the @p target
10835 * location. Anything in the background will be given a darker coloring to
10836 * indicate that the hover object is on top (at the default theme). When the
10837 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10838 * clicked that @b doesn't cause the hover to be dismissed.
10840 * A Hover object has two parents. One parent that owns it during creation
10841 * and the other parent being the one over which the hover object spans.
10844 * @note The hover object will take up the entire space of @p target
10847 * Elementary has the following styles for the hover widget:
10851 * @li hoversel_vertical
10853 * The following are the available position for content:
10865 * Signals that you can add callbacks for are:
10866 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10867 * @li "smart,changed" - a content object placed under the "smart"
10868 * policy was replaced to a new slot direction.
10870 * See @ref tutorial_hover for more information.
10874 typedef enum _Elm_Hover_Axis
10876 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10877 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10878 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10879 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10882 * @brief Adds a hover object to @p parent
10884 * @param parent The parent object
10885 * @return The hover object or NULL if one could not be created
10887 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10889 * @brief Sets the target object for the hover.
10891 * @param obj The hover object
10892 * @param target The object to center the hover onto.
10894 * This function will cause the hover to be centered on the target object.
10896 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10898 * @brief Gets the target object for the hover.
10900 * @param obj The hover object
10901 * @return The target object for the hover.
10903 * @see elm_hover_target_set()
10905 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10907 * @brief Sets the parent object for the hover.
10909 * @param obj The hover object
10910 * @param parent The object to locate the hover over.
10912 * This function will cause the hover to take up the entire space that the
10913 * parent object fills.
10915 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10917 * @brief Gets the parent object for the hover.
10919 * @param obj The hover object
10920 * @return The parent object to locate the hover over.
10922 * @see elm_hover_parent_set()
10924 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10926 * @brief Sets the content of the hover object and the direction in which it
10929 * @param obj The hover object
10930 * @param swallow The direction that the object will be displayed
10931 * at. Accepted values are "left", "top-left", "top", "top-right",
10932 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10934 * @param content The content to place at @p swallow
10936 * Once the content object is set for a given direction, a previously
10937 * set one (on the same direction) will be deleted. If you want to
10938 * keep that old content object, use the elm_hover_content_unset()
10941 * All directions may have contents at the same time, except for
10942 * "smart". This is a special placement hint and its use case
10943 * independs of the calculations coming from
10944 * elm_hover_best_content_location_get(). Its use is for cases when
10945 * one desires only one hover content, but with a dynamic special
10946 * placement within the hover area. The content's geometry, whenever
10947 * it changes, will be used to decide on a best location, not
10948 * extrapolating the hover's parent object view to show it in (still
10949 * being the hover's target determinant of its medium part -- move and
10950 * resize it to simulate finger sizes, for example). If one of the
10951 * directions other than "smart" are used, a previously content set
10952 * using it will be deleted, and vice-versa.
10954 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10956 * @brief Get the content of the hover object, in a given direction.
10958 * Return the content object which was set for this widget in the
10959 * @p swallow direction.
10961 * @param obj The hover object
10962 * @param swallow The direction that the object was display at.
10963 * @return The content that was being used
10965 * @see elm_hover_content_set()
10967 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10969 * @brief Unset the content of the hover object, in a given direction.
10971 * Unparent and return the content object set at @p swallow direction.
10973 * @param obj The hover object
10974 * @param swallow The direction that the object was display at.
10975 * @return The content that was being used.
10977 * @see elm_hover_content_set()
10979 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10981 * @brief Returns the best swallow location for content in the hover.
10983 * @param obj The hover object
10984 * @param pref_axis The preferred orientation axis for the hover object to use
10985 * @return The edje location to place content into the hover or @c
10988 * Best is defined here as the location at which there is the most available
10991 * @p pref_axis may be one of
10992 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10993 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10994 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10995 * - @c ELM_HOVER_AXIS_BOTH -- both
10997 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10998 * nescessarily be along the horizontal axis("left" or "right"). If
10999 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11000 * be along the vertical axis("top" or "bottom"). Chossing
11001 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11002 * returned position may be in either axis.
11004 * @see elm_hover_content_set()
11006 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11013 * @defgroup Entry Entry
11015 * @image html img/widget/entry/preview-00.png
11016 * @image latex img/widget/entry/preview-00.eps width=\textwidth
11017 * @image html img/widget/entry/preview-01.png
11018 * @image latex img/widget/entry/preview-01.eps width=\textwidth
11019 * @image html img/widget/entry/preview-02.png
11020 * @image latex img/widget/entry/preview-02.eps width=\textwidth
11021 * @image html img/widget/entry/preview-03.png
11022 * @image latex img/widget/entry/preview-03.eps width=\textwidth
11024 * An entry is a convenience widget which shows a box that the user can
11025 * enter text into. Entries by default don't scroll, so they grow to
11026 * accomodate the entire text, resizing the parent window as needed. This
11027 * can be changed with the elm_entry_scrollable_set() function.
11029 * They can also be single line or multi line (the default) and when set
11030 * to multi line mode they support text wrapping in any of the modes
11031 * indicated by #Elm_Wrap_Type.
11033 * Other features include password mode, filtering of inserted text with
11034 * elm_entry_text_filter_append() and related functions, inline "items" and
11035 * formatted markup text.
11037 * @section entry-markup Formatted text
11039 * The markup tags supported by the Entry are defined by the theme, but
11040 * even when writing new themes or extensions it's a good idea to stick to
11041 * a sane default, to maintain coherency and avoid application breakages.
11042 * Currently defined by the default theme are the following tags:
11043 * @li \<br\>: Inserts a line break.
11044 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11046 * @li \<tab\>: Inserts a tab.
11047 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11049 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11050 * @li \<link\>...\</link\>: Underlines the enclosed text.
11051 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11053 * @section entry-special Special markups
11055 * Besides those used to format text, entries support two special markup
11056 * tags used to insert clickable portions of text or items inlined within
11059 * @subsection entry-anchors Anchors
11061 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11062 * \</a\> tags and an event will be generated when this text is clicked,
11066 * This text is outside <a href=anc-01>but this one is an anchor</a>
11069 * The @c href attribute in the opening tag gives the name that will be
11070 * used to identify the anchor and it can be any valid utf8 string.
11072 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11073 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11074 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11075 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11078 * @subsection entry-items Items
11080 * Inlined in the text, any other @c Evas_Object can be inserted by using
11081 * \<item\> tags this way:
11084 * <item size=16x16 vsize=full href=emoticon/haha></item>
11087 * Just like with anchors, the @c href identifies each item, but these need,
11088 * in addition, to indicate their size, which is done using any one of
11089 * @c size, @c absize or @c relsize attributes. These attributes take their
11090 * value in the WxH format, where W is the width and H the height of the
11093 * @li absize: Absolute pixel size for the item. Whatever value is set will
11094 * be the item's size regardless of any scale value the object may have
11095 * been set to. The final line height will be adjusted to fit larger items.
11096 * @li size: Similar to @c absize, but it's adjusted to the scale value set
11098 * @li relsize: Size is adjusted for the item to fit within the current
11101 * Besides their size, items are specificed a @c vsize value that affects
11102 * how their final size and position are calculated. The possible values
11104 * @li ascent: Item will be placed within the line's baseline and its
11105 * ascent. That is, the height between the line where all characters are
11106 * positioned and the highest point in the line. For @c size and @c absize
11107 * items, the descent value will be added to the total line height to make
11108 * them fit. @c relsize items will be adjusted to fit within this space.
11109 * @li full: Items will be placed between the descent and ascent, or the
11110 * lowest point in the line and its highest.
11112 * The next image shows different configurations of items and how
11113 * the previously mentioned options affect their sizes. In all cases,
11114 * the green line indicates the ascent, blue for the baseline and red for
11117 * @image html entry_item.png
11118 * @image latex entry_item.eps width=\textwidth
11120 * And another one to show how size differs from absize. In the first one,
11121 * the scale value is set to 1.0, while the second one is using one of 2.0.
11123 * @image html entry_item_scale.png
11124 * @image latex entry_item_scale.eps width=\textwidth
11126 * After the size for an item is calculated, the entry will request an
11127 * object to place in its space. For this, the functions set with
11128 * elm_entry_item_provider_append() and related functions will be called
11129 * in order until one of them returns a @c non-NULL value. If no providers
11130 * are available, or all of them return @c NULL, then the entry falls back
11131 * to one of the internal defaults, provided the name matches with one of
11134 * All of the following are currently supported:
11137 * - emoticon/angry-shout
11138 * - emoticon/crazy-laugh
11139 * - emoticon/evil-laugh
11141 * - emoticon/goggle-smile
11142 * - emoticon/grumpy
11143 * - emoticon/grumpy-smile
11144 * - emoticon/guilty
11145 * - emoticon/guilty-smile
11147 * - emoticon/half-smile
11148 * - emoticon/happy-panting
11150 * - emoticon/indifferent
11152 * - emoticon/knowing-grin
11154 * - emoticon/little-bit-sorry
11155 * - emoticon/love-lots
11157 * - emoticon/minimal-smile
11158 * - emoticon/not-happy
11159 * - emoticon/not-impressed
11161 * - emoticon/opensmile
11164 * - emoticon/squint-laugh
11165 * - emoticon/surprised
11166 * - emoticon/suspicious
11167 * - emoticon/tongue-dangling
11168 * - emoticon/tongue-poke
11170 * - emoticon/unhappy
11171 * - emoticon/very-sorry
11174 * - emoticon/worried
11177 * Alternatively, an item may reference an image by its path, using
11178 * the URI form @c file:///path/to/an/image.png and the entry will then
11179 * use that image for the item.
11181 * @section entry-files Loading and saving files
11183 * Entries have convinience functions to load text from a file and save
11184 * changes back to it after a short delay. The automatic saving is enabled
11185 * by default, but can be disabled with elm_entry_autosave_set() and files
11186 * can be loaded directly as plain text or have any markup in them
11187 * recognized. See elm_entry_file_set() for more details.
11189 * @section entry-signals Emitted signals
11191 * This widget emits the following signals:
11193 * @li "changed": The text within the entry was changed.
11194 * @li "changed,user": The text within the entry was changed because of user interaction.
11195 * @li "activated": The enter key was pressed on a single line entry.
11196 * @li "press": A mouse button has been pressed on the entry.
11197 * @li "longpressed": A mouse button has been pressed and held for a couple
11199 * @li "clicked": The entry has been clicked (mouse press and release).
11200 * @li "clicked,double": The entry has been double clicked.
11201 * @li "clicked,triple": The entry has been triple clicked.
11202 * @li "focused": The entry has received focus.
11203 * @li "unfocused": The entry has lost focus.
11204 * @li "selection,paste": A paste of the clipboard contents was requested.
11205 * @li "selection,copy": A copy of the selected text into the clipboard was
11207 * @li "selection,cut": A cut of the selected text into the clipboard was
11209 * @li "selection,start": A selection has begun and no previous selection
11211 * @li "selection,changed": The current selection has changed.
11212 * @li "selection,cleared": The current selection has been cleared.
11213 * @li "cursor,changed": The cursor has changed position.
11214 * @li "anchor,clicked": An anchor has been clicked. The event_info
11215 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11216 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11217 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11218 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11219 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11220 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11221 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11222 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11223 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11224 * @li "preedit,changed": The preedit string has changed.
11225 * @li "language,changed": Program language changed.
11227 * @section entry-examples
11229 * An overview of the Entry API can be seen in @ref entry_example_01
11234 * @typedef Elm_Entry_Anchor_Info
11236 * The info sent in the callback for the "anchor,clicked" signals emitted
11239 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11241 * @struct _Elm_Entry_Anchor_Info
11243 * The info sent in the callback for the "anchor,clicked" signals emitted
11246 struct _Elm_Entry_Anchor_Info
11248 const char *name; /**< The name of the anchor, as stated in its href */
11249 int button; /**< The mouse button used to click on it */
11250 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11251 y, /**< Anchor geometry, relative to canvas */
11252 w, /**< Anchor geometry, relative to canvas */
11253 h; /**< Anchor geometry, relative to canvas */
11256 * @typedef Elm_Entry_Filter_Cb
11257 * This callback type is used by entry filters to modify text.
11258 * @param data The data specified as the last param when adding the filter
11259 * @param entry The entry object
11260 * @param text A pointer to the location of the text being filtered. This data can be modified,
11261 * but any additional allocations must be managed by the user.
11262 * @see elm_entry_text_filter_append
11263 * @see elm_entry_text_filter_prepend
11265 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11268 * @typedef Elm_Entry_Change_Info
11269 * This corresponds to Edje_Entry_Change_Info. Includes information about
11270 * a change in the entry.
11272 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11276 * This adds an entry to @p parent object.
11278 * By default, entries are:
11282 * @li autosave is enabled
11284 * @param parent The parent object
11285 * @return The new object or NULL if it cannot be created
11287 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11289 * Sets the entry to single line mode.
11291 * In single line mode, entries don't ever wrap when the text reaches the
11292 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11293 * key will generate an @c "activate" event instead of adding a new line.
11295 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11296 * and pressing enter will break the text into a different line
11297 * without generating any events.
11299 * @param obj The entry object
11300 * @param single_line If true, the text in the entry
11301 * will be on a single line.
11303 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11305 * Gets whether the entry is set to be single line.
11307 * @param obj The entry object
11308 * @return single_line If true, the text in the entry is set to display
11309 * on a single line.
11311 * @see elm_entry_single_line_set()
11313 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11315 * Sets the entry to password mode.
11317 * In password mode, entries are implicitly single line and the display of
11318 * any text in them is replaced with asterisks (*).
11320 * @param obj The entry object
11321 * @param password If true, password mode is enabled.
11323 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11325 * Gets whether the entry is set to password mode.
11327 * @param obj The entry object
11328 * @return If true, the entry is set to display all characters
11329 * as asterisks (*).
11331 * @see elm_entry_password_set()
11333 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11335 * This sets the text displayed within the entry to @p entry.
11337 * @param obj The entry object
11338 * @param entry The text to be displayed
11340 * @deprecated Use elm_object_text_set() instead.
11341 * @note Using this function bypasses text filters
11343 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11345 * This returns the text currently shown in object @p entry.
11346 * See also elm_entry_entry_set().
11348 * @param obj The entry object
11349 * @return The currently displayed text or NULL on failure
11351 * @deprecated Use elm_object_text_get() instead.
11353 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11355 * Appends @p entry to the text of the entry.
11357 * Adds the text in @p entry to the end of any text already present in the
11360 * The appended text is subject to any filters set for the widget.
11362 * @param obj The entry object
11363 * @param entry The text to be displayed
11365 * @see elm_entry_text_filter_append()
11367 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11369 * Gets whether the entry is empty.
11371 * Empty means no text at all. If there are any markup tags, like an item
11372 * tag for which no provider finds anything, and no text is displayed, this
11373 * function still returns EINA_FALSE.
11375 * @param obj The entry object
11376 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11378 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11380 * Gets any selected text within the entry.
11382 * If there's any selected text in the entry, this function returns it as
11383 * a string in markup format. NULL is returned if no selection exists or
11384 * if an error occurred.
11386 * The returned value points to an internal string and should not be freed
11387 * or modified in any way. If the @p entry object is deleted or its
11388 * contents are changed, the returned pointer should be considered invalid.
11390 * @param obj The entry object
11391 * @return The selected text within the entry or NULL on failure
11393 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11395 * Returns the actual textblock object of the entry.
11397 * This function exposes the internal textblock object that actually
11398 * contains and draws the text. This should be used for low-level
11399 * manipulations that are otherwise not possible.
11401 * Changing the textblock directly from here will not notify edje/elm to
11402 * recalculate the textblock size automatically, so any modifications
11403 * done to the textblock returned by this function should be followed by
11404 * a call to elm_entry_calc_force().
11406 * The return value is marked as const as an additional warning.
11407 * One should not use the returned object with any of the generic evas
11408 * functions (geometry_get/resize/move and etc), but only with the textblock
11409 * functions; The former will either not work at all, or break the correct
11412 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11413 * the internal textblock object. Do NOT cache the returned object, and try
11414 * not to mix calls on this object with regular elm_entry calls (which may
11415 * change the internal textblock object). This applies to all cursors
11416 * returned from textblock calls, and all the other derivative values.
11418 * @param obj The entry object
11419 * @return The textblock object.
11421 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11423 * Forces calculation of the entry size and text layouting.
11425 * This should be used after modifying the textblock object directly. See
11426 * elm_entry_textblock_get() for more information.
11428 * @param obj The entry object
11430 * @see elm_entry_textblock_get()
11432 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11434 * Inserts the given text into the entry at the current cursor position.
11436 * This inserts text at the cursor position as if it was typed
11437 * by the user (note that this also allows markup which a user
11438 * can't just "type" as it would be converted to escaped text, so this
11439 * call can be used to insert things like emoticon items or bold push/pop
11440 * tags, other font and color change tags etc.)
11442 * If any selection exists, it will be replaced by the inserted text.
11444 * The inserted text is subject to any filters set for the widget.
11446 * @param obj The entry object
11447 * @param entry The text to insert
11449 * @see elm_entry_text_filter_append()
11451 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11453 * Set the line wrap type to use on multi-line entries.
11455 * Sets the wrap type used by the entry to any of the specified in
11456 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11457 * line (without inserting a line break or paragraph separator) when it
11458 * reaches the far edge of the widget.
11460 * Note that this only makes sense for multi-line entries. A widget set
11461 * to be single line will never wrap.
11463 * @param obj The entry object
11464 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11466 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11468 * Gets the wrap mode the entry was set to use.
11470 * @param obj The entry object
11471 * @return Wrap type
11473 * @see also elm_entry_line_wrap_set()
11475 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11477 * Sets if the entry is to be editable or not.
11479 * By default, entries are editable and when focused, any text input by the
11480 * user will be inserted at the current cursor position. But calling this
11481 * function with @p editable as EINA_FALSE will prevent the user from
11482 * inputting text into the entry.
11484 * The only way to change the text of a non-editable entry is to use
11485 * elm_object_text_set(), elm_entry_entry_insert() and other related
11488 * @param obj The entry object
11489 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11490 * if not, the entry is read-only and no user input is allowed.
11492 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11494 * Gets whether the entry is editable or not.
11496 * @param obj The entry object
11497 * @return If true, the entry is editable by the user.
11498 * If false, it is not editable by the user
11500 * @see elm_entry_editable_set()
11502 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11504 * This drops any existing text selection within the entry.
11506 * @param obj The entry object
11508 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11510 * This selects all text within the entry.
11512 * @param obj The entry object
11514 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11516 * This moves the cursor one place to the right within the entry.
11518 * @param obj The entry object
11519 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11521 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11523 * This moves the cursor one place to the left within the entry.
11525 * @param obj The entry object
11526 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11528 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11530 * This moves the cursor one line up within the entry.
11532 * @param obj The entry object
11533 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11535 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11537 * This moves the cursor one line down within the entry.
11539 * @param obj The entry object
11540 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11542 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11544 * This moves the cursor to the beginning of the entry.
11546 * @param obj The entry object
11548 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11550 * This moves the cursor to the end of the entry.
11552 * @param obj The entry object
11554 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11556 * This moves the cursor to the beginning of the current line.
11558 * @param obj The entry object
11560 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11562 * This moves the cursor to the end of the current line.
11564 * @param obj The entry object
11566 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11568 * This begins a selection within the entry as though
11569 * the user were holding down the mouse button to make a selection.
11571 * @param obj The entry object
11573 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11575 * This ends a selection within the entry as though
11576 * the user had just released the mouse button while making a selection.
11578 * @param obj The entry object
11580 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11582 * Gets whether a format node exists at the current cursor position.
11584 * A format node is anything that defines how the text is rendered. It can
11585 * be a visible format node, such as a line break or a paragraph separator,
11586 * or an invisible one, such as bold begin or end tag.
11587 * This function returns whether any format node exists at the current
11590 * @param obj The entry object
11591 * @return EINA_TRUE if the current cursor position contains a format node,
11592 * EINA_FALSE otherwise.
11594 * @see elm_entry_cursor_is_visible_format_get()
11596 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11598 * Gets if the current cursor position holds a visible format node.
11600 * @param obj The entry object
11601 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11602 * if it's an invisible one or no format exists.
11604 * @see elm_entry_cursor_is_format_get()
11606 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11608 * Gets the character pointed by the cursor at its current position.
11610 * This function returns a string with the utf8 character stored at the
11611 * current cursor position.
11612 * Only the text is returned, any format that may exist will not be part
11613 * of the return value.
11615 * @param obj The entry object
11616 * @return The text pointed by the cursors.
11618 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11620 * This function returns the geometry of the cursor.
11622 * It's useful if you want to draw something on the cursor (or where it is),
11623 * or for example in the case of scrolled entry where you want to show the
11626 * @param obj The entry object
11627 * @param x returned geometry
11628 * @param y returned geometry
11629 * @param w returned geometry
11630 * @param h returned geometry
11631 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11633 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);
11635 * Sets the cursor position in the entry to the given value
11637 * The value in @p pos is the index of the character position within the
11638 * contents of the string as returned by elm_entry_cursor_pos_get().
11640 * @param obj The entry object
11641 * @param pos The position of the cursor
11643 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11645 * Retrieves the current position of the cursor in the entry
11647 * @param obj The entry object
11648 * @return The cursor position
11650 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11652 * This executes a "cut" action on the selected text in the entry.
11654 * @param obj The entry object
11656 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11658 * This executes a "copy" action on the selected text in the entry.
11660 * @param obj The entry object
11662 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11664 * This executes a "paste" action in the entry.
11666 * @param obj The entry object
11668 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11670 * This clears and frees the items in a entry's contextual (longpress)
11673 * @param obj The entry object
11675 * @see elm_entry_context_menu_item_add()
11677 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11679 * This adds an item to the entry's contextual menu.
11681 * A longpress on an entry will make the contextual menu show up, if this
11682 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11683 * By default, this menu provides a few options like enabling selection mode,
11684 * which is useful on embedded devices that need to be explicit about it,
11685 * and when a selection exists it also shows the copy and cut actions.
11687 * With this function, developers can add other options to this menu to
11688 * perform any action they deem necessary.
11690 * @param obj The entry object
11691 * @param label The item's text label
11692 * @param icon_file The item's icon file
11693 * @param icon_type The item's icon type
11694 * @param func The callback to execute when the item is clicked
11695 * @param data The data to associate with the item for related functions
11697 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);
11699 * This disables the entry's contextual (longpress) menu.
11701 * @param obj The entry object
11702 * @param disabled If true, the menu is disabled
11704 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11706 * This returns whether the entry's contextual (longpress) menu is
11709 * @param obj The entry object
11710 * @return If true, the menu is disabled
11712 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11714 * This appends a custom item provider to the list for that entry
11716 * This appends the given callback. The list is walked from beginning to end
11717 * with each function called given the item href string in the text. If the
11718 * function returns an object handle other than NULL (it should create an
11719 * object to do this), then this object is used to replace that item. If
11720 * not the next provider is called until one provides an item object, or the
11721 * default provider in entry does.
11723 * @param obj The entry object
11724 * @param func The function called to provide the item object
11725 * @param data The data passed to @p func
11727 * @see @ref entry-items
11729 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);
11731 * This prepends a custom item provider to the list for that entry
11733 * This prepends the given callback. See elm_entry_item_provider_append() for
11736 * @param obj The entry object
11737 * @param func The function called to provide the item object
11738 * @param data The data passed to @p func
11740 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);
11742 * This removes a custom item provider to the list for that entry
11744 * This removes the given callback. See elm_entry_item_provider_append() for
11747 * @param obj The entry object
11748 * @param func The function called to provide the item object
11749 * @param data The data passed to @p func
11751 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);
11753 * Append a filter function for text inserted in the entry
11755 * Append the given callback to the list. This functions will be called
11756 * whenever any text is inserted into the entry, with the text to be inserted
11757 * as a parameter. The callback function is free to alter the text in any way
11758 * it wants, but it must remember to free the given pointer and update it.
11759 * If the new text is to be discarded, the function can free it and set its
11760 * text parameter to NULL. This will also prevent any following filters from
11763 * @param obj The entry object
11764 * @param func The function to use as text filter
11765 * @param data User data to pass to @p func
11767 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11769 * Prepend a filter function for text insdrted in the entry
11771 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11772 * for more information
11774 * @param obj The entry object
11775 * @param func The function to use as text filter
11776 * @param data User data to pass to @p func
11778 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11780 * Remove a filter from the list
11782 * Removes the given callback from the filter list. See
11783 * elm_entry_text_filter_append() for more information.
11785 * @param obj The entry object
11786 * @param func The filter function to remove
11787 * @param data The user data passed when adding the function
11789 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11791 * This converts a markup (HTML-like) string into UTF-8.
11793 * The returned string is a malloc'ed buffer and it should be freed when
11794 * not needed anymore.
11796 * @param s The string (in markup) to be converted
11797 * @return The converted string (in UTF-8). It should be freed.
11799 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11801 * This converts a UTF-8 string into markup (HTML-like).
11803 * The returned string is a malloc'ed buffer and it should be freed when
11804 * not needed anymore.
11806 * @param s The string (in UTF-8) to be converted
11807 * @return The converted string (in markup). It should be freed.
11809 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11811 * This sets the file (and implicitly loads it) for the text to display and
11812 * then edit. All changes are written back to the file after a short delay if
11813 * the entry object is set to autosave (which is the default).
11815 * If the entry had any other file set previously, any changes made to it
11816 * will be saved if the autosave feature is enabled, otherwise, the file
11817 * will be silently discarded and any non-saved changes will be lost.
11819 * @param obj The entry object
11820 * @param file The path to the file to load and save
11821 * @param format The file format
11823 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11825 * Gets the file being edited by the entry.
11827 * This function can be used to retrieve any file set on the entry for
11828 * edition, along with the format used to load and save it.
11830 * @param obj The entry object
11831 * @param file The path to the file to load and save
11832 * @param format The file format
11834 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11836 * This function writes any changes made to the file set with
11837 * elm_entry_file_set()
11839 * @param obj The entry object
11841 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11843 * This sets the entry object to 'autosave' the loaded text file or not.
11845 * @param obj The entry object
11846 * @param autosave Autosave the loaded file or not
11848 * @see elm_entry_file_set()
11850 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11852 * This gets the entry object's 'autosave' status.
11854 * @param obj The entry object
11855 * @return Autosave the loaded file or not
11857 * @see elm_entry_file_set()
11859 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11861 * Control pasting of text and images for the widget.
11863 * Normally the entry allows both text and images to be pasted. By setting
11864 * textonly to be true, this prevents images from being pasted.
11866 * Note this only changes the behaviour of text.
11868 * @param obj The entry object
11869 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11870 * text+image+other.
11872 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11874 * Getting elm_entry text paste/drop mode.
11876 * In textonly mode, only text may be pasted or dropped into the widget.
11878 * @param obj The entry object
11879 * @return If the widget only accepts text from pastes.
11881 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11883 * Enable or disable scrolling in entry
11885 * Normally the entry is not scrollable unless you enable it with this call.
11887 * @param obj The entry object
11888 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11890 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11892 * Get the scrollable state of the entry
11894 * Normally the entry is not scrollable. This gets the scrollable state
11895 * of the entry. See elm_entry_scrollable_set() for more information.
11897 * @param obj The entry object
11898 * @return The scrollable state
11900 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11902 * This sets a widget to be displayed to the left of a scrolled entry.
11904 * @param obj The scrolled entry object
11905 * @param icon The widget to display on the left side of the scrolled
11908 * @note A previously set widget will be destroyed.
11909 * @note If the object being set does not have minimum size hints set,
11910 * it won't get properly displayed.
11912 * @see elm_entry_end_set()
11914 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11916 * Gets the leftmost widget of the scrolled entry. This object is
11917 * owned by the scrolled entry and should not be modified.
11919 * @param obj The scrolled entry object
11920 * @return the left widget inside the scroller
11922 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11924 * Unset the leftmost widget of the scrolled entry, unparenting and
11927 * @param obj The scrolled entry object
11928 * @return the previously set icon sub-object of this entry, on
11931 * @see elm_entry_icon_set()
11933 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11935 * Sets the visibility of the left-side widget of the scrolled entry,
11936 * set by elm_entry_icon_set().
11938 * @param obj The scrolled entry object
11939 * @param setting EINA_TRUE if the object should be displayed,
11940 * EINA_FALSE if not.
11942 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11944 * This sets a widget to be displayed to the end of a scrolled entry.
11946 * @param obj The scrolled entry object
11947 * @param end The widget to display on the right side of the scrolled
11950 * @note A previously set widget will be destroyed.
11951 * @note If the object being set does not have minimum size hints set,
11952 * it won't get properly displayed.
11954 * @see elm_entry_icon_set
11956 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11958 * Gets the endmost widget of the scrolled entry. This object is owned
11959 * by the scrolled entry and should not be modified.
11961 * @param obj The scrolled entry object
11962 * @return the right widget inside the scroller
11964 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11966 * Unset the endmost widget of the scrolled entry, unparenting and
11969 * @param obj The scrolled entry object
11970 * @return the previously set icon sub-object of this entry, on
11973 * @see elm_entry_icon_set()
11975 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11977 * Sets the visibility of the end widget of the scrolled entry, set by
11978 * elm_entry_end_set().
11980 * @param obj The scrolled entry object
11981 * @param setting EINA_TRUE if the object should be displayed,
11982 * EINA_FALSE if not.
11984 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11986 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11989 * Setting an entry to single-line mode with elm_entry_single_line_set()
11990 * will automatically disable the display of scrollbars when the entry
11991 * moves inside its scroller.
11993 * @param obj The scrolled entry object
11994 * @param h The horizontal scrollbar policy to apply
11995 * @param v The vertical scrollbar policy to apply
11997 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11999 * This enables/disables bouncing within the entry.
12001 * This function sets whether the entry will bounce when scrolling reaches
12002 * the end of the contained entry.
12004 * @param obj The scrolled entry object
12005 * @param h The horizontal bounce state
12006 * @param v The vertical bounce state
12008 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12010 * Get the bounce mode
12012 * @param obj The Entry object
12013 * @param h_bounce Allow bounce horizontally
12014 * @param v_bounce Allow bounce vertically
12016 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12018 /* pre-made filters for entries */
12020 * @typedef Elm_Entry_Filter_Limit_Size
12022 * Data for the elm_entry_filter_limit_size() entry filter.
12024 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12026 * @struct _Elm_Entry_Filter_Limit_Size
12028 * Data for the elm_entry_filter_limit_size() entry filter.
12030 struct _Elm_Entry_Filter_Limit_Size
12032 int max_char_count; /**< The maximum number of characters allowed. */
12033 int max_byte_count; /**< The maximum number of bytes allowed*/
12036 * Filter inserted text based on user defined character and byte limits
12038 * Add this filter to an entry to limit the characters that it will accept
12039 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12040 * The funtion works on the UTF-8 representation of the string, converting
12041 * it from the set markup, thus not accounting for any format in it.
12043 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12044 * it as data when setting the filter. In it, it's possible to set limits
12045 * by character count or bytes (any of them is disabled if 0), and both can
12046 * be set at the same time. In that case, it first checks for characters,
12049 * The function will cut the inserted text in order to allow only the first
12050 * number of characters that are still allowed. The cut is made in
12051 * characters, even when limiting by bytes, in order to always contain
12052 * valid ones and avoid half unicode characters making it in.
12054 * This filter, like any others, does not apply when setting the entry text
12055 * directly with elm_object_text_set() (or the deprecated
12056 * elm_entry_entry_set()).
12058 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12060 * @typedef Elm_Entry_Filter_Accept_Set
12062 * Data for the elm_entry_filter_accept_set() entry filter.
12064 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12066 * @struct _Elm_Entry_Filter_Accept_Set
12068 * Data for the elm_entry_filter_accept_set() entry filter.
12070 struct _Elm_Entry_Filter_Accept_Set
12072 const char *accepted; /**< Set of characters accepted in the entry. */
12073 const char *rejected; /**< Set of characters rejected from the entry. */
12076 * Filter inserted text based on accepted or rejected sets of characters
12078 * Add this filter to an entry to restrict the set of accepted characters
12079 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12080 * This structure contains both accepted and rejected sets, but they are
12081 * mutually exclusive.
12083 * The @c accepted set takes preference, so if it is set, the filter will
12084 * only work based on the accepted characters, ignoring anything in the
12085 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12087 * In both cases, the function filters by matching utf8 characters to the
12088 * raw markup text, so it can be used to remove formatting tags.
12090 * This filter, like any others, does not apply when setting the entry text
12091 * directly with elm_object_text_set() (or the deprecated
12092 * elm_entry_entry_set()).
12094 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12096 * Set the input panel layout of the entry
12098 * @param obj The entry object
12099 * @param layout layout type
12101 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12103 * Get the input panel layout of the entry
12105 * @param obj The entry object
12106 * @return layout type
12108 * @see elm_entry_input_panel_layout_set
12110 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12112 * Set the autocapitalization type on the immodule.
12114 * @param obj The entry object
12115 * @param autocapital_type The type of autocapitalization
12117 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12119 * Retrieve the autocapitalization type on the immodule.
12121 * @param obj The entry object
12122 * @return autocapitalization type
12124 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12126 * Sets the attribute to show the input panel automatically.
12128 * @param obj The entry object
12129 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12131 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12133 * Retrieve the attribute to show the input panel automatically.
12135 * @param obj The entry object
12136 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12138 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12144 /* composite widgets - these basically put together basic widgets above
12145 * in convenient packages that do more than basic stuff */
12149 * @defgroup Anchorview Anchorview
12151 * @image html img/widget/anchorview/preview-00.png
12152 * @image latex img/widget/anchorview/preview-00.eps
12154 * Anchorview is for displaying text that contains markup with anchors
12155 * like <c>\<a href=1234\>something\</\></c> in it.
12157 * Besides being styled differently, the anchorview widget provides the
12158 * necessary functionality so that clicking on these anchors brings up a
12159 * popup with user defined content such as "call", "add to contacts" or
12160 * "open web page". This popup is provided using the @ref Hover widget.
12162 * This widget is very similar to @ref Anchorblock, so refer to that
12163 * widget for an example. The only difference Anchorview has is that the
12164 * widget is already provided with scrolling functionality, so if the
12165 * text set to it is too large to fit in the given space, it will scroll,
12166 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12167 * text can be displayed.
12169 * This widget emits the following signals:
12170 * @li "anchor,clicked": will be called when an anchor is clicked. The
12171 * @p event_info parameter on the callback will be a pointer of type
12172 * ::Elm_Entry_Anchorview_Info.
12174 * See @ref Anchorblock for an example on how to use both of them.
12183 * @typedef Elm_Entry_Anchorview_Info
12185 * The info sent in the callback for "anchor,clicked" signals emitted by
12186 * the Anchorview widget.
12188 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12190 * @struct _Elm_Entry_Anchorview_Info
12192 * The info sent in the callback for "anchor,clicked" signals emitted by
12193 * the Anchorview widget.
12195 struct _Elm_Entry_Anchorview_Info
12197 const char *name; /**< Name of the anchor, as indicated in its href
12199 int button; /**< The mouse button used to click on it */
12200 Evas_Object *hover; /**< The hover object to use for the popup */
12202 Evas_Coord x, y, w, h;
12203 } anchor, /**< Geometry selection of text used as anchor */
12204 hover_parent; /**< Geometry of the object used as parent by the
12206 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12207 for content on the left side of
12208 the hover. Before calling the
12209 callback, the widget will make the
12210 necessary calculations to check
12211 which sides are fit to be set with
12212 content, based on the position the
12213 hover is activated and its distance
12214 to the edges of its parent object
12216 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12217 the right side of the hover.
12218 See @ref hover_left */
12219 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12220 of the hover. See @ref hover_left */
12221 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12222 below the hover. See @ref
12226 * Add a new Anchorview object
12228 * @param parent The parent object
12229 * @return The new object or NULL if it cannot be created
12231 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12233 * Set the text to show in the anchorview
12235 * Sets the text of the anchorview to @p text. This text can include markup
12236 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12237 * text that will be specially styled and react to click events, ended with
12238 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12239 * "anchor,clicked" signal that you can attach a callback to with
12240 * evas_object_smart_callback_add(). The name of the anchor given in the
12241 * event info struct will be the one set in the href attribute, in this
12242 * case, anchorname.
12244 * Other markup can be used to style the text in different ways, but it's
12245 * up to the style defined in the theme which tags do what.
12246 * @deprecated use elm_object_text_set() instead.
12248 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12250 * Get the markup text set for the anchorview
12252 * Retrieves the text set on the anchorview, with markup tags included.
12254 * @param obj The anchorview object
12255 * @return The markup text set or @c NULL if nothing was set or an error
12257 * @deprecated use elm_object_text_set() instead.
12259 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12261 * Set the parent of the hover popup
12263 * Sets the parent object to use by the hover created by the anchorview
12264 * when an anchor is clicked. See @ref Hover for more details on this.
12265 * If no parent is set, the same anchorview object will be used.
12267 * @param obj The anchorview object
12268 * @param parent The object to use as parent for the hover
12270 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12272 * Get the parent of the hover popup
12274 * Get the object used as parent for the hover created by the anchorview
12275 * widget. See @ref Hover for more details on this.
12277 * @param obj The anchorview object
12278 * @return The object used as parent for the hover, NULL if none is set.
12280 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12282 * Set the style that the hover should use
12284 * When creating the popup hover, anchorview will request that it's
12285 * themed according to @p style.
12287 * @param obj The anchorview object
12288 * @param style The style to use for the underlying hover
12290 * @see elm_object_style_set()
12292 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12294 * Get the style that the hover should use
12296 * Get the style the hover created by anchorview will use.
12298 * @param obj The anchorview object
12299 * @return The style to use by the hover. NULL means the default is used.
12301 * @see elm_object_style_set()
12303 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12305 * Ends the hover popup in the anchorview
12307 * When an anchor is clicked, the anchorview widget will create a hover
12308 * object to use as a popup with user provided content. This function
12309 * terminates this popup, returning the anchorview to its normal state.
12311 * @param obj The anchorview object
12313 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12315 * Set bouncing behaviour when the scrolled content reaches an edge
12317 * Tell the internal scroller object whether it should bounce or not
12318 * when it reaches the respective edges for each axis.
12320 * @param obj The anchorview object
12321 * @param h_bounce Whether to bounce or not in the horizontal axis
12322 * @param v_bounce Whether to bounce or not in the vertical axis
12324 * @see elm_scroller_bounce_set()
12326 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12328 * Get the set bouncing behaviour of the internal scroller
12330 * Get whether the internal scroller should bounce when the edge of each
12331 * axis is reached scrolling.
12333 * @param obj The anchorview object
12334 * @param h_bounce Pointer where to store the bounce state of the horizontal
12336 * @param v_bounce Pointer where to store the bounce state of the vertical
12339 * @see elm_scroller_bounce_get()
12341 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12343 * Appends a custom item provider to the given anchorview
12345 * Appends the given function to the list of items providers. This list is
12346 * called, one function at a time, with the given @p data pointer, the
12347 * anchorview object and, in the @p item parameter, the item name as
12348 * referenced in its href string. Following functions in the list will be
12349 * called in order until one of them returns something different to NULL,
12350 * which should be an Evas_Object which will be used in place of the item
12353 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12354 * href=item/name\>\</item\>
12356 * @param obj The anchorview object
12357 * @param func The function to add to the list of providers
12358 * @param data User data that will be passed to the callback function
12360 * @see elm_entry_item_provider_append()
12362 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);
12364 * Prepend a custom item provider to the given anchorview
12366 * Like elm_anchorview_item_provider_append(), but it adds the function
12367 * @p func to the beginning of the list, instead of the end.
12369 * @param obj The anchorview object
12370 * @param func The function to add to the list of providers
12371 * @param data User data that will be passed to the callback function
12373 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);
12375 * Remove a custom item provider from the list of the given anchorview
12377 * Removes the function and data pairing that matches @p func and @p data.
12378 * That is, unless the same function and same user data are given, the
12379 * function will not be removed from the list. This allows us to add the
12380 * same callback several times, with different @p data pointers and be
12381 * able to remove them later without conflicts.
12383 * @param obj The anchorview object
12384 * @param func The function to remove from the list
12385 * @param data The data matching the function to remove from the list
12387 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);
12394 * @defgroup Anchorblock Anchorblock
12396 * @image html img/widget/anchorblock/preview-00.png
12397 * @image latex img/widget/anchorblock/preview-00.eps
12399 * Anchorblock is for displaying text that contains markup with anchors
12400 * like <c>\<a href=1234\>something\</\></c> in it.
12402 * Besides being styled differently, the anchorblock widget provides the
12403 * necessary functionality so that clicking on these anchors brings up a
12404 * popup with user defined content such as "call", "add to contacts" or
12405 * "open web page". This popup is provided using the @ref Hover widget.
12407 * This widget emits the following signals:
12408 * @li "anchor,clicked": will be called when an anchor is clicked. The
12409 * @p event_info parameter on the callback will be a pointer of type
12410 * ::Elm_Entry_Anchorblock_Info.
12416 * Since examples are usually better than plain words, we might as well
12417 * try @ref tutorial_anchorblock_example "one".
12420 * @addtogroup Anchorblock
12424 * @typedef Elm_Entry_Anchorblock_Info
12426 * The info sent in the callback for "anchor,clicked" signals emitted by
12427 * the Anchorblock widget.
12429 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12431 * @struct _Elm_Entry_Anchorblock_Info
12433 * The info sent in the callback for "anchor,clicked" signals emitted by
12434 * the Anchorblock widget.
12436 struct _Elm_Entry_Anchorblock_Info
12438 const char *name; /**< Name of the anchor, as indicated in its href
12440 int button; /**< The mouse button used to click on it */
12441 Evas_Object *hover; /**< The hover object to use for the popup */
12443 Evas_Coord x, y, w, h;
12444 } anchor, /**< Geometry selection of text used as anchor */
12445 hover_parent; /**< Geometry of the object used as parent by the
12447 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12448 for content on the left side of
12449 the hover. Before calling the
12450 callback, the widget will make the
12451 necessary calculations to check
12452 which sides are fit to be set with
12453 content, based on the position the
12454 hover is activated and its distance
12455 to the edges of its parent object
12457 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12458 the right side of the hover.
12459 See @ref hover_left */
12460 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12461 of the hover. See @ref hover_left */
12462 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12463 below the hover. See @ref
12467 * Add a new Anchorblock object
12469 * @param parent The parent object
12470 * @return The new object or NULL if it cannot be created
12472 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12474 * Set the text to show in the anchorblock
12476 * Sets the text of the anchorblock to @p text. This text can include markup
12477 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12478 * of text that will be specially styled and react to click events, ended
12479 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12480 * "anchor,clicked" signal that you can attach a callback to with
12481 * evas_object_smart_callback_add(). The name of the anchor given in the
12482 * event info struct will be the one set in the href attribute, in this
12483 * case, anchorname.
12485 * Other markup can be used to style the text in different ways, but it's
12486 * up to the style defined in the theme which tags do what.
12487 * @deprecated use elm_object_text_set() instead.
12489 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12491 * Get the markup text set for the anchorblock
12493 * Retrieves the text set on the anchorblock, with markup tags included.
12495 * @param obj The anchorblock object
12496 * @return The markup text set or @c NULL if nothing was set or an error
12498 * @deprecated use elm_object_text_set() instead.
12500 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12502 * Set the parent of the hover popup
12504 * Sets the parent object to use by the hover created by the anchorblock
12505 * when an anchor is clicked. See @ref Hover for more details on this.
12507 * @param obj The anchorblock object
12508 * @param parent The object to use as parent for the hover
12510 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12512 * Get the parent of the hover popup
12514 * Get the object used as parent for the hover created by the anchorblock
12515 * widget. See @ref Hover for more details on this.
12516 * If no parent is set, the same anchorblock object will be used.
12518 * @param obj The anchorblock object
12519 * @return The object used as parent for the hover, NULL if none is set.
12521 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12523 * Set the style that the hover should use
12525 * When creating the popup hover, anchorblock will request that it's
12526 * themed according to @p style.
12528 * @param obj The anchorblock object
12529 * @param style The style to use for the underlying hover
12531 * @see elm_object_style_set()
12533 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12535 * Get the style that the hover should use
12537 * Get the style, the hover created by anchorblock will use.
12539 * @param obj The anchorblock object
12540 * @return The style to use by the hover. NULL means the default is used.
12542 * @see elm_object_style_set()
12544 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12546 * Ends the hover popup in the anchorblock
12548 * When an anchor is clicked, the anchorblock widget will create a hover
12549 * object to use as a popup with user provided content. This function
12550 * terminates this popup, returning the anchorblock to its normal state.
12552 * @param obj The anchorblock object
12554 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12556 * Appends a custom item provider to the given anchorblock
12558 * Appends the given function to the list of items providers. This list is
12559 * called, one function at a time, with the given @p data pointer, the
12560 * anchorblock object and, in the @p item parameter, the item name as
12561 * referenced in its href string. Following functions in the list will be
12562 * called in order until one of them returns something different to NULL,
12563 * which should be an Evas_Object which will be used in place of the item
12566 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12567 * href=item/name\>\</item\>
12569 * @param obj The anchorblock object
12570 * @param func The function to add to the list of providers
12571 * @param data User data that will be passed to the callback function
12573 * @see elm_entry_item_provider_append()
12575 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);
12577 * Prepend a custom item provider to the given anchorblock
12579 * Like elm_anchorblock_item_provider_append(), but it adds the function
12580 * @p func to the beginning of the list, instead of the end.
12582 * @param obj The anchorblock object
12583 * @param func The function to add to the list of providers
12584 * @param data User data that will be passed to the callback function
12586 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);
12588 * Remove a custom item provider from the list of the given anchorblock
12590 * Removes the function and data pairing that matches @p func and @p data.
12591 * That is, unless the same function and same user data are given, the
12592 * function will not be removed from the list. This allows us to add the
12593 * same callback several times, with different @p data pointers and be
12594 * able to remove them later without conflicts.
12596 * @param obj The anchorblock object
12597 * @param func The function to remove from the list
12598 * @param data The data matching the function to remove from the list
12600 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);
12606 * @defgroup Bubble Bubble
12608 * @image html img/widget/bubble/preview-00.png
12609 * @image latex img/widget/bubble/preview-00.eps
12610 * @image html img/widget/bubble/preview-01.png
12611 * @image latex img/widget/bubble/preview-01.eps
12612 * @image html img/widget/bubble/preview-02.png
12613 * @image latex img/widget/bubble/preview-02.eps
12615 * @brief The Bubble is a widget to show text similar to how speech is
12616 * represented in comics.
12618 * The bubble widget contains 5 important visual elements:
12619 * @li The frame is a rectangle with rounded edjes and an "arrow".
12620 * @li The @p icon is an image to which the frame's arrow points to.
12621 * @li The @p label is a text which appears to the right of the icon if the
12622 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12624 * @li The @p info is a text which appears to the right of the label. Info's
12625 * font is of a ligther color than label.
12626 * @li The @p content is an evas object that is shown inside the frame.
12628 * The position of the arrow, icon, label and info depends on which corner is
12629 * selected. The four available corners are:
12630 * @li "top_left" - Default
12632 * @li "bottom_left"
12633 * @li "bottom_right"
12635 * Signals that you can add callbacks for are:
12636 * @li "clicked" - This is called when a user has clicked the bubble.
12638 * Default contents parts of the bubble that you can use for are:
12639 * @li "default" - A content of the bubble
12640 * @li "icon" - An icon of the bubble
12642 * Default text parts of the button widget that you can use for are:
12643 * @li NULL - Label of the bubble
12645 * For an example of using a buble see @ref bubble_01_example_page "this".
12651 * Add a new bubble to the parent
12653 * @param parent The parent object
12654 * @return The new object or NULL if it cannot be created
12656 * This function adds a text bubble to the given parent evas object.
12658 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12660 * Set the label of the bubble
12662 * @param obj The bubble object
12663 * @param label The string to set in the label
12665 * This function sets the title of the bubble. Where this appears depends on
12666 * the selected corner.
12667 * @deprecated use elm_object_text_set() instead.
12669 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12671 * Get the label of the bubble
12673 * @param obj The bubble object
12674 * @return The string of set in the label
12676 * This function gets the title of the bubble.
12677 * @deprecated use elm_object_text_get() instead.
12679 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12681 * Set the info of the bubble
12683 * @param obj The bubble object
12684 * @param info The given info about the bubble
12686 * This function sets the info of the bubble. Where this appears depends on
12687 * the selected corner.
12688 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12690 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12692 * Get the info of the bubble
12694 * @param obj The bubble object
12696 * @return The "info" string of the bubble
12698 * This function gets the info text.
12699 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12701 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12703 * Set the content to be shown in the bubble
12705 * Once the content object is set, a previously set one will be deleted.
12706 * If you want to keep the old content object, use the
12707 * elm_bubble_content_unset() function.
12709 * @param obj The bubble object
12710 * @param content The given content of the bubble
12712 * This function sets the content shown on the middle of the bubble.
12714 * @deprecated use elm_object_content_set() instead
12717 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12719 * Get the content shown in the bubble
12721 * Return the content object which is set for this widget.
12723 * @param obj The bubble object
12724 * @return The content that is being used
12726 * @deprecated use elm_object_content_get() instead
12729 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12731 * Unset the content shown in the bubble
12733 * Unparent and return the content object which was set for this widget.
12735 * @param obj The bubble object
12736 * @return The content that was being used
12738 * @deprecated use elm_object_content_unset() instead
12741 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12743 * Set the icon of the bubble
12745 * Once the icon object is set, a previously set one will be deleted.
12746 * If you want to keep the old content object, use the
12747 * elm_icon_content_unset() function.
12749 * @param obj The bubble object
12750 * @param icon The given icon for the bubble
12752 * @deprecated use elm_object_part_content_set() instead
12755 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12757 * Get the icon of the bubble
12759 * @param obj The bubble object
12760 * @return The icon for the bubble
12762 * This function gets the icon shown on the top left of bubble.
12764 * @deprecated use elm_object_part_content_get() instead
12767 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12769 * Unset the icon of the bubble
12771 * Unparent and return the icon object which was set for this widget.
12773 * @param obj The bubble object
12774 * @return The icon that was being used
12776 * @deprecated use elm_object_part_content_unset() instead
12779 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12781 * Set the corner of the bubble
12783 * @param obj The bubble object.
12784 * @param corner The given corner for the bubble.
12786 * This function sets the corner of the bubble. The corner will be used to
12787 * determine where the arrow in the frame points to and where label, icon and
12790 * Possible values for corner are:
12791 * @li "top_left" - Default
12793 * @li "bottom_left"
12794 * @li "bottom_right"
12796 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12798 * Get the corner of the bubble
12800 * @param obj The bubble object.
12801 * @return The given corner for the bubble.
12803 * This function gets the selected corner of the bubble.
12805 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12811 * @defgroup Photo Photo
12813 * For displaying the photo of a person (contact). Simple, yet
12814 * with a very specific purpose.
12816 * Signals that you can add callbacks for are:
12818 * "clicked" - This is called when a user has clicked the photo
12819 * "drag,start" - Someone started dragging the image out of the object
12820 * "drag,end" - Dragged item was dropped (somewhere)
12826 * Add a new photo to the parent
12828 * @param parent The parent object
12829 * @return The new object or NULL if it cannot be created
12833 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12836 * Set the file that will be used as photo
12838 * @param obj The photo object
12839 * @param file The path to file that will be used as photo
12841 * @return (1 = success, 0 = error)
12845 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12848 * Set the file that will be used as thumbnail in the photo.
12850 * @param obj The photo object.
12851 * @param file The path to file that will be used as thumb.
12852 * @param group The key used in case of an EET file.
12856 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12859 * Set the size that will be used on the photo
12861 * @param obj The photo object
12862 * @param size The size that the photo will be
12866 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12869 * Set if the photo should be completely visible or not.
12871 * @param obj The photo object
12872 * @param fill if true the photo will be completely visible
12876 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12879 * Set editability of the photo.
12881 * An editable photo can be dragged to or from, and can be cut or
12882 * pasted too. Note that pasting an image or dropping an item on
12883 * the image will delete the existing content.
12885 * @param obj The photo object.
12886 * @param set To set of clear editablity.
12888 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12894 /* gesture layer */
12896 * @defgroup Elm_Gesture_Layer Gesture Layer
12897 * Gesture Layer Usage:
12899 * Use Gesture Layer to detect gestures.
12900 * The advantage is that you don't have to implement
12901 * gesture detection, just set callbacks of gesture state.
12902 * By using gesture layer we make standard interface.
12904 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12905 * with a parent object parameter.
12906 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12907 * call. Usually with same object as target (2nd parameter).
12909 * Now you need to tell gesture layer what gestures you follow.
12910 * This is done with @ref elm_gesture_layer_cb_set call.
12911 * By setting the callback you actually saying to gesture layer:
12912 * I would like to know when the gesture @ref Elm_Gesture_Types
12913 * switches to state @ref Elm_Gesture_State.
12915 * Next, you need to implement the actual action that follows the input
12916 * in your callback.
12918 * Note that if you like to stop being reported about a gesture, just set
12919 * all callbacks referring this gesture to NULL.
12920 * (again with @ref elm_gesture_layer_cb_set)
12922 * The information reported by gesture layer to your callback is depending
12923 * on @ref Elm_Gesture_Types:
12924 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12925 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12926 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12928 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12929 * @ref ELM_GESTURE_MOMENTUM.
12931 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12932 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12933 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12934 * Note that we consider a flick as a line-gesture that should be completed
12935 * in flick-time-limit as defined in @ref Config.
12937 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12939 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12942 * Gesture Layer Tweaks:
12944 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12945 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12947 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12948 * so gesture starts when user touches (a *DOWN event) touch-surface
12949 * and ends when no fingers touches surface (a *UP event).
12953 * @enum _Elm_Gesture_Types
12954 * Enum of supported gesture types.
12955 * @ingroup Elm_Gesture_Layer
12957 enum _Elm_Gesture_Types
12959 ELM_GESTURE_FIRST = 0,
12961 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12962 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12963 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12964 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12966 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12968 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12969 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12971 ELM_GESTURE_ZOOM, /**< Zoom */
12972 ELM_GESTURE_ROTATE, /**< Rotate */
12978 * @typedef Elm_Gesture_Types
12979 * gesture types enum
12980 * @ingroup Elm_Gesture_Layer
12982 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12985 * @enum _Elm_Gesture_State
12986 * Enum of gesture states.
12987 * @ingroup Elm_Gesture_Layer
12989 enum _Elm_Gesture_State
12991 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12992 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12993 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12994 ELM_GESTURE_STATE_END, /**< Gesture completed */
12995 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12999 * @typedef Elm_Gesture_State
13000 * gesture states enum
13001 * @ingroup Elm_Gesture_Layer
13003 typedef enum _Elm_Gesture_State Elm_Gesture_State;
13006 * @struct _Elm_Gesture_Taps_Info
13007 * Struct holds taps info for user
13008 * @ingroup Elm_Gesture_Layer
13010 struct _Elm_Gesture_Taps_Info
13012 Evas_Coord x, y; /**< Holds center point between fingers */
13013 unsigned int n; /**< Number of fingers tapped */
13014 unsigned int timestamp; /**< event timestamp */
13018 * @typedef Elm_Gesture_Taps_Info
13019 * holds taps info for user
13020 * @ingroup Elm_Gesture_Layer
13022 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13025 * @struct _Elm_Gesture_Momentum_Info
13026 * Struct holds momentum info for user
13027 * x1 and y1 are not necessarily in sync
13028 * x1 holds x value of x direction starting point
13029 * and same holds for y1.
13030 * This is noticeable when doing V-shape movement
13031 * @ingroup Elm_Gesture_Layer
13033 struct _Elm_Gesture_Momentum_Info
13034 { /* Report line ends, timestamps, and momentum computed */
13035 Evas_Coord x1; /**< Final-swipe direction starting point on X */
13036 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13037 Evas_Coord x2; /**< Final-swipe direction ending point on X */
13038 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
13040 unsigned int tx; /**< Timestamp of start of final x-swipe */
13041 unsigned int ty; /**< Timestamp of start of final y-swipe */
13043 Evas_Coord mx; /**< Momentum on X */
13044 Evas_Coord my; /**< Momentum on Y */
13046 unsigned int n; /**< Number of fingers */
13050 * @typedef Elm_Gesture_Momentum_Info
13051 * holds momentum info for user
13052 * @ingroup Elm_Gesture_Layer
13054 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13057 * @struct _Elm_Gesture_Line_Info
13058 * Struct holds line info for user
13059 * @ingroup Elm_Gesture_Layer
13061 struct _Elm_Gesture_Line_Info
13062 { /* Report line ends, timestamps, and momentum computed */
13063 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13064 double angle; /**< Angle (direction) of lines */
13068 * @typedef Elm_Gesture_Line_Info
13069 * Holds line info for user
13070 * @ingroup Elm_Gesture_Layer
13072 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13075 * @struct _Elm_Gesture_Zoom_Info
13076 * Struct holds zoom info for user
13077 * @ingroup Elm_Gesture_Layer
13079 struct _Elm_Gesture_Zoom_Info
13081 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13082 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13083 double zoom; /**< Zoom value: 1.0 means no zoom */
13084 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13088 * @typedef Elm_Gesture_Zoom_Info
13089 * Holds zoom info for user
13090 * @ingroup Elm_Gesture_Layer
13092 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13095 * @struct _Elm_Gesture_Rotate_Info
13096 * Struct holds rotation info for user
13097 * @ingroup Elm_Gesture_Layer
13099 struct _Elm_Gesture_Rotate_Info
13101 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13102 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13103 double base_angle; /**< Holds start-angle */
13104 double angle; /**< Rotation value: 0.0 means no rotation */
13105 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13109 * @typedef Elm_Gesture_Rotate_Info
13110 * Holds rotation info for user
13111 * @ingroup Elm_Gesture_Layer
13113 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13116 * @typedef Elm_Gesture_Event_Cb
13117 * User callback used to stream gesture info from gesture layer
13118 * @param data user data
13119 * @param event_info gesture report info
13120 * Returns a flag field to be applied on the causing event.
13121 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13122 * upon the event, in an irreversible way.
13124 * @ingroup Elm_Gesture_Layer
13126 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13129 * Use function to set callbacks to be notified about
13130 * change of state of gesture.
13131 * When a user registers a callback with this function
13132 * this means this gesture has to be tested.
13134 * When ALL callbacks for a gesture are set to NULL
13135 * it means user isn't interested in gesture-state
13136 * and it will not be tested.
13138 * @param obj Pointer to gesture-layer.
13139 * @param idx The gesture you would like to track its state.
13140 * @param cb callback function pointer.
13141 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13142 * @param data user info to be sent to callback (usually, Smart Data)
13144 * @ingroup Elm_Gesture_Layer
13146 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);
13149 * Call this function to get repeat-events settings.
13151 * @param obj Pointer to gesture-layer.
13153 * @return repeat events settings.
13154 * @see elm_gesture_layer_hold_events_set()
13155 * @ingroup Elm_Gesture_Layer
13157 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13160 * This function called in order to make gesture-layer repeat events.
13161 * Set this of you like to get the raw events only if gestures were not detected.
13162 * Clear this if you like gesture layer to fwd events as testing gestures.
13164 * @param obj Pointer to gesture-layer.
13165 * @param r Repeat: TRUE/FALSE
13167 * @ingroup Elm_Gesture_Layer
13169 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13172 * This function sets step-value for zoom action.
13173 * Set step to any positive value.
13174 * Cancel step setting by setting to 0.0
13176 * @param obj Pointer to gesture-layer.
13177 * @param s new zoom step value.
13179 * @ingroup Elm_Gesture_Layer
13181 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13184 * This function sets step-value for rotate action.
13185 * Set step to any positive value.
13186 * Cancel step setting by setting to 0.0
13188 * @param obj Pointer to gesture-layer.
13189 * @param s new roatate step value.
13191 * @ingroup Elm_Gesture_Layer
13193 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13196 * This function called to attach gesture-layer to an Evas_Object.
13197 * @param obj Pointer to gesture-layer.
13198 * @param t Pointer to underlying object (AKA Target)
13200 * @return TRUE, FALSE on success, failure.
13202 * @ingroup Elm_Gesture_Layer
13204 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13207 * Call this function to construct a new gesture-layer object.
13208 * This does not activate the gesture layer. You have to
13209 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13211 * @param parent the parent object.
13213 * @return Pointer to new gesture-layer object.
13215 * @ingroup Elm_Gesture_Layer
13217 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13220 * @defgroup Thumb Thumb
13222 * @image html img/widget/thumb/preview-00.png
13223 * @image latex img/widget/thumb/preview-00.eps
13225 * A thumb object is used for displaying the thumbnail of an image or video.
13226 * You must have compiled Elementary with Ethumb_Client support and the DBus
13227 * service must be present and auto-activated in order to have thumbnails to
13230 * Once the thumbnail object becomes visible, it will check if there is a
13231 * previously generated thumbnail image for the file set on it. If not, it
13232 * will start generating this thumbnail.
13234 * Different config settings will cause different thumbnails to be generated
13235 * even on the same file.
13237 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13238 * Ethumb documentation to change this path, and to see other configuration
13241 * Signals that you can add callbacks for are:
13243 * - "clicked" - This is called when a user has clicked the thumb without dragging
13245 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13246 * - "press" - This is called when a user has pressed down the thumb.
13247 * - "generate,start" - The thumbnail generation started.
13248 * - "generate,stop" - The generation process stopped.
13249 * - "generate,error" - The generation failed.
13250 * - "load,error" - The thumbnail image loading failed.
13252 * available styles:
13256 * An example of use of thumbnail:
13258 * - @ref thumb_example_01
13262 * @addtogroup Thumb
13267 * @enum _Elm_Thumb_Animation_Setting
13268 * @typedef Elm_Thumb_Animation_Setting
13270 * Used to set if a video thumbnail is animating or not.
13274 typedef enum _Elm_Thumb_Animation_Setting
13276 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13277 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13278 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13279 ELM_THUMB_ANIMATION_LAST
13280 } Elm_Thumb_Animation_Setting;
13283 * Add a new thumb object to the parent.
13285 * @param parent The parent object.
13286 * @return The new object or NULL if it cannot be created.
13288 * @see elm_thumb_file_set()
13289 * @see elm_thumb_ethumb_client_get()
13293 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13295 * Reload thumbnail if it was generated before.
13297 * @param obj The thumb object to reload
13299 * This is useful if the ethumb client configuration changed, like its
13300 * size, aspect or any other property one set in the handle returned
13301 * by elm_thumb_ethumb_client_get().
13303 * If the options didn't change, the thumbnail won't be generated again, but
13304 * the old one will still be used.
13306 * @see elm_thumb_file_set()
13310 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13312 * Set the file that will be used as thumbnail.
13314 * @param obj The thumb object.
13315 * @param file The path to file that will be used as thumb.
13316 * @param key The key used in case of an EET file.
13318 * The file can be an image or a video (in that case, acceptable extensions are:
13319 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13320 * function elm_thumb_animate().
13322 * @see elm_thumb_file_get()
13323 * @see elm_thumb_reload()
13324 * @see elm_thumb_animate()
13328 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13330 * Get the image or video path and key used to generate the thumbnail.
13332 * @param obj The thumb object.
13333 * @param file Pointer to filename.
13334 * @param key Pointer to key.
13336 * @see elm_thumb_file_set()
13337 * @see elm_thumb_path_get()
13341 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13343 * Get the path and key to the image or video generated by ethumb.
13345 * One just need to make sure that the thumbnail was generated before getting
13346 * its path; otherwise, the path will be NULL. One way to do that is by asking
13347 * for the path when/after the "generate,stop" smart callback is called.
13349 * @param obj The thumb object.
13350 * @param file Pointer to thumb path.
13351 * @param key Pointer to thumb key.
13353 * @see elm_thumb_file_get()
13357 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13359 * Set the animation state for the thumb object. If its content is an animated
13360 * video, you may start/stop the animation or tell it to play continuously and
13363 * @param obj The thumb object.
13364 * @param setting The animation setting.
13366 * @see elm_thumb_file_set()
13370 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13372 * Get the animation state for the thumb object.
13374 * @param obj The thumb object.
13375 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13378 * @see elm_thumb_animate_set()
13382 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13384 * Get the ethumb_client handle so custom configuration can be made.
13386 * @return Ethumb_Client instance or NULL.
13388 * This must be called before the objects are created to be sure no object is
13389 * visible and no generation started.
13391 * Example of usage:
13394 * #include <Elementary.h>
13395 * #ifndef ELM_LIB_QUICKLAUNCH
13397 * elm_main(int argc, char **argv)
13399 * Ethumb_Client *client;
13401 * elm_need_ethumb();
13405 * client = elm_thumb_ethumb_client_get();
13408 * ERR("could not get ethumb_client");
13411 * ethumb_client_size_set(client, 100, 100);
13412 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13415 * // Create elm_thumb objects here
13425 * @note There's only one client handle for Ethumb, so once a configuration
13426 * change is done to it, any other request for thumbnails (for any thumbnail
13427 * object) will use that configuration. Thus, this configuration is global.
13431 EAPI void *elm_thumb_ethumb_client_get(void);
13433 * Get the ethumb_client connection state.
13435 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13438 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13440 * Make the thumbnail 'editable'.
13442 * @param obj Thumb object.
13443 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13445 * This means the thumbnail is a valid drag target for drag and drop, and can be
13446 * cut or pasted too.
13448 * @see elm_thumb_editable_get()
13452 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13454 * Make the thumbnail 'editable'.
13456 * @param obj Thumb object.
13457 * @return Editability.
13459 * This means the thumbnail is a valid drag target for drag and drop, and can be
13460 * cut or pasted too.
13462 * @see elm_thumb_editable_set()
13466 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13473 * @defgroup Web Web
13475 * @image html img/widget/web/preview-00.png
13476 * @image latex img/widget/web/preview-00.eps
13478 * A web object is used for displaying web pages (HTML/CSS/JS)
13479 * using WebKit-EFL. You must have compiled Elementary with
13482 * Signals that you can add callbacks for are:
13483 * @li "download,request": A file download has been requested. Event info is
13484 * a pointer to a Elm_Web_Download
13485 * @li "editorclient,contents,changed": Editor client's contents changed
13486 * @li "editorclient,selection,changed": Editor client's selection changed
13487 * @li "frame,created": A new frame was created. Event info is an
13488 * Evas_Object which can be handled with WebKit's ewk_frame API
13489 * @li "icon,received": An icon was received by the main frame
13490 * @li "inputmethod,changed": Input method changed. Event info is an
13491 * Eina_Bool indicating whether it's enabled or not
13492 * @li "js,windowobject,clear": JS window object has been cleared
13493 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13494 * is a char *link[2], where the first string contains the URL the link
13495 * points to, and the second one the title of the link
13496 * @li "link,hover,out": Mouse cursor left the link
13497 * @li "load,document,finished": Loading of a document finished. Event info
13498 * is the frame that finished loading
13499 * @li "load,error": Load failed. Event info is a pointer to
13500 * Elm_Web_Frame_Load_Error
13501 * @li "load,finished": Load finished. Event info is NULL on success, on
13502 * error it's a pointer to Elm_Web_Frame_Load_Error
13503 * @li "load,newwindow,show": A new window was created and is ready to be
13505 * @li "load,progress": Overall load progress. Event info is a pointer to
13506 * a double containing a value between 0.0 and 1.0
13507 * @li "load,provisional": Started provisional load
13508 * @li "load,started": Loading of a document started
13509 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13510 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13511 * the menubar is visible, or EINA_FALSE in case it's not
13512 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13513 * an Eina_Bool indicating the visibility
13514 * @li "popup,created": A dropdown widget was activated, requesting its
13515 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13516 * @li "popup,willdelete": The web object is ready to destroy the popup
13517 * object created. Event info is a pointer to Elm_Web_Menu
13518 * @li "ready": Page is fully loaded
13519 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13520 * info is a pointer to Eina_Bool where the visibility state should be set
13521 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13522 * is an Eina_Bool with the visibility state set
13523 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13524 * a string with the new text
13525 * @li "statusbar,visible,get": Queries visibility of the status bar.
13526 * Event info is a pointer to Eina_Bool where the visibility state should be
13528 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13529 * an Eina_Bool with the visibility value
13530 * @li "title,changed": Title of the main frame changed. Event info is a
13531 * string with the new title
13532 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13533 * is a pointer to Eina_Bool where the visibility state should be set
13534 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13535 * info is an Eina_Bool with the visibility state
13536 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13537 * a string with the text to show
13538 * @li "uri,changed": URI of the main frame changed. Event info is a string
13540 * @li "view,resized": The web object internal's view changed sized
13541 * @li "windows,close,request": A JavaScript request to close the current
13542 * window was requested
13543 * @li "zoom,animated,end": Animated zoom finished
13545 * available styles:
13548 * An example of use of web:
13550 * - @ref web_example_01 TBD
13559 * Structure used to report load errors.
13561 * Load errors are reported as signal by elm_web. All the strings are
13562 * temporary references and should @b not be used after the signal
13563 * callback returns. If it's required, make copies with strdup() or
13564 * eina_stringshare_add() (they are not even guaranteed to be
13565 * stringshared, so must use eina_stringshare_add() and not
13566 * eina_stringshare_ref()).
13568 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13570 * Structure used to report load errors.
13572 * Load errors are reported as signal by elm_web. All the strings are
13573 * temporary references and should @b not be used after the signal
13574 * callback returns. If it's required, make copies with strdup() or
13575 * eina_stringshare_add() (they are not even guaranteed to be
13576 * stringshared, so must use eina_stringshare_add() and not
13577 * eina_stringshare_ref()).
13579 struct _Elm_Web_Frame_Load_Error
13581 int code; /**< Numeric error code */
13582 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13583 const char *domain; /**< Error domain name */
13584 const char *description; /**< Error description (already localized) */
13585 const char *failing_url; /**< The URL that failed to load */
13586 Evas_Object *frame; /**< Frame object that produced the error */
13590 * The possibles types that the items in a menu can be
13592 typedef enum _Elm_Web_Menu_Item_Type
13594 ELM_WEB_MENU_SEPARATOR,
13595 ELM_WEB_MENU_GROUP,
13596 ELM_WEB_MENU_OPTION
13597 } Elm_Web_Menu_Item_Type;
13600 * Structure describing the items in a menu
13602 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13604 * Structure describing the items in a menu
13606 struct _Elm_Web_Menu_Item
13608 const char *text; /**< The text for the item */
13609 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13613 * Structure describing the menu of a popup
13615 * This structure will be passed as the @c event_info for the "popup,create"
13616 * signal, which is emitted when a dropdown menu is opened. Users wanting
13617 * to handle these popups by themselves should listen to this signal and
13618 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13619 * property as @c EINA_FALSE means that the user will not handle the popup
13620 * and the default implementation will be used.
13622 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13623 * will be emitted to notify the user that it can destroy any objects and
13624 * free all data related to it.
13626 * @see elm_web_popup_selected_set()
13627 * @see elm_web_popup_destroy()
13629 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13631 * Structure describing the menu of a popup
13633 * This structure will be passed as the @c event_info for the "popup,create"
13634 * signal, which is emitted when a dropdown menu is opened. Users wanting
13635 * to handle these popups by themselves should listen to this signal and
13636 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13637 * property as @c EINA_FALSE means that the user will not handle the popup
13638 * and the default implementation will be used.
13640 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13641 * will be emitted to notify the user that it can destroy any objects and
13642 * free all data related to it.
13644 * @see elm_web_popup_selected_set()
13645 * @see elm_web_popup_destroy()
13647 struct _Elm_Web_Menu
13649 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13650 int x; /**< The X position of the popup, relative to the elm_web object */
13651 int y; /**< The Y position of the popup, relative to the elm_web object */
13652 int width; /**< Width of the popup menu */
13653 int height; /**< Height of the popup menu */
13655 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. */
13658 typedef struct _Elm_Web_Download Elm_Web_Download;
13659 struct _Elm_Web_Download
13665 * Types of zoom available.
13667 typedef enum _Elm_Web_Zoom_Mode
13669 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13670 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13671 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13672 ELM_WEB_ZOOM_MODE_LAST
13673 } Elm_Web_Zoom_Mode;
13675 * Opaque handler containing the features (such as statusbar, menubar, etc)
13676 * that are to be set on a newly requested window.
13678 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13680 * Callback type for the create_window hook.
13682 * The function parameters are:
13683 * @li @p data User data pointer set when setting the hook function
13684 * @li @p obj The elm_web object requesting the new window
13685 * @li @p js Set to @c EINA_TRUE if the request was originated from
13686 * JavaScript. @c EINA_FALSE otherwise.
13687 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13688 * the features requested for the new window.
13690 * The returned value of the function should be the @c elm_web widget where
13691 * the request will be loaded. That is, if a new window or tab is created,
13692 * the elm_web widget in it should be returned, and @b NOT the window
13694 * Returning @c NULL should cancel the request.
13696 * @see elm_web_window_create_hook_set()
13698 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13700 * Callback type for the JS alert hook.
13702 * The function parameters are:
13703 * @li @p data User data pointer set when setting the hook function
13704 * @li @p obj The elm_web object requesting the new window
13705 * @li @p message The message to show in the alert dialog
13707 * The function should return the object representing the alert dialog.
13708 * Elm_Web will run a second main loop to handle the dialog and normal
13709 * flow of the application will be restored when the object is deleted, so
13710 * the user should handle the popup properly in order to delete the object
13711 * when the action is finished.
13712 * If the function returns @c NULL the popup will be ignored.
13714 * @see elm_web_dialog_alert_hook_set()
13716 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13718 * Callback type for the JS confirm hook.
13720 * The function parameters are:
13721 * @li @p data User data pointer set when setting the hook function
13722 * @li @p obj The elm_web object requesting the new window
13723 * @li @p message The message to show in the confirm dialog
13724 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13725 * the user selected @c Ok, @c EINA_FALSE otherwise.
13727 * The function should return the object representing the confirm dialog.
13728 * Elm_Web will run a second main loop to handle the dialog and normal
13729 * flow of the application will be restored when the object is deleted, so
13730 * the user should handle the popup properly in order to delete the object
13731 * when the action is finished.
13732 * If the function returns @c NULL the popup will be ignored.
13734 * @see elm_web_dialog_confirm_hook_set()
13736 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13738 * Callback type for the JS prompt hook.
13740 * The function parameters are:
13741 * @li @p data User data pointer set when setting the hook function
13742 * @li @p obj The elm_web object requesting the new window
13743 * @li @p message The message to show in the prompt dialog
13744 * @li @p def_value The default value to present the user in the entry
13745 * @li @p value Pointer where to store the value given by the user. Must
13746 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13747 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13748 * the user selected @c Ok, @c EINA_FALSE otherwise.
13750 * The function should return the object representing the prompt dialog.
13751 * Elm_Web will run a second main loop to handle the dialog and normal
13752 * flow of the application will be restored when the object is deleted, so
13753 * the user should handle the popup properly in order to delete the object
13754 * when the action is finished.
13755 * If the function returns @c NULL the popup will be ignored.
13757 * @see elm_web_dialog_prompt_hook_set()
13759 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13761 * Callback type for the JS file selector hook.
13763 * The function parameters are:
13764 * @li @p data User data pointer set when setting the hook function
13765 * @li @p obj The elm_web object requesting the new window
13766 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13767 * @li @p accept_types Mime types accepted
13768 * @li @p selected Pointer where to store the list of malloc'ed strings
13769 * containing the path to each file selected. Must be @c NULL if the file
13770 * dialog is cancelled
13771 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13772 * the user selected @c Ok, @c EINA_FALSE otherwise.
13774 * The function should return the object representing the file selector
13776 * Elm_Web will run a second main loop to handle the dialog and normal
13777 * flow of the application will be restored when the object is deleted, so
13778 * the user should handle the popup properly in order to delete the object
13779 * when the action is finished.
13780 * If the function returns @c NULL the popup will be ignored.
13782 * @see elm_web_dialog_file selector_hook_set()
13784 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);
13786 * Callback type for the JS console message hook.
13788 * When a console message is added from JavaScript, any set function to the
13789 * console message hook will be called for the user to handle. There is no
13790 * default implementation of this hook.
13792 * The function parameters are:
13793 * @li @p data User data pointer set when setting the hook function
13794 * @li @p obj The elm_web object that originated the message
13795 * @li @p message The message sent
13796 * @li @p line_number The line number
13797 * @li @p source_id Source id
13799 * @see elm_web_console_message_hook_set()
13801 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13803 * Add a new web object to the parent.
13805 * @param parent The parent object.
13806 * @return The new object or NULL if it cannot be created.
13808 * @see elm_web_uri_set()
13809 * @see elm_web_webkit_view_get()
13811 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13814 * Get internal ewk_view object from web object.
13816 * Elementary may not provide some low level features of EWebKit,
13817 * instead of cluttering the API with proxy methods we opted to
13818 * return the internal reference. Be careful using it as it may
13819 * interfere with elm_web behavior.
13821 * @param obj The web object.
13822 * @return The internal ewk_view object or NULL if it does not
13823 * exist. (Failure to create or Elementary compiled without
13826 * @see elm_web_add()
13828 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13831 * Sets the function to call when a new window is requested
13833 * This hook will be called when a request to create a new window is
13834 * issued from the web page loaded.
13835 * There is no default implementation for this feature, so leaving this
13836 * unset or passing @c NULL in @p func will prevent new windows from
13839 * @param obj The web object where to set the hook function
13840 * @param func The hook function to be called when a window is requested
13841 * @param data User data
13843 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13845 * Sets the function to call when an alert dialog
13847 * This hook will be called when a JavaScript alert dialog is requested.
13848 * If no function is set or @c NULL is passed in @p func, the default
13849 * implementation will take place.
13851 * @param obj The web object where to set the hook function
13852 * @param func The callback function to be used
13853 * @param data User data
13855 * @see elm_web_inwin_mode_set()
13857 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13859 * Sets the function to call when an confirm dialog
13861 * This hook will be called when a JavaScript confirm dialog is requested.
13862 * If no function is set or @c NULL is passed in @p func, the default
13863 * implementation will take place.
13865 * @param obj The web object where to set the hook function
13866 * @param func The callback function to be used
13867 * @param data User data
13869 * @see elm_web_inwin_mode_set()
13871 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13873 * Sets the function to call when an prompt dialog
13875 * This hook will be called when a JavaScript prompt dialog is requested.
13876 * If no function is set or @c NULL is passed in @p func, the default
13877 * implementation will take place.
13879 * @param obj The web object where to set the hook function
13880 * @param func The callback function to be used
13881 * @param data User data
13883 * @see elm_web_inwin_mode_set()
13885 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13887 * Sets the function to call when an file selector dialog
13889 * This hook will be called when a JavaScript file selector dialog is
13891 * If no function is set or @c NULL is passed in @p func, the default
13892 * implementation will take place.
13894 * @param obj The web object where to set the hook function
13895 * @param func The callback function to be used
13896 * @param data User data
13898 * @see elm_web_inwin_mode_set()
13900 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13902 * Sets the function to call when a console message is emitted from JS
13904 * This hook will be called when a console message is emitted from
13905 * JavaScript. There is no default implementation for this feature.
13907 * @param obj The web object where to set the hook function
13908 * @param func The callback function to be used
13909 * @param data User data
13911 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13913 * Gets the status of the tab propagation
13915 * @param obj The web object to query
13916 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13918 * @see elm_web_tab_propagate_set()
13920 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13922 * Sets whether to use tab propagation
13924 * If tab propagation is enabled, whenever the user presses the Tab key,
13925 * Elementary will handle it and switch focus to the next widget.
13926 * The default value is disabled, where WebKit will handle the Tab key to
13927 * cycle focus though its internal objects, jumping to the next widget
13928 * only when that cycle ends.
13930 * @param obj The web object
13931 * @param propagate Whether to propagate Tab keys to Elementary or not
13933 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13935 * Sets the URI for the web object
13937 * It must be a full URI, with resource included, in the form
13938 * http://www.enlightenment.org or file:///tmp/something.html
13940 * @param obj The web object
13941 * @param uri The URI to set
13942 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13944 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13946 * Gets the current URI for the object
13948 * The returned string must not be freed and is guaranteed to be
13951 * @param obj The web object
13952 * @return A stringshared internal string with the current URI, or NULL on
13955 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13957 * Gets the current title
13959 * The returned string must not be freed and is guaranteed to be
13962 * @param obj The web object
13963 * @return A stringshared internal string with the current title, or NULL on
13966 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13968 * Sets the background color to be used by the web object
13970 * This is the color that will be used by default when the loaded page
13971 * does not set it's own. Color values are pre-multiplied.
13973 * @param obj The web object
13974 * @param r Red component
13975 * @param g Green component
13976 * @param b Blue component
13977 * @param a Alpha component
13979 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13981 * Gets the background color to be used by the web object
13983 * This is the color that will be used by default when the loaded page
13984 * does not set it's own. Color values are pre-multiplied.
13986 * @param obj The web object
13987 * @param r Red component
13988 * @param g Green component
13989 * @param b Blue component
13990 * @param a Alpha component
13992 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13994 * Gets a copy of the currently selected text
13996 * The string returned must be freed by the user when it's done with it.
13998 * @param obj The web object
13999 * @return A newly allocated string, or NULL if nothing is selected or an
14002 EAPI char *elm_view_selection_get(const Evas_Object *obj);
14004 * Tells the web object which index in the currently open popup was selected
14006 * When the user handles the popup creation from the "popup,created" signal,
14007 * it needs to tell the web object which item was selected by calling this
14008 * function with the index corresponding to the item.
14010 * @param obj The web object
14011 * @param index The index selected
14013 * @see elm_web_popup_destroy()
14015 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
14017 * Dismisses an open dropdown popup
14019 * When the popup from a dropdown widget is to be dismissed, either after
14020 * selecting an option or to cancel it, this function must be called, which
14021 * will later emit an "popup,willdelete" signal to notify the user that
14022 * any memory and objects related to this popup can be freed.
14024 * @param obj The web object
14025 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14026 * if there was no menu to destroy
14028 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
14030 * Searches the given string in a document.
14032 * @param obj The web object where to search the text
14033 * @param string String to search
14034 * @param case_sensitive If search should be case sensitive or not
14035 * @param forward If search is from cursor and on or backwards
14036 * @param wrap If search should wrap at the end
14038 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14041 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14043 * Marks matches of the given string in a document.
14045 * @param obj The web object where to search text
14046 * @param string String to match
14047 * @param case_sensitive If match should be case sensitive or not
14048 * @param highlight If matches should be highlighted
14049 * @param limit Maximum amount of matches, or zero to unlimited
14051 * @return number of matched @a string
14053 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14055 * Clears all marked matches in the document
14057 * @param obj The web object
14059 * @return EINA_TRUE on success, EINA_FALSE otherwise
14061 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
14063 * Sets whether to highlight the matched marks
14065 * If enabled, marks set with elm_web_text_matches_mark() will be
14068 * @param obj The web object
14069 * @param highlight Whether to highlight the marks or not
14071 * @return EINA_TRUE on success, EINA_FALSE otherwise
14073 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14075 * Gets whether highlighting marks is enabled
14077 * @param The web object
14079 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14082 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
14084 * Gets the overall loading progress of the page
14086 * Returns the estimated loading progress of the page, with a value between
14087 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14088 * included in the page.
14090 * @param The web object
14092 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14095 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
14097 * Stops loading the current page
14099 * Cancels the loading of the current page in the web object. This will
14100 * cause a "load,error" signal to be emitted, with the is_cancellation
14101 * flag set to EINA_TRUE.
14103 * @param obj The web object
14105 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14107 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14109 * Requests a reload of the current document in the object
14111 * @param obj The web object
14113 * @return EINA_TRUE on success, EINA_FALSE otherwise
14115 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14117 * Requests a reload of the current document, avoiding any existing caches
14119 * @param obj The web object
14121 * @return EINA_TRUE on success, EINA_FALSE otherwise
14123 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14125 * Goes back one step in the browsing history
14127 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14129 * @param obj The web object
14131 * @return EINA_TRUE on success, EINA_FALSE otherwise
14133 * @see elm_web_history_enable_set()
14134 * @see elm_web_back_possible()
14135 * @see elm_web_forward()
14136 * @see elm_web_navigate()
14138 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14140 * Goes forward one step in the browsing history
14142 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14144 * @param obj The web object
14146 * @return EINA_TRUE on success, EINA_FALSE otherwise
14148 * @see elm_web_history_enable_set()
14149 * @see elm_web_forward_possible()
14150 * @see elm_web_back()
14151 * @see elm_web_navigate()
14153 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14155 * Jumps the given number of steps in the browsing history
14157 * The @p steps value can be a negative integer to back in history, or a
14158 * positive to move forward.
14160 * @param obj The web object
14161 * @param steps The number of steps to jump
14163 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14164 * history exists to jump the given number of steps
14166 * @see elm_web_history_enable_set()
14167 * @see elm_web_navigate_possible()
14168 * @see elm_web_back()
14169 * @see elm_web_forward()
14171 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14173 * Queries whether it's possible to go back in history
14175 * @param obj The web object
14177 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14180 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14182 * Queries whether it's possible to go forward in history
14184 * @param obj The web object
14186 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14189 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14191 * Queries whether it's possible to jump the given number of steps
14193 * The @p steps value can be a negative integer to back in history, or a
14194 * positive to move forward.
14196 * @param obj The web object
14197 * @param steps The number of steps to check for
14199 * @return EINA_TRUE if enough history exists to perform the given jump,
14200 * EINA_FALSE otherwise
14202 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14204 * Gets whether browsing history is enabled for the given object
14206 * @param obj The web object
14208 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14210 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14212 * Enables or disables the browsing history
14214 * @param obj The web object
14215 * @param enable Whether to enable or disable the browsing history
14217 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14219 * Sets the zoom level of the web object
14221 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14222 * values meaning zoom in and lower meaning zoom out. This function will
14223 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14224 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14226 * @param obj The web object
14227 * @param zoom The zoom level to set
14229 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14231 * Gets the current zoom level set on the web object
14233 * Note that this is the zoom level set on the web object and not that
14234 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14235 * the two zoom levels should match, but for the other two modes the
14236 * Webkit zoom is calculated internally to match the chosen mode without
14237 * changing the zoom level set for the web object.
14239 * @param obj The web object
14241 * @return The zoom level set on the object
14243 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14245 * Sets the zoom mode to use
14247 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14248 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14250 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14251 * with the elm_web_zoom_set() function.
14252 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14253 * make sure the entirety of the web object's contents are shown.
14254 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14255 * fit the contents in the web object's size, without leaving any space
14258 * @param obj The web object
14259 * @param mode The mode to set
14261 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14263 * Gets the currently set zoom mode
14265 * @param obj The web object
14267 * @return The current zoom mode set for the object, or
14268 * ::ELM_WEB_ZOOM_MODE_LAST on error
14270 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14272 * Shows the given region in the web object
14274 * @param obj The web object
14275 * @param x The x coordinate of the region to show
14276 * @param y The y coordinate of the region to show
14277 * @param w The width of the region to show
14278 * @param h The height of the region to show
14280 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14282 * Brings in the region to the visible area
14284 * Like elm_web_region_show(), but it animates the scrolling of the object
14287 * @param obj The web object
14288 * @param x The x coordinate of the region to show
14289 * @param y The y coordinate of the region to show
14290 * @param w The width of the region to show
14291 * @param h The height of the region to show
14293 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14295 * Sets the default dialogs to use an Inwin instead of a normal window
14297 * If set, then the default implementation for the JavaScript dialogs and
14298 * file selector will be opened in an Inwin. Otherwise they will use a
14299 * normal separated window.
14301 * @param obj The web object
14302 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14304 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14306 * Gets whether Inwin mode is set for the current object
14308 * @param obj The web object
14310 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14312 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14314 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14315 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14316 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);
14317 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14324 * @defgroup Hoversel Hoversel
14326 * @image html img/widget/hoversel/preview-00.png
14327 * @image latex img/widget/hoversel/preview-00.eps
14329 * A hoversel is a button that pops up a list of items (automatically
14330 * choosing the direction to display) that have a label and, optionally, an
14331 * icon to select from. It is a convenience widget to avoid the need to do
14332 * all the piecing together yourself. It is intended for a small number of
14333 * items in the hoversel menu (no more than 8), though is capable of many
14336 * Signals that you can add callbacks for are:
14337 * "clicked" - the user clicked the hoversel button and popped up the sel
14338 * "selected" - an item in the hoversel list is selected. event_info is the item
14339 * "dismissed" - the hover is dismissed
14341 * See @ref tutorial_hoversel for an example.
14344 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14346 * @brief Add a new Hoversel object
14348 * @param parent The parent object
14349 * @return The new object or NULL if it cannot be created
14351 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14353 * @brief This sets the hoversel to expand horizontally.
14355 * @param obj The hoversel object
14356 * @param horizontal If true, the hover will expand horizontally to the
14359 * @note The initial button will display horizontally regardless of this
14362 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14364 * @brief This returns whether the hoversel is set to expand horizontally.
14366 * @param obj The hoversel object
14367 * @return If true, the hover will expand horizontally to the right.
14369 * @see elm_hoversel_horizontal_set()
14371 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14373 * @brief Set the Hover parent
14375 * @param obj The hoversel object
14376 * @param parent The parent to use
14378 * Sets the hover parent object, the area that will be darkened when the
14379 * hoversel is clicked. Should probably be the window that the hoversel is
14380 * in. See @ref Hover objects for more information.
14382 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14384 * @brief Get the Hover parent
14386 * @param obj The hoversel object
14387 * @return The used parent
14389 * Gets the hover parent object.
14391 * @see elm_hoversel_hover_parent_set()
14393 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14395 * @brief Set the hoversel button label
14397 * @param obj The hoversel object
14398 * @param label The label text.
14400 * This sets the label of the button that is always visible (before it is
14401 * clicked and expanded).
14403 * @deprecated elm_object_text_set()
14405 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14407 * @brief Get the hoversel button label
14409 * @param obj The hoversel object
14410 * @return The label text.
14412 * @deprecated elm_object_text_get()
14414 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14416 * @brief Set the icon of the hoversel button
14418 * @param obj The hoversel object
14419 * @param icon The icon object
14421 * Sets the icon of the button that is always visible (before it is clicked
14422 * and expanded). Once the icon object is set, a previously set one will be
14423 * deleted, if you want to keep that old content object, use the
14424 * elm_hoversel_icon_unset() function.
14426 * @see elm_object_content_set() for the button widget
14428 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14430 * @brief Get the icon of the hoversel button
14432 * @param obj The hoversel object
14433 * @return The icon object
14435 * Get the icon of the button that is always visible (before it is clicked
14436 * and expanded). Also see elm_object_content_get() for the button widget.
14438 * @see elm_hoversel_icon_set()
14440 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14442 * @brief Get and unparent the icon of the hoversel button
14444 * @param obj The hoversel object
14445 * @return The icon object that was being used
14447 * Unparent and return the icon of the button that is always visible
14448 * (before it is clicked and expanded).
14450 * @see elm_hoversel_icon_set()
14451 * @see elm_object_content_unset() for the button widget
14453 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14455 * @brief This triggers the hoversel popup from code, the same as if the user
14456 * had clicked the button.
14458 * @param obj The hoversel object
14460 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14462 * @brief This dismisses the hoversel popup as if the user had clicked
14463 * outside the hover.
14465 * @param obj The hoversel object
14467 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14469 * @brief Returns whether the hoversel is expanded.
14471 * @param obj The hoversel object
14472 * @return This will return EINA_TRUE if the hoversel is expanded or
14473 * EINA_FALSE if it is not expanded.
14475 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14477 * @brief This will remove all the children items from the hoversel.
14479 * @param obj The hoversel object
14481 * @warning Should @b not be called while the hoversel is active; use
14482 * elm_hoversel_expanded_get() to check first.
14484 * @see elm_hoversel_item_del_cb_set()
14485 * @see elm_hoversel_item_del()
14487 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14489 * @brief Get the list of items within the given hoversel.
14491 * @param obj The hoversel object
14492 * @return Returns a list of Elm_Hoversel_Item*
14494 * @see elm_hoversel_item_add()
14496 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14498 * @brief Add an item to the hoversel button
14500 * @param obj The hoversel object
14501 * @param label The text label to use for the item (NULL if not desired)
14502 * @param icon_file An image file path on disk to use for the icon or standard
14503 * icon name (NULL if not desired)
14504 * @param icon_type The icon type if relevant
14505 * @param func Convenience function to call when this item is selected
14506 * @param data Data to pass to item-related functions
14507 * @return A handle to the item added.
14509 * This adds an item to the hoversel to show when it is clicked. Note: if you
14510 * need to use an icon from an edje file then use
14511 * elm_hoversel_item_icon_set() right after the this function, and set
14512 * icon_file to NULL here.
14514 * For more information on what @p icon_file and @p icon_type are see the
14515 * @ref Icon "icon documentation".
14517 EAPI Elm_Hoversel_Item *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14519 * @brief Delete an item from the hoversel
14521 * @param item The item to delete
14523 * This deletes the item from the hoversel (should not be called while the
14524 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14526 * @see elm_hoversel_item_add()
14527 * @see elm_hoversel_item_del_cb_set()
14529 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14531 * @brief Set the function to be called when an item from the hoversel is
14534 * @param item The item to set the callback on
14535 * @param func The function called
14537 * That function will receive these parameters:
14538 * @li void *item_data
14539 * @li Evas_Object *the_item_object
14540 * @li Elm_Hoversel_Item *the_object_struct
14542 * @see elm_hoversel_item_add()
14544 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14546 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14547 * that will be passed to associated function callbacks.
14549 * @param item The item to get the data from
14550 * @return The data pointer set with elm_hoversel_item_add()
14552 * @see elm_hoversel_item_add()
14554 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14556 * @brief This returns the label text of the given hoversel item.
14558 * @param item The item to get the label
14559 * @return The label text of the hoversel item
14561 * @see elm_hoversel_item_add()
14563 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14565 * @brief This sets the icon for the given hoversel item.
14567 * @param item The item to set the icon
14568 * @param icon_file An image file path on disk to use for the icon or standard
14570 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14571 * to NULL if the icon is not an edje file
14572 * @param icon_type The icon type
14574 * The icon can be loaded from the standard set, from an image file, or from
14577 * @see elm_hoversel_item_add()
14579 EAPI void elm_hoversel_item_icon_set(Elm_Hoversel_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
14581 * @brief Get the icon object of the hoversel item
14583 * @param item The item to get the icon from
14584 * @param icon_file The image file path on disk used for the icon or standard
14586 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14587 * if the icon is not an edje file
14588 * @param icon_type The icon type
14590 * @see elm_hoversel_item_icon_set()
14591 * @see elm_hoversel_item_add()
14593 EAPI void elm_hoversel_item_icon_get(const Elm_Hoversel_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
14599 * @defgroup Toolbar Toolbar
14600 * @ingroup Elementary
14602 * @image html img/widget/toolbar/preview-00.png
14603 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14605 * @image html img/toolbar.png
14606 * @image latex img/toolbar.eps width=\textwidth
14608 * A toolbar is a widget that displays a list of items inside
14609 * a box. It can be scrollable, show a menu with items that don't fit
14610 * to toolbar size or even crop them.
14612 * Only one item can be selected at a time.
14614 * Items can have multiple states, or show menus when selected by the user.
14616 * Smart callbacks one can listen to:
14617 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14618 * - "language,changed" - when the program language changes
14620 * Available styles for it:
14622 * - @c "transparent" - no background or shadow, just show the content
14624 * List of examples:
14625 * @li @ref toolbar_example_01
14626 * @li @ref toolbar_example_02
14627 * @li @ref toolbar_example_03
14631 * @addtogroup Toolbar
14636 * @enum _Elm_Toolbar_Shrink_Mode
14637 * @typedef Elm_Toolbar_Shrink_Mode
14639 * Set toolbar's items display behavior, it can be scrollabel,
14640 * show a menu with exceeding items, or simply hide them.
14642 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14645 * Values <b> don't </b> work as bitmask, only one can be choosen.
14647 * @see elm_toolbar_mode_shrink_set()
14648 * @see elm_toolbar_mode_shrink_get()
14652 typedef enum _Elm_Toolbar_Shrink_Mode
14654 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14655 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14656 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14657 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14658 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14659 } Elm_Toolbar_Shrink_Mode;
14661 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(). */
14664 * Add a new toolbar widget to the given parent Elementary
14665 * (container) object.
14667 * @param parent The parent object.
14668 * @return a new toolbar widget handle or @c NULL, on errors.
14670 * This function inserts a new toolbar widget on the canvas.
14674 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14676 * Set the icon size, in pixels, to be used by toolbar items.
14678 * @param obj The toolbar object
14679 * @param icon_size The icon size in pixels
14681 * @note Default value is @c 32. It reads value from elm config.
14683 * @see elm_toolbar_icon_size_get()
14687 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14689 * Get the icon size, in pixels, to be used by toolbar items.
14691 * @param obj The toolbar object.
14692 * @return The icon size in pixels.
14694 * @see elm_toolbar_icon_size_set() for details.
14698 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14700 * Sets icon lookup order, for toolbar items' icons.
14702 * @param obj The toolbar object.
14703 * @param order The icon lookup order.
14705 * Icons added before calling this function will not be affected.
14706 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14708 * @see elm_toolbar_icon_order_lookup_get()
14712 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14714 * Gets the icon lookup order.
14716 * @param obj The toolbar object.
14717 * @return The icon lookup order.
14719 * @see elm_toolbar_icon_order_lookup_set() for details.
14723 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14725 * Set whether the toolbar should always have an item selected.
14727 * @param obj The toolbar object.
14728 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14731 * This will cause the toolbar to always have an item selected, and clicking
14732 * the selected item will not cause a selected event to be emitted. Enabling this mode
14733 * will immediately select the first toolbar item.
14735 * Always-selected is disabled by default.
14737 * @see elm_toolbar_always_select_mode_get().
14741 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14743 * Get whether the toolbar should always have an item selected.
14745 * @param obj The toolbar object.
14746 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14747 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14749 * @see elm_toolbar_always_select_mode_set() for details.
14753 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14755 * Set whether the toolbar items' should be selected by the user or not.
14757 * @param obj The toolbar object.
14758 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14761 * This will turn off the ability to select items entirely and they will
14762 * neither appear selected nor emit selected signals. The clicked
14763 * callback function will still be called.
14765 * Selection is enabled by default.
14767 * @see elm_toolbar_no_select_mode_get().
14771 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14774 * Set whether the toolbar items' should be selected by the user or not.
14776 * @param obj The toolbar object.
14777 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14778 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14780 * @see elm_toolbar_no_select_mode_set() for details.
14784 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14786 * Append item to the toolbar.
14788 * @param obj The toolbar object.
14789 * @param icon A string with icon name or the absolute path of an image file.
14790 * @param label The label of the item.
14791 * @param func The function to call when the item is clicked.
14792 * @param data The data to associate with the item for related callbacks.
14793 * @return The created item or @c NULL upon failure.
14795 * A new item will be created and appended to the toolbar, i.e., will
14796 * be set as @b last item.
14798 * Items created with this method can be deleted with
14799 * elm_toolbar_item_del().
14801 * Associated @p data can be properly freed when item is deleted if a
14802 * callback function is set with elm_toolbar_item_del_cb_set().
14804 * If a function is passed as argument, it will be called everytime this item
14805 * is selected, i.e., the user clicks over an unselected item.
14806 * If such function isn't needed, just passing
14807 * @c NULL as @p func is enough. The same should be done for @p data.
14809 * Toolbar will load icon image from fdo or current theme.
14810 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14811 * If an absolute path is provided it will load it direct from a file.
14813 * @see elm_toolbar_item_icon_set()
14814 * @see elm_toolbar_item_del()
14815 * @see elm_toolbar_item_del_cb_set()
14819 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);
14821 * Prepend item to the toolbar.
14823 * @param obj The toolbar object.
14824 * @param icon A string with icon name or the absolute path of an image file.
14825 * @param label The label of the item.
14826 * @param func The function to call when the item is clicked.
14827 * @param data The data to associate with the item for related callbacks.
14828 * @return The created item or @c NULL upon failure.
14830 * A new item will be created and prepended to the toolbar, i.e., will
14831 * be set as @b first item.
14833 * Items created with this method can be deleted with
14834 * elm_toolbar_item_del().
14836 * Associated @p data can be properly freed when item is deleted if a
14837 * callback function is set with elm_toolbar_item_del_cb_set().
14839 * If a function is passed as argument, it will be called everytime this item
14840 * is selected, i.e., the user clicks over an unselected item.
14841 * If such function isn't needed, just passing
14842 * @c NULL as @p func is enough. The same should be done for @p data.
14844 * Toolbar will load icon image from fdo or current theme.
14845 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14846 * If an absolute path is provided it will load it direct from a file.
14848 * @see elm_toolbar_item_icon_set()
14849 * @see elm_toolbar_item_del()
14850 * @see elm_toolbar_item_del_cb_set()
14854 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);
14856 * Insert a new item into the toolbar object before item @p before.
14858 * @param obj The toolbar object.
14859 * @param before The toolbar item to insert before.
14860 * @param icon A string with icon name or the absolute path of an image file.
14861 * @param label The label of the item.
14862 * @param func The function to call when the item is clicked.
14863 * @param data The data to associate with the item for related callbacks.
14864 * @return The created item or @c NULL upon failure.
14866 * A new item will be created and added to the toolbar. Its position in
14867 * this toolbar will be just before item @p before.
14869 * Items created with this method can be deleted with
14870 * elm_toolbar_item_del().
14872 * Associated @p data can be properly freed when item is deleted if a
14873 * callback function is set with elm_toolbar_item_del_cb_set().
14875 * If a function is passed as argument, it will be called everytime this item
14876 * is selected, i.e., the user clicks over an unselected item.
14877 * If such function isn't needed, just passing
14878 * @c NULL as @p func is enough. The same should be done for @p data.
14880 * Toolbar will load icon image from fdo or current theme.
14881 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14882 * If an absolute path is provided it will load it direct from a file.
14884 * @see elm_toolbar_item_icon_set()
14885 * @see elm_toolbar_item_del()
14886 * @see elm_toolbar_item_del_cb_set()
14890 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);
14893 * Insert a new item into the toolbar object after item @p after.
14895 * @param obj The toolbar object.
14896 * @param after The toolbar item to insert after.
14897 * @param icon A string with icon name or the absolute path of an image file.
14898 * @param label The label of the item.
14899 * @param func The function to call when the item is clicked.
14900 * @param data The data to associate with the item for related callbacks.
14901 * @return The created item or @c NULL upon failure.
14903 * A new item will be created and added to the toolbar. Its position in
14904 * this toolbar will be just after item @p after.
14906 * Items created with this method can be deleted with
14907 * elm_toolbar_item_del().
14909 * Associated @p data can be properly freed when item is deleted if a
14910 * callback function is set with elm_toolbar_item_del_cb_set().
14912 * If a function is passed as argument, it will be called everytime this item
14913 * is selected, i.e., the user clicks over an unselected item.
14914 * If such function isn't needed, just passing
14915 * @c NULL as @p func is enough. The same should be done for @p data.
14917 * Toolbar will load icon image from fdo or current theme.
14918 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14919 * If an absolute path is provided it will load it direct from a file.
14921 * @see elm_toolbar_item_icon_set()
14922 * @see elm_toolbar_item_del()
14923 * @see elm_toolbar_item_del_cb_set()
14927 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);
14929 * Get the first item in the given toolbar widget's list of
14932 * @param obj The toolbar object
14933 * @return The first item or @c NULL, if it has no items (and on
14936 * @see elm_toolbar_item_append()
14937 * @see elm_toolbar_last_item_get()
14941 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14943 * Get the last item in the given toolbar widget's list of
14946 * @param obj The toolbar object
14947 * @return The last item or @c NULL, if it has no items (and on
14950 * @see elm_toolbar_item_prepend()
14951 * @see elm_toolbar_first_item_get()
14955 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14957 * Get the item after @p item in toolbar.
14959 * @param it The toolbar item.
14960 * @return The item after @p item, or @c NULL if none or on failure.
14962 * @note If it is the last item, @c NULL will be returned.
14964 * @see elm_toolbar_item_append()
14968 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14970 * Get the item before @p item in toolbar.
14972 * @param item The toolbar item.
14973 * @return The item before @p item, or @c NULL if none or on failure.
14975 * @note If it is the first item, @c NULL will be returned.
14977 * @see elm_toolbar_item_prepend()
14981 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14983 * Get the toolbar object from an item.
14985 * @param it The item.
14986 * @return The toolbar object.
14988 * This returns the toolbar object itself that an item belongs to.
14992 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14994 * Set the priority of a toolbar item.
14996 * @param it The toolbar item.
14997 * @param priority The item priority. The default is zero.
14999 * This is used only when the toolbar shrink mode is set to
15000 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15001 * When space is less than required, items with low priority
15002 * will be removed from the toolbar and added to a dynamically-created menu,
15003 * while items with higher priority will remain on the toolbar,
15004 * with the same order they were added.
15006 * @see elm_toolbar_item_priority_get()
15010 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15012 * Get the priority of a toolbar item.
15014 * @param it The toolbar item.
15015 * @return The @p item priority, or @c 0 on failure.
15017 * @see elm_toolbar_item_priority_set() for details.
15021 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15023 * Get the label of item.
15025 * @param it The item of toolbar.
15026 * @return The label of item.
15028 * The return value is a pointer to the label associated to @p item when
15029 * it was created, with function elm_toolbar_item_append() or similar,
15031 * with function elm_toolbar_item_label_set. If no label
15032 * was passed as argument, it will return @c NULL.
15034 * @see elm_toolbar_item_label_set() for more details.
15035 * @see elm_toolbar_item_append()
15039 EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15041 * Set the label of item.
15043 * @param it The item of toolbar.
15044 * @param text The label of item.
15046 * The label to be displayed by the item.
15047 * Label will be placed at icons bottom (if set).
15049 * If a label was passed as argument on item creation, with function
15050 * elm_toolbar_item_append() or similar, it will be already
15051 * displayed by the item.
15053 * @see elm_toolbar_item_label_get()
15054 * @see elm_toolbar_item_append()
15058 EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15060 * Return the data associated with a given toolbar widget item.
15062 * @param it The toolbar widget item handle.
15063 * @return The data associated with @p item.
15065 * @see elm_toolbar_item_data_set()
15069 EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15071 * Set the data associated with a given toolbar widget item.
15073 * @param it The toolbar widget item handle
15074 * @param data The new data pointer to set to @p item.
15076 * This sets new item data on @p item.
15078 * @warning The old data pointer won't be touched by this function, so
15079 * the user had better to free that old data himself/herself.
15083 EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15085 * Returns a pointer to a toolbar item by its label.
15087 * @param obj The toolbar object.
15088 * @param label The label of the item to find.
15090 * @return The pointer to the toolbar item matching @p label or @c NULL
15095 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15097 * Get whether the @p item is selected or not.
15099 * @param it The toolbar item.
15100 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15101 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15103 * @see elm_toolbar_selected_item_set() for details.
15104 * @see elm_toolbar_item_selected_get()
15108 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15110 * Set the selected state of an item.
15112 * @param it The toolbar item
15113 * @param selected The selected state
15115 * This sets the selected state of the given item @p it.
15116 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15118 * If a new item is selected the previosly selected will be unselected.
15119 * Previoulsy selected item can be get with function
15120 * elm_toolbar_selected_item_get().
15122 * Selected items will be highlighted.
15124 * @see elm_toolbar_item_selected_get()
15125 * @see elm_toolbar_selected_item_get()
15129 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15131 * Get the selected item.
15133 * @param obj The toolbar object.
15134 * @return The selected toolbar item.
15136 * The selected item can be unselected with function
15137 * elm_toolbar_item_selected_set().
15139 * The selected item always will be highlighted on toolbar.
15141 * @see elm_toolbar_selected_items_get()
15145 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15147 * Set the icon associated with @p item.
15149 * @param obj The parent of this item.
15150 * @param it The toolbar item.
15151 * @param icon A string with icon name or the absolute path of an image file.
15153 * Toolbar will load icon image from fdo or current theme.
15154 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15155 * If an absolute path is provided it will load it direct from a file.
15157 * @see elm_toolbar_icon_order_lookup_set()
15158 * @see elm_toolbar_icon_order_lookup_get()
15162 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15164 * Get the string used to set the icon of @p item.
15166 * @param it The toolbar item.
15167 * @return The string associated with the icon object.
15169 * @see elm_toolbar_item_icon_set() for details.
15173 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15175 * Get the object of @p item.
15177 * @param it The toolbar item.
15178 * @return The object
15182 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15184 * Get the icon object of @p item.
15186 * @param it The toolbar item.
15187 * @return The icon object
15189 * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15190 * or elm_toolbar_item_icon_memfile_set() for details.
15194 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15196 * Set the icon associated with @p item to an image in a binary buffer.
15198 * @param it The toolbar item.
15199 * @param img The binary data that will be used as an image
15200 * @param size The size of binary data @p img
15201 * @param format Optional format of @p img to pass to the image loader
15202 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15204 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15206 * @note The icon image set by this function can be changed by
15207 * elm_toolbar_item_icon_set().
15211 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);
15214 * Set the icon associated with @p item to an image in a binary buffer.
15216 * @param it The toolbar item.
15217 * @param file The file that contains the image
15218 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15220 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15222 * @note The icon image set by this function can be changed by
15223 * elm_toolbar_item_icon_set().
15227 EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
15230 * Delete them item from the toolbar.
15232 * @param it The item of toolbar to be deleted.
15234 * @see elm_toolbar_item_append()
15235 * @see elm_toolbar_item_del_cb_set()
15239 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15242 * Set the function called when a toolbar item is freed.
15244 * @param it The item to set the callback on.
15245 * @param func The function called.
15247 * If there is a @p func, then it will be called prior item's memory release.
15248 * That will be called with the following arguments:
15250 * @li item's Evas object;
15253 * This way, a data associated to a toolbar item could be properly freed.
15257 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15260 * Get a value whether toolbar item is disabled or not.
15262 * @param it The item.
15263 * @return The disabled state.
15265 * @see elm_toolbar_item_disabled_set() for more details.
15269 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15272 * Sets the disabled/enabled state of a toolbar item.
15274 * @param it The item.
15275 * @param disabled The disabled state.
15277 * A disabled item cannot be selected or unselected. It will also
15278 * change its appearance (generally greyed out). This sets the
15279 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15284 EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15287 * Set or unset item as a separator.
15289 * @param it The toolbar item.
15290 * @param setting @c EINA_TRUE to set item @p item as separator or
15291 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15293 * Items aren't set as separator by default.
15295 * If set as separator it will display separator theme, so won't display
15298 * @see elm_toolbar_item_separator_get()
15302 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
15305 * Get a value whether item is a separator or not.
15307 * @param it The toolbar item.
15308 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15309 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15311 * @see elm_toolbar_item_separator_set() for details.
15315 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15318 * Set the shrink state of toolbar @p obj.
15320 * @param obj The toolbar object.
15321 * @param shrink_mode Toolbar's items display behavior.
15323 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15324 * but will enforce a minimun size so all the items will fit, won't scroll
15325 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15326 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15327 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15331 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15334 * Get the shrink mode of toolbar @p obj.
15336 * @param obj The toolbar object.
15337 * @return Toolbar's items display behavior.
15339 * @see elm_toolbar_mode_shrink_set() for details.
15343 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15346 * Enable/disable homogeneous mode.
15348 * @param obj The toolbar object
15349 * @param homogeneous Assume the items within the toolbar are of the
15350 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15352 * This will enable the homogeneous mode where items are of the same size.
15353 * @see elm_toolbar_homogeneous_get()
15357 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15360 * Get whether the homogeneous mode is enabled.
15362 * @param obj The toolbar object.
15363 * @return Assume the items within the toolbar are of the same height
15364 * and width (EINA_TRUE = on, EINA_FALSE = off).
15366 * @see elm_toolbar_homogeneous_set()
15370 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15372 * Set the parent object of the toolbar items' menus.
15374 * @param obj The toolbar object.
15375 * @param parent The parent of the menu objects.
15377 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15379 * For more details about setting the parent for toolbar menus, see
15380 * elm_menu_parent_set().
15382 * @see elm_menu_parent_set() for details.
15383 * @see elm_toolbar_item_menu_set() for details.
15387 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15389 * Get the parent object of the toolbar items' menus.
15391 * @param obj The toolbar object.
15392 * @return The parent of the menu objects.
15394 * @see elm_toolbar_menu_parent_set() for details.
15398 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15400 * Set the alignment of the items.
15402 * @param obj The toolbar object.
15403 * @param align The new alignment, a float between <tt> 0.0 </tt>
15404 * and <tt> 1.0 </tt>.
15406 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15407 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15410 * Centered items by default.
15412 * @see elm_toolbar_align_get()
15416 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15418 * Get the alignment of the items.
15420 * @param obj The toolbar object.
15421 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15424 * @see elm_toolbar_align_set() for details.
15428 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15430 * Set whether the toolbar item opens a menu.
15432 * @param it The toolbar item.
15433 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15435 * A toolbar item can be set to be a menu, using this function.
15437 * Once it is set to be a menu, it can be manipulated through the
15438 * menu-like function elm_toolbar_menu_parent_set() and the other
15439 * elm_menu functions, using the Evas_Object @c menu returned by
15440 * elm_toolbar_item_menu_get().
15442 * So, items to be displayed in this item's menu should be added with
15443 * elm_menu_item_add().
15445 * The following code exemplifies the most basic usage:
15447 * tb = elm_toolbar_add(win)
15448 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15449 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15450 * elm_toolbar_menu_parent_set(tb, win);
15451 * menu = elm_toolbar_item_menu_get(item);
15452 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15453 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15457 * @see elm_toolbar_item_menu_get()
15461 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
15463 * Get toolbar item's menu.
15465 * @param it The toolbar item.
15466 * @return Item's menu object or @c NULL on failure.
15468 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15469 * this function will set it.
15471 * @see elm_toolbar_item_menu_set() for details.
15475 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15477 * Add a new state to @p item.
15479 * @param it The toolbar item.
15480 * @param icon A string with icon name or the absolute path of an image file.
15481 * @param label The label of the new state.
15482 * @param func The function to call when the item is clicked when this
15483 * state is selected.
15484 * @param data The data to associate with the state.
15485 * @return The toolbar item state, or @c NULL upon failure.
15487 * Toolbar will load icon image from fdo or current theme.
15488 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15489 * If an absolute path is provided it will load it direct from a file.
15491 * States created with this function can be removed with
15492 * elm_toolbar_item_state_del().
15494 * @see elm_toolbar_item_state_del()
15495 * @see elm_toolbar_item_state_sel()
15496 * @see elm_toolbar_item_state_get()
15500 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);
15502 * Delete a previoulsy added state to @p item.
15504 * @param it The toolbar item.
15505 * @param state The state to be deleted.
15506 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15508 * @see elm_toolbar_item_state_add()
15510 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15512 * Set @p state as the current state of @p it.
15514 * @param it The toolbar item.
15515 * @param state The state to use.
15516 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15518 * If @p state is @c NULL, it won't select any state and the default item's
15519 * icon and label will be used. It's the same behaviour than
15520 * elm_toolbar_item_state_unser().
15522 * @see elm_toolbar_item_state_unset()
15526 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15528 * Unset the state of @p it.
15530 * @param it The toolbar item.
15532 * The default icon and label from this item will be displayed.
15534 * @see elm_toolbar_item_state_set() for more details.
15538 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15540 * Get the current state of @p it.
15542 * @param it The toolbar item.
15543 * @return The selected state or @c NULL if none is selected or on failure.
15545 * @see elm_toolbar_item_state_set() for details.
15546 * @see elm_toolbar_item_state_unset()
15547 * @see elm_toolbar_item_state_add()
15551 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15553 * Get the state after selected state in toolbar's @p item.
15555 * @param it The toolbar item to change state.
15556 * @return The state after current state, or @c NULL on failure.
15558 * If last state is selected, this function will return first state.
15560 * @see elm_toolbar_item_state_set()
15561 * @see elm_toolbar_item_state_add()
15565 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15567 * Get the state before selected state in toolbar's @p item.
15569 * @param it The toolbar item to change state.
15570 * @return The state before current state, or @c NULL on failure.
15572 * If first state is selected, this function will return last state.
15574 * @see elm_toolbar_item_state_set()
15575 * @see elm_toolbar_item_state_add()
15579 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15581 * Set the text to be shown in a given toolbar item's tooltips.
15583 * @param it toolbar item.
15584 * @param text The text to set in the content.
15586 * Setup the text as tooltip to object. The item can have only one tooltip,
15587 * so any previous tooltip data - set with this function or
15588 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15590 * @see elm_object_tooltip_text_set() for more details.
15594 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
15596 * Set the content to be shown in the tooltip item.
15598 * Setup the tooltip to item. The item can have only one tooltip,
15599 * so any previous tooltip data is removed. @p func(with @p data) will
15600 * be called every time that need show the tooltip and it should
15601 * return a valid Evas_Object. This object is then managed fully by
15602 * tooltip system and is deleted when the tooltip is gone.
15604 * @param it the toolbar item being attached a tooltip.
15605 * @param func the function used to create the tooltip contents.
15606 * @param data what to provide to @a func as callback data/context.
15607 * @param del_cb called when data is not needed anymore, either when
15608 * another callback replaces @a func, the tooltip is unset with
15609 * elm_toolbar_item_tooltip_unset() or the owner @a item
15610 * dies. This callback receives as the first parameter the
15611 * given @a data, and @c event_info is the item.
15613 * @see elm_object_tooltip_content_cb_set() for more details.
15617 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);
15619 * Unset tooltip from item.
15621 * @param it toolbar item to remove previously set tooltip.
15623 * Remove tooltip from item. The callback provided as del_cb to
15624 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15625 * it is not used anymore.
15627 * @see elm_object_tooltip_unset() for more details.
15628 * @see elm_toolbar_item_tooltip_content_cb_set()
15632 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15634 * Sets a different style for this item tooltip.
15636 * @note before you set a style you should define a tooltip with
15637 * elm_toolbar_item_tooltip_content_cb_set() or
15638 * elm_toolbar_item_tooltip_text_set()
15640 * @param it toolbar item with tooltip already set.
15641 * @param style the theme style to use (default, transparent, ...)
15643 * @see elm_object_tooltip_style_set() for more details.
15647 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15649 * Get the style for this item tooltip.
15651 * @param it toolbar item with tooltip already set.
15652 * @return style the theme style in use, defaults to "default". If the
15653 * object does not have a tooltip set, then NULL is returned.
15655 * @see elm_object_tooltip_style_get() for more details.
15656 * @see elm_toolbar_item_tooltip_style_set()
15660 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15662 * Set the type of mouse pointer/cursor decoration to be shown,
15663 * when the mouse pointer is over the given toolbar widget item
15665 * @param it toolbar item to customize cursor on
15666 * @param cursor the cursor type's name
15668 * This function works analogously as elm_object_cursor_set(), but
15669 * here the cursor's changing area is restricted to the item's
15670 * area, and not the whole widget's. Note that that item cursors
15671 * have precedence over widget cursors, so that a mouse over an
15672 * item with custom cursor set will always show @b that cursor.
15674 * If this function is called twice for an object, a previously set
15675 * cursor will be unset on the second call.
15677 * @see elm_object_cursor_set()
15678 * @see elm_toolbar_item_cursor_get()
15679 * @see elm_toolbar_item_cursor_unset()
15683 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
15686 * Get the type of mouse pointer/cursor decoration set to be shown,
15687 * when the mouse pointer is over the given toolbar widget item
15689 * @param it toolbar item with custom cursor set
15690 * @return the cursor type's name or @c NULL, if no custom cursors
15691 * were set to @p item (and on errors)
15693 * @see elm_object_cursor_get()
15694 * @see elm_toolbar_item_cursor_set()
15695 * @see elm_toolbar_item_cursor_unset()
15699 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15702 * Unset any custom mouse pointer/cursor decoration set to be
15703 * shown, when the mouse pointer is over the given toolbar widget
15704 * item, thus making it show the @b default cursor again.
15706 * @param it a toolbar item
15708 * Use this call to undo any custom settings on this item's cursor
15709 * decoration, bringing it back to defaults (no custom style set).
15711 * @see elm_object_cursor_unset()
15712 * @see elm_toolbar_item_cursor_set()
15716 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15719 * Set a different @b style for a given custom cursor set for a
15722 * @param it toolbar item with custom cursor set
15723 * @param style the <b>theme style</b> to use (e.g. @c "default",
15724 * @c "transparent", etc)
15726 * This function only makes sense when one is using custom mouse
15727 * cursor decorations <b>defined in a theme file</b>, which can have,
15728 * given a cursor name/type, <b>alternate styles</b> on it. It
15729 * works analogously as elm_object_cursor_style_set(), but here
15730 * applyed only to toolbar item objects.
15732 * @warning Before you set a cursor style you should have definen a
15733 * custom cursor previously on the item, with
15734 * elm_toolbar_item_cursor_set()
15736 * @see elm_toolbar_item_cursor_engine_only_set()
15737 * @see elm_toolbar_item_cursor_style_get()
15741 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15744 * Get the current @b style set for a given toolbar item's custom
15747 * @param it toolbar item with custom cursor set.
15748 * @return style the cursor style in use. If the object does not
15749 * have a cursor set, then @c NULL is returned.
15751 * @see elm_toolbar_item_cursor_style_set() for more details
15755 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15758 * Set if the (custom)cursor for a given toolbar item should be
15759 * searched in its theme, also, or should only rely on the
15760 * rendering engine.
15762 * @param it item with custom (custom) cursor already set on
15763 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15764 * only on those provided by the rendering engine, @c EINA_FALSE to
15765 * have them searched on the widget's theme, as well.
15767 * @note This call is of use only if you've set a custom cursor
15768 * for toolbar items, with elm_toolbar_item_cursor_set().
15770 * @note By default, cursors will only be looked for between those
15771 * provided by the rendering engine.
15775 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15778 * Get if the (custom) cursor for a given toolbar item is being
15779 * searched in its theme, also, or is only relying on the rendering
15782 * @param it a toolbar item
15783 * @return @c EINA_TRUE, if cursors are being looked for only on
15784 * those provided by the rendering engine, @c EINA_FALSE if they
15785 * are being searched on the widget's theme, as well.
15787 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15791 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15794 * Change a toolbar's orientation
15795 * @param obj The toolbar object
15796 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15797 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15799 * @deprecated use elm_toolbar_horizontal_set() instead.
15801 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15804 * Change a toolbar's orientation
15805 * @param obj The toolbar object
15806 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15807 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15810 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15813 * Get a toolbar's orientation
15814 * @param obj The toolbar object
15815 * @return If @c EINA_TRUE, the toolbar is vertical
15816 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15818 * @deprecated use elm_toolbar_horizontal_get() instead.
15820 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15823 * Get a toolbar's orientation
15824 * @param obj The toolbar object
15825 * @return If @c EINA_TRUE, the toolbar is horizontal
15826 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15829 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15835 * @defgroup Tooltips Tooltips
15837 * The Tooltip is an (internal, for now) smart object used to show a
15838 * content in a frame on mouse hover of objects(or widgets), with
15839 * tips/information about them.
15844 EAPI double elm_tooltip_delay_get(void);
15845 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15846 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15847 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15848 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15849 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15850 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15851 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);
15852 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15853 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15854 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15855 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15856 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15863 * @defgroup Cursors Cursors
15865 * The Elementary cursor is an internal smart object used to
15866 * customize the mouse cursor displayed over objects (or
15867 * widgets). In the most common scenario, the cursor decoration
15868 * comes from the graphical @b engine Elementary is running
15869 * on. Those engines may provide different decorations for cursors,
15870 * and Elementary provides functions to choose them (think of X11
15871 * cursors, as an example).
15873 * There's also the possibility of, besides using engine provided
15874 * cursors, also use ones coming from Edje theming files. Both
15875 * globally and per widget, Elementary makes it possible for one to
15876 * make the cursors lookup to be held on engines only or on
15877 * Elementary's theme file, too. To set cursor's hot spot,
15878 * two data items should be added to cursor's theme: "hot_x" and
15879 * "hot_y", that are the offset from upper-left corner of the cursor
15880 * (coordinates 0,0).
15886 * Set the cursor to be shown when mouse is over the object
15888 * Set the cursor that will be displayed when mouse is over the
15889 * object. The object can have only one cursor set to it, so if
15890 * this function is called twice for an object, the previous set
15892 * If using X cursors, a definition of all the valid cursor names
15893 * is listed on Elementary_Cursors.h. If an invalid name is set
15894 * the default cursor will be used.
15896 * @param obj the object being set a cursor.
15897 * @param cursor the cursor name to be used.
15901 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15904 * Get the cursor to be shown when mouse is over the object
15906 * @param obj an object with cursor already set.
15907 * @return the cursor name.
15911 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15914 * Unset cursor for object
15916 * Unset cursor for object, and set the cursor to default if the mouse
15917 * was over this object.
15919 * @param obj Target object
15920 * @see elm_object_cursor_set()
15924 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15927 * Sets a different style for this object cursor.
15929 * @note before you set a style you should define a cursor with
15930 * elm_object_cursor_set()
15932 * @param obj an object with cursor already set.
15933 * @param style the theme style to use (default, transparent, ...)
15937 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15940 * Get the style for this object cursor.
15942 * @param obj an object with cursor already set.
15943 * @return style the theme style in use, defaults to "default". If the
15944 * object does not have a cursor set, then NULL is returned.
15948 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15951 * Set if the cursor set should be searched on the theme or should use
15952 * the provided by the engine, only.
15954 * @note before you set if should look on theme you should define a cursor
15955 * with elm_object_cursor_set(). By default it will only look for cursors
15956 * provided by the engine.
15958 * @param obj an object with cursor already set.
15959 * @param engine_only boolean to define it cursors should be looked only
15960 * between the provided by the engine or searched on widget's theme as well.
15964 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15967 * Get the cursor engine only usage for this object cursor.
15969 * @param obj an object with cursor already set.
15970 * @return engine_only boolean to define it cursors should be
15971 * looked only between the provided by the engine or searched on
15972 * widget's theme as well. If the object does not have a cursor
15973 * set, then EINA_FALSE is returned.
15977 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15980 * Get the configured cursor engine only usage
15982 * This gets the globally configured exclusive usage of engine cursors.
15984 * @return 1 if only engine cursors should be used
15987 EAPI int elm_cursor_engine_only_get(void);
15990 * Set the configured cursor engine only usage
15992 * This sets the globally configured exclusive usage of engine cursors.
15993 * It won't affect cursors set before changing this value.
15995 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15996 * look for them on theme before.
15997 * @return EINA_TRUE if value is valid and setted (0 or 1)
16000 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
16007 * @defgroup Menu Menu
16009 * @image html img/widget/menu/preview-00.png
16010 * @image latex img/widget/menu/preview-00.eps
16012 * A menu is a list of items displayed above its parent. When the menu is
16013 * showing its parent is darkened. Each item can have a sub-menu. The menu
16014 * object can be used to display a menu on a right click event, in a toolbar,
16017 * Signals that you can add callbacks for are:
16018 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16020 * Default contents parts of the menu items that you can use for are:
16021 * @li "default" - A main content of the menu item
16023 * Default text parts of the menu items that you can use for are:
16024 * @li "default" - label in the menu item
16026 * @see @ref tutorial_menu
16031 * @brief Add a new menu to the parent
16033 * @param parent The parent object.
16034 * @return The new object or NULL if it cannot be created.
16036 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16038 * @brief Set the parent for the given menu widget
16040 * @param obj The menu object.
16041 * @param parent The new parent.
16043 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16045 * @brief Get the parent for the given menu widget
16047 * @param obj The menu object.
16048 * @return The parent.
16050 * @see elm_menu_parent_set()
16052 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16054 * @brief Move the menu to a new position
16056 * @param obj The menu object.
16057 * @param x The new position.
16058 * @param y The new position.
16060 * Sets the top-left position of the menu to (@p x,@p y).
16062 * @note @p x and @p y coordinates are relative to parent.
16064 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16066 * @brief Close a opened menu
16068 * @param obj the menu object
16071 * Hides the menu and all it's sub-menus.
16073 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16075 * @brief Returns a list of @p item's items.
16077 * @param obj The menu object
16078 * @return An Eina_List* of @p item's items
16080 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16082 * @brief Get the Evas_Object of an Elm_Object_Item
16084 * @param it The menu item object.
16085 * @return The edje object containing the swallowed content
16087 * @warning Don't manipulate this object!
16090 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16092 * @brief Add an item at the end of the given menu widget
16094 * @param obj The menu object.
16095 * @param parent The parent menu item (optional)
16096 * @param icon An icon display on the item. The icon will be destryed by the menu.
16097 * @param label The label of the item.
16098 * @param func Function called when the user select the item.
16099 * @param data Data sent by the callback.
16100 * @return Returns the new item.
16102 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);
16104 * @brief Add an object swallowed in an item at the end of the given menu
16107 * @param obj The menu object.
16108 * @param parent The parent menu item (optional)
16109 * @param subobj The object to swallow
16110 * @param func Function called when the user select the item.
16111 * @param data Data sent by the callback.
16112 * @return Returns the new item.
16114 * Add an evas object as an item to the menu.
16116 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);
16118 * @brief Set the label of a menu item
16120 * @param it The menu item object.
16121 * @param label The label to set for @p item
16123 * @warning Don't use this funcion on items created with
16124 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16126 * @deprecated Use elm_object_item_text_set() instead
16128 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16130 * @brief Get the label of a menu item
16132 * @param it The menu item object.
16133 * @return The label of @p item
16134 * @deprecated Use elm_object_item_text_get() instead
16136 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16138 * @brief Set the icon of a menu item to the standard icon with name @p icon
16140 * @param it The menu item object.
16141 * @param icon The icon object to set for the content of @p item
16143 * Once this icon is set, any previously set icon will be deleted.
16145 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16147 * @brief Get the string representation from the icon of a menu item
16149 * @param it The menu item object.
16150 * @return The string representation of @p item's icon or NULL
16152 * @see elm_menu_item_object_icon_name_set()
16154 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16156 * @brief Set the content object of a menu item
16158 * @param it The menu item object
16159 * @param The content object or NULL
16160 * @return EINA_TRUE on success, else EINA_FALSE
16162 * Use this function to change the object swallowed by a menu item, deleting
16163 * any previously swallowed object.
16165 * @deprecated Use elm_object_item_content_set() instead
16167 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16169 * @brief Get the content object of a menu item
16171 * @param it The menu item object
16172 * @return The content object or NULL
16173 * @note If @p item was added with elm_menu_item_add_object, this
16174 * function will return the object passed, else it will return the
16177 * @see elm_menu_item_object_content_set()
16179 * @deprecated Use elm_object_item_content_get() instead
16181 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16183 * @brief Set the selected state of @p item.
16185 * @param it The menu item object.
16186 * @param selected The selected/unselected state of the item
16188 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16190 * @brief Get the selected state of @p item.
16192 * @param it The menu item object.
16193 * @return The selected/unselected state of the item
16195 * @see elm_menu_item_selected_set()
16197 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16199 * @brief Set the disabled state of @p item.
16201 * @param it The menu item object.
16202 * @param disabled The enabled/disabled state of the item
16203 * @deprecated Use elm_object_item_disabled_set() instead
16205 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16207 * @brief Get the disabled state of @p item.
16209 * @param it The menu item object.
16210 * @return The enabled/disabled state of the item
16212 * @see elm_menu_item_disabled_set()
16213 * @deprecated Use elm_object_item_disabled_get() instead
16215 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16217 * @brief Add a separator item to menu @p obj under @p parent.
16219 * @param obj The menu object
16220 * @param parent The item to add the separator under
16221 * @return The created item or NULL on failure
16223 * This is item is a @ref Separator.
16225 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16227 * @brief Returns whether @p item is a separator.
16229 * @param it The item to check
16230 * @return If true, @p item is a separator
16232 * @see elm_menu_item_separator_add()
16234 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16236 * @brief Deletes an item from the menu.
16238 * @param it The item to delete.
16240 * @see elm_menu_item_add()
16242 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16244 * @brief Set the function called when a menu item is deleted.
16246 * @param it The item to set the callback on
16247 * @param func The function called
16249 * @see elm_menu_item_add()
16250 * @see elm_menu_item_del()
16252 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16254 * @brief Returns the data associated with menu item @p item.
16256 * @param it The item
16257 * @return The data associated with @p item or NULL if none was set.
16259 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16261 * @deprecated Use elm_object_item_data_get() instead
16263 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16265 * @brief Sets the data to be associated with menu item @p item.
16267 * @param it The item
16268 * @param data The data to be associated with @p item
16270 * @deprecated Use elm_object_item_data_set() instead
16272 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16275 * @brief Returns a list of @p item's subitems.
16277 * @param it The item
16278 * @return An Eina_List* of @p item's subitems
16280 * @see elm_menu_add()
16282 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16284 * @brief Get the position of a menu item
16286 * @param it The menu item
16287 * @return The item's index
16289 * This function returns the index position of a menu item in a menu.
16290 * For a sub-menu, this number is relative to the first item in the sub-menu.
16292 * @note Index values begin with 0
16294 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16296 * @brief @brief Return a menu item's owner menu
16298 * @param it The menu item
16299 * @return The menu object owning @p item, or NULL on failure
16301 * Use this function to get the menu object owning an item.
16303 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16305 * @brief Get the selected item in the menu
16307 * @param obj The menu object
16308 * @return The selected item, or NULL if none
16310 * @see elm_menu_item_selected_get()
16311 * @see elm_menu_item_selected_set()
16313 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16315 * @brief Get the last item in the menu
16317 * @param obj The menu object
16318 * @return The last item, or NULL if none
16320 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16322 * @brief Get the first item in the menu
16324 * @param obj The menu object
16325 * @return The first item, or NULL if none
16327 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16329 * @brief Get the next item in the menu.
16331 * @param it The menu item object.
16332 * @return The item after it, or NULL if none
16334 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16336 * @brief Get the previous item in the menu.
16338 * @param it The menu item object.
16339 * @return The item before it, or NULL if none
16341 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16347 * @defgroup List List
16348 * @ingroup Elementary
16350 * @image html img/widget/list/preview-00.png
16351 * @image latex img/widget/list/preview-00.eps width=\textwidth
16353 * @image html img/list.png
16354 * @image latex img/list.eps width=\textwidth
16356 * A list widget is a container whose children are displayed vertically or
16357 * horizontally, in order, and can be selected.
16358 * The list can accept only one or multiple items selection. Also has many
16359 * modes of items displaying.
16361 * A list is a very simple type of list widget. For more robust
16362 * lists, @ref Genlist should probably be used.
16364 * Smart callbacks one can listen to:
16365 * - @c "activated" - The user has double-clicked or pressed
16366 * (enter|return|spacebar) on an item. The @c event_info parameter
16367 * is the item that was activated.
16368 * - @c "clicked,double" - The user has double-clicked an item.
16369 * The @c event_info parameter is the item that was double-clicked.
16370 * - "selected" - when the user selected an item
16371 * - "unselected" - when the user unselected an item
16372 * - "longpressed" - an item in the list is long-pressed
16373 * - "edge,top" - the list is scrolled until the top edge
16374 * - "edge,bottom" - the list is scrolled until the bottom edge
16375 * - "edge,left" - the list is scrolled until the left edge
16376 * - "edge,right" - the list is scrolled until the right edge
16377 * - "language,changed" - the program's language changed
16379 * Available styles for it:
16382 * List of examples:
16383 * @li @ref list_example_01
16384 * @li @ref list_example_02
16385 * @li @ref list_example_03
16394 * @enum _Elm_List_Mode
16395 * @typedef Elm_List_Mode
16397 * Set list's resize behavior, transverse axis scroll and
16398 * items cropping. See each mode's description for more details.
16400 * @note Default value is #ELM_LIST_SCROLL.
16402 * Values <b> don't </b> work as bitmask, only one can be choosen.
16404 * @see elm_list_mode_set()
16405 * @see elm_list_mode_get()
16409 typedef enum _Elm_List_Mode
16411 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. */
16412 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). */
16413 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. */
16414 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. */
16415 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16418 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(). */
16421 * Add a new list widget to the given parent Elementary
16422 * (container) object.
16424 * @param parent The parent object.
16425 * @return a new list widget handle or @c NULL, on errors.
16427 * This function inserts a new list widget on the canvas.
16431 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16436 * @param obj The list object
16438 * @note Call before running show() on the list object.
16439 * @warning If not called, it won't display the list properly.
16442 * li = elm_list_add(win);
16443 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16444 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16446 * evas_object_show(li);
16451 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16454 * Enable or disable multiple items selection on the list object.
16456 * @param obj The list object
16457 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16460 * Disabled by default. If disabled, the user can select a single item of
16461 * the list each time. Selected items are highlighted on list.
16462 * If enabled, many items can be selected.
16464 * If a selected item is selected again, it will be unselected.
16466 * @see elm_list_multi_select_get()
16470 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16473 * Get a value whether multiple items selection is enabled or not.
16475 * @see elm_list_multi_select_set() for details.
16477 * @param obj The list object.
16478 * @return @c EINA_TRUE means multiple items selection is enabled.
16479 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16480 * @c EINA_FALSE is returned.
16484 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16487 * Set which mode to use for the list object.
16489 * @param obj The list object
16490 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16491 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16493 * Set list's resize behavior, transverse axis scroll and
16494 * items cropping. See each mode's description for more details.
16496 * @note Default value is #ELM_LIST_SCROLL.
16498 * Only one can be set, if a previous one was set, it will be changed
16499 * by the new mode set. Bitmask won't work as well.
16501 * @see elm_list_mode_get()
16505 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16508 * Get the mode the list is at.
16510 * @param obj The list object
16511 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16512 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16514 * @note see elm_list_mode_set() for more information.
16518 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16521 * Enable or disable horizontal mode on the list object.
16523 * @param obj The list object.
16524 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16525 * disable it, i.e., to enable vertical mode.
16527 * @note Vertical mode is set by default.
16529 * On horizontal mode items are displayed on list from left to right,
16530 * instead of from top to bottom. Also, the list will scroll horizontally.
16531 * Each item will presents left icon on top and right icon, or end, at
16534 * @see elm_list_horizontal_get()
16538 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16541 * Get a value whether horizontal mode is enabled or not.
16543 * @param obj The list object.
16544 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16545 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16546 * @c EINA_FALSE is returned.
16548 * @see elm_list_horizontal_set() for details.
16552 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16555 * Enable or disable always select mode on the list object.
16557 * @param obj The list object
16558 * @param always_select @c EINA_TRUE to enable always select mode or
16559 * @c EINA_FALSE to disable it.
16561 * @note Always select mode is disabled by default.
16563 * Default behavior of list items is to only call its callback function
16564 * the first time it's pressed, i.e., when it is selected. If a selected
16565 * item is pressed again, and multi-select is disabled, it won't call
16566 * this function (if multi-select is enabled it will unselect the item).
16568 * If always select is enabled, it will call the callback function
16569 * everytime a item is pressed, so it will call when the item is selected,
16570 * and again when a selected item is pressed.
16572 * @see elm_list_always_select_mode_get()
16573 * @see elm_list_multi_select_set()
16577 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16580 * Get a value whether always select mode is enabled or not, meaning that
16581 * an item will always call its callback function, even if already selected.
16583 * @param obj The list object
16584 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16585 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16586 * @c EINA_FALSE is returned.
16588 * @see elm_list_always_select_mode_set() for details.
16592 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16595 * Set bouncing behaviour when the scrolled content reaches an edge.
16597 * Tell the internal scroller object whether it should bounce or not
16598 * when it reaches the respective edges for each axis.
16600 * @param obj The list object
16601 * @param h_bounce Whether to bounce or not in the horizontal axis.
16602 * @param v_bounce Whether to bounce or not in the vertical axis.
16604 * @see elm_scroller_bounce_set()
16608 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16611 * Get the bouncing behaviour of the internal scroller.
16613 * Get whether the internal scroller should bounce when the edge of each
16614 * axis is reached scrolling.
16616 * @param obj The list object.
16617 * @param h_bounce Pointer where to store the bounce state of the horizontal
16619 * @param v_bounce Pointer where to store the bounce state of the vertical
16622 * @see elm_scroller_bounce_get()
16623 * @see elm_list_bounce_set()
16627 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16630 * Set the scrollbar policy.
16632 * @param obj The list object
16633 * @param policy_h Horizontal scrollbar policy.
16634 * @param policy_v Vertical scrollbar policy.
16636 * This sets the scrollbar visibility policy for the given scroller.
16637 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16638 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16639 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16640 * This applies respectively for the horizontal and vertical scrollbars.
16642 * The both are disabled by default, i.e., are set to
16643 * #ELM_SCROLLER_POLICY_OFF.
16647 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16650 * Get the scrollbar policy.
16652 * @see elm_list_scroller_policy_get() for details.
16654 * @param obj The list object.
16655 * @param policy_h Pointer where to store horizontal scrollbar policy.
16656 * @param policy_v Pointer where to store vertical scrollbar policy.
16660 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);
16663 * Append a new item to the list object.
16665 * @param obj The list object.
16666 * @param label The label of the list item.
16667 * @param icon The icon object to use for the left side of the item. An
16668 * icon can be any Evas object, but usually it is an icon created
16669 * with elm_icon_add().
16670 * @param end The icon object to use for the right side of the item. An
16671 * icon can be any Evas object.
16672 * @param func The function to call when the item is clicked.
16673 * @param data The data to associate with the item for related callbacks.
16675 * @return The created item or @c NULL upon failure.
16677 * A new item will be created and appended to the list, i.e., will
16678 * be set as @b last item.
16680 * Items created with this method can be deleted with
16681 * elm_list_item_del().
16683 * Associated @p data can be properly freed when item is deleted if a
16684 * callback function is set with elm_list_item_del_cb_set().
16686 * If a function is passed as argument, it will be called everytime this item
16687 * is selected, i.e., the user clicks over an unselected item.
16688 * If always select is enabled it will call this function every time
16689 * user clicks over an item (already selected or not).
16690 * If such function isn't needed, just passing
16691 * @c NULL as @p func is enough. The same should be done for @p data.
16693 * Simple example (with no function callback or data associated):
16695 * li = elm_list_add(win);
16696 * ic = elm_icon_add(win);
16697 * elm_icon_file_set(ic, "path/to/image", NULL);
16698 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16699 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16701 * evas_object_show(li);
16704 * @see elm_list_always_select_mode_set()
16705 * @see elm_list_item_del()
16706 * @see elm_list_item_del_cb_set()
16707 * @see elm_list_clear()
16708 * @see elm_icon_add()
16712 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);
16715 * Prepend a new item to the list object.
16717 * @param obj The list object.
16718 * @param label The label of the list item.
16719 * @param icon The icon object to use for the left side of the item. An
16720 * icon can be any Evas object, but usually it is an icon created
16721 * with elm_icon_add().
16722 * @param end The icon object to use for the right side of the item. An
16723 * icon can be any Evas object.
16724 * @param func The function to call when the item is clicked.
16725 * @param data The data to associate with the item for related callbacks.
16727 * @return The created item or @c NULL upon failure.
16729 * A new item will be created and prepended to the list, i.e., will
16730 * be set as @b first item.
16732 * Items created with this method can be deleted with
16733 * elm_list_item_del().
16735 * Associated @p data can be properly freed when item is deleted if a
16736 * callback function is set with elm_list_item_del_cb_set().
16738 * If a function is passed as argument, it will be called everytime this item
16739 * is selected, i.e., the user clicks over an unselected item.
16740 * If always select is enabled it will call this function every time
16741 * user clicks over an item (already selected or not).
16742 * If such function isn't needed, just passing
16743 * @c NULL as @p func is enough. The same should be done for @p data.
16745 * @see elm_list_item_append() for a simple code example.
16746 * @see elm_list_always_select_mode_set()
16747 * @see elm_list_item_del()
16748 * @see elm_list_item_del_cb_set()
16749 * @see elm_list_clear()
16750 * @see elm_icon_add()
16754 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);
16757 * Insert a new item into the list object before item @p before.
16759 * @param obj The list object.
16760 * @param before The list item to insert before.
16761 * @param label The label of the list item.
16762 * @param icon The icon object to use for the left side of the item. An
16763 * icon can be any Evas object, but usually it is an icon created
16764 * with elm_icon_add().
16765 * @param end The icon object to use for the right side of the item. An
16766 * icon can be any Evas object.
16767 * @param func The function to call when the item is clicked.
16768 * @param data The data to associate with the item for related callbacks.
16770 * @return The created item or @c NULL upon failure.
16772 * A new item will be created and added to the list. Its position in
16773 * this list will be just before item @p before.
16775 * Items created with this method can be deleted with
16776 * elm_list_item_del().
16778 * Associated @p data can be properly freed when item is deleted if a
16779 * callback function is set with elm_list_item_del_cb_set().
16781 * If a function is passed as argument, it will be called everytime this item
16782 * is selected, i.e., the user clicks over an unselected item.
16783 * If always select is enabled it will call this function every time
16784 * user clicks over an item (already selected or not).
16785 * If such function isn't needed, just passing
16786 * @c NULL as @p func is enough. The same should be done for @p data.
16788 * @see elm_list_item_append() for a simple code example.
16789 * @see elm_list_always_select_mode_set()
16790 * @see elm_list_item_del()
16791 * @see elm_list_item_del_cb_set()
16792 * @see elm_list_clear()
16793 * @see elm_icon_add()
16797 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);
16800 * Insert a new item into the list object after item @p after.
16802 * @param obj The list object.
16803 * @param after The list item to insert after.
16804 * @param label The label of the list item.
16805 * @param icon The icon object to use for the left side of the item. An
16806 * icon can be any Evas object, but usually it is an icon created
16807 * with elm_icon_add().
16808 * @param end The icon object to use for the right side of the item. An
16809 * icon can be any Evas object.
16810 * @param func The function to call when the item is clicked.
16811 * @param data The data to associate with the item for related callbacks.
16813 * @return The created item or @c NULL upon failure.
16815 * A new item will be created and added to the list. Its position in
16816 * this list will be just after item @p after.
16818 * Items created with this method can be deleted with
16819 * elm_list_item_del().
16821 * Associated @p data can be properly freed when item is deleted if a
16822 * callback function is set with elm_list_item_del_cb_set().
16824 * If a function is passed as argument, it will be called everytime this item
16825 * is selected, i.e., the user clicks over an unselected item.
16826 * If always select is enabled it will call this function every time
16827 * user clicks over an item (already selected or not).
16828 * If such function isn't needed, just passing
16829 * @c NULL as @p func is enough. The same should be done for @p data.
16831 * @see elm_list_item_append() for a simple code example.
16832 * @see elm_list_always_select_mode_set()
16833 * @see elm_list_item_del()
16834 * @see elm_list_item_del_cb_set()
16835 * @see elm_list_clear()
16836 * @see elm_icon_add()
16840 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);
16843 * Insert a new item into the sorted list object.
16845 * @param obj The list object.
16846 * @param label The label of the list item.
16847 * @param icon The icon object to use for the left side of the item. An
16848 * icon can be any Evas object, but usually it is an icon created
16849 * with elm_icon_add().
16850 * @param end The icon object to use for the right side of the item. An
16851 * icon can be any Evas object.
16852 * @param func The function to call when the item is clicked.
16853 * @param data The data to associate with the item for related callbacks.
16854 * @param cmp_func The comparing function to be used to sort list
16855 * items <b>by #Elm_List_Item item handles</b>. This function will
16856 * receive two items and compare them, returning a non-negative integer
16857 * if the second item should be place after the first, or negative value
16858 * if should be placed before.
16860 * @return The created item or @c NULL upon failure.
16862 * @note This function inserts values into a list object assuming it was
16863 * sorted and the result will be sorted.
16865 * A new item will be created and added to the list. Its position in
16866 * this list will be found comparing the new item with previously inserted
16867 * items using function @p cmp_func.
16869 * Items created with this method can be deleted with
16870 * elm_list_item_del().
16872 * Associated @p data can be properly freed when item is deleted if a
16873 * callback function is set with elm_list_item_del_cb_set().
16875 * If a function is passed as argument, it will be called everytime this item
16876 * is selected, i.e., the user clicks over an unselected item.
16877 * If always select is enabled it will call this function every time
16878 * user clicks over an item (already selected or not).
16879 * If such function isn't needed, just passing
16880 * @c NULL as @p func is enough. The same should be done for @p data.
16882 * @see elm_list_item_append() for a simple code example.
16883 * @see elm_list_always_select_mode_set()
16884 * @see elm_list_item_del()
16885 * @see elm_list_item_del_cb_set()
16886 * @see elm_list_clear()
16887 * @see elm_icon_add()
16891 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);
16894 * Remove all list's items.
16896 * @param obj The list object
16898 * @see elm_list_item_del()
16899 * @see elm_list_item_append()
16903 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16906 * Get a list of all the list items.
16908 * @param obj The list object
16909 * @return An @c Eina_List of list items, #Elm_List_Item,
16910 * or @c NULL on failure.
16912 * @see elm_list_item_append()
16913 * @see elm_list_item_del()
16914 * @see elm_list_clear()
16918 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16921 * Get the selected item.
16923 * @param obj The list object.
16924 * @return The selected list item.
16926 * The selected item can be unselected with function
16927 * elm_list_item_selected_set().
16929 * The selected item always will be highlighted on list.
16931 * @see elm_list_selected_items_get()
16935 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16938 * Return a list of the currently selected list items.
16940 * @param obj The list object.
16941 * @return An @c Eina_List of list items, #Elm_List_Item,
16942 * or @c NULL on failure.
16944 * Multiple items can be selected if multi select is enabled. It can be
16945 * done with elm_list_multi_select_set().
16947 * @see elm_list_selected_item_get()
16948 * @see elm_list_multi_select_set()
16952 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16955 * Set the selected state of an item.
16957 * @param item The list item
16958 * @param selected The selected state
16960 * This sets the selected state of the given item @p it.
16961 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16963 * If a new item is selected the previosly selected will be unselected,
16964 * unless multiple selection is enabled with elm_list_multi_select_set().
16965 * Previoulsy selected item can be get with function
16966 * elm_list_selected_item_get().
16968 * Selected items will be highlighted.
16970 * @see elm_list_item_selected_get()
16971 * @see elm_list_selected_item_get()
16972 * @see elm_list_multi_select_set()
16976 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16979 * Get whether the @p item is selected or not.
16981 * @param item The list item.
16982 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16983 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16985 * @see elm_list_selected_item_set() for details.
16986 * @see elm_list_item_selected_get()
16990 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16993 * Set or unset item as a separator.
16995 * @param it The list item.
16996 * @param setting @c EINA_TRUE to set item @p it as separator or
16997 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16999 * Items aren't set as separator by default.
17001 * If set as separator it will display separator theme, so won't display
17004 * @see elm_list_item_separator_get()
17008 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17011 * Get a value whether item is a separator or not.
17013 * @see elm_list_item_separator_set() for details.
17015 * @param it The list item.
17016 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17017 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17021 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17024 * Show @p item in the list view.
17026 * @param item The list item to be shown.
17028 * It won't animate list until item is visible. If such behavior is wanted,
17029 * use elm_list_bring_in() intead.
17033 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17036 * Bring in the given item to list view.
17038 * @param item The item.
17040 * This causes list to jump to the given item @p item and show it
17041 * (by scrolling), if it is not fully visible.
17043 * This may use animation to do so and take a period of time.
17045 * If animation isn't wanted, elm_list_item_show() can be used.
17049 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17052 * Delete them item from the list.
17054 * @param item The item of list to be deleted.
17056 * If deleting all list items is required, elm_list_clear()
17057 * should be used instead of getting items list and deleting each one.
17059 * @see elm_list_clear()
17060 * @see elm_list_item_append()
17061 * @see elm_list_item_del_cb_set()
17065 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17068 * Set the function called when a list item is freed.
17070 * @param item The item to set the callback on
17071 * @param func The function called
17073 * If there is a @p func, then it will be called prior item's memory release.
17074 * That will be called with the following arguments:
17076 * @li item's Evas object;
17079 * This way, a data associated to a list item could be properly freed.
17083 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17086 * Get the data associated to the item.
17088 * @param item The list item
17089 * @return The data associated to @p item
17091 * The return value is a pointer to data associated to @p item when it was
17092 * created, with function elm_list_item_append() or similar. If no data
17093 * was passed as argument, it will return @c NULL.
17095 * @see elm_list_item_append()
17099 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17102 * Get the left side icon associated to the item.
17104 * @param item The list item
17105 * @return The left side icon associated to @p item
17107 * The return value is a pointer to the icon associated to @p item when
17109 * created, with function elm_list_item_append() or similar, or later
17110 * with function elm_list_item_icon_set(). If no icon
17111 * was passed as argument, it will return @c NULL.
17113 * @see elm_list_item_append()
17114 * @see elm_list_item_icon_set()
17118 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17121 * Set the left side icon associated to the item.
17123 * @param item The list item
17124 * @param icon The left side icon object to associate with @p item
17126 * The icon object to use at left side of the item. An
17127 * icon can be any Evas object, but usually it is an icon created
17128 * with elm_icon_add().
17130 * Once the icon object is set, a previously set one will be deleted.
17131 * @warning Setting the same icon for two items will cause the icon to
17132 * dissapear from the first item.
17134 * If an icon was passed as argument on item creation, with function
17135 * elm_list_item_append() or similar, it will be already
17136 * associated to the item.
17138 * @see elm_list_item_append()
17139 * @see elm_list_item_icon_get()
17143 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17146 * Get the right side icon associated to the item.
17148 * @param item The list item
17149 * @return The right side icon associated to @p item
17151 * The return value is a pointer to the icon associated to @p item when
17153 * created, with function elm_list_item_append() or similar, or later
17154 * with function elm_list_item_icon_set(). If no icon
17155 * was passed as argument, it will return @c NULL.
17157 * @see elm_list_item_append()
17158 * @see elm_list_item_icon_set()
17162 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17165 * Set the right side icon associated to the item.
17167 * @param item The list item
17168 * @param end The right side icon object to associate with @p item
17170 * The icon object to use at right side of the item. An
17171 * icon can be any Evas object, but usually it is an icon created
17172 * with elm_icon_add().
17174 * Once the icon object is set, a previously set one will be deleted.
17175 * @warning Setting the same icon for two items will cause the icon to
17176 * dissapear from the first item.
17178 * If an icon was passed as argument on item creation, with function
17179 * elm_list_item_append() or similar, it will be already
17180 * associated to the item.
17182 * @see elm_list_item_append()
17183 * @see elm_list_item_end_get()
17187 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17190 * Gets the base object of the item.
17192 * @param item The list item
17193 * @return The base object associated with @p item
17195 * Base object is the @c Evas_Object that represents that item.
17199 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17200 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17203 * Get the label of item.
17205 * @param item The item of list.
17206 * @return The label of item.
17208 * The return value is a pointer to the label associated to @p item when
17209 * it was created, with function elm_list_item_append(), or later
17210 * with function elm_list_item_label_set. If no label
17211 * was passed as argument, it will return @c NULL.
17213 * @see elm_list_item_label_set() for more details.
17214 * @see elm_list_item_append()
17218 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17221 * Set the label of item.
17223 * @param item The item of list.
17224 * @param text The label of item.
17226 * The label to be displayed by the item.
17227 * Label will be placed between left and right side icons (if set).
17229 * If a label was passed as argument on item creation, with function
17230 * elm_list_item_append() or similar, it will be already
17231 * displayed by the item.
17233 * @see elm_list_item_label_get()
17234 * @see elm_list_item_append()
17238 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17242 * Get the item before @p it in list.
17244 * @param it The list item.
17245 * @return The item before @p it, or @c NULL if none or on failure.
17247 * @note If it is the first item, @c NULL will be returned.
17249 * @see elm_list_item_append()
17250 * @see elm_list_items_get()
17254 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17257 * Get the item after @p it in list.
17259 * @param it The list item.
17260 * @return The item after @p it, or @c NULL if none or on failure.
17262 * @note If it is the last item, @c NULL will be returned.
17264 * @see elm_list_item_append()
17265 * @see elm_list_items_get()
17269 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17272 * Sets the disabled/enabled state of a list item.
17274 * @param it The item.
17275 * @param disabled The disabled state.
17277 * A disabled item cannot be selected or unselected. It will also
17278 * change its appearance (generally greyed out). This sets the
17279 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17284 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17287 * Get a value whether list item is disabled or not.
17289 * @param it The item.
17290 * @return The disabled state.
17292 * @see elm_list_item_disabled_set() for more details.
17296 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17299 * Set the text to be shown in a given list item's tooltips.
17301 * @param item Target item.
17302 * @param text The text to set in the content.
17304 * Setup the text as tooltip to object. The item can have only one tooltip,
17305 * so any previous tooltip data - set with this function or
17306 * elm_list_item_tooltip_content_cb_set() - is removed.
17308 * @see elm_object_tooltip_text_set() for more details.
17312 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17316 * @brief Disable size restrictions on an object's tooltip
17317 * @param item The tooltip's anchor object
17318 * @param disable If EINA_TRUE, size restrictions are disabled
17319 * @return EINA_FALSE on failure, EINA_TRUE on success
17321 * This function allows a tooltip to expand beyond its parant window's canvas.
17322 * It will instead be limited only by the size of the display.
17324 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17326 * @brief Retrieve size restriction state of an object's tooltip
17327 * @param obj The tooltip's anchor object
17328 * @return If EINA_TRUE, size restrictions are disabled
17330 * This function returns whether a tooltip is allowed to expand beyond
17331 * its parant window's canvas.
17332 * It will instead be limited only by the size of the display.
17334 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17337 * Set the content to be shown in the tooltip item.
17339 * Setup the tooltip to item. The item can have only one tooltip,
17340 * so any previous tooltip data is removed. @p func(with @p data) will
17341 * be called every time that need show the tooltip and it should
17342 * return a valid Evas_Object. This object is then managed fully by
17343 * tooltip system and is deleted when the tooltip is gone.
17345 * @param item the list item being attached a tooltip.
17346 * @param func the function used to create the tooltip contents.
17347 * @param data what to provide to @a func as callback data/context.
17348 * @param del_cb called when data is not needed anymore, either when
17349 * another callback replaces @a func, the tooltip is unset with
17350 * elm_list_item_tooltip_unset() or the owner @a item
17351 * dies. This callback receives as the first parameter the
17352 * given @a data, and @c event_info is the item.
17354 * @see elm_object_tooltip_content_cb_set() for more details.
17358 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);
17361 * Unset tooltip from item.
17363 * @param item list item to remove previously set tooltip.
17365 * Remove tooltip from item. The callback provided as del_cb to
17366 * elm_list_item_tooltip_content_cb_set() will be called to notify
17367 * it is not used anymore.
17369 * @see elm_object_tooltip_unset() for more details.
17370 * @see elm_list_item_tooltip_content_cb_set()
17374 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17377 * Sets a different style for this item tooltip.
17379 * @note before you set a style you should define a tooltip with
17380 * elm_list_item_tooltip_content_cb_set() or
17381 * elm_list_item_tooltip_text_set()
17383 * @param item list item with tooltip already set.
17384 * @param style the theme style to use (default, transparent, ...)
17386 * @see elm_object_tooltip_style_set() for more details.
17390 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17393 * Get the style for this item tooltip.
17395 * @param item list item with tooltip already set.
17396 * @return style the theme style in use, defaults to "default". If the
17397 * object does not have a tooltip set, then NULL is returned.
17399 * @see elm_object_tooltip_style_get() for more details.
17400 * @see elm_list_item_tooltip_style_set()
17404 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17407 * Set the type of mouse pointer/cursor decoration to be shown,
17408 * when the mouse pointer is over the given list widget item
17410 * @param item list item to customize cursor on
17411 * @param cursor the cursor type's name
17413 * This function works analogously as elm_object_cursor_set(), but
17414 * here the cursor's changing area is restricted to the item's
17415 * area, and not the whole widget's. Note that that item cursors
17416 * have precedence over widget cursors, so that a mouse over an
17417 * item with custom cursor set will always show @b that cursor.
17419 * If this function is called twice for an object, a previously set
17420 * cursor will be unset on the second call.
17422 * @see elm_object_cursor_set()
17423 * @see elm_list_item_cursor_get()
17424 * @see elm_list_item_cursor_unset()
17428 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17431 * Get the type of mouse pointer/cursor decoration set to be shown,
17432 * when the mouse pointer is over the given list widget item
17434 * @param item list item with custom cursor set
17435 * @return the cursor type's name or @c NULL, if no custom cursors
17436 * were set to @p item (and on errors)
17438 * @see elm_object_cursor_get()
17439 * @see elm_list_item_cursor_set()
17440 * @see elm_list_item_cursor_unset()
17444 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17447 * Unset any custom mouse pointer/cursor decoration set to be
17448 * shown, when the mouse pointer is over the given list widget
17449 * item, thus making it show the @b default cursor again.
17451 * @param item a list item
17453 * Use this call to undo any custom settings on this item's cursor
17454 * decoration, bringing it back to defaults (no custom style set).
17456 * @see elm_object_cursor_unset()
17457 * @see elm_list_item_cursor_set()
17461 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17464 * Set a different @b style for a given custom cursor set for a
17467 * @param item list item with custom cursor set
17468 * @param style the <b>theme style</b> to use (e.g. @c "default",
17469 * @c "transparent", etc)
17471 * This function only makes sense when one is using custom mouse
17472 * cursor decorations <b>defined in a theme file</b>, which can have,
17473 * given a cursor name/type, <b>alternate styles</b> on it. It
17474 * works analogously as elm_object_cursor_style_set(), but here
17475 * applyed only to list item objects.
17477 * @warning Before you set a cursor style you should have definen a
17478 * custom cursor previously on the item, with
17479 * elm_list_item_cursor_set()
17481 * @see elm_list_item_cursor_engine_only_set()
17482 * @see elm_list_item_cursor_style_get()
17486 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17489 * Get the current @b style set for a given list item's custom
17492 * @param item list item with custom cursor set.
17493 * @return style the cursor style in use. If the object does not
17494 * have a cursor set, then @c NULL is returned.
17496 * @see elm_list_item_cursor_style_set() for more details
17500 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17503 * Set if the (custom)cursor for a given list item should be
17504 * searched in its theme, also, or should only rely on the
17505 * rendering engine.
17507 * @param item item with custom (custom) cursor already set on
17508 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17509 * only on those provided by the rendering engine, @c EINA_FALSE to
17510 * have them searched on the widget's theme, as well.
17512 * @note This call is of use only if you've set a custom cursor
17513 * for list items, with elm_list_item_cursor_set().
17515 * @note By default, cursors will only be looked for between those
17516 * provided by the rendering engine.
17520 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17523 * Get if the (custom) cursor for a given list item is being
17524 * searched in its theme, also, or is only relying on the rendering
17527 * @param item a list item
17528 * @return @c EINA_TRUE, if cursors are being looked for only on
17529 * those provided by the rendering engine, @c EINA_FALSE if they
17530 * are being searched on the widget's theme, as well.
17532 * @see elm_list_item_cursor_engine_only_set(), for more details
17536 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17543 * @defgroup Slider Slider
17544 * @ingroup Elementary
17546 * @image html img/widget/slider/preview-00.png
17547 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17549 * The slider adds a dragable āsliderā widget for selecting the value of
17550 * something within a range.
17552 * A slider can be horizontal or vertical. It can contain an Icon and has a
17553 * primary label as well as a units label (that is formatted with floating
17554 * point values and thus accepts a printf-style format string, like
17555 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17556 * else (like on the slider itself) that also accepts a format string like
17557 * units. Label, Icon Unit and Indicator strings/objects are optional.
17559 * A slider may be inverted which means values invert, with high vales being
17560 * on the left or top and low values on the right or bottom (as opposed to
17561 * normally being low on the left or top and high on the bottom and right).
17563 * The slider should have its minimum and maximum values set by the
17564 * application with elm_slider_min_max_set() and value should also be set by
17565 * the application before use with elm_slider_value_set(). The span of the
17566 * slider is its length (horizontally or vertically). This will be scaled by
17567 * the object or applications scaling factor. At any point code can query the
17568 * slider for its value with elm_slider_value_get().
17570 * Smart callbacks one can listen to:
17571 * - "changed" - Whenever the slider value is changed by the user.
17572 * - "slider,drag,start" - dragging the slider indicator around has started.
17573 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17574 * - "delay,changed" - A short time after the value is changed by the user.
17575 * This will be called only when the user stops dragging for
17576 * a very short period or when they release their
17577 * finger/mouse, so it avoids possibly expensive reactions to
17578 * the value change.
17580 * Available styles for it:
17583 * Default contents parts of the slider widget that you can use for are:
17584 * @li "icon" - An icon of the slider
17585 * @li "end" - A end part content of the slider
17587 * Default text parts of the silder widget that you can use for are:
17588 * @li "default" - Label of the silder
17589 * Here is an example on its usage:
17590 * @li @ref slider_example
17594 * @addtogroup Slider
17599 * Add a new slider widget to the given parent Elementary
17600 * (container) object.
17602 * @param parent The parent object.
17603 * @return a new slider widget handle or @c NULL, on errors.
17605 * This function inserts a new slider widget on the canvas.
17609 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17612 * Set the label of a given slider widget
17614 * @param obj The progress bar object
17615 * @param label The text label string, in UTF-8
17618 * @deprecated use elm_object_text_set() instead.
17620 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17623 * Get the label of a given slider widget
17625 * @param obj The progressbar object
17626 * @return The text label string, in UTF-8
17629 * @deprecated use elm_object_text_get() instead.
17631 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17634 * Set the icon object of the slider object.
17636 * @param obj The slider object.
17637 * @param icon The icon object.
17639 * On horizontal mode, icon is placed at left, and on vertical mode,
17642 * @note Once the icon object is set, a previously set one will be deleted.
17643 * If you want to keep that old content object, use the
17644 * elm_slider_icon_unset() function.
17646 * @warning If the object being set does not have minimum size hints set,
17647 * it won't get properly displayed.
17650 * @deprecated use elm_object_part_content_set() instead.
17652 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17655 * Unset an icon set on a given slider widget.
17657 * @param obj The slider object.
17658 * @return The icon object that was being used, if any was set, or
17659 * @c NULL, otherwise (and on errors).
17661 * On horizontal mode, icon is placed at left, and on vertical mode,
17664 * This call will unparent and return the icon object which was set
17665 * for this widget, previously, on success.
17667 * @see elm_slider_icon_set() for more details
17668 * @see elm_slider_icon_get()
17669 * @deprecated use elm_object_part_content_unset() instead.
17673 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17676 * Retrieve the icon object set for a given slider widget.
17678 * @param obj The slider object.
17679 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17680 * otherwise (and on errors).
17682 * On horizontal mode, icon is placed at left, and on vertical mode,
17685 * @see elm_slider_icon_set() for more details
17686 * @see elm_slider_icon_unset()
17688 * @deprecated use elm_object_part_content_get() instead.
17692 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17695 * Set the end object of the slider object.
17697 * @param obj The slider object.
17698 * @param end The end object.
17700 * On horizontal mode, end is placed at left, and on vertical mode,
17701 * placed at bottom.
17703 * @note Once the icon object is set, a previously set one will be deleted.
17704 * If you want to keep that old content object, use the
17705 * elm_slider_end_unset() function.
17707 * @warning If the object being set does not have minimum size hints set,
17708 * it won't get properly displayed.
17710 * @deprecated use elm_object_part_content_set() instead.
17714 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17717 * Unset an end object set on a given slider widget.
17719 * @param obj The slider object.
17720 * @return The end object that was being used, if any was set, or
17721 * @c NULL, otherwise (and on errors).
17723 * On horizontal mode, end is placed at left, and on vertical mode,
17724 * placed at bottom.
17726 * This call will unparent and return the icon object which was set
17727 * for this widget, previously, on success.
17729 * @see elm_slider_end_set() for more details.
17730 * @see elm_slider_end_get()
17732 * @deprecated use elm_object_part_content_unset() instead
17737 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17740 * Retrieve the end object set for a given slider widget.
17742 * @param obj The slider object.
17743 * @return The end object's handle, if @p obj had one set, or @c NULL,
17744 * otherwise (and on errors).
17746 * On horizontal mode, icon is placed at right, and on vertical mode,
17747 * placed at bottom.
17749 * @see elm_slider_end_set() for more details.
17750 * @see elm_slider_end_unset()
17753 * @deprecated use elm_object_part_content_get() instead
17758 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17761 * Set the (exact) length of the bar region of a given slider widget.
17763 * @param obj The slider object.
17764 * @param size The length of the slider's bar region.
17766 * This sets the minimum width (when in horizontal mode) or height
17767 * (when in vertical mode) of the actual bar area of the slider
17768 * @p obj. This in turn affects the object's minimum size. Use
17769 * this when you're not setting other size hints expanding on the
17770 * given direction (like weight and alignment hints) and you would
17771 * like it to have a specific size.
17773 * @note Icon, end, label, indicator and unit text around @p obj
17774 * will require their
17775 * own space, which will make @p obj to require more the @p size,
17778 * @see elm_slider_span_size_get()
17782 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17785 * Get the length set for the bar region of a given slider widget
17787 * @param obj The slider object.
17788 * @return The length of the slider's bar region.
17790 * If that size was not set previously, with
17791 * elm_slider_span_size_set(), this call will return @c 0.
17795 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17798 * Set the format string for the unit label.
17800 * @param obj The slider object.
17801 * @param format The format string for the unit display.
17803 * Unit label is displayed all the time, if set, after slider's bar.
17804 * In horizontal mode, at right and in vertical mode, at bottom.
17806 * If @c NULL, unit label won't be visible. If not it sets the format
17807 * string for the label text. To the label text is provided a floating point
17808 * value, so the label text can display up to 1 floating point value.
17809 * Note that this is optional.
17811 * Use a format string such as "%1.2f meters" for example, and it will
17812 * display values like: "3.14 meters" for a value equal to 3.14159.
17814 * Default is unit label disabled.
17816 * @see elm_slider_indicator_format_get()
17820 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17823 * Get the unit label format of the slider.
17825 * @param obj The slider object.
17826 * @return The unit label format string in UTF-8.
17828 * Unit label is displayed all the time, if set, after slider's bar.
17829 * In horizontal mode, at right and in vertical mode, at bottom.
17831 * @see elm_slider_unit_format_set() for more
17832 * information on how this works.
17836 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17839 * Set the format string for the indicator label.
17841 * @param obj The slider object.
17842 * @param indicator The format string for the indicator display.
17844 * The slider may display its value somewhere else then unit label,
17845 * for example, above the slider knob that is dragged around. This function
17846 * sets the format string used for this.
17848 * If @c NULL, indicator label won't be visible. If not it sets the format
17849 * string for the label text. To the label text is provided a floating point
17850 * value, so the label text can display up to 1 floating point value.
17851 * Note that this is optional.
17853 * Use a format string such as "%1.2f meters" for example, and it will
17854 * display values like: "3.14 meters" for a value equal to 3.14159.
17856 * Default is indicator label disabled.
17858 * @see elm_slider_indicator_format_get()
17862 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17865 * Get the indicator label format of the slider.
17867 * @param obj The slider object.
17868 * @return The indicator label format string in UTF-8.
17870 * The slider may display its value somewhere else then unit label,
17871 * for example, above the slider knob that is dragged around. This function
17872 * gets the format string used for this.
17874 * @see elm_slider_indicator_format_set() for more
17875 * information on how this works.
17879 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17882 * Set the format function pointer for the indicator label
17884 * @param obj The slider object.
17885 * @param func The indicator format function.
17886 * @param free_func The freeing function for the format string.
17888 * Set the callback function to format the indicator string.
17890 * @see elm_slider_indicator_format_set() for more info on how this works.
17894 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);
17897 * Set the format function pointer for the units label
17899 * @param obj The slider object.
17900 * @param func The units format function.
17901 * @param free_func The freeing function for the format string.
17903 * Set the callback function to format the indicator string.
17905 * @see elm_slider_units_format_set() for more info on how this works.
17909 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);
17912 * Set the orientation of a given slider widget.
17914 * @param obj The slider object.
17915 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17916 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17918 * Use this function to change how your slider is to be
17919 * disposed: vertically or horizontally.
17921 * By default it's displayed horizontally.
17923 * @see elm_slider_horizontal_get()
17927 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17930 * Retrieve the orientation of a given slider widget
17932 * @param obj The slider object.
17933 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17934 * @c EINA_FALSE if it's @b vertical (and on errors).
17936 * @see elm_slider_horizontal_set() for more details.
17940 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17943 * Set the minimum and maximum values for the slider.
17945 * @param obj The slider object.
17946 * @param min The minimum value.
17947 * @param max The maximum value.
17949 * Define the allowed range of values to be selected by the user.
17951 * If actual value is less than @p min, it will be updated to @p min. If it
17952 * is bigger then @p max, will be updated to @p max. Actual value can be
17953 * get with elm_slider_value_get().
17955 * By default, min is equal to 0.0, and max is equal to 1.0.
17957 * @warning Maximum must be greater than minimum, otherwise behavior
17960 * @see elm_slider_min_max_get()
17964 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17967 * Get the minimum and maximum values of the slider.
17969 * @param obj The slider object.
17970 * @param min Pointer where to store the minimum value.
17971 * @param max Pointer where to store the maximum value.
17973 * @note If only one value is needed, the other pointer can be passed
17976 * @see elm_slider_min_max_set() for details.
17980 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17983 * Set the value the slider displays.
17985 * @param obj The slider object.
17986 * @param val The value to be displayed.
17988 * Value will be presented on the unit label following format specified with
17989 * elm_slider_unit_format_set() and on indicator with
17990 * elm_slider_indicator_format_set().
17992 * @warning The value must to be between min and max values. This values
17993 * are set by elm_slider_min_max_set().
17995 * @see elm_slider_value_get()
17996 * @see elm_slider_unit_format_set()
17997 * @see elm_slider_indicator_format_set()
17998 * @see elm_slider_min_max_set()
18002 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18005 * Get the value displayed by the spinner.
18007 * @param obj The spinner object.
18008 * @return The value displayed.
18010 * @see elm_spinner_value_set() for details.
18014 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18017 * Invert a given slider widget's displaying values order
18019 * @param obj The slider object.
18020 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18021 * @c EINA_FALSE to bring it back to default, non-inverted values.
18023 * A slider may be @b inverted, in which state it gets its
18024 * values inverted, with high vales being on the left or top and
18025 * low values on the right or bottom, as opposed to normally have
18026 * the low values on the former and high values on the latter,
18027 * respectively, for horizontal and vertical modes.
18029 * @see elm_slider_inverted_get()
18033 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18036 * Get whether a given slider widget's displaying values are
18039 * @param obj The slider object.
18040 * @return @c EINA_TRUE, if @p obj has inverted values,
18041 * @c EINA_FALSE otherwise (and on errors).
18043 * @see elm_slider_inverted_set() for more details.
18047 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18050 * Set whether to enlarge slider indicator (augmented knob) or not.
18052 * @param obj The slider object.
18053 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18054 * let the knob always at default size.
18056 * By default, indicator will be bigger while dragged by the user.
18058 * @warning It won't display values set with
18059 * elm_slider_indicator_format_set() if you disable indicator.
18063 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18066 * Get whether a given slider widget's enlarging indicator or not.
18068 * @param obj The slider object.
18069 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18070 * @c EINA_FALSE otherwise (and on errors).
18072 * @see elm_slider_indicator_show_set() for details.
18076 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18083 * @addtogroup Actionslider Actionslider
18085 * @image html img/widget/actionslider/preview-00.png
18086 * @image latex img/widget/actionslider/preview-00.eps
18088 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18089 * properties. The user drags and releases the indicator, to choose a label.
18091 * Labels occupy the following positions.
18096 * Positions can be enabled or disabled.
18098 * Magnets can be set on the above positions.
18100 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18102 * @note By default all positions are set as enabled.
18104 * Signals that you can add callbacks for are:
18106 * "selected" - when user selects an enabled position (the label is passed
18109 * "pos_changed" - when the indicator reaches any of the positions("left",
18110 * "right" or "center").
18112 * See an example of actionslider usage @ref actionslider_example_page "here"
18115 typedef enum _Elm_Actionslider_Pos
18117 ELM_ACTIONSLIDER_NONE = 0,
18118 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18119 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18120 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18121 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18122 } Elm_Actionslider_Pos;
18125 * Add a new actionslider to the parent.
18127 * @param parent The parent object
18128 * @return The new actionslider object or NULL if it cannot be created
18130 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18132 * Set actionslider labels.
18134 * @param obj The actionslider object
18135 * @param left_label The label to be set on the left.
18136 * @param center_label The label to be set on the center.
18137 * @param right_label The label to be set on the right.
18138 * @deprecated use elm_object_text_set() instead.
18140 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);
18142 * Get actionslider labels.
18144 * @param obj The actionslider object
18145 * @param left_label A char** to place the left_label of @p obj into.
18146 * @param center_label A char** to place the center_label of @p obj into.
18147 * @param right_label A char** to place the right_label of @p obj into.
18148 * @deprecated use elm_object_text_set() instead.
18150 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);
18152 * Get actionslider selected label.
18154 * @param obj The actionslider object
18155 * @return The selected label
18157 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18159 * Set actionslider indicator position.
18161 * @param obj The actionslider object.
18162 * @param pos The position of the indicator.
18164 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18166 * Get actionslider indicator position.
18168 * @param obj The actionslider object.
18169 * @return The position of the indicator.
18171 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18173 * Set actionslider magnet position. To make multiple positions magnets @c or
18174 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18176 * @param obj The actionslider object.
18177 * @param pos Bit mask indicating the magnet positions.
18179 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18181 * Get actionslider magnet position.
18183 * @param obj The actionslider object.
18184 * @return The positions with magnet property.
18186 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18188 * Set actionslider enabled position. To set multiple positions as enabled @c or
18189 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18191 * @note All the positions are enabled by default.
18193 * @param obj The actionslider object.
18194 * @param pos Bit mask indicating the enabled positions.
18196 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18198 * Get actionslider enabled position.
18200 * @param obj The actionslider object.
18201 * @return The enabled positions.
18203 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18205 * Set the label used on the indicator.
18207 * @param obj The actionslider object
18208 * @param label The label to be set on the indicator.
18209 * @deprecated use elm_object_text_set() instead.
18211 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18213 * Get the label used on the indicator object.
18215 * @param obj The actionslider object
18216 * @return The indicator label
18217 * @deprecated use elm_object_text_get() instead.
18219 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18225 * @defgroup Genlist Genlist
18227 * @image html img/widget/genlist/preview-00.png
18228 * @image latex img/widget/genlist/preview-00.eps
18229 * @image html img/genlist.png
18230 * @image latex img/genlist.eps
18232 * This widget aims to have more expansive list than the simple list in
18233 * Elementary that could have more flexible items and allow many more entries
18234 * while still being fast and low on memory usage. At the same time it was
18235 * also made to be able to do tree structures. But the price to pay is more
18236 * complexity when it comes to usage. If all you want is a simple list with
18237 * icons and a single text, use the normal @ref List object.
18239 * Genlist has a fairly large API, mostly because it's relatively complex,
18240 * trying to be both expansive, powerful and efficient. First we will begin
18241 * an overview on the theory behind genlist.
18243 * @section Genlist_Item_Class Genlist item classes - creating items
18245 * In order to have the ability to add and delete items on the fly, genlist
18246 * implements a class (callback) system where the application provides a
18247 * structure with information about that type of item (genlist may contain
18248 * multiple different items with different classes, states and styles).
18249 * Genlist will call the functions in this struct (methods) when an item is
18250 * "realized" (i.e., created dynamically, while the user is scrolling the
18251 * grid). All objects will simply be deleted when no longer needed with
18252 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18253 * following members:
18254 * - @c item_style - This is a constant string and simply defines the name
18255 * of the item style. It @b must be specified and the default should be @c
18258 * - @c func - A struct with pointers to functions that will be called when
18259 * an item is going to be actually created. All of them receive a @c data
18260 * parameter that will point to the same data passed to
18261 * elm_genlist_item_append() and related item creation functions, and a @c
18262 * obj parameter that points to the genlist object itself.
18264 * The function pointers inside @c func are @c text_get, @c content_get, @c
18265 * state_get and @c del. The 3 first functions also receive a @c part
18266 * parameter described below. A brief description of these functions follows:
18268 * - @c text_get - The @c part parameter is the name string of one of the
18269 * existing text parts in the Edje group implementing the item's theme.
18270 * This function @b must return a strdup'()ed string, as the caller will
18271 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
18272 * - @c content_get - The @c part parameter is the name string of one of the
18273 * existing (content) swallow parts in the Edje group implementing the item's
18274 * theme. It must return @c NULL, when no content is desired, or a valid
18275 * object handle, otherwise. The object will be deleted by the genlist on
18276 * its deletion or when the item is "unrealized". See
18277 * #Elm_Genlist_Item_Content_Get_Cb.
18278 * - @c func.state_get - The @c part parameter is the name string of one of
18279 * the state parts in the Edje group implementing the item's theme. Return
18280 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18281 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18282 * and @c "elm" as "emission" and "source" arguments, respectively, when
18283 * the state is true (the default is false), where @c XXX is the name of
18284 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18285 * - @c func.del - This is intended for use when genlist items are deleted,
18286 * so any data attached to the item (e.g. its data parameter on creation)
18287 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18289 * available item styles:
18291 * - default_style - The text part is a textblock
18293 * @image html img/widget/genlist/preview-04.png
18294 * @image latex img/widget/genlist/preview-04.eps
18298 * @image html img/widget/genlist/preview-01.png
18299 * @image latex img/widget/genlist/preview-01.eps
18301 * - icon_top_text_bottom
18303 * @image html img/widget/genlist/preview-02.png
18304 * @image latex img/widget/genlist/preview-02.eps
18308 * @image html img/widget/genlist/preview-03.png
18309 * @image latex img/widget/genlist/preview-03.eps
18311 * @section Genlist_Items Structure of items
18313 * An item in a genlist can have 0 or more texts (they can be regular
18314 * text or textblock Evas objects - that's up to the style to determine), 0
18315 * or more contents (which are simply objects swallowed into the genlist item's
18316 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18317 * behavior left to the user to define. The Edje part names for each of
18318 * these properties will be looked up, in the theme file for the genlist,
18319 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18320 * "states", respectively. For each of those properties, if more than one
18321 * part is provided, they must have names listed separated by spaces in the
18322 * data fields. For the default genlist item theme, we have @b one text
18323 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18324 * "elm.swallow.end") and @b no state parts.
18326 * A genlist item may be at one of several styles. Elementary provides one
18327 * by default - "default", but this can be extended by system or application
18328 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18331 * @section Genlist_Manipulation Editing and Navigating
18333 * Items can be added by several calls. All of them return a @ref
18334 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18335 * They all take a data parameter that is meant to be used for a handle to
18336 * the applications internal data (eg the struct with the original item
18337 * data). The parent parameter is the parent genlist item this belongs to if
18338 * it is a tree or an indexed group, and NULL if there is no parent. The
18339 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18340 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18341 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18342 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18343 * is set then this item is group index item that is displayed at the top
18344 * until the next group comes. The func parameter is a convenience callback
18345 * that is called when the item is selected and the data parameter will be
18346 * the func_data parameter, obj be the genlist object and event_info will be
18347 * the genlist item.
18349 * elm_genlist_item_append() adds an item to the end of the list, or if
18350 * there is a parent, to the end of all the child items of the parent.
18351 * elm_genlist_item_prepend() is the same but adds to the beginning of
18352 * the list or children list. elm_genlist_item_insert_before() inserts at
18353 * item before another item and elm_genlist_item_insert_after() inserts after
18354 * the indicated item.
18356 * The application can clear the list with elm_genlist_clear() which deletes
18357 * all the items in the list and elm_genlist_item_del() will delete a specific
18358 * item. elm_genlist_item_subitems_clear() will clear all items that are
18359 * children of the indicated parent item.
18361 * To help inspect list items you can jump to the item at the top of the list
18362 * with elm_genlist_first_item_get() which will return the item pointer, and
18363 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18364 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18365 * and previous items respectively relative to the indicated item. Using
18366 * these calls you can walk the entire item list/tree. Note that as a tree
18367 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18368 * let you know which item is the parent (and thus know how to skip them if
18371 * @section Genlist_Muti_Selection Multi-selection
18373 * If the application wants multiple items to be able to be selected,
18374 * elm_genlist_multi_select_set() can enable this. If the list is
18375 * single-selection only (the default), then elm_genlist_selected_item_get()
18376 * will return the selected item, if any, or NULL if none is selected. If the
18377 * list is multi-select then elm_genlist_selected_items_get() will return a
18378 * list (that is only valid as long as no items are modified (added, deleted,
18379 * selected or unselected)).
18381 * @section Genlist_Usage_Hints Usage hints
18383 * There are also convenience functions. elm_genlist_item_genlist_get() will
18384 * return the genlist object the item belongs to. elm_genlist_item_show()
18385 * will make the scroller scroll to show that specific item so its visible.
18386 * elm_genlist_item_data_get() returns the data pointer set by the item
18387 * creation functions.
18389 * If an item changes (state of boolean changes, text or contents change),
18390 * then use elm_genlist_item_update() to have genlist update the item with
18391 * the new state. Genlist will re-realize the item thus call the functions
18392 * in the _Elm_Genlist_Item_Class for that item.
18394 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18395 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18396 * to expand/contract an item and get its expanded state, use
18397 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18398 * again to make an item disabled (unable to be selected and appear
18399 * differently) use elm_genlist_item_disabled_set() to set this and
18400 * elm_genlist_item_disabled_get() to get the disabled state.
18402 * In general to indicate how the genlist should expand items horizontally to
18403 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18404 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18405 * mode means that if items are too wide to fit, the scroller will scroll
18406 * horizontally. Otherwise items are expanded to fill the width of the
18407 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18408 * to the viewport width and limited to that size. This can be combined with
18409 * a different style that uses edjes' ellipsis feature (cutting text off like
18412 * Items will only call their selection func and callback when first becoming
18413 * selected. Any further clicks will do nothing, unless you enable always
18414 * select with elm_genlist_always_select_mode_set(). This means even if
18415 * selected, every click will make the selected callbacks be called.
18416 * elm_genlist_no_select_mode_set() will turn off the ability to select
18417 * items entirely and they will neither appear selected nor call selected
18418 * callback functions.
18420 * Remember that you can create new styles and add your own theme augmentation
18421 * per application with elm_theme_extension_add(). If you absolutely must
18422 * have a specific style that overrides any theme the user or system sets up
18423 * you can use elm_theme_overlay_add() to add such a file.
18425 * @section Genlist_Implementation Implementation
18427 * Evas tracks every object you create. Every time it processes an event
18428 * (mouse move, down, up etc.) it needs to walk through objects and find out
18429 * what event that affects. Even worse every time it renders display updates,
18430 * in order to just calculate what to re-draw, it needs to walk through many
18431 * many many objects. Thus, the more objects you keep active, the more
18432 * overhead Evas has in just doing its work. It is advisable to keep your
18433 * active objects to the minimum working set you need. Also remember that
18434 * object creation and deletion carries an overhead, so there is a
18435 * middle-ground, which is not easily determined. But don't keep massive lists
18436 * of objects you can't see or use. Genlist does this with list objects. It
18437 * creates and destroys them dynamically as you scroll around. It groups them
18438 * into blocks so it can determine the visibility etc. of a whole block at
18439 * once as opposed to having to walk the whole list. This 2-level list allows
18440 * for very large numbers of items to be in the list (tests have used up to
18441 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18442 * may be different sizes, every item added needs to be calculated as to its
18443 * size and thus this presents a lot of overhead on populating the list, this
18444 * genlist employs a queue. Any item added is queued and spooled off over
18445 * time, actually appearing some time later, so if your list has many members
18446 * you may find it takes a while for them to all appear, with your process
18447 * consuming a lot of CPU while it is busy spooling.
18449 * Genlist also implements a tree structure, but it does so with callbacks to
18450 * the application, with the application filling in tree structures when
18451 * requested (allowing for efficient building of a very deep tree that could
18452 * even be used for file-management). See the above smart signal callbacks for
18455 * @section Genlist_Smart_Events Genlist smart events
18457 * Signals that you can add callbacks for are:
18458 * - @c "activated" - The user has double-clicked or pressed
18459 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18460 * item that was activated.
18461 * - @c "clicked,double" - The user has double-clicked an item. The @c
18462 * event_info parameter is the item that was double-clicked.
18463 * - @c "selected" - This is called when a user has made an item selected.
18464 * The event_info parameter is the genlist item that was selected.
18465 * - @c "unselected" - This is called when a user has made an item
18466 * unselected. The event_info parameter is the genlist item that was
18468 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18469 * called and the item is now meant to be expanded. The event_info
18470 * parameter is the genlist item that was indicated to expand. It is the
18471 * job of this callback to then fill in the child items.
18472 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18473 * called and the item is now meant to be contracted. The event_info
18474 * parameter is the genlist item that was indicated to contract. It is the
18475 * job of this callback to then delete the child items.
18476 * - @c "expand,request" - This is called when a user has indicated they want
18477 * to expand a tree branch item. The callback should decide if the item can
18478 * expand (has any children) and then call elm_genlist_item_expanded_set()
18479 * appropriately to set the state. The event_info parameter is the genlist
18480 * item that was indicated to expand.
18481 * - @c "contract,request" - This is called when a user has indicated they
18482 * want to contract a tree branch item. The callback should decide if the
18483 * item can contract (has any children) and then call
18484 * elm_genlist_item_expanded_set() appropriately to set the state. The
18485 * event_info parameter is the genlist item that was indicated to contract.
18486 * - @c "realized" - This is called when the item in the list is created as a
18487 * real evas object. event_info parameter is the genlist item that was
18488 * created. The object may be deleted at any time, so it is up to the
18489 * caller to not use the object pointer from elm_genlist_item_object_get()
18490 * in a way where it may point to freed objects.
18491 * - @c "unrealized" - This is called just before an item is unrealized.
18492 * After this call content objects provided will be deleted and the item
18493 * object itself delete or be put into a floating cache.
18494 * - @c "drag,start,up" - This is called when the item in the list has been
18495 * dragged (not scrolled) up.
18496 * - @c "drag,start,down" - This is called when the item in the list has been
18497 * dragged (not scrolled) down.
18498 * - @c "drag,start,left" - This is called when the item in the list has been
18499 * dragged (not scrolled) left.
18500 * - @c "drag,start,right" - This is called when the item in the list has
18501 * been dragged (not scrolled) right.
18502 * - @c "drag,stop" - This is called when the item in the list has stopped
18504 * - @c "drag" - This is called when the item in the list is being dragged.
18505 * - @c "longpressed" - This is called when the item is pressed for a certain
18506 * amount of time. By default it's 1 second.
18507 * - @c "scroll,anim,start" - This is called when scrolling animation has
18509 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18511 * - @c "scroll,drag,start" - This is called when dragging the content has
18513 * - @c "scroll,drag,stop" - This is called when dragging the content has
18515 * - @c "edge,top" - This is called when the genlist is scrolled until
18517 * - @c "edge,bottom" - This is called when the genlist is scrolled
18518 * until the bottom edge.
18519 * - @c "edge,left" - This is called when the genlist is scrolled
18520 * until the left edge.
18521 * - @c "edge,right" - This is called when the genlist is scrolled
18522 * until the right edge.
18523 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18525 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18527 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18529 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18531 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18532 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18533 * multi-touch pinched in.
18534 * - @c "swipe" - This is called when the genlist is swiped.
18535 * - @c "moved" - This is called when a genlist item is moved.
18536 * - @c "language,changed" - This is called when the program's language is
18539 * @section Genlist_Examples Examples
18541 * Here is a list of examples that use the genlist, trying to show some of
18542 * its capabilities:
18543 * - @ref genlist_example_01
18544 * - @ref genlist_example_02
18545 * - @ref genlist_example_03
18546 * - @ref genlist_example_04
18547 * - @ref genlist_example_05
18551 * @addtogroup Genlist
18556 * @enum _Elm_Genlist_Item_Flags
18557 * @typedef Elm_Genlist_Item_Flags
18559 * Defines if the item is of any special type (has subitems or it's the
18560 * index of a group), or is just a simple item.
18564 typedef enum _Elm_Genlist_Item_Flags
18566 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18567 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18568 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18569 } Elm_Genlist_Item_Flags;
18570 typedef enum _Elm_Genlist_Item_Field_Flags
18572 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18573 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18574 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
18575 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18576 } Elm_Genlist_Item_Field_Flags;
18577 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18578 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18579 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18580 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18581 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18583 * Text fetching class function for Elm_Gen_Item_Class.
18584 * @param data The data passed in the item creation function
18585 * @param obj The base widget object
18586 * @param part The part name of the swallow
18587 * @return The allocated (NOT stringshared) string to set as the text
18589 typedef char *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18591 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18592 * @param data The data passed in the item creation function
18593 * @param obj The base widget object
18594 * @param part The part name of the swallow
18595 * @return The content object to swallow
18597 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18599 * State fetching class function for Elm_Gen_Item_Class.
18600 * @param data The data passed in the item creation function
18601 * @param obj The base widget object
18602 * @param part The part name of the swallow
18603 * @return The hell if I know
18605 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18607 * Deletion class function for Elm_Gen_Item_Class.
18608 * @param data The data passed in the item creation function
18609 * @param obj The base widget object
18611 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18614 * @struct _Elm_Genlist_Item_Class
18616 * Genlist item class definition structs.
18618 * This struct contains the style and fetching functions that will define the
18619 * contents of each item.
18621 * @see @ref Genlist_Item_Class
18623 struct _Elm_Genlist_Item_Class
18625 const char *item_style; /**< style of this class. */
18626 struct Elm_Genlist_Item_Class_Func
18628 Elm_Genlist_Item_Text_Get_Cb text_get; /**< Text fetching class function for genlist item classes.*/
18629 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18630 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18631 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18634 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18636 * Add a new genlist widget to the given parent Elementary
18637 * (container) object
18639 * @param parent The parent object
18640 * @return a new genlist widget handle or @c NULL, on errors
18642 * This function inserts a new genlist widget on the canvas.
18644 * @see elm_genlist_item_append()
18645 * @see elm_genlist_item_del()
18646 * @see elm_genlist_clear()
18650 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18652 * Remove all items from a given genlist widget.
18654 * @param obj The genlist object
18656 * This removes (and deletes) all items in @p obj, leaving it empty.
18658 * @see elm_genlist_item_del(), to remove just one item.
18662 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18664 * Enable or disable multi-selection in the genlist
18666 * @param obj The genlist object
18667 * @param multi Multi-select enable/disable. Default is disabled.
18669 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18670 * the list. This allows more than 1 item to be selected. To retrieve the list
18671 * of selected items, use elm_genlist_selected_items_get().
18673 * @see elm_genlist_selected_items_get()
18674 * @see elm_genlist_multi_select_get()
18678 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18680 * Gets if multi-selection in genlist is enabled or disabled.
18682 * @param obj The genlist object
18683 * @return Multi-select enabled/disabled
18684 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18686 * @see elm_genlist_multi_select_set()
18690 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18692 * This sets the horizontal stretching mode.
18694 * @param obj The genlist object
18695 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18697 * This sets the mode used for sizing items horizontally. Valid modes
18698 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18699 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18700 * the scroller will scroll horizontally. Otherwise items are expanded
18701 * to fill the width of the viewport of the scroller. If it is
18702 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18703 * limited to that size.
18705 * @see elm_genlist_horizontal_get()
18709 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18710 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18712 * Gets the horizontal stretching mode.
18714 * @param obj The genlist object
18715 * @return The mode to use
18716 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18718 * @see elm_genlist_horizontal_set()
18722 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18723 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18725 * Set the always select mode.
18727 * @param obj The genlist object
18728 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18729 * EINA_FALSE = off). Default is @c EINA_FALSE.
18731 * Items will only call their selection func and callback when first
18732 * becoming selected. Any further clicks will do nothing, unless you
18733 * enable always select with elm_genlist_always_select_mode_set().
18734 * This means that, even if selected, every click will make the selected
18735 * callbacks be called.
18737 * @see elm_genlist_always_select_mode_get()
18741 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18743 * Get the always select mode.
18745 * @param obj The genlist object
18746 * @return The always select mode
18747 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18749 * @see elm_genlist_always_select_mode_set()
18753 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18755 * Enable/disable the no select mode.
18757 * @param obj The genlist object
18758 * @param no_select The no select mode
18759 * (EINA_TRUE = on, EINA_FALSE = off)
18761 * This will turn off the ability to select items entirely and they
18762 * will neither appear selected nor call selected callback functions.
18764 * @see elm_genlist_no_select_mode_get()
18768 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18770 * Gets whether the no select mode is enabled.
18772 * @param obj The genlist object
18773 * @return The no select mode
18774 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18776 * @see elm_genlist_no_select_mode_set()
18780 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18782 * Enable/disable compress mode.
18784 * @param obj The genlist object
18785 * @param compress The compress mode
18786 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18788 * This will enable the compress mode where items are "compressed"
18789 * horizontally to fit the genlist scrollable viewport width. This is
18790 * special for genlist. Do not rely on
18791 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18792 * work as genlist needs to handle it specially.
18794 * @see elm_genlist_compress_mode_get()
18798 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18800 * Get whether the compress mode is enabled.
18802 * @param obj The genlist object
18803 * @return The compress mode
18804 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18806 * @see elm_genlist_compress_mode_set()
18810 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18812 * Enable/disable height-for-width mode.
18814 * @param obj The genlist object
18815 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18816 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18818 * With height-for-width mode the item width will be fixed (restricted
18819 * to a minimum of) to the list width when calculating its size in
18820 * order to allow the height to be calculated based on it. This allows,
18821 * for instance, text block to wrap lines if the Edje part is
18822 * configured with "text.min: 0 1".
18824 * @note This mode will make list resize slower as it will have to
18825 * recalculate every item height again whenever the list width
18828 * @note When height-for-width mode is enabled, it also enables
18829 * compress mode (see elm_genlist_compress_mode_set()) and
18830 * disables homogeneous (see elm_genlist_homogeneous_set()).
18834 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18836 * Get whether the height-for-width mode is enabled.
18838 * @param obj The genlist object
18839 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18844 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18846 * Enable/disable horizontal and vertical bouncing effect.
18848 * @param obj The genlist object
18849 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18850 * EINA_FALSE = off). Default is @c EINA_FALSE.
18851 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18852 * EINA_FALSE = off). Default is @c EINA_TRUE.
18854 * This will enable or disable the scroller bouncing effect for the
18855 * genlist. See elm_scroller_bounce_set() for details.
18857 * @see elm_scroller_bounce_set()
18858 * @see elm_genlist_bounce_get()
18862 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18864 * Get whether the horizontal and vertical bouncing effect is enabled.
18866 * @param obj The genlist object
18867 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18869 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18872 * @see elm_genlist_bounce_set()
18876 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18878 * Enable/disable homogeneous mode.
18880 * @param obj The genlist object
18881 * @param homogeneous Assume the items within the genlist are of the
18882 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18885 * This will enable the homogeneous mode where items are of the same
18886 * height and width so that genlist may do the lazy-loading at its
18887 * maximum (which increases the performance for scrolling the list). This
18888 * implies 'compressed' mode.
18890 * @see elm_genlist_compress_mode_set()
18891 * @see elm_genlist_homogeneous_get()
18895 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18897 * Get whether the homogeneous mode is enabled.
18899 * @param obj The genlist object
18900 * @return Assume the items within the genlist are of the same height
18901 * and width (EINA_TRUE = on, EINA_FALSE = off)
18903 * @see elm_genlist_homogeneous_set()
18907 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18909 * Set the maximum number of items within an item block
18911 * @param obj The genlist object
18912 * @param n Maximum number of items within an item block. Default is 32.
18914 * This will configure the block count to tune to the target with
18915 * particular performance matrix.
18917 * A block of objects will be used to reduce the number of operations due to
18918 * many objects in the screen. It can determine the visibility, or if the
18919 * object has changed, it theme needs to be updated, etc. doing this kind of
18920 * calculation to the entire block, instead of per object.
18922 * The default value for the block count is enough for most lists, so unless
18923 * you know you will have a lot of objects visible in the screen at the same
18924 * time, don't try to change this.
18926 * @see elm_genlist_block_count_get()
18927 * @see @ref Genlist_Implementation
18931 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18933 * Get the maximum number of items within an item block
18935 * @param obj The genlist object
18936 * @return Maximum number of items within an item block
18938 * @see elm_genlist_block_count_set()
18942 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18944 * Set the timeout in seconds for the longpress event.
18946 * @param obj The genlist object
18947 * @param timeout timeout in seconds. Default is 1.
18949 * This option will change how long it takes to send an event "longpressed"
18950 * after the mouse down signal is sent to the list. If this event occurs, no
18951 * "clicked" event will be sent.
18953 * @see elm_genlist_longpress_timeout_set()
18957 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18959 * Get the timeout in seconds for the longpress event.
18961 * @param obj The genlist object
18962 * @return timeout in seconds
18964 * @see elm_genlist_longpress_timeout_get()
18968 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18970 * Append a new item in a given genlist widget.
18972 * @param obj The genlist object
18973 * @param itc The item class for the item
18974 * @param data The item data
18975 * @param parent The parent item, or NULL if none
18976 * @param flags Item flags
18977 * @param func Convenience function called when the item is selected
18978 * @param func_data Data passed to @p func above.
18979 * @return A handle to the item added or @c NULL if not possible
18981 * This adds the given item to the end of the list or the end of
18982 * the children list if the @p parent is given.
18984 * @see elm_genlist_item_prepend()
18985 * @see elm_genlist_item_insert_before()
18986 * @see elm_genlist_item_insert_after()
18987 * @see elm_genlist_item_del()
18991 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);
18993 * Prepend a new item in a given genlist widget.
18995 * @param obj The genlist object
18996 * @param itc The item class for the item
18997 * @param data The item data
18998 * @param parent The parent item, or NULL if none
18999 * @param flags Item flags
19000 * @param func Convenience function called when the item is selected
19001 * @param func_data Data passed to @p func above.
19002 * @return A handle to the item added or NULL if not possible
19004 * This adds an item to the beginning of the list or beginning of the
19005 * children of the parent if given.
19007 * @see elm_genlist_item_append()
19008 * @see elm_genlist_item_insert_before()
19009 * @see elm_genlist_item_insert_after()
19010 * @see elm_genlist_item_del()
19014 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);
19016 * Insert an item before another in a genlist widget
19018 * @param obj The genlist object
19019 * @param itc The item class for the item
19020 * @param data The item data
19021 * @param before The item to place this new one before.
19022 * @param flags Item flags
19023 * @param func Convenience function called when the item is selected
19024 * @param func_data Data passed to @p func above.
19025 * @return A handle to the item added or @c NULL if not possible
19027 * This inserts an item before another in the list. It will be in the
19028 * same tree level or group as the item it is inserted before.
19030 * @see elm_genlist_item_append()
19031 * @see elm_genlist_item_prepend()
19032 * @see elm_genlist_item_insert_after()
19033 * @see elm_genlist_item_del()
19037 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);
19039 * Insert an item after another in a genlist widget
19041 * @param obj The genlist object
19042 * @param itc The item class for the item
19043 * @param data The item data
19044 * @param after The item to place this new one after.
19045 * @param flags Item flags
19046 * @param func Convenience function called when the item is selected
19047 * @param func_data Data passed to @p func above.
19048 * @return A handle to the item added or @c NULL if not possible
19050 * This inserts an item after another in the list. It will be in the
19051 * same tree level or group as the item it is inserted after.
19053 * @see elm_genlist_item_append()
19054 * @see elm_genlist_item_prepend()
19055 * @see elm_genlist_item_insert_before()
19056 * @see elm_genlist_item_del()
19060 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);
19062 * Insert a new item into the sorted genlist object
19064 * @param obj The genlist object
19065 * @param itc The item class for the item
19066 * @param data The item data
19067 * @param parent The parent item, or NULL if none
19068 * @param flags Item flags
19069 * @param comp The function called for the sort
19070 * @param func Convenience function called when item selected
19071 * @param func_data Data passed to @p func above.
19072 * @return A handle to the item added or NULL if not possible
19076 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);
19077 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);
19078 /* operations to retrieve existing items */
19080 * Get the selectd item in the genlist.
19082 * @param obj The genlist object
19083 * @return The selected item, or NULL if none is selected.
19085 * This gets the selected item in the list (if multi-selection is enabled, only
19086 * the item that was first selected in the list is returned - which is not very
19087 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19090 * If no item is selected, NULL is returned.
19092 * @see elm_genlist_selected_items_get()
19096 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19098 * Get a list of selected items in the genlist.
19100 * @param obj The genlist object
19101 * @return The list of selected items, or NULL if none are selected.
19103 * It returns a list of the selected items. This list pointer is only valid so
19104 * long as the selection doesn't change (no items are selected or unselected, or
19105 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19106 * pointers. The order of the items in this list is the order which they were
19107 * selected, i.e. the first item in this list is the first item that was
19108 * selected, and so on.
19110 * @note If not in multi-select mode, consider using function
19111 * elm_genlist_selected_item_get() instead.
19113 * @see elm_genlist_multi_select_set()
19114 * @see elm_genlist_selected_item_get()
19118 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19120 * Get the mode item style of items in the genlist
19121 * @param obj The genlist object
19122 * @return The mode item style string, or NULL if none is specified
19124 * This is a constant string and simply defines the name of the
19125 * style that will be used for mode animations. It can be
19126 * @c NULL if you don't plan to use Genlist mode. See
19127 * elm_genlist_item_mode_set() for more info.
19131 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19133 * Set the mode item style of items in the genlist
19134 * @param obj The genlist object
19135 * @param style The mode item style string, or NULL if none is desired
19137 * This is a constant string and simply defines the name of the
19138 * style that will be used for mode animations. It can be
19139 * @c NULL if you don't plan to use Genlist mode. See
19140 * elm_genlist_item_mode_set() for more info.
19144 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19146 * Get a list of realized items in genlist
19148 * @param obj The genlist object
19149 * @return The list of realized items, nor NULL if none are realized.
19151 * This returns a list of the realized items in the genlist. The list
19152 * contains Elm_Genlist_Item pointers. The list must be freed by the
19153 * caller when done with eina_list_free(). The item pointers in the
19154 * list are only valid so long as those items are not deleted or the
19155 * genlist is not deleted.
19157 * @see elm_genlist_realized_items_update()
19161 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19163 * Get the item that is at the x, y canvas coords.
19165 * @param obj The gelinst object.
19166 * @param x The input x coordinate
19167 * @param y The input y coordinate
19168 * @param posret The position relative to the item returned here
19169 * @return The item at the coordinates or NULL if none
19171 * This returns the item at the given coordinates (which are canvas
19172 * relative, not object-relative). If an item is at that coordinate,
19173 * that item handle is returned, and if @p posret is not NULL, the
19174 * integer pointed to is set to a value of -1, 0 or 1, depending if
19175 * the coordinate is on the upper portion of that item (-1), on the
19176 * middle section (0) or on the lower part (1). If NULL is returned as
19177 * an item (no item found there), then posret may indicate -1 or 1
19178 * based if the coordinate is above or below all items respectively in
19183 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);
19185 * Get the first item in the genlist
19187 * This returns the first item in the list.
19189 * @param obj The genlist object
19190 * @return The first item, or NULL if none
19194 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19196 * Get the last item in the genlist
19198 * This returns the last item in the list.
19200 * @return The last item, or NULL if none
19204 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19206 * Set the scrollbar policy
19208 * @param obj The genlist object
19209 * @param policy_h Horizontal scrollbar policy.
19210 * @param policy_v Vertical scrollbar policy.
19212 * This sets the scrollbar visibility policy for the given genlist
19213 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19214 * made visible if it is needed, and otherwise kept hidden.
19215 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19216 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19217 * respectively for the horizontal and vertical scrollbars. Default is
19218 * #ELM_SMART_SCROLLER_POLICY_AUTO
19220 * @see elm_genlist_scroller_policy_get()
19224 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19226 * Get the scrollbar policy
19228 * @param obj The genlist object
19229 * @param policy_h Pointer to store the horizontal scrollbar policy.
19230 * @param policy_v Pointer to store the vertical scrollbar policy.
19232 * @see elm_genlist_scroller_policy_set()
19236 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);
19238 * Get the @b next item in a genlist widget's internal list of items,
19239 * given a handle to one of those items.
19241 * @param item The genlist item to fetch next from
19242 * @return The item after @p item, or @c NULL if there's none (and
19245 * This returns the item placed after the @p item, on the container
19248 * @see elm_genlist_item_prev_get()
19252 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19254 * Get the @b previous item in a genlist widget's internal list of items,
19255 * given a handle to one of those items.
19257 * @param item The genlist item to fetch previous from
19258 * @return The item before @p item, or @c NULL if there's none (and
19261 * This returns the item placed before the @p item, on the container
19264 * @see elm_genlist_item_next_get()
19268 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19270 * Get the genlist object's handle which contains a given genlist
19273 * @param item The item to fetch the container from
19274 * @return The genlist (parent) object
19276 * This returns the genlist object itself that an item belongs to.
19280 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19282 * Get the parent item of the given item
19284 * @param it The item
19285 * @return The parent of the item or @c NULL if it has no parent.
19287 * This returns the item that was specified as parent of the item @p it on
19288 * elm_genlist_item_append() and insertion related functions.
19292 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19294 * Remove all sub-items (children) of the given item
19296 * @param it The item
19298 * This removes all items that are children (and their descendants) of the
19299 * given item @p it.
19301 * @see elm_genlist_clear()
19302 * @see elm_genlist_item_del()
19306 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19308 * Set whether a given genlist item is selected or not
19310 * @param it The item
19311 * @param selected Use @c EINA_TRUE, to make it selected, @c
19312 * EINA_FALSE to make it unselected
19314 * This sets the selected state of an item. If multi selection is
19315 * not enabled on the containing genlist and @p selected is @c
19316 * EINA_TRUE, any other previously selected items will get
19317 * unselected in favor of this new one.
19319 * @see elm_genlist_item_selected_get()
19323 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19325 * Get whether a given genlist item is selected or not
19327 * @param it The item
19328 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19330 * @see elm_genlist_item_selected_set() for more details
19334 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19336 * Sets the expanded state of an item.
19338 * @param it The item
19339 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19341 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19344 * The theme will respond to this change visually, and a signal "expanded" or
19345 * "contracted" will be sent from the genlist with a pointer to the item that
19346 * has been expanded/contracted.
19348 * Calling this function won't show or hide any child of this item (if it is
19349 * a parent). You must manually delete and create them on the callbacks fo
19350 * the "expanded" or "contracted" signals.
19352 * @see elm_genlist_item_expanded_get()
19356 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19358 * Get the expanded state of an item
19360 * @param it The item
19361 * @return The expanded state
19363 * This gets the expanded state of an item.
19365 * @see elm_genlist_item_expanded_set()
19369 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19371 * Get the depth of expanded item
19373 * @param it The genlist item object
19374 * @return The depth of expanded item
19378 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19380 * Set whether a given genlist item is disabled or not.
19382 * @param it The item
19383 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19384 * to enable it back.
19386 * A disabled item cannot be selected or unselected. It will also
19387 * change its appearance, to signal the user it's disabled.
19389 * @see elm_genlist_item_disabled_get()
19393 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19395 * Get whether a given genlist item is disabled or not.
19397 * @param it The item
19398 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19401 * @see elm_genlist_item_disabled_set() for more details
19405 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19407 * Sets the display only state of an item.
19409 * @param it The item
19410 * @param display_only @c EINA_TRUE if the item is display only, @c
19411 * EINA_FALSE otherwise.
19413 * A display only item cannot be selected or unselected. It is for
19414 * display only and not selecting or otherwise clicking, dragging
19415 * etc. by the user, thus finger size rules will not be applied to
19418 * It's good to set group index items to display only state.
19420 * @see elm_genlist_item_display_only_get()
19424 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19426 * Get the display only state of an item
19428 * @param it The item
19429 * @return @c EINA_TRUE if the item is display only, @c
19430 * EINA_FALSE otherwise.
19432 * @see elm_genlist_item_display_only_set()
19436 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19438 * Show the portion of a genlist's internal list containing a given
19439 * item, immediately.
19441 * @param it The item to display
19443 * This causes genlist to jump to the given item @p it and show it (by
19444 * immediately scrolling to that position), if it is not fully visible.
19446 * @see elm_genlist_item_bring_in()
19447 * @see elm_genlist_item_top_show()
19448 * @see elm_genlist_item_middle_show()
19452 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19454 * Animatedly bring in, to the visible are of a genlist, a given
19457 * @param it The item to display
19459 * This causes genlist to jump to the given item @p it and show it (by
19460 * animatedly scrolling), if it is not fully visible. This may use animation
19461 * to do so and take a period of time
19463 * @see elm_genlist_item_show()
19464 * @see elm_genlist_item_top_bring_in()
19465 * @see elm_genlist_item_middle_bring_in()
19469 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19471 * Show the portion of a genlist's internal list containing a given
19472 * item, immediately.
19474 * @param it The item to display
19476 * This causes genlist to jump to the given item @p it and show it (by
19477 * immediately scrolling to that position), if it is not fully visible.
19479 * The item will be positioned at the top of the genlist viewport.
19481 * @see elm_genlist_item_show()
19482 * @see elm_genlist_item_top_bring_in()
19486 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19488 * Animatedly bring in, to the visible are of a genlist, a given
19491 * @param it The item
19493 * This causes genlist to jump to the given item @p it and show it (by
19494 * animatedly scrolling), if it is not fully visible. This may use animation
19495 * to do so and take a period of time
19497 * The item will be positioned at the top of the genlist viewport.
19499 * @see elm_genlist_item_bring_in()
19500 * @see elm_genlist_item_top_show()
19504 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19506 * Show the portion of a genlist's internal list containing a given
19507 * item, immediately.
19509 * @param it The item to display
19511 * This causes genlist to jump to the given item @p it and show it (by
19512 * immediately scrolling to that position), if it is not fully visible.
19514 * The item will be positioned at the middle of the genlist viewport.
19516 * @see elm_genlist_item_show()
19517 * @see elm_genlist_item_middle_bring_in()
19521 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19523 * Animatedly bring in, to the visible are of a genlist, a given
19526 * @param it The item
19528 * This causes genlist to jump to the given item @p it and show it (by
19529 * animatedly scrolling), if it is not fully visible. This may use animation
19530 * to do so and take a period of time
19532 * The item will be positioned at the middle of the genlist viewport.
19534 * @see elm_genlist_item_bring_in()
19535 * @see elm_genlist_item_middle_show()
19539 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19541 * Remove a genlist item from the its parent, deleting it.
19543 * @param item The item to be removed.
19544 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19546 * @see elm_genlist_clear(), to remove all items in a genlist at
19551 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19553 * Return the data associated to a given genlist item
19555 * @param item The genlist item.
19556 * @return the data associated to this item.
19558 * This returns the @c data value passed on the
19559 * elm_genlist_item_append() and related item addition calls.
19561 * @see elm_genlist_item_append()
19562 * @see elm_genlist_item_data_set()
19566 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19568 * Set the data associated to a given genlist item
19570 * @param item The genlist item
19571 * @param data The new data pointer to set on it
19573 * This @b overrides the @c data value passed on the
19574 * elm_genlist_item_append() and related item addition calls. This
19575 * function @b won't call elm_genlist_item_update() automatically,
19576 * so you'd issue it afterwards if you want to hove the item
19577 * updated to reflect the that new data.
19579 * @see elm_genlist_item_data_get()
19583 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19585 * Tells genlist to "orphan" contents fetchs by the item class
19587 * @param it The item
19589 * This instructs genlist to release references to contents in the item,
19590 * meaning that they will no longer be managed by genlist and are
19591 * floating "orphans" that can be re-used elsewhere if the user wants
19596 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19597 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19599 * Get the real Evas object created to implement the view of a
19600 * given genlist item
19602 * @param item The genlist item.
19603 * @return the Evas object implementing this item's view.
19605 * This returns the actual Evas object used to implement the
19606 * specified genlist item's view. This may be @c NULL, as it may
19607 * not have been created or may have been deleted, at any time, by
19608 * the genlist. <b>Do not modify this object</b> (move, resize,
19609 * show, hide, etc.), as the genlist is controlling it. This
19610 * function is for querying, emitting custom signals or hooking
19611 * lower level callbacks for events on that object. Do not delete
19612 * this object under any circumstances.
19614 * @see elm_genlist_item_data_get()
19618 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19620 * Update the contents of an item
19622 * @param it The item
19624 * This updates an item by calling all the item class functions again
19625 * to get the contents, texts and states. Use this when the original
19626 * item data has changed and the changes are desired to be reflected.
19628 * Use elm_genlist_realized_items_update() to update all already realized
19631 * @see elm_genlist_realized_items_update()
19635 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19637 * Promote an item to the top of the list
19639 * @param it The item
19643 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19645 * Demote an item to the end of the list
19647 * @param it The item
19651 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19653 * Update the part of an item
19655 * @param it The item
19656 * @param parts The name of item's part
19657 * @param itf The flags of item's part type
19659 * This updates an item's part by calling item's fetching functions again
19660 * to get the contents, texts and states. Use this when the original
19661 * item data has changed and the changes are desired to be reflected.
19662 * Second parts argument is used for globbing to match '*', '?', and '.'
19663 * It can be used at updating multi fields.
19665 * Use elm_genlist_realized_items_update() to update an item's all
19668 * @see elm_genlist_item_update()
19672 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19674 * Update the item class of an item
19676 * @param it The item
19677 * @param itc The item class for the item
19679 * This sets another class fo the item, changing the way that it is
19680 * displayed. After changing the item class, elm_genlist_item_update() is
19681 * called on the item @p it.
19685 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19686 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19688 * Set the text to be shown in a given genlist item's tooltips.
19690 * @param item The genlist item
19691 * @param text The text to set in the content
19693 * This call will setup the text to be used as tooltip to that item
19694 * (analogous to elm_object_tooltip_text_set(), but being item
19695 * tooltips with higher precedence than object tooltips). It can
19696 * have only one tooltip at a time, so any previous tooltip data
19697 * will get removed.
19699 * In order to set a content or something else as a tooltip, look at
19700 * elm_genlist_item_tooltip_content_cb_set().
19704 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19706 * Set the content to be shown in a given genlist item's tooltips
19708 * @param item The genlist item.
19709 * @param func The function returning the tooltip contents.
19710 * @param data What to provide to @a func as callback data/context.
19711 * @param del_cb Called when data is not needed anymore, either when
19712 * another callback replaces @p func, the tooltip is unset with
19713 * elm_genlist_item_tooltip_unset() or the owner @p item
19714 * dies. This callback receives as its first parameter the
19715 * given @p data, being @c event_info the item handle.
19717 * This call will setup the tooltip's contents to @p item
19718 * (analogous to elm_object_tooltip_content_cb_set(), but being
19719 * item tooltips with higher precedence than object tooltips). It
19720 * can have only one tooltip at a time, so any previous tooltip
19721 * content will get removed. @p func (with @p data) will be called
19722 * every time Elementary needs to show the tooltip and it should
19723 * return a valid Evas object, which will be fully managed by the
19724 * tooltip system, getting deleted when the tooltip is gone.
19726 * In order to set just a text as a tooltip, look at
19727 * elm_genlist_item_tooltip_text_set().
19731 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);
19733 * Unset a tooltip from a given genlist item
19735 * @param item genlist item to remove a previously set tooltip from.
19737 * This call removes any tooltip set on @p item. The callback
19738 * provided as @c del_cb to
19739 * elm_genlist_item_tooltip_content_cb_set() will be called to
19740 * notify it is not used anymore (and have resources cleaned, if
19743 * @see elm_genlist_item_tooltip_content_cb_set()
19747 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19749 * Set a different @b style for a given genlist item's tooltip.
19751 * @param item genlist item with tooltip set
19752 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19753 * "default", @c "transparent", etc)
19755 * Tooltips can have <b>alternate styles</b> to be displayed on,
19756 * which are defined by the theme set on Elementary. This function
19757 * works analogously as elm_object_tooltip_style_set(), but here
19758 * applied only to genlist item objects. The default style for
19759 * tooltips is @c "default".
19761 * @note before you set a style you should define a tooltip with
19762 * elm_genlist_item_tooltip_content_cb_set() or
19763 * elm_genlist_item_tooltip_text_set()
19765 * @see elm_genlist_item_tooltip_style_get()
19769 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19771 * Get the style set a given genlist item's tooltip.
19773 * @param item genlist item with tooltip already set on.
19774 * @return style the theme style in use, which defaults to
19775 * "default". If the object does not have a tooltip set,
19776 * then @c NULL is returned.
19778 * @see elm_genlist_item_tooltip_style_set() for more details
19782 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19784 * @brief Disable size restrictions on an object's tooltip
19785 * @param item The tooltip's anchor object
19786 * @param disable If EINA_TRUE, size restrictions are disabled
19787 * @return EINA_FALSE on failure, EINA_TRUE on success
19789 * This function allows a tooltip to expand beyond its parant window's canvas.
19790 * It will instead be limited only by the size of the display.
19792 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19794 * @brief Retrieve size restriction state of an object's tooltip
19795 * @param item The tooltip's anchor object
19796 * @return If EINA_TRUE, size restrictions are disabled
19798 * This function returns whether a tooltip is allowed to expand beyond
19799 * its parant window's canvas.
19800 * It will instead be limited only by the size of the display.
19802 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19804 * Set the type of mouse pointer/cursor decoration to be shown,
19805 * when the mouse pointer is over the given genlist widget item
19807 * @param item genlist item to customize cursor on
19808 * @param cursor the cursor type's name
19810 * This function works analogously as elm_object_cursor_set(), but
19811 * here the cursor's changing area is restricted to the item's
19812 * area, and not the whole widget's. Note that that item cursors
19813 * have precedence over widget cursors, so that a mouse over @p
19814 * item will always show cursor @p type.
19816 * If this function is called twice for an object, a previously set
19817 * cursor will be unset on the second call.
19819 * @see elm_object_cursor_set()
19820 * @see elm_genlist_item_cursor_get()
19821 * @see elm_genlist_item_cursor_unset()
19825 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19827 * Get the type of mouse pointer/cursor decoration set to be shown,
19828 * when the mouse pointer is over the given genlist widget item
19830 * @param item genlist item with custom cursor set
19831 * @return the cursor type's name or @c NULL, if no custom cursors
19832 * were set to @p item (and on errors)
19834 * @see elm_object_cursor_get()
19835 * @see elm_genlist_item_cursor_set() for more details
19836 * @see elm_genlist_item_cursor_unset()
19840 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19842 * Unset any custom mouse pointer/cursor decoration set to be
19843 * shown, when the mouse pointer is over the given genlist widget
19844 * item, thus making it show the @b default cursor again.
19846 * @param item a genlist item
19848 * Use this call to undo any custom settings on this item's cursor
19849 * decoration, bringing it back to defaults (no custom style set).
19851 * @see elm_object_cursor_unset()
19852 * @see elm_genlist_item_cursor_set() for more details
19856 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19858 * Set a different @b style for a given custom cursor set for a
19861 * @param item genlist item with custom cursor set
19862 * @param style the <b>theme style</b> to use (e.g. @c "default",
19863 * @c "transparent", etc)
19865 * This function only makes sense when one is using custom mouse
19866 * cursor decorations <b>defined in a theme file</b> , which can
19867 * have, given a cursor name/type, <b>alternate styles</b> on
19868 * it. It works analogously as elm_object_cursor_style_set(), but
19869 * here applied only to genlist item objects.
19871 * @warning Before you set a cursor style you should have defined a
19872 * custom cursor previously on the item, with
19873 * elm_genlist_item_cursor_set()
19875 * @see elm_genlist_item_cursor_engine_only_set()
19876 * @see elm_genlist_item_cursor_style_get()
19880 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19882 * Get the current @b style set for a given genlist item's custom
19885 * @param item genlist item with custom cursor set.
19886 * @return style the cursor style in use. If the object does not
19887 * have a cursor set, then @c NULL is returned.
19889 * @see elm_genlist_item_cursor_style_set() for more details
19893 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19895 * Set if the (custom) cursor for a given genlist item should be
19896 * searched in its theme, also, or should only rely on the
19897 * rendering engine.
19899 * @param item item with custom (custom) cursor already set on
19900 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19901 * only on those provided by the rendering engine, @c EINA_FALSE to
19902 * have them searched on the widget's theme, as well.
19904 * @note This call is of use only if you've set a custom cursor
19905 * for genlist items, with elm_genlist_item_cursor_set().
19907 * @note By default, cursors will only be looked for between those
19908 * provided by the rendering engine.
19912 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19914 * Get if the (custom) cursor for a given genlist item is being
19915 * searched in its theme, also, or is only relying on the rendering
19918 * @param item a genlist item
19919 * @return @c EINA_TRUE, if cursors are being looked for only on
19920 * those provided by the rendering engine, @c EINA_FALSE if they
19921 * are being searched on the widget's theme, as well.
19923 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19927 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19929 * Update the contents of all realized items.
19931 * @param obj The genlist object.
19933 * This updates all realized items by calling all the item class functions again
19934 * to get the contents, texts and states. Use this when the original
19935 * item data has changed and the changes are desired to be reflected.
19937 * To update just one item, use elm_genlist_item_update().
19939 * @see elm_genlist_realized_items_get()
19940 * @see elm_genlist_item_update()
19944 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19946 * Activate a genlist mode on an item
19948 * @param item The genlist item
19949 * @param mode Mode name
19950 * @param mode_set Boolean to define set or unset mode.
19952 * A genlist mode is a different way of selecting an item. Once a mode is
19953 * activated on an item, any other selected item is immediately unselected.
19954 * This feature provides an easy way of implementing a new kind of animation
19955 * for selecting an item, without having to entirely rewrite the item style
19956 * theme. However, the elm_genlist_selected_* API can't be used to get what
19957 * item is activate for a mode.
19959 * The current item style will still be used, but applying a genlist mode to
19960 * an item will select it using a different kind of animation.
19962 * The current active item for a mode can be found by
19963 * elm_genlist_mode_item_get().
19965 * The characteristics of genlist mode are:
19966 * - Only one mode can be active at any time, and for only one item.
19967 * - Genlist handles deactivating other items when one item is activated.
19968 * - A mode is defined in the genlist theme (edc), and more modes can easily
19970 * - A mode style and the genlist item style are different things. They
19971 * can be combined to provide a default style to the item, with some kind
19972 * of animation for that item when the mode is activated.
19974 * When a mode is activated on an item, a new view for that item is created.
19975 * The theme of this mode defines the animation that will be used to transit
19976 * the item from the old view to the new view. This second (new) view will be
19977 * active for that item while the mode is active on the item, and will be
19978 * destroyed after the mode is totally deactivated from that item.
19980 * @see elm_genlist_mode_get()
19981 * @see elm_genlist_mode_item_get()
19985 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19987 * Get the last (or current) genlist mode used.
19989 * @param obj The genlist object
19991 * This function just returns the name of the last used genlist mode. It will
19992 * be the current mode if it's still active.
19994 * @see elm_genlist_item_mode_set()
19995 * @see elm_genlist_mode_item_get()
19999 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20001 * Get active genlist mode item
20003 * @param obj The genlist object
20004 * @return The active item for that current mode. Or @c NULL if no item is
20005 * activated with any mode.
20007 * This function returns the item that was activated with a mode, by the
20008 * function elm_genlist_item_mode_set().
20010 * @see elm_genlist_item_mode_set()
20011 * @see elm_genlist_mode_get()
20015 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20020 * @param obj The genlist object
20021 * @param reorder_mode The reorder mode
20022 * (EINA_TRUE = on, EINA_FALSE = off)
20026 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20029 * Get the reorder mode
20031 * @param obj The genlist object
20032 * @return The reorder mode
20033 * (EINA_TRUE = on, EINA_FALSE = off)
20037 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20044 * @defgroup Check Check
20046 * @image html img/widget/check/preview-00.png
20047 * @image latex img/widget/check/preview-00.eps
20048 * @image html img/widget/check/preview-01.png
20049 * @image latex img/widget/check/preview-01.eps
20050 * @image html img/widget/check/preview-02.png
20051 * @image latex img/widget/check/preview-02.eps
20053 * @brief The check widget allows for toggling a value between true and
20056 * Check objects are a lot like radio objects in layout and functionality
20057 * except they do not work as a group, but independently and only toggle the
20058 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20059 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20060 * returns the current state. For convenience, like the radio objects, you
20061 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20062 * for it to modify.
20064 * Signals that you can add callbacks for are:
20065 * "changed" - This is called whenever the user changes the state of one of
20066 * the check object(event_info is NULL).
20068 * Default contents parts of the check widget that you can use for are:
20069 * @li "icon" - An icon of the check
20071 * Default text parts of the check widget that you can use for are:
20072 * @li "elm.text" - Label of the check
20074 * @ref tutorial_check should give you a firm grasp of how to use this widget
20079 * @brief Add a new Check object
20081 * @param parent The parent object
20082 * @return The new object or NULL if it cannot be created
20084 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20086 * @brief Set the text label of the check object
20088 * @param obj The check object
20089 * @param label The text label string in UTF-8
20091 * @deprecated use elm_object_text_set() instead.
20093 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20095 * @brief Get the text label of the check object
20097 * @param obj The check object
20098 * @return The text label string in UTF-8
20100 * @deprecated use elm_object_text_get() instead.
20102 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20104 * @brief Set the icon object of the check object
20106 * @param obj The check object
20107 * @param icon The icon object
20109 * Once the icon object is set, a previously set one will be deleted.
20110 * If you want to keep that old content object, use the
20111 * elm_object_content_unset() function.
20113 * @deprecated use elm_object_part_content_set() instead.
20116 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20118 * @brief Get the icon object of the check object
20120 * @param obj The check object
20121 * @return The icon object
20123 * @deprecated use elm_object_part_content_get() instead.
20126 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20128 * @brief Unset the icon used for the check object
20130 * @param obj The check object
20131 * @return The icon object that was being used
20133 * Unparent and return the icon object which was set for this widget.
20135 * @deprecated use elm_object_part_content_unset() instead.
20138 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20140 * @brief Set the on/off state of the check object
20142 * @param obj The check object
20143 * @param state The state to use (1 == on, 0 == off)
20145 * This sets the state of the check. If set
20146 * with elm_check_state_pointer_set() the state of that variable is also
20147 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20149 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20151 * @brief Get the state of the check object
20153 * @param obj The check object
20154 * @return The boolean state
20156 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @brief Set a convenience pointer to a boolean to change
20160 * @param obj The check object
20161 * @param statep Pointer to the boolean to modify
20163 * This sets a pointer to a boolean, that, in addition to the check objects
20164 * state will also be modified directly. To stop setting the object pointed
20165 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20166 * then when this is called, the check objects state will also be modified to
20167 * reflect the value of the boolean @p statep points to, just like calling
20168 * elm_check_state_set().
20170 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20171 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20172 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);
20179 * @defgroup Radio Radio
20181 * @image html img/widget/radio/preview-00.png
20182 * @image latex img/widget/radio/preview-00.eps
20184 * @brief Radio is a widget that allows for 1 or more options to be displayed
20185 * and have the user choose only 1 of them.
20187 * A radio object contains an indicator, an optional Label and an optional
20188 * icon object. While it's possible to have a group of only one radio they,
20189 * are normally used in groups of 2 or more. To add a radio to a group use
20190 * elm_radio_group_add(). The radio object(s) will select from one of a set
20191 * of integer values, so any value they are configuring needs to be mapped to
20192 * a set of integers. To configure what value that radio object represents,
20193 * use elm_radio_state_value_set() to set the integer it represents. To set
20194 * the value the whole group(which one is currently selected) is to indicate
20195 * use elm_radio_value_set() on any group member, and to get the groups value
20196 * use elm_radio_value_get(). For convenience the radio objects are also able
20197 * to directly set an integer(int) to the value that is selected. To specify
20198 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20199 * The radio objects will modify this directly. That implies the pointer must
20200 * point to valid memory for as long as the radio objects exist.
20202 * Signals that you can add callbacks for are:
20203 * @li changed - This is called whenever the user changes the state of one of
20204 * the radio objects within the group of radio objects that work together.
20206 * Default contents parts of the radio widget that you can use for are:
20207 * @li "icon" - An icon of the radio
20209 * @ref tutorial_radio show most of this API in action.
20213 * @brief Add a new radio to the parent
20215 * @param parent The parent object
20216 * @return The new object or NULL if it cannot be created
20218 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20220 * @brief Set the text label of the radio object
20222 * @param obj The radio object
20223 * @param label The text label string in UTF-8
20225 * @deprecated use elm_object_text_set() instead.
20227 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20229 * @brief Get the text label of the radio object
20231 * @param obj The radio object
20232 * @return The text label string in UTF-8
20234 * @deprecated use elm_object_text_set() instead.
20236 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20238 * @brief Set the icon object of the radio object
20240 * @param obj The radio object
20241 * @param icon The icon object
20243 * Once the icon object is set, a previously set one will be deleted. If you
20244 * want to keep that old content object, use the elm_radio_icon_unset()
20247 * @deprecated use elm_object_part_content_set() instead.
20250 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20252 * @brief Get the icon object of the radio object
20254 * @param obj The radio object
20255 * @return The icon object
20257 * @see elm_radio_icon_set()
20259 * @deprecated use elm_object_part_content_get() instead.
20262 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20264 * @brief Unset the icon used for the radio object
20266 * @param obj The radio object
20267 * @return The icon object that was being used
20269 * Unparent and return the icon object which was set for this widget.
20271 * @see elm_radio_icon_set()
20272 * @deprecated use elm_object_part_content_unset() instead.
20275 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20277 * @brief Add this radio to a group of other radio objects
20279 * @param obj The radio object
20280 * @param group Any object whose group the @p obj is to join.
20282 * Radio objects work in groups. Each member should have a different integer
20283 * value assigned. In order to have them work as a group, they need to know
20284 * about each other. This adds the given radio object to the group of which
20285 * the group object indicated is a member.
20287 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20289 * @brief Set the integer value that this radio object represents
20291 * @param obj The radio object
20292 * @param value The value to use if this radio object is selected
20294 * This sets the value of the radio.
20296 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20298 * @brief Get the integer value that this radio object represents
20300 * @param obj The radio object
20301 * @return The value used if this radio object is selected
20303 * This gets the value of the radio.
20305 * @see elm_radio_value_set()
20307 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20309 * @brief Set the value of the radio.
20311 * @param obj The radio object
20312 * @param value The value to use for the group
20314 * This sets the value of the radio group and will also set the value if
20315 * pointed to, to the value supplied, but will not call any callbacks.
20317 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20319 * @brief Get the state of the radio object
20321 * @param obj The radio object
20322 * @return The integer state
20324 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20326 * @brief Set a convenience pointer to a integer to change
20328 * @param obj The radio object
20329 * @param valuep Pointer to the integer to modify
20331 * This sets a pointer to a integer, that, in addition to the radio objects
20332 * state will also be modified directly. To stop setting the object pointed
20333 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20334 * when this is called, the radio objects state will also be modified to
20335 * reflect the value of the integer valuep points to, just like calling
20336 * elm_radio_value_set().
20338 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20344 * @defgroup Pager Pager
20346 * @image html img/widget/pager/preview-00.png
20347 * @image latex img/widget/pager/preview-00.eps
20349 * @brief Widget that allows flipping between one or more āpagesā
20352 * The flipping between pages of objects is animated. All content
20353 * in the pager is kept in a stack, being the last content added
20354 * (visible one) on the top of that stack.
20356 * Objects can be pushed or popped from the stack or deleted as
20357 * well. Pushes and pops will animate the widget accordingly to its
20358 * style (a pop will also delete the child object once the
20359 * animation is finished). Any object already in the pager can be
20360 * promoted to the top (from its current stacking position) through
20361 * the use of elm_pager_content_promote(). New objects are pushed
20362 * to the top with elm_pager_content_push(). When the top item is
20363 * no longer wanted, simply pop it with elm_pager_content_pop() and
20364 * it will also be deleted. If an object is no longer needed and is
20365 * not the top item, just delete it as normal. You can query which
20366 * objects are the top and bottom with
20367 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20369 * Signals that you can add callbacks for are:
20370 * - @c "show,finished" - when a new page is actually shown on the top
20371 * - @c "hide,finished" - when a previous page is hidden
20373 * Only after the first of that signals the child object is
20374 * guaranteed to be visible, as in @c evas_object_visible_get().
20376 * This widget has the following styles available:
20379 * - @c "fade_translucide"
20380 * - @c "fade_invisible"
20382 * @note These styles affect only the flipping animations on the
20383 * default theme; the appearance when not animating is unaffected
20386 * @ref tutorial_pager gives a good overview of the usage of the API.
20391 * Add a new pager to the parent
20393 * @param parent The parent object
20394 * @return The new object or NULL if it cannot be created
20398 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20401 * @brief Push an object to the top of the pager stack (and show it).
20403 * @param obj The pager object
20404 * @param content The object to push
20406 * The object pushed becomes a child of the pager, it will be controlled and
20407 * deleted when the pager is deleted.
20409 * @note If the content is already in the stack use
20410 * elm_pager_content_promote().
20411 * @warning Using this function on @p content already in the stack results in
20412 * undefined behavior.
20414 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20417 * @brief Pop the object that is on top of the stack
20419 * @param obj The pager object
20421 * This pops the object that is on the top(visible) of the pager, makes it
20422 * disappear, then deletes the object. The object that was underneath it on
20423 * the stack will become visible.
20425 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20428 * @brief Moves an object already in the pager stack to the top of the stack.
20430 * @param obj The pager object
20431 * @param content The object to promote
20433 * This will take the @p content and move it to the top of the stack as
20434 * if it had been pushed there.
20436 * @note If the content isn't already in the stack use
20437 * elm_pager_content_push().
20438 * @warning Using this function on @p content not already in the stack
20439 * results in undefined behavior.
20441 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20444 * @brief Return the object at the bottom of the pager stack
20446 * @param obj The pager object
20447 * @return The bottom object or NULL if none
20449 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20452 * @brief Return the object at the top of the pager stack
20454 * @param obj The pager object
20455 * @return The top object or NULL if none
20457 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20464 * @defgroup Slideshow Slideshow
20466 * @image html img/widget/slideshow/preview-00.png
20467 * @image latex img/widget/slideshow/preview-00.eps
20469 * This widget, as the name indicates, is a pre-made image
20470 * slideshow panel, with API functions acting on (child) image
20471 * items presentation. Between those actions, are:
20472 * - advance to next/previous image
20473 * - select the style of image transition animation
20474 * - set the exhibition time for each image
20475 * - start/stop the slideshow
20477 * The transition animations are defined in the widget's theme,
20478 * consequently new animations can be added without having to
20479 * update the widget's code.
20481 * @section Slideshow_Items Slideshow items
20483 * For slideshow items, just like for @ref Genlist "genlist" ones,
20484 * the user defines a @b classes, specifying functions that will be
20485 * called on the item's creation and deletion times.
20487 * The #Elm_Slideshow_Item_Class structure contains the following
20490 * - @c func.get - When an item is displayed, this function is
20491 * called, and it's where one should create the item object, de
20492 * facto. For example, the object can be a pure Evas image object
20493 * or an Elementary @ref Photocam "photocam" widget. See
20494 * #SlideshowItemGetFunc.
20495 * - @c func.del - When an item is no more displayed, this function
20496 * is called, where the user must delete any data associated to
20497 * the item. See #SlideshowItemDelFunc.
20499 * @section Slideshow_Caching Slideshow caching
20501 * The slideshow provides facilities to have items adjacent to the
20502 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20503 * you, so that the system does not have to decode image data
20504 * anymore at the time it has to actually switch images on its
20505 * viewport. The user is able to set the numbers of items to be
20506 * cached @b before and @b after the current item, in the widget's
20509 * Smart events one can add callbacks for are:
20511 * - @c "changed" - when the slideshow switches its view to a new
20514 * List of examples for the slideshow widget:
20515 * @li @ref slideshow_example
20519 * @addtogroup Slideshow
20523 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20524 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20525 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20526 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20527 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20530 * @struct _Elm_Slideshow_Item_Class
20532 * Slideshow item class definition. See @ref Slideshow_Items for
20535 struct _Elm_Slideshow_Item_Class
20537 struct _Elm_Slideshow_Item_Class_Func
20539 SlideshowItemGetFunc get;
20540 SlideshowItemDelFunc del;
20542 }; /**< #Elm_Slideshow_Item_Class member definitions */
20545 * Add a new slideshow widget to the given parent Elementary
20546 * (container) object
20548 * @param parent The parent object
20549 * @return A new slideshow widget handle or @c NULL, on errors
20551 * This function inserts a new slideshow widget on the canvas.
20553 * @ingroup Slideshow
20555 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20558 * Add (append) a new item in a given slideshow widget.
20560 * @param obj The slideshow object
20561 * @param itc The item class for the item
20562 * @param data The item's data
20563 * @return A handle to the item added or @c NULL, on errors
20565 * Add a new item to @p obj's internal list of items, appending it.
20566 * The item's class must contain the function really fetching the
20567 * image object to show for this item, which could be an Evas image
20568 * object or an Elementary photo, for example. The @p data
20569 * parameter is going to be passed to both class functions of the
20572 * @see #Elm_Slideshow_Item_Class
20573 * @see elm_slideshow_item_sorted_insert()
20575 * @ingroup Slideshow
20577 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20580 * Insert a new item into the given slideshow widget, using the @p func
20581 * function to sort items (by item handles).
20583 * @param obj The slideshow object
20584 * @param itc The item class for the item
20585 * @param data The item's data
20586 * @param func The comparing function to be used to sort slideshow
20587 * items <b>by #Elm_Slideshow_Item item handles</b>
20588 * @return Returns The slideshow item handle, on success, or
20589 * @c NULL, on errors
20591 * Add a new item to @p obj's internal list of items, in a position
20592 * determined by the @p func comparing function. The item's class
20593 * must contain the function really fetching the image object to
20594 * show for this item, which could be an Evas image object or an
20595 * Elementary photo, for example. The @p data parameter is going to
20596 * be passed to both class functions of the item.
20598 * @see #Elm_Slideshow_Item_Class
20599 * @see elm_slideshow_item_add()
20601 * @ingroup Slideshow
20603 EAPI Elm_Slideshow_Item *elm_slideshow_item_sorted_insert(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) EINA_ARG_NONNULL(1);
20606 * Display a given slideshow widget's item, programmatically.
20608 * @param obj The slideshow object
20609 * @param item The item to display on @p obj's viewport
20611 * The change between the current item and @p item will use the
20612 * transition @p obj is set to use (@see
20613 * elm_slideshow_transition_set()).
20615 * @ingroup Slideshow
20617 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20620 * Slide to the @b next item, in a given slideshow widget
20622 * @param obj The slideshow object
20624 * The sliding animation @p obj is set to use will be the
20625 * transition effect used, after this call is issued.
20627 * @note If the end of the slideshow's internal list of items is
20628 * reached, it'll wrap around to the list's beginning, again.
20630 * @ingroup Slideshow
20632 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20635 * Slide to the @b previous item, in a given slideshow widget
20637 * @param obj The slideshow object
20639 * The sliding animation @p obj is set to use will be the
20640 * transition effect used, after this call is issued.
20642 * @note If the beginning of the slideshow's internal list of items
20643 * is reached, it'll wrap around to the list's end, again.
20645 * @ingroup Slideshow
20647 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20650 * Returns the list of sliding transition/effect names available, for a
20651 * given slideshow widget.
20653 * @param obj The slideshow object
20654 * @return The list of transitions (list of @b stringshared strings
20657 * The transitions, which come from @p obj's theme, must be an EDC
20658 * data item named @c "transitions" on the theme file, with (prefix)
20659 * names of EDC programs actually implementing them.
20661 * The available transitions for slideshows on the default theme are:
20662 * - @c "fade" - the current item fades out, while the new one
20663 * fades in to the slideshow's viewport.
20664 * - @c "black_fade" - the current item fades to black, and just
20665 * then, the new item will fade in.
20666 * - @c "horizontal" - the current item slides horizontally, until
20667 * it gets out of the slideshow's viewport, while the new item
20668 * comes from the left to take its place.
20669 * - @c "vertical" - the current item slides vertically, until it
20670 * gets out of the slideshow's viewport, while the new item comes
20671 * from the bottom to take its place.
20672 * - @c "square" - the new item starts to appear from the middle of
20673 * the current one, but with a tiny size, growing until its
20674 * target (full) size and covering the old one.
20676 * @warning The stringshared strings get no new references
20677 * exclusive to the user grabbing the list, here, so if you'd like
20678 * to use them out of this call's context, you'd better @c
20679 * eina_stringshare_ref() them.
20681 * @see elm_slideshow_transition_set()
20683 * @ingroup Slideshow
20685 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20688 * Set the current slide transition/effect in use for a given
20691 * @param obj The slideshow object
20692 * @param transition The new transition's name string
20694 * If @p transition is implemented in @p obj's theme (i.e., is
20695 * contained in the list returned by
20696 * elm_slideshow_transitions_get()), this new sliding effect will
20697 * be used on the widget.
20699 * @see elm_slideshow_transitions_get() for more details
20701 * @ingroup Slideshow
20703 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20706 * Get the current slide transition/effect in use for a given
20709 * @param obj The slideshow object
20710 * @return The current transition's name
20712 * @see elm_slideshow_transition_set() for more details
20714 * @ingroup Slideshow
20716 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20719 * Set the interval between each image transition on a given
20720 * slideshow widget, <b>and start the slideshow, itself</b>
20722 * @param obj The slideshow object
20723 * @param timeout The new displaying timeout for images
20725 * After this call, the slideshow widget will start cycling its
20726 * view, sequentially and automatically, with the images of the
20727 * items it has. The time between each new image displayed is going
20728 * to be @p timeout, in @b seconds. If a different timeout was set
20729 * previously and an slideshow was in progress, it will continue
20730 * with the new time between transitions, after this call.
20732 * @note A value less than or equal to 0 on @p timeout will disable
20733 * the widget's internal timer, thus halting any slideshow which
20734 * could be happening on @p obj.
20736 * @see elm_slideshow_timeout_get()
20738 * @ingroup Slideshow
20740 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20743 * Get the interval set for image transitions on a given slideshow
20746 * @param obj The slideshow object
20747 * @return Returns the timeout set on it
20749 * @see elm_slideshow_timeout_set() for more details
20751 * @ingroup Slideshow
20753 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20756 * Set if, after a slideshow is started, for a given slideshow
20757 * widget, its items should be displayed cyclically or not.
20759 * @param obj The slideshow object
20760 * @param loop Use @c EINA_TRUE to make it cycle through items or
20761 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20764 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20765 * ignore what is set by this functions, i.e., they'll @b always
20766 * cycle through items. This affects only the "automatic"
20767 * slideshow, as set by elm_slideshow_timeout_set().
20769 * @see elm_slideshow_loop_get()
20771 * @ingroup Slideshow
20773 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20776 * Get if, after a slideshow is started, for a given slideshow
20777 * widget, its items are to be displayed cyclically or not.
20779 * @param obj The slideshow object
20780 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20781 * through or @c EINA_FALSE, otherwise
20783 * @see elm_slideshow_loop_set() for more details
20785 * @ingroup Slideshow
20787 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20790 * Remove all items from a given slideshow widget
20792 * @param obj The slideshow object
20794 * This removes (and deletes) all items in @p obj, leaving it
20797 * @see elm_slideshow_item_del(), to remove just one item.
20799 * @ingroup Slideshow
20801 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20804 * Get the internal list of items in a given slideshow widget.
20806 * @param obj The slideshow object
20807 * @return The list of items (#Elm_Slideshow_Item as data) or
20808 * @c NULL on errors.
20810 * This list is @b not to be modified in any way and must not be
20811 * freed. Use the list members with functions like
20812 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20814 * @warning This list is only valid until @p obj object's internal
20815 * items list is changed. It should be fetched again with another
20816 * call to this function when changes happen.
20818 * @ingroup Slideshow
20820 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20823 * Delete a given item from a slideshow widget.
20825 * @param item The slideshow item
20827 * @ingroup Slideshow
20829 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20832 * Return the data associated with a given slideshow item
20834 * @param item The slideshow item
20835 * @return Returns the data associated to this item
20837 * @ingroup Slideshow
20839 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20842 * Returns the currently displayed item, in a given slideshow widget
20844 * @param obj The slideshow object
20845 * @return A handle to the item being displayed in @p obj or
20846 * @c NULL, if none is (and on errors)
20848 * @ingroup Slideshow
20850 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20853 * Get the real Evas object created to implement the view of a
20854 * given slideshow item
20856 * @param item The slideshow item.
20857 * @return the Evas object implementing this item's view.
20859 * This returns the actual Evas object used to implement the
20860 * specified slideshow item's view. This may be @c NULL, as it may
20861 * not have been created or may have been deleted, at any time, by
20862 * the slideshow. <b>Do not modify this object</b> (move, resize,
20863 * show, hide, etc.), as the slideshow is controlling it. This
20864 * function is for querying, emitting custom signals or hooking
20865 * lower level callbacks for events on that object. Do not delete
20866 * this object under any circumstances.
20868 * @see elm_slideshow_item_data_get()
20870 * @ingroup Slideshow
20872 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20875 * Get the the item, in a given slideshow widget, placed at
20876 * position @p nth, in its internal items list
20878 * @param obj The slideshow object
20879 * @param nth The number of the item to grab a handle to (0 being
20881 * @return The item stored in @p obj at position @p nth or @c NULL,
20882 * if there's no item with that index (and on errors)
20884 * @ingroup Slideshow
20886 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20889 * Set the current slide layout in use for a given slideshow widget
20891 * @param obj The slideshow object
20892 * @param layout The new layout's name string
20894 * If @p layout is implemented in @p obj's theme (i.e., is contained
20895 * in the list returned by elm_slideshow_layouts_get()), this new
20896 * images layout will be used on the widget.
20898 * @see elm_slideshow_layouts_get() for more details
20900 * @ingroup Slideshow
20902 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20905 * Get the current slide layout in use for a given slideshow widget
20907 * @param obj The slideshow object
20908 * @return The current layout's name
20910 * @see elm_slideshow_layout_set() for more details
20912 * @ingroup Slideshow
20914 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20917 * Returns the list of @b layout names available, for a given
20918 * slideshow widget.
20920 * @param obj The slideshow object
20921 * @return The list of layouts (list of @b stringshared strings
20924 * Slideshow layouts will change how the widget is to dispose each
20925 * image item in its viewport, with regard to cropping, scaling,
20928 * The layouts, which come from @p obj's theme, must be an EDC
20929 * data item name @c "layouts" on the theme file, with (prefix)
20930 * names of EDC programs actually implementing them.
20932 * The available layouts for slideshows on the default theme are:
20933 * - @c "fullscreen" - item images with original aspect, scaled to
20934 * touch top and down slideshow borders or, if the image's heigh
20935 * is not enough, left and right slideshow borders.
20936 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20937 * one, but always leaving 10% of the slideshow's dimensions of
20938 * distance between the item image's borders and the slideshow
20939 * borders, for each axis.
20941 * @warning The stringshared strings get no new references
20942 * exclusive to the user grabbing the list, here, so if you'd like
20943 * to use them out of this call's context, you'd better @c
20944 * eina_stringshare_ref() them.
20946 * @see elm_slideshow_layout_set()
20948 * @ingroup Slideshow
20950 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20953 * Set the number of items to cache, on a given slideshow widget,
20954 * <b>before the current item</b>
20956 * @param obj The slideshow object
20957 * @param count Number of items to cache before the current one
20959 * The default value for this property is @c 2. See
20960 * @ref Slideshow_Caching "slideshow caching" for more details.
20962 * @see elm_slideshow_cache_before_get()
20964 * @ingroup Slideshow
20966 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20969 * Retrieve the number of items to cache, on a given slideshow widget,
20970 * <b>before the current item</b>
20972 * @param obj The slideshow object
20973 * @return The number of items set to be cached before the current one
20975 * @see elm_slideshow_cache_before_set() for more details
20977 * @ingroup Slideshow
20979 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20982 * Set the number of items to cache, on a given slideshow widget,
20983 * <b>after the current item</b>
20985 * @param obj The slideshow object
20986 * @param count Number of items to cache after the current one
20988 * The default value for this property is @c 2. See
20989 * @ref Slideshow_Caching "slideshow caching" for more details.
20991 * @see elm_slideshow_cache_after_get()
20993 * @ingroup Slideshow
20995 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20998 * Retrieve the number of items to cache, on a given slideshow widget,
20999 * <b>after the current item</b>
21001 * @param obj The slideshow object
21002 * @return The number of items set to be cached after the current one
21004 * @see elm_slideshow_cache_after_set() for more details
21006 * @ingroup Slideshow
21008 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21011 * Get the number of items stored in a given slideshow widget
21013 * @param obj The slideshow object
21014 * @return The number of items on @p obj, at the moment of this call
21016 * @ingroup Slideshow
21018 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21025 * @defgroup Fileselector File Selector
21027 * @image html img/widget/fileselector/preview-00.png
21028 * @image latex img/widget/fileselector/preview-00.eps
21030 * A file selector is a widget that allows a user to navigate
21031 * through a file system, reporting file selections back via its
21034 * It contains shortcut buttons for home directory (@c ~) and to
21035 * jump one directory upwards (..), as well as cancel/ok buttons to
21036 * confirm/cancel a given selection. After either one of those two
21037 * former actions, the file selector will issue its @c "done" smart
21040 * There's a text entry on it, too, showing the name of the current
21041 * selection. There's the possibility of making it editable, so it
21042 * is useful on file saving dialogs on applications, where one
21043 * gives a file name to save contents to, in a given directory in
21044 * the system. This custom file name will be reported on the @c
21045 * "done" smart callback (explained in sequence).
21047 * Finally, it has a view to display file system items into in two
21052 * If Elementary is built with support of the Ethumb thumbnailing
21053 * library, the second form of view will display preview thumbnails
21054 * of files which it supports.
21056 * Smart callbacks one can register to:
21058 * - @c "selected" - the user has clicked on a file (when not in
21059 * folders-only mode) or directory (when in folders-only mode)
21060 * - @c "directory,open" - the list has been populated with new
21061 * content (@c event_info is a pointer to the directory's
21062 * path, a @b stringshared string)
21063 * - @c "done" - the user has clicked on the "ok" or "cancel"
21064 * buttons (@c event_info is a pointer to the selection's
21065 * path, a @b stringshared string)
21067 * Here is an example on its usage:
21068 * @li @ref fileselector_example
21072 * @addtogroup Fileselector
21077 * Defines how a file selector widget is to layout its contents
21078 * (file system entries).
21080 typedef enum _Elm_Fileselector_Mode
21082 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21083 ELM_FILESELECTOR_GRID, /**< layout as a grid */
21084 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21085 } Elm_Fileselector_Mode;
21088 * Add a new file selector widget to the given parent Elementary
21089 * (container) object
21091 * @param parent The parent object
21092 * @return a new file selector widget handle or @c NULL, on errors
21094 * This function inserts a new file selector widget on the canvas.
21096 * @ingroup Fileselector
21098 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21101 * Enable/disable the file name entry box where the user can type
21102 * in a name for a file, in a given file selector widget
21104 * @param obj The file selector object
21105 * @param is_save @c EINA_TRUE to make the file selector a "saving
21106 * dialog", @c EINA_FALSE otherwise
21108 * Having the entry editable is useful on file saving dialogs on
21109 * applications, where one gives a file name to save contents to,
21110 * in a given directory in the system. This custom file name will
21111 * be reported on the @c "done" smart callback.
21113 * @see elm_fileselector_is_save_get()
21115 * @ingroup Fileselector
21117 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21120 * Get whether the given file selector is in "saving dialog" mode
21122 * @param obj The file selector object
21123 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21124 * mode, @c EINA_FALSE otherwise (and on errors)
21126 * @see elm_fileselector_is_save_set() for more details
21128 * @ingroup Fileselector
21130 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21133 * Enable/disable folder-only view for a given file selector widget
21135 * @param obj The file selector object
21136 * @param only @c EINA_TRUE to make @p obj only display
21137 * directories, @c EINA_FALSE to make files to be displayed in it
21140 * If enabled, the widget's view will only display folder items,
21143 * @see elm_fileselector_folder_only_get()
21145 * @ingroup Fileselector
21147 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21150 * Get whether folder-only view is set for a given file selector
21153 * @param obj The file selector object
21154 * @return only @c EINA_TRUE if @p obj is only displaying
21155 * directories, @c EINA_FALSE if files are being displayed in it
21156 * too (and on errors)
21158 * @see elm_fileselector_folder_only_get()
21160 * @ingroup Fileselector
21162 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21165 * Enable/disable the "ok" and "cancel" buttons on a given file
21168 * @param obj The file selector object
21169 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21171 * @note A file selector without those buttons will never emit the
21172 * @c "done" smart event, and is only usable if one is just hooking
21173 * to the other two events.
21175 * @see elm_fileselector_buttons_ok_cancel_get()
21177 * @ingroup Fileselector
21179 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21182 * Get whether the "ok" and "cancel" buttons on a given file
21183 * selector widget are being shown.
21185 * @param obj The file selector object
21186 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21187 * otherwise (and on errors)
21189 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21191 * @ingroup Fileselector
21193 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21196 * Enable/disable a tree view in the given file selector widget,
21197 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21199 * @param obj The file selector object
21200 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21203 * In a tree view, arrows are created on the sides of directories,
21204 * allowing them to expand in place.
21206 * @note If it's in other mode, the changes made by this function
21207 * will only be visible when one switches back to "list" mode.
21209 * @see elm_fileselector_expandable_get()
21211 * @ingroup Fileselector
21213 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21216 * Get whether tree view is enabled for the given file selector
21219 * @param obj The file selector object
21220 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21221 * otherwise (and or errors)
21223 * @see elm_fileselector_expandable_set() for more details
21225 * @ingroup Fileselector
21227 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21230 * Set, programmatically, the @b directory that a given file
21231 * selector widget will display contents from
21233 * @param obj The file selector object
21234 * @param path The path to display in @p obj
21236 * This will change the @b directory that @p obj is displaying. It
21237 * will also clear the text entry area on the @p obj object, which
21238 * displays select files' names.
21240 * @see elm_fileselector_path_get()
21242 * @ingroup Fileselector
21244 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21247 * Get the parent directory's path that a given file selector
21248 * widget is displaying
21250 * @param obj The file selector object
21251 * @return The (full) path of the directory the file selector is
21252 * displaying, a @b stringshared string
21254 * @see elm_fileselector_path_set()
21256 * @ingroup Fileselector
21258 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21261 * Set, programmatically, the currently selected file/directory in
21262 * the given file selector widget
21264 * @param obj The file selector object
21265 * @param path The (full) path to a file or directory
21266 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21267 * latter case occurs if the directory or file pointed to do not
21270 * @see elm_fileselector_selected_get()
21272 * @ingroup Fileselector
21274 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21277 * Get the currently selected item's (full) path, in the given file
21280 * @param obj The file selector object
21281 * @return The absolute path of the selected item, a @b
21282 * stringshared string
21284 * @note Custom editions on @p obj object's text entry, if made,
21285 * will appear on the return string of this function, naturally.
21287 * @see elm_fileselector_selected_set() for more details
21289 * @ingroup Fileselector
21291 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21294 * Set the mode in which a given file selector widget will display
21295 * (layout) file system entries in its view
21297 * @param obj The file selector object
21298 * @param mode The mode of the fileselector, being it one of
21299 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21300 * first one, naturally, will display the files in a list. The
21301 * latter will make the widget to display its entries in a grid
21304 * @note By using elm_fileselector_expandable_set(), the user may
21305 * trigger a tree view for that list.
21307 * @note If Elementary is built with support of the Ethumb
21308 * thumbnailing library, the second form of view will display
21309 * preview thumbnails of files which it supports. You must have
21310 * elm_need_ethumb() called in your Elementary for thumbnailing to
21313 * @see elm_fileselector_expandable_set().
21314 * @see elm_fileselector_mode_get().
21316 * @ingroup Fileselector
21318 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21321 * Get the mode in which a given file selector widget is displaying
21322 * (layouting) file system entries in its view
21324 * @param obj The fileselector object
21325 * @return The mode in which the fileselector is at
21327 * @see elm_fileselector_mode_set() for more details
21329 * @ingroup Fileselector
21331 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21338 * @defgroup Progressbar Progress bar
21340 * The progress bar is a widget for visually representing the
21341 * progress status of a given job/task.
21343 * A progress bar may be horizontal or vertical. It may display an
21344 * icon besides it, as well as primary and @b units labels. The
21345 * former is meant to label the widget as a whole, while the
21346 * latter, which is formatted with floating point values (and thus
21347 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21348 * units"</c>), is meant to label the widget's <b>progress
21349 * value</b>. Label, icon and unit strings/objects are @b optional
21350 * for progress bars.
21352 * A progress bar may be @b inverted, in which state it gets its
21353 * values inverted, with high values being on the left or top and
21354 * low values on the right or bottom, as opposed to normally have
21355 * the low values on the former and high values on the latter,
21356 * respectively, for horizontal and vertical modes.
21358 * The @b span of the progress, as set by
21359 * elm_progressbar_span_size_set(), is its length (horizontally or
21360 * vertically), unless one puts size hints on the widget to expand
21361 * on desired directions, by any container. That length will be
21362 * scaled by the object or applications scaling factor. At any
21363 * point code can query the progress bar for its value with
21364 * elm_progressbar_value_get().
21366 * Available widget styles for progress bars:
21368 * - @c "wheel" (simple style, no text, no progression, only
21369 * "pulse" effect is available)
21371 * Default contents parts of the progressbar widget that you can use for are:
21372 * @li "icon" - An icon of the progressbar
21374 * Here is an example on its usage:
21375 * @li @ref progressbar_example
21379 * Add a new progress bar widget to the given parent Elementary
21380 * (container) object
21382 * @param parent The parent object
21383 * @return a new progress bar widget handle or @c NULL, on errors
21385 * This function inserts a new progress bar widget on the canvas.
21387 * @ingroup Progressbar
21389 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21392 * Set whether a given progress bar widget is at "pulsing mode" or
21395 * @param obj The progress bar object
21396 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21397 * @c EINA_FALSE to put it back to its default one
21399 * By default, progress bars will display values from the low to
21400 * high value boundaries. There are, though, contexts in which the
21401 * state of progression of a given task is @b unknown. For those,
21402 * one can set a progress bar widget to a "pulsing state", to give
21403 * the user an idea that some computation is being held, but
21404 * without exact progress values. In the default theme it will
21405 * animate its bar with the contents filling in constantly and back
21406 * to non-filled, in a loop. To start and stop this pulsing
21407 * animation, one has to explicitly call elm_progressbar_pulse().
21409 * @see elm_progressbar_pulse_get()
21410 * @see elm_progressbar_pulse()
21412 * @ingroup Progressbar
21414 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21417 * Get whether a given progress bar widget is at "pulsing mode" or
21420 * @param obj The progress bar object
21421 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21422 * if it's in the default one (and on errors)
21424 * @ingroup Progressbar
21426 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21429 * Start/stop a given progress bar "pulsing" animation, if its
21432 * @param obj The progress bar object
21433 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21434 * @c EINA_FALSE to @b stop it
21436 * @note This call won't do anything if @p obj is not under "pulsing mode".
21438 * @see elm_progressbar_pulse_set() for more details.
21440 * @ingroup Progressbar
21442 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21445 * Set the progress value (in percentage) on a given progress bar
21448 * @param obj The progress bar object
21449 * @param val The progress value (@b must be between @c 0.0 and @c
21452 * Use this call to set progress bar levels.
21454 * @note If you passes a value out of the specified range for @p
21455 * val, it will be interpreted as the @b closest of the @b boundary
21456 * values in the range.
21458 * @ingroup Progressbar
21460 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21463 * Get the progress value (in percentage) on a given progress bar
21466 * @param obj The progress bar object
21467 * @return The value of the progressbar
21469 * @see elm_progressbar_value_set() for more details
21471 * @ingroup Progressbar
21473 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21476 * Set the label of a given progress bar widget
21478 * @param obj The progress bar object
21479 * @param label The text label string, in UTF-8
21481 * @ingroup Progressbar
21482 * @deprecated use elm_object_text_set() instead.
21484 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21487 * Get the label of a given progress bar widget
21489 * @param obj The progressbar object
21490 * @return The text label string, in UTF-8
21492 * @ingroup Progressbar
21493 * @deprecated use elm_object_text_set() instead.
21495 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21498 * Set the icon object of a given progress bar widget
21500 * @param obj The progress bar object
21501 * @param icon The icon object
21503 * Use this call to decorate @p obj with an icon next to it.
21505 * @note Once the icon object is set, a previously set one will be
21506 * deleted. If you want to keep that old content object, use the
21507 * elm_progressbar_icon_unset() function.
21509 * @see elm_progressbar_icon_get()
21510 * @deprecated use elm_object_part_content_set() instead.
21512 * @ingroup Progressbar
21514 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21517 * Retrieve the icon object set for a given progress bar widget
21519 * @param obj The progress bar object
21520 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21521 * otherwise (and on errors)
21523 * @see elm_progressbar_icon_set() for more details
21524 * @deprecated use elm_object_part_content_get() instead.
21526 * @ingroup Progressbar
21528 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21531 * Unset an icon set on a given progress bar widget
21533 * @param obj The progress bar object
21534 * @return The icon object that was being used, if any was set, or
21535 * @c NULL, otherwise (and on errors)
21537 * This call will unparent and return the icon object which was set
21538 * for this widget, previously, on success.
21540 * @see elm_progressbar_icon_set() for more details
21541 * @deprecated use elm_object_part_content_unset() instead.
21543 * @ingroup Progressbar
21545 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21548 * Set the (exact) length of the bar region of a given progress bar
21551 * @param obj The progress bar object
21552 * @param size The length of the progress bar's bar region
21554 * This sets the minimum width (when in horizontal mode) or height
21555 * (when in vertical mode) of the actual bar area of the progress
21556 * bar @p obj. This in turn affects the object's minimum size. Use
21557 * this when you're not setting other size hints expanding on the
21558 * given direction (like weight and alignment hints) and you would
21559 * like it to have a specific size.
21561 * @note Icon, label and unit text around @p obj will require their
21562 * own space, which will make @p obj to require more the @p size,
21565 * @see elm_progressbar_span_size_get()
21567 * @ingroup Progressbar
21569 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21572 * Get the length set for the bar region of a given progress bar
21575 * @param obj The progress bar object
21576 * @return The length of the progress bar's bar region
21578 * If that size was not set previously, with
21579 * elm_progressbar_span_size_set(), this call will return @c 0.
21581 * @ingroup Progressbar
21583 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21586 * Set the format string for a given progress bar widget's units
21589 * @param obj The progress bar object
21590 * @param format The format string for @p obj's units label
21592 * If @c NULL is passed on @p format, it will make @p obj's units
21593 * area to be hidden completely. If not, it'll set the <b>format
21594 * string</b> for the units label's @b text. The units label is
21595 * provided a floating point value, so the units text is up display
21596 * at most one floating point falue. Note that the units label is
21597 * optional. Use a format string such as "%1.2f meters" for
21600 * @note The default format string for a progress bar is an integer
21601 * percentage, as in @c "%.0f %%".
21603 * @see elm_progressbar_unit_format_get()
21605 * @ingroup Progressbar
21607 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21610 * Retrieve the format string set for a given progress bar widget's
21613 * @param obj The progress bar object
21614 * @return The format set string for @p obj's units label or
21615 * @c NULL, if none was set (and on errors)
21617 * @see elm_progressbar_unit_format_set() for more details
21619 * @ingroup Progressbar
21621 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21624 * Set the orientation of a given progress bar widget
21626 * @param obj The progress bar object
21627 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21628 * @b horizontal, @c EINA_FALSE to make it @b vertical
21630 * Use this function to change how your progress bar is to be
21631 * disposed: vertically or horizontally.
21633 * @see elm_progressbar_horizontal_get()
21635 * @ingroup Progressbar
21637 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21640 * Retrieve the orientation of a given progress bar widget
21642 * @param obj The progress bar object
21643 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21644 * @c EINA_FALSE if it's @b vertical (and on errors)
21646 * @see elm_progressbar_horizontal_set() for more details
21648 * @ingroup Progressbar
21650 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21653 * Invert a given progress bar widget's displaying values order
21655 * @param obj The progress bar object
21656 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21657 * @c EINA_FALSE to bring it back to default, non-inverted values.
21659 * A progress bar may be @b inverted, in which state it gets its
21660 * values inverted, with high values being on the left or top and
21661 * low values on the right or bottom, as opposed to normally have
21662 * the low values on the former and high values on the latter,
21663 * respectively, for horizontal and vertical modes.
21665 * @see elm_progressbar_inverted_get()
21667 * @ingroup Progressbar
21669 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21672 * Get whether a given progress bar widget's displaying values are
21675 * @param obj The progress bar object
21676 * @return @c EINA_TRUE, if @p obj has inverted values,
21677 * @c EINA_FALSE otherwise (and on errors)
21679 * @see elm_progressbar_inverted_set() for more details
21681 * @ingroup Progressbar
21683 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21686 * @defgroup Separator Separator
21688 * @brief Separator is a very thin object used to separate other objects.
21690 * A separator can be vertical or horizontal.
21692 * @ref tutorial_separator is a good example of how to use a separator.
21696 * @brief Add a separator object to @p parent
21698 * @param parent The parent object
21700 * @return The separator object, or NULL upon failure
21702 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21704 * @brief Set the horizontal mode of a separator object
21706 * @param obj The separator object
21707 * @param horizontal If true, the separator is horizontal
21709 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21711 * @brief Get the horizontal mode of a separator object
21713 * @param obj The separator object
21714 * @return If true, the separator is horizontal
21716 * @see elm_separator_horizontal_set()
21718 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21724 * @defgroup Spinner Spinner
21725 * @ingroup Elementary
21727 * @image html img/widget/spinner/preview-00.png
21728 * @image latex img/widget/spinner/preview-00.eps
21730 * A spinner is a widget which allows the user to increase or decrease
21731 * numeric values using arrow buttons, or edit values directly, clicking
21732 * over it and typing the new value.
21734 * By default the spinner will not wrap and has a label
21735 * of "%.0f" (just showing the integer value of the double).
21737 * A spinner has a label that is formatted with floating
21738 * point values and thus accepts a printf-style format string, like
21739 * ā%1.2f unitsā.
21741 * It also allows specific values to be replaced by pre-defined labels.
21743 * Smart callbacks one can register to:
21745 * - "changed" - Whenever the spinner value is changed.
21746 * - "delay,changed" - A short time after the value is changed by the user.
21747 * This will be called only when the user stops dragging for a very short
21748 * period or when they release their finger/mouse, so it avoids possibly
21749 * expensive reactions to the value change.
21751 * Available styles for it:
21753 * - @c "vertical": up/down buttons at the right side and text left aligned.
21755 * Here is an example on its usage:
21756 * @ref spinner_example
21760 * @addtogroup Spinner
21765 * Add a new spinner widget to the given parent Elementary
21766 * (container) object.
21768 * @param parent The parent object.
21769 * @return a new spinner widget handle or @c NULL, on errors.
21771 * This function inserts a new spinner widget on the canvas.
21776 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21779 * Set the format string of the displayed label.
21781 * @param obj The spinner object.
21782 * @param fmt The format string for the label display.
21784 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21785 * string for the label text. The label text is provided a floating point
21786 * value, so the label text can display up to 1 floating point value.
21787 * Note that this is optional.
21789 * Use a format string such as "%1.2f meters" for example, and it will
21790 * display values like: "3.14 meters" for a value equal to 3.14159.
21792 * Default is "%0.f".
21794 * @see elm_spinner_label_format_get()
21798 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21801 * Get the label format of the spinner.
21803 * @param obj The spinner object.
21804 * @return The text label format string in UTF-8.
21806 * @see elm_spinner_label_format_set() for details.
21810 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21813 * Set the minimum and maximum values for the spinner.
21815 * @param obj The spinner object.
21816 * @param min The minimum value.
21817 * @param max The maximum value.
21819 * Define the allowed range of values to be selected by the user.
21821 * If actual value is less than @p min, it will be updated to @p min. If it
21822 * is bigger then @p max, will be updated to @p max. Actual value can be
21823 * get with elm_spinner_value_get().
21825 * By default, min is equal to 0, and max is equal to 100.
21827 * @warning Maximum must be greater than minimum.
21829 * @see elm_spinner_min_max_get()
21833 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21836 * Get the minimum and maximum values of the spinner.
21838 * @param obj The spinner object.
21839 * @param min Pointer where to store the minimum value.
21840 * @param max Pointer where to store the maximum value.
21842 * @note If only one value is needed, the other pointer can be passed
21845 * @see elm_spinner_min_max_set() for details.
21849 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21852 * Set the step used to increment or decrement the spinner value.
21854 * @param obj The spinner object.
21855 * @param step The step value.
21857 * This value will be incremented or decremented to the displayed value.
21858 * It will be incremented while the user keep right or top arrow pressed,
21859 * and will be decremented while the user keep left or bottom arrow pressed.
21861 * The interval to increment / decrement can be set with
21862 * elm_spinner_interval_set().
21864 * By default step value is equal to 1.
21866 * @see elm_spinner_step_get()
21870 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21873 * Get the step used to increment or decrement the spinner value.
21875 * @param obj The spinner object.
21876 * @return The step value.
21878 * @see elm_spinner_step_get() for more details.
21882 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21885 * Set the value the spinner displays.
21887 * @param obj The spinner object.
21888 * @param val The value to be displayed.
21890 * Value will be presented on the label following format specified with
21891 * elm_spinner_format_set().
21893 * @warning The value must to be between min and max values. This values
21894 * are set by elm_spinner_min_max_set().
21896 * @see elm_spinner_value_get().
21897 * @see elm_spinner_format_set().
21898 * @see elm_spinner_min_max_set().
21902 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21905 * Get the value displayed by the spinner.
21907 * @param obj The spinner object.
21908 * @return The value displayed.
21910 * @see elm_spinner_value_set() for details.
21914 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21917 * Set whether the spinner should wrap when it reaches its
21918 * minimum or maximum value.
21920 * @param obj The spinner object.
21921 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21924 * Disabled by default. If disabled, when the user tries to increment the
21926 * but displayed value plus step value is bigger than maximum value,
21928 * won't allow it. The same happens when the user tries to decrement it,
21929 * but the value less step is less than minimum value.
21931 * When wrap is enabled, in such situations it will allow these changes,
21932 * but will get the value that would be less than minimum and subtracts
21933 * from maximum. Or add the value that would be more than maximum to
21937 * @li min value = 10
21938 * @li max value = 50
21939 * @li step value = 20
21940 * @li displayed value = 20
21942 * When the user decrement value (using left or bottom arrow), it will
21943 * displays @c 40, because max - (min - (displayed - step)) is
21944 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21946 * @see elm_spinner_wrap_get().
21950 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21953 * Get whether the spinner should wrap when it reaches its
21954 * minimum or maximum value.
21956 * @param obj The spinner object
21957 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21958 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21960 * @see elm_spinner_wrap_set() for details.
21964 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21967 * Set whether the spinner can be directly edited by the user or not.
21969 * @param obj The spinner object.
21970 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21971 * don't allow users to edit it directly.
21973 * Spinner objects can have edition @b disabled, in which state they will
21974 * be changed only by arrows.
21975 * Useful for contexts
21976 * where you don't want your users to interact with it writting the value.
21978 * when using special values, the user can see real value instead
21979 * of special label on edition.
21981 * It's enabled by default.
21983 * @see elm_spinner_editable_get()
21987 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21990 * Get whether the spinner can be directly edited by the user or not.
21992 * @param obj The spinner object.
21993 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21994 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21996 * @see elm_spinner_editable_set() for details.
22000 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22003 * Set a special string to display in the place of the numerical value.
22005 * @param obj The spinner object.
22006 * @param value The value to be replaced.
22007 * @param label The label to be used.
22009 * It's useful for cases when a user should select an item that is
22010 * better indicated by a label than a value. For example, weekdays or months.
22014 * sp = elm_spinner_add(win);
22015 * elm_spinner_min_max_set(sp, 1, 3);
22016 * elm_spinner_special_value_add(sp, 1, "January");
22017 * elm_spinner_special_value_add(sp, 2, "February");
22018 * elm_spinner_special_value_add(sp, 3, "March");
22019 * evas_object_show(sp);
22024 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22027 * Set the interval on time updates for an user mouse button hold
22028 * on spinner widgets' arrows.
22030 * @param obj The spinner object.
22031 * @param interval The (first) interval value in seconds.
22033 * This interval value is @b decreased while the user holds the
22034 * mouse pointer either incrementing or decrementing spinner's value.
22036 * This helps the user to get to a given value distant from the
22037 * current one easier/faster, as it will start to change quicker and
22038 * quicker on mouse button holds.
22040 * The calculation for the next change interval value, starting from
22041 * the one set with this call, is the previous interval divided by
22042 * @c 1.05, so it decreases a little bit.
22044 * The default starting interval value for automatic changes is
22047 * @see elm_spinner_interval_get()
22051 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22054 * Get the interval on time updates for an user mouse button hold
22055 * on spinner widgets' arrows.
22057 * @param obj The spinner object.
22058 * @return The (first) interval value, in seconds, set on it.
22060 * @see elm_spinner_interval_set() for more details.
22064 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22071 * @defgroup Index Index
22073 * @image html img/widget/index/preview-00.png
22074 * @image latex img/widget/index/preview-00.eps
22076 * An index widget gives you an index for fast access to whichever
22077 * group of other UI items one might have. It's a list of text
22078 * items (usually letters, for alphabetically ordered access).
22080 * Index widgets are by default hidden and just appear when the
22081 * user clicks over it's reserved area in the canvas. In its
22082 * default theme, it's an area one @ref Fingers "finger" wide on
22083 * the right side of the index widget's container.
22085 * When items on the index are selected, smart callbacks get
22086 * called, so that its user can make other container objects to
22087 * show a given area or child object depending on the index item
22088 * selected. You'd probably be using an index together with @ref
22089 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22092 * Smart events one can add callbacks for are:
22093 * - @c "changed" - When the selected index item changes. @c
22094 * event_info is the selected item's data pointer.
22095 * - @c "delay,changed" - When the selected index item changes, but
22096 * after a small idling period. @c event_info is the selected
22097 * item's data pointer.
22098 * - @c "selected" - When the user releases a mouse button and
22099 * selects an item. @c event_info is the selected item's data
22101 * - @c "level,up" - when the user moves a finger from the first
22102 * level to the second level
22103 * - @c "level,down" - when the user moves a finger from the second
22104 * level to the first level
22106 * The @c "delay,changed" event is so that it'll wait a small time
22107 * before actually reporting those events and, moreover, just the
22108 * last event happening on those time frames will actually be
22111 * Here are some examples on its usage:
22112 * @li @ref index_example_01
22113 * @li @ref index_example_02
22117 * @addtogroup Index
22121 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22124 * Add a new index widget to the given parent Elementary
22125 * (container) object
22127 * @param parent The parent object
22128 * @return a new index widget handle or @c NULL, on errors
22130 * This function inserts a new index widget on the canvas.
22134 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22137 * Set whether a given index widget is or not visible,
22140 * @param obj The index object
22141 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22143 * Not to be confused with visible as in @c evas_object_show() --
22144 * visible with regard to the widget's auto hiding feature.
22146 * @see elm_index_active_get()
22150 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22153 * Get whether a given index widget is currently visible or not.
22155 * @param obj The index object
22156 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22158 * @see elm_index_active_set() for more details
22162 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22165 * Set the items level for a given index widget.
22167 * @param obj The index object.
22168 * @param level @c 0 or @c 1, the currently implemented levels.
22170 * @see elm_index_item_level_get()
22174 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22177 * Get the items level set for a given index widget.
22179 * @param obj The index object.
22180 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22182 * @see elm_index_item_level_set() for more information
22186 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22189 * Returns the last selected item's data, for a given index widget.
22191 * @param obj The index object.
22192 * @return The item @b data associated to the last selected item on
22193 * @p obj (or @c NULL, on errors).
22195 * @warning The returned value is @b not an #Elm_Index_Item item
22196 * handle, but the data associated to it (see the @c item parameter
22197 * in elm_index_item_append(), as an example).
22201 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22204 * Append a new item on a given index widget.
22206 * @param obj The index object.
22207 * @param letter Letter under which the item should be indexed
22208 * @param item The item data to set for the index's item
22210 * Despite the most common usage of the @p letter argument is for
22211 * single char strings, one could use arbitrary strings as index
22214 * @c item will be the pointer returned back on @c "changed", @c
22215 * "delay,changed" and @c "selected" smart events.
22219 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22222 * Prepend a new item on a given index widget.
22224 * @param obj The index object.
22225 * @param letter Letter under which the item should be indexed
22226 * @param item The item data to set for the index's item
22228 * Despite the most common usage of the @p letter argument is for
22229 * single char strings, one could use arbitrary strings as index
22232 * @c item will be the pointer returned back on @c "changed", @c
22233 * "delay,changed" and @c "selected" smart events.
22237 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22240 * Append a new item, on a given index widget, <b>after the item
22241 * having @p relative as data</b>.
22243 * @param obj The index object.
22244 * @param letter Letter under which the item should be indexed
22245 * @param item The item data to set for the index's item
22246 * @param relative The item data of the index item to be the
22247 * predecessor of this new one
22249 * Despite the most common usage of the @p letter argument is for
22250 * single char strings, one could use arbitrary strings as index
22253 * @c item will be the pointer returned back on @c "changed", @c
22254 * "delay,changed" and @c "selected" smart events.
22256 * @note If @p relative is @c NULL or if it's not found to be data
22257 * set on any previous item on @p obj, this function will behave as
22258 * elm_index_item_append().
22262 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22265 * Prepend a new item, on a given index widget, <b>after the item
22266 * having @p relative as data</b>.
22268 * @param obj The index object.
22269 * @param letter Letter under which the item should be indexed
22270 * @param item The item data to set for the index's item
22271 * @param relative The item data of the index item to be the
22272 * successor of this new one
22274 * Despite the most common usage of the @p letter argument is for
22275 * single char strings, one could use arbitrary strings as index
22278 * @c item will be the pointer returned back on @c "changed", @c
22279 * "delay,changed" and @c "selected" smart events.
22281 * @note If @p relative is @c NULL or if it's not found to be data
22282 * set on any previous item on @p obj, this function will behave as
22283 * elm_index_item_prepend().
22287 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22290 * Insert a new item into the given index widget, using @p cmp_func
22291 * function to sort items (by item handles).
22293 * @param obj The index object.
22294 * @param letter Letter under which the item should be indexed
22295 * @param item The item data to set for the index's item
22296 * @param cmp_func The comparing function to be used to sort index
22297 * items <b>by #Elm_Index_Item item handles</b>
22298 * @param cmp_data_func A @b fallback function to be called for the
22299 * sorting of index items <b>by item data</b>). It will be used
22300 * when @p cmp_func returns @c 0 (equality), which means an index
22301 * item with provided item data already exists. To decide which
22302 * data item should be pointed to by the index item in question, @p
22303 * cmp_data_func will be used. If @p cmp_data_func returns a
22304 * non-negative value, the previous index item data will be
22305 * replaced by the given @p item pointer. If the previous data need
22306 * to be freed, it should be done by the @p cmp_data_func function,
22307 * because all references to it will be lost. If this function is
22308 * not provided (@c NULL is given), index items will be @b
22309 * duplicated, if @p cmp_func returns @c 0.
22311 * Despite the most common usage of the @p letter argument is for
22312 * single char strings, one could use arbitrary strings as index
22315 * @c item will be the pointer returned back on @c "changed", @c
22316 * "delay,changed" and @c "selected" smart events.
22320 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);
22323 * Remove an item from a given index widget, <b>to be referenced by
22324 * it's data value</b>.
22326 * @param obj The index object
22327 * @param item The item's data pointer for the item to be removed
22330 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22331 * that callback function will be called by this one.
22333 * @warning The item to be removed from @p obj will be found via
22334 * its item data pointer, and not by an #Elm_Index_Item handle.
22338 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22341 * Find a given index widget's item, <b>using item data</b>.
22343 * @param obj The index object
22344 * @param item The item data pointed to by the desired index item
22345 * @return The index item handle, if found, or @c NULL otherwise
22349 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22352 * Removes @b all items from a given index widget.
22354 * @param obj The index object.
22356 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22357 * that callback function will be called for each item in @p obj.
22361 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22364 * Go to a given items level on a index widget
22366 * @param obj The index object
22367 * @param level The index level (one of @c 0 or @c 1)
22371 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22374 * Return the data associated with a given index widget item
22376 * @param it The index widget item handle
22377 * @return The data associated with @p it
22379 * @see elm_index_item_data_set()
22383 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22386 * Set the data associated with a given index widget item
22388 * @param it The index widget item handle
22389 * @param data The new data pointer to set to @p it
22391 * This sets new item data on @p it.
22393 * @warning The old data pointer won't be touched by this function, so
22394 * the user had better to free that old data himself/herself.
22398 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22401 * Set the function to be called when a given index widget item is freed.
22403 * @param it The item to set the callback on
22404 * @param func The function to call on the item's deletion
22406 * When called, @p func will have both @c data and @c event_info
22407 * arguments with the @p it item's data value and, naturally, the
22408 * @c obj argument with a handle to the parent index widget.
22412 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22415 * Get the letter (string) set on a given index widget item.
22417 * @param it The index item handle
22418 * @return The letter string set on @p it
22422 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22429 * @defgroup Photocam Photocam
22431 * @image html img/widget/photocam/preview-00.png
22432 * @image latex img/widget/photocam/preview-00.eps
22434 * This is a widget specifically for displaying high-resolution digital
22435 * camera photos giving speedy feedback (fast load), low memory footprint
22436 * and zooming and panning as well as fitting logic. It is entirely focused
22437 * on jpeg images, and takes advantage of properties of the jpeg format (via
22438 * evas loader features in the jpeg loader).
22440 * Signals that you can add callbacks for are:
22441 * @li "clicked" - This is called when a user has clicked the photo without
22443 * @li "press" - This is called when a user has pressed down on the photo.
22444 * @li "longpressed" - This is called when a user has pressed down on the
22445 * photo for a long time without dragging around.
22446 * @li "clicked,double" - This is called when a user has double-clicked the
22448 * @li "load" - Photo load begins.
22449 * @li "loaded" - This is called when the image file load is complete for the
22450 * first view (low resolution blurry version).
22451 * @li "load,detail" - Photo detailed data load begins.
22452 * @li "loaded,detail" - This is called when the image file load is complete
22453 * for the detailed image data (full resolution needed).
22454 * @li "zoom,start" - Zoom animation started.
22455 * @li "zoom,stop" - Zoom animation stopped.
22456 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22457 * @li "scroll" - the content has been scrolled (moved)
22458 * @li "scroll,anim,start" - scrolling animation has started
22459 * @li "scroll,anim,stop" - scrolling animation has stopped
22460 * @li "scroll,drag,start" - dragging the contents around has started
22461 * @li "scroll,drag,stop" - dragging the contents around has stopped
22463 * @ref tutorial_photocam shows the API in action.
22467 * @brief Types of zoom available.
22469 typedef enum _Elm_Photocam_Zoom_Mode
22471 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22472 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22473 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22474 ELM_PHOTOCAM_ZOOM_MODE_LAST
22475 } Elm_Photocam_Zoom_Mode;
22477 * @brief Add a new Photocam object
22479 * @param parent The parent object
22480 * @return The new object or NULL if it cannot be created
22482 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22484 * @brief Set the photo file to be shown
22486 * @param obj The photocam object
22487 * @param file The photo file
22488 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22490 * This sets (and shows) the specified file (with a relative or absolute
22491 * path) and will return a load error (same error that
22492 * evas_object_image_load_error_get() will return). The image will change and
22493 * adjust its size at this point and begin a background load process for this
22494 * photo that at some time in the future will be displayed at the full
22497 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22499 * @brief Returns the path of the current image file
22501 * @param obj The photocam object
22502 * @return Returns the path
22504 * @see elm_photocam_file_set()
22506 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22508 * @brief Set the zoom level of the photo
22510 * @param obj The photocam object
22511 * @param zoom The zoom level to set
22513 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22514 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22515 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22516 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22519 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22521 * @brief Get the zoom level of the photo
22523 * @param obj The photocam object
22524 * @return The current zoom level
22526 * This returns the current zoom level of the photocam object. Note that if
22527 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22528 * (which is the default), the zoom level may be changed at any time by the
22529 * photocam object itself to account for photo size and photocam viewpoer
22532 * @see elm_photocam_zoom_set()
22533 * @see elm_photocam_zoom_mode_set()
22535 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22537 * @brief Set the zoom mode
22539 * @param obj The photocam object
22540 * @param mode The desired mode
22542 * This sets the zoom mode to manual or one of several automatic levels.
22543 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22544 * elm_photocam_zoom_set() and will stay at that level until changed by code
22545 * or until zoom mode is changed. This is the default mode. The Automatic
22546 * modes will allow the photocam object to automatically adjust zoom mode
22547 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22548 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22549 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22550 * pixels within the frame are left unfilled.
22552 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22554 * @brief Get the zoom mode
22556 * @param obj The photocam object
22557 * @return The current zoom mode
22559 * This gets the current zoom mode of the photocam object.
22561 * @see elm_photocam_zoom_mode_set()
22563 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22565 * @brief Get the current image pixel width and height
22567 * @param obj The photocam object
22568 * @param w A pointer to the width return
22569 * @param h A pointer to the height return
22571 * This gets the current photo pixel width and height (for the original).
22572 * The size will be returned in the integers @p w and @p h that are pointed
22575 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22577 * @brief Get the area of the image that is currently shown
22580 * @param x A pointer to the X-coordinate of region
22581 * @param y A pointer to the Y-coordinate of region
22582 * @param w A pointer to the width
22583 * @param h A pointer to the height
22585 * @see elm_photocam_image_region_show()
22586 * @see elm_photocam_image_region_bring_in()
22588 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22590 * @brief Set the viewed portion of the image
22592 * @param obj The photocam object
22593 * @param x X-coordinate of region in image original pixels
22594 * @param y Y-coordinate of region in image original pixels
22595 * @param w Width of region in image original pixels
22596 * @param h Height of region in image original pixels
22598 * This shows the region of the image without using animation.
22600 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22602 * @brief Bring in the viewed portion of the image
22604 * @param obj The photocam object
22605 * @param x X-coordinate of region in image original pixels
22606 * @param y Y-coordinate of region in image original pixels
22607 * @param w Width of region in image original pixels
22608 * @param h Height of region in image original pixels
22610 * This shows the region of the image using animation.
22612 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22614 * @brief Set the paused state for photocam
22616 * @param obj The photocam object
22617 * @param paused The pause state to set
22619 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22620 * photocam. The default is off. This will stop zooming using animation on
22621 * zoom levels changes and change instantly. This will stop any existing
22622 * animations that are running.
22624 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22626 * @brief Get the paused state for photocam
22628 * @param obj The photocam object
22629 * @return The current paused state
22631 * This gets the current paused state for the photocam object.
22633 * @see elm_photocam_paused_set()
22635 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22637 * @brief Get the internal low-res image used for photocam
22639 * @param obj The photocam object
22640 * @return The internal image object handle, or NULL if none exists
22642 * This gets the internal image object inside photocam. Do not modify it. It
22643 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22644 * deleted at any time as well.
22646 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22648 * @brief Set the photocam scrolling bouncing.
22650 * @param obj The photocam object
22651 * @param h_bounce bouncing for horizontal
22652 * @param v_bounce bouncing for vertical
22654 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22656 * @brief Get the photocam scrolling bouncing.
22658 * @param obj The photocam object
22659 * @param h_bounce bouncing for horizontal
22660 * @param v_bounce bouncing for vertical
22662 * @see elm_photocam_bounce_set()
22664 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22670 * @defgroup Map Map
22671 * @ingroup Elementary
22673 * @image html img/widget/map/preview-00.png
22674 * @image latex img/widget/map/preview-00.eps
22676 * This is a widget specifically for displaying a map. It uses basically
22677 * OpenStreetMap provider http://www.openstreetmap.org/,
22678 * but custom providers can be added.
22680 * It supports some basic but yet nice features:
22681 * @li zoom and scroll
22682 * @li markers with content to be displayed when user clicks over it
22683 * @li group of markers
22686 * Smart callbacks one can listen to:
22688 * - "clicked" - This is called when a user has clicked the map without
22690 * - "press" - This is called when a user has pressed down on the map.
22691 * - "longpressed" - This is called when a user has pressed down on the map
22692 * for a long time without dragging around.
22693 * - "clicked,double" - This is called when a user has double-clicked
22695 * - "load,detail" - Map detailed data load begins.
22696 * - "loaded,detail" - This is called when all currently visible parts of
22697 * the map are loaded.
22698 * - "zoom,start" - Zoom animation started.
22699 * - "zoom,stop" - Zoom animation stopped.
22700 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22701 * - "scroll" - the content has been scrolled (moved).
22702 * - "scroll,anim,start" - scrolling animation has started.
22703 * - "scroll,anim,stop" - scrolling animation has stopped.
22704 * - "scroll,drag,start" - dragging the contents around has started.
22705 * - "scroll,drag,stop" - dragging the contents around has stopped.
22706 * - "downloaded" - This is called when all currently required map images
22708 * - "route,load" - This is called when route request begins.
22709 * - "route,loaded" - This is called when route request ends.
22710 * - "name,load" - This is called when name request begins.
22711 * - "name,loaded- This is called when name request ends.
22713 * Available style for map widget:
22716 * Available style for markers:
22721 * Available style for marker bubble:
22724 * List of examples:
22725 * @li @ref map_example_01
22726 * @li @ref map_example_02
22727 * @li @ref map_example_03
22736 * @enum _Elm_Map_Zoom_Mode
22737 * @typedef Elm_Map_Zoom_Mode
22739 * Set map's zoom behavior. It can be set to manual or automatic.
22741 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22743 * Values <b> don't </b> work as bitmask, only one can be choosen.
22745 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22746 * than the scroller view.
22748 * @see elm_map_zoom_mode_set()
22749 * @see elm_map_zoom_mode_get()
22753 typedef enum _Elm_Map_Zoom_Mode
22755 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22756 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22757 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22758 ELM_MAP_ZOOM_MODE_LAST
22759 } Elm_Map_Zoom_Mode;
22762 * @enum _Elm_Map_Route_Sources
22763 * @typedef Elm_Map_Route_Sources
22765 * Set route service to be used. By default used source is
22766 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22768 * @see elm_map_route_source_set()
22769 * @see elm_map_route_source_get()
22773 typedef enum _Elm_Map_Route_Sources
22775 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22776 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. */
22777 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22778 ELM_MAP_ROUTE_SOURCE_LAST
22779 } Elm_Map_Route_Sources;
22781 typedef enum _Elm_Map_Name_Sources
22783 ELM_MAP_NAME_SOURCE_NOMINATIM,
22784 ELM_MAP_NAME_SOURCE_LAST
22785 } Elm_Map_Name_Sources;
22788 * @enum _Elm_Map_Route_Type
22789 * @typedef Elm_Map_Route_Type
22791 * Set type of transport used on route.
22793 * @see elm_map_route_add()
22797 typedef enum _Elm_Map_Route_Type
22799 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22800 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22801 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22802 ELM_MAP_ROUTE_TYPE_LAST
22803 } Elm_Map_Route_Type;
22806 * @enum _Elm_Map_Route_Method
22807 * @typedef Elm_Map_Route_Method
22809 * Set the routing method, what should be priorized, time or distance.
22811 * @see elm_map_route_add()
22815 typedef enum _Elm_Map_Route_Method
22817 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22818 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22819 ELM_MAP_ROUTE_METHOD_LAST
22820 } Elm_Map_Route_Method;
22822 typedef enum _Elm_Map_Name_Method
22824 ELM_MAP_NAME_METHOD_SEARCH,
22825 ELM_MAP_NAME_METHOD_REVERSE,
22826 ELM_MAP_NAME_METHOD_LAST
22827 } Elm_Map_Name_Method;
22829 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(). */
22830 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(). */
22831 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(). */
22832 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(). */
22833 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22834 typedef struct _Elm_Map_Track Elm_Map_Track;
22836 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. */
22837 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22838 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22839 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22841 typedef char *(*ElmMapModuleSourceFunc) (void);
22842 typedef int (*ElmMapModuleZoomMinFunc) (void);
22843 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22844 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22845 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22846 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22847 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22848 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22849 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22852 * Add a new map widget to the given parent Elementary (container) object.
22854 * @param parent The parent object.
22855 * @return a new map widget handle or @c NULL, on errors.
22857 * This function inserts a new map widget on the canvas.
22861 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22864 * Set the zoom level of the map.
22866 * @param obj The map object.
22867 * @param zoom The zoom level to set.
22869 * This sets the zoom level.
22871 * It will respect limits defined by elm_map_source_zoom_min_set() and
22872 * elm_map_source_zoom_max_set().
22874 * By default these values are 0 (world map) and 18 (maximum zoom).
22876 * This function should be used when zoom mode is set to
22877 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22878 * with elm_map_zoom_mode_set().
22880 * @see elm_map_zoom_mode_set().
22881 * @see elm_map_zoom_get().
22885 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22888 * Get the zoom level of the map.
22890 * @param obj The map object.
22891 * @return The current zoom level.
22893 * This returns the current zoom level of the map object.
22895 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22896 * (which is the default), the zoom level may be changed at any time by the
22897 * map object itself to account for map size and map viewport size.
22899 * @see elm_map_zoom_set() for details.
22903 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22906 * Set the zoom mode used by the map object.
22908 * @param obj The map object.
22909 * @param mode The zoom mode of the map, being it one of
22910 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22911 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22913 * This sets the zoom mode to manual or one of the automatic levels.
22914 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22915 * elm_map_zoom_set() and will stay at that level until changed by code
22916 * or until zoom mode is changed. This is the default mode.
22918 * The Automatic modes will allow the map object to automatically
22919 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22920 * adjust zoom so the map fits inside the scroll frame with no pixels
22921 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22922 * ensure no pixels within the frame are left unfilled. Do not forget that
22923 * the valid sizes are 2^zoom, consequently the map may be smaller than
22924 * the scroller view.
22926 * @see elm_map_zoom_set()
22930 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22933 * Get the zoom mode used by the map object.
22935 * @param obj The map object.
22936 * @return The zoom mode of the map, being it one of
22937 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22938 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22940 * This function returns the current zoom mode used by the map object.
22942 * @see elm_map_zoom_mode_set() for more details.
22946 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22949 * Get the current coordinates of the map.
22951 * @param obj The map object.
22952 * @param lon Pointer where to store longitude.
22953 * @param lat Pointer where to store latitude.
22955 * This gets the current center coordinates of the map object. It can be
22956 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22958 * @see elm_map_geo_region_bring_in()
22959 * @see elm_map_geo_region_show()
22963 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22966 * Animatedly bring in given coordinates to the center of the map.
22968 * @param obj The map object.
22969 * @param lon Longitude to center at.
22970 * @param lat Latitude to center at.
22972 * This causes map to jump to the given @p lat and @p lon coordinates
22973 * and show it (by scrolling) in the center of the viewport, if it is not
22974 * already centered. This will use animation to do so and take a period
22975 * of time to complete.
22977 * @see elm_map_geo_region_show() for a function to avoid animation.
22978 * @see elm_map_geo_region_get()
22982 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22985 * Show the given coordinates at the center of the map, @b immediately.
22987 * @param obj The map object.
22988 * @param lon Longitude to center at.
22989 * @param lat Latitude to center at.
22991 * This causes map to @b redraw its viewport's contents to the
22992 * region contining the given @p lat and @p lon, that will be moved to the
22993 * center of the map.
22995 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22996 * @see elm_map_geo_region_get()
23000 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23003 * Pause or unpause the map.
23005 * @param obj The map object.
23006 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23009 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23012 * The default is off.
23014 * This will stop zooming using animation, changing zoom levels will
23015 * change instantly. This will stop any existing animations that are running.
23017 * @see elm_map_paused_get()
23021 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23024 * Get a value whether map is paused or not.
23026 * @param obj The map object.
23027 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23028 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23030 * This gets the current paused state for the map object.
23032 * @see elm_map_paused_set() for details.
23036 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23039 * Set to show markers during zoom level changes or not.
23041 * @param obj The map object.
23042 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23045 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23048 * The default is off.
23050 * This will stop zooming using animation, changing zoom levels will
23051 * change instantly. This will stop any existing animations that are running.
23053 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23056 * The default is off.
23058 * Enabling it will force the map to stop displaying the markers during
23059 * zoom level changes. Set to on if you have a large number of markers.
23061 * @see elm_map_paused_markers_get()
23065 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23068 * Get a value whether markers will be displayed on zoom level changes or not
23070 * @param obj The map object.
23071 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23072 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23074 * This gets the current markers paused state for the map object.
23076 * @see elm_map_paused_markers_set() for details.
23080 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23083 * Get the information of downloading status.
23085 * @param obj The map object.
23086 * @param try_num Pointer where to store number of tiles being downloaded.
23087 * @param finish_num Pointer where to store number of tiles successfully
23090 * This gets the current downloading status for the map object, the number
23091 * of tiles being downloaded and the number of tiles already downloaded.
23095 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23098 * Convert a pixel coordinate (x,y) into a geographic coordinate
23099 * (longitude, latitude).
23101 * @param obj The map object.
23102 * @param x the coordinate.
23103 * @param y the coordinate.
23104 * @param size the size in pixels of the map.
23105 * The map is a square and generally his size is : pow(2.0, zoom)*256.
23106 * @param lon Pointer where to store the longitude that correspond to x.
23107 * @param lat Pointer where to store the latitude that correspond to y.
23109 * @note Origin pixel point is the top left corner of the viewport.
23110 * Map zoom and size are taken on account.
23112 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23116 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);
23119 * Convert a geographic coordinate (longitude, latitude) into a pixel
23120 * coordinate (x, y).
23122 * @param obj The map object.
23123 * @param lon the longitude.
23124 * @param lat the latitude.
23125 * @param size the size in pixels of the map. The map is a square
23126 * and generally his size is : pow(2.0, zoom)*256.
23127 * @param x Pointer where to store the horizontal pixel coordinate that
23128 * correspond to the longitude.
23129 * @param y Pointer where to store the vertical pixel coordinate that
23130 * correspond to the latitude.
23132 * @note Origin pixel point is the top left corner of the viewport.
23133 * Map zoom and size are taken on account.
23135 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23139 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);
23142 * Convert a geographic coordinate (longitude, latitude) into a name
23145 * @param obj The map object.
23146 * @param lon the longitude.
23147 * @param lat the latitude.
23148 * @return name A #Elm_Map_Name handle for this coordinate.
23150 * To get the string for this address, elm_map_name_address_get()
23153 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23157 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23160 * Convert a name (address) into a geographic coordinate
23161 * (longitude, latitude).
23163 * @param obj The map object.
23164 * @param name The address.
23165 * @return name A #Elm_Map_Name handle for this address.
23167 * To get the longitude and latitude, elm_map_name_region_get()
23170 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23174 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23177 * Convert a pixel coordinate into a rotated pixel coordinate.
23179 * @param obj The map object.
23180 * @param x horizontal coordinate of the point to rotate.
23181 * @param y vertical coordinate of the point to rotate.
23182 * @param cx rotation's center horizontal position.
23183 * @param cy rotation's center vertical position.
23184 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23185 * @param xx Pointer where to store rotated x.
23186 * @param yy Pointer where to store rotated y.
23190 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);
23193 * Add a new marker to the map object.
23195 * @param obj The map object.
23196 * @param lon The longitude of the marker.
23197 * @param lat The latitude of the marker.
23198 * @param clas The class, to use when marker @b isn't grouped to others.
23199 * @param clas_group The class group, to use when marker is grouped to others
23200 * @param data The data passed to the callbacks.
23202 * @return The created marker or @c NULL upon failure.
23204 * A marker will be created and shown in a specific point of the map, defined
23205 * by @p lon and @p lat.
23207 * It will be displayed using style defined by @p class when this marker
23208 * is displayed alone (not grouped). A new class can be created with
23209 * elm_map_marker_class_new().
23211 * If the marker is grouped to other markers, it will be displayed with
23212 * style defined by @p class_group. Markers with the same group are grouped
23213 * if they are close. A new group class can be created with
23214 * elm_map_marker_group_class_new().
23216 * Markers created with this method can be deleted with
23217 * elm_map_marker_remove().
23219 * A marker can have associated content to be displayed by a bubble,
23220 * when a user click over it, as well as an icon. These objects will
23221 * be fetch using class' callback functions.
23223 * @see elm_map_marker_class_new()
23224 * @see elm_map_marker_group_class_new()
23225 * @see elm_map_marker_remove()
23229 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);
23232 * Set the maximum numbers of markers' content to be displayed in a group.
23234 * @param obj The map object.
23235 * @param max The maximum numbers of items displayed in a bubble.
23237 * A bubble will be displayed when the user clicks over the group,
23238 * and will place the content of markers that belong to this group
23241 * A group can have a long list of markers, consequently the creation
23242 * of the content of the bubble can be very slow.
23244 * In order to avoid this, a maximum number of items is displayed
23247 * By default this number is 30.
23249 * Marker with the same group class are grouped if they are close.
23251 * @see elm_map_marker_add()
23255 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23258 * Remove a marker from the map.
23260 * @param marker The marker to remove.
23262 * @see elm_map_marker_add()
23266 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23269 * Get the current coordinates of the marker.
23271 * @param marker marker.
23272 * @param lat Pointer where to store the marker's latitude.
23273 * @param lon Pointer where to store the marker's longitude.
23275 * These values are set when adding markers, with function
23276 * elm_map_marker_add().
23278 * @see elm_map_marker_add()
23282 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23285 * Animatedly bring in given marker to the center of the map.
23287 * @param marker The marker to center at.
23289 * This causes map to jump to the given @p marker's coordinates
23290 * and show it (by scrolling) in the center of the viewport, if it is not
23291 * already centered. This will use animation to do so and take a period
23292 * of time to complete.
23294 * @see elm_map_marker_show() for a function to avoid animation.
23295 * @see elm_map_marker_region_get()
23299 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23302 * Show the given marker at the center of the map, @b immediately.
23304 * @param marker The marker to center at.
23306 * This causes map to @b redraw its viewport's contents to the
23307 * region contining the given @p marker's coordinates, that will be
23308 * moved to the center of the map.
23310 * @see elm_map_marker_bring_in() for a function to move with animation.
23311 * @see elm_map_markers_list_show() if more than one marker need to be
23313 * @see elm_map_marker_region_get()
23317 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23320 * Move and zoom the map to display a list of markers.
23322 * @param markers A list of #Elm_Map_Marker handles.
23324 * The map will be centered on the center point of the markers in the list.
23325 * Then the map will be zoomed in order to fit the markers using the maximum
23326 * zoom which allows display of all the markers.
23328 * @warning All the markers should belong to the same map object.
23330 * @see elm_map_marker_show() to show a single marker.
23331 * @see elm_map_marker_bring_in()
23335 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23338 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23340 * @param marker The marker wich content should be returned.
23341 * @return Return the evas object if it exists, else @c NULL.
23343 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23344 * elm_map_marker_class_get_cb_set() should be used.
23346 * This content is what will be inside the bubble that will be displayed
23347 * when an user clicks over the marker.
23349 * This returns the actual Evas object used to be placed inside
23350 * the bubble. This may be @c NULL, as it may
23351 * not have been created or may have been deleted, at any time, by
23352 * the map. <b>Do not modify this object</b> (move, resize,
23353 * show, hide, etc.), as the map is controlling it. This
23354 * function is for querying, emitting custom signals or hooking
23355 * lower level callbacks for events on that object. Do not delete
23356 * this object under any circumstances.
23360 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23363 * Update the marker
23365 * @param marker The marker to be updated.
23367 * If a content is set to this marker, it will call function to delete it,
23368 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23369 * #ElmMapMarkerGetFunc.
23371 * These functions are set for the marker class with
23372 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23376 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23379 * Close all the bubbles opened by the user.
23381 * @param obj The map object.
23383 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23384 * when the user clicks on a marker.
23386 * This functions is set for the marker class with
23387 * elm_map_marker_class_get_cb_set().
23391 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23394 * Create a new group class.
23396 * @param obj The map object.
23397 * @return Returns the new group class.
23399 * Each marker must be associated to a group class. Markers in the same
23400 * group are grouped if they are close.
23402 * The group class defines the style of the marker when a marker is grouped
23403 * to others markers. When it is alone, another class will be used.
23405 * A group class will need to be provided when creating a marker with
23406 * elm_map_marker_add().
23408 * Some properties and functions can be set by class, as:
23409 * - style, with elm_map_group_class_style_set()
23410 * - data - to be associated to the group class. It can be set using
23411 * elm_map_group_class_data_set().
23412 * - min zoom to display markers, set with
23413 * elm_map_group_class_zoom_displayed_set().
23414 * - max zoom to group markers, set using
23415 * elm_map_group_class_zoom_grouped_set().
23416 * - visibility - set if markers will be visible or not, set with
23417 * elm_map_group_class_hide_set().
23418 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23419 * It can be set using elm_map_group_class_icon_cb_set().
23421 * @see elm_map_marker_add()
23422 * @see elm_map_group_class_style_set()
23423 * @see elm_map_group_class_data_set()
23424 * @see elm_map_group_class_zoom_displayed_set()
23425 * @see elm_map_group_class_zoom_grouped_set()
23426 * @see elm_map_group_class_hide_set()
23427 * @see elm_map_group_class_icon_cb_set()
23431 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23434 * Set the marker's style of a group class.
23436 * @param clas The group class.
23437 * @param style The style to be used by markers.
23439 * Each marker must be associated to a group class, and will use the style
23440 * defined by such class when grouped to other markers.
23442 * The following styles are provided by default theme:
23443 * @li @c radio - blue circle
23444 * @li @c radio2 - green circle
23447 * @see elm_map_group_class_new() for more details.
23448 * @see elm_map_marker_add()
23452 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23455 * Set the icon callback function of a group class.
23457 * @param clas The group class.
23458 * @param icon_get The callback function that will return the icon.
23460 * Each marker must be associated to a group class, and it can display a
23461 * custom icon. The function @p icon_get must return this icon.
23463 * @see elm_map_group_class_new() for more details.
23464 * @see elm_map_marker_add()
23468 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23471 * Set the data associated to the group class.
23473 * @param clas The group class.
23474 * @param data The new user data.
23476 * This data will be passed for callback functions, like icon get callback,
23477 * that can be set with elm_map_group_class_icon_cb_set().
23479 * If a data was previously set, the object will lose the pointer for it,
23480 * so if needs to be freed, you must do it yourself.
23482 * @see elm_map_group_class_new() for more details.
23483 * @see elm_map_group_class_icon_cb_set()
23484 * @see elm_map_marker_add()
23488 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23491 * Set the minimum zoom from where the markers are displayed.
23493 * @param clas The group class.
23494 * @param zoom The minimum zoom.
23496 * Markers only will be displayed when the map is displayed at @p zoom
23499 * @see elm_map_group_class_new() for more details.
23500 * @see elm_map_marker_add()
23504 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23507 * Set the zoom from where the markers are no more grouped.
23509 * @param clas The group class.
23510 * @param zoom The maximum zoom.
23512 * Markers only will be grouped when the map is displayed at
23513 * less than @p zoom.
23515 * @see elm_map_group_class_new() for more details.
23516 * @see elm_map_marker_add()
23520 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23523 * Set if the markers associated to the group class @clas are hidden or not.
23525 * @param clas The group class.
23526 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23529 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23534 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23537 * Create a new marker class.
23539 * @param obj The map object.
23540 * @return Returns the new group class.
23542 * Each marker must be associated to a class.
23544 * The marker class defines the style of the marker when a marker is
23545 * displayed alone, i.e., not grouped to to others markers. When grouped
23546 * it will use group class style.
23548 * A marker class will need to be provided when creating a marker with
23549 * elm_map_marker_add().
23551 * Some properties and functions can be set by class, as:
23552 * - style, with elm_map_marker_class_style_set()
23553 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23554 * It can be set using elm_map_marker_class_icon_cb_set().
23555 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23556 * Set using elm_map_marker_class_get_cb_set().
23557 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23558 * Set using elm_map_marker_class_del_cb_set().
23560 * @see elm_map_marker_add()
23561 * @see elm_map_marker_class_style_set()
23562 * @see elm_map_marker_class_icon_cb_set()
23563 * @see elm_map_marker_class_get_cb_set()
23564 * @see elm_map_marker_class_del_cb_set()
23568 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23571 * Set the marker's style of a marker class.
23573 * @param clas The marker class.
23574 * @param style The style to be used by markers.
23576 * Each marker must be associated to a marker class, and will use the style
23577 * defined by such class when alone, i.e., @b not grouped to other markers.
23579 * The following styles are provided by default theme:
23584 * @see elm_map_marker_class_new() for more details.
23585 * @see elm_map_marker_add()
23589 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23592 * Set the icon callback function of a marker class.
23594 * @param clas The marker class.
23595 * @param icon_get The callback function that will return the icon.
23597 * Each marker must be associated to a marker class, and it can display a
23598 * custom icon. The function @p icon_get must return this icon.
23600 * @see elm_map_marker_class_new() for more details.
23601 * @see elm_map_marker_add()
23605 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23608 * Set the bubble content callback function of a marker class.
23610 * @param clas The marker class.
23611 * @param get The callback function that will return the content.
23613 * Each marker must be associated to a marker class, and it can display a
23614 * a content on a bubble that opens when the user click over the marker.
23615 * The function @p get must return this content object.
23617 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23620 * @see elm_map_marker_class_new() for more details.
23621 * @see elm_map_marker_class_del_cb_set()
23622 * @see elm_map_marker_add()
23626 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23629 * Set the callback function used to delete bubble content of a marker class.
23631 * @param clas The marker class.
23632 * @param del The callback function that will delete the content.
23634 * Each marker must be associated to a marker class, and it can display a
23635 * a content on a bubble that opens when the user click over the marker.
23636 * The function to return such content can be set with
23637 * elm_map_marker_class_get_cb_set().
23639 * If this content must be freed, a callback function need to be
23640 * set for that task with this function.
23642 * If this callback is defined it will have to delete (or not) the
23643 * object inside, but if the callback is not defined the object will be
23644 * destroyed with evas_object_del().
23646 * @see elm_map_marker_class_new() for more details.
23647 * @see elm_map_marker_class_get_cb_set()
23648 * @see elm_map_marker_add()
23652 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23655 * Get the list of available sources.
23657 * @param obj The map object.
23658 * @return The source names list.
23660 * It will provide a list with all available sources, that can be set as
23661 * current source with elm_map_source_name_set(), or get with
23662 * elm_map_source_name_get().
23664 * Available sources:
23670 * @see elm_map_source_name_set() for more details.
23671 * @see elm_map_source_name_get()
23675 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23678 * Set the source of the map.
23680 * @param obj The map object.
23681 * @param source The source to be used.
23683 * Map widget retrieves images that composes the map from a web service.
23684 * This web service can be set with this method.
23686 * A different service can return a different maps with different
23687 * information and it can use different zoom values.
23689 * The @p source_name need to match one of the names provided by
23690 * elm_map_source_names_get().
23692 * The current source can be get using elm_map_source_name_get().
23694 * @see elm_map_source_names_get()
23695 * @see elm_map_source_name_get()
23700 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23703 * Get the name of currently used source.
23705 * @param obj The map object.
23706 * @return Returns the name of the source in use.
23708 * @see elm_map_source_name_set() for more details.
23712 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23715 * Set the source of the route service to be used by the map.
23717 * @param obj The map object.
23718 * @param source The route service to be used, being it one of
23719 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23720 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23722 * Each one has its own algorithm, so the route retrieved may
23723 * differ depending on the source route. Now, only the default is working.
23725 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23726 * http://www.yournavigation.org/.
23728 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23729 * assumptions. Its routing core is based on Contraction Hierarchies.
23731 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23733 * @see elm_map_route_source_get().
23737 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23740 * Get the current route source.
23742 * @param obj The map object.
23743 * @return The source of the route service used by the map.
23745 * @see elm_map_route_source_set() for details.
23749 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23752 * Set the minimum zoom of the source.
23754 * @param obj The map object.
23755 * @param zoom New minimum zoom value to be used.
23757 * By default, it's 0.
23761 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23764 * Get the minimum zoom of the source.
23766 * @param obj The map object.
23767 * @return Returns the minimum zoom of the source.
23769 * @see elm_map_source_zoom_min_set() for details.
23773 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23776 * Set the maximum zoom of the source.
23778 * @param obj The map object.
23779 * @param zoom New maximum zoom value to be used.
23781 * By default, it's 18.
23785 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23788 * Get the maximum zoom of the source.
23790 * @param obj The map object.
23791 * @return Returns the maximum zoom of the source.
23793 * @see elm_map_source_zoom_min_set() for details.
23797 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23800 * Set the user agent used by the map object to access routing services.
23802 * @param obj The map object.
23803 * @param user_agent The user agent to be used by the map.
23805 * User agent is a client application implementing a network protocol used
23806 * in communications within a clientāserver distributed computing system
23808 * The @p user_agent identification string will transmitted in a header
23809 * field @c User-Agent.
23811 * @see elm_map_user_agent_get()
23815 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23818 * Get the user agent used by the map object.
23820 * @param obj The map object.
23821 * @return The user agent identification string used by the map.
23823 * @see elm_map_user_agent_set() for details.
23827 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23830 * Add a new route to the map object.
23832 * @param obj The map object.
23833 * @param type The type of transport to be considered when tracing a route.
23834 * @param method The routing method, what should be priorized.
23835 * @param flon The start longitude.
23836 * @param flat The start latitude.
23837 * @param tlon The destination longitude.
23838 * @param tlat The destination latitude.
23840 * @return The created route or @c NULL upon failure.
23842 * A route will be traced by point on coordinates (@p flat, @p flon)
23843 * to point on coordinates (@p tlat, @p tlon), using the route service
23844 * set with elm_map_route_source_set().
23846 * It will take @p type on consideration to define the route,
23847 * depending if the user will be walking or driving, the route may vary.
23848 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23849 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23851 * Another parameter is what the route should priorize, the minor distance
23852 * or the less time to be spend on the route. So @p method should be one
23853 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23855 * Routes created with this method can be deleted with
23856 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23857 * and distance can be get with elm_map_route_distance_get().
23859 * @see elm_map_route_remove()
23860 * @see elm_map_route_color_set()
23861 * @see elm_map_route_distance_get()
23862 * @see elm_map_route_source_set()
23866 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);
23869 * Remove a route from the map.
23871 * @param route The route to remove.
23873 * @see elm_map_route_add()
23877 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23880 * Set the route color.
23882 * @param route The route object.
23883 * @param r Red channel value, from 0 to 255.
23884 * @param g Green channel value, from 0 to 255.
23885 * @param b Blue channel value, from 0 to 255.
23886 * @param a Alpha channel value, from 0 to 255.
23888 * It uses an additive color model, so each color channel represents
23889 * how much of each primary colors must to be used. 0 represents
23890 * ausence of this color, so if all of the three are set to 0,
23891 * the color will be black.
23893 * These component values should be integers in the range 0 to 255,
23894 * (single 8-bit byte).
23896 * This sets the color used for the route. By default, it is set to
23897 * solid red (r = 255, g = 0, b = 0, a = 255).
23899 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23901 * @see elm_map_route_color_get()
23905 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23908 * Get the route color.
23910 * @param route The route object.
23911 * @param r Pointer where to store the red channel value.
23912 * @param g Pointer where to store the green channel value.
23913 * @param b Pointer where to store the blue channel value.
23914 * @param a Pointer where to store the alpha channel value.
23916 * @see elm_map_route_color_set() for details.
23920 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23923 * Get the route distance in kilometers.
23925 * @param route The route object.
23926 * @return The distance of route (unit : km).
23930 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23933 * Get the information of route nodes.
23935 * @param route The route object.
23936 * @return Returns a string with the nodes of route.
23940 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23943 * Get the information of route waypoint.
23945 * @param route the route object.
23946 * @return Returns a string with information about waypoint of route.
23950 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23953 * Get the address of the name.
23955 * @param name The name handle.
23956 * @return Returns the address string of @p name.
23958 * This gets the coordinates of the @p name, created with one of the
23959 * conversion functions.
23961 * @see elm_map_utils_convert_name_into_coord()
23962 * @see elm_map_utils_convert_coord_into_name()
23966 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23969 * Get the current coordinates of the name.
23971 * @param name The name handle.
23972 * @param lat Pointer where to store the latitude.
23973 * @param lon Pointer where to store The longitude.
23975 * This gets the coordinates of the @p name, created with one of the
23976 * conversion functions.
23978 * @see elm_map_utils_convert_name_into_coord()
23979 * @see elm_map_utils_convert_coord_into_name()
23983 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23986 * Remove a name from the map.
23988 * @param name The name to remove.
23990 * Basically the struct handled by @p name will be freed, so convertions
23991 * between address and coordinates will be lost.
23993 * @see elm_map_utils_convert_name_into_coord()
23994 * @see elm_map_utils_convert_coord_into_name()
23998 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24003 * @param obj The map object.
24004 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
24005 * @param cx Rotation's center horizontal position.
24006 * @param cy Rotation's center vertical position.
24008 * @see elm_map_rotate_get()
24012 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24015 * Get the rotate degree of the map
24017 * @param obj The map object
24018 * @param degree Pointer where to store degrees from 0.0 to 360.0
24019 * to rotate arount Z axis.
24020 * @param cx Pointer where to store rotation's center horizontal position.
24021 * @param cy Pointer where to store rotation's center vertical position.
24023 * @see elm_map_rotate_set() to set map rotation.
24027 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);
24030 * Enable or disable mouse wheel to be used to zoom in / out the map.
24032 * @param obj The map object.
24033 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24036 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24038 * It's disabled by default.
24040 * @see elm_map_wheel_disabled_get()
24044 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24047 * Get a value whether mouse wheel is enabled or not.
24049 * @param obj The map object.
24050 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24051 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24053 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24055 * @see elm_map_wheel_disabled_set() for details.
24059 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24063 * Add a track on the map
24065 * @param obj The map object.
24066 * @param emap The emap route object.
24067 * @return The route object. This is an elm object of type Route.
24069 * @see elm_route_add() for details.
24073 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24077 * Remove a track from the map
24079 * @param obj The map object.
24080 * @param route The track to remove.
24084 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24091 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24093 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24095 EAPI double elm_route_lon_min_get(Evas_Object *obj);
24096 EAPI double elm_route_lat_min_get(Evas_Object *obj);
24097 EAPI double elm_route_lon_max_get(Evas_Object *obj);
24098 EAPI double elm_route_lat_max_get(Evas_Object *obj);
24102 * @defgroup Panel Panel
24104 * @image html img/widget/panel/preview-00.png
24105 * @image latex img/widget/panel/preview-00.eps
24107 * @brief A panel is a type of animated container that contains subobjects.
24108 * It can be expanded or contracted by clicking the button on it's edge.
24110 * Orientations are as follows:
24111 * @li ELM_PANEL_ORIENT_TOP
24112 * @li ELM_PANEL_ORIENT_LEFT
24113 * @li ELM_PANEL_ORIENT_RIGHT
24115 * Default contents parts of the panel widget that you can use for are:
24116 * @li "default" - A content of the panel
24118 * @ref tutorial_panel shows one way to use this widget.
24121 typedef enum _Elm_Panel_Orient
24123 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24124 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24125 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24126 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24127 } Elm_Panel_Orient;
24129 * @brief Adds a panel object
24131 * @param parent The parent object
24133 * @return The panel object, or NULL on failure
24135 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24137 * @brief Sets the orientation of the panel
24139 * @param parent The parent object
24140 * @param orient The panel orientation. Can be one of the following:
24141 * @li ELM_PANEL_ORIENT_TOP
24142 * @li ELM_PANEL_ORIENT_LEFT
24143 * @li ELM_PANEL_ORIENT_RIGHT
24145 * Sets from where the panel will (dis)appear.
24147 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24149 * @brief Get the orientation of the panel.
24151 * @param obj The panel object
24152 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24154 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24156 * @brief Set the content of the panel.
24158 * @param obj The panel object
24159 * @param content The panel content
24161 * Once the content object is set, a previously set one will be deleted.
24162 * If you want to keep that old content object, use the
24163 * elm_panel_content_unset() function.
24165 * @deprecated use elm_object_content_set() instead
24168 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24170 * @brief Get the content of the panel.
24172 * @param obj The panel object
24173 * @return The content that is being used
24175 * Return the content object which is set for this widget.
24177 * @see elm_panel_content_set()
24179 * @deprecated use elm_object_content_get() instead
24182 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24184 * @brief Unset the content of the panel.
24186 * @param obj The panel object
24187 * @return The content that was being used
24189 * Unparent and return the content object which was set for this widget.
24191 * @see elm_panel_content_set()
24193 * @deprecated use elm_object_content_unset() instead
24196 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24198 * @brief Set the state of the panel.
24200 * @param obj The panel object
24201 * @param hidden If true, the panel will run the animation to contract
24203 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24205 * @brief Get the state of the panel.
24207 * @param obj The panel object
24208 * @param hidden If true, the panel is in the "hide" state
24210 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24212 * @brief Toggle the hidden state of the panel from code
24214 * @param obj The panel object
24216 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24222 * @defgroup Panes Panes
24223 * @ingroup Elementary
24225 * @image html img/widget/panes/preview-00.png
24226 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24228 * @image html img/panes.png
24229 * @image latex img/panes.eps width=\textwidth
24231 * The panes adds a dragable bar between two contents. When dragged
24232 * this bar will resize contents size.
24234 * Panes can be displayed vertically or horizontally, and contents
24235 * size proportion can be customized (homogeneous by default).
24237 * Smart callbacks one can listen to:
24238 * - "press" - The panes has been pressed (button wasn't released yet).
24239 * - "unpressed" - The panes was released after being pressed.
24240 * - "clicked" - The panes has been clicked>
24241 * - "clicked,double" - The panes has been double clicked
24243 * Available styles for it:
24246 * Default contents parts of the panes widget that you can use for are:
24247 * @li "left" - A leftside content of the panes
24248 * @li "right" - A rightside content of the panes
24250 * If panes is displayed vertically, left content will be displayed at
24253 * Here is an example on its usage:
24254 * @li @ref panes_example
24258 * @addtogroup Panes
24263 * Add a new panes widget to the given parent Elementary
24264 * (container) object.
24266 * @param parent The parent object.
24267 * @return a new panes widget handle or @c NULL, on errors.
24269 * This function inserts a new panes widget on the canvas.
24273 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24276 * Set the left content of the panes widget.
24278 * @param obj The panes object.
24279 * @param content The new left content object.
24281 * Once the content object is set, a previously set one will be deleted.
24282 * If you want to keep that old content object, use the
24283 * elm_panes_content_left_unset() function.
24285 * If panes is displayed vertically, left content will be displayed at
24288 * @see elm_panes_content_left_get()
24289 * @see elm_panes_content_right_set() to set content on the other side.
24291 * @deprecated use elm_object_part_content_set() instead
24295 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24298 * Set the right content of the panes widget.
24300 * @param obj The panes object.
24301 * @param content The new right content object.
24303 * Once the content object is set, a previously set one will be deleted.
24304 * If you want to keep that old content object, use the
24305 * elm_panes_content_right_unset() function.
24307 * If panes is displayed vertically, left content will be displayed at
24310 * @see elm_panes_content_right_get()
24311 * @see elm_panes_content_left_set() to set content on the other side.
24313 * @deprecated use elm_object_part_content_set() instead
24317 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24320 * Get the left content of the panes.
24322 * @param obj The panes object.
24323 * @return The left content object that is being used.
24325 * Return the left content object which is set for this widget.
24327 * @see elm_panes_content_left_set() for details.
24329 * @deprecated use elm_object_part_content_get() instead
24333 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24336 * Get the right content of the panes.
24338 * @param obj The panes object
24339 * @return The right content object that is being used
24341 * Return the right content object which is set for this widget.
24343 * @see elm_panes_content_right_set() for details.
24345 * @deprecated use elm_object_part_content_get() instead
24349 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24352 * Unset the left content used for the panes.
24354 * @param obj The panes object.
24355 * @return The left content object that was being used.
24357 * Unparent and return the left content object which was set for this widget.
24359 * @see elm_panes_content_left_set() for details.
24360 * @see elm_panes_content_left_get().
24362 * @deprecated use elm_object_part_content_unset() instead
24366 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24369 * Unset the right content used for the panes.
24371 * @param obj The panes object.
24372 * @return The right content object that was being used.
24374 * Unparent and return the right content object which was set for this
24377 * @see elm_panes_content_right_set() for details.
24378 * @see elm_panes_content_right_get().
24380 * @deprecated use elm_object_part_content_unset() instead
24384 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24387 * Get the size proportion of panes widget's left side.
24389 * @param obj The panes object.
24390 * @return float value between 0.0 and 1.0 representing size proportion
24393 * @see elm_panes_content_left_size_set() for more details.
24397 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24400 * Set the size proportion of panes widget's left side.
24402 * @param obj The panes object.
24403 * @param size Value between 0.0 and 1.0 representing size proportion
24406 * By default it's homogeneous, i.e., both sides have the same size.
24408 * If something different is required, it can be set with this function.
24409 * For example, if the left content should be displayed over
24410 * 75% of the panes size, @p size should be passed as @c 0.75.
24411 * This way, right content will be resized to 25% of panes size.
24413 * If displayed vertically, left content is displayed at top, and
24414 * right content at bottom.
24416 * @note This proportion will change when user drags the panes bar.
24418 * @see elm_panes_content_left_size_get()
24422 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24425 * Set the orientation of a given panes widget.
24427 * @param obj The panes object.
24428 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24429 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24431 * Use this function to change how your panes is to be
24432 * disposed: vertically or horizontally.
24434 * By default it's displayed horizontally.
24436 * @see elm_panes_horizontal_get()
24440 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24443 * Retrieve the orientation of a given panes widget.
24445 * @param obj The panes object.
24446 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24447 * @c EINA_FALSE if it's @b vertical (and on errors).
24449 * @see elm_panes_horizontal_set() for more details.
24453 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24454 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24455 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24462 * @defgroup Flip Flip
24464 * @image html img/widget/flip/preview-00.png
24465 * @image latex img/widget/flip/preview-00.eps
24467 * This widget holds 2 content objects(Evas_Object): one on the front and one
24468 * on the back. It allows you to flip from front to back and vice-versa using
24469 * various animations.
24471 * If either the front or back contents are not set the flip will treat that
24472 * as transparent. So if you wore to set the front content but not the back,
24473 * and then call elm_flip_go() you would see whatever is below the flip.
24475 * For a list of supported animations see elm_flip_go().
24477 * Signals that you can add callbacks for are:
24478 * "animate,begin" - when a flip animation was started
24479 * "animate,done" - when a flip animation is finished
24481 * @ref tutorial_flip show how to use most of the API.
24485 typedef enum _Elm_Flip_Mode
24487 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24488 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24489 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24490 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24491 ELM_FLIP_CUBE_LEFT,
24492 ELM_FLIP_CUBE_RIGHT,
24494 ELM_FLIP_CUBE_DOWN,
24495 ELM_FLIP_PAGE_LEFT,
24496 ELM_FLIP_PAGE_RIGHT,
24500 typedef enum _Elm_Flip_Interaction
24502 ELM_FLIP_INTERACTION_NONE,
24503 ELM_FLIP_INTERACTION_ROTATE,
24504 ELM_FLIP_INTERACTION_CUBE,
24505 ELM_FLIP_INTERACTION_PAGE
24506 } Elm_Flip_Interaction;
24507 typedef enum _Elm_Flip_Direction
24509 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24510 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24511 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24512 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24513 } Elm_Flip_Direction;
24515 * @brief Add a new flip to the parent
24517 * @param parent The parent object
24518 * @return The new object or NULL if it cannot be created
24520 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24522 * @brief Set the front content of the flip widget.
24524 * @param obj The flip object
24525 * @param content The new front content object
24527 * Once the content object is set, a previously set one will be deleted.
24528 * If you want to keep that old content object, use the
24529 * elm_flip_content_front_unset() function.
24531 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24533 * @brief Set the back content of the flip widget.
24535 * @param obj The flip object
24536 * @param content The new back content object
24538 * Once the content object is set, a previously set one will be deleted.
24539 * If you want to keep that old content object, use the
24540 * elm_flip_content_back_unset() function.
24542 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24544 * @brief Get the front content used for the flip
24546 * @param obj The flip object
24547 * @return The front content object that is being used
24549 * Return the front content object which is set for this widget.
24551 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24553 * @brief Get the back content used for the flip
24555 * @param obj The flip object
24556 * @return The back content object that is being used
24558 * Return the back content object which is set for this widget.
24560 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24562 * @brief Unset the front content used for the flip
24564 * @param obj The flip object
24565 * @return The front content object that was being used
24567 * Unparent and return the front content object which was set for this widget.
24569 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24571 * @brief Unset the back content used for the flip
24573 * @param obj The flip object
24574 * @return The back content object that was being used
24576 * Unparent and return the back content object which was set for this widget.
24578 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24580 * @brief Get flip front visibility state
24582 * @param obj The flip objct
24583 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24586 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24588 * @brief Set flip perspective
24590 * @param obj The flip object
24591 * @param foc The coordinate to set the focus on
24592 * @param x The X coordinate
24593 * @param y The Y coordinate
24595 * @warning This function currently does nothing.
24597 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24599 * @brief Runs the flip animation
24601 * @param obj The flip object
24602 * @param mode The mode type
24604 * Flips the front and back contents using the @p mode animation. This
24605 * efectively hides the currently visible content and shows the hidden one.
24607 * There a number of possible animations to use for the flipping:
24608 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24609 * around a horizontal axis in the middle of its height, the other content
24610 * is shown as the other side of the flip.
24611 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24612 * around a vertical axis in the middle of its width, the other content is
24613 * shown as the other side of the flip.
24614 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24615 * around a diagonal axis in the middle of its width, the other content is
24616 * shown as the other side of the flip.
24617 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24618 * around a diagonal axis in the middle of its height, the other content is
24619 * shown as the other side of the flip.
24620 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24621 * as if the flip was a cube, the other content is show as the right face of
24623 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24624 * right as if the flip was a cube, the other content is show as the left
24625 * face of the cube.
24626 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24627 * flip was a cube, the other content is show as the bottom face of the cube.
24628 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24629 * the flip was a cube, the other content is show as the upper face of the
24631 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24632 * if the flip was a book, the other content is shown as the page below that.
24633 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24634 * as if the flip was a book, the other content is shown as the page below
24636 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24637 * flip was a book, the other content is shown as the page below that.
24638 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24639 * flip was a book, the other content is shown as the page below that.
24641 * @image html elm_flip.png
24642 * @image latex elm_flip.eps width=\textwidth
24644 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24646 * @brief Set the interactive flip mode
24648 * @param obj The flip object
24649 * @param mode The interactive flip mode to use
24651 * This sets if the flip should be interactive (allow user to click and
24652 * drag a side of the flip to reveal the back page and cause it to flip).
24653 * By default a flip is not interactive. You may also need to set which
24654 * sides of the flip are "active" for flipping and how much space they use
24655 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24656 * and elm_flip_interacton_direction_hitsize_set()
24658 * The four avilable mode of interaction are:
24659 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24660 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24661 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24662 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24664 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24665 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24666 * happen, those can only be acheived with elm_flip_go();
24668 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24670 * @brief Get the interactive flip mode
24672 * @param obj The flip object
24673 * @return The interactive flip mode
24675 * Returns the interactive flip mode set by elm_flip_interaction_set()
24677 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24679 * @brief Set which directions of the flip respond to interactive flip
24681 * @param obj The flip object
24682 * @param dir The direction to change
24683 * @param enabled If that direction is enabled or not
24685 * By default all directions are disabled, so you may want to enable the
24686 * desired directions for flipping if you need interactive flipping. You must
24687 * call this function once for each direction that should be enabled.
24689 * @see elm_flip_interaction_set()
24691 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24693 * @brief Get the enabled state of that flip direction
24695 * @param obj The flip object
24696 * @param dir The direction to check
24697 * @return If that direction is enabled or not
24699 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24701 * @see elm_flip_interaction_set()
24703 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24705 * @brief Set the amount of the flip that is sensitive to interactive flip
24707 * @param obj The flip object
24708 * @param dir The direction to modify
24709 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24711 * Set the amount of the flip that is sensitive to interactive flip, with 0
24712 * representing no area in the flip and 1 representing the entire flip. There
24713 * is however a consideration to be made in that the area will never be
24714 * smaller than the finger size set(as set in your Elementary configuration).
24716 * @see elm_flip_interaction_set()
24718 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24720 * @brief Get the amount of the flip that is sensitive to interactive flip
24722 * @param obj The flip object
24723 * @param dir The direction to check
24724 * @return The size set for that direction
24726 * Returns the amount os sensitive area set by
24727 * elm_flip_interacton_direction_hitsize_set().
24729 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24734 /* scrolledentry */
24735 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24736 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24737 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24739 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24740 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24741 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24742 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24743 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24744 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24745 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24746 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24747 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24748 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24749 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24750 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24751 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24752 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24753 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24754 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24755 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24756 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24757 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24758 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24759 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24760 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24761 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24762 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24763 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24764 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24765 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24766 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24767 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24768 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24769 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24770 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);
24771 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24772 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24773 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);
24774 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24775 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);
24776 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24777 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24778 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24779 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24780 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24781 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24782 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24783 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24784 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);
24785 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);
24786 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);
24787 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);
24788 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);
24789 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);
24790 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24791 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24792 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24793 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24794 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24795 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24796 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24799 * @defgroup Conformant Conformant
24800 * @ingroup Elementary
24802 * @image html img/widget/conformant/preview-00.png
24803 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24805 * @image html img/conformant.png
24806 * @image latex img/conformant.eps width=\textwidth
24808 * The aim is to provide a widget that can be used in elementary apps to
24809 * account for space taken up by the indicator, virtual keypad & softkey
24810 * windows when running the illume2 module of E17.
24812 * So conformant content will be sized and positioned considering the
24813 * space required for such stuff, and when they popup, as a keyboard
24814 * shows when an entry is selected, conformant content won't change.
24816 * Available styles for it:
24819 * Default contents parts of the conformant widget that you can use for are:
24820 * @li "default" - A content of the conformant
24822 * See how to use this widget in this example:
24823 * @ref conformant_example
24827 * @addtogroup Conformant
24832 * Add a new conformant widget to the given parent Elementary
24833 * (container) object.
24835 * @param parent The parent object.
24836 * @return A new conformant widget handle or @c NULL, on errors.
24838 * This function inserts a new conformant widget on the canvas.
24840 * @ingroup Conformant
24842 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24845 * Set the content of the conformant widget.
24847 * @param obj The conformant object.
24848 * @param content The content to be displayed by the conformant.
24850 * Content will be sized and positioned considering the space required
24851 * to display a virtual keyboard. So it won't fill all the conformant
24852 * size. This way is possible to be sure that content won't resize
24853 * or be re-positioned after the keyboard is displayed.
24855 * Once the content object is set, a previously set one will be deleted.
24856 * If you want to keep that old content object, use the
24857 * elm_object_content_unset() function.
24859 * @see elm_object_content_unset()
24860 * @see elm_object_content_get()
24862 * @deprecated use elm_object_content_set() instead
24864 * @ingroup Conformant
24866 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24869 * Get the content of the conformant widget.
24871 * @param obj The conformant object.
24872 * @return The content that is being used.
24874 * Return the content object which is set for this widget.
24875 * It won't be unparent from conformant. For that, use
24876 * elm_object_content_unset().
24878 * @see elm_object_content_set().
24879 * @see elm_object_content_unset()
24881 * @deprecated use elm_object_content_get() instead
24883 * @ingroup Conformant
24885 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24888 * Unset the content of the conformant widget.
24890 * @param obj The conformant object.
24891 * @return The content that was being used.
24893 * Unparent and return the content object which was set for this widget.
24895 * @see elm_object_content_set().
24897 * @deprecated use elm_object_content_unset() instead
24899 * @ingroup Conformant
24901 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24904 * Returns the Evas_Object that represents the content area.
24906 * @param obj The conformant object.
24907 * @return The content area of the widget.
24909 * @ingroup Conformant
24911 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24918 * @defgroup Mapbuf Mapbuf
24919 * @ingroup Elementary
24921 * @image html img/widget/mapbuf/preview-00.png
24922 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24924 * This holds one content object and uses an Evas Map of transformation
24925 * points to be later used with this content. So the content will be
24926 * moved, resized, etc as a single image. So it will improve performance
24927 * when you have a complex interafce, with a lot of elements, and will
24928 * need to resize or move it frequently (the content object and its
24931 * Default contents parts of the mapbuf widget that you can use for are:
24932 * @li "default" - A content of the mapbuf
24934 * To enable map, elm_mapbuf_enabled_set() should be used.
24936 * See how to use this widget in this example:
24937 * @ref mapbuf_example
24941 * @addtogroup Mapbuf
24946 * Add a new mapbuf widget to the given parent Elementary
24947 * (container) object.
24949 * @param parent The parent object.
24950 * @return A new mapbuf widget handle or @c NULL, on errors.
24952 * This function inserts a new mapbuf widget on the canvas.
24956 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24959 * Set the content of the mapbuf.
24961 * @param obj The mapbuf object.
24962 * @param content The content that will be filled in this mapbuf object.
24964 * Once the content object is set, a previously set one will be deleted.
24965 * If you want to keep that old content object, use the
24966 * elm_mapbuf_content_unset() function.
24968 * To enable map, elm_mapbuf_enabled_set() should be used.
24970 * @deprecated use elm_object_content_set() instead
24974 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24977 * Get the content of the mapbuf.
24979 * @param obj The mapbuf object.
24980 * @return The content that is being used.
24982 * Return the content object which is set for this widget.
24984 * @see elm_mapbuf_content_set() for details.
24986 * @deprecated use elm_object_content_get() instead
24990 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24993 * Unset the content of the mapbuf.
24995 * @param obj The mapbuf object.
24996 * @return The content that was being used.
24998 * Unparent and return the content object which was set for this widget.
25000 * @see elm_mapbuf_content_set() for details.
25002 * @deprecated use elm_object_content_unset() instead
25006 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25009 * Enable or disable the map.
25011 * @param obj The mapbuf object.
25012 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25014 * This enables the map that is set or disables it. On enable, the object
25015 * geometry will be saved, and the new geometry will change (position and
25016 * size) to reflect the map geometry set.
25018 * Also, when enabled, alpha and smooth states will be used, so if the
25019 * content isn't solid, alpha should be enabled, for example, otherwise
25020 * a black retangle will fill the content.
25022 * When disabled, the stored map will be freed and geometry prior to
25023 * enabling the map will be restored.
25025 * It's disabled by default.
25027 * @see elm_mapbuf_alpha_set()
25028 * @see elm_mapbuf_smooth_set()
25032 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25035 * Get a value whether map is enabled or not.
25037 * @param obj The mapbuf object.
25038 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25039 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25041 * @see elm_mapbuf_enabled_set() for details.
25045 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25048 * Enable or disable smooth map rendering.
25050 * @param obj The mapbuf object.
25051 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25054 * This sets smoothing for map rendering. If the object is a type that has
25055 * its own smoothing settings, then both the smooth settings for this object
25056 * and the map must be turned off.
25058 * By default smooth maps are enabled.
25062 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25065 * Get a value whether smooth map rendering is enabled or not.
25067 * @param obj The mapbuf object.
25068 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25069 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25071 * @see elm_mapbuf_smooth_set() for details.
25075 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25078 * Set or unset alpha flag for map rendering.
25080 * @param obj The mapbuf object.
25081 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25084 * This sets alpha flag for map rendering. If the object is a type that has
25085 * its own alpha settings, then this will take precedence. Only image objects
25086 * have this currently. It stops alpha blending of the map area, and is
25087 * useful if you know the object and/or all sub-objects is 100% solid.
25089 * Alpha is enabled by default.
25093 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25096 * Get a value whether alpha blending is enabled or not.
25098 * @param obj The mapbuf object.
25099 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25100 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25102 * @see elm_mapbuf_alpha_set() for details.
25106 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25113 * @defgroup Flipselector Flip Selector
25115 * @image html img/widget/flipselector/preview-00.png
25116 * @image latex img/widget/flipselector/preview-00.eps
25118 * A flip selector is a widget to show a set of @b text items, one
25119 * at a time, with the same sheet switching style as the @ref Clock
25120 * "clock" widget, when one changes the current displaying sheet
25121 * (thus, the "flip" in the name).
25123 * User clicks to flip sheets which are @b held for some time will
25124 * make the flip selector to flip continuosly and automatically for
25125 * the user. The interval between flips will keep growing in time,
25126 * so that it helps the user to reach an item which is distant from
25127 * the current selection.
25129 * Smart callbacks one can register to:
25130 * - @c "selected" - when the widget's selected text item is changed
25131 * - @c "overflowed" - when the widget's current selection is changed
25132 * from the first item in its list to the last
25133 * - @c "underflowed" - when the widget's current selection is changed
25134 * from the last item in its list to the first
25136 * Available styles for it:
25139 * To set/get the label of the flipselector item, you can use
25140 * elm_object_item_text_set/get APIs.
25141 * Once the text is set, a previously set one will be deleted.
25143 * Here is an example on its usage:
25144 * @li @ref flipselector_example
25148 * @addtogroup Flipselector
25153 * Add a new flip selector widget to the given parent Elementary
25154 * (container) widget
25156 * @param parent The parent object
25157 * @return a new flip selector widget handle or @c NULL, on errors
25159 * This function inserts a new flip selector widget on the canvas.
25161 * @ingroup Flipselector
25163 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25166 * Programmatically select the next item of a flip selector widget
25168 * @param obj The flipselector object
25170 * @note The selection will be animated. Also, if it reaches the
25171 * end of its list of member items, it will continue with the first
25174 * @ingroup Flipselector
25176 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25179 * Programmatically select the previous item of a flip selector
25182 * @param obj The flipselector object
25184 * @note The selection will be animated. Also, if it reaches the
25185 * beginning of its list of member items, it will continue with the
25186 * last one backwards.
25188 * @ingroup Flipselector
25190 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25193 * Append a (text) item to a flip selector widget
25195 * @param obj The flipselector object
25196 * @param label The (text) label of the new item
25197 * @param func Convenience callback function to take place when
25199 * @param data Data passed to @p func, above
25200 * @return A handle to the item added or @c NULL, on errors
25202 * The widget's list of labels to show will be appended with the
25203 * given value. If the user wishes so, a callback function pointer
25204 * can be passed, which will get called when this same item is
25207 * @note The current selection @b won't be modified by appending an
25208 * element to the list.
25210 * @note The maximum length of the text label is going to be
25211 * determined <b>by the widget's theme</b>. Strings larger than
25212 * that value are going to be @b truncated.
25214 * @ingroup Flipselector
25216 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25219 * Prepend a (text) item to a flip selector widget
25221 * @param obj The flipselector object
25222 * @param label The (text) label of the new item
25223 * @param func Convenience callback function to take place when
25225 * @param data Data passed to @p func, above
25226 * @return A handle to the item added or @c NULL, on errors
25228 * The widget's list of labels to show will be prepended with the
25229 * given value. If the user wishes so, a callback function pointer
25230 * can be passed, which will get called when this same item is
25233 * @note The current selection @b won't be modified by prepending
25234 * an element to the list.
25236 * @note The maximum length of the text label is going to be
25237 * determined <b>by the widget's theme</b>. Strings larger than
25238 * that value are going to be @b truncated.
25240 * @ingroup Flipselector
25242 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25245 * Get the internal list of items in a given flip selector widget.
25247 * @param obj The flipselector object
25248 * @return The list of items (#Elm_Object_Item as data) or
25249 * @c NULL on errors.
25251 * This list is @b not to be modified in any way and must not be
25252 * freed. Use the list members with functions like
25253 * elm_object_item_text_set(),
25254 * elm_object_item_text_get(),
25255 * elm_flipselector_item_del(),
25256 * elm_flipselector_item_selected_get(),
25257 * elm_flipselector_item_selected_set().
25259 * @warning This list is only valid until @p obj object's internal
25260 * items list is changed. It should be fetched again with another
25261 * call to this function when changes happen.
25263 * @ingroup Flipselector
25265 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25268 * Get the first item in the given flip selector widget's list of
25271 * @param obj The flipselector object
25272 * @return The first item or @c NULL, if it has no items (and on
25275 * @see elm_flipselector_item_append()
25276 * @see elm_flipselector_last_item_get()
25278 * @ingroup Flipselector
25280 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25283 * Get the last item in the given flip selector widget's list of
25286 * @param obj The flipselector object
25287 * @return The last item or @c NULL, if it has no items (and on
25290 * @see elm_flipselector_item_prepend()
25291 * @see elm_flipselector_first_item_get()
25293 * @ingroup Flipselector
25295 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25298 * Get the currently selected item in a flip selector widget.
25300 * @param obj The flipselector object
25301 * @return The selected item or @c NULL, if the widget has no items
25304 * @ingroup Flipselector
25306 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25309 * Set whether a given flip selector widget's item should be the
25310 * currently selected one.
25312 * @param it The flip selector item
25313 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25315 * This sets whether @p item is or not the selected (thus, under
25316 * display) one. If @p item is different than one under display,
25317 * the latter will be unselected. If the @p item is set to be
25318 * unselected, on the other hand, the @b first item in the widget's
25319 * internal members list will be the new selected one.
25321 * @see elm_flipselector_item_selected_get()
25323 * @ingroup Flipselector
25325 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25328 * Get whether a given flip selector widget's item is the currently
25331 * @param it The flip selector item
25332 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25335 * @see elm_flipselector_item_selected_set()
25337 * @ingroup Flipselector
25339 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25342 * Delete a given item from a flip selector widget.
25344 * @param it The item to delete
25346 * @ingroup Flipselector
25348 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25351 * Get the label of a given flip selector widget's item.
25353 * @param it The item to get label from
25354 * @return The text label of @p item or @c NULL, on errors
25356 * @see elm_object_item_text_set()
25358 * @deprecated see elm_object_item_text_get() instead
25359 * @ingroup Flipselector
25361 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25364 * Set the label of a given flip selector widget's item.
25366 * @param it The item to set label on
25367 * @param label The text label string, in UTF-8 encoding
25369 * @see elm_object_item_text_get()
25371 * @deprecated see elm_object_item_text_set() instead
25372 * @ingroup Flipselector
25374 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25377 * Gets the item before @p item in a flip selector widget's
25378 * internal list of items.
25380 * @param it The item to fetch previous from
25381 * @return The item before the @p item, in its parent's list. If
25382 * there is no previous item for @p item or there's an
25383 * error, @c NULL is returned.
25385 * @see elm_flipselector_item_next_get()
25387 * @ingroup Flipselector
25389 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25392 * Gets the item after @p item in a flip selector widget's
25393 * internal list of items.
25395 * @param it The item to fetch next from
25396 * @return The item after the @p item, in its parent's list. If
25397 * there is no next item for @p item or there's an
25398 * error, @c NULL is returned.
25400 * @see elm_flipselector_item_next_get()
25402 * @ingroup Flipselector
25404 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25407 * Set the interval on time updates for an user mouse button hold
25408 * on a flip selector widget.
25410 * @param obj The flip selector object
25411 * @param interval The (first) interval value in seconds
25413 * This interval value is @b decreased while the user holds the
25414 * mouse pointer either flipping up or flipping doww a given flip
25417 * This helps the user to get to a given item distant from the
25418 * current one easier/faster, as it will start to flip quicker and
25419 * quicker on mouse button holds.
25421 * The calculation for the next flip interval value, starting from
25422 * the one set with this call, is the previous interval divided by
25423 * 1.05, so it decreases a little bit.
25425 * The default starting interval value for automatic flips is
25428 * @see elm_flipselector_interval_get()
25430 * @ingroup Flipselector
25432 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25435 * Get the interval on time updates for an user mouse button hold
25436 * on a flip selector widget.
25438 * @param obj The flip selector object
25439 * @return The (first) interval value, in seconds, set on it
25441 * @see elm_flipselector_interval_set() for more details
25443 * @ingroup Flipselector
25445 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25451 * @addtogroup Calendar
25456 * @enum _Elm_Calendar_Mark_Repeat
25457 * @typedef Elm_Calendar_Mark_Repeat
25459 * Event periodicity, used to define if a mark should be repeated
25460 * @b beyond event's day. It's set when a mark is added.
25462 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25463 * there will be marks every week after this date. Marks will be displayed
25464 * at 13th, 20th, 27th, 3rd June ...
25466 * Values don't work as bitmask, only one can be choosen.
25468 * @see elm_calendar_mark_add()
25470 * @ingroup Calendar
25472 typedef enum _Elm_Calendar_Mark_Repeat
25474 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25475 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25476 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25477 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*/
25478 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. */
25479 } Elm_Calendar_Mark_Repeat;
25481 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(). */
25484 * Add a new calendar widget to the given parent Elementary
25485 * (container) object.
25487 * @param parent The parent object.
25488 * @return a new calendar widget handle or @c NULL, on errors.
25490 * This function inserts a new calendar widget on the canvas.
25492 * @ref calendar_example_01
25494 * @ingroup Calendar
25496 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25499 * Get weekdays names displayed by the calendar.
25501 * @param obj The calendar object.
25502 * @return Array of seven strings to be used as weekday names.
25504 * By default, weekdays abbreviations get from system are displayed:
25505 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25506 * The first string is related to Sunday, the second to Monday...
25508 * @see elm_calendar_weekdays_name_set()
25510 * @ref calendar_example_05
25512 * @ingroup Calendar
25514 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25517 * Set weekdays names to be displayed by the calendar.
25519 * @param obj The calendar object.
25520 * @param weekdays Array of seven strings to be used as weekday names.
25521 * @warning It must have 7 elements, or it will access invalid memory.
25522 * @warning The strings must be NULL terminated ('@\0').
25524 * By default, weekdays abbreviations get from system are displayed:
25525 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25527 * The first string should be related to Sunday, the second to Monday...
25529 * The usage should be like this:
25531 * const char *weekdays[] =
25533 * "Sunday", "Monday", "Tuesday", "Wednesday",
25534 * "Thursday", "Friday", "Saturday"
25536 * elm_calendar_weekdays_names_set(calendar, weekdays);
25539 * @see elm_calendar_weekdays_name_get()
25541 * @ref calendar_example_02
25543 * @ingroup Calendar
25545 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25548 * Set the minimum and maximum values for the year
25550 * @param obj The calendar object
25551 * @param min The minimum year, greater than 1901;
25552 * @param max The maximum year;
25554 * Maximum must be greater than minimum, except if you don't wan't to set
25556 * Default values are 1902 and -1.
25558 * If the maximum year is a negative value, it will be limited depending
25559 * on the platform architecture (year 2037 for 32 bits);
25561 * @see elm_calendar_min_max_year_get()
25563 * @ref calendar_example_03
25565 * @ingroup Calendar
25567 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25570 * Get the minimum and maximum values for the year
25572 * @param obj The calendar object.
25573 * @param min The minimum year.
25574 * @param max The maximum year.
25576 * Default values are 1902 and -1.
25578 * @see elm_calendar_min_max_year_get() for more details.
25580 * @ref calendar_example_05
25582 * @ingroup Calendar
25584 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25587 * Enable or disable day selection
25589 * @param obj The calendar object.
25590 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25593 * Enabled by default. If disabled, the user still can select months,
25594 * but not days. Selected days are highlighted on calendar.
25595 * It should be used if you won't need such selection for the widget usage.
25597 * When a day is selected, or month is changed, smart callbacks for
25598 * signal "changed" will be called.
25600 * @see elm_calendar_day_selection_enable_get()
25602 * @ref calendar_example_04
25604 * @ingroup Calendar
25606 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25609 * Get a value whether day selection is enabled or not.
25611 * @see elm_calendar_day_selection_enable_set() for details.
25613 * @param obj The calendar object.
25614 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25615 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25617 * @ref calendar_example_05
25619 * @ingroup Calendar
25621 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25625 * Set selected date to be highlighted on calendar.
25627 * @param obj The calendar object.
25628 * @param selected_time A @b tm struct to represent the selected date.
25630 * Set the selected date, changing the displayed month if needed.
25631 * Selected date changes when the user goes to next/previous month or
25632 * select a day pressing over it on calendar.
25634 * @see elm_calendar_selected_time_get()
25636 * @ref calendar_example_04
25638 * @ingroup Calendar
25640 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25643 * Get selected date.
25645 * @param obj The calendar object
25646 * @param selected_time A @b tm struct to point to selected date
25647 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25650 * Get date selected by the user or set by function
25651 * elm_calendar_selected_time_set().
25652 * Selected date changes when the user goes to next/previous month or
25653 * select a day pressing over it on calendar.
25655 * @see elm_calendar_selected_time_get()
25657 * @ref calendar_example_05
25659 * @ingroup Calendar
25661 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25664 * Set a function to format the string that will be used to display
25667 * @param obj The calendar object
25668 * @param format_function Function to set the month-year string given
25669 * the selected date
25671 * By default it uses strftime with "%B %Y" format string.
25672 * It should allocate the memory that will be used by the string,
25673 * that will be freed by the widget after usage.
25674 * A pointer to the string and a pointer to the time struct will be provided.
25679 * _format_month_year(struct tm *selected_time)
25682 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25683 * return strdup(buf);
25686 * elm_calendar_format_function_set(calendar, _format_month_year);
25689 * @ref calendar_example_02
25691 * @ingroup Calendar
25693 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25696 * Add a new mark to the calendar
25698 * @param obj The calendar object
25699 * @param mark_type A string used to define the type of mark. It will be
25700 * emitted to the theme, that should display a related modification on these
25701 * days representation.
25702 * @param mark_time A time struct to represent the date of inclusion of the
25703 * mark. For marks that repeats it will just be displayed after the inclusion
25704 * date in the calendar.
25705 * @param repeat Repeat the event following this periodicity. Can be a unique
25706 * mark (that don't repeat), daily, weekly, monthly or annually.
25707 * @return The created mark or @p NULL upon failure.
25709 * Add a mark that will be drawn in the calendar respecting the insertion
25710 * time and periodicity. It will emit the type as signal to the widget theme.
25711 * Default theme supports "holiday" and "checked", but it can be extended.
25713 * It won't immediately update the calendar, drawing the marks.
25714 * For this, call elm_calendar_marks_draw(). However, when user selects
25715 * next or previous month calendar forces marks drawn.
25717 * Marks created with this method can be deleted with
25718 * elm_calendar_mark_del().
25722 * struct tm selected_time;
25723 * time_t current_time;
25725 * current_time = time(NULL) + 5 * 84600;
25726 * localtime_r(¤t_time, &selected_time);
25727 * elm_calendar_mark_add(cal, "holiday", selected_time,
25728 * ELM_CALENDAR_ANNUALLY);
25730 * current_time = time(NULL) + 1 * 84600;
25731 * localtime_r(¤t_time, &selected_time);
25732 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25734 * elm_calendar_marks_draw(cal);
25737 * @see elm_calendar_marks_draw()
25738 * @see elm_calendar_mark_del()
25740 * @ref calendar_example_06
25742 * @ingroup Calendar
25744 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);
25747 * Delete mark from the calendar.
25749 * @param mark The mark to be deleted.
25751 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25752 * should be used instead of getting marks list and deleting each one.
25754 * @see elm_calendar_mark_add()
25756 * @ref calendar_example_06
25758 * @ingroup Calendar
25760 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25763 * Remove all calendar's marks
25765 * @param obj The calendar object.
25767 * @see elm_calendar_mark_add()
25768 * @see elm_calendar_mark_del()
25770 * @ingroup Calendar
25772 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25776 * Get a list of all the calendar marks.
25778 * @param obj The calendar object.
25779 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25781 * @see elm_calendar_mark_add()
25782 * @see elm_calendar_mark_del()
25783 * @see elm_calendar_marks_clear()
25785 * @ingroup Calendar
25787 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25790 * Draw calendar marks.
25792 * @param obj The calendar object.
25794 * Should be used after adding, removing or clearing marks.
25795 * It will go through the entire marks list updating the calendar.
25796 * If lots of marks will be added, add all the marks and then call
25799 * When the month is changed, i.e. user selects next or previous month,
25800 * marks will be drawed.
25802 * @see elm_calendar_mark_add()
25803 * @see elm_calendar_mark_del()
25804 * @see elm_calendar_marks_clear()
25806 * @ref calendar_example_06
25808 * @ingroup Calendar
25810 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25813 * Set a day text color to the same that represents Saturdays.
25815 * @param obj The calendar object.
25816 * @param pos The text position. Position is the cell counter, from left
25817 * to right, up to down. It starts on 0 and ends on 41.
25819 * @deprecated use elm_calendar_mark_add() instead like:
25822 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25823 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25826 * @see elm_calendar_mark_add()
25828 * @ingroup Calendar
25830 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25833 * Set a day text color to the same that represents Sundays.
25835 * @param obj The calendar object.
25836 * @param pos The text position. Position is the cell counter, from left
25837 * to right, up to down. It starts on 0 and ends on 41.
25839 * @deprecated use elm_calendar_mark_add() instead like:
25842 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25843 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25846 * @see elm_calendar_mark_add()
25848 * @ingroup Calendar
25850 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25853 * Set a day text color to the same that represents Weekdays.
25855 * @param obj The calendar object
25856 * @param pos The text position. Position is the cell counter, from left
25857 * to right, up to down. It starts on 0 and ends on 41.
25859 * @deprecated use elm_calendar_mark_add() instead like:
25862 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25864 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25865 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25866 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25867 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25868 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25869 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25870 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25871 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25872 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25875 * @see elm_calendar_mark_add()
25877 * @ingroup Calendar
25879 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25882 * Set the interval on time updates for an user mouse button hold
25883 * on calendar widgets' month selection.
25885 * @param obj The calendar object
25886 * @param interval The (first) interval value in seconds
25888 * This interval value is @b decreased while the user holds the
25889 * mouse pointer either selecting next or previous month.
25891 * This helps the user to get to a given month distant from the
25892 * current one easier/faster, as it will start to change quicker and
25893 * quicker on mouse button holds.
25895 * The calculation for the next change interval value, starting from
25896 * the one set with this call, is the previous interval divided by
25897 * 1.05, so it decreases a little bit.
25899 * The default starting interval value for automatic changes is
25902 * @see elm_calendar_interval_get()
25904 * @ingroup Calendar
25906 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25909 * Get the interval on time updates for an user mouse button hold
25910 * on calendar widgets' month selection.
25912 * @param obj The calendar object
25913 * @return The (first) interval value, in seconds, set on it
25915 * @see elm_calendar_interval_set() for more details
25917 * @ingroup Calendar
25919 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25926 * @defgroup Diskselector Diskselector
25927 * @ingroup Elementary
25929 * @image html img/widget/diskselector/preview-00.png
25930 * @image latex img/widget/diskselector/preview-00.eps
25932 * A diskselector is a kind of list widget. It scrolls horizontally,
25933 * and can contain label and icon objects. Three items are displayed
25934 * with the selected one in the middle.
25936 * It can act like a circular list with round mode and labels can be
25937 * reduced for a defined length for side items.
25939 * Smart callbacks one can listen to:
25940 * - "selected" - when item is selected, i.e. scroller stops.
25942 * Available styles for it:
25945 * List of examples:
25946 * @li @ref diskselector_example_01
25947 * @li @ref diskselector_example_02
25951 * @addtogroup Diskselector
25955 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(). */
25958 * Add a new diskselector widget to the given parent Elementary
25959 * (container) object.
25961 * @param parent The parent object.
25962 * @return a new diskselector widget handle or @c NULL, on errors.
25964 * This function inserts a new diskselector widget on the canvas.
25966 * @ingroup Diskselector
25968 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25971 * Enable or disable round mode.
25973 * @param obj The diskselector object.
25974 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25977 * Disabled by default. If round mode is enabled the items list will
25978 * work like a circle list, so when the user reaches the last item,
25979 * the first one will popup.
25981 * @see elm_diskselector_round_get()
25983 * @ingroup Diskselector
25985 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25988 * Get a value whether round mode is enabled or not.
25990 * @see elm_diskselector_round_set() for details.
25992 * @param obj The diskselector object.
25993 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25994 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25996 * @ingroup Diskselector
25998 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26001 * Get the side labels max length.
26003 * @deprecated use elm_diskselector_side_label_length_get() instead:
26005 * @param obj The diskselector object.
26006 * @return The max length defined for side labels, or 0 if not a valid
26009 * @ingroup Diskselector
26011 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26014 * Set the side labels max length.
26016 * @deprecated use elm_diskselector_side_label_length_set() instead:
26018 * @param obj The diskselector object.
26019 * @param len The max length defined for side labels.
26021 * @ingroup Diskselector
26023 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26026 * Get the side labels max length.
26028 * @see elm_diskselector_side_label_length_set() for details.
26030 * @param obj The diskselector object.
26031 * @return The max length defined for side labels, or 0 if not a valid
26034 * @ingroup Diskselector
26036 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26039 * Set the side labels max length.
26041 * @param obj The diskselector object.
26042 * @param len The max length defined for side labels.
26044 * Length is the number of characters of items' label that will be
26045 * visible when it's set on side positions. It will just crop
26046 * the string after defined size. E.g.:
26048 * An item with label "January" would be displayed on side position as
26049 * "Jan" if max length is set to 3, or "Janu", if this property
26052 * When it's selected, the entire label will be displayed, except for
26053 * width restrictions. In this case label will be cropped and "..."
26054 * will be concatenated.
26056 * Default side label max length is 3.
26058 * This property will be applyed over all items, included before or
26059 * later this function call.
26061 * @ingroup Diskselector
26063 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26066 * Set the number of items to be displayed.
26068 * @param obj The diskselector object.
26069 * @param num The number of items the diskselector will display.
26071 * Default value is 3, and also it's the minimun. If @p num is less
26072 * than 3, it will be set to 3.
26074 * Also, it can be set on theme, using data item @c display_item_num
26075 * on group "elm/diskselector/item/X", where X is style set.
26078 * group { name: "elm/diskselector/item/X";
26080 * item: "display_item_num" "5";
26083 * @ingroup Diskselector
26085 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26088 * Get the number of items in the diskselector object.
26090 * @param obj The diskselector object.
26092 * @ingroup Diskselector
26094 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26097 * Set bouncing behaviour when the scrolled content reaches an edge.
26099 * Tell the internal scroller object whether it should bounce or not
26100 * when it reaches the respective edges for each axis.
26102 * @param obj The diskselector object.
26103 * @param h_bounce Whether to bounce or not in the horizontal axis.
26104 * @param v_bounce Whether to bounce or not in the vertical axis.
26106 * @see elm_scroller_bounce_set()
26108 * @ingroup Diskselector
26110 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26113 * Get the bouncing behaviour of the internal scroller.
26115 * Get whether the internal scroller should bounce when the edge of each
26116 * axis is reached scrolling.
26118 * @param obj The diskselector object.
26119 * @param h_bounce Pointer where to store the bounce state of the horizontal
26121 * @param v_bounce Pointer where to store the bounce state of the vertical
26124 * @see elm_scroller_bounce_get()
26125 * @see elm_diskselector_bounce_set()
26127 * @ingroup Diskselector
26129 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26132 * Get the scrollbar policy.
26134 * @see elm_diskselector_scroller_policy_get() for details.
26136 * @param obj The diskselector object.
26137 * @param policy_h Pointer where to store horizontal scrollbar policy.
26138 * @param policy_v Pointer where to store vertical scrollbar policy.
26140 * @ingroup Diskselector
26142 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);
26145 * Set the scrollbar policy.
26147 * @param obj The diskselector object.
26148 * @param policy_h Horizontal scrollbar policy.
26149 * @param policy_v Vertical scrollbar policy.
26151 * This sets the scrollbar visibility policy for the given scroller.
26152 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26153 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26154 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26155 * This applies respectively for the horizontal and vertical scrollbars.
26157 * The both are disabled by default, i.e., are set to
26158 * #ELM_SCROLLER_POLICY_OFF.
26160 * @ingroup Diskselector
26162 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26165 * Remove all diskselector's items.
26167 * @param obj The diskselector object.
26169 * @see elm_diskselector_item_del()
26170 * @see elm_diskselector_item_append()
26172 * @ingroup Diskselector
26174 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26177 * Get a list of all the diskselector items.
26179 * @param obj The diskselector object.
26180 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26181 * or @c NULL on failure.
26183 * @see elm_diskselector_item_append()
26184 * @see elm_diskselector_item_del()
26185 * @see elm_diskselector_clear()
26187 * @ingroup Diskselector
26189 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26192 * Appends a new item to the diskselector object.
26194 * @param obj The diskselector object.
26195 * @param label The label of the diskselector item.
26196 * @param icon The icon object to use at left side of the item. An
26197 * icon can be any Evas object, but usually it is an icon created
26198 * with elm_icon_add().
26199 * @param func The function to call when the item is selected.
26200 * @param data The data to associate with the item for related callbacks.
26202 * @return The created item or @c NULL upon failure.
26204 * A new item will be created and appended to the diskselector, i.e., will
26205 * be set as last item. Also, if there is no selected item, it will
26206 * be selected. This will always happens for the first appended item.
26208 * If no icon is set, label will be centered on item position, otherwise
26209 * the icon will be placed at left of the label, that will be shifted
26212 * Items created with this method can be deleted with
26213 * elm_diskselector_item_del().
26215 * Associated @p data can be properly freed when item is deleted if a
26216 * callback function is set with elm_diskselector_item_del_cb_set().
26218 * If a function is passed as argument, it will be called everytime this item
26219 * is selected, i.e., the user stops the diskselector with this
26220 * item on center position. If such function isn't needed, just passing
26221 * @c NULL as @p func is enough. The same should be done for @p data.
26223 * Simple example (with no function callback or data associated):
26225 * disk = elm_diskselector_add(win);
26226 * ic = elm_icon_add(win);
26227 * elm_icon_file_set(ic, "path/to/image", NULL);
26228 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26229 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26232 * @see elm_diskselector_item_del()
26233 * @see elm_diskselector_item_del_cb_set()
26234 * @see elm_diskselector_clear()
26235 * @see elm_icon_add()
26237 * @ingroup Diskselector
26239 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);
26243 * Delete them item from the diskselector.
26245 * @param it The item of diskselector to be deleted.
26247 * If deleting all diskselector items is required, elm_diskselector_clear()
26248 * should be used instead of getting items list and deleting each one.
26250 * @see elm_diskselector_clear()
26251 * @see elm_diskselector_item_append()
26252 * @see elm_diskselector_item_del_cb_set()
26254 * @ingroup Diskselector
26256 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26259 * Set the function called when a diskselector item is freed.
26261 * @param it The item to set the callback on
26262 * @param func The function called
26264 * If there is a @p func, then it will be called prior item's memory release.
26265 * That will be called with the following arguments:
26267 * @li item's Evas object;
26270 * This way, a data associated to a diskselector item could be properly
26273 * @ingroup Diskselector
26275 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26278 * Get the data associated to the item.
26280 * @param it The diskselector item
26281 * @return The data associated to @p it
26283 * The return value is a pointer to data associated to @p item when it was
26284 * created, with function elm_diskselector_item_append(). If no data
26285 * was passed as argument, it will return @c NULL.
26287 * @see elm_diskselector_item_append()
26289 * @ingroup Diskselector
26291 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26294 * Set the icon associated to the item.
26296 * @param it The diskselector item
26297 * @param icon The icon object to associate with @p it
26299 * The icon object to use at left side of the item. An
26300 * icon can be any Evas object, but usually it is an icon created
26301 * with elm_icon_add().
26303 * Once the icon object is set, a previously set one will be deleted.
26304 * @warning Setting the same icon for two items will cause the icon to
26305 * dissapear from the first item.
26307 * If an icon was passed as argument on item creation, with function
26308 * elm_diskselector_item_append(), it will be already
26309 * associated to the item.
26311 * @see elm_diskselector_item_append()
26312 * @see elm_diskselector_item_icon_get()
26314 * @ingroup Diskselector
26316 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26319 * Get the icon associated to the item.
26321 * @param it The diskselector item
26322 * @return The icon associated to @p it
26324 * The return value is a pointer to the icon associated to @p item when it was
26325 * created, with function elm_diskselector_item_append(), or later
26326 * with function elm_diskselector_item_icon_set. If no icon
26327 * was passed as argument, it will return @c NULL.
26329 * @see elm_diskselector_item_append()
26330 * @see elm_diskselector_item_icon_set()
26332 * @ingroup Diskselector
26334 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26337 * Set the label of item.
26339 * @param it The item of diskselector.
26340 * @param label The label of item.
26342 * The label to be displayed by the item.
26344 * If no icon is set, label will be centered on item position, otherwise
26345 * the icon will be placed at left of the label, that will be shifted
26348 * An item with label "January" would be displayed on side position as
26349 * "Jan" if max length is set to 3 with function
26350 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26353 * When this @p item is selected, the entire label will be displayed,
26354 * except for width restrictions.
26355 * In this case label will be cropped and "..." will be concatenated,
26356 * but only for display purposes. It will keep the entire string, so
26357 * if diskselector is resized the remaining characters will be displayed.
26359 * If a label was passed as argument on item creation, with function
26360 * elm_diskselector_item_append(), it will be already
26361 * displayed by the item.
26363 * @see elm_diskselector_side_label_lenght_set()
26364 * @see elm_diskselector_item_label_get()
26365 * @see elm_diskselector_item_append()
26367 * @ingroup Diskselector
26369 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26372 * Get the label of item.
26374 * @param it The item of diskselector.
26375 * @return The label of item.
26377 * The return value is a pointer to the label associated to @p item when it was
26378 * created, with function elm_diskselector_item_append(), or later
26379 * with function elm_diskselector_item_label_set. If no label
26380 * was passed as argument, it will return @c NULL.
26382 * @see elm_diskselector_item_label_set() for more details.
26383 * @see elm_diskselector_item_append()
26385 * @ingroup Diskselector
26387 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26390 * Get the selected item.
26392 * @param obj The diskselector object.
26393 * @return The selected diskselector item.
26395 * The selected item can be unselected with function
26396 * elm_diskselector_item_selected_set(), and the first item of
26397 * diskselector will be selected.
26399 * The selected item always will be centered on diskselector, with
26400 * full label displayed, i.e., max lenght set to side labels won't
26401 * apply on the selected item. More details on
26402 * elm_diskselector_side_label_length_set().
26404 * @ingroup Diskselector
26406 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26409 * Set the selected state of an item.
26411 * @param it The diskselector item
26412 * @param selected The selected state
26414 * This sets the selected state of the given item @p it.
26415 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26417 * If a new item is selected the previosly selected will be unselected.
26418 * Previoulsy selected item can be get with function
26419 * elm_diskselector_selected_item_get().
26421 * If the item @p it is unselected, the first item of diskselector will
26424 * Selected items will be visible on center position of diskselector.
26425 * So if it was on another position before selected, or was invisible,
26426 * diskselector will animate items until the selected item reaches center
26429 * @see elm_diskselector_item_selected_get()
26430 * @see elm_diskselector_selected_item_get()
26432 * @ingroup Diskselector
26434 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26437 * Get whether the @p item is selected or not.
26439 * @param it The diskselector item.
26440 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26441 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26443 * @see elm_diskselector_selected_item_set() for details.
26444 * @see elm_diskselector_item_selected_get()
26446 * @ingroup Diskselector
26448 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26451 * Get the first item of the diskselector.
26453 * @param obj The diskselector object.
26454 * @return The first item, or @c NULL if none.
26456 * The list of items follows append order. So it will return the first
26457 * item appended to the widget that wasn't deleted.
26459 * @see elm_diskselector_item_append()
26460 * @see elm_diskselector_items_get()
26462 * @ingroup Diskselector
26464 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26467 * Get the last item of the diskselector.
26469 * @param obj The diskselector object.
26470 * @return The last item, or @c NULL if none.
26472 * The list of items follows append order. So it will return last first
26473 * item appended to the widget that wasn't deleted.
26475 * @see elm_diskselector_item_append()
26476 * @see elm_diskselector_items_get()
26478 * @ingroup Diskselector
26480 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26483 * Get the item before @p item in diskselector.
26485 * @param it The diskselector item.
26486 * @return The item before @p item, or @c NULL if none or on failure.
26488 * The list of items follows append order. So it will return item appended
26489 * just before @p item and that wasn't deleted.
26491 * If it is the first item, @c NULL will be returned.
26492 * First item can be get by elm_diskselector_first_item_get().
26494 * @see elm_diskselector_item_append()
26495 * @see elm_diskselector_items_get()
26497 * @ingroup Diskselector
26499 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26502 * Get the item after @p item in diskselector.
26504 * @param it The diskselector item.
26505 * @return The item after @p item, or @c NULL if none or on failure.
26507 * The list of items follows append order. So it will return item appended
26508 * just after @p item and that wasn't deleted.
26510 * If it is the last item, @c NULL will be returned.
26511 * Last item can be get by elm_diskselector_last_item_get().
26513 * @see elm_diskselector_item_append()
26514 * @see elm_diskselector_items_get()
26516 * @ingroup Diskselector
26518 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26521 * Set the text to be shown in the diskselector item.
26523 * @param item Target item
26524 * @param text The text to set in the content
26526 * Setup the text as tooltip to object. The item can have only one tooltip,
26527 * so any previous tooltip data is removed.
26529 * @see elm_object_tooltip_text_set() for more details.
26531 * @ingroup Diskselector
26533 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26536 * Set the content to be shown in the tooltip item.
26538 * Setup the tooltip to item. The item can have only one tooltip,
26539 * so any previous tooltip data is removed. @p func(with @p data) will
26540 * be called every time that need show the tooltip and it should
26541 * return a valid Evas_Object. This object is then managed fully by
26542 * tooltip system and is deleted when the tooltip is gone.
26544 * @param item the diskselector item being attached a tooltip.
26545 * @param func the function used to create the tooltip contents.
26546 * @param data what to provide to @a func as callback data/context.
26547 * @param del_cb called when data is not needed anymore, either when
26548 * another callback replaces @p func, the tooltip is unset with
26549 * elm_diskselector_item_tooltip_unset() or the owner @a item
26550 * dies. This callback receives as the first parameter the
26551 * given @a data, and @c event_info is the item.
26553 * @see elm_object_tooltip_content_cb_set() for more details.
26555 * @ingroup Diskselector
26557 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);
26560 * Unset tooltip from item.
26562 * @param item diskselector item to remove previously set tooltip.
26564 * Remove tooltip from item. The callback provided as del_cb to
26565 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26566 * it is not used anymore.
26568 * @see elm_object_tooltip_unset() for more details.
26569 * @see elm_diskselector_item_tooltip_content_cb_set()
26571 * @ingroup Diskselector
26573 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26577 * Sets a different style for this item tooltip.
26579 * @note before you set a style you should define a tooltip with
26580 * elm_diskselector_item_tooltip_content_cb_set() or
26581 * elm_diskselector_item_tooltip_text_set()
26583 * @param item diskselector item with tooltip already set.
26584 * @param style the theme style to use (default, transparent, ...)
26586 * @see elm_object_tooltip_style_set() for more details.
26588 * @ingroup Diskselector
26590 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26593 * Get the style for this item tooltip.
26595 * @param item diskselector item with tooltip already set.
26596 * @return style the theme style in use, defaults to "default". If the
26597 * object does not have a tooltip set, then NULL is returned.
26599 * @see elm_object_tooltip_style_get() for more details.
26600 * @see elm_diskselector_item_tooltip_style_set()
26602 * @ingroup Diskselector
26604 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26607 * Set the cursor to be shown when mouse is over the diskselector item
26609 * @param item Target item
26610 * @param cursor the cursor name to be used.
26612 * @see elm_object_cursor_set() for more details.
26614 * @ingroup Diskselector
26616 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26619 * Get the cursor to be shown when mouse is over the diskselector item
26621 * @param item diskselector item with cursor already set.
26622 * @return the cursor name.
26624 * @see elm_object_cursor_get() for more details.
26625 * @see elm_diskselector_cursor_set()
26627 * @ingroup Diskselector
26629 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26633 * Unset the cursor to be shown when mouse is over the diskselector item
26635 * @param item Target item
26637 * @see elm_object_cursor_unset() for more details.
26638 * @see elm_diskselector_cursor_set()
26640 * @ingroup Diskselector
26642 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26645 * Sets a different style for this item cursor.
26647 * @note before you set a style you should define a cursor with
26648 * elm_diskselector_item_cursor_set()
26650 * @param item diskselector item with cursor already set.
26651 * @param style the theme style to use (default, transparent, ...)
26653 * @see elm_object_cursor_style_set() for more details.
26655 * @ingroup Diskselector
26657 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26661 * Get the style for this item cursor.
26663 * @param item diskselector item with cursor already set.
26664 * @return style the theme style in use, defaults to "default". If the
26665 * object does not have a cursor set, then @c NULL is returned.
26667 * @see elm_object_cursor_style_get() for more details.
26668 * @see elm_diskselector_item_cursor_style_set()
26670 * @ingroup Diskselector
26672 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26676 * Set if the cursor set should be searched on the theme or should use
26677 * the provided by the engine, only.
26679 * @note before you set if should look on theme you should define a cursor
26680 * with elm_diskselector_item_cursor_set().
26681 * By default it will only look for cursors provided by the engine.
26683 * @param item widget item with cursor already set.
26684 * @param engine_only boolean to define if cursors set with
26685 * elm_diskselector_item_cursor_set() should be searched only
26686 * between cursors provided by the engine or searched on widget's
26689 * @see elm_object_cursor_engine_only_set() for more details.
26691 * @ingroup Diskselector
26693 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26696 * Get the cursor engine only usage for this item cursor.
26698 * @param item widget item with cursor already set.
26699 * @return engine_only boolean to define it cursors should be looked only
26700 * between the provided by the engine or searched on widget's theme as well.
26701 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26703 * @see elm_object_cursor_engine_only_get() for more details.
26704 * @see elm_diskselector_item_cursor_engine_only_set()
26706 * @ingroup Diskselector
26708 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26715 * @defgroup Colorselector Colorselector
26719 * @image html img/widget/colorselector/preview-00.png
26720 * @image latex img/widget/colorselector/preview-00.eps
26722 * @brief Widget for user to select a color.
26724 * Signals that you can add callbacks for are:
26725 * "changed" - When the color value changes(event_info is NULL).
26727 * See @ref tutorial_colorselector.
26730 * @brief Add a new colorselector to the parent
26732 * @param parent The parent object
26733 * @return The new object or NULL if it cannot be created
26735 * @ingroup Colorselector
26737 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26739 * Set a color for the colorselector
26741 * @param obj Colorselector object
26742 * @param r r-value of color
26743 * @param g g-value of color
26744 * @param b b-value of color
26745 * @param a a-value of color
26747 * @ingroup Colorselector
26749 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26751 * Get a color from the colorselector
26753 * @param obj Colorselector object
26754 * @param r integer pointer for r-value of color
26755 * @param g integer pointer for g-value of color
26756 * @param b integer pointer for b-value of color
26757 * @param a integer pointer for a-value of color
26759 * @ingroup Colorselector
26761 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26767 * @defgroup Ctxpopup Ctxpopup
26769 * @image html img/widget/ctxpopup/preview-00.png
26770 * @image latex img/widget/ctxpopup/preview-00.eps
26772 * @brief Context popup widet.
26774 * A ctxpopup is a widget that, when shown, pops up a list of items.
26775 * It automatically chooses an area inside its parent object's view
26776 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26777 * optimally fit into it. In the default theme, it will also point an
26778 * arrow to it's top left position at the time one shows it. Ctxpopup
26779 * items have a label and/or an icon. It is intended for a small
26780 * number of items (hence the use of list, not genlist).
26782 * @note Ctxpopup is a especialization of @ref Hover.
26784 * Signals that you can add callbacks for are:
26785 * "dismissed" - the ctxpopup was dismissed
26787 * Default contents parts of the ctxpopup widget that you can use for are:
26788 * @li "default" - A content of the ctxpopup
26790 * Default contents parts of the naviframe items that you can use for are:
26791 * @li "icon" - An icon in the title area
26793 * Default text parts of the naviframe items that you can use for are:
26794 * @li "default" - Title label in the title area
26796 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26799 typedef enum _Elm_Ctxpopup_Direction
26801 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26803 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26804 the clicked area */
26805 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26806 the clicked area */
26807 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26809 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26810 } Elm_Ctxpopup_Direction;
26813 * @brief Add a new Ctxpopup object to the parent.
26815 * @param parent Parent object
26816 * @return New object or @c NULL, if it cannot be created
26818 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26820 * @brief Set the Ctxpopup's parent
26822 * @param obj The ctxpopup object
26823 * @param area The parent to use
26825 * Set the parent object.
26827 * @note elm_ctxpopup_add() will automatically call this function
26828 * with its @c parent argument.
26830 * @see elm_ctxpopup_add()
26831 * @see elm_hover_parent_set()
26833 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26835 * @brief Get the Ctxpopup's parent
26837 * @param obj The ctxpopup object
26839 * @see elm_ctxpopup_hover_parent_set() for more information
26841 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26843 * @brief Clear all items in the given ctxpopup object.
26845 * @param obj Ctxpopup object
26847 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26849 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26851 * @param obj Ctxpopup object
26852 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26854 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26856 * @brief Get the value of current ctxpopup object's orientation.
26858 * @param obj Ctxpopup object
26859 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26861 * @see elm_ctxpopup_horizontal_set()
26863 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26865 * @brief Add a new item to a ctxpopup object.
26867 * @param obj Ctxpopup object
26868 * @param icon Icon to be set on new item
26869 * @param label The Label of the new item
26870 * @param func Convenience function called when item selected
26871 * @param data Data passed to @p func
26872 * @return A handle to the item added or @c NULL, on errors
26874 * @warning Ctxpopup can't hold both an item list and a content at the same
26875 * time. When an item is added, any previous content will be removed.
26877 * @see elm_ctxpopup_content_set()
26879 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);
26881 * @brief Delete the given item in a ctxpopup object.
26883 * @param it Ctxpopup item to be deleted
26885 * @see elm_ctxpopup_item_append()
26887 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26889 * @brief Set the ctxpopup item's state as disabled or enabled.
26891 * @param it Ctxpopup item to be enabled/disabled
26892 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26894 * When disabled the item is greyed out to indicate it's state.
26895 * @deprecated use elm_object_item_disabled_set() instead
26897 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26899 * @brief Get the ctxpopup item's disabled/enabled state.
26901 * @param it Ctxpopup item to be enabled/disabled
26902 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26904 * @see elm_ctxpopup_item_disabled_set()
26905 * @deprecated use elm_object_item_disabled_get() instead
26907 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26909 * @brief Get the icon object for the given ctxpopup item.
26911 * @param it Ctxpopup item
26912 * @return icon object or @c NULL, if the item does not have icon or an error
26915 * @see elm_ctxpopup_item_append()
26916 * @see elm_ctxpopup_item_icon_set()
26918 * @deprecated use elm_object_item_part_content_get() instead
26920 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26922 * @brief Sets the side icon associated with the ctxpopup item
26924 * @param it Ctxpopup item
26925 * @param icon Icon object to be set
26927 * Once the icon object is set, a previously set one will be deleted.
26928 * @warning Setting the same icon for two items will cause the icon to
26929 * dissapear from the first item.
26931 * @see elm_ctxpopup_item_append()
26933 * @deprecated use elm_object_item_part_content_set() instead
26936 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26938 * @brief Get the label for the given ctxpopup item.
26940 * @param it Ctxpopup item
26941 * @return label string or @c NULL, if the item does not have label or an
26944 * @see elm_ctxpopup_item_append()
26945 * @see elm_ctxpopup_item_label_set()
26947 * @deprecated use elm_object_item_text_get() instead
26949 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26951 * @brief (Re)set the label on the given ctxpopup item.
26953 * @param it Ctxpopup item
26954 * @param label String to set as label
26956 * @deprecated use elm_object_item_text_set() instead
26958 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26960 * @brief Set an elm widget as the content of the ctxpopup.
26962 * @param obj Ctxpopup object
26963 * @param content Content to be swallowed
26965 * If the content object is already set, a previous one will bedeleted. If
26966 * you want to keep that old content object, use the
26967 * elm_ctxpopup_content_unset() function.
26969 * @warning Ctxpopup can't hold both a item list and a content at the same
26970 * time. When a content is set, any previous items will be removed.
26972 * @deprecated use elm_object_content_set() instead
26975 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26977 * @brief Unset the ctxpopup content
26979 * @param obj Ctxpopup object
26980 * @return The content that was being used
26982 * Unparent and return the content object which was set for this widget.
26984 * @deprecated use elm_object_content_unset()
26986 * @see elm_ctxpopup_content_set()
26988 * @deprecated use elm_object_content_unset() instead
26991 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26993 * @brief Set the direction priority of a ctxpopup.
26995 * @param obj Ctxpopup object
26996 * @param first 1st priority of direction
26997 * @param second 2nd priority of direction
26998 * @param third 3th priority of direction
26999 * @param fourth 4th priority of direction
27001 * This functions gives a chance to user to set the priority of ctxpopup
27002 * showing direction. This doesn't guarantee the ctxpopup will appear in the
27003 * requested direction.
27005 * @see Elm_Ctxpopup_Direction
27007 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);
27009 * @brief Get the direction priority of a ctxpopup.
27011 * @param obj Ctxpopup object
27012 * @param first 1st priority of direction to be returned
27013 * @param second 2nd priority of direction to be returned
27014 * @param third 3th priority of direction to be returned
27015 * @param fourth 4th priority of direction to be returned
27017 * @see elm_ctxpopup_direction_priority_set() for more information.
27019 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);
27022 * @brief Get the current direction of a ctxpopup.
27024 * @param obj Ctxpopup object
27025 * @return current direction of a ctxpopup
27027 * @warning Once the ctxpopup showed up, the direction would be determined
27029 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27038 * @defgroup Transit Transit
27039 * @ingroup Elementary
27041 * Transit is designed to apply various animated transition effects to @c
27042 * Evas_Object, such like translation, rotation, etc. For using these
27043 * effects, create an @ref Elm_Transit and add the desired transition effects.
27045 * Once the effects are added into transit, they will be automatically
27046 * managed (their callback will be called until the duration is ended, and
27047 * they will be deleted on completion).
27051 * Elm_Transit *trans = elm_transit_add();
27052 * elm_transit_object_add(trans, obj);
27053 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27054 * elm_transit_duration_set(transit, 1);
27055 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27056 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27057 * elm_transit_repeat_times_set(transit, 3);
27060 * Some transition effects are used to change the properties of objects. They
27062 * @li @ref elm_transit_effect_translation_add
27063 * @li @ref elm_transit_effect_color_add
27064 * @li @ref elm_transit_effect_rotation_add
27065 * @li @ref elm_transit_effect_wipe_add
27066 * @li @ref elm_transit_effect_zoom_add
27067 * @li @ref elm_transit_effect_resizing_add
27069 * Other transition effects are used to make one object disappear and another
27070 * object appear on its old place. These effects are:
27072 * @li @ref elm_transit_effect_flip_add
27073 * @li @ref elm_transit_effect_resizable_flip_add
27074 * @li @ref elm_transit_effect_fade_add
27075 * @li @ref elm_transit_effect_blend_add
27077 * It's also possible to make a transition chain with @ref
27078 * elm_transit_chain_transit_add.
27080 * @warning We strongly recommend to use elm_transit just when edje can not do
27081 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27082 * animations can be manipulated inside the theme.
27084 * List of examples:
27085 * @li @ref transit_example_01_explained
27086 * @li @ref transit_example_02_explained
27087 * @li @ref transit_example_03_c
27088 * @li @ref transit_example_04_c
27094 * @enum Elm_Transit_Tween_Mode
27096 * The type of acceleration used in the transition.
27100 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27101 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27102 over time, then decrease again
27104 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27106 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27108 } Elm_Transit_Tween_Mode;
27111 * @enum Elm_Transit_Effect_Flip_Axis
27113 * The axis where flip effect should be applied.
27117 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27118 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27119 } Elm_Transit_Effect_Flip_Axis;
27121 * @enum Elm_Transit_Effect_Wipe_Dir
27123 * The direction where the wipe effect should occur.
27127 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27128 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27129 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27130 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27131 } Elm_Transit_Effect_Wipe_Dir;
27132 /** @enum Elm_Transit_Effect_Wipe_Type
27134 * Whether the wipe effect should show or hide the object.
27138 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27140 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27142 } Elm_Transit_Effect_Wipe_Type;
27145 * @typedef Elm_Transit
27147 * The Transit created with elm_transit_add(). This type has the information
27148 * about the objects which the transition will be applied, and the
27149 * transition effects that will be used. It also contains info about
27150 * duration, number of repetitions, auto-reverse, etc.
27152 typedef struct _Elm_Transit Elm_Transit;
27153 typedef void Elm_Transit_Effect;
27155 * @typedef Elm_Transit_Effect_Transition_Cb
27157 * Transition callback called for this effect on each transition iteration.
27159 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27161 * Elm_Transit_Effect_End_Cb
27163 * Transition callback called for this effect when the transition is over.
27165 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27168 * Elm_Transit_Del_Cb
27170 * A callback called when the transit is deleted.
27172 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27177 * @note Is not necessary to delete the transit object, it will be deleted at
27178 * the end of its operation.
27179 * @note The transit will start playing when the program enter in the main loop, is not
27180 * necessary to give a start to the transit.
27182 * @return The transit object.
27186 EAPI Elm_Transit *elm_transit_add(void);
27189 * Stops the animation and delete the @p transit object.
27191 * Call this function if you wants to stop the animation before the duration
27192 * time. Make sure the @p transit object is still alive with
27193 * elm_transit_del_cb_set() function.
27194 * All added effects will be deleted, calling its repective data_free_cb
27195 * functions. The function setted by elm_transit_del_cb_set() will be called.
27197 * @see elm_transit_del_cb_set()
27199 * @param transit The transit object to be deleted.
27202 * @warning Just call this function if you are sure the transit is alive.
27204 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27207 * Add a new effect to the transit.
27209 * @note The cb function and the data are the key to the effect. If you try to
27210 * add an already added effect, nothing is done.
27211 * @note After the first addition of an effect in @p transit, if its
27212 * effect list become empty again, the @p transit will be killed by
27213 * elm_transit_del(transit) function.
27217 * Elm_Transit *transit = elm_transit_add();
27218 * elm_transit_effect_add(transit,
27219 * elm_transit_effect_blend_op,
27220 * elm_transit_effect_blend_context_new(),
27221 * elm_transit_effect_blend_context_free);
27224 * @param transit The transit object.
27225 * @param transition_cb The operation function. It is called when the
27226 * animation begins, it is the function that actually performs the animation.
27227 * It is called with the @p data, @p transit and the time progression of the
27228 * animation (a double value between 0.0 and 1.0).
27229 * @param effect The context data of the effect.
27230 * @param end_cb The function to free the context data, it will be called
27231 * at the end of the effect, it must finalize the animation and free the
27235 * @warning The transit free the context data at the and of the transition with
27236 * the data_free_cb function, do not use the context data in another transit.
27238 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);
27241 * Delete an added effect.
27243 * This function will remove the effect from the @p transit, calling the
27244 * data_free_cb to free the @p data.
27246 * @see elm_transit_effect_add()
27248 * @note If the effect is not found, nothing is done.
27249 * @note If the effect list become empty, this function will call
27250 * elm_transit_del(transit), that is, it will kill the @p transit.
27252 * @param transit The transit object.
27253 * @param transition_cb The operation function.
27254 * @param effect The context data of the effect.
27258 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);
27261 * Add new object to apply the effects.
27263 * @note After the first addition of an object in @p transit, if its
27264 * object list become empty again, the @p transit will be killed by
27265 * elm_transit_del(transit) function.
27266 * @note If the @p obj belongs to another transit, the @p obj will be
27267 * removed from it and it will only belong to the @p transit. If the old
27268 * transit stays without objects, it will die.
27269 * @note When you add an object into the @p transit, its state from
27270 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27271 * transit ends, if you change this state whith evas_object_pass_events_set()
27272 * after add the object, this state will change again when @p transit stops to
27275 * @param transit The transit object.
27276 * @param obj Object to be animated.
27279 * @warning It is not allowed to add a new object after transit begins to go.
27281 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27284 * Removes an added object from the transit.
27286 * @note If the @p obj is not in the @p transit, nothing is done.
27287 * @note If the list become empty, this function will call
27288 * elm_transit_del(transit), that is, it will kill the @p transit.
27290 * @param transit The transit object.
27291 * @param obj Object to be removed from @p transit.
27294 * @warning It is not allowed to remove objects after transit begins to go.
27296 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27299 * Get the objects of the transit.
27301 * @param transit The transit object.
27302 * @return a Eina_List with the objects from the transit.
27306 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27309 * Enable/disable keeping up the objects states.
27310 * If it is not kept, the objects states will be reset when transition ends.
27312 * @note @p transit can not be NULL.
27313 * @note One state includes geometry, color, map data.
27315 * @param transit The transit object.
27316 * @param state_keep Keeping or Non Keeping.
27320 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27323 * Get a value whether the objects states will be reset or not.
27325 * @note @p transit can not be NULL
27327 * @see elm_transit_objects_final_state_keep_set()
27329 * @param transit The transit object.
27330 * @return EINA_TRUE means the states of the objects will be reset.
27331 * If @p transit is NULL, EINA_FALSE is returned
27335 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27338 * Set the event enabled when transit is operating.
27340 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27341 * events from mouse and keyboard during the animation.
27342 * @note When you add an object with elm_transit_object_add(), its state from
27343 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27344 * transit ends, if you change this state with evas_object_pass_events_set()
27345 * after adding the object, this state will change again when @p transit stops
27348 * @param transit The transit object.
27349 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27350 * ignored otherwise.
27354 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27357 * Get the value of event enabled status.
27359 * @see elm_transit_event_enabled_set()
27361 * @param transit The Transit object
27362 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27363 * EINA_FALSE is returned
27367 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27370 * Set the user-callback function when the transit is deleted.
27372 * @note Using this function twice will overwrite the first function setted.
27373 * @note the @p transit object will be deleted after call @p cb function.
27375 * @param transit The transit object.
27376 * @param cb Callback function pointer. This function will be called before
27377 * the deletion of the transit.
27378 * @param data Callback funtion user data. It is the @p op parameter.
27382 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27385 * Set reverse effect automatically.
27387 * If auto reverse is setted, after running the effects with the progress
27388 * parameter from 0 to 1, it will call the effecs again with the progress
27389 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27390 * where the duration was setted with the function elm_transit_add and
27391 * the repeat with the function elm_transit_repeat_times_set().
27393 * @param transit The transit object.
27394 * @param reverse EINA_TRUE means the auto_reverse is on.
27398 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27401 * Get if the auto reverse is on.
27403 * @see elm_transit_auto_reverse_set()
27405 * @param transit The transit object.
27406 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27407 * EINA_FALSE is returned
27411 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27414 * Set the transit repeat count. Effect will be repeated by repeat count.
27416 * This function sets the number of repetition the transit will run after
27417 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27418 * If the @p repeat is a negative number, it will repeat infinite times.
27420 * @note If this function is called during the transit execution, the transit
27421 * will run @p repeat times, ignoring the times it already performed.
27423 * @param transit The transit object
27424 * @param repeat Repeat count
27428 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27431 * Get the transit repeat count.
27433 * @see elm_transit_repeat_times_set()
27435 * @param transit The Transit object.
27436 * @return The repeat count. If @p transit is NULL
27441 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27444 * Set the transit animation acceleration type.
27446 * This function sets the tween mode of the transit that can be:
27447 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27448 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27449 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27450 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27452 * @param transit The transit object.
27453 * @param tween_mode The tween type.
27457 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27460 * Get the transit animation acceleration type.
27462 * @note @p transit can not be NULL
27464 * @param transit The transit object.
27465 * @return The tween type. If @p transit is NULL
27466 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27470 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27473 * Set the transit animation time
27475 * @note @p transit can not be NULL
27477 * @param transit The transit object.
27478 * @param duration The animation time.
27482 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27485 * Get the transit animation time
27487 * @note @p transit can not be NULL
27489 * @param transit The transit object.
27491 * @return The transit animation time.
27495 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27498 * Starts the transition.
27499 * Once this API is called, the transit begins to measure the time.
27501 * @note @p transit can not be NULL
27503 * @param transit The transit object.
27507 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27510 * Pause/Resume the transition.
27512 * If you call elm_transit_go again, the transit will be started from the
27513 * beginning, and will be unpaused.
27515 * @note @p transit can not be NULL
27517 * @param transit The transit object.
27518 * @param paused Whether the transition should be paused or not.
27522 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27525 * Get the value of paused status.
27527 * @see elm_transit_paused_set()
27529 * @note @p transit can not be NULL
27531 * @param transit The transit object.
27532 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27533 * EINA_FALSE is returned
27537 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27540 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27542 * The value returned is a fraction (current time / total time). It
27543 * represents the progression position relative to the total.
27545 * @note @p transit can not be NULL
27547 * @param transit The transit object.
27549 * @return The time progression value. If @p transit is NULL
27554 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27557 * Makes the chain relationship between two transits.
27559 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27560 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27562 * @param transit The transit object.
27563 * @param chain_transit The chain transit object. This transit will be operated
27564 * after transit is done.
27566 * This function adds @p chain_transit transition to a chain after the @p
27567 * transit, and will be started as soon as @p transit ends. See @ref
27568 * transit_example_02_explained for a full example.
27572 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27575 * Cut off the chain relationship between two transits.
27577 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27578 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27580 * @param transit The transit object.
27581 * @param chain_transit The chain transit object.
27583 * This function remove the @p chain_transit transition from the @p transit.
27587 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27590 * Get the current chain transit list.
27592 * @note @p transit can not be NULL.
27594 * @param transit The transit object.
27595 * @return chain transit list.
27599 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27602 * Add the Resizing Effect to Elm_Transit.
27604 * @note This API is one of the facades. It creates resizing effect context
27605 * and add it's required APIs to elm_transit_effect_add.
27607 * @see elm_transit_effect_add()
27609 * @param transit Transit object.
27610 * @param from_w Object width size when effect begins.
27611 * @param from_h Object height size when effect begins.
27612 * @param to_w Object width size when effect ends.
27613 * @param to_h Object height size when effect ends.
27614 * @return Resizing effect context data.
27618 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);
27621 * Add the Translation Effect to Elm_Transit.
27623 * @note This API is one of the facades. It creates translation effect context
27624 * and add it's required APIs to elm_transit_effect_add.
27626 * @see elm_transit_effect_add()
27628 * @param transit Transit object.
27629 * @param from_dx X Position variation when effect begins.
27630 * @param from_dy Y Position variation when effect begins.
27631 * @param to_dx X Position variation when effect ends.
27632 * @param to_dy Y Position variation when effect ends.
27633 * @return Translation effect context data.
27636 * @warning It is highly recommended just create a transit with this effect when
27637 * the window that the objects of the transit belongs has already been created.
27638 * This is because this effect needs the geometry information about the objects,
27639 * and if the window was not created yet, it can get a wrong information.
27641 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);
27644 * Add the Zoom Effect to Elm_Transit.
27646 * @note This API is one of the facades. It creates zoom effect context
27647 * and add it's required APIs to elm_transit_effect_add.
27649 * @see elm_transit_effect_add()
27651 * @param transit Transit object.
27652 * @param from_rate Scale rate when effect begins (1 is current rate).
27653 * @param to_rate Scale rate when effect ends.
27654 * @return Zoom effect context data.
27657 * @warning It is highly recommended just create a transit with this effect when
27658 * the window that the objects of the transit belongs has already been created.
27659 * This is because this effect needs the geometry information about the objects,
27660 * and if the window was not created yet, it can get a wrong information.
27662 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27665 * Add the Flip Effect to Elm_Transit.
27667 * @note This API is one of the facades. It creates flip effect context
27668 * and add it's required APIs to elm_transit_effect_add.
27669 * @note This effect is applied to each pair of objects in the order they are listed
27670 * in the transit list of objects. The first object in the pair will be the
27671 * "front" object and the second will be the "back" object.
27673 * @see elm_transit_effect_add()
27675 * @param transit Transit object.
27676 * @param axis Flipping Axis(X or Y).
27677 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27678 * @return Flip effect context data.
27681 * @warning It is highly recommended just create a transit with this effect when
27682 * the window that the objects of the transit belongs has already been created.
27683 * This is because this effect needs the geometry information about the objects,
27684 * and if the window was not created yet, it can get a wrong information.
27686 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27689 * Add the Resizable Flip Effect to Elm_Transit.
27691 * @note This API is one of the facades. It creates resizable flip effect context
27692 * and add it's required APIs to elm_transit_effect_add.
27693 * @note This effect is applied to each pair of objects in the order they are listed
27694 * in the transit list of objects. The first object in the pair will be the
27695 * "front" object and the second will be the "back" object.
27697 * @see elm_transit_effect_add()
27699 * @param transit Transit object.
27700 * @param axis Flipping Axis(X or Y).
27701 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27702 * @return Resizable flip effect context data.
27705 * @warning It is highly recommended just create a transit with this effect when
27706 * the window that the objects of the transit belongs has already been created.
27707 * This is because this effect needs the geometry information about the objects,
27708 * and if the window was not created yet, it can get a wrong information.
27710 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27713 * Add the Wipe Effect to Elm_Transit.
27715 * @note This API is one of the facades. It creates wipe effect context
27716 * and add it's required APIs to elm_transit_effect_add.
27718 * @see elm_transit_effect_add()
27720 * @param transit Transit object.
27721 * @param type Wipe type. Hide or show.
27722 * @param dir Wipe Direction.
27723 * @return Wipe effect context data.
27726 * @warning It is highly recommended just create a transit with this effect when
27727 * the window that the objects of the transit belongs has already been created.
27728 * This is because this effect needs the geometry information about the objects,
27729 * and if the window was not created yet, it can get a wrong information.
27731 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27734 * Add the Color Effect to Elm_Transit.
27736 * @note This API is one of the facades. It creates color effect context
27737 * and add it's required APIs to elm_transit_effect_add.
27739 * @see elm_transit_effect_add()
27741 * @param transit Transit object.
27742 * @param from_r RGB R when effect begins.
27743 * @param from_g RGB G when effect begins.
27744 * @param from_b RGB B when effect begins.
27745 * @param from_a RGB A when effect begins.
27746 * @param to_r RGB R when effect ends.
27747 * @param to_g RGB G when effect ends.
27748 * @param to_b RGB B when effect ends.
27749 * @param to_a RGB A when effect ends.
27750 * @return Color effect context data.
27754 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);
27757 * Add the Fade Effect to Elm_Transit.
27759 * @note This API is one of the facades. It creates fade effect context
27760 * and add it's required APIs to elm_transit_effect_add.
27761 * @note This effect is applied to each pair of objects in the order they are listed
27762 * in the transit list of objects. The first object in the pair will be the
27763 * "before" object and the second will be the "after" object.
27765 * @see elm_transit_effect_add()
27767 * @param transit Transit object.
27768 * @return Fade effect context data.
27771 * @warning It is highly recommended just create a transit with this effect when
27772 * the window that the objects of the transit belongs has already been created.
27773 * This is because this effect needs the color information about the objects,
27774 * and if the window was not created yet, it can get a wrong information.
27776 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27779 * Add the Blend Effect to Elm_Transit.
27781 * @note This API is one of the facades. It creates blend effect context
27782 * and add it's required APIs to elm_transit_effect_add.
27783 * @note This effect is applied to each pair of objects in the order they are listed
27784 * in the transit list of objects. The first object in the pair will be the
27785 * "before" object and the second will be the "after" object.
27787 * @see elm_transit_effect_add()
27789 * @param transit Transit object.
27790 * @return Blend effect context data.
27793 * @warning It is highly recommended just create a transit with this effect when
27794 * the window that the objects of the transit belongs has already been created.
27795 * This is because this effect needs the color information about the objects,
27796 * and if the window was not created yet, it can get a wrong information.
27798 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27801 * Add the Rotation Effect to Elm_Transit.
27803 * @note This API is one of the facades. It creates rotation effect context
27804 * and add it's required APIs to elm_transit_effect_add.
27806 * @see elm_transit_effect_add()
27808 * @param transit Transit object.
27809 * @param from_degree Degree when effect begins.
27810 * @param to_degree Degree when effect is ends.
27811 * @return Rotation effect context data.
27814 * @warning It is highly recommended just create a transit with this effect when
27815 * the window that the objects of the transit belongs has already been created.
27816 * This is because this effect needs the geometry information about the objects,
27817 * and if the window was not created yet, it can get a wrong information.
27819 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27822 * Add the ImageAnimation Effect to Elm_Transit.
27824 * @note This API is one of the facades. It creates image animation effect context
27825 * and add it's required APIs to elm_transit_effect_add.
27826 * The @p images parameter is a list images paths. This list and
27827 * its contents will be deleted at the end of the effect by
27828 * elm_transit_effect_image_animation_context_free() function.
27832 * char buf[PATH_MAX];
27833 * Eina_List *images = NULL;
27834 * Elm_Transit *transi = elm_transit_add();
27836 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27837 * images = eina_list_append(images, eina_stringshare_add(buf));
27839 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27840 * images = eina_list_append(images, eina_stringshare_add(buf));
27841 * elm_transit_effect_image_animation_add(transi, images);
27845 * @see elm_transit_effect_add()
27847 * @param transit Transit object.
27848 * @param images Eina_List of images file paths. This list and
27849 * its contents will be deleted at the end of the effect by
27850 * elm_transit_effect_image_animation_context_free() function.
27851 * @return Image Animation effect context data.
27855 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27860 typedef struct _Elm_Store Elm_Store;
27861 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27862 typedef struct _Elm_Store_Item Elm_Store_Item;
27863 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27864 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27865 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27866 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27867 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27868 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27869 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27870 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27872 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27873 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27874 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27875 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27879 ELM_STORE_ITEM_MAPPING_NONE = 0,
27880 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27881 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27882 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27883 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27884 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27885 // can add more here as needed by common apps
27886 ELM_STORE_ITEM_MAPPING_LAST
27887 } Elm_Store_Item_Mapping_Type;
27889 struct _Elm_Store_Item_Mapping_Icon
27891 // FIXME: allow edje file icons
27893 Elm_Icon_Lookup_Order lookup_order;
27894 Eina_Bool standard_name : 1;
27895 Eina_Bool no_scale : 1;
27896 Eina_Bool smooth : 1;
27897 Eina_Bool scale_up : 1;
27898 Eina_Bool scale_down : 1;
27901 struct _Elm_Store_Item_Mapping_Empty
27906 struct _Elm_Store_Item_Mapping_Photo
27911 struct _Elm_Store_Item_Mapping_Custom
27913 Elm_Store_Item_Mapping_Cb func;
27916 struct _Elm_Store_Item_Mapping
27918 Elm_Store_Item_Mapping_Type type;
27923 Elm_Store_Item_Mapping_Empty empty;
27924 Elm_Store_Item_Mapping_Icon icon;
27925 Elm_Store_Item_Mapping_Photo photo;
27926 Elm_Store_Item_Mapping_Custom custom;
27927 // add more types here
27931 struct _Elm_Store_Item_Info
27933 Elm_Genlist_Item_Class *item_class;
27934 const Elm_Store_Item_Mapping *mapping;
27939 struct _Elm_Store_Item_Info_Filesystem
27941 Elm_Store_Item_Info base;
27945 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27946 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27948 EAPI void elm_store_free(Elm_Store *st);
27950 EAPI Elm_Store *elm_store_filesystem_new(void);
27951 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27952 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27953 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27955 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27957 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27958 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27959 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27960 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27961 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27962 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27964 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27965 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27966 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27967 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27968 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27969 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27970 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27973 * @defgroup SegmentControl SegmentControl
27974 * @ingroup Elementary
27976 * @image html img/widget/segment_control/preview-00.png
27977 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27979 * @image html img/segment_control.png
27980 * @image latex img/segment_control.eps width=\textwidth
27982 * Segment control widget is a horizontal control made of multiple segment
27983 * items, each segment item functioning similar to discrete two state button.
27984 * A segment control groups the items together and provides compact
27985 * single button with multiple equal size segments.
27987 * Segment item size is determined by base widget
27988 * size and the number of items added.
27989 * Only one segment item can be at selected state. A segment item can display
27990 * combination of Text and any Evas_Object like Images or other widget.
27992 * Smart callbacks one can listen to:
27993 * - "changed" - When the user clicks on a segment item which is not
27994 * previously selected and get selected. The event_info parameter is the
27995 * segment item pointer.
27997 * Available styles for it:
28000 * Here is an example on its usage:
28001 * @li @ref segment_control_example
28005 * @addtogroup SegmentControl
28009 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28012 * Add a new segment control widget to the given parent Elementary
28013 * (container) object.
28015 * @param parent The parent object.
28016 * @return a new segment control widget handle or @c NULL, on errors.
28018 * This function inserts a new segment control widget on the canvas.
28020 * @ingroup SegmentControl
28022 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28025 * Append a new item to the segment control object.
28027 * @param obj The segment control object.
28028 * @param icon The icon object to use for the left side of the item. An
28029 * icon can be any Evas object, but usually it is an icon created
28030 * with elm_icon_add().
28031 * @param label The label of the item.
28032 * Note that, NULL is different from empty string "".
28033 * @return The created item or @c NULL upon failure.
28035 * A new item will be created and appended to the segment control, i.e., will
28036 * be set as @b last item.
28038 * If it should be inserted at another position,
28039 * elm_segment_control_item_insert_at() should be used instead.
28041 * Items created with this function can be deleted with function
28042 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28044 * @note @p label set to @c NULL is different from empty string "".
28046 * only has icon, it will be displayed bigger and centered. If it has
28047 * icon and label, even that an empty string, icon will be smaller and
28048 * positioned at left.
28052 * sc = elm_segment_control_add(win);
28053 * ic = elm_icon_add(win);
28054 * elm_icon_file_set(ic, "path/to/image", NULL);
28055 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28056 * elm_segment_control_item_add(sc, ic, "label");
28057 * evas_object_show(sc);
28060 * @see elm_segment_control_item_insert_at()
28061 * @see elm_segment_control_item_del()
28063 * @ingroup SegmentControl
28065 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28068 * Insert a new item to the segment control object at specified position.
28070 * @param obj The segment control object.
28071 * @param icon The icon object to use for the left side of the item. An
28072 * icon can be any Evas object, but usually it is an icon created
28073 * with elm_icon_add().
28074 * @param label The label of the item.
28075 * @param index Item position. Value should be between 0 and items count.
28076 * @return The created item or @c NULL upon failure.
28078 * Index values must be between @c 0, when item will be prepended to
28079 * segment control, and items count, that can be get with
28080 * elm_segment_control_item_count_get(), case when item will be appended
28081 * to segment control, just like elm_segment_control_item_add().
28083 * Items created with this function can be deleted with function
28084 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28086 * @note @p label set to @c NULL is different from empty string "".
28088 * only has icon, it will be displayed bigger and centered. If it has
28089 * icon and label, even that an empty string, icon will be smaller and
28090 * positioned at left.
28092 * @see elm_segment_control_item_add()
28093 * @see elm_segment_control_item_count_get()
28094 * @see elm_segment_control_item_del()
28096 * @ingroup SegmentControl
28098 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);
28101 * Remove a segment control item from its parent, deleting it.
28103 * @param it The item to be removed.
28105 * Items can be added with elm_segment_control_item_add() or
28106 * elm_segment_control_item_insert_at().
28108 * @ingroup SegmentControl
28110 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28113 * Remove a segment control item at given index from its parent,
28116 * @param obj The segment control object.
28117 * @param index The position of the segment control item to be deleted.
28119 * Items can be added with elm_segment_control_item_add() or
28120 * elm_segment_control_item_insert_at().
28122 * @ingroup SegmentControl
28124 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28127 * Get the Segment items count from segment control.
28129 * @param obj The segment control object.
28130 * @return Segment items count.
28132 * It will just return the number of items added to segment control @p obj.
28134 * @ingroup SegmentControl
28136 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28139 * Get the item placed at specified index.
28141 * @param obj The segment control object.
28142 * @param index The index of the segment item.
28143 * @return The segment control item or @c NULL on failure.
28145 * Index is the position of an item in segment control widget. Its
28146 * range is from @c 0 to <tt> count - 1 </tt>.
28147 * Count is the number of items, that can be get with
28148 * elm_segment_control_item_count_get().
28150 * @ingroup SegmentControl
28152 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28155 * Get the label of item.
28157 * @param obj The segment control object.
28158 * @param index The index of the segment item.
28159 * @return The label of the item at @p index.
28161 * The return value is a pointer to the label associated to the item when
28162 * it was created, with function elm_segment_control_item_add(), or later
28163 * with function elm_segment_control_item_label_set. If no label
28164 * was passed as argument, it will return @c NULL.
28166 * @see elm_segment_control_item_label_set() for more details.
28167 * @see elm_segment_control_item_add()
28169 * @ingroup SegmentControl
28171 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28174 * Set the label of item.
28176 * @param it The item of segment control.
28177 * @param text The label of item.
28179 * The label to be displayed by the item.
28180 * Label will be at right of the icon (if set).
28182 * If a label was passed as argument on item creation, with function
28183 * elm_control_segment_item_add(), it will be already
28184 * displayed by the item.
28186 * @see elm_segment_control_item_label_get()
28187 * @see elm_segment_control_item_add()
28189 * @ingroup SegmentControl
28191 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28194 * Get the icon associated to the item.
28196 * @param obj The segment control object.
28197 * @param index The index of the segment item.
28198 * @return The left side icon associated to the item at @p index.
28200 * The return value is a pointer to the icon associated to the item when
28201 * it was created, with function elm_segment_control_item_add(), or later
28202 * with function elm_segment_control_item_icon_set(). If no icon
28203 * was passed as argument, it will return @c NULL.
28205 * @see elm_segment_control_item_add()
28206 * @see elm_segment_control_item_icon_set()
28208 * @ingroup SegmentControl
28210 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28213 * Set the icon associated to the item.
28215 * @param it The segment control item.
28216 * @param icon The icon object to associate with @p it.
28218 * The icon object to use at left side of the item. An
28219 * icon can be any Evas object, but usually it is an icon created
28220 * with elm_icon_add().
28222 * Once the icon object is set, a previously set one will be deleted.
28223 * @warning Setting the same icon for two items will cause the icon to
28224 * dissapear from the first item.
28226 * If an icon was passed as argument on item creation, with function
28227 * elm_segment_control_item_add(), it will be already
28228 * associated to the item.
28230 * @see elm_segment_control_item_add()
28231 * @see elm_segment_control_item_icon_get()
28233 * @ingroup SegmentControl
28235 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28238 * Get the index of an item.
28240 * @param it The segment control item.
28241 * @return The position of item in segment control widget.
28243 * Index is the position of an item in segment control widget. Its
28244 * range is from @c 0 to <tt> count - 1 </tt>.
28245 * Count is the number of items, that can be get with
28246 * elm_segment_control_item_count_get().
28248 * @ingroup SegmentControl
28250 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28253 * Get the base object of the item.
28255 * @param it The segment control item.
28256 * @return The base object associated with @p it.
28258 * Base object is the @c Evas_Object that represents that item.
28260 * @ingroup SegmentControl
28262 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28265 * Get the selected item.
28267 * @param obj The segment control object.
28268 * @return The selected item or @c NULL if none of segment items is
28271 * The selected item can be unselected with function
28272 * elm_segment_control_item_selected_set().
28274 * The selected item always will be highlighted on segment control.
28276 * @ingroup SegmentControl
28278 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28281 * Set the selected state of an item.
28283 * @param it The segment control item
28284 * @param select The selected state
28286 * This sets the selected state of the given item @p it.
28287 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28289 * If a new item is selected the previosly selected will be unselected.
28290 * Previoulsy selected item can be get with function
28291 * elm_segment_control_item_selected_get().
28293 * The selected item always will be highlighted on segment control.
28295 * @see elm_segment_control_item_selected_get()
28297 * @ingroup SegmentControl
28299 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28306 * @defgroup Grid Grid
28308 * The grid is a grid layout widget that lays out a series of children as a
28309 * fixed "grid" of widgets using a given percentage of the grid width and
28310 * height each using the child object.
28312 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28313 * widgets size itself. The default is 100 x 100, so that means the
28314 * position and sizes of children will effectively be percentages (0 to 100)
28315 * of the width or height of the grid widget
28321 * Add a new grid to the parent
28323 * @param parent The parent object
28324 * @return The new object or NULL if it cannot be created
28328 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28331 * Set the virtual size of the grid
28333 * @param obj The grid object
28334 * @param w The virtual width of the grid
28335 * @param h The virtual height of the grid
28339 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28342 * Get the virtual size of the grid
28344 * @param obj The grid object
28345 * @param w Pointer to integer to store the virtual width of the grid
28346 * @param h Pointer to integer to store the virtual height of the grid
28350 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28353 * Pack child at given position and size
28355 * @param obj The grid object
28356 * @param subobj The child to pack
28357 * @param x The virtual x coord at which to pack it
28358 * @param y The virtual y coord at which to pack it
28359 * @param w The virtual width at which to pack it
28360 * @param h The virtual height at which to pack it
28364 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28367 * Unpack a child from a grid object
28369 * @param obj The grid object
28370 * @param subobj The child to unpack
28374 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28377 * Faster way to remove all child objects from a grid object.
28379 * @param obj The grid object
28380 * @param clear If true, it will delete just removed children
28384 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28387 * Set packing of an existing child at to position and size
28389 * @param subobj The child to set packing of
28390 * @param x The virtual x coord at which to pack it
28391 * @param y The virtual y coord at which to pack it
28392 * @param w The virtual width at which to pack it
28393 * @param h The virtual height at which to pack it
28397 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28400 * get packing of a child
28402 * @param subobj The child to query
28403 * @param x Pointer to integer to store the virtual x coord
28404 * @param y Pointer to integer to store the virtual y coord
28405 * @param w Pointer to integer to store the virtual width
28406 * @param h Pointer to integer to store the virtual height
28410 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28416 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28417 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28418 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28419 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28420 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28421 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28424 * @defgroup Video Video
28426 * @addtogroup Video
28429 * Elementary comes with two object that help design application that need
28430 * to display video. The main one, Elm_Video, display a video by using Emotion.
28431 * It does embedded the video inside an Edje object, so you can do some
28432 * animation depending on the video state change. It does also implement a
28433 * ressource management policy to remove this burden from the application writer.
28435 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28436 * It take care of updating its content according to Emotion event and provide a
28437 * way to theme itself. It also does automatically raise the priority of the
28438 * linked Elm_Video so it will use the video decoder if available. It also does
28439 * activate the remember function on the linked Elm_Video object.
28441 * Signals that you can add callback for are :
28443 * "forward,clicked" - the user clicked the forward button.
28444 * "info,clicked" - the user clicked the info button.
28445 * "next,clicked" - the user clicked the next button.
28446 * "pause,clicked" - the user clicked the pause button.
28447 * "play,clicked" - the user clicked the play button.
28448 * "prev,clicked" - the user clicked the prev button.
28449 * "rewind,clicked" - the user clicked the rewind button.
28450 * "stop,clicked" - the user clicked the stop button.
28452 * Default contents parts of the player widget that you can use for are:
28453 * @li "video" - A video of the player
28458 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28460 * @param parent The parent object
28461 * @return a new player widget handle or @c NULL, on errors.
28463 * This function inserts a new player widget on the canvas.
28465 * @see elm_object_part_content_set()
28469 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28472 * @brief Link a Elm_Payer with an Elm_Video object.
28474 * @param player the Elm_Player object.
28475 * @param video The Elm_Video object.
28477 * This mean that action on the player widget will affect the
28478 * video object and the state of the video will be reflected in
28479 * the player itself.
28481 * @see elm_player_add()
28482 * @see elm_video_add()
28483 * @deprecated use elm_object_part_content_set() instead
28487 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28490 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28492 * @param parent The parent object
28493 * @return a new video widget handle or @c NULL, on errors.
28495 * This function inserts a new video widget on the canvas.
28497 * @seeelm_video_file_set()
28498 * @see elm_video_uri_set()
28502 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28505 * @brief Define the file that will be the video source.
28507 * @param video The video object to define the file for.
28508 * @param filename The file to target.
28510 * This function will explicitly define a filename as a source
28511 * for the video of the Elm_Video object.
28513 * @see elm_video_uri_set()
28514 * @see elm_video_add()
28515 * @see elm_player_add()
28519 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28522 * @brief Define the uri that will be the video source.
28524 * @param video The video object to define the file for.
28525 * @param uri The uri to target.
28527 * This function will define an uri as a source for the video of the
28528 * Elm_Video object. URI could be remote source of video, like http:// or local source
28529 * like for example WebCam who are most of the time v4l2:// (but that depend and
28530 * you should use Emotion API to request and list the available Webcam on your system).
28532 * @see elm_video_file_set()
28533 * @see elm_video_add()
28534 * @see elm_player_add()
28538 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28541 * @brief Get the underlying Emotion object.
28543 * @param video The video object to proceed the request on.
28544 * @return the underlying Emotion object.
28548 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28551 * @brief Start to play the video
28553 * @param video The video object to proceed the request on.
28555 * Start to play the video and cancel all suspend state.
28559 EAPI void elm_video_play(Evas_Object *video);
28562 * @brief Pause the video
28564 * @param video The video object to proceed the request on.
28566 * Pause the video and start a timer to trigger suspend mode.
28570 EAPI void elm_video_pause(Evas_Object *video);
28573 * @brief Stop the video
28575 * @param video The video object to proceed the request on.
28577 * Stop the video and put the emotion in deep sleep mode.
28581 EAPI void elm_video_stop(Evas_Object *video);
28584 * @brief Is the video actually playing.
28586 * @param video The video object to proceed the request on.
28587 * @return EINA_TRUE if the video is actually playing.
28589 * You should consider watching event on the object instead of polling
28590 * the object state.
28594 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28597 * @brief Is it possible to seek inside the video.
28599 * @param video The video object to proceed the request on.
28600 * @return EINA_TRUE if is possible to seek inside the video.
28604 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28607 * @brief Is the audio muted.
28609 * @param video The video object to proceed the request on.
28610 * @return EINA_TRUE if the audio is muted.
28614 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28617 * @brief Change the mute state of the Elm_Video object.
28619 * @param video The video object to proceed the request on.
28620 * @param mute The new mute state.
28624 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28627 * @brief Get the audio level of the current video.
28629 * @param video The video object to proceed the request on.
28630 * @return the current audio level.
28634 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28637 * @brief Set the audio level of anElm_Video object.
28639 * @param video The video object to proceed the request on.
28640 * @param volume The new audio volume.
28644 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28646 EAPI double elm_video_play_position_get(const Evas_Object *video);
28647 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28648 EAPI double elm_video_play_length_get(const Evas_Object *video);
28649 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28650 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28651 EAPI const char *elm_video_title_get(const Evas_Object *video);
28657 * @defgroup Naviframe Naviframe
28658 * @ingroup Elementary
28660 * @brief Naviframe is a kind of view manager for the applications.
28662 * Naviframe provides functions to switch different pages with stack
28663 * mechanism. It means if one page(item) needs to be changed to the new one,
28664 * then naviframe would push the new page to it's internal stack. Of course,
28665 * it can be back to the previous page by popping the top page. Naviframe
28666 * provides some transition effect while the pages are switching (same as
28669 * Since each item could keep the different styles, users could keep the
28670 * same look & feel for the pages or different styles for the items in it's
28673 * Signals that you can add callback for are:
28674 * @li "transition,finished" - When the transition is finished in changing
28676 * @li "title,clicked" - User clicked title area
28678 * Default contents parts of the naviframe items that you can use for are:
28679 * @li "default" - A main content of the page
28680 * @li "icon" - An icon in the title area
28681 * @li "prev_btn" - A button to go to the previous page
28682 * @li "next_btn" - A button to go to the next page
28684 * Default text parts of the naviframe items that you can use for are:
28685 * @li "default" - Title label in the title area
28686 * @li "subtitle" - Sub-title label in the title area
28688 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28692 * @addtogroup Naviframe
28697 * @brief Add a new Naviframe object to the parent.
28699 * @param parent Parent object
28700 * @return New object or @c NULL, if it cannot be created
28702 * @ingroup Naviframe
28704 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28706 * @brief Push a new item to the top of the naviframe stack (and show it).
28708 * @param obj The naviframe object
28709 * @param title_label The label in the title area. The name of the title
28710 * label part is "elm.text.title"
28711 * @param prev_btn The button to go to the previous item. If it is NULL,
28712 * then naviframe will create a back button automatically. The name of
28713 * the prev_btn part is "elm.swallow.prev_btn"
28714 * @param next_btn The button to go to the next item. Or It could be just an
28715 * extra function button. The name of the next_btn part is
28716 * "elm.swallow.next_btn"
28717 * @param content The main content object. The name of content part is
28718 * "elm.swallow.content"
28719 * @param item_style The current item style name. @c NULL would be default.
28720 * @return The created item or @c NULL upon failure.
28722 * The item pushed becomes one page of the naviframe, this item will be
28723 * deleted when it is popped.
28725 * @see also elm_naviframe_item_style_set()
28726 * @see also elm_naviframe_item_insert_before()
28727 * @see also elm_naviframe_item_insert_after()
28729 * The following styles are available for this item:
28732 * @ingroup Naviframe
28734 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);
28736 * @brief Insert a new item into the naviframe before item @p before.
28738 * @param before The naviframe item to insert before.
28739 * @param title_label The label in the title area. The name of the title
28740 * label part is "elm.text.title"
28741 * @param prev_btn The button to go to the previous item. If it is NULL,
28742 * then naviframe will create a back button automatically. The name of
28743 * the prev_btn part is "elm.swallow.prev_btn"
28744 * @param next_btn The button to go to the next item. Or It could be just an
28745 * extra function button. The name of the next_btn part is
28746 * "elm.swallow.next_btn"
28747 * @param content The main content object. The name of content part is
28748 * "elm.swallow.content"
28749 * @param item_style The current item style name. @c NULL would be default.
28750 * @return The created item or @c NULL upon failure.
28752 * The item is inserted into the naviframe straight away without any
28753 * transition operations. This item will be deleted when it is popped.
28755 * @see also elm_naviframe_item_style_set()
28756 * @see also elm_naviframe_item_push()
28757 * @see also elm_naviframe_item_insert_after()
28759 * The following styles are available for this item:
28762 * @ingroup Naviframe
28764 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);
28766 * @brief Insert a new item into the naviframe after item @p after.
28768 * @param after The naviframe item to insert after.
28769 * @param title_label The label in the title area. The name of the title
28770 * label part is "elm.text.title"
28771 * @param prev_btn The button to go to the previous item. If it is NULL,
28772 * then naviframe will create a back button automatically. The name of
28773 * the prev_btn part is "elm.swallow.prev_btn"
28774 * @param next_btn The button to go to the next item. Or It could be just an
28775 * extra function button. The name of the next_btn part is
28776 * "elm.swallow.next_btn"
28777 * @param content The main content object. The name of content part is
28778 * "elm.swallow.content"
28779 * @param item_style The current item style name. @c NULL would be default.
28780 * @return The created item or @c NULL upon failure.
28782 * The item is inserted into the naviframe straight away without any
28783 * transition operations. This item will be deleted when it is popped.
28785 * @see also elm_naviframe_item_style_set()
28786 * @see also elm_naviframe_item_push()
28787 * @see also elm_naviframe_item_insert_before()
28789 * The following styles are available for this item:
28792 * @ingroup Naviframe
28794 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);
28796 * @brief Pop an item that is on top of the stack
28798 * @param obj The naviframe object
28799 * @return @c NULL or the content object(if the
28800 * elm_naviframe_content_preserve_on_pop_get is true).
28802 * This pops an item that is on the top(visible) of the naviframe, makes it
28803 * disappear, then deletes the item. The item that was underneath it on the
28804 * stack will become visible.
28806 * @see also elm_naviframe_content_preserve_on_pop_get()
28808 * @ingroup Naviframe
28810 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28812 * @brief Pop the items between the top and the above one on the given item.
28814 * @param it The naviframe item
28816 * @ingroup Naviframe
28818 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28820 * Promote an item already in the naviframe stack to the top of the stack
28822 * @param it The naviframe item
28824 * This will take the indicated item and promote it to the top of the stack
28825 * as if it had been pushed there. The item must already be inside the
28826 * naviframe stack to work.
28829 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28831 * @brief Delete the given item instantly.
28833 * @param it The naviframe item
28835 * This just deletes the given item from the naviframe item list instantly.
28836 * So this would not emit any signals for view transitions but just change
28837 * the current view if the given item is a top one.
28839 * @ingroup Naviframe
28841 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28843 * @brief preserve the content objects when items are popped.
28845 * @param obj The naviframe object
28846 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28848 * @see also elm_naviframe_content_preserve_on_pop_get()
28850 * @ingroup Naviframe
28852 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28854 * @brief Get a value whether preserve mode is enabled or not.
28856 * @param obj The naviframe object
28857 * @return If @c EINA_TRUE, preserve mode is enabled
28859 * @see also elm_naviframe_content_preserve_on_pop_set()
28861 * @ingroup Naviframe
28863 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28865 * @brief Get a top item on the naviframe stack
28867 * @param obj The naviframe object
28868 * @return The top item on the naviframe stack or @c NULL, if the stack is
28871 * @ingroup Naviframe
28873 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28875 * @brief Get a bottom item on the naviframe stack
28877 * @param obj The naviframe object
28878 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28881 * @ingroup Naviframe
28883 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28885 * @brief Set an item style
28887 * @param obj The naviframe item
28888 * @param item_style The current item style name. @c NULL would be default
28890 * The following styles are available for this item:
28893 * @see also elm_naviframe_item_style_get()
28895 * @ingroup Naviframe
28897 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28899 * @brief Get an item style
28901 * @param obj The naviframe item
28902 * @return The current item style name
28904 * @see also elm_naviframe_item_style_set()
28906 * @ingroup Naviframe
28908 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28910 * @brief Show/Hide the title area
28912 * @param it The naviframe item
28913 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28916 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28918 * @see also elm_naviframe_item_title_visible_get()
28920 * @ingroup Naviframe
28922 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28924 * @brief Get a value whether title area is visible or not.
28926 * @param it The naviframe item
28927 * @return If @c EINA_TRUE, title area is visible
28929 * @see also elm_naviframe_item_title_visible_set()
28931 * @ingroup Naviframe
28933 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28936 * @brief Set creating prev button automatically or not
28938 * @param obj The naviframe object
28939 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28940 * be created internally when you pass the @c NULL to the prev_btn
28941 * parameter in elm_naviframe_item_push
28943 * @see also elm_naviframe_item_push()
28945 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28947 * @brief Get a value whether prev button(back button) will be auto pushed or
28950 * @param obj The naviframe object
28951 * @return If @c EINA_TRUE, prev button will be auto pushed.
28953 * @see also elm_naviframe_item_push()
28954 * elm_naviframe_prev_btn_auto_pushed_set()
28956 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28958 * @brief Get a list of all the naviframe items.
28960 * @param obj The naviframe object
28961 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28962 * or @c NULL on failure.
28964 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28971 * @defgroup Multibuttonentry Multibuttonentry
28973 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
28974 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
28975 * a new button is added to the next row. When a text button is pressed, it will become focused.
28976 * Backspace removes the focus.
28977 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
28979 * Smart callbacks one can register:
28980 * - @c "item,selected" - when item is selected. May be called on backspace key.
28981 * - @c "item,added" - when a new multibuttonentry item is added.
28982 * - @c "item,deleted" - when a multibuttonentry item is deleted.
28983 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
28984 * - @c "clicked" - when multibuttonentry is clicked.
28985 * - @c "focused" - when multibuttonentry is focused.
28986 * - @c "unfocused" - when multibuttonentry is unfocused.
28987 * - @c "expanded" - when multibuttonentry is expanded.
28988 * - @c "shrank" - when multibuttonentry is shrank.
28989 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
28991 * Here is an example on its usage:
28992 * @li @ref multibuttonentry_example
28995 * @addtogroup Multibuttonentry
28999 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29000 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29003 * @brief Add a new multibuttonentry to the parent
29005 * @param parent The parent object
29006 * @return The new object or NULL if it cannot be created
29009 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29013 * @param obj The multibuttonentry object
29014 * @return The label, or NULL if none
29017 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29021 * @param obj The multibuttonentry object
29022 * @param label The text label string
29025 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29027 * Get the entry of the multibuttonentry object
29029 * @param obj The multibuttonentry object
29030 * @return The entry object, or NULL if none
29033 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29035 * Get the guide text
29037 * @param obj The multibuttonentry object
29038 * @return The guide text, or NULL if none
29041 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29043 * Set the guide text
29045 * @param obj The multibuttonentry object
29046 * @param label The guide text string
29049 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
29051 * Get the value of shrink_mode state.
29053 * @param obj The multibuttonentry object
29054 * @param the value of shrink mode state.
29057 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29059 * Set/Unset the multibuttonentry to shrink mode state of single line
29061 * @param obj The multibuttonentry object
29062 * @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.
29065 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
29067 * Prepend a new item to the multibuttonentry
29069 * @param obj The multibuttonentry object
29070 * @param label The label of new item
29071 * @param data The ponter to the data to be attached
29072 * @return A handle to the item added or NULL if not possible
29075 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29077 * Append a new item to the multibuttonentry
29079 * @param obj The multibuttonentry object
29080 * @param label The label of new item
29081 * @param data The ponter to the data to be attached
29082 * @return A handle to the item added or NULL if not possible
29085 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29087 * Add a new item to the multibuttonentry before the indicated object
29090 * @param obj The multibuttonentry object
29091 * @param before The item before which to add it
29092 * @param label The label of new item
29093 * @param data The ponter to the data to be attached
29094 * @return A handle to the item added or NULL if not possible
29097 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);
29099 * Add a new item to the multibuttonentry after the indicated object
29101 * @param obj The multibuttonentry object
29102 * @param after The item after which to add it
29103 * @param label The label of new item
29104 * @param data The ponter to the data to be attached
29105 * @return A handle to the item added or NULL if not possible
29108 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);
29110 * Get a list of items in the multibuttonentry
29112 * @param obj The multibuttonentry object
29113 * @return The list of items, or NULL if none
29116 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29118 * Get the first item in the multibuttonentry
29120 * @param obj The multibuttonentry object
29121 * @return The first item, or NULL if none
29124 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29126 * Get the last item in the multibuttonentry
29128 * @param obj The multibuttonentry object
29129 * @return The last item, or NULL if none
29132 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29134 * Get the selected item in the multibuttonentry
29136 * @param obj The multibuttonentry object
29137 * @return The selected item, or NULL if none
29140 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29142 * Set the selected state of an item
29144 * @param item The item
29145 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29148 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29150 * unselect all items.
29152 * @param obj The multibuttonentry object
29155 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29157 * Delete a given item
29159 * @param item The item
29162 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29164 * Remove all items in the multibuttonentry.
29166 * @param obj The multibuttonentry object
29169 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29171 * Get the label of a given item
29173 * @param item The item
29174 * @return The label of a given item, or NULL if none
29177 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29179 * Set the label of a given item
29181 * @param item The item
29182 * @param label The text label string
29185 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29187 * Get the previous item in the multibuttonentry
29189 * @param item The item
29190 * @return The item before the item @p item
29193 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29195 * Get the next item in the multibuttonentry
29197 * @param item The item
29198 * @return The item after the item @p item
29201 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29203 * Append a item filter function for text inserted in the Multibuttonentry
29205 * Append the given callback to the list. This functions will be called
29206 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29207 * as a parameter. The callback function is free to alter the text in any way
29208 * it wants, but it must remember to free the given pointer and update it.
29209 * If the new text is to be discarded, the function can free it and set it text
29210 * parameter to NULL. This will also prevent any following filters from being
29213 * @param obj The multibuttonentryentry object
29214 * @param func The function to use as item filter
29215 * @param data User data to pass to @p func
29218 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29220 * Prepend a filter function for text inserted in the Multibuttentry
29222 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29223 * for more information
29225 * @param obj The multibuttonentry object
29226 * @param func The function to use as text filter
29227 * @param data User data to pass to @p func
29230 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29232 * Remove a filter from the list
29234 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29235 * for more information.
29237 * @param obj The multibuttonentry object
29238 * @param func The filter function to remove
29239 * @param data The user data passed when adding the function
29242 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);