3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@@gmail.com>
288 @author Thierry el Borgi <thierry@@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
290 @author Chanwook Jung <joey.jung@@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
293 @author Kim Yunhan <spbear@@gmail.com>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
307 * @brief Elementary's API
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
323 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
325 /* Standard headers for standard system calls etc. */
330 #include <sys/types.h>
331 #include <sys/stat.h>
332 #include <sys/time.h>
333 #include <sys/param.h>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
371 // disabled - evas 1.1 won't have this.
372 //#include <Evas_GL.h>
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
391 # include <Ethumb_Client.h>
403 # ifdef ELEMENTARY_BUILD
405 # define EAPI __declspec(dllexport)
408 # endif /* ! DLL_EXPORT */
410 # define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
415 # define EAPI __attribute__ ((visibility("default")))
422 #endif /* ! _WIN32 */
427 # define EAPI_MAIN EAPI
430 /* allow usage from c++ */
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
438 typedef struct _Elm_Version
446 EAPI extern Elm_Version *elm_version;
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
453 * @defgroup General General
455 * @brief General Elementary API. Functions that don't relate to
456 * Elementary objects specifically.
458 * Here are documented functions which init/shutdown the library,
459 * that apply to generic Elementary objects, that deal with
460 * configuration, et cetera.
462 * @ref general_functions_example_page "This" example contemplates
463 * some of these functions.
467 * @addtogroup General
472 * Defines couple of standard Evas_Object layers to be used
473 * with evas_object_layer_set().
475 * @note whenever extending with new values, try to keep some padding
476 * to siblings so there is room for further extensions.
478 typedef enum _Elm_Object_Layer
480 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488 /**************************************************************************/
489 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492 * Emitted when the application has reconfigured elementary settings due
493 * to an external configuration tool asking it to.
495 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498 * Emitted when any Elementary's policy value is changed.
500 EAPI extern int ELM_EVENT_POLICY_CHANGED;
503 * @typedef Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510 * @struct _Elm_Event_Policy_Changed
512 * Data on the event when an Elementary policy has changed
514 struct _Elm_Event_Policy_Changed
516 unsigned int policy; /**< the policy identifier */
517 int new_value; /**< value the policy had before the change */
518 int old_value; /**< new value the policy got */
522 * Policy identifiers.
524 typedef enum _Elm_Policy
526 ELM_POLICY_QUIT, /**< under which circumstances the application
527 * should quit automatically. @see
531 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
534 typedef enum _Elm_Policy_Quit
536 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
538 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
540 * window is closed */
541 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
543 typedef enum _Elm_Focus_Direction
547 } Elm_Focus_Direction;
549 typedef enum _Elm_Text_Format
551 ELM_TEXT_FORMAT_PLAIN_UTF8,
552 ELM_TEXT_FORMAT_MARKUP_UTF8
556 * Line wrapping types.
558 typedef enum _Elm_Wrap_Type
560 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
561 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
562 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
563 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
569 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
570 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
571 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
572 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
573 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
574 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
575 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
576 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
577 ELM_INPUT_PANEL_LAYOUT_INVALID
578 } Elm_Input_Panel_Layout;
582 ELM_AUTOCAPITAL_TYPE_NONE,
583 ELM_AUTOCAPITAL_TYPE_WORD,
584 ELM_AUTOCAPITAL_TYPE_SENTENCE,
585 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
586 } Elm_Autocapital_Type;
589 * @typedef Elm_Object_Item
590 * An Elementary Object item handle.
593 typedef struct _Elm_Object_Item Elm_Object_Item;
597 * Called back when a widget's tooltip is activated and needs content.
598 * @param data user-data given to elm_object_tooltip_content_cb_set()
599 * @param obj owner widget.
600 * @param tooltip The tooltip object (affix content to this!)
602 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
605 * Called back when a widget's item tooltip is activated and needs content.
606 * @param data user-data given to elm_object_tooltip_content_cb_set()
607 * @param obj owner widget.
608 * @param tooltip The tooltip object (affix content to this!)
609 * @param item context dependent item. As an example, if tooltip was
610 * set on Elm_List_Item, then it is of this type.
612 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
614 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. */
616 #ifndef ELM_LIB_QUICKLAUNCH
617 #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 */
619 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
622 /**************************************************************************/
626 * Initialize Elementary
628 * @param[in] argc System's argument count value
629 * @param[in] argv System's pointer to array of argument strings
630 * @return The init counter value.
632 * This function initializes Elementary and increments a counter of
633 * the number of calls to it. It returns the new counter's value.
635 * @warning This call is exported only for use by the @c ELM_MAIN()
636 * macro. There is no need to use this if you use this macro (which
637 * is highly advisable). An elm_main() should contain the entry
638 * point code for your application, having the same prototype as
639 * elm_init(), and @b not being static (putting the @c EAPI symbol
640 * in front of its type declaration is advisable). The @c
641 * ELM_MAIN() call should be placed just after it.
644 * @dontinclude bg_example_01.c
648 * See the full @ref bg_example_01_c "example".
650 * @see elm_shutdown().
653 EAPI int elm_init(int argc, char **argv);
656 * Shut down Elementary
658 * @return The init counter value.
660 * This should be called at the end of your application, just
661 * before it ceases to do any more processing. This will clean up
662 * any permanent resources your application may have allocated via
663 * Elementary that would otherwise persist.
665 * @see elm_init() for an example
669 EAPI int elm_shutdown(void);
672 * Run Elementary's main loop
674 * This call should be issued just after all initialization is
675 * completed. This function will not return until elm_exit() is
676 * called. It will keep looping, running the main
677 * (event/processing) loop for Elementary.
679 * @see elm_init() for an example
683 EAPI void elm_run(void);
686 * Exit Elementary's main loop
688 * If this call is issued, it will flag the main loop to cease
689 * processing and return back to its parent function (usually your
690 * elm_main() function).
692 * @see elm_init() for an example. There, just after a request to
693 * close the window comes, the main loop will be left.
695 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
696 * applications, you'll be able to get this function called automatically for you.
700 EAPI void elm_exit(void);
703 * Provide information in order to make Elementary determine the @b
704 * run time location of the software in question, so other data files
705 * such as images, sound files, executable utilities, libraries,
706 * modules and locale files can be found.
708 * @param mainfunc This is your application's main function name,
709 * whose binary's location is to be found. Providing @c NULL
710 * will make Elementary not to use it
711 * @param dom This will be used as the application's "domain", in the
712 * form of a prefix to any environment variables that may
713 * override prefix detection and the directory name, inside the
714 * standard share or data directories, where the software's
715 * data files will be looked for.
716 * @param checkfile This is an (optional) magic file's path to check
717 * for existence (and it must be located in the data directory,
718 * under the share directory provided above). Its presence will
719 * help determine the prefix found was correct. Pass @c NULL if
720 * the check is not to be done.
722 * This function allows one to re-locate the application somewhere
723 * else after compilation, if the developer wishes for easier
724 * distribution of pre-compiled binaries.
726 * The prefix system is designed to locate where the given software is
727 * installed (under a common path prefix) at run time and then report
728 * specific locations of this prefix and common directories inside
729 * this prefix like the binary, library, data and locale directories,
730 * through the @c elm_app_*_get() family of functions.
732 * Call elm_app_info_set() early on before you change working
733 * directory or anything about @c argv[0], so it gets accurate
736 * It will then try and trace back which file @p mainfunc comes from,
737 * if provided, to determine the application's prefix directory.
739 * The @p dom parameter provides a string prefix to prepend before
740 * environment variables, allowing a fallback to @b specific
741 * environment variables to locate the software. You would most
742 * probably provide a lowercase string there, because it will also
743 * serve as directory domain, explained next. For environment
744 * variables purposes, this string is made uppercase. For example if
745 * @c "myapp" is provided as the prefix, then the program would expect
746 * @c "MYAPP_PREFIX" as a master environment variable to specify the
747 * exact install prefix for the software, or more specific environment
748 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
749 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
750 * the user or scripts before launching. If not provided (@c NULL),
751 * environment variables will not be used to override compiled-in
752 * defaults or auto detections.
754 * The @p dom string also provides a subdirectory inside the system
755 * shared data directory for data files. For example, if the system
756 * directory is @c /usr/local/share, then this directory name is
757 * appended, creating @c /usr/local/share/myapp, if it @p was @c
758 * "myapp". It is expected that the application installs data files in
761 * The @p checkfile is a file name or path of something inside the
762 * share or data directory to be used to test that the prefix
763 * detection worked. For example, your app will install a wallpaper
764 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
765 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
768 * @see elm_app_compile_bin_dir_set()
769 * @see elm_app_compile_lib_dir_set()
770 * @see elm_app_compile_data_dir_set()
771 * @see elm_app_compile_locale_set()
772 * @see elm_app_prefix_dir_get()
773 * @see elm_app_bin_dir_get()
774 * @see elm_app_lib_dir_get()
775 * @see elm_app_data_dir_get()
776 * @see elm_app_locale_dir_get()
778 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
781 * Provide information on the @b fallback application's binaries
782 * directory, in scenarios where they get overriden by
783 * elm_app_info_set().
785 * @param dir The path to the default binaries directory (compile time
788 * @note Elementary will as well use this path to determine actual
789 * names of binaries' directory paths, maybe changing it to be @c
790 * something/local/bin instead of @c something/bin, only, for
793 * @warning You should call this function @b before
794 * elm_app_info_set().
796 EAPI void elm_app_compile_bin_dir_set(const char *dir);
799 * Provide information on the @b fallback application's libraries
800 * directory, on scenarios where they get overriden by
801 * elm_app_info_set().
803 * @param dir The path to the default libraries directory (compile
806 * @note Elementary will as well use this path to determine actual
807 * names of libraries' directory paths, maybe changing it to be @c
808 * something/lib32 or @c something/lib64 instead of @c something/lib,
811 * @warning You should call this function @b before
812 * elm_app_info_set().
814 EAPI void elm_app_compile_lib_dir_set(const char *dir);
817 * Provide information on the @b fallback application's data
818 * directory, on scenarios where they get overriden by
819 * elm_app_info_set().
821 * @param dir The path to the default data directory (compile time
824 * @note Elementary will as well use this path to determine actual
825 * names of data directory paths, maybe changing it to be @c
826 * something/local/share instead of @c something/share, only, for
829 * @warning You should call this function @b before
830 * elm_app_info_set().
832 EAPI void elm_app_compile_data_dir_set(const char *dir);
835 * Provide information on the @b fallback application's locale
836 * directory, on scenarios where they get overriden by
837 * elm_app_info_set().
839 * @param dir The path to the default locale directory (compile time
842 * @warning You should call this function @b before
843 * elm_app_info_set().
845 EAPI void elm_app_compile_locale_set(const char *dir);
848 * Retrieve the application's run time prefix directory, as set by
849 * elm_app_info_set() and the way (environment) the application was
852 * @return The directory prefix the application is actually using.
854 EAPI const char *elm_app_prefix_dir_get(void);
857 * Retrieve the application's run time binaries prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The binaries directory prefix the application is actually
864 EAPI const char *elm_app_bin_dir_get(void);
867 * Retrieve the application's run time libraries prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The libraries directory prefix the application is actually
874 EAPI const char *elm_app_lib_dir_get(void);
877 * Retrieve the application's run time data prefix directory, as
878 * set by elm_app_info_set() and the way (environment) the application
881 * @return The data directory prefix the application is actually
884 EAPI const char *elm_app_data_dir_get(void);
887 * Retrieve the application's run time locale prefix directory, as
888 * set by elm_app_info_set() and the way (environment) the application
891 * @return The locale directory prefix the application is actually
894 EAPI const char *elm_app_locale_dir_get(void);
897 * Exposed symbol used only by macros and should not be used by apps
899 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
902 * Exposed symbol used only by macros and should not be used by apps
904 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
907 * Exposed symbol used only by macros and should not be used by apps
909 EAPI int elm_quicklaunch_init(int argc, char **argv);
912 * Exposed symbol used only by macros and should not be used by apps
914 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
917 * Exposed symbol used only by macros and should not be used by apps
919 EAPI int elm_quicklaunch_sub_shutdown(void);
922 * Exposed symbol used only by macros and should not be used by apps
924 EAPI int elm_quicklaunch_shutdown(void);
927 * Exposed symbol used only by macros and should not be used by apps
929 EAPI void elm_quicklaunch_seed(void);
932 * Exposed symbol used only by macros and should not be used by apps
934 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
937 * Exposed symbol used only by macros and should not be used by apps
939 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
942 * Exposed symbol used only by macros and should not be used by apps
944 EAPI void elm_quicklaunch_cleanup(void);
947 * Exposed symbol used only by macros and should not be used by apps
949 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
952 * Exposed symbol used only by macros and should not be used by apps
954 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
957 * Request that your elementary application needs efreet
959 * This initializes the Efreet library when called and if support exists
960 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
961 * before any efreet calls.
963 * @return EINA_TRUE if support exists and initialization succeeded.
967 EAPI Eina_Bool elm_need_efreet(void);
970 * Request that your elementary application needs e_dbus
972 * This initializes the E_dbus library when called and if support exists
973 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
974 * before any e_dbus calls.
976 * @return EINA_TRUE if support exists and initialization succeeded.
980 EAPI Eina_Bool elm_need_e_dbus(void);
983 * Request that your elementary application needs ethumb
985 * This initializes the Ethumb library when called and if support exists
986 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
987 * This must be called before any other function that deals with
988 * elm_thumb objects or ethumb_client instances.
992 EAPI Eina_Bool elm_need_ethumb(void);
995 * Request that your elementary application needs web support
997 * This initializes the Ewebkit library when called and if support exists
998 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
999 * This must be called before any other function that deals with
1000 * elm_web objects or ewk_view instances.
1004 EAPI Eina_Bool elm_need_web(void);
1007 * Set a new policy's value (for a given policy group/identifier).
1009 * @param policy policy identifier, as in @ref Elm_Policy.
1010 * @param value policy value, which depends on the identifier
1012 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1014 * Elementary policies define applications' behavior,
1015 * somehow. These behaviors are divided in policy groups (see
1016 * #Elm_Policy enumeration). This call will emit the Ecore event
1017 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1018 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1021 * @note Currently, we have only one policy identifier/group
1022 * (#ELM_POLICY_QUIT), which has two possible values.
1026 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
1029 * Gets the policy value for given policy identifier.
1031 * @param policy policy identifier, as in #Elm_Policy.
1032 * @return The currently set policy value, for that
1033 * identifier. Will be @c 0 if @p policy passed is invalid.
1037 EAPI int elm_policy_get(unsigned int policy);
1040 * Change the language of the current application
1042 * The @p lang passed must be the full name of the locale to use, for
1043 * example "en_US.utf8" or "es_ES@euro".
1045 * Changing language with this function will make Elementary run through
1046 * all its widgets, translating strings set with
1047 * elm_object_domain_translatable_text_part_set(). This way, an entire
1048 * UI can have its language changed without having to restart the program.
1050 * For more complex cases, like having formatted strings that need
1051 * translation, widgets will also emit a "language,changed" signal that
1052 * the user can listen to to manually translate the text.
1054 * @param lang Language to set, must be the full name of the locale
1058 EAPI void elm_language_set(const char *lang);
1061 * Set a label of an object
1063 * @param obj The Elementary object
1064 * @param part The text part name to set (NULL for the default label)
1065 * @param label The new text of the label
1067 * @note Elementary objects may have many labels (e.g. Action Slider)
1068 * @deprecated Use elm_object_part_text_set() instead.
1071 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1074 * Set a label of an object
1076 * @param obj The Elementary object
1077 * @param part The text part name to set (NULL for the default label)
1078 * @param label The new text of the label
1080 * @note Elementary objects may have many labels (e.g. Action Slider)
1084 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1086 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1089 * Get a label of an object
1091 * @param obj The Elementary object
1092 * @param part The text part name to get (NULL for the default label)
1093 * @return text of the label or NULL for any error
1095 * @note Elementary objects may have many labels (e.g. Action Slider)
1096 * @deprecated Use elm_object_part_text_get() instead.
1099 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1102 * Get a label of an object
1104 * @param obj The Elementary object
1105 * @param part The text part name to get (NULL for the default label)
1106 * @return text of the label or NULL for any error
1108 * @note Elementary objects may have many labels (e.g. Action Slider)
1112 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1114 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1117 * Set the text for an objects' part, marking it as translatable.
1119 * The string to set as @p text must be the original one. Do not pass the
1120 * return of @c gettext() here. Elementary will translate the string
1121 * internally and set it on the object using elm_object_part_text_set(),
1122 * also storing the original string so that it can be automatically
1123 * translated when the language is changed with elm_language_set().
1125 * The @p domain will be stored along to find the translation in the
1126 * correct catalog. It can be NULL, in which case it will use whatever
1127 * domain was set by the application with @c textdomain(). This is useful
1128 * in case you are building a library on top of Elementary that will have
1129 * its own translatable strings, that should not be mixed with those of
1130 * programs using the library.
1132 * @param obj The object containing the text part
1133 * @param part The name of the part to set
1134 * @param domain The translation domain to use
1135 * @param text The original, non-translated text to set
1139 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1141 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1143 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1146 * Gets the original string set as translatable for an object
1148 * When setting translated strings, the function elm_object_part_text_get()
1149 * will return the translation returned by @c gettext(). To get the
1150 * original string use this function.
1152 * @param obj The object
1153 * @param part The name of the part that was set
1155 * @return The original, untranslated string
1159 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1161 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1164 * Set a content of an object
1166 * @param obj The Elementary object
1167 * @param part The content part name to set (NULL for the default content)
1168 * @param content The new content of the object
1170 * @note Elementary objects may have many contents
1171 * @deprecated Use elm_object_part_content_set instead.
1174 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1177 * Set a content of an object
1179 * @param obj The Elementary object
1180 * @param part The content part name to set (NULL for the default content)
1181 * @param content The new content of the object
1183 * @note Elementary objects may have many contents
1187 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1189 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1192 * Get a content of an object
1194 * @param obj The Elementary object
1195 * @param item The content part name to get (NULL for the default content)
1196 * @return content of the object or NULL for any error
1198 * @note Elementary objects may have many contents
1199 * @deprecated Use elm_object_part_content_get instead.
1202 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1205 * Get a content of an object
1207 * @param obj The Elementary object
1208 * @param item The content part name to get (NULL for the default content)
1209 * @return content of the object or NULL for any error
1211 * @note Elementary objects may have many contents
1215 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1217 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1220 * Unset a content of an object
1222 * @param obj The Elementary object
1223 * @param item The content part name to unset (NULL for the default content)
1225 * @note Elementary objects may have many contents
1226 * @deprecated Use elm_object_part_content_unset instead.
1229 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1232 * Unset a content of an object
1234 * @param obj The Elementary object
1235 * @param item The content part name to unset (NULL for the default content)
1237 * @note Elementary objects may have many contents
1241 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1243 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1246 * Set the text to read out when in accessibility mode
1248 * @param obj The object which is to be described
1249 * @param txt The text that describes the widget to people with poor or no vision
1253 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1256 * Get the widget object's handle which contains a given item
1258 * @param item The Elementary object item
1259 * @return The widget object
1261 * @note This returns the widget object itself that an item belongs to.
1265 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1268 * Set a content of an object item
1270 * @param it The Elementary object item
1271 * @param part The content part name to set (NULL for the default content)
1272 * @param content The new content of the object item
1274 * @note Elementary object items may have many contents
1275 * @deprecated Use elm_object_item_part_content_set instead.
1278 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1281 * Set a content of an object item
1283 * @param it The Elementary object item
1284 * @param part The content part name to set (NULL for the default content)
1285 * @param content The new content of the object item
1287 * @note Elementary object items may have many contents
1291 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1293 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1296 * Get a content of an object item
1298 * @param it The Elementary object item
1299 * @param part The content part name to unset (NULL for the default content)
1300 * @return content of the object item or NULL for any error
1302 * @note Elementary object items may have many contents
1303 * @deprecated Use elm_object_item_part_content_get instead.
1306 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1309 * Get a content of an object item
1311 * @param it The Elementary object item
1312 * @param part The content part name to unset (NULL for the default content)
1313 * @return content of the object item or NULL for any error
1315 * @note Elementary object items may have many contents
1319 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1321 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1324 * Unset a content of an object item
1326 * @param it The Elementary object item
1327 * @param part The content part name to unset (NULL for the default content)
1329 * @note Elementary object items may have many contents
1330 * @deprecated Use elm_object_item_part_content_unset instead.
1333 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1336 * Unset a content of an object item
1338 * @param it The Elementary object item
1339 * @param part The content part name to unset (NULL for the default content)
1341 * @note Elementary object items may have many contents
1345 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1347 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1350 * Set a label of an object item
1352 * @param it The Elementary object item
1353 * @param part The text part name to set (NULL for the default label)
1354 * @param label The new text of the label
1356 * @note Elementary object items may have many labels
1357 * @deprecated Use elm_object_item_part_text_set instead.
1360 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1363 * Set a label of an object item
1365 * @param it The Elementary object item
1366 * @param part The text part name to set (NULL for the default label)
1367 * @param label The new text of the label
1369 * @note Elementary object items may have many labels
1373 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1375 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1378 * Get a label of an object item
1380 * @param it The Elementary object item
1381 * @param part The text part name to get (NULL for the default label)
1382 * @return text of the label or NULL for any error
1384 * @note Elementary object items may have many labels
1385 * @deprecated Use elm_object_item_part_text_get instead.
1388 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1390 * Get a label of an object item
1392 * @param it The Elementary object item
1393 * @param part The text part name to get (NULL for the default label)
1394 * @return text of the label or NULL for any error
1396 * @note Elementary object items may have many labels
1400 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1402 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1405 * Set the text to read out when in accessibility mode
1407 * @param it The object item which is to be described
1408 * @param txt The text that describes the widget to people with poor or no vision
1412 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1415 * Get the data associated with an object item
1416 * @param it The Elementary object item
1417 * @return The data associated with @p it
1421 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1424 * Set the data associated with an object item
1425 * @param it The Elementary object item
1426 * @param data The data to be associated with @p it
1430 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1433 * Send a signal to the edje object of the widget item.
1435 * This function sends a signal to the edje object of the obj item. An
1436 * edje program can respond to a signal by specifying matching
1437 * 'signal' and 'source' fields.
1439 * @param it The Elementary object item
1440 * @param emission The signal's name.
1441 * @param source The signal's source.
1444 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1447 * Set the disabled state of an widget item.
1449 * @param obj The Elementary object item
1450 * @param disabled The state to put in in: @c EINA_TRUE for
1451 * disabled, @c EINA_FALSE for enabled
1453 * Elementary object item can be @b disabled, in which state they won't
1454 * receive input and, in general, will be themed differently from
1455 * their normal state, usually greyed out. Useful for contexts
1456 * where you don't want your users to interact with some of the
1457 * parts of you interface.
1459 * This sets the state for the widget item, either disabling it or
1464 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1467 * Get the disabled state of an widget item.
1469 * @param obj The Elementary object
1470 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1471 * if it's enabled (or on errors)
1473 * This gets the state of the widget, which might be enabled or disabled.
1477 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1484 * @defgroup Caches Caches
1486 * These are functions which let one fine-tune some cache values for
1487 * Elementary applications, thus allowing for performance adjustments.
1493 * @brief Flush all caches.
1495 * Frees all data that was in cache and is not currently being used to reduce
1496 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1497 * to calling all of the following functions:
1498 * @li edje_file_cache_flush()
1499 * @li edje_collection_cache_flush()
1500 * @li eet_clearcache()
1501 * @li evas_image_cache_flush()
1502 * @li evas_font_cache_flush()
1503 * @li evas_render_dump()
1504 * @note Evas caches are flushed for every canvas associated with a window.
1508 EAPI void elm_all_flush(void);
1511 * Get the configured cache flush interval time
1513 * This gets the globally configured cache flush interval time, in
1516 * @return The cache flush interval time
1519 * @see elm_all_flush()
1521 EAPI int elm_cache_flush_interval_get(void);
1524 * Set the configured cache flush interval time
1526 * This sets the globally configured cache flush interval time, in ticks
1528 * @param size The cache flush interval time
1531 * @see elm_all_flush()
1533 EAPI void elm_cache_flush_interval_set(int size);
1536 * Set the configured cache flush interval time for all applications on the
1539 * This sets the globally configured cache flush interval time -- in ticks
1540 * -- for all applications on the display.
1542 * @param size The cache flush interval time
1545 EAPI void elm_cache_flush_interval_all_set(int size);
1548 * Get the configured cache flush enabled state
1550 * This gets the globally configured cache flush state - if it is enabled
1551 * or not. When cache flushing is enabled, elementary will regularly
1552 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1553 * memory and allow usage to re-seed caches and data in memory where it
1554 * can do so. An idle application will thus minimise its memory usage as
1555 * data will be freed from memory and not be re-loaded as it is idle and
1556 * not rendering or doing anything graphically right now.
1558 * @return The cache flush state
1561 * @see elm_all_flush()
1563 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1566 * Set the configured cache flush enabled state
1568 * This sets the globally configured cache flush enabled state.
1570 * @param size The cache flush enabled state
1573 * @see elm_all_flush()
1575 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1578 * Set the configured cache flush enabled state for all applications on the
1581 * This sets the globally configured cache flush enabled state for all
1582 * applications on the display.
1584 * @param size The cache flush enabled state
1587 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1590 * Get the configured font cache size
1592 * This gets the globally configured font cache size, in bytes.
1594 * @return The font cache size
1597 EAPI int elm_font_cache_get(void);
1600 * Set the configured font cache size
1602 * This sets the globally configured font cache size, in bytes
1604 * @param size The font cache size
1607 EAPI void elm_font_cache_set(int size);
1610 * Set the configured font cache size for all applications on the
1613 * This sets the globally configured font cache size -- in bytes
1614 * -- for all applications on the display.
1616 * @param size The font cache size
1619 EAPI void elm_font_cache_all_set(int size);
1622 * Get the configured image cache size
1624 * This gets the globally configured image cache size, in bytes
1626 * @return The image cache size
1629 EAPI int elm_image_cache_get(void);
1632 * Set the configured image cache size
1634 * This sets the globally configured image cache size, in bytes
1636 * @param size The image cache size
1639 EAPI void elm_image_cache_set(int size);
1642 * Set the configured image cache size for all applications on the
1645 * This sets the globally configured image cache size -- in bytes
1646 * -- for all applications on the display.
1648 * @param size The image cache size
1651 EAPI void elm_image_cache_all_set(int size);
1654 * Get the configured edje file cache size.
1656 * This gets the globally configured edje file cache size, in number
1659 * @return The edje file cache size
1662 EAPI int elm_edje_file_cache_get(void);
1665 * Set the configured edje file cache size
1667 * This sets the globally configured edje file cache size, in number
1670 * @param size The edje file cache size
1673 EAPI void elm_edje_file_cache_set(int size);
1676 * Set the configured edje file cache size for all applications on the
1679 * This sets the globally configured edje file cache size -- in number
1680 * of files -- for all applications on the display.
1682 * @param size The edje file cache size
1685 EAPI void elm_edje_file_cache_all_set(int size);
1688 * Get the configured edje collections (groups) cache size.
1690 * This gets the globally configured edje collections cache size, in
1691 * number of collections.
1693 * @return The edje collections cache size
1696 EAPI int elm_edje_collection_cache_get(void);
1699 * Set the configured edje collections (groups) cache size
1701 * This sets the globally configured edje collections cache size, in
1702 * number of collections.
1704 * @param size The edje collections cache size
1707 EAPI void elm_edje_collection_cache_set(int size);
1710 * Set the configured edje collections (groups) cache size for all
1711 * applications on the display
1713 * This sets the globally configured edje collections cache size -- in
1714 * number of collections -- for all applications on the display.
1716 * @param size The edje collections cache size
1719 EAPI void elm_edje_collection_cache_all_set(int size);
1726 * @defgroup Scaling Widget Scaling
1728 * Different widgets can be scaled independently. These functions
1729 * allow you to manipulate this scaling on a per-widget basis. The
1730 * object and all its children get their scaling factors multiplied
1731 * by the scale factor set. This is multiplicative, in that if a
1732 * child also has a scale size set it is in turn multiplied by its
1733 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1734 * double size, @c 0.5 is half, etc.
1736 * @ref general_functions_example_page "This" example contemplates
1737 * some of these functions.
1741 * Get the global scaling factor
1743 * This gets the globally configured scaling factor that is applied to all
1746 * @return The scaling factor
1749 EAPI double elm_scale_get(void);
1752 * Set the global scaling factor
1754 * This sets the globally configured scaling factor that is applied to all
1757 * @param scale The scaling factor to set
1760 EAPI void elm_scale_set(double scale);
1763 * Set the global scaling factor for all applications on the display
1765 * This sets the globally configured scaling factor that is applied to all
1766 * objects for all applications.
1767 * @param scale The scaling factor to set
1770 EAPI void elm_scale_all_set(double scale);
1773 * Set the scaling factor for a given Elementary object
1775 * @param obj The Elementary to operate on
1776 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1781 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1784 * Get the scaling factor for a given Elementary object
1786 * @param obj The object
1787 * @return The scaling factor set by elm_object_scale_set()
1791 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1794 * @defgroup Password_last_show Password last input show
1796 * Last show feature of password mode enables user to view
1797 * the last input entered for few seconds before masking it.
1798 * These functions allow to set this feature in password mode
1799 * of entry widget and also allow to manipulate the duration
1800 * for which the input has to be visible.
1806 * Get show last setting of password mode.
1808 * This gets the show last input setting of password mode which might be
1809 * enabled or disabled.
1811 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1813 * @ingroup Password_last_show
1815 EAPI Eina_Bool elm_password_show_last_get(void);
1818 * Set show last setting in password mode.
1820 * This enables or disables show last setting of password mode.
1822 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1823 * @see elm_password_show_last_timeout_set()
1824 * @ingroup Password_last_show
1826 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1829 * Get's the timeout value in last show password mode.
1831 * This gets the time out value for which the last input entered in password
1832 * mode will be visible.
1834 * @return The timeout value of last show password mode.
1835 * @ingroup Password_last_show
1837 EAPI double elm_password_show_last_timeout_get(void);
1840 * Set's the timeout value in last show password mode.
1842 * This sets the time out value for which the last input entered in password
1843 * mode will be visible.
1845 * @param password_show_last_timeout The timeout value.
1846 * @see elm_password_show_last_set()
1847 * @ingroup Password_last_show
1849 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1856 * @defgroup UI-Mirroring Selective Widget mirroring
1858 * These functions allow you to set ui-mirroring on specific
1859 * widgets or the whole interface. Widgets can be in one of two
1860 * modes, automatic and manual. Automatic means they'll be changed
1861 * according to the system mirroring mode and manual means only
1862 * explicit changes will matter. You are not supposed to change
1863 * mirroring state of a widget set to automatic, will mostly work,
1864 * but the behavior is not really defined.
1869 EAPI Eina_Bool elm_mirrored_get(void);
1870 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1873 * Get the system mirrored mode. This determines the default mirrored mode
1876 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1878 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1881 * Set the system mirrored mode. This determines the default mirrored mode
1884 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1886 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1889 * Returns the widget's mirrored mode setting.
1891 * @param obj The widget.
1892 * @return mirrored mode setting of the object.
1895 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1898 * Sets the widget's mirrored mode setting.
1899 * When widget in automatic mode, it follows the system mirrored mode set by
1900 * elm_mirrored_set().
1901 * @param obj The widget.
1902 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1904 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1911 * Set the style to use by a widget
1913 * Sets the style name that will define the appearance of a widget. Styles
1914 * vary from widget to widget and may also be defined by other themes
1915 * by means of extensions and overlays.
1917 * @param obj The Elementary widget to style
1918 * @param style The style name to use
1920 * @see elm_theme_extension_add()
1921 * @see elm_theme_extension_del()
1922 * @see elm_theme_overlay_add()
1923 * @see elm_theme_overlay_del()
1927 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1929 * Get the style used by the widget
1931 * This gets the style being used for that widget. Note that the string
1932 * pointer is only valid as longas the object is valid and the style doesn't
1935 * @param obj The Elementary widget to query for its style
1936 * @return The style name used
1938 * @see elm_object_style_set()
1942 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1945 * @defgroup Styles Styles
1947 * Widgets can have different styles of look. These generic API's
1948 * set styles of widgets, if they support them (and if the theme(s)
1951 * @ref general_functions_example_page "This" example contemplates
1952 * some of these functions.
1956 * Set the disabled state of an Elementary object.
1958 * @param obj The Elementary object to operate on
1959 * @param disabled The state to put in in: @c EINA_TRUE for
1960 * disabled, @c EINA_FALSE for enabled
1962 * Elementary objects can be @b disabled, in which state they won't
1963 * receive input and, in general, will be themed differently from
1964 * their normal state, usually greyed out. Useful for contexts
1965 * where you don't want your users to interact with some of the
1966 * parts of you interface.
1968 * This sets the state for the widget, either disabling it or
1973 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1976 * Get the disabled state of an Elementary object.
1978 * @param obj The Elementary object to operate on
1979 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1980 * if it's enabled (or on errors)
1982 * This gets the state of the widget, which might be enabled or disabled.
1986 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1989 * @defgroup WidgetNavigation Widget Tree Navigation.
1991 * How to check if an Evas Object is an Elementary widget? How to
1992 * get the first elementary widget that is parent of the given
1993 * object? These are all covered in widget tree navigation.
1995 * @ref general_functions_example_page "This" example contemplates
1996 * some of these functions.
2000 * Check if the given Evas Object is an Elementary widget.
2002 * @param obj the object to query.
2003 * @return @c EINA_TRUE if it is an elementary widget variant,
2004 * @c EINA_FALSE otherwise
2005 * @ingroup WidgetNavigation
2007 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2010 * Get the first parent of the given object that is an Elementary
2013 * @param obj the Elementary object to query parent from.
2014 * @return the parent object that is an Elementary widget, or @c
2015 * NULL, if it was not found.
2017 * Use this to query for an object's parent widget.
2019 * @note Most of Elementary users wouldn't be mixing non-Elementary
2020 * smart objects in the objects tree of an application, as this is
2021 * an advanced usage of Elementary with Evas. So, except for the
2022 * application's window, which is the root of that tree, all other
2023 * objects would have valid Elementary widget parents.
2025 * @ingroup WidgetNavigation
2027 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2030 * Get the top level parent of an Elementary widget.
2032 * @param obj The object to query.
2033 * @return The top level Elementary widget, or @c NULL if parent cannot be
2035 * @ingroup WidgetNavigation
2037 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2040 * Get the string that represents this Elementary widget.
2042 * @note Elementary is weird and exposes itself as a single
2043 * Evas_Object_Smart_Class of type "elm_widget", so
2044 * evas_object_type_get() always return that, making debug and
2045 * language bindings hard. This function tries to mitigate this
2046 * problem, but the solution is to change Elementary to use
2047 * proper inheritance.
2049 * @param obj the object to query.
2050 * @return Elementary widget name, or @c NULL if not a valid widget.
2051 * @ingroup WidgetNavigation
2053 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2056 * @defgroup Config Elementary Config
2058 * Elementary configuration is formed by a set options bounded to a
2059 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2060 * "finger size", etc. These are functions with which one syncronizes
2061 * changes made to those values to the configuration storing files, de
2062 * facto. You most probably don't want to use the functions in this
2063 * group unlees you're writing an elementary configuration manager.
2069 * Save back Elementary's configuration, so that it will persist on
2072 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2075 * This function will take effect -- thus, do I/O -- immediately. Use
2076 * it when you want to apply all configuration changes at once. The
2077 * current configuration set will get saved onto the current profile
2078 * configuration file.
2081 EAPI Eina_Bool elm_config_save(void);
2084 * Reload Elementary's configuration, bounded to current selected
2087 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2090 * Useful when you want to force reloading of configuration values for
2091 * a profile. If one removes user custom configuration directories,
2092 * for example, it will force a reload with system values instead.
2095 EAPI void elm_config_reload(void);
2102 * @defgroup Profile Elementary Profile
2104 * Profiles are pre-set options that affect the whole look-and-feel of
2105 * Elementary-based applications. There are, for example, profiles
2106 * aimed at desktop computer applications and others aimed at mobile,
2107 * touchscreen-based ones. You most probably don't want to use the
2108 * functions in this group unlees you're writing an elementary
2109 * configuration manager.
2115 * Get Elementary's profile in use.
2117 * This gets the global profile that is applied to all Elementary
2120 * @return The profile's name
2123 EAPI const char *elm_profile_current_get(void);
2126 * Get an Elementary's profile directory path in the filesystem. One
2127 * may want to fetch a system profile's dir or an user one (fetched
2130 * @param profile The profile's name
2131 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2132 * or a system one (@c EINA_FALSE)
2133 * @return The profile's directory path.
2136 * @note You must free it with elm_profile_dir_free().
2138 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2141 * Free an Elementary's profile directory path, as returned by
2142 * elm_profile_dir_get().
2144 * @param p_dir The profile's path
2148 EAPI void elm_profile_dir_free(const char *p_dir);
2151 * Get Elementary's list of available profiles.
2153 * @return The profiles list. List node data are the profile name
2157 * @note One must free this list, after usage, with the function
2158 * elm_profile_list_free().
2160 EAPI Eina_List *elm_profile_list_get(void);
2163 * Free Elementary's list of available profiles.
2165 * @param l The profiles list, as returned by elm_profile_list_get().
2169 EAPI void elm_profile_list_free(Eina_List *l);
2172 * Set Elementary's profile.
2174 * This sets the global profile that is applied to Elementary
2175 * applications. Just the process the call comes from will be
2178 * @param profile The profile's name
2182 EAPI void elm_profile_set(const char *profile);
2185 * Set Elementary's profile.
2187 * This sets the global profile that is applied to all Elementary
2188 * applications. All running Elementary windows will be affected.
2190 * @param profile The profile's name
2194 EAPI void elm_profile_all_set(const char *profile);
2201 * @defgroup Engine Elementary Engine
2203 * These are functions setting and querying which rendering engine
2204 * Elementary will use for drawing its windows' pixels.
2206 * The following are the available engines:
2207 * @li "software_x11"
2210 * @li "software_16_x11"
2211 * @li "software_8_x11"
2214 * @li "software_gdi"
2215 * @li "software_16_wince_gdi"
2217 * @li "software_16_sdl"
2221 * @li "opengl_cocoa"
2228 * @brief Get Elementary's rendering engine in use.
2230 * @return The rendering engine's name
2231 * @note there's no need to free the returned string, here.
2233 * This gets the global rendering engine that is applied to all Elementary
2236 * @see elm_engine_set()
2238 EAPI const char *elm_engine_current_get(void);
2241 * @brief Set Elementary's rendering engine for use.
2243 * @param engine The rendering engine's name
2245 * This sets global rendering engine that is applied to all Elementary
2246 * applications. Note that it will take effect only to Elementary windows
2247 * created after this is called.
2249 * @see elm_win_add()
2251 EAPI void elm_engine_set(const char *engine);
2258 * @defgroup Fonts Elementary Fonts
2260 * These are functions dealing with font rendering, selection and the
2261 * like for Elementary applications. One might fetch which system
2262 * fonts are there to use and set custom fonts for individual classes
2263 * of UI items containing text (text classes).
2268 typedef struct _Elm_Text_Class
2274 typedef struct _Elm_Font_Overlay
2276 const char *text_class;
2278 Evas_Font_Size size;
2281 typedef struct _Elm_Font_Properties
2285 } Elm_Font_Properties;
2288 * Get Elementary's list of supported text classes.
2290 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2293 * Release the list with elm_text_classes_list_free().
2295 EAPI const Eina_List *elm_text_classes_list_get(void);
2298 * Free Elementary's list of supported text classes.
2302 * @see elm_text_classes_list_get().
2304 EAPI void elm_text_classes_list_free(const Eina_List *list);
2307 * Get Elementary's list of font overlays, set with
2308 * elm_font_overlay_set().
2310 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2315 * For each text class, one can set a <b>font overlay</b> for it,
2316 * overriding the default font properties for that class coming from
2317 * the theme in use. There is no need to free this list.
2319 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2321 EAPI const Eina_List *elm_font_overlay_list_get(void);
2324 * Set a font overlay for a given Elementary text class.
2326 * @param text_class Text class name
2327 * @param font Font name and style string
2328 * @param size Font size
2332 * @p font has to be in the format returned by
2333 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2334 * and elm_font_overlay_unset().
2336 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2339 * Unset a font overlay for a given Elementary text class.
2341 * @param text_class Text class name
2345 * This will bring back text elements belonging to text class
2346 * @p text_class back to their default font settings.
2348 EAPI void elm_font_overlay_unset(const char *text_class);
2351 * Apply the changes made with elm_font_overlay_set() and
2352 * elm_font_overlay_unset() on the current Elementary window.
2356 * This applies all font overlays set to all objects in the UI.
2358 EAPI void elm_font_overlay_apply(void);
2361 * Apply the changes made with elm_font_overlay_set() and
2362 * elm_font_overlay_unset() on all Elementary application windows.
2366 * This applies all font overlays set to all objects in the UI.
2368 EAPI void elm_font_overlay_all_apply(void);
2371 * Translate a font (family) name string in fontconfig's font names
2372 * syntax into an @c Elm_Font_Properties struct.
2374 * @param font The font name and styles string
2375 * @return the font properties struct
2379 * @note The reverse translation can be achived with
2380 * elm_font_fontconfig_name_get(), for one style only (single font
2381 * instance, not family).
2383 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2386 * Free font properties return by elm_font_properties_get().
2388 * @param efp the font properties struct
2392 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2395 * Translate a font name, bound to a style, into fontconfig's font names
2398 * @param name The font (family) name
2399 * @param style The given style (may be @c NULL)
2401 * @return the font name and style string
2405 * @note The reverse translation can be achived with
2406 * elm_font_properties_get(), for one style only (single font
2407 * instance, not family).
2409 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2412 * Free the font string return by elm_font_fontconfig_name_get().
2414 * @param efp the font properties struct
2418 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2421 * Create a font hash table of available system fonts.
2423 * One must call it with @p list being the return value of
2424 * evas_font_available_list(). The hash will be indexed by font
2425 * (family) names, being its values @c Elm_Font_Properties blobs.
2427 * @param list The list of available system fonts, as returned by
2428 * evas_font_available_list().
2429 * @return the font hash.
2433 * @note The user is supposed to get it populated at least with 3
2434 * default font families (Sans, Serif, Monospace), which should be
2435 * present on most systems.
2437 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2440 * Free the hash return by elm_font_available_hash_add().
2442 * @param hash the hash to be freed.
2446 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2453 * @defgroup Fingers Fingers
2455 * Elementary is designed to be finger-friendly for touchscreens,
2456 * and so in addition to scaling for display resolution, it can
2457 * also scale based on finger "resolution" (or size). You can then
2458 * customize the granularity of the areas meant to receive clicks
2461 * Different profiles may have pre-set values for finger sizes.
2463 * @ref general_functions_example_page "This" example contemplates
2464 * some of these functions.
2470 * Get the configured "finger size"
2472 * @return The finger size
2474 * This gets the globally configured finger size, <b>in pixels</b>
2478 EAPI Evas_Coord elm_finger_size_get(void);
2481 * Set the configured finger size
2483 * This sets the globally configured finger size in pixels
2485 * @param size The finger size
2488 EAPI void elm_finger_size_set(Evas_Coord size);
2491 * Set the configured finger size for all applications on the display
2493 * This sets the globally configured finger size in pixels for all
2494 * applications on the display
2496 * @param size The finger size
2499 EAPI void elm_finger_size_all_set(Evas_Coord size);
2506 * @defgroup Focus Focus
2508 * An Elementary application has, at all times, one (and only one)
2509 * @b focused object. This is what determines where the input
2510 * events go to within the application's window. Also, focused
2511 * objects can be decorated differently, in order to signal to the
2512 * user where the input is, at a given moment.
2514 * Elementary applications also have the concept of <b>focus
2515 * chain</b>: one can cycle through all the windows' focusable
2516 * objects by input (tab key) or programmatically. The default
2517 * focus chain for an application is the one define by the order in
2518 * which the widgets where added in code. One will cycle through
2519 * top level widgets, and, for each one containg sub-objects, cycle
2520 * through them all, before returning to the level
2521 * above. Elementary also allows one to set @b custom focus chains
2522 * for their applications.
2524 * Besides the focused decoration a widget may exhibit, when it
2525 * gets focus, Elementary has a @b global focus highlight object
2526 * that can be enabled for a window. If one chooses to do so, this
2527 * extra highlight effect will surround the current focused object,
2530 * @note Some Elementary widgets are @b unfocusable, after
2531 * creation, by their very nature: they are not meant to be
2532 * interacted with input events, but are there just for visual
2535 * @ref general_functions_example_page "This" example contemplates
2536 * some of these functions.
2540 * Get the enable status of the focus highlight
2542 * This gets whether the highlight on focused objects is enabled or not
2545 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2548 * Set the enable status of the focus highlight
2550 * Set whether to show or not the highlight on focused objects
2551 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2554 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2557 * Get the enable status of the highlight animation
2559 * Get whether the focus highlight, if enabled, will animate its switch from
2560 * one object to the next
2563 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2566 * Set the enable status of the highlight animation
2568 * Set whether the focus highlight, if enabled, will animate its switch from
2569 * one object to the next
2570 * @param animate Enable animation if EINA_TRUE, disable otherwise
2573 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2576 * Get the whether an Elementary object has the focus or not.
2578 * @param obj The Elementary object to get the information from
2579 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2580 * not (and on errors).
2582 * @see elm_object_focus_set()
2586 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2589 * Set/unset focus to a given Elementary object.
2591 * @param obj The Elementary object to operate on.
2592 * @param enable @c EINA_TRUE Set focus to a given object,
2593 * @c EINA_FALSE Unset focus to a given object.
2595 * @note When you set focus to this object, if it can handle focus, will
2596 * take the focus away from the one who had it previously and will, for
2597 * now on, be the one receiving input events. Unsetting focus will remove
2598 * the focus from @p obj, passing it back to the previous element in the
2601 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2605 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2608 * Make a given Elementary object the focused one.
2610 * @param obj The Elementary object to make focused.
2612 * @note This object, if it can handle focus, will take the focus
2613 * away from the one who had it previously and will, for now on, be
2614 * the one receiving input events.
2616 * @see elm_object_focus_get()
2617 * @deprecated use elm_object_focus_set() instead.
2621 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2624 * Remove the focus from an Elementary object
2626 * @param obj The Elementary to take focus from
2628 * This removes the focus from @p obj, passing it back to the
2629 * previous element in the focus chain list.
2631 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2632 * @deprecated use elm_object_focus_set() instead.
2636 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2639 * Set the ability for an Element object to be focused
2641 * @param obj The Elementary object to operate on
2642 * @param enable @c EINA_TRUE if the object can be focused, @c
2643 * EINA_FALSE if not (and on errors)
2645 * This sets whether the object @p obj is able to take focus or
2646 * not. Unfocusable objects do nothing when programmatically
2647 * focused, being the nearest focusable parent object the one
2648 * really getting focus. Also, when they receive mouse input, they
2649 * will get the event, but not take away the focus from where it
2654 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2657 * Get whether an Elementary object is focusable or not
2659 * @param obj The Elementary object to operate on
2660 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2661 * EINA_FALSE if not (and on errors)
2663 * @note Objects which are meant to be interacted with by input
2664 * events are created able to be focused, by default. All the
2669 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2672 * Set custom focus chain.
2674 * This function overwrites any previous custom focus chain within
2675 * the list of objects. The previous list will be deleted and this list
2676 * will be managed by elementary. After it is set, don't modify it.
2678 * @note On focus cycle, only will be evaluated children of this container.
2680 * @param obj The container object
2681 * @param objs Chain of objects to pass focus
2684 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2687 * Unset a custom focus chain on a given Elementary widget
2689 * @param obj The container object to remove focus chain from
2691 * Any focus chain previously set on @p obj (for its child objects)
2692 * is removed entirely after this call.
2696 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2699 * Get custom focus chain
2701 * @param obj The container object
2704 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2707 * Append object to custom focus chain.
2709 * @note If relative_child equal to NULL or not in custom chain, the object
2710 * will be added in end.
2712 * @note On focus cycle, only will be evaluated children of this container.
2714 * @param obj The container object
2715 * @param child The child to be added in custom chain
2716 * @param relative_child The relative object to position the child
2719 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2722 * Prepend object to custom focus chain.
2724 * @note If relative_child equal to NULL or not in custom chain, the object
2725 * will be added in begin.
2727 * @note On focus cycle, only will be evaluated children of this container.
2729 * @param obj The container object
2730 * @param child The child to be added in custom chain
2731 * @param relative_child The relative object to position the child
2734 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2737 * Give focus to next object in object tree.
2739 * Give focus to next object in focus chain of one object sub-tree.
2740 * If the last object of chain already have focus, the focus will go to the
2741 * first object of chain.
2743 * @param obj The object root of sub-tree
2744 * @param dir Direction to cycle the focus
2748 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2751 * Give focus to near object in one direction.
2753 * Give focus to near object in direction of one object.
2754 * If none focusable object in given direction, the focus will not change.
2756 * @param obj The reference object
2757 * @param x Horizontal component of direction to focus
2758 * @param y Vertical component of direction to focus
2762 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2765 * Make the elementary object and its children to be unfocusable
2768 * @param obj The Elementary object to operate on
2769 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2770 * @c EINA_FALSE for focusable.
2772 * This sets whether the object @p obj and its children objects
2773 * are able to take focus or not. If the tree is set as unfocusable,
2774 * newest focused object which is not in this tree will get focus.
2775 * This API can be helpful for an object to be deleted.
2776 * When an object will be deleted soon, it and its children may not
2777 * want to get focus (by focus reverting or by other focus controls).
2778 * Then, just use this API before deleting.
2780 * @see elm_object_tree_unfocusable_get()
2784 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2787 * Get whether an Elementary object and its children are unfocusable or not.
2789 * @param obj The Elementary object to get the information from
2790 * @return @c EINA_TRUE, if the tree is unfocussable,
2791 * @c EINA_FALSE if not (and on errors).
2793 * @see elm_object_tree_unfocusable_set()
2797 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2800 * @defgroup Scrolling Scrolling
2802 * These are functions setting how scrollable views in Elementary
2803 * widgets should behave on user interaction.
2809 * Get whether scrollers should bounce when they reach their
2810 * viewport's edge during a scroll.
2812 * @return the thumb scroll bouncing state
2814 * This is the default behavior for touch screens, in general.
2815 * @ingroup Scrolling
2817 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2820 * Set whether scrollers should bounce when they reach their
2821 * viewport's edge during a scroll.
2823 * @param enabled the thumb scroll bouncing state
2825 * @see elm_thumbscroll_bounce_enabled_get()
2826 * @ingroup Scrolling
2828 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2831 * Set whether scrollers should bounce when they reach their
2832 * viewport's edge during a scroll, for all Elementary application
2835 * @param enabled the thumb scroll bouncing state
2837 * @see elm_thumbscroll_bounce_enabled_get()
2838 * @ingroup Scrolling
2840 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2843 * Get the amount of inertia a scroller will impose at bounce
2846 * @return the thumb scroll bounce friction
2848 * @ingroup Scrolling
2850 EAPI double elm_scroll_bounce_friction_get(void);
2853 * Set the amount of inertia a scroller will impose at bounce
2856 * @param friction the thumb scroll bounce friction
2858 * @see elm_thumbscroll_bounce_friction_get()
2859 * @ingroup Scrolling
2861 EAPI void elm_scroll_bounce_friction_set(double friction);
2864 * Set the amount of inertia a scroller will impose at bounce
2865 * animations, for all Elementary application windows.
2867 * @param friction the thumb scroll bounce friction
2869 * @see elm_thumbscroll_bounce_friction_get()
2870 * @ingroup Scrolling
2872 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2875 * Get the amount of inertia a <b>paged</b> scroller will impose at
2876 * page fitting animations.
2878 * @return the page scroll friction
2880 * @ingroup Scrolling
2882 EAPI double elm_scroll_page_scroll_friction_get(void);
2885 * Set the amount of inertia a <b>paged</b> scroller will impose at
2886 * page fitting animations.
2888 * @param friction the page scroll friction
2890 * @see elm_thumbscroll_page_scroll_friction_get()
2891 * @ingroup Scrolling
2893 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2896 * Set the amount of inertia a <b>paged</b> scroller will impose at
2897 * page fitting animations, for all Elementary application windows.
2899 * @param friction the page scroll friction
2901 * @see elm_thumbscroll_page_scroll_friction_get()
2902 * @ingroup Scrolling
2904 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2907 * Get the amount of inertia a scroller will impose at region bring
2910 * @return the bring in scroll friction
2912 * @ingroup Scrolling
2914 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2917 * Set the amount of inertia a scroller will impose at region bring
2920 * @param friction the bring in scroll friction
2922 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2923 * @ingroup Scrolling
2925 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2928 * Set the amount of inertia a scroller will impose at region bring
2929 * animations, for all Elementary application windows.
2931 * @param friction the bring in scroll friction
2933 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2934 * @ingroup Scrolling
2936 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2939 * Get the amount of inertia scrollers will impose at animations
2940 * triggered by Elementary widgets' zooming API.
2942 * @return the zoom friction
2944 * @ingroup Scrolling
2946 EAPI double elm_scroll_zoom_friction_get(void);
2949 * Set the amount of inertia scrollers will impose at animations
2950 * triggered by Elementary widgets' zooming API.
2952 * @param friction the zoom friction
2954 * @see elm_thumbscroll_zoom_friction_get()
2955 * @ingroup Scrolling
2957 EAPI void elm_scroll_zoom_friction_set(double friction);
2960 * Set the amount of inertia scrollers will impose at animations
2961 * triggered by Elementary widgets' zooming API, for all Elementary
2962 * application windows.
2964 * @param friction the zoom friction
2966 * @see elm_thumbscroll_zoom_friction_get()
2967 * @ingroup Scrolling
2969 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2972 * Get whether scrollers should be draggable from any point in their
2975 * @return the thumb scroll state
2977 * @note This is the default behavior for touch screens, in general.
2978 * @note All other functions namespaced with "thumbscroll" will only
2979 * have effect if this mode is enabled.
2981 * @ingroup Scrolling
2983 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2986 * Set whether scrollers should be draggable from any point in their
2989 * @param enabled the thumb scroll state
2991 * @see elm_thumbscroll_enabled_get()
2992 * @ingroup Scrolling
2994 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2997 * Set whether scrollers should be draggable from any point in their
2998 * views, for all Elementary application windows.
3000 * @param enabled the thumb scroll state
3002 * @see elm_thumbscroll_enabled_get()
3003 * @ingroup Scrolling
3005 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3008 * Get the number of pixels one should travel while dragging a
3009 * scroller's view to actually trigger scrolling.
3011 * @return the thumb scroll threshould
3013 * One would use higher values for touch screens, in general, because
3014 * of their inherent imprecision.
3015 * @ingroup Scrolling
3017 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
3020 * Set the number of pixels one should travel while dragging a
3021 * scroller's view to actually trigger scrolling.
3023 * @param threshold the thumb scroll threshould
3025 * @see elm_thumbscroll_threshould_get()
3026 * @ingroup Scrolling
3028 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3031 * Set the number of pixels one should travel while dragging a
3032 * scroller's view to actually trigger scrolling, for all Elementary
3033 * application windows.
3035 * @param threshold the thumb scroll threshould
3037 * @see elm_thumbscroll_threshould_get()
3038 * @ingroup Scrolling
3040 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3043 * Get the minimum speed of mouse cursor movement which will trigger
3044 * list self scrolling animation after a mouse up event
3047 * @return the thumb scroll momentum threshould
3049 * @ingroup Scrolling
3051 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
3054 * Set the minimum speed of mouse cursor movement which will trigger
3055 * list self scrolling animation after a mouse up event
3058 * @param threshold the thumb scroll momentum threshould
3060 * @see elm_thumbscroll_momentum_threshould_get()
3061 * @ingroup Scrolling
3063 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3066 * Set the minimum speed of mouse cursor movement which will trigger
3067 * list self scrolling animation after a mouse up event
3068 * (pixels/second), for all Elementary application windows.
3070 * @param threshold the thumb scroll momentum threshould
3072 * @see elm_thumbscroll_momentum_threshould_get()
3073 * @ingroup Scrolling
3075 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3078 * Get the amount of inertia a scroller will impose at self scrolling
3081 * @return the thumb scroll friction
3083 * @ingroup Scrolling
3085 EAPI double elm_scroll_thumbscroll_friction_get(void);
3088 * Set the amount of inertia a scroller will impose at self scrolling
3091 * @param friction the thumb scroll friction
3093 * @see elm_thumbscroll_friction_get()
3094 * @ingroup Scrolling
3096 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3099 * Set the amount of inertia a scroller will impose at self scrolling
3100 * animations, for all Elementary application windows.
3102 * @param friction the thumb scroll friction
3104 * @see elm_thumbscroll_friction_get()
3105 * @ingroup Scrolling
3107 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3110 * Get the amount of lag between your actual mouse cursor dragging
3111 * movement and a scroller's view movement itself, while pushing it
3112 * into bounce state manually.
3114 * @return the thumb scroll border friction
3116 * @ingroup Scrolling
3118 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3121 * Set the amount of lag between your actual mouse cursor dragging
3122 * movement and a scroller's view movement itself, while pushing it
3123 * into bounce state manually.
3125 * @param friction the thumb scroll border friction. @c 0.0 for
3126 * perfect synchrony between two movements, @c 1.0 for maximum
3129 * @see elm_thumbscroll_border_friction_get()
3130 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3132 * @ingroup Scrolling
3134 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3137 * Set the amount of lag between your actual mouse cursor dragging
3138 * movement and a scroller's view movement itself, while pushing it
3139 * into bounce state manually, for all Elementary application windows.
3141 * @param friction the thumb scroll border friction. @c 0.0 for
3142 * perfect synchrony between two movements, @c 1.0 for maximum
3145 * @see elm_thumbscroll_border_friction_get()
3146 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3148 * @ingroup Scrolling
3150 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3153 * Get the sensitivity amount which is be multiplied by the length of
3156 * @return the thumb scroll sensitivity friction
3158 * @ingroup Scrolling
3160 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3163 * Set the sensitivity amount which is be multiplied by the length of
3166 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3167 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3170 * @see elm_thumbscroll_sensitivity_friction_get()
3171 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3173 * @ingroup Scrolling
3175 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3178 * Set the sensitivity amount which is be multiplied by the length of
3179 * mouse dragging, for all Elementary application windows.
3181 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3182 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3185 * @see elm_thumbscroll_sensitivity_friction_get()
3186 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3188 * @ingroup Scrolling
3190 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3197 * @defgroup Scrollhints Scrollhints
3199 * Objects when inside a scroller can scroll, but this may not always be
3200 * desirable in certain situations. This allows an object to hint to itself
3201 * and parents to "not scroll" in one of 2 ways. If any child object of a
3202 * scroller has pushed a scroll freeze or hold then it affects all parent
3203 * scrollers until all children have released them.
3205 * 1. To hold on scrolling. This means just flicking and dragging may no
3206 * longer scroll, but pressing/dragging near an edge of the scroller will
3207 * still scroll. This is automatically used by the entry object when
3210 * 2. To totally freeze scrolling. This means it stops. until
3217 * Push the scroll hold by 1
3219 * This increments the scroll hold count by one. If it is more than 0 it will
3220 * take effect on the parents of the indicated object.
3222 * @param obj The object
3223 * @ingroup Scrollhints
3225 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3228 * Pop the scroll hold by 1
3230 * This decrements the scroll hold count by one. If it is more than 0 it will
3231 * take effect on the parents of the indicated object.
3233 * @param obj The object
3234 * @ingroup Scrollhints
3236 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3239 * Push the scroll freeze by 1
3241 * This increments the scroll freeze count by one. If it is more
3242 * than 0 it will take effect on the parents of the indicated
3245 * @param obj The object
3246 * @ingroup Scrollhints
3248 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3251 * Pop the scroll freeze by 1
3253 * This decrements the scroll freeze count by one. If it is more
3254 * than 0 it will take effect on the parents of the indicated
3257 * @param obj The object
3258 * @ingroup Scrollhints
3260 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3263 * Lock the scrolling of the given widget (and thus all parents)
3265 * This locks the given object from scrolling in the X axis (and implicitly
3266 * also locks all parent scrollers too from doing the same).
3268 * @param obj The object
3269 * @param lock The lock state (1 == locked, 0 == unlocked)
3270 * @ingroup Scrollhints
3272 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3275 * Lock the scrolling of the given widget (and thus all parents)
3277 * This locks the given object from scrolling in the Y axis (and implicitly
3278 * also locks all parent scrollers too from doing the same).
3280 * @param obj The object
3281 * @param lock The lock state (1 == locked, 0 == unlocked)
3282 * @ingroup Scrollhints
3284 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3287 * Get the scrolling lock of the given widget
3289 * This gets the lock for X axis scrolling.
3291 * @param obj The object
3292 * @ingroup Scrollhints
3294 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3297 * Get the scrolling lock of the given widget
3299 * This gets the lock for X axis scrolling.
3301 * @param obj The object
3302 * @ingroup Scrollhints
3304 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3311 * Send a signal to the widget edje object.
3313 * This function sends a signal to the edje object of the obj. An
3314 * edje program can respond to a signal by specifying matching
3315 * 'signal' and 'source' fields.
3317 * @param obj The object
3318 * @param emission The signal's name.
3319 * @param source The signal's source.
3322 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3325 * Add a callback for a signal emitted by widget edje object.
3327 * This function connects a callback function to a signal emitted by the
3328 * edje object of the obj.
3329 * Globs can occur in either the emission or source name.
3331 * @param obj The object
3332 * @param emission The signal's name.
3333 * @param source The signal's source.
3334 * @param func The callback function to be executed when the signal is
3336 * @param data A pointer to data to pass in to the callback function.
3339 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);
3342 * Remove a signal-triggered callback from a widget edje object.
3344 * This function removes a callback, previoulsy attached to a
3345 * signal emitted by the edje object of the obj. The parameters
3346 * emission, source and func must match exactly those passed to a
3347 * previous call to elm_object_signal_callback_add(). The data
3348 * pointer that was passed to this call will be returned.
3350 * @param obj The object
3351 * @param emission The signal's name.
3352 * @param source The signal's source.
3353 * @param func The callback function to be executed when the signal is
3355 * @return The data pointer
3358 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);
3361 * Add a callback for input events (key up, key down, mouse wheel)
3362 * on a given Elementary widget
3364 * @param obj The widget to add an event callback on
3365 * @param func The callback function to be executed when the event
3367 * @param data Data to pass in to @p func
3369 * Every widget in an Elementary interface set to receive focus,
3370 * with elm_object_focus_allow_set(), will propagate @b all of its
3371 * key up, key down and mouse wheel input events up to its parent
3372 * object, and so on. All of the focusable ones in this chain which
3373 * had an event callback set, with this call, will be able to treat
3374 * those events. There are two ways of making the propagation of
3375 * these event upwards in the tree of widgets to @b cease:
3376 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3377 * the event was @b not processed, so the propagation will go on.
3378 * - The @c event_info pointer passed to @p func will contain the
3379 * event's structure and, if you OR its @c event_flags inner
3380 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3381 * one has already handled it, thus killing the event's
3384 * @note Your event callback will be issued on those events taking
3385 * place only if no other child widget of @obj has consumed the
3388 * @note Not to be confused with @c
3389 * evas_object_event_callback_add(), which will add event callbacks
3390 * per type on general Evas objects (no event propagation
3391 * infrastructure taken in account).
3393 * @note Not to be confused with @c
3394 * elm_object_signal_callback_add(), which will add callbacks to @b
3395 * signals coming from a widget's theme, not input events.
3397 * @note Not to be confused with @c
3398 * edje_object_signal_callback_add(), which does the same as
3399 * elm_object_signal_callback_add(), but directly on an Edje
3402 * @note Not to be confused with @c
3403 * evas_object_smart_callback_add(), which adds callbacks to smart
3404 * objects' <b>smart events</b>, and not input events.
3406 * @see elm_object_event_callback_del()
3410 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3413 * Remove an event callback from a widget.
3415 * This function removes a callback, previoulsy attached to event emission
3417 * The parameters func and data must match exactly those passed to
3418 * a previous call to elm_object_event_callback_add(). The data pointer that
3419 * was passed to this call will be returned.
3421 * @param obj The object
3422 * @param func The callback function to be executed when the event is
3424 * @param data Data to pass in to the callback function.
3425 * @return The data pointer
3428 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3431 * Adjust size of an element for finger usage.
3433 * @param times_w How many fingers should fit horizontally
3434 * @param w Pointer to the width size to adjust
3435 * @param times_h How many fingers should fit vertically
3436 * @param h Pointer to the height size to adjust
3438 * This takes width and height sizes (in pixels) as input and a
3439 * size multiple (which is how many fingers you want to place
3440 * within the area, being "finger" the size set by
3441 * elm_finger_size_set()), and adjusts the size to be large enough
3442 * to accommodate the resulting size -- if it doesn't already
3443 * accommodate it. On return the @p w and @p h sizes pointed to by
3444 * these parameters will be modified, on those conditions.
3446 * @note This is kind of a low level Elementary call, most useful
3447 * on size evaluation times for widgets. An external user wouldn't
3448 * be calling, most of the time.
3452 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3455 * Get the duration for occuring long press event.
3457 * @return Timeout for long press event
3458 * @ingroup Longpress
3460 EAPI double elm_longpress_timeout_get(void);
3463 * Set the duration for occuring long press event.
3465 * @param lonpress_timeout Timeout for long press event
3466 * @ingroup Longpress
3468 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3471 * @defgroup Debug Debug
3472 * don't use it unless you are sure
3478 * Print Tree object hierarchy in stdout
3480 * @param obj The root object
3483 EAPI void elm_object_tree_dump(const Evas_Object *top);
3486 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3488 * @param obj The root object
3489 * @param file The path of output file
3492 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3499 * @defgroup Theme Theme
3501 * Elementary uses Edje to theme its widgets, naturally. But for the most
3502 * part this is hidden behind a simpler interface that lets the user set
3503 * extensions and choose the style of widgets in a much easier way.
3505 * Instead of thinking in terms of paths to Edje files and their groups
3506 * each time you want to change the appearance of a widget, Elementary
3507 * works so you can add any theme file with extensions or replace the
3508 * main theme at one point in the application, and then just set the style
3509 * of widgets with elm_object_style_set() and related functions. Elementary
3510 * will then look in its list of themes for a matching group and apply it,
3511 * and when the theme changes midway through the application, all widgets
3512 * will be updated accordingly.
3514 * There are three concepts you need to know to understand how Elementary
3515 * theming works: default theme, extensions and overlays.
3517 * Default theme, obviously enough, is the one that provides the default
3518 * look of all widgets. End users can change the theme used by Elementary
3519 * by setting the @c ELM_THEME environment variable before running an
3520 * application, or globally for all programs using the @c elementary_config
3521 * utility. Applications can change the default theme using elm_theme_set(),
3522 * but this can go against the user wishes, so it's not an adviced practice.
3524 * Ideally, applications should find everything they need in the already
3525 * provided theme, but there may be occasions when that's not enough and
3526 * custom styles are required to correctly express the idea. For this
3527 * cases, Elementary has extensions.
3529 * Extensions allow the application developer to write styles of its own
3530 * to apply to some widgets. This requires knowledge of how each widget
3531 * is themed, as extensions will always replace the entire group used by
3532 * the widget, so important signals and parts need to be there for the
3533 * object to behave properly (see documentation of Edje for details).
3534 * Once the theme for the extension is done, the application needs to add
3535 * it to the list of themes Elementary will look into, using
3536 * elm_theme_extension_add(), and set the style of the desired widgets as
3537 * he would normally with elm_object_style_set().
3539 * Overlays, on the other hand, can replace the look of all widgets by
3540 * overriding the default style. Like extensions, it's up to the application
3541 * developer to write the theme for the widgets it wants, the difference
3542 * being that when looking for the theme, Elementary will check first the
3543 * list of overlays, then the set theme and lastly the list of extensions,
3544 * so with overlays it's possible to replace the default view and every
3545 * widget will be affected. This is very much alike to setting the whole
3546 * theme for the application and will probably clash with the end user
3547 * options, not to mention the risk of ending up with not matching styles
3548 * across the program. Unless there's a very special reason to use them,
3549 * overlays should be avoided for the resons exposed before.
3551 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3552 * keeps one default internally and every function that receives one of
3553 * these can be called with NULL to refer to this default (except for
3554 * elm_theme_free()). It's possible to create a new instance of a
3555 * ::Elm_Theme to set other theme for a specific widget (and all of its
3556 * children), but this is as discouraged, if not even more so, than using
3557 * overlays. Don't use this unless you really know what you are doing.
3559 * But to be less negative about things, you can look at the following
3561 * @li @ref theme_example_01 "Using extensions"
3562 * @li @ref theme_example_02 "Using overlays"
3567 * @typedef Elm_Theme
3569 * Opaque handler for the list of themes Elementary looks for when
3570 * rendering widgets.
3572 * Stay out of this unless you really know what you are doing. For most
3573 * cases, sticking to the default is all a developer needs.
3575 typedef struct _Elm_Theme Elm_Theme;
3578 * Create a new specific theme
3580 * This creates an empty specific theme that only uses the default theme. A
3581 * specific theme has its own private set of extensions and overlays too
3582 * (which are empty by default). Specific themes do not fall back to themes
3583 * of parent objects. They are not intended for this use. Use styles, overlays
3584 * and extensions when needed, but avoid specific themes unless there is no
3585 * other way (example: you want to have a preview of a new theme you are
3586 * selecting in a "theme selector" window. The preview is inside a scroller
3587 * and should display what the theme you selected will look like, but not
3588 * actually apply it yet. The child of the scroller will have a specific
3589 * theme set to show this preview before the user decides to apply it to all
3592 EAPI Elm_Theme *elm_theme_new(void);
3594 * Free a specific theme
3596 * @param th The theme to free
3598 * This frees a theme created with elm_theme_new().
3600 EAPI void elm_theme_free(Elm_Theme *th);
3602 * Copy the theme fom the source to the destination theme
3604 * @param th The source theme to copy from
3605 * @param thdst The destination theme to copy data to
3607 * This makes a one-time static copy of all the theme config, extensions
3608 * and overlays from @p th to @p thdst. If @p th references a theme, then
3609 * @p thdst is also set to reference it, with all the theme settings,
3610 * overlays and extensions that @p th had.
3612 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3614 * Tell the source theme to reference the ref theme
3616 * @param th The theme that will do the referencing
3617 * @param thref The theme that is the reference source
3619 * This clears @p th to be empty and then sets it to refer to @p thref
3620 * so @p th acts as an override to @p thref, but where its overrides
3621 * don't apply, it will fall through to @p thref for configuration.
3623 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3625 * Return the theme referred to
3627 * @param th The theme to get the reference from
3628 * @return The referenced theme handle
3630 * This gets the theme set as the reference theme by elm_theme_ref_set().
3631 * If no theme is set as a reference, NULL is returned.
3633 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3635 * Return the default theme
3637 * @return The default theme handle
3639 * This returns the internal default theme setup handle that all widgets
3640 * use implicitly unless a specific theme is set. This is also often use
3641 * as a shorthand of NULL.
3643 EAPI Elm_Theme *elm_theme_default_get(void);
3645 * Prepends a theme overlay to the list of overlays
3647 * @param th The theme to add to, or if NULL, the default theme
3648 * @param item The Edje file path to be used
3650 * Use this if your application needs to provide some custom overlay theme
3651 * (An Edje file that replaces some default styles of widgets) where adding
3652 * new styles, or changing system theme configuration is not possible. Do
3653 * NOT use this instead of a proper system theme configuration. Use proper
3654 * configuration files, profiles, environment variables etc. to set a theme
3655 * so that the theme can be altered by simple confiugration by a user. Using
3656 * this call to achieve that effect is abusing the API and will create lots
3659 * @see elm_theme_extension_add()
3661 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3663 * Delete a theme overlay from the list of overlays
3665 * @param th The theme to delete from, or if NULL, the default theme
3666 * @param item The name of the theme overlay
3668 * @see elm_theme_overlay_add()
3670 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3672 * Appends a theme extension to the list of extensions.
3674 * @param th The theme to add to, or if NULL, the default theme
3675 * @param item The Edje file path to be used
3677 * This is intended when an application needs more styles of widgets or new
3678 * widget themes that the default does not provide (or may not provide). The
3679 * application has "extended" usage by coming up with new custom style names
3680 * for widgets for specific uses, but as these are not "standard", they are
3681 * not guaranteed to be provided by a default theme. This means the
3682 * application is required to provide these extra elements itself in specific
3683 * Edje files. This call adds one of those Edje files to the theme search
3684 * path to be search after the default theme. The use of this call is
3685 * encouraged when default styles do not meet the needs of the application.
3686 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3688 * @see elm_object_style_set()
3690 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3692 * Deletes a theme extension from the list of extensions.
3694 * @param th The theme to delete from, or if NULL, the default theme
3695 * @param item The name of the theme extension
3697 * @see elm_theme_extension_add()
3699 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3701 * Set the theme search order for the given theme
3703 * @param th The theme to set the search order, or if NULL, the default theme
3704 * @param theme Theme search string
3706 * This sets the search string for the theme in path-notation from first
3707 * theme to search, to last, delimited by the : character. Example:
3709 * "shiny:/path/to/file.edj:default"
3711 * See the ELM_THEME environment variable for more information.
3713 * @see elm_theme_get()
3714 * @see elm_theme_list_get()
3716 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3718 * Return the theme search order
3720 * @param th The theme to get the search order, or if NULL, the default theme
3721 * @return The internal search order path
3723 * This function returns a colon separated string of theme elements as
3724 * returned by elm_theme_list_get().
3726 * @see elm_theme_set()
3727 * @see elm_theme_list_get()
3729 EAPI const char *elm_theme_get(Elm_Theme *th);
3731 * Return a list of theme elements to be used in a theme.
3733 * @param th Theme to get the list of theme elements from.
3734 * @return The internal list of theme elements
3736 * This returns the internal list of theme elements (will only be valid as
3737 * long as the theme is not modified by elm_theme_set() or theme is not
3738 * freed by elm_theme_free(). This is a list of strings which must not be
3739 * altered as they are also internal. If @p th is NULL, then the default
3740 * theme element list is returned.
3742 * A theme element can consist of a full or relative path to a .edj file,
3743 * or a name, without extension, for a theme to be searched in the known
3744 * theme paths for Elemementary.
3746 * @see elm_theme_set()
3747 * @see elm_theme_get()
3749 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3751 * Return the full patrh for a theme element
3753 * @param f The theme element name
3754 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3755 * @return The full path to the file found.
3757 * This returns a string you should free with free() on success, NULL on
3758 * failure. This will search for the given theme element, and if it is a
3759 * full or relative path element or a simple searchable name. The returned
3760 * path is the full path to the file, if searched, and the file exists, or it
3761 * is simply the full path given in the element or a resolved path if
3762 * relative to home. The @p in_search_path boolean pointed to is set to
3763 * EINA_TRUE if the file was a searchable file andis in the search path,
3764 * and EINA_FALSE otherwise.
3766 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3768 * Flush the current theme.
3770 * @param th Theme to flush
3772 * This flushes caches that let elementary know where to find theme elements
3773 * in the given theme. If @p th is NULL, then the default theme is flushed.
3774 * Call this function if source theme data has changed in such a way as to
3775 * make any caches Elementary kept invalid.
3777 EAPI void elm_theme_flush(Elm_Theme *th);
3779 * This flushes all themes (default and specific ones).
3781 * This will flush all themes in the current application context, by calling
3782 * elm_theme_flush() on each of them.
3784 EAPI void elm_theme_full_flush(void);
3786 * Set the theme for all elementary using applications on the current display
3788 * @param theme The name of the theme to use. Format same as the ELM_THEME
3789 * environment variable.
3791 EAPI void elm_theme_all_set(const char *theme);
3793 * Return a list of theme elements in the theme search path
3795 * @return A list of strings that are the theme element names.
3797 * This lists all available theme files in the standard Elementary search path
3798 * for theme elements, and returns them in alphabetical order as theme
3799 * element names in a list of strings. Free this with
3800 * elm_theme_name_available_list_free() when you are done with the list.
3802 EAPI Eina_List *elm_theme_name_available_list_new(void);
3804 * Free the list returned by elm_theme_name_available_list_new()
3806 * This frees the list of themes returned by
3807 * elm_theme_name_available_list_new(). Once freed the list should no longer
3808 * be used. a new list mys be created.
3810 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3812 * Set a specific theme to be used for this object and its children
3814 * @param obj The object to set the theme on
3815 * @param th The theme to set
3817 * This sets a specific theme that will be used for the given object and any
3818 * child objects it has. If @p th is NULL then the theme to be used is
3819 * cleared and the object will inherit its theme from its parent (which
3820 * ultimately will use the default theme if no specific themes are set).
3822 * Use special themes with great care as this will annoy users and make
3823 * configuration difficult. Avoid any custom themes at all if it can be
3826 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3828 * Get the specific theme to be used
3830 * @param obj The object to get the specific theme from
3831 * @return The specifc theme set.
3833 * This will return a specific theme set, or NULL if no specific theme is
3834 * set on that object. It will not return inherited themes from parents, only
3835 * the specific theme set for that specific object. See elm_object_theme_set()
3836 * for more information.
3838 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3841 * Get a data item from a theme
3843 * @param th The theme, or NULL for default theme
3844 * @param key The data key to search with
3845 * @return The data value, or NULL on failure
3847 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3848 * It works the same way as edje_file_data_get() except that the return is stringshared.
3850 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3856 /** @defgroup Win Win
3858 * @image html img/widget/win/preview-00.png
3859 * @image latex img/widget/win/preview-00.eps
3861 * The window class of Elementary. Contains functions to manipulate
3862 * windows. The Evas engine used to render the window contents is specified
3863 * in the system or user elementary config files (whichever is found last),
3864 * and can be overridden with the ELM_ENGINE environment variable for
3865 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3866 * compilation setup and modules actually installed at runtime) are (listed
3867 * in order of best supported and most likely to be complete and work to
3870 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3871 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3873 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3875 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3877 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3879 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3880 * rendering using SDL as the buffer)
3881 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3882 * GDI with software)
3883 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3884 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3885 * grayscale using dedicated 8bit software engine in X11)
3886 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3887 * X11 using 16bit software engine)
3888 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3889 * (Windows CE rendering via GDI with 16bit software renderer)
3890 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3891 * buffer with 16bit software renderer)
3892 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3893 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3894 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3896 * All engines use a simple string to select the engine to render, EXCEPT
3897 * the "shot" engine. This actually encodes the output of the virtual
3898 * screenshot and how long to delay in the engine string. The engine string
3899 * is encoded in the following way:
3901 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3903 * Where options are separated by a ":" char if more than one option is
3904 * given, with delay, if provided being the first option and file the last
3905 * (order is important). The delay specifies how long to wait after the
3906 * window is shown before doing the virtual "in memory" rendering and then
3907 * save the output to the file specified by the file option (and then exit).
3908 * If no delay is given, the default is 0.5 seconds. If no file is given the
3909 * default output file is "out.png". Repeat option is for continous
3910 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3911 * fixed to "out001.png" Some examples of using the shot engine:
3913 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3914 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3915 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3916 * ELM_ENGINE="shot:delay=2.0" elementary_test
3917 * ELM_ENGINE="shot:" elementary_test
3919 * Signals that you can add callbacks for are:
3921 * @li "delete,request": the user requested to close the window. See
3922 * elm_win_autodel_set().
3923 * @li "focus,in": window got focus
3924 * @li "focus,out": window lost focus
3925 * @li "moved": window that holds the canvas was moved
3928 * @li @ref win_example_01
3933 * Defines the types of window that can be created
3935 * These are hints set on the window so that a running Window Manager knows
3936 * how the window should be handled and/or what kind of decorations it
3939 * Currently, only the X11 backed engines use them.
3941 typedef enum _Elm_Win_Type
3943 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3944 window. Almost every window will be created with this
3946 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3947 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3948 window holding desktop icons. */
3949 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3950 be kept on top of any other window by the Window
3952 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3954 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3955 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3957 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3958 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3959 entry in a menubar is clicked. Typically used
3960 with elm_win_override_set(). This hint exists
3961 for completion only, as the EFL way of
3962 implementing a menu would not normally use a
3963 separate window for its contents. */
3964 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3965 triggered by right-clicking an object. */
3966 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3967 explanatory text that typically appear after the
3968 mouse cursor hovers over an object for a while.
3969 Typically used with elm_win_override_set() and also
3970 not very commonly used in the EFL. */
3971 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3972 battery life or a new E-Mail received. */
3973 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3974 usually used in the EFL. */
3975 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3976 object being dragged across different windows, or even
3977 applications. Typically used with
3978 elm_win_override_set(). */
3979 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3980 buffer. No actual window is created for this
3981 type, instead the window and all of its
3982 contents will be rendered to an image buffer.
3983 This allows to have children window inside a
3984 parent one just like any other object would
3985 be, and do other things like applying @c
3986 Evas_Map effects to it. This is the only type
3987 of window that requires the @c parent
3988 parameter of elm_win_add() to be a valid @c
3993 * The differents layouts that can be requested for the virtual keyboard.
3995 * When the application window is being managed by Illume, it may request
3996 * any of the following layouts for the virtual keyboard.
3998 typedef enum _Elm_Win_Keyboard_Mode
4000 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4001 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4002 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4003 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4004 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4005 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4006 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4007 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4008 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4009 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4010 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4011 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4012 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4013 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4014 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4015 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4016 } Elm_Win_Keyboard_Mode;
4019 * Available commands that can be sent to the Illume manager.
4021 * When running under an Illume session, a window may send commands to the
4022 * Illume manager to perform different actions.
4024 typedef enum _Elm_Illume_Command
4026 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4028 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4030 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4032 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4033 } Elm_Illume_Command;
4036 * Adds a window object. If this is the first window created, pass NULL as
4039 * @param parent Parent object to add the window to, or NULL
4040 * @param name The name of the window
4041 * @param type The window type, one of #Elm_Win_Type.
4043 * The @p parent paramter can be @c NULL for every window @p type except
4044 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4045 * which the image object will be created.
4047 * @return The created object, or NULL on failure
4049 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4051 * Adds a window object with standard setup
4053 * @param name The name of the window
4054 * @param title The title for the window
4056 * This creates a window like elm_win_add() but also puts in a standard
4057 * background with elm_bg_add(), as well as setting the window title to
4058 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4059 * as the parent widget.
4061 * @return The created object, or NULL on failure
4063 * @see elm_win_add()
4065 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4067 * Add @p subobj as a resize object of window @p obj.
4070 * Setting an object as a resize object of the window means that the
4071 * @p subobj child's size and position will be controlled by the window
4072 * directly. That is, the object will be resized to match the window size
4073 * and should never be moved or resized manually by the developer.
4075 * In addition, resize objects of the window control what the minimum size
4076 * of it will be, as well as whether it can or not be resized by the user.
4078 * For the end user to be able to resize a window by dragging the handles
4079 * or borders provided by the Window Manager, or using any other similar
4080 * mechanism, all of the resize objects in the window should have their
4081 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4083 * Also notice that the window can get resized to the current size of the
4084 * object if the EVAS_HINT_EXPAND is set @b after the call to
4085 * elm_win_resize_object_add(). So if the object should get resized to the
4086 * size of the window, set this hint @b before adding it as a resize object
4087 * (this happens because the size of the window and the object are evaluated
4088 * as soon as the object is added to the window).
4090 * @param obj The window object
4091 * @param subobj The resize object to add
4093 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4095 * Delete @p subobj as a resize object of window @p obj.
4097 * This function removes the object @p subobj from the resize objects of
4098 * the window @p obj. It will not delete the object itself, which will be
4099 * left unmanaged and should be deleted by the developer, manually handled
4100 * or set as child of some other container.
4102 * @param obj The window object
4103 * @param subobj The resize object to add
4105 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4107 * Set the title of the window
4109 * @param obj The window object
4110 * @param title The title to set
4112 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4114 * Get the title of the window
4116 * The returned string is an internal one and should not be freed or
4117 * modified. It will also be rendered invalid if a new title is set or if
4118 * the window is destroyed.
4120 * @param obj The window object
4123 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4125 * Set the window's autodel state.
4127 * When closing the window in any way outside of the program control, like
4128 * pressing the X button in the titlebar or using a command from the
4129 * Window Manager, a "delete,request" signal is emitted to indicate that
4130 * this event occurred and the developer can take any action, which may
4131 * include, or not, destroying the window object.
4133 * When the @p autodel parameter is set, the window will be automatically
4134 * destroyed when this event occurs, after the signal is emitted.
4135 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4136 * and is up to the program to do so when it's required.
4138 * @param obj The window object
4139 * @param autodel If true, the window will automatically delete itself when
4142 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4144 * Get the window's autodel state.
4146 * @param obj The window object
4147 * @return If the window will automatically delete itself when closed
4149 * @see elm_win_autodel_set()
4151 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4153 * Activate a window object.
4155 * This function sends a request to the Window Manager to activate the
4156 * window pointed by @p obj. If honored by the WM, the window will receive
4157 * the keyboard focus.
4159 * @note This is just a request that a Window Manager may ignore, so calling
4160 * this function does not ensure in any way that the window will be the
4161 * active one after it.
4163 * @param obj The window object
4165 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4167 * Lower a window object.
4169 * Places the window pointed by @p obj at the bottom of the stack, so that
4170 * no other window is covered by it.
4172 * If elm_win_override_set() is not set, the Window Manager may ignore this
4175 * @param obj The window object
4177 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4179 * Raise a window object.
4181 * Places the window pointed by @p obj at the top of the stack, so that it's
4182 * not covered by any other window.
4184 * If elm_win_override_set() is not set, the Window Manager may ignore this
4187 * @param obj The window object
4189 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4191 * Set the borderless state of a window.
4193 * This function requests the Window Manager to not draw any decoration
4194 * around the window.
4196 * @param obj The window object
4197 * @param borderless If true, the window is borderless
4199 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4201 * Get the borderless state of a window.
4203 * @param obj The window object
4204 * @return If true, the window is borderless
4206 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4208 * Set the shaped state of a window.
4210 * Shaped windows, when supported, will render the parts of the window that
4211 * has no content, transparent.
4213 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4214 * background object or cover the entire window in any other way, or the
4215 * parts of the canvas that have no data will show framebuffer artifacts.
4217 * @param obj The window object
4218 * @param shaped If true, the window is shaped
4220 * @see elm_win_alpha_set()
4222 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4224 * Get the shaped state of a window.
4226 * @param obj The window object
4227 * @return If true, the window is shaped
4229 * @see elm_win_shaped_set()
4231 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4233 * Set the alpha channel state of a window.
4235 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4236 * possibly making parts of the window completely or partially transparent.
4237 * This is also subject to the underlying system supporting it, like for
4238 * example, running under a compositing manager. If no compositing is
4239 * available, enabling this option will instead fallback to using shaped
4240 * windows, with elm_win_shaped_set().
4242 * @param obj The window object
4243 * @param alpha If true, the window has an alpha channel
4245 * @see elm_win_alpha_set()
4247 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4249 * Get the transparency state of a window.
4251 * @param obj The window object
4252 * @return If true, the window is transparent
4254 * @see elm_win_transparent_set()
4256 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4258 * Set the transparency state of a window.
4260 * Use elm_win_alpha_set() instead.
4262 * @param obj The window object
4263 * @param transparent If true, the window is transparent
4265 * @see elm_win_alpha_set()
4267 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4269 * Get the alpha channel state of a window.
4271 * @param obj The window object
4272 * @return If true, the window has an alpha channel
4274 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4276 * Set the override state of a window.
4278 * A window with @p override set to EINA_TRUE will not be managed by the
4279 * Window Manager. This means that no decorations of any kind will be shown
4280 * for it, moving and resizing must be handled by the application, as well
4281 * as the window visibility.
4283 * This should not be used for normal windows, and even for not so normal
4284 * ones, it should only be used when there's a good reason and with a lot
4285 * of care. Mishandling override windows may result situations that
4286 * disrupt the normal workflow of the end user.
4288 * @param obj The window object
4289 * @param override If true, the window is overridden
4291 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4293 * Get the override state of a window.
4295 * @param obj The window object
4296 * @return If true, the window is overridden
4298 * @see elm_win_override_set()
4300 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4302 * Set the fullscreen state of a window.
4304 * @param obj The window object
4305 * @param fullscreen If true, the window is fullscreen
4307 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4309 * Get the fullscreen state of a window.
4311 * @param obj The window object
4312 * @return If true, the window is fullscreen
4314 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4316 * Set the maximized state of a window.
4318 * @param obj The window object
4319 * @param maximized If true, the window is maximized
4321 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4323 * Get the maximized state of a window.
4325 * @param obj The window object
4326 * @return If true, the window is maximized
4328 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 * Set the iconified state of a window.
4332 * @param obj The window object
4333 * @param iconified If true, the window is iconified
4335 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4337 * Get the iconified state of a window.
4339 * @param obj The window object
4340 * @return If true, the window is iconified
4342 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4344 * Set the layer of the window.
4346 * What this means exactly will depend on the underlying engine used.
4348 * In the case of X11 backed engines, the value in @p layer has the
4349 * following meanings:
4350 * @li < 3: The window will be placed below all others.
4351 * @li > 5: The window will be placed above all others.
4352 * @li other: The window will be placed in the default layer.
4354 * @param obj The window object
4355 * @param layer The layer of the window
4357 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4359 * Get the layer of the window.
4361 * @param obj The window object
4362 * @return The layer of the window
4364 * @see elm_win_layer_set()
4366 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368 * Set the rotation of the window.
4370 * Most engines only work with multiples of 90.
4372 * This function is used to set the orientation of the window @p obj to
4373 * match that of the screen. The window itself will be resized to adjust
4374 * to the new geometry of its contents. If you want to keep the window size,
4375 * see elm_win_rotation_with_resize_set().
4377 * @param obj The window object
4378 * @param rotation The rotation of the window, in degrees (0-360),
4379 * counter-clockwise.
4381 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4383 * Rotates the window and resizes it.
4385 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4386 * that they fit inside the current window geometry.
4388 * @param obj The window object
4389 * @param layer The rotation of the window in degrees (0-360),
4390 * counter-clockwise.
4392 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4394 * Get the rotation of the window.
4396 * @param obj The window object
4397 * @return The rotation of the window in degrees (0-360)
4399 * @see elm_win_rotation_set()
4400 * @see elm_win_rotation_with_resize_set()
4402 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4404 * Set the sticky state of the window.
4406 * Hints the Window Manager that the window in @p obj should be left fixed
4407 * at its position even when the virtual desktop it's on moves or changes.
4409 * @param obj The window object
4410 * @param sticky If true, the window's sticky state is enabled
4412 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4414 * Get the sticky state of the window.
4416 * @param obj The window object
4417 * @return If true, the window's sticky state is enabled
4419 * @see elm_win_sticky_set()
4421 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4423 * Set if this window is an illume conformant window
4425 * @param obj The window object
4426 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4428 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4430 * Get if this window is an illume conformant window
4432 * @param obj The window object
4433 * @return A boolean if this window is illume conformant or not
4435 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4437 * Set a window to be an illume quickpanel window
4439 * By default window objects are not quickpanel windows.
4441 * @param obj The window object
4442 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4444 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4446 * Get if this window is a quickpanel or not
4448 * @param obj The window object
4449 * @return A boolean if this window is a quickpanel or not
4451 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4453 * Set the major priority of a quickpanel window
4455 * @param obj The window object
4456 * @param priority The major priority for this quickpanel
4458 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4460 * Get the major priority of a quickpanel window
4462 * @param obj The window object
4463 * @return The major priority of this quickpanel
4465 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4467 * Set the minor priority of a quickpanel window
4469 * @param obj The window object
4470 * @param priority The minor priority for this quickpanel
4472 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4474 * Get the minor priority of a quickpanel window
4476 * @param obj The window object
4477 * @return The minor priority of this quickpanel
4479 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4481 * Set which zone this quickpanel should appear in
4483 * @param obj The window object
4484 * @param zone The requested zone for this quickpanel
4486 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4488 * Get which zone this quickpanel should appear in
4490 * @param obj The window object
4491 * @return The requested zone for this quickpanel
4493 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4495 * Set the window to be skipped by keyboard focus
4497 * This sets the window to be skipped by normal keyboard input. This means
4498 * a window manager will be asked to not focus this window as well as omit
4499 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4501 * Call this and enable it on a window BEFORE you show it for the first time,
4502 * otherwise it may have no effect.
4504 * Use this for windows that have only output information or might only be
4505 * interacted with by the mouse or fingers, and never for typing input.
4506 * Be careful that this may have side-effects like making the window
4507 * non-accessible in some cases unless the window is specially handled. Use
4510 * @param obj The window object
4511 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4513 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4515 * Send a command to the windowing environment
4517 * This is intended to work in touchscreen or small screen device
4518 * environments where there is a more simplistic window management policy in
4519 * place. This uses the window object indicated to select which part of the
4520 * environment to control (the part that this window lives in), and provides
4521 * a command and an optional parameter structure (use NULL for this if not
4524 * @param obj The window object that lives in the environment to control
4525 * @param command The command to send
4526 * @param params Optional parameters for the command
4528 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4530 * Get the inlined image object handle
4532 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4533 * then the window is in fact an evas image object inlined in the parent
4534 * canvas. You can get this object (be careful to not manipulate it as it
4535 * is under control of elementary), and use it to do things like get pixel
4536 * data, save the image to a file, etc.
4538 * @param obj The window object to get the inlined image from
4539 * @return The inlined image object, or NULL if none exists
4541 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4543 * Determine whether a window has focus
4544 * @param obj The window to query
4545 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4547 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4549 * Get screen geometry details for the screen that a window is on
4550 * @param obj The window to query
4551 * @param x where to return the horizontal offset value. May be NULL.
4552 * @param y where to return the vertical offset value. May be NULL.
4553 * @param w where to return the width value. May be NULL.
4554 * @param h where to return the height value. May be NULL.
4556 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4558 * Set the enabled status for the focus highlight in a window
4560 * This function will enable or disable the focus highlight only for the
4561 * given window, regardless of the global setting for it
4563 * @param obj The window where to enable the highlight
4564 * @param enabled The enabled value for the highlight
4566 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4568 * Get the enabled value of the focus highlight for this window
4570 * @param obj The window in which to check if the focus highlight is enabled
4572 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4574 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4576 * Set the style for the focus highlight on this window
4578 * Sets the style to use for theming the highlight of focused objects on
4579 * the given window. If @p style is NULL, the default will be used.
4581 * @param obj The window where to set the style
4582 * @param style The style to set
4584 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4586 * Get the style set for the focus highlight object
4588 * Gets the style set for this windows highilght object, or NULL if none
4591 * @param obj The window to retrieve the highlights style from
4593 * @return The style set or NULL if none was. Default is used in that case.
4595 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4597 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4598 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4599 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4600 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4601 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4602 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4603 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4605 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4606 * (blank mouse, private mouse obj, defaultmouse)
4610 * Sets the keyboard mode of the window.
4612 * @param obj The window object
4613 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4615 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4617 * Gets the keyboard mode of the window.
4619 * @param obj The window object
4620 * @return The mode, one of #Elm_Win_Keyboard_Mode
4622 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4624 * Sets whether the window is a keyboard.
4626 * @param obj The window object
4627 * @param is_keyboard If true, the window is a virtual keyboard
4629 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4631 * Gets whether the window is a keyboard.
4633 * @param obj The window object
4634 * @return If the window is a virtual keyboard
4636 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4639 * Get the screen position of a window.
4641 * @param obj The window object
4642 * @param x The int to store the x coordinate to
4643 * @param y The int to store the y coordinate to
4645 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4651 * @defgroup Inwin Inwin
4653 * @image html img/widget/inwin/preview-00.png
4654 * @image latex img/widget/inwin/preview-00.eps
4655 * @image html img/widget/inwin/preview-01.png
4656 * @image latex img/widget/inwin/preview-01.eps
4657 * @image html img/widget/inwin/preview-02.png
4658 * @image latex img/widget/inwin/preview-02.eps
4660 * An inwin is a window inside a window that is useful for a quick popup.
4661 * It does not hover.
4663 * It works by creating an object that will occupy the entire window, so it
4664 * must be created using an @ref Win "elm_win" as parent only. The inwin
4665 * object can be hidden or restacked below every other object if it's
4666 * needed to show what's behind it without destroying it. If this is done,
4667 * the elm_win_inwin_activate() function can be used to bring it back to
4668 * full visibility again.
4670 * There are three styles available in the default theme. These are:
4671 * @li default: The inwin is sized to take over most of the window it's
4673 * @li minimal: The size of the inwin will be the minimum necessary to show
4675 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4676 * possible, but it's sized vertically the most it needs to fit its\
4679 * Some examples of Inwin can be found in the following:
4680 * @li @ref inwin_example_01
4685 * Adds an inwin to the current window
4687 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4688 * Never call this function with anything other than the top-most window
4689 * as its parameter, unless you are fond of undefined behavior.
4691 * After creating the object, the widget will set itself as resize object
4692 * for the window with elm_win_resize_object_add(), so when shown it will
4693 * appear to cover almost the entire window (how much of it depends on its
4694 * content and the style used). It must not be added into other container
4695 * objects and it needs not be moved or resized manually.
4697 * @param parent The parent object
4698 * @return The new object or NULL if it cannot be created
4700 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4702 * Activates an inwin object, ensuring its visibility
4704 * This function will make sure that the inwin @p obj is completely visible
4705 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4706 * to the front. It also sets the keyboard focus to it, which will be passed
4709 * The object's theme will also receive the signal "elm,action,show" with
4712 * @param obj The inwin to activate
4714 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4716 * Set the content of an inwin object.
4718 * Once the content object is set, a previously set one will be deleted.
4719 * If you want to keep that old content object, use the
4720 * elm_win_inwin_content_unset() function.
4722 * @param obj The inwin object
4723 * @param content The object to set as content
4725 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4727 * Get the content of an inwin object.
4729 * Return the content object which is set for this widget.
4731 * The returned object is valid as long as the inwin is still alive and no
4732 * other content is set on it. Deleting the object will notify the inwin
4733 * about it and this one will be left empty.
4735 * If you need to remove an inwin's content to be reused somewhere else,
4736 * see elm_win_inwin_content_unset().
4738 * @param obj The inwin object
4739 * @return The content that is being used
4741 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4743 * Unset the content of an inwin object.
4745 * Unparent and return the content object which was set for this widget.
4747 * @param obj The inwin object
4748 * @return The content that was being used
4750 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4754 /* X specific calls - won't work on non-x engines (return 0) */
4757 * Get the Ecore_X_Window of an Evas_Object
4759 * @param obj The object
4761 * @return The Ecore_X_Window of @p obj
4765 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4767 /* smart callbacks called:
4768 * "delete,request" - the user requested to delete the window
4769 * "focus,in" - window got focus
4770 * "focus,out" - window lost focus
4771 * "moved" - window that holds the canvas was moved
4777 * @image html img/widget/bg/preview-00.png
4778 * @image latex img/widget/bg/preview-00.eps
4780 * @brief Background object, used for setting a solid color, image or Edje
4781 * group as background to a window or any container object.
4783 * The bg object is used for setting a solid background to a window or
4784 * packing into any container object. It works just like an image, but has
4785 * some properties useful to a background, like setting it to tiled,
4786 * centered, scaled or stretched.
4788 * Default contents parts of the bg widget that you can use for are:
4789 * @li "overlay" - overlay of the bg
4791 * Here is some sample code using it:
4792 * @li @ref bg_01_example_page
4793 * @li @ref bg_02_example_page
4794 * @li @ref bg_03_example_page
4798 typedef enum _Elm_Bg_Option
4800 ELM_BG_OPTION_CENTER, /**< center the background */
4801 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4802 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4803 ELM_BG_OPTION_TILE /**< tile background at its original size */
4807 * Add a new background to the parent
4809 * @param parent The parent object
4810 * @return The new object or NULL if it cannot be created
4814 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4817 * Set the file (image or edje) used for the background
4819 * @param obj The bg object
4820 * @param file The file path
4821 * @param group Optional key (group in Edje) within the file
4823 * This sets the image file used in the background object. The image (or edje)
4824 * will be stretched (retaining aspect if its an image file) to completely fill
4825 * the bg object. This may mean some parts are not visible.
4827 * @note Once the image of @p obj is set, a previously set one will be deleted,
4828 * even if @p file is NULL.
4832 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4835 * Get the file (image or edje) used for the background
4837 * @param obj The bg object
4838 * @param file The file path
4839 * @param group Optional key (group in Edje) within the file
4843 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4846 * Set the option used for the background image
4848 * @param obj The bg object
4849 * @param option The desired background option (TILE, SCALE)
4851 * This sets the option used for manipulating the display of the background
4852 * image. The image can be tiled or scaled.
4856 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4859 * Get the option used for the background image
4861 * @param obj The bg object
4862 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4866 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4868 * Set the option used for the background color
4870 * @param obj The bg object
4875 * This sets the color used for the background rectangle. Its range goes
4880 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4882 * Get the option used for the background color
4884 * @param obj The bg object
4891 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4894 * Set the overlay object used for the background object.
4896 * @param obj The bg object
4897 * @param overlay The overlay object
4899 * This provides a way for elm_bg to have an 'overlay' that will be on top
4900 * of the bg. Once the over object is set, a previously set one will be
4901 * deleted, even if you set the new one to NULL. If you want to keep that
4902 * old content object, use the elm_bg_overlay_unset() function.
4904 * @deprecated use elm_object_part_content_set() instead
4909 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4912 * Get the overlay object used for the background object.
4914 * @param obj The bg object
4915 * @return The content that is being used
4917 * Return the content object which is set for this widget
4919 * @deprecated use elm_object_part_content_get() instead
4923 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4926 * Get the overlay object used for the background object.
4928 * @param obj The bg object
4929 * @return The content that was being used
4931 * Unparent and return the overlay object which was set for this widget
4933 * @deprecated use elm_object_part_content_unset() instead
4937 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4940 * Set the size of the pixmap representation of the image.
4942 * This option just makes sense if an image is going to be set in the bg.
4944 * @param obj The bg object
4945 * @param w The new width of the image pixmap representation.
4946 * @param h The new height of the image pixmap representation.
4948 * This function sets a new size for pixmap representation of the given bg
4949 * image. It allows the image to be loaded already in the specified size,
4950 * reducing the memory usage and load time when loading a big image with load
4951 * size set to a smaller size.
4953 * NOTE: this is just a hint, the real size of the pixmap may differ
4954 * depending on the type of image being loaded, being bigger than requested.
4958 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4959 /* smart callbacks called:
4963 * @defgroup Icon Icon
4965 * @image html img/widget/icon/preview-00.png
4966 * @image latex img/widget/icon/preview-00.eps
4968 * An object that provides standard icon images (delete, edit, arrows, etc.)
4969 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4971 * The icon image requested can be in the elementary theme, or in the
4972 * freedesktop.org paths. It's possible to set the order of preference from
4973 * where the image will be used.
4975 * This API is very similar to @ref Image, but with ready to use images.
4977 * Default images provided by the theme are described below.
4979 * The first list contains icons that were first intended to be used in
4980 * toolbars, but can be used in many other places too:
4996 * Now some icons that were designed to be used in menus (but again, you can
4997 * use them anywhere else):
5002 * @li menu/arrow_down
5003 * @li menu/arrow_left
5004 * @li menu/arrow_right
5013 * And here we have some media player specific icons:
5014 * @li media_player/forward
5015 * @li media_player/info
5016 * @li media_player/next
5017 * @li media_player/pause
5018 * @li media_player/play
5019 * @li media_player/prev
5020 * @li media_player/rewind
5021 * @li media_player/stop
5023 * Signals that you can add callbacks for are:
5025 * "clicked" - This is called when a user has clicked the icon
5027 * An example of usage for this API follows:
5028 * @li @ref tutorial_icon
5036 typedef enum _Elm_Icon_Type
5043 * @enum _Elm_Icon_Lookup_Order
5044 * @typedef Elm_Icon_Lookup_Order
5046 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5047 * theme, FDO paths, or both?
5051 typedef enum _Elm_Icon_Lookup_Order
5053 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5054 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5055 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
5056 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
5057 } Elm_Icon_Lookup_Order;
5060 * Add a new icon object to the parent.
5062 * @param parent The parent object
5063 * @return The new object or NULL if it cannot be created
5065 * @see elm_icon_file_set()
5069 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5071 * Set the file that will be used as icon.
5073 * @param obj The icon object
5074 * @param file The path to file that will be used as icon image
5075 * @param group The group that the icon belongs to an edje file
5077 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5079 * @note The icon image set by this function can be changed by
5080 * elm_icon_standard_set().
5082 * @see elm_icon_file_get()
5086 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5088 * Set a location in memory to be used as an icon
5090 * @param obj The icon object
5091 * @param img The binary data that will be used as an image
5092 * @param size The size of binary data @p img
5093 * @param format Optional format of @p img to pass to the image loader
5094 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5096 * The @p format string should be something like "png", "jpg", "tga",
5097 * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5098 * the loader performance as it tries the "correct" loader first before
5099 * trying a range of other possible loaders until one succeeds.
5101 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5103 * @note The icon image set by this function can be changed by
5104 * elm_icon_standard_set().
5108 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);
5110 * Get the file that will be used as icon.
5112 * @param obj The icon object
5113 * @param file The path to file that will be used as the icon image
5114 * @param group The group that the icon belongs to, in edje file
5116 * @see elm_icon_file_set()
5120 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5122 * Set the file that will be used, but use a generated thumbnail.
5124 * @param obj The icon object
5125 * @param file The path to file that will be used as icon image
5126 * @param group The group that the icon belongs to an edje file
5128 * This functions like elm_icon_file_set() but requires the Ethumb library
5129 * support to be enabled successfully with elm_need_ethumb(). When set
5130 * the file indicated has a thumbnail generated and cached on disk for
5131 * future use or will directly use an existing cached thumbnail if it
5134 * @see elm_icon_file_set()
5138 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5140 * Set the icon by icon standards names.
5142 * @param obj The icon object
5143 * @param name The icon name
5145 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5147 * For example, freedesktop.org defines standard icon names such as "home",
5148 * "network", etc. There can be different icon sets to match those icon
5149 * keys. The @p name given as parameter is one of these "keys", and will be
5150 * used to look in the freedesktop.org paths and elementary theme. One can
5151 * change the lookup order with elm_icon_order_lookup_set().
5153 * If name is not found in any of the expected locations and it is the
5154 * absolute path of an image file, this image will be used.
5156 * @note The icon image set by this function can be changed by
5157 * elm_icon_file_set().
5159 * @see elm_icon_standard_get()
5160 * @see elm_icon_file_set()
5164 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5166 * Get the icon name set by icon standard names.
5168 * @param obj The icon object
5169 * @return The icon name
5171 * If the icon image was set using elm_icon_file_set() instead of
5172 * elm_icon_standard_set(), then this function will return @c NULL.
5174 * @see elm_icon_standard_set()
5178 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5180 * Set the smooth scaling for an icon object.
5182 * @param obj The icon object
5183 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5184 * otherwise. Default is @c EINA_TRUE.
5186 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5187 * scaling provides a better resulting image, but is slower.
5189 * The smooth scaling should be disabled when making animations that change
5190 * the icon size, since they will be faster. Animations that don't require
5191 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5192 * is already scaled, since the scaled icon image will be cached).
5194 * @see elm_icon_smooth_get()
5198 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5200 * Get whether smooth scaling is enabled for an icon object.
5202 * @param obj The icon object
5203 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5205 * @see elm_icon_smooth_set()
5209 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5211 * Disable scaling of this object.
5213 * @param obj The icon object.
5214 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5215 * otherwise. Default is @c EINA_FALSE.
5217 * This function disables scaling of the icon object through the function
5218 * elm_object_scale_set(). However, this does not affect the object
5219 * size/resize in any way. For that effect, take a look at
5220 * elm_icon_scale_set().
5222 * @see elm_icon_no_scale_get()
5223 * @see elm_icon_scale_set()
5224 * @see elm_object_scale_set()
5228 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5230 * Get whether scaling is disabled on the object.
5232 * @param obj The icon object
5233 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5235 * @see elm_icon_no_scale_set()
5239 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5241 * Set if the object is (up/down) resizable.
5243 * @param obj The icon object
5244 * @param scale_up A bool to set if the object is resizable up. Default is
5246 * @param scale_down A bool to set if the object is resizable down. Default
5249 * This function limits the icon object resize ability. If @p scale_up is set to
5250 * @c EINA_FALSE, the object can't have its height or width resized to a value
5251 * higher than the original icon size. Same is valid for @p scale_down.
5253 * @see elm_icon_scale_get()
5257 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5259 * Get if the object is (up/down) resizable.
5261 * @param obj The icon object
5262 * @param scale_up A bool to set if the object is resizable up
5263 * @param scale_down A bool to set if the object is resizable down
5265 * @see elm_icon_scale_set()
5269 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5271 * Get the object's image size
5273 * @param obj The icon object
5274 * @param w A pointer to store the width in
5275 * @param h A pointer to store the height in
5279 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5281 * Set if the icon fill the entire object area.
5283 * @param obj The icon object
5284 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5285 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5287 * When the icon object is resized to a different aspect ratio from the
5288 * original icon image, the icon image will still keep its aspect. This flag
5289 * tells how the image should fill the object's area. They are: keep the
5290 * entire icon inside the limits of height and width of the object (@p
5291 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5292 * of the object, and the icon will fill the entire object (@p fill_outside
5295 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5296 * retain property to false. Thus, the icon image will always keep its
5297 * original aspect ratio.
5299 * @see elm_icon_fill_outside_get()
5300 * @see elm_image_fill_outside_set()
5304 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5306 * Get if the object is filled outside.
5308 * @param obj The icon object
5309 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5311 * @see elm_icon_fill_outside_set()
5315 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317 * Set the prescale size for the icon.
5319 * @param obj The icon object
5320 * @param size The prescale size. This value is used for both width and
5323 * This function sets a new size for pixmap representation of the given
5324 * icon. It allows the icon to be loaded already in the specified size,
5325 * reducing the memory usage and load time when loading a big icon with load
5326 * size set to a smaller size.
5328 * It's equivalent to the elm_bg_load_size_set() function for bg.
5330 * @note this is just a hint, the real size of the pixmap may differ
5331 * depending on the type of icon being loaded, being bigger than requested.
5333 * @see elm_icon_prescale_get()
5334 * @see elm_bg_load_size_set()
5338 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5340 * Get the prescale size for the icon.
5342 * @param obj The icon object
5343 * @return The prescale size
5345 * @see elm_icon_prescale_set()
5349 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5351 * Gets the image object of the icon. DO NOT MODIFY THIS.
5353 * @param obj The icon object
5354 * @return The internal icon object
5358 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5360 * Sets the icon lookup order used by elm_icon_standard_set().
5362 * @param obj The icon object
5363 * @param order The icon lookup order (can be one of
5364 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5365 * or ELM_ICON_LOOKUP_THEME)
5367 * @see elm_icon_order_lookup_get()
5368 * @see Elm_Icon_Lookup_Order
5372 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5374 * Gets the icon lookup order.
5376 * @param obj The icon object
5377 * @return The icon lookup order
5379 * @see elm_icon_order_lookup_set()
5380 * @see Elm_Icon_Lookup_Order
5384 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5386 * Enable or disable preloading of the icon
5388 * @param obj The icon object
5389 * @param disable If EINA_TRUE, preloading will be disabled
5392 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5394 * Get if the icon supports animation or not.
5396 * @param obj The icon object
5397 * @return @c EINA_TRUE if the icon supports animation,
5398 * @c EINA_FALSE otherwise.
5400 * Return if this elm icon's image can be animated. Currently Evas only
5401 * supports gif animation. If the return value is EINA_FALSE, other
5402 * elm_icon_animated_XXX APIs won't work.
5405 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5407 * Set animation mode of the icon.
5409 * @param obj The icon object
5410 * @param anim @c EINA_TRUE if the object do animation job,
5411 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5413 * Since the default animation mode is set to EINA_FALSE,
5414 * the icon is shown without animation. Files like animated GIF files
5415 * can animate, and this is supported if you enable animated support
5417 * Set it to EINA_TRUE when the icon needs to be animated.
5420 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5422 * Get animation mode of the icon.
5424 * @param obj The icon object
5425 * @return The animation mode of the icon object
5426 * @see elm_icon_animated_set
5429 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5431 * Set animation play mode of the icon.
5433 * @param obj The icon object
5434 * @param play @c EINA_TRUE the object play animation images,
5435 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5437 * To play elm icon's animation, set play to EINA_TURE.
5438 * For example, you make gif player using this set/get API and click event.
5439 * This literally lets you control current play or paused state. To have
5440 * this work with animated GIF files for example, you first, before
5441 * setting the file have to use elm_icon_animated_set() to enable animation
5442 * at all on the icon.
5444 * 1. Click event occurs
5445 * 2. Check play flag using elm_icon_animaged_play_get
5446 * 3. If elm icon was playing, set play to EINA_FALSE.
5447 * Then animation will be stopped and vice versa
5450 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5452 * Get animation play mode of the icon.
5454 * @param obj The icon object
5455 * @return The play mode of the icon object
5457 * @see elm_icon_animated_play_get
5460 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5467 * @defgroup Image Image
5469 * @image html img/widget/image/preview-00.png
5470 * @image latex img/widget/image/preview-00.eps
5473 * An object that allows one to load an image file to it. It can be used
5474 * anywhere like any other elementary widget.
5476 * This widget provides most of the functionality provided from @ref Bg or @ref
5477 * Icon, but with a slightly different API (use the one that fits better your
5480 * The features not provided by those two other image widgets are:
5481 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5482 * @li change the object orientation with elm_image_orient_set();
5483 * @li and turning the image editable with elm_image_editable_set().
5485 * Signals that you can add callbacks for are:
5487 * @li @c "clicked" - This is called when a user has clicked the image
5489 * An example of usage for this API follows:
5490 * @li @ref tutorial_image
5499 * @enum _Elm_Image_Orient
5500 * @typedef Elm_Image_Orient
5502 * Possible orientation options for elm_image_orient_set().
5504 * @image html elm_image_orient_set.png
5505 * @image latex elm_image_orient_set.eps width=\textwidth
5509 typedef enum _Elm_Image_Orient
5511 ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5512 ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5513 ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5514 ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5515 ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5516 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5517 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5518 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5519 ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5520 ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5521 ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5522 ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5526 * Add a new image to the parent.
5528 * @param parent The parent object
5529 * @return The new object or NULL if it cannot be created
5531 * @see elm_image_file_set()
5535 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5537 * Set the file that will be used as image.
5539 * @param obj The image object
5540 * @param file The path to file that will be used as image
5541 * @param group The group that the image belongs in edje file (if it's an
5544 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5546 * @see elm_image_file_get()
5550 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5552 * Get the file that will be used as image.
5554 * @param obj The image object
5555 * @param file The path to file
5556 * @param group The group that the image belongs in edje file
5558 * @see elm_image_file_set()
5562 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5564 * Set the smooth effect for an image.
5566 * @param obj The image object
5567 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5568 * otherwise. Default is @c EINA_TRUE.
5570 * Set the scaling algorithm to be used when scaling the image. Smooth
5571 * scaling provides a better resulting image, but is slower.
5573 * The smooth scaling should be disabled when making animations that change
5574 * the image size, since it will be faster. Animations that don't require
5575 * resizing of the image can keep the smooth scaling enabled (even if the
5576 * image is already scaled, since the scaled image will be cached).
5578 * @see elm_image_smooth_get()
5582 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5584 * Get the smooth effect for an image.
5586 * @param obj The image object
5587 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5589 * @see elm_image_smooth_get()
5593 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5596 * Gets the current size of the image.
5598 * @param obj The image object.
5599 * @param w Pointer to store width, or NULL.
5600 * @param h Pointer to store height, or NULL.
5602 * This is the real size of the image, not the size of the object.
5604 * On error, neither w and h will be fileld with 0.
5608 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5610 * Disable scaling of this object.
5612 * @param obj The image object.
5613 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5614 * otherwise. Default is @c EINA_FALSE.
5616 * This function disables scaling of the elm_image widget through the
5617 * function elm_object_scale_set(). However, this does not affect the widget
5618 * size/resize in any way. For that effect, take a look at
5619 * elm_image_scale_set().
5621 * @see elm_image_no_scale_get()
5622 * @see elm_image_scale_set()
5623 * @see elm_object_scale_set()
5627 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5629 * Get whether scaling is disabled on the object.
5631 * @param obj The image object
5632 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5634 * @see elm_image_no_scale_set()
5638 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5640 * Set if the object is (up/down) resizable.
5642 * @param obj The image object
5643 * @param scale_up A bool to set if the object is resizable up. Default is
5645 * @param scale_down A bool to set if the object is resizable down. Default
5648 * This function limits the image resize ability. If @p scale_up is set to
5649 * @c EINA_FALSE, the object can't have its height or width resized to a value
5650 * higher than the original image size. Same is valid for @p scale_down.
5652 * @see elm_image_scale_get()
5656 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5658 * Get if the object is (up/down) resizable.
5660 * @param obj The image object
5661 * @param scale_up A bool to set if the object is resizable up
5662 * @param scale_down A bool to set if the object is resizable down
5664 * @see elm_image_scale_set()
5668 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5670 * Set if the image fills the entire object area, when keeping the aspect ratio.
5672 * @param obj The image object
5673 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5674 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5676 * When the image should keep its aspect ratio even if resized to another
5677 * aspect ratio, there are two possibilities to resize it: keep the entire
5678 * image inside the limits of height and width of the object (@p fill_outside
5679 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5680 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5682 * @note This option will have no effect if
5683 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5685 * @see elm_image_fill_outside_get()
5686 * @see elm_image_aspect_ratio_retained_set()
5690 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5692 * Get if the object is filled outside
5694 * @param obj The image object
5695 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5697 * @see elm_image_fill_outside_set()
5701 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5703 * Set the prescale size for the image
5705 * @param obj The image object
5706 * @param size The prescale size. This value is used for both width and
5709 * This function sets a new size for pixmap representation of the given
5710 * image. It allows the image to be loaded already in the specified size,
5711 * reducing the memory usage and load time when loading a big image with load
5712 * size set to a smaller size.
5714 * It's equivalent to the elm_bg_load_size_set() function for bg.
5716 * @note this is just a hint, the real size of the pixmap may differ
5717 * depending on the type of image being loaded, being bigger than requested.
5719 * @see elm_image_prescale_get()
5720 * @see elm_bg_load_size_set()
5724 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5726 * Get the prescale size for the image
5728 * @param obj The image object
5729 * @return The prescale size
5731 * @see elm_image_prescale_set()
5735 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5737 * Set the image orientation.
5739 * @param obj The image object
5740 * @param orient The image orientation @ref Elm_Image_Orient
5741 * Default is #ELM_IMAGE_ORIENT_NONE.
5743 * This function allows to rotate or flip the given image.
5745 * @see elm_image_orient_get()
5746 * @see @ref Elm_Image_Orient
5750 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5752 * Get the image orientation.
5754 * @param obj The image object
5755 * @return The image orientation @ref Elm_Image_Orient
5757 * @see elm_image_orient_set()
5758 * @see @ref Elm_Image_Orient
5762 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5764 * Make the image 'editable'.
5766 * @param obj Image object.
5767 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5769 * This means the image is a valid drag target for drag and drop, and can be
5770 * cut or pasted too.
5774 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5776 * Check if the image 'editable'.
5778 * @param obj Image object.
5779 * @return Editability.
5781 * A return value of EINA_TRUE means the image is a valid drag target
5782 * for drag and drop, and can be cut or pasted too.
5786 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5788 * Get the basic Evas_Image object from this object (widget).
5790 * @param obj The image object to get the inlined image from
5791 * @return The inlined image object, or NULL if none exists
5793 * This function allows one to get the underlying @c Evas_Object of type
5794 * Image from this elementary widget. It can be useful to do things like get
5795 * the pixel data, save the image to a file, etc.
5797 * @note Be careful to not manipulate it, as it is under control of
5802 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5804 * Set whether the original aspect ratio of the image should be kept on resize.
5806 * @param obj The image object.
5807 * @param retained @c EINA_TRUE if the image should retain the aspect,
5808 * @c EINA_FALSE otherwise.
5810 * The original aspect ratio (width / height) of the image is usually
5811 * distorted to match the object's size. Enabling this option will retain
5812 * this original aspect, and the way that the image is fit into the object's
5813 * area depends on the option set by elm_image_fill_outside_set().
5815 * @see elm_image_aspect_ratio_retained_get()
5816 * @see elm_image_fill_outside_set()
5820 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5822 * Get if the object retains the original aspect ratio.
5824 * @param obj The image object.
5825 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5830 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5840 * @image html img/widget/box/preview-00.png
5841 * @image latex img/widget/box/preview-00.eps width=\textwidth
5843 * @image html img/box.png
5844 * @image latex img/box.eps width=\textwidth
5846 * A box arranges objects in a linear fashion, governed by a layout function
5847 * that defines the details of this arrangement.
5849 * By default, the box will use an internal function to set the layout to
5850 * a single row, either vertical or horizontal. This layout is affected
5851 * by a number of parameters, such as the homogeneous flag set by
5852 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5853 * elm_box_align_set() and the hints set to each object in the box.
5855 * For this default layout, it's possible to change the orientation with
5856 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5857 * placing its elements ordered from top to bottom. When horizontal is set,
5858 * the order will go from left to right. If the box is set to be
5859 * homogeneous, every object in it will be assigned the same space, that
5860 * of the largest object. Padding can be used to set some spacing between
5861 * the cell given to each object. The alignment of the box, set with
5862 * elm_box_align_set(), determines how the bounding box of all the elements
5863 * will be placed within the space given to the box widget itself.
5865 * The size hints of each object also affect how they are placed and sized
5866 * within the box. evas_object_size_hint_min_set() will give the minimum
5867 * size the object can have, and the box will use it as the basis for all
5868 * latter calculations. Elementary widgets set their own minimum size as
5869 * needed, so there's rarely any need to use it manually.
5871 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5872 * used to tell whether the object will be allocated the minimum size it
5873 * needs or if the space given to it should be expanded. It's important
5874 * to realize that expanding the size given to the object is not the same
5875 * thing as resizing the object. It could very well end being a small
5876 * widget floating in a much larger empty space. If not set, the weight
5877 * for objects will normally be 0.0 for both axis, meaning the widget will
5878 * not be expanded. To take as much space possible, set the weight to
5879 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5881 * Besides how much space each object is allocated, it's possible to control
5882 * how the widget will be placed within that space using
5883 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5884 * for both axis, meaning the object will be centered, but any value from
5885 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5886 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5887 * is -1.0, means the object will be resized to fill the entire space it
5890 * In addition, customized functions to define the layout can be set, which
5891 * allow the application developer to organize the objects within the box
5892 * in any number of ways.
5894 * The special elm_box_layout_transition() function can be used
5895 * to switch from one layout to another, animating the motion of the
5896 * children of the box.
5898 * @note Objects should not be added to box objects using _add() calls.
5900 * Some examples on how to use boxes follow:
5901 * @li @ref box_example_01
5902 * @li @ref box_example_02
5907 * @typedef Elm_Box_Transition
5909 * Opaque handler containing the parameters to perform an animated
5910 * transition of the layout the box uses.
5912 * @see elm_box_transition_new()
5913 * @see elm_box_layout_set()
5914 * @see elm_box_layout_transition()
5916 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5919 * Add a new box to the parent
5921 * By default, the box will be in vertical mode and non-homogeneous.
5923 * @param parent The parent object
5924 * @return The new object or NULL if it cannot be created
5926 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5928 * Set the horizontal orientation
5930 * By default, box object arranges their contents vertically from top to
5932 * By calling this function with @p horizontal as EINA_TRUE, the box will
5933 * become horizontal, arranging contents from left to right.
5935 * @note This flag is ignored if a custom layout function is set.
5937 * @param obj The box object
5938 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5939 * EINA_FALSE = vertical)
5941 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5943 * Get the horizontal orientation
5945 * @param obj The box object
5946 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5948 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5950 * Set the box to arrange its children homogeneously
5952 * If enabled, homogeneous layout makes all items the same size, according
5953 * to the size of the largest of its children.
5955 * @note This flag is ignored if a custom layout function is set.
5957 * @param obj The box object
5958 * @param homogeneous The homogeneous flag
5960 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5962 * Get whether the box is using homogeneous mode or not
5964 * @param obj The box object
5965 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5967 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 * Add an object to the beginning of the pack list
5971 * Pack @p subobj into the box @p obj, placing it first in the list of
5972 * children objects. The actual position the object will get on screen
5973 * depends on the layout used. If no custom layout is set, it will be at
5974 * the top or left, depending if the box is vertical or horizontal,
5977 * @param obj The box object
5978 * @param subobj The object to add to the box
5980 * @see elm_box_pack_end()
5981 * @see elm_box_pack_before()
5982 * @see elm_box_pack_after()
5983 * @see elm_box_unpack()
5984 * @see elm_box_unpack_all()
5985 * @see elm_box_clear()
5987 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5989 * Add an object at the end of the pack list
5991 * Pack @p subobj into the box @p obj, placing it last in the list of
5992 * children objects. The actual position the object will get on screen
5993 * depends on the layout used. If no custom layout is set, it will be at
5994 * the bottom or right, depending if the box is vertical or horizontal,
5997 * @param obj The box object
5998 * @param subobj The object to add to the box
6000 * @see elm_box_pack_start()
6001 * @see elm_box_pack_before()
6002 * @see elm_box_pack_after()
6003 * @see elm_box_unpack()
6004 * @see elm_box_unpack_all()
6005 * @see elm_box_clear()
6007 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6009 * Adds an object to the box before the indicated object
6011 * This will add the @p subobj to the box indicated before the object
6012 * indicated with @p before. If @p before is not already in the box, results
6013 * are undefined. Before means either to the left of the indicated object or
6014 * above it depending on orientation.
6016 * @param obj The box object
6017 * @param subobj The object to add to the box
6018 * @param before The object before which to add it
6020 * @see elm_box_pack_start()
6021 * @see elm_box_pack_end()
6022 * @see elm_box_pack_after()
6023 * @see elm_box_unpack()
6024 * @see elm_box_unpack_all()
6025 * @see elm_box_clear()
6027 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6029 * Adds an object to the box after the indicated object
6031 * This will add the @p subobj to the box indicated after the object
6032 * indicated with @p after. If @p after is not already in the box, results
6033 * are undefined. After means either to the right of the indicated object or
6034 * below it depending on orientation.
6036 * @param obj The box object
6037 * @param subobj The object to add to the box
6038 * @param after The object after which to add it
6040 * @see elm_box_pack_start()
6041 * @see elm_box_pack_end()
6042 * @see elm_box_pack_before()
6043 * @see elm_box_unpack()
6044 * @see elm_box_unpack_all()
6045 * @see elm_box_clear()
6047 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6049 * Clear the box of all children
6051 * Remove all the elements contained by the box, deleting the respective
6054 * @param obj The box object
6056 * @see elm_box_unpack()
6057 * @see elm_box_unpack_all()
6059 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6063 * Remove the object given by @p subobj from the box @p obj without
6066 * @param obj The box object
6068 * @see elm_box_unpack_all()
6069 * @see elm_box_clear()
6071 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6073 * Remove all items from the box, without deleting them
6075 * Clear the box from all children, but don't delete the respective objects.
6076 * If no other references of the box children exist, the objects will never
6077 * be deleted, and thus the application will leak the memory. Make sure
6078 * when using this function that you hold a reference to all the objects
6079 * in the box @p obj.
6081 * @param obj The box object
6083 * @see elm_box_clear()
6084 * @see elm_box_unpack()
6086 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6088 * Retrieve a list of the objects packed into the box
6090 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6091 * The order of the list corresponds to the packing order the box uses.
6093 * You must free this list with eina_list_free() once you are done with it.
6095 * @param obj The box object
6097 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6099 * Set the space (padding) between the box's elements.
6101 * Extra space in pixels that will be added between a box child and its
6102 * neighbors after its containing cell has been calculated. This padding
6103 * is set for all elements in the box, besides any possible padding that
6104 * individual elements may have through their size hints.
6106 * @param obj The box object
6107 * @param horizontal The horizontal space between elements
6108 * @param vertical The vertical space between elements
6110 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6112 * Get the space (padding) between the box's elements.
6114 * @param obj The box object
6115 * @param horizontal The horizontal space between elements
6116 * @param vertical The vertical space between elements
6118 * @see elm_box_padding_set()
6120 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6122 * Set the alignment of the whole bouding box of contents.
6124 * Sets how the bounding box containing all the elements of the box, after
6125 * their sizes and position has been calculated, will be aligned within
6126 * the space given for the whole box widget.
6128 * @param obj The box object
6129 * @param horizontal The horizontal alignment of elements
6130 * @param vertical The vertical alignment of elements
6132 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6134 * Get the alignment of the whole bouding box of contents.
6136 * @param obj The box object
6137 * @param horizontal The horizontal alignment of elements
6138 * @param vertical The vertical alignment of elements
6140 * @see elm_box_align_set()
6142 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6145 * Force the box to recalculate its children packing.
6147 * If any children was added or removed, box will not calculate the
6148 * values immediately rather leaving it to the next main loop
6149 * iteration. While this is great as it would save lots of
6150 * recalculation, whenever you need to get the position of a just
6151 * added item you must force recalculate before doing so.
6153 * @param obj The box object.
6155 EAPI void elm_box_recalculate(Evas_Object *obj);
6158 * Set the layout defining function to be used by the box
6160 * Whenever anything changes that requires the box in @p obj to recalculate
6161 * the size and position of its elements, the function @p cb will be called
6162 * to determine what the layout of the children will be.
6164 * Once a custom function is set, everything about the children layout
6165 * is defined by it. The flags set by elm_box_horizontal_set() and
6166 * elm_box_homogeneous_set() no longer have any meaning, and the values
6167 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6168 * layout function to decide if they are used and how. These last two
6169 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6170 * passed to @p cb. The @c Evas_Object the function receives is not the
6171 * Elementary widget, but the internal Evas Box it uses, so none of the
6172 * functions described here can be used on it.
6174 * Any of the layout functions in @c Evas can be used here, as well as the
6175 * special elm_box_layout_transition().
6177 * The final @p data argument received by @p cb is the same @p data passed
6178 * here, and the @p free_data function will be called to free it
6179 * whenever the box is destroyed or another layout function is set.
6181 * Setting @p cb to NULL will revert back to the default layout function.
6183 * @param obj The box object
6184 * @param cb The callback function used for layout
6185 * @param data Data that will be passed to layout function
6186 * @param free_data Function called to free @p data
6188 * @see elm_box_layout_transition()
6190 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);
6192 * Special layout function that animates the transition from one layout to another
6194 * Normally, when switching the layout function for a box, this will be
6195 * reflected immediately on screen on the next render, but it's also
6196 * possible to do this through an animated transition.
6198 * This is done by creating an ::Elm_Box_Transition and setting the box
6199 * layout to this function.
6203 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6204 * evas_object_box_layout_vertical, // start
6205 * NULL, // data for initial layout
6206 * NULL, // free function for initial data
6207 * evas_object_box_layout_horizontal, // end
6208 * NULL, // data for final layout
6209 * NULL, // free function for final data
6210 * anim_end, // will be called when animation ends
6211 * NULL); // data for anim_end function\
6212 * elm_box_layout_set(box, elm_box_layout_transition, t,
6213 * elm_box_transition_free);
6216 * @note This function can only be used with elm_box_layout_set(). Calling
6217 * it directly will not have the expected results.
6219 * @see elm_box_transition_new
6220 * @see elm_box_transition_free
6221 * @see elm_box_layout_set
6223 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6225 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6227 * If you want to animate the change from one layout to another, you need
6228 * to set the layout function of the box to elm_box_layout_transition(),
6229 * passing as user data to it an instance of ::Elm_Box_Transition with the
6230 * necessary information to perform this animation. The free function to
6231 * set for the layout is elm_box_transition_free().
6233 * The parameters to create an ::Elm_Box_Transition sum up to how long
6234 * will it be, in seconds, a layout function to describe the initial point,
6235 * another for the final position of the children and one function to be
6236 * called when the whole animation ends. This last function is useful to
6237 * set the definitive layout for the box, usually the same as the end
6238 * layout for the animation, but could be used to start another transition.
6240 * @param start_layout The layout function that will be used to start the animation
6241 * @param start_layout_data The data to be passed the @p start_layout function
6242 * @param start_layout_free_data Function to free @p start_layout_data
6243 * @param end_layout The layout function that will be used to end the animation
6244 * @param end_layout_free_data The data to be passed the @p end_layout function
6245 * @param end_layout_free_data Function to free @p end_layout_data
6246 * @param transition_end_cb Callback function called when animation ends
6247 * @param transition_end_data Data to be passed to @p transition_end_cb
6248 * @return An instance of ::Elm_Box_Transition
6250 * @see elm_box_transition_new
6251 * @see elm_box_layout_transition
6253 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);
6255 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6257 * This function is mostly useful as the @c free_data parameter in
6258 * elm_box_layout_set() when elm_box_layout_transition().
6260 * @param data The Elm_Box_Transition instance to be freed.
6262 * @see elm_box_transition_new
6263 * @see elm_box_layout_transition
6265 EAPI void elm_box_transition_free(void *data);
6272 * @defgroup Button Button
6274 * @image html img/widget/button/preview-00.png
6275 * @image latex img/widget/button/preview-00.eps
6276 * @image html img/widget/button/preview-01.png
6277 * @image latex img/widget/button/preview-01.eps
6278 * @image html img/widget/button/preview-02.png
6279 * @image latex img/widget/button/preview-02.eps
6281 * This is a push-button. Press it and run some function. It can contain
6282 * a simple label and icon object and it also has an autorepeat feature.
6284 * This widgets emits the following signals:
6285 * @li "clicked": the user clicked the button (press/release).
6286 * @li "repeated": the user pressed the button without releasing it.
6287 * @li "pressed": button was pressed.
6288 * @li "unpressed": button was released after being pressed.
6289 * In all three cases, the @c event parameter of the callback will be
6292 * Also, defined in the default theme, the button has the following styles
6294 * @li default: a normal button.
6295 * @li anchor: Like default, but the button fades away when the mouse is not
6296 * over it, leaving only the text or icon.
6297 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6298 * continuous look across its options.
6299 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6301 * Default contents parts of the button widget that you can use for are:
6302 * @li "icon" - An icon of the button
6304 * Default text parts of the button widget that you can use for are:
6305 * @li "default" - Label of the button
6307 * Follow through a complete example @ref button_example_01 "here".
6311 * Add a new button to the parent's canvas
6313 * @param parent The parent object
6314 * @return The new object or NULL if it cannot be created
6316 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6318 * Set the label used in the button
6320 * The passed @p label can be NULL to clean any existing text in it and
6321 * leave the button as an icon only object.
6323 * @param obj The button object
6324 * @param label The text will be written on the button
6325 * @deprecated use elm_object_text_set() instead.
6327 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6329 * Get the label set for the button
6331 * The string returned is an internal pointer and should not be freed or
6332 * altered. It will also become invalid when the button is destroyed.
6333 * The string returned, if not NULL, is a stringshare, so if you need to
6334 * keep it around even after the button is destroyed, you can use
6335 * eina_stringshare_ref().
6337 * @param obj The button object
6338 * @return The text set to the label, or NULL if nothing is set
6339 * @deprecated use elm_object_text_set() instead.
6341 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6343 * Set the icon used for the button
6345 * Setting a new icon will delete any other that was previously set, making
6346 * any reference to them invalid. If you need to maintain the previous
6347 * object alive, unset it first with elm_button_icon_unset().
6349 * @param obj The button object
6350 * @param icon The icon object for the button
6351 * @deprecated use elm_object_part_content_set() instead.
6353 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6355 * Get the icon used for the button
6357 * Return the icon object which is set for this widget. If the button is
6358 * destroyed or another icon is set, the returned object will be deleted
6359 * and any reference to it will be invalid.
6361 * @param obj The button object
6362 * @return The icon object that is being used
6364 * @deprecated use elm_object_part_content_get() instead
6366 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6368 * Remove the icon set without deleting it and return the object
6370 * This function drops the reference the button holds of the icon object
6371 * and returns this last object. It is used in case you want to remove any
6372 * icon, or set another one, without deleting the actual object. The button
6373 * will be left without an icon set.
6375 * @param obj The button object
6376 * @return The icon object that was being used
6377 * @deprecated use elm_object_part_content_unset() instead.
6379 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6381 * Turn on/off the autorepeat event generated when the button is kept pressed
6383 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6384 * signal when they are clicked.
6386 * When on, keeping a button pressed will continuously emit a @c repeated
6387 * signal until the button is released. The time it takes until it starts
6388 * emitting the signal is given by
6389 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6390 * new emission by elm_button_autorepeat_gap_timeout_set().
6392 * @param obj The button object
6393 * @param on A bool to turn on/off the event
6395 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6397 * Get whether the autorepeat feature is enabled
6399 * @param obj The button object
6400 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6402 * @see elm_button_autorepeat_set()
6404 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6406 * Set the initial timeout before the autorepeat event is generated
6408 * Sets the timeout, in seconds, since the button is pressed until the
6409 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6410 * won't be any delay and the even will be fired the moment the button is
6413 * @param obj The button object
6414 * @param t Timeout in seconds
6416 * @see elm_button_autorepeat_set()
6417 * @see elm_button_autorepeat_gap_timeout_set()
6419 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6421 * Get the initial timeout before the autorepeat event is generated
6423 * @param obj The button object
6424 * @return Timeout in seconds
6426 * @see elm_button_autorepeat_initial_timeout_set()
6428 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6430 * Set the interval between each generated autorepeat event
6432 * After the first @c repeated event is fired, all subsequent ones will
6433 * follow after a delay of @p t seconds for each.
6435 * @param obj The button object
6436 * @param t Interval in seconds
6438 * @see elm_button_autorepeat_initial_timeout_set()
6440 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6442 * Get the interval between each generated autorepeat event
6444 * @param obj The button object
6445 * @return Interval in seconds
6447 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6453 * @defgroup File_Selector_Button File Selector Button
6455 * @image html img/widget/fileselector_button/preview-00.png
6456 * @image latex img/widget/fileselector_button/preview-00.eps
6457 * @image html img/widget/fileselector_button/preview-01.png
6458 * @image latex img/widget/fileselector_button/preview-01.eps
6459 * @image html img/widget/fileselector_button/preview-02.png
6460 * @image latex img/widget/fileselector_button/preview-02.eps
6462 * This is a button that, when clicked, creates an Elementary
6463 * window (or inner window) <b> with a @ref Fileselector "file
6464 * selector widget" within</b>. When a file is chosen, the (inner)
6465 * window is closed and the button emits a signal having the
6466 * selected file as it's @c event_info.
6468 * This widget encapsulates operations on its internal file
6469 * selector on its own API. There is less control over its file
6470 * selector than that one would have instatiating one directly.
6472 * The following styles are available for this button:
6475 * @li @c "hoversel_vertical"
6476 * @li @c "hoversel_vertical_entry"
6478 * Smart callbacks one can register to:
6479 * - @c "file,chosen" - the user has selected a path, whose string
6480 * pointer comes as the @c event_info data (a stringshared
6483 * Here is an example on its usage:
6484 * @li @ref fileselector_button_example
6486 * @see @ref File_Selector_Entry for a similar widget.
6491 * Add a new file selector button widget to the given parent
6492 * Elementary (container) object
6494 * @param parent The parent object
6495 * @return a new file selector button widget handle or @c NULL, on
6498 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6501 * Set the label for a given file selector button widget
6503 * @param obj The file selector button widget
6504 * @param label The text label to be displayed on @p obj
6506 * @deprecated use elm_object_text_set() instead.
6508 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6511 * Get the label set for a given file selector button widget
6513 * @param obj The file selector button widget
6514 * @return The button label
6516 * @deprecated use elm_object_text_set() instead.
6518 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6521 * Set the icon on a given file selector button widget
6523 * @param obj The file selector button widget
6524 * @param icon The icon object for the button
6526 * Once the icon object is set, a previously set one will be
6527 * deleted. If you want to keep the latter, use the
6528 * elm_fileselector_button_icon_unset() function.
6530 * @see elm_fileselector_button_icon_get()
6532 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6535 * Get the icon set for a given file selector button widget
6537 * @param obj The file selector button widget
6538 * @return The icon object currently set on @p obj or @c NULL, if
6541 * @see elm_fileselector_button_icon_set()
6543 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6546 * Unset the icon used in a given file selector button widget
6548 * @param obj The file selector button widget
6549 * @return The icon object that was being used on @p obj or @c
6552 * Unparent and return the icon object which was set for this
6555 * @see elm_fileselector_button_icon_set()
6557 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6560 * Set the title for a given file selector button widget's window
6562 * @param obj The file selector button widget
6563 * @param title The title string
6565 * This will change the window's title, when the file selector pops
6566 * out after a click on the button. Those windows have the default
6567 * (unlocalized) value of @c "Select a file" as titles.
6569 * @note It will only take any effect if the file selector
6570 * button widget is @b not under "inwin mode".
6572 * @see elm_fileselector_button_window_title_get()
6574 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6577 * Get the title set for a given file selector button widget's
6580 * @param obj The file selector button widget
6581 * @return Title of the file selector button's window
6583 * @see elm_fileselector_button_window_title_get() for more details
6585 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6588 * Set the size of a given file selector button widget's window,
6589 * holding the file selector itself.
6591 * @param obj The file selector button widget
6592 * @param width The window's width
6593 * @param height The window's height
6595 * @note it will only take any effect if the file selector button
6596 * widget is @b not under "inwin mode". The default size for the
6597 * window (when applicable) is 400x400 pixels.
6599 * @see elm_fileselector_button_window_size_get()
6601 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6604 * Get the size of a given file selector button widget's window,
6605 * holding the file selector itself.
6607 * @param obj The file selector button widget
6608 * @param width Pointer into which to store the width value
6609 * @param height Pointer into which to store the height value
6611 * @note Use @c NULL pointers on the size values you're not
6612 * interested in: they'll be ignored by the function.
6614 * @see elm_fileselector_button_window_size_set(), for more details
6616 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6619 * Set the initial file system path for a given file selector
6622 * @param obj The file selector button widget
6623 * @param path The path string
6625 * It must be a <b>directory</b> path, which will have the contents
6626 * displayed initially in the file selector's view, when invoked
6627 * from @p obj. The default initial path is the @c "HOME"
6628 * environment variable's value.
6630 * @see elm_fileselector_button_path_get()
6632 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6635 * Get the initial file system path set for a given file selector
6638 * @param obj The file selector button widget
6639 * @return path The path string
6641 * @see elm_fileselector_button_path_set() for more details
6643 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6646 * Enable/disable a tree view in the given file selector button
6647 * widget's internal file selector
6649 * @param obj The file selector button widget
6650 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6653 * This has the same effect as elm_fileselector_expandable_set(),
6654 * but now applied to a file selector button's internal file
6657 * @note There's no way to put a file selector button's internal
6658 * file selector in "grid mode", as one may do with "pure" file
6661 * @see elm_fileselector_expandable_get()
6663 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6666 * Get whether tree view is enabled for the given file selector
6667 * button widget's internal file selector
6669 * @param obj The file selector button widget
6670 * @return @c EINA_TRUE if @p obj widget's internal file selector
6671 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6673 * @see elm_fileselector_expandable_set() for more details
6675 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6678 * Set whether a given file selector button widget's internal file
6679 * selector is to display folders only or the directory contents,
6682 * @param obj The file selector button widget
6683 * @param only @c EINA_TRUE to make @p obj widget's internal file
6684 * selector only display directories, @c EINA_FALSE to make files
6685 * to be displayed in it too
6687 * This has the same effect as elm_fileselector_folder_only_set(),
6688 * but now applied to a file selector button's internal file
6691 * @see elm_fileselector_folder_only_get()
6693 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6696 * Get whether a given file selector button widget's internal file
6697 * selector is displaying folders only or the directory contents,
6700 * @param obj The file selector button widget
6701 * @return @c EINA_TRUE if @p obj widget's internal file
6702 * selector is only displaying directories, @c EINA_FALSE if files
6703 * are being displayed in it too (and on errors)
6705 * @see elm_fileselector_button_folder_only_set() for more details
6707 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6710 * Enable/disable the file name entry box where the user can type
6711 * in a name for a file, in a given file selector button widget's
6712 * internal file selector.
6714 * @param obj The file selector button widget
6715 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6716 * file selector a "saving dialog", @c EINA_FALSE otherwise
6718 * This has the same effect as elm_fileselector_is_save_set(),
6719 * but now applied to a file selector button's internal file
6722 * @see elm_fileselector_is_save_get()
6724 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6727 * Get whether the given file selector button widget's internal
6728 * file selector is in "saving dialog" mode
6730 * @param obj The file selector button widget
6731 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6732 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6735 * @see elm_fileselector_button_is_save_set() for more details
6737 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6740 * Set whether a given file selector button widget's internal file
6741 * selector will raise an Elementary "inner window", instead of a
6742 * dedicated Elementary window. By default, it won't.
6744 * @param obj The file selector button widget
6745 * @param value @c EINA_TRUE to make it use an inner window, @c
6746 * EINA_TRUE to make it use a dedicated window
6748 * @see elm_win_inwin_add() for more information on inner windows
6749 * @see elm_fileselector_button_inwin_mode_get()
6751 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6754 * Get whether a given file selector button widget's internal file
6755 * selector will raise an Elementary "inner window", instead of a
6756 * dedicated Elementary window.
6758 * @param obj The file selector button widget
6759 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6760 * if it will use a dedicated window
6762 * @see elm_fileselector_button_inwin_mode_set() for more details
6764 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6771 * @defgroup File_Selector_Entry File Selector Entry
6773 * @image html img/widget/fileselector_entry/preview-00.png
6774 * @image latex img/widget/fileselector_entry/preview-00.eps
6776 * This is an entry made to be filled with or display a <b>file
6777 * system path string</b>. Besides the entry itself, the widget has
6778 * a @ref File_Selector_Button "file selector button" on its side,
6779 * which will raise an internal @ref Fileselector "file selector widget",
6780 * when clicked, for path selection aided by file system
6783 * This file selector may appear in an Elementary window or in an
6784 * inner window. When a file is chosen from it, the (inner) window
6785 * is closed and the selected file's path string is exposed both as
6786 * an smart event and as the new text on the entry.
6788 * This widget encapsulates operations on its internal file
6789 * selector on its own API. There is less control over its file
6790 * selector than that one would have instatiating one directly.
6792 * Smart callbacks one can register to:
6793 * - @c "changed" - The text within the entry was changed
6794 * - @c "activated" - The entry has had editing finished and
6795 * changes are to be "committed"
6796 * - @c "press" - The entry has been clicked
6797 * - @c "longpressed" - The entry has been clicked (and held) for a
6799 * - @c "clicked" - The entry has been clicked
6800 * - @c "clicked,double" - The entry has been double clicked
6801 * - @c "focused" - The entry has received focus
6802 * - @c "unfocused" - The entry has lost focus
6803 * - @c "selection,paste" - A paste action has occurred on the
6805 * - @c "selection,copy" - A copy action has occurred on the entry
6806 * - @c "selection,cut" - A cut action has occurred on the entry
6807 * - @c "unpressed" - The file selector entry's button was released
6808 * after being pressed.
6809 * - @c "file,chosen" - The user has selected a path via the file
6810 * selector entry's internal file selector, whose string pointer
6811 * comes as the @c event_info data (a stringshared string)
6813 * Here is an example on its usage:
6814 * @li @ref fileselector_entry_example
6816 * @see @ref File_Selector_Button for a similar widget.
6821 * Add a new file selector entry widget to the given parent
6822 * Elementary (container) object
6824 * @param parent The parent object
6825 * @return a new file selector entry widget handle or @c NULL, on
6828 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6831 * Set the label for a given file selector entry widget's button
6833 * @param obj The file selector entry widget
6834 * @param label The text label to be displayed on @p obj widget's
6837 * @deprecated use elm_object_text_set() instead.
6839 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6842 * Get the label set for a given file selector entry widget's button
6844 * @param obj The file selector entry widget
6845 * @return The widget button's label
6847 * @deprecated use elm_object_text_set() instead.
6849 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6852 * Set the icon on a given file selector entry widget's button
6854 * @param obj The file selector entry widget
6855 * @param icon The icon object for the entry's button
6857 * Once the icon object is set, a previously set one will be
6858 * deleted. If you want to keep the latter, use the
6859 * elm_fileselector_entry_button_icon_unset() function.
6861 * @see elm_fileselector_entry_button_icon_get()
6863 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6866 * Get the icon set for a given file selector entry widget's button
6868 * @param obj The file selector entry widget
6869 * @return The icon object currently set on @p obj widget's button
6870 * or @c NULL, if none is
6872 * @see elm_fileselector_entry_button_icon_set()
6874 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6877 * Unset the icon used in a given file selector entry widget's
6880 * @param obj The file selector entry widget
6881 * @return The icon object that was being used on @p obj widget's
6882 * button or @c NULL, on errors
6884 * Unparent and return the icon object which was set for this
6887 * @see elm_fileselector_entry_button_icon_set()
6889 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6892 * Set the title for a given file selector entry widget's window
6894 * @param obj The file selector entry widget
6895 * @param title The title string
6897 * This will change the window's title, when the file selector pops
6898 * out after a click on the entry's button. Those windows have the
6899 * default (unlocalized) value of @c "Select a file" as titles.
6901 * @note It will only take any effect if the file selector
6902 * entry widget is @b not under "inwin mode".
6904 * @see elm_fileselector_entry_window_title_get()
6906 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6909 * Get the title set for a given file selector entry widget's
6912 * @param obj The file selector entry widget
6913 * @return Title of the file selector entry's window
6915 * @see elm_fileselector_entry_window_title_get() for more details
6917 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6920 * Set the size of a given file selector entry widget's window,
6921 * holding the file selector itself.
6923 * @param obj The file selector entry widget
6924 * @param width The window's width
6925 * @param height The window's height
6927 * @note it will only take any effect if the file selector entry
6928 * widget is @b not under "inwin mode". The default size for the
6929 * window (when applicable) is 400x400 pixels.
6931 * @see elm_fileselector_entry_window_size_get()
6933 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6936 * Get the size of a given file selector entry widget's window,
6937 * holding the file selector itself.
6939 * @param obj The file selector entry widget
6940 * @param width Pointer into which to store the width value
6941 * @param height Pointer into which to store the height value
6943 * @note Use @c NULL pointers on the size values you're not
6944 * interested in: they'll be ignored by the function.
6946 * @see elm_fileselector_entry_window_size_set(), for more details
6948 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6951 * Set the initial file system path and the entry's path string for
6952 * a given file selector entry widget
6954 * @param obj The file selector entry widget
6955 * @param path The path string
6957 * It must be a <b>directory</b> path, which will have the contents
6958 * displayed initially in the file selector's view, when invoked
6959 * from @p obj. The default initial path is the @c "HOME"
6960 * environment variable's value.
6962 * @see elm_fileselector_entry_path_get()
6964 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6967 * Get the entry's path string for a given file selector entry
6970 * @param obj The file selector entry widget
6971 * @return path The path string
6973 * @see elm_fileselector_entry_path_set() for more details
6975 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6978 * Enable/disable a tree view in the given file selector entry
6979 * widget's internal file selector
6981 * @param obj The file selector entry widget
6982 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6985 * This has the same effect as elm_fileselector_expandable_set(),
6986 * but now applied to a file selector entry's internal file
6989 * @note There's no way to put a file selector entry's internal
6990 * file selector in "grid mode", as one may do with "pure" file
6993 * @see elm_fileselector_expandable_get()
6995 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6998 * Get whether tree view is enabled for the given file selector
6999 * entry widget's internal file selector
7001 * @param obj The file selector entry widget
7002 * @return @c EINA_TRUE if @p obj widget's internal file selector
7003 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7005 * @see elm_fileselector_expandable_set() for more details
7007 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7010 * Set whether a given file selector entry widget's internal file
7011 * selector is to display folders only or the directory contents,
7014 * @param obj The file selector entry widget
7015 * @param only @c EINA_TRUE to make @p obj widget's internal file
7016 * selector only display directories, @c EINA_FALSE to make files
7017 * to be displayed in it too
7019 * This has the same effect as elm_fileselector_folder_only_set(),
7020 * but now applied to a file selector entry's internal file
7023 * @see elm_fileselector_folder_only_get()
7025 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7028 * Get whether a given file selector entry widget's internal file
7029 * selector is displaying folders only or the directory contents,
7032 * @param obj The file selector entry widget
7033 * @return @c EINA_TRUE if @p obj widget's internal file
7034 * selector is only displaying directories, @c EINA_FALSE if files
7035 * are being displayed in it too (and on errors)
7037 * @see elm_fileselector_entry_folder_only_set() for more details
7039 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7042 * Enable/disable the file name entry box where the user can type
7043 * in a name for a file, in a given file selector entry widget's
7044 * internal file selector.
7046 * @param obj The file selector entry widget
7047 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7048 * file selector a "saving dialog", @c EINA_FALSE otherwise
7050 * This has the same effect as elm_fileselector_is_save_set(),
7051 * but now applied to a file selector entry's internal file
7054 * @see elm_fileselector_is_save_get()
7056 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7059 * Get whether the given file selector entry widget's internal
7060 * file selector is in "saving dialog" mode
7062 * @param obj The file selector entry widget
7063 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7064 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7067 * @see elm_fileselector_entry_is_save_set() for more details
7069 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7072 * Set whether a given file selector entry widget's internal file
7073 * selector will raise an Elementary "inner window", instead of a
7074 * dedicated Elementary window. By default, it won't.
7076 * @param obj The file selector entry widget
7077 * @param value @c EINA_TRUE to make it use an inner window, @c
7078 * EINA_TRUE to make it use a dedicated window
7080 * @see elm_win_inwin_add() for more information on inner windows
7081 * @see elm_fileselector_entry_inwin_mode_get()
7083 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7086 * Get whether a given file selector entry widget's internal file
7087 * selector will raise an Elementary "inner window", instead of a
7088 * dedicated Elementary window.
7090 * @param obj The file selector entry widget
7091 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7092 * if it will use a dedicated window
7094 * @see elm_fileselector_entry_inwin_mode_set() for more details
7096 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7099 * Set the initial file system path for a given file selector entry
7102 * @param obj The file selector entry widget
7103 * @param path The path string
7105 * It must be a <b>directory</b> path, which will have the contents
7106 * displayed initially in the file selector's view, when invoked
7107 * from @p obj. The default initial path is the @c "HOME"
7108 * environment variable's value.
7110 * @see elm_fileselector_entry_path_get()
7112 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7115 * Get the parent directory's path to the latest file selection on
7116 * a given filer selector entry widget
7118 * @param obj The file selector object
7119 * @return The (full) path of the directory of the last selection
7120 * on @p obj widget, a @b stringshared string
7122 * @see elm_fileselector_entry_path_set()
7124 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7131 * @defgroup Scroller Scroller
7133 * A scroller holds a single object and "scrolls it around". This means that
7134 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7135 * region around, allowing to move through a much larger object that is
7136 * contained in the scroller. The scroller will always have a small minimum
7137 * size by default as it won't be limited by the contents of the scroller.
7139 * Signals that you can add callbacks for are:
7140 * @li "edge,left" - the left edge of the content has been reached
7141 * @li "edge,right" - the right edge of the content has been reached
7142 * @li "edge,top" - the top edge of the content has been reached
7143 * @li "edge,bottom" - the bottom edge of the content has been reached
7144 * @li "scroll" - the content has been scrolled (moved)
7145 * @li "scroll,anim,start" - scrolling animation has started
7146 * @li "scroll,anim,stop" - scrolling animation has stopped
7147 * @li "scroll,drag,start" - dragging the contents around has started
7148 * @li "scroll,drag,stop" - dragging the contents around has stopped
7149 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7152 * @note When Elemementary is in embedded mode the scrollbars will not be
7153 * dragable, they appear merely as indicators of how much has been scrolled.
7154 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7155 * fingerscroll) won't work.
7157 * Default contents parts of the scroller widget that you can use for are:
7158 * @li "default" - A content of the scroller
7160 * In @ref tutorial_scroller you'll find an example of how to use most of
7165 * @brief Type that controls when scrollbars should appear.
7167 * @see elm_scroller_policy_set()
7169 typedef enum _Elm_Scroller_Policy
7171 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7172 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7173 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7174 ELM_SCROLLER_POLICY_LAST
7175 } Elm_Scroller_Policy;
7177 * @brief Add a new scroller to the parent
7179 * @param parent The parent object
7180 * @return The new object or NULL if it cannot be created
7182 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7184 * @brief Set the content of the scroller widget (the object to be scrolled around).
7186 * @param obj The scroller object
7187 * @param content The new content object
7189 * Once the content object is set, a previously set one will be deleted.
7190 * If you want to keep that old content object, use the
7191 * elm_scroller_content_unset() function.
7192 * @deprecated use elm_object_content_set() instead
7194 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7196 * @brief Get the content of the scroller widget
7198 * @param obj The slider object
7199 * @return The content that is being used
7201 * Return the content object which is set for this widget
7203 * @see elm_scroller_content_set()
7204 * @deprecated use elm_object_content_get() instead.
7206 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7208 * @brief Unset the content of the scroller widget
7210 * @param obj The slider object
7211 * @return The content that was being used
7213 * Unparent and return the content object which was set for this widget
7215 * @see elm_scroller_content_set()
7216 * @deprecated use elm_object_content_unset() instead.
7218 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7220 * @brief Set custom theme elements for the scroller
7222 * @param obj The scroller object
7223 * @param widget The widget name to use (default is "scroller")
7224 * @param base The base name to use (default is "base")
7226 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7228 * @brief Make the scroller minimum size limited to the minimum size of the content
7230 * @param obj The scroller object
7231 * @param w Enable limiting minimum size horizontally
7232 * @param h Enable limiting minimum size vertically
7234 * By default the scroller will be as small as its design allows,
7235 * irrespective of its content. This will make the scroller minimum size the
7236 * right size horizontally and/or vertically to perfectly fit its content in
7239 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7241 * @brief Show a specific virtual region within the scroller content object
7243 * @param obj The scroller object
7244 * @param x X coordinate of the region
7245 * @param y Y coordinate of the region
7246 * @param w Width of the region
7247 * @param h Height of the region
7249 * This will ensure all (or part if it does not fit) of the designated
7250 * region in the virtual content object (0, 0 starting at the top-left of the
7251 * virtual content object) is shown within the scroller.
7253 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);
7255 * @brief Set the scrollbar visibility policy
7257 * @param obj The scroller object
7258 * @param policy_h Horizontal scrollbar policy
7259 * @param policy_v Vertical scrollbar policy
7261 * This sets the scrollbar visibility policy for the given scroller.
7262 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7263 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7264 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7265 * respectively for the horizontal and vertical scrollbars.
7267 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7269 * @brief Gets scrollbar visibility policy
7271 * @param obj The scroller object
7272 * @param policy_h Horizontal scrollbar policy
7273 * @param policy_v Vertical scrollbar policy
7275 * @see elm_scroller_policy_set()
7277 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7279 * @brief Get the currently visible content region
7281 * @param obj The scroller object
7282 * @param x X coordinate of the region
7283 * @param y Y coordinate of the region
7284 * @param w Width of the region
7285 * @param h Height of the region
7287 * This gets the current region in the content object that is visible through
7288 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7289 * w, @p h values pointed to.
7291 * @note All coordinates are relative to the content.
7293 * @see elm_scroller_region_show()
7295 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);
7297 * @brief Get the size of the content object
7299 * @param obj The scroller object
7300 * @param w Width of the content object.
7301 * @param h Height of the content object.
7303 * This gets the size of the content object of the scroller.
7305 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7307 * @brief Set bouncing behavior
7309 * @param obj The scroller object
7310 * @param h_bounce Allow bounce horizontally
7311 * @param v_bounce Allow bounce vertically
7313 * When scrolling, the scroller may "bounce" when reaching an edge of the
7314 * content object. This is a visual way to indicate the end has been reached.
7315 * This is enabled by default for both axis. This API will set if it is enabled
7316 * for the given axis with the boolean parameters for each axis.
7318 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7320 * @brief Get the bounce behaviour
7322 * @param obj The Scroller object
7323 * @param h_bounce Will the scroller bounce horizontally or not
7324 * @param v_bounce Will the scroller bounce vertically or not
7326 * @see elm_scroller_bounce_set()
7328 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7330 * @brief Set scroll page size relative to viewport size.
7332 * @param obj The scroller object
7333 * @param h_pagerel The horizontal page relative size
7334 * @param v_pagerel The vertical page relative size
7336 * The scroller is capable of limiting scrolling by the user to "pages". That
7337 * is to jump by and only show a "whole page" at a time as if the continuous
7338 * area of the scroller content is split into page sized pieces. This sets
7339 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7340 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7341 * axis. This is mutually exclusive with page size
7342 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7343 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7344 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7347 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7349 * @brief Set scroll page size.
7351 * @param obj The scroller object
7352 * @param h_pagesize The horizontal page size
7353 * @param v_pagesize The vertical page size
7355 * This sets the page size to an absolute fixed value, with 0 turning it off
7358 * @see elm_scroller_page_relative_set()
7360 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7362 * @brief Get scroll current page number.
7364 * @param obj The scroller object
7365 * @param h_pagenumber The horizontal page number
7366 * @param v_pagenumber The vertical page number
7368 * The page number starts from 0. 0 is the first page.
7369 * Current page means the page which meets the top-left of the viewport.
7370 * If there are two or more pages in the viewport, it returns the number of the page
7371 * which meets the top-left of the viewport.
7373 * @see elm_scroller_last_page_get()
7374 * @see elm_scroller_page_show()
7375 * @see elm_scroller_page_brint_in()
7377 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7379 * @brief Get scroll last page number.
7381 * @param obj The scroller object
7382 * @param h_pagenumber The horizontal page number
7383 * @param v_pagenumber The vertical page number
7385 * The page number starts from 0. 0 is the first page.
7386 * This returns the last page number among the pages.
7388 * @see elm_scroller_current_page_get()
7389 * @see elm_scroller_page_show()
7390 * @see elm_scroller_page_brint_in()
7392 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7394 * Show a specific virtual region within the scroller content object by page number.
7396 * @param obj The scroller object
7397 * @param h_pagenumber The horizontal page number
7398 * @param v_pagenumber The vertical page number
7400 * 0, 0 of the indicated page is located at the top-left of the viewport.
7401 * This will jump to the page directly without animation.
7406 * sc = elm_scroller_add(win);
7407 * elm_scroller_content_set(sc, content);
7408 * elm_scroller_page_relative_set(sc, 1, 0);
7409 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7410 * elm_scroller_page_show(sc, h_page + 1, v_page);
7413 * @see elm_scroller_page_bring_in()
7415 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7417 * Show a specific virtual region within the scroller content object by page number.
7419 * @param obj The scroller object
7420 * @param h_pagenumber The horizontal page number
7421 * @param v_pagenumber The vertical page number
7423 * 0, 0 of the indicated page is located at the top-left of the viewport.
7424 * This will slide to the page with animation.
7429 * sc = elm_scroller_add(win);
7430 * elm_scroller_content_set(sc, content);
7431 * elm_scroller_page_relative_set(sc, 1, 0);
7432 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7433 * elm_scroller_page_bring_in(sc, h_page, v_page);
7436 * @see elm_scroller_page_show()
7438 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7440 * @brief Show a specific virtual region within the scroller content object.
7442 * @param obj The scroller object
7443 * @param x X coordinate of the region
7444 * @param y Y coordinate of the region
7445 * @param w Width of the region
7446 * @param h Height of the region
7448 * This will ensure all (or part if it does not fit) of the designated
7449 * region in the virtual content object (0, 0 starting at the top-left of the
7450 * virtual content object) is shown within the scroller. Unlike
7451 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7452 * to this location (if configuration in general calls for transitions). It
7453 * may not jump immediately to the new location and make take a while and
7454 * show other content along the way.
7456 * @see elm_scroller_region_show()
7458 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);
7460 * @brief Set event propagation on a scroller
7462 * @param obj The scroller object
7463 * @param propagation If propagation is enabled or not
7465 * This enables or disabled event propagation from the scroller content to
7466 * the scroller and its parent. By default event propagation is disabled.
7468 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7470 * @brief Get event propagation for a scroller
7472 * @param obj The scroller object
7473 * @return The propagation state
7475 * This gets the event propagation for a scroller.
7477 * @see elm_scroller_propagate_events_set()
7479 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7481 * @brief Set scrolling gravity on a scroller
7483 * @param obj The scroller object
7484 * @param x The scrolling horizontal gravity
7485 * @param y The scrolling vertical gravity
7487 * The gravity, defines how the scroller will adjust its view
7488 * when the size of the scroller contents increase.
7490 * The scroller will adjust the view to glue itself as follows.
7492 * x=0.0, for showing the left most region of the content.
7493 * x=1.0, for showing the right most region of the content.
7494 * y=0.0, for showing the bottom most region of the content.
7495 * y=1.0, for showing the top most region of the content.
7497 * Default values for x and y are 0.0
7499 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7501 * @brief Get scrolling gravity values for a scroller
7503 * @param obj The scroller object
7504 * @param x The scrolling horizontal gravity
7505 * @param y The scrolling vertical gravity
7507 * This gets gravity values for a scroller.
7509 * @see elm_scroller_gravity_set()
7512 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7518 * @defgroup Label Label
7520 * @image html img/widget/label/preview-00.png
7521 * @image latex img/widget/label/preview-00.eps
7523 * @brief Widget to display text, with simple html-like markup.
7525 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7526 * text doesn't fit the geometry of the label it will be ellipsized or be
7527 * cut. Elementary provides several styles for this widget:
7528 * @li default - No animation
7529 * @li marker - Centers the text in the label and make it bold by default
7530 * @li slide_long - The entire text appears from the right of the screen and
7531 * slides until it disappears in the left of the screen(reappering on the
7533 * @li slide_short - The text appears in the left of the label and slides to
7534 * the right to show the overflow. When all of the text has been shown the
7535 * position is reset.
7536 * @li slide_bounce - The text appears in the left of the label and slides to
7537 * the right to show the overflow. When all of the text has been shown the
7538 * animation reverses, moving the text to the left.
7540 * Custom themes can of course invent new markup tags and style them any way
7543 * The following signals may be emitted by the label widget:
7544 * @li "language,changed": The program's language changed.
7546 * See @ref tutorial_label for a demonstration of how to use a label widget.
7550 * @brief Add a new label to the parent
7552 * @param parent The parent object
7553 * @return The new object or NULL if it cannot be created
7555 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7557 * @brief Set the label on the label object
7559 * @param obj The label object
7560 * @param label The label will be used on the label object
7561 * @deprecated See elm_object_text_set()
7563 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 */
7565 * @brief Get the label used on the label object
7567 * @param obj The label object
7568 * @return The string inside the label
7569 * @deprecated See elm_object_text_get()
7571 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7573 * @brief Set the wrapping behavior of the label
7575 * @param obj The label object
7576 * @param wrap To wrap text or not
7578 * By default no wrapping is done. Possible values for @p wrap are:
7579 * @li ELM_WRAP_NONE - No wrapping
7580 * @li ELM_WRAP_CHAR - wrap between characters
7581 * @li ELM_WRAP_WORD - wrap between words
7582 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7584 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7586 * @brief Get the wrapping behavior of the label
7588 * @param obj The label object
7591 * @see elm_label_line_wrap_set()
7593 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7595 * @brief Set wrap width of the label
7597 * @param obj The label object
7598 * @param w The wrap width in pixels at a minimum where words need to wrap
7600 * This function sets the maximum width size hint of the label.
7602 * @warning This is only relevant if the label is inside a container.
7604 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7606 * @brief Get wrap width of the label
7608 * @param obj The label object
7609 * @return The wrap width in pixels at a minimum where words need to wrap
7611 * @see elm_label_wrap_width_set()
7613 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7615 * @brief Set wrap height of the label
7617 * @param obj The label object
7618 * @param h The wrap height in pixels at a minimum where words need to wrap
7620 * This function sets the maximum height size hint of the label.
7622 * @warning This is only relevant if the label is inside a container.
7624 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7626 * @brief get wrap width of the label
7628 * @param obj The label object
7629 * @return The wrap height in pixels at a minimum where words need to wrap
7631 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7633 * @brief Set the font size on the label object.
7635 * @param obj The label object
7636 * @param size font size
7638 * @warning NEVER use this. It is for hyper-special cases only. use styles
7639 * instead. e.g. "default", "marker", "slide_long" etc.
7641 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7643 * @brief Set the text color on the label object
7645 * @param obj The label object
7646 * @param r Red property background color of The label object
7647 * @param g Green property background color of The label object
7648 * @param b Blue property background color of The label object
7649 * @param a Alpha property background color of The label object
7651 * @warning NEVER use this. It is for hyper-special cases only. use styles
7652 * instead. e.g. "default", "marker", "slide_long" etc.
7654 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);
7656 * @brief Set the text align on the label object
7658 * @param obj The label object
7659 * @param align align mode ("left", "center", "right")
7661 * @warning NEVER use this. It is for hyper-special cases only. use styles
7662 * instead. e.g. "default", "marker", "slide_long" etc.
7664 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7666 * @brief Set background color of the label
7668 * @param obj The label object
7669 * @param r Red property background color of The label object
7670 * @param g Green property background color of The label object
7671 * @param b Blue property background color of The label object
7672 * @param a Alpha property background alpha of The label object
7674 * @warning NEVER use this. It is for hyper-special cases only. use styles
7675 * instead. e.g. "default", "marker", "slide_long" etc.
7677 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);
7679 * @brief Set the ellipsis behavior of the label
7681 * @param obj The label object
7682 * @param ellipsis To ellipsis text or not
7684 * If set to true and the text doesn't fit in the label an ellipsis("...")
7685 * will be shown at the end of the widget.
7687 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7688 * choosen wrap method was ELM_WRAP_WORD.
7690 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7692 * @brief Set the text slide of the label
7694 * @param obj The label object
7695 * @param slide To start slide or stop
7697 * If set to true, the text of the label will slide/scroll through the length of
7700 * @warning This only works with the themes "slide_short", "slide_long" and
7703 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7705 * @brief Get the text slide mode of the label
7707 * @param obj The label object
7708 * @return slide slide mode value
7710 * @see elm_label_slide_set()
7712 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7714 * @brief Set the slide duration(speed) of the label
7716 * @param obj The label object
7717 * @return The duration in seconds in moving text from slide begin position
7718 * to slide end position
7720 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7722 * @brief Get the slide duration(speed) of the label
7724 * @param obj The label object
7725 * @return The duration time in moving text from slide begin position to slide end position
7727 * @see elm_label_slide_duration_set()
7729 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7735 * @defgroup Toggle Toggle
7737 * @image html img/widget/toggle/preview-00.png
7738 * @image latex img/widget/toggle/preview-00.eps
7740 * @brief A toggle is a slider which can be used to toggle between
7741 * two values. It has two states: on and off.
7743 * This widget is deprecated. Please use elm_check_add() instead using the
7744 * toggle style like:
7747 * obj = elm_check_add(parent);
7748 * elm_object_style_set(obj, "toggle");
7749 * elm_object_part_text_set(obj, "on", "ON");
7750 * elm_object_part_text_set(obj, "off", "OFF");
7753 * Signals that you can add callbacks for are:
7754 * @li "changed" - Whenever the toggle value has been changed. Is not called
7755 * until the toggle is released by the cursor (assuming it
7756 * has been triggered by the cursor in the first place).
7758 * Default contents parts of the toggle widget that you can use for are:
7759 * @li "icon" - An icon of the toggle
7761 * Default text parts of the toggle widget that you can use for are:
7762 * @li "elm.text" - Label of the toggle
7764 * @ref tutorial_toggle show how to use a toggle.
7768 * @brief Add a toggle to @p parent.
7770 * @param parent The parent object
7772 * @return The toggle object
7774 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7776 * @brief Sets the label to be displayed with the toggle.
7778 * @param obj The toggle object
7779 * @param label The label to be displayed
7781 * @deprecated use elm_object_text_set() instead.
7783 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7785 * @brief Gets the label of the toggle
7787 * @param obj toggle object
7788 * @return The label of the toggle
7790 * @deprecated use elm_object_text_get() instead.
7792 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7794 * @brief Set the icon used for the toggle
7796 * @param obj The toggle object
7797 * @param icon The icon object for the button
7799 * Once the icon object is set, a previously set one will be deleted
7800 * If you want to keep that old content object, use the
7801 * elm_toggle_icon_unset() function.
7803 * @deprecated use elm_object_part_content_set() instead.
7805 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7807 * @brief Get the icon used for the toggle
7809 * @param obj The toggle object
7810 * @return The icon object that is being used
7812 * Return the icon object which is set for this widget.
7814 * @see elm_toggle_icon_set()
7816 * @deprecated use elm_object_part_content_get() instead.
7818 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7820 * @brief Unset the icon used for the toggle
7822 * @param obj The toggle object
7823 * @return The icon object that was being used
7825 * Unparent and return the icon object which was set for this widget.
7827 * @see elm_toggle_icon_set()
7829 * @deprecated use elm_object_part_content_unset() instead.
7831 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7833 * @brief Sets the labels to be associated with the on and off states of the toggle.
7835 * @param obj The toggle object
7836 * @param onlabel The label displayed when the toggle is in the "on" state
7837 * @param offlabel The label displayed when the toggle is in the "off" state
7839 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7842 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7844 * @brief Gets the labels associated with the on and off states of the
7847 * @param obj The toggle object
7848 * @param onlabel A char** to place the onlabel of @p obj into
7849 * @param offlabel A char** to place the offlabel of @p obj into
7851 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7854 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7856 * @brief Sets the state of the toggle to @p state.
7858 * @param obj The toggle object
7859 * @param state The state of @p obj
7861 * @deprecated use elm_check_state_set() instead.
7863 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7865 * @brief Gets the state of the toggle to @p state.
7867 * @param obj The toggle object
7868 * @return The state of @p obj
7870 * @deprecated use elm_check_state_get() instead.
7872 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7874 * @brief Sets the state pointer of the toggle to @p statep.
7876 * @param obj The toggle object
7877 * @param statep The state pointer of @p obj
7879 * @deprecated use elm_check_state_pointer_set() instead.
7881 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7887 * @defgroup Frame Frame
7889 * @image html img/widget/frame/preview-00.png
7890 * @image latex img/widget/frame/preview-00.eps
7892 * @brief Frame is a widget that holds some content and has a title.
7894 * The default look is a frame with a title, but Frame supports multple
7902 * @li outdent_bottom
7904 * Of all this styles only default shows the title. Frame emits no signals.
7906 * Default contents parts of the frame widget that you can use for are:
7907 * @li "default" - A content of the frame
7909 * Default text parts of the frame widget that you can use for are:
7910 * @li "elm.text" - Label of the frame
7912 * For a detailed example see the @ref tutorial_frame.
7917 * @brief Add a new frame to the parent
7919 * @param parent The parent object
7920 * @return The new object or NULL if it cannot be created
7922 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7924 * @brief Set the frame label
7926 * @param obj The frame object
7927 * @param label The label of this frame object
7929 * @deprecated use elm_object_text_set() instead.
7931 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7933 * @brief Get the frame label
7935 * @param obj The frame object
7937 * @return The label of this frame objet or NULL if unable to get frame
7939 * @deprecated use elm_object_text_get() instead.
7941 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7943 * @brief Set the content of the frame widget
7945 * Once the content object is set, a previously set one will be deleted.
7946 * If you want to keep that old content object, use the
7947 * elm_frame_content_unset() function.
7949 * @param obj The frame object
7950 * @param content The content will be filled in this frame object
7952 * @deprecated use elm_object_content_set() instead.
7954 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7956 * @brief Get the content of the frame widget
7958 * Return the content object which is set for this widget
7960 * @param obj The frame object
7961 * @return The content that is being used
7963 * @deprecated use elm_object_content_get() instead.
7965 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7967 * @brief Unset the content of the frame widget
7969 * Unparent and return the content object which was set for this widget
7971 * @param obj The frame object
7972 * @return The content that was being used
7974 * @deprecated use elm_object_content_unset() instead.
7976 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7982 * @defgroup Table Table
7984 * A container widget to arrange other widgets in a table where items can
7985 * also span multiple columns or rows - even overlap (and then be raised or
7986 * lowered accordingly to adjust stacking if they do overlap).
7988 * For a Table widget the row/column count is not fixed.
7989 * The table widget adjusts itself when subobjects are added to it dynamically.
7991 * The followin are examples of how to use a table:
7992 * @li @ref tutorial_table_01
7993 * @li @ref tutorial_table_02
7998 * @brief Add a new table to the parent
8000 * @param parent The parent object
8001 * @return The new object or NULL if it cannot be created
8003 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8005 * @brief Set the homogeneous layout in the table
8007 * @param obj The layout object
8008 * @param homogeneous A boolean to set if the layout is homogeneous in the
8009 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8011 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8013 * @brief Get the current table homogeneous mode.
8015 * @param obj The table object
8016 * @return A boolean to indicating if the layout is homogeneous in the table
8017 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8019 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8021 * @brief Set padding between cells.
8023 * @param obj The layout object.
8024 * @param horizontal set the horizontal padding.
8025 * @param vertical set the vertical padding.
8027 * Default value is 0.
8029 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8031 * @brief Get padding between cells.
8033 * @param obj The layout object.
8034 * @param horizontal set the horizontal padding.
8035 * @param vertical set the vertical padding.
8037 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8039 * @brief Add a subobject on the table with the coordinates passed
8041 * @param obj The table object
8042 * @param subobj The subobject to be added to the table
8043 * @param x Row number
8044 * @param y Column number
8048 * @note All positioning inside the table is relative to rows and columns, so
8049 * a value of 0 for x and y, means the top left cell of the table, and a
8050 * value of 1 for w and h means @p subobj only takes that 1 cell.
8052 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8054 * @brief Remove child from table.
8056 * @param obj The table object
8057 * @param subobj The subobject
8059 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8061 * @brief Faster way to remove all child objects from a table object.
8063 * @param obj The table object
8064 * @param clear If true, will delete children, else just remove from table.
8066 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8068 * @brief Set the packing location of an existing child of the table
8070 * @param subobj The subobject to be modified in the table
8071 * @param x Row number
8072 * @param y Column number
8076 * Modifies the position of an object already in the table.
8078 * @note All positioning inside the table is relative to rows and columns, so
8079 * a value of 0 for x and y, means the top left cell of the table, and a
8080 * value of 1 for w and h means @p subobj only takes that 1 cell.
8082 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8084 * @brief Get the packing location of an existing child of the table
8086 * @param subobj The subobject to be modified in the table
8087 * @param x Row number
8088 * @param y Column number
8092 * @see elm_table_pack_set()
8094 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8099 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8100 typedef struct Elm_Gen_Item Elm_Gen_Item;
8101 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8102 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8103 typedef char *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8104 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. */
8105 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. */
8106 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8107 struct _Elm_Gen_Item_Class
8109 const char *item_style;
8110 struct _Elm_Gen_Item_Class_Func
8112 Elm_Gen_Item_Text_Get_Cb text_get;
8113 Elm_Gen_Item_Content_Get_Cb content_get;
8114 Elm_Gen_Item_State_Get_Cb state_get;
8115 Elm_Gen_Item_Del_Cb del;
8118 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8119 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8120 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8121 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8122 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8123 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8124 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8125 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8126 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8127 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8128 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8130 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8131 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8132 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8133 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8134 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8135 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8136 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8137 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8138 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8139 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8142 * @defgroup Gengrid Gengrid (Generic grid)
8144 * This widget aims to position objects in a grid layout while
8145 * actually creating and rendering only the visible ones, using the
8146 * same idea as the @ref Genlist "genlist": the user defines a @b
8147 * class for each item, specifying functions that will be called at
8148 * object creation, deletion, etc. When those items are selected by
8149 * the user, a callback function is issued. Users may interact with
8150 * a gengrid via the mouse (by clicking on items to select them and
8151 * clicking on the grid's viewport and swiping to pan the whole
8152 * view) or via the keyboard, navigating through item with the
8155 * @section Gengrid_Layouts Gengrid layouts
8157 * Gengrid may layout its items in one of two possible layouts:
8161 * When in "horizontal mode", items will be placed in @b columns,
8162 * from top to bottom and, when the space for a column is filled,
8163 * another one is started on the right, thus expanding the grid
8164 * horizontally, making for horizontal scrolling. When in "vertical
8165 * mode" , though, items will be placed in @b rows, from left to
8166 * right and, when the space for a row is filled, another one is
8167 * started below, thus expanding the grid vertically (and making
8168 * for vertical scrolling).
8170 * @section Gengrid_Items Gengrid items
8172 * An item in a gengrid can have 0 or more texts (they can be
8173 * regular text or textblock Evas objects - that's up to the style
8174 * to determine), 0 or more contents (which are simply objects
8175 * swallowed into the gengrid item's theming Edje object) and 0 or
8176 * more <b>boolean states</b>, which have the behavior left to the
8177 * user to define. The Edje part names for each of these properties
8178 * will be looked up, in the theme file for the gengrid, under the
8179 * Edje (string) data items named @c "texts", @c "contents" and @c
8180 * "states", respectively. For each of those properties, if more
8181 * than one part is provided, they must have names listed separated
8182 * by spaces in the data fields. For the default gengrid item
8183 * theme, we have @b one text part (@c "elm.text"), @b two content
8184 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8187 * A gengrid item may be at one of several styles. Elementary
8188 * provides one by default - "default", but this can be extended by
8189 * system or application custom themes/overlays/extensions (see
8190 * @ref Theme "themes" for more details).
8192 * @section Gengrid_Item_Class Gengrid item classes
8194 * In order to have the ability to add and delete items on the fly,
8195 * gengrid implements a class (callback) system where the
8196 * application provides a structure with information about that
8197 * type of item (gengrid may contain multiple different items with
8198 * different classes, states and styles). Gengrid will call the
8199 * functions in this struct (methods) when an item is "realized"
8200 * (i.e., created dynamically, while the user is scrolling the
8201 * grid). All objects will simply be deleted when no longer needed
8202 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8203 * contains the following members:
8204 * - @c item_style - This is a constant string and simply defines
8205 * the name of the item style. It @b must be specified and the
8206 * default should be @c "default".
8207 * - @c func.text_get - This function is called when an item
8208 * object is actually created. The @c data parameter will point to
8209 * the same data passed to elm_gengrid_item_append() and related
8210 * item creation functions. The @c obj parameter is the gengrid
8211 * object itself, while the @c part one is the name string of one
8212 * of the existing text parts in the Edje group implementing the
8213 * item's theme. This function @b must return a strdup'()ed string,
8214 * as the caller will free() it when done. See
8215 * #Elm_Gengrid_Item_Text_Get_Cb.
8216 * - @c func.content_get - This function is called when an item object
8217 * is actually created. The @c data parameter will point to the
8218 * same data passed to elm_gengrid_item_append() and related item
8219 * creation functions. The @c obj parameter is the gengrid object
8220 * itself, while the @c part one is the name string of one of the
8221 * existing (content) swallow parts in the Edje group implementing the
8222 * item's theme. It must return @c NULL, when no content is desired,
8223 * or a valid object handle, otherwise. The object will be deleted
8224 * by the gengrid on its deletion or when the item is "unrealized".
8225 * See #Elm_Gengrid_Item_Content_Get_Cb.
8226 * - @c func.state_get - This function is called when an item
8227 * object is actually created. The @c data parameter will point to
8228 * the same data passed to elm_gengrid_item_append() and related
8229 * item creation functions. The @c obj parameter is the gengrid
8230 * object itself, while the @c part one is the name string of one
8231 * of the state parts in the Edje group implementing the item's
8232 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8233 * true/on. Gengrids will emit a signal to its theming Edje object
8234 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8235 * "source" arguments, respectively, when the state is true (the
8236 * default is false), where @c XXX is the name of the (state) part.
8237 * See #Elm_Gengrid_Item_State_Get_Cb.
8238 * - @c func.del - This is called when elm_gengrid_item_del() is
8239 * called on an item or elm_gengrid_clear() is called on the
8240 * gengrid. This is intended for use when gengrid items are
8241 * deleted, so any data attached to the item (e.g. its data
8242 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8244 * @section Gengrid_Usage_Hints Usage hints
8246 * If the user wants to have multiple items selected at the same
8247 * time, elm_gengrid_multi_select_set() will permit it. If the
8248 * gengrid is single-selection only (the default), then
8249 * elm_gengrid_select_item_get() will return the selected item or
8250 * @c NULL, if none is selected. If the gengrid is under
8251 * multi-selection, then elm_gengrid_selected_items_get() will
8252 * return a list (that is only valid as long as no items are
8253 * modified (added, deleted, selected or unselected) of child items
8256 * If an item changes (internal (boolean) state, text or content
8257 * changes), then use elm_gengrid_item_update() to have gengrid
8258 * update the item with the new state. A gengrid will re-"realize"
8259 * the item, thus calling the functions in the
8260 * #Elm_Gengrid_Item_Class set for that item.
8262 * To programmatically (un)select an item, use
8263 * elm_gengrid_item_selected_set(). To get its selected state use
8264 * elm_gengrid_item_selected_get(). To make an item disabled
8265 * (unable to be selected and appear differently) use
8266 * elm_gengrid_item_disabled_set() to set this and
8267 * elm_gengrid_item_disabled_get() to get the disabled state.
8269 * Grid cells will only have their selection smart callbacks called
8270 * when firstly getting selected. Any further clicks will do
8271 * nothing, unless you enable the "always select mode", with
8272 * elm_gengrid_always_select_mode_set(), thus making every click to
8273 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8274 * turn off the ability to select items entirely in the widget and
8275 * they will neither appear selected nor call the selection smart
8278 * Remember that you can create new styles and add your own theme
8279 * augmentation per application with elm_theme_extension_add(). If
8280 * you absolutely must have a specific style that overrides any
8281 * theme the user or system sets up you can use
8282 * elm_theme_overlay_add() to add such a file.
8284 * @section Gengrid_Smart_Events Gengrid smart events
8286 * Smart events that you can add callbacks for are:
8287 * - @c "activated" - The user has double-clicked or pressed
8288 * (enter|return|spacebar) on an item. The @c event_info parameter
8289 * is the gengrid item that was activated.
8290 * - @c "clicked,double" - The user has double-clicked an item.
8291 * The @c event_info parameter is the gengrid item that was double-clicked.
8292 * - @c "longpressed" - This is called when the item is pressed for a certain
8293 * amount of time. By default it's 1 second.
8294 * - @c "selected" - The user has made an item selected. The
8295 * @c event_info parameter is the gengrid item that was selected.
8296 * - @c "unselected" - The user has made an item unselected. The
8297 * @c event_info parameter is the gengrid item that was unselected.
8298 * - @c "realized" - This is called when the item in the gengrid
8299 * has its implementing Evas object instantiated, de facto. @c
8300 * event_info is the gengrid item that was created. The object
8301 * may be deleted at any time, so it is highly advised to the
8302 * caller @b not to use the object pointer returned from
8303 * elm_gengrid_item_object_get(), because it may point to freed
8305 * - @c "unrealized" - This is called when the implementing Evas
8306 * object for this item is deleted. @c event_info is the gengrid
8307 * item that was deleted.
8308 * - @c "changed" - Called when an item is added, removed, resized
8309 * or moved and when the gengrid is resized or gets "horizontal"
8311 * - @c "scroll,anim,start" - This is called when scrolling animation has
8313 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8315 * - @c "drag,start,up" - Called when the item in the gengrid has
8316 * been dragged (not scrolled) up.
8317 * - @c "drag,start,down" - Called when the item in the gengrid has
8318 * been dragged (not scrolled) down.
8319 * - @c "drag,start,left" - Called when the item in the gengrid has
8320 * been dragged (not scrolled) left.
8321 * - @c "drag,start,right" - Called when the item in the gengrid has
8322 * been dragged (not scrolled) right.
8323 * - @c "drag,stop" - Called when the item in the gengrid has
8324 * stopped being dragged.
8325 * - @c "drag" - Called when the item in the gengrid is being
8327 * - @c "scroll" - called when the content has been scrolled
8329 * - @c "scroll,drag,start" - called when dragging the content has
8331 * - @c "scroll,drag,stop" - called when dragging the content has
8333 * - @c "edge,top" - This is called when the gengrid is scrolled until
8335 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8336 * until the bottom edge.
8337 * - @c "edge,left" - This is called when the gengrid is scrolled
8338 * until the left edge.
8339 * - @c "edge,right" - This is called when the gengrid is scrolled
8340 * until the right edge.
8342 * List of gengrid examples:
8343 * @li @ref gengrid_example
8347 * @addtogroup Gengrid
8351 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8352 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8353 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8354 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8355 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8357 * Text fetching class function for Elm_Gen_Item_Class.
8358 * @param data The data passed in the item creation function
8359 * @param obj The base widget object
8360 * @param part The part name of the swallow
8361 * @return The allocated (NOT stringshared) string to set as the text
8363 typedef char *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8365 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8366 * @param data The data passed in the item creation function
8367 * @param obj The base widget object
8368 * @param part The part name of the swallow
8369 * @return The content object to swallow
8371 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8373 * State fetching class function for Elm_Gen_Item_Class.
8374 * @param data The data passed in the item creation function
8375 * @param obj The base widget object
8376 * @param part The part name of the swallow
8377 * @return The hell if I know
8379 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8381 * Deletion class function for Elm_Gen_Item_Class.
8382 * @param data The data passed in the item creation function
8383 * @param obj The base widget object
8385 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8388 * @struct _Elm_Gengrid_Item_Class
8390 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8393 struct _Elm_Gengrid_Item_Class
8395 const char *item_style;
8396 struct _Elm_Gengrid_Item_Class_Func
8398 Elm_Gengrid_Item_Text_Get_Cb text_get; /**< Text fetching class function for gengrid item classes.*/
8399 Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8400 Elm_Gengrid_Item_State_Get_Cb state_get; /**< State fetching class function for gengrid item classes. */
8401 Elm_Gengrid_Item_Del_Cb del; /**< Deletion class function for gengrid item classes. */
8403 }; /**< #Elm_Gengrid_Item_Class member definitions */
8404 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8406 * Add a new gengrid widget to the given parent Elementary
8407 * (container) object
8409 * @param parent The parent object
8410 * @return a new gengrid widget handle or @c NULL, on errors
8412 * This function inserts a new gengrid widget on the canvas.
8414 * @see elm_gengrid_item_size_set()
8415 * @see elm_gengrid_group_item_size_set()
8416 * @see elm_gengrid_horizontal_set()
8417 * @see elm_gengrid_item_append()
8418 * @see elm_gengrid_item_del()
8419 * @see elm_gengrid_clear()
8423 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8426 * Set the size for the items of a given gengrid widget
8428 * @param obj The gengrid object.
8429 * @param w The items' width.
8430 * @param h The items' height;
8432 * A gengrid, after creation, has still no information on the size
8433 * to give to each of its cells. So, you most probably will end up
8434 * with squares one @ref Fingers "finger" wide, the default
8435 * size. Use this function to force a custom size for you items,
8436 * making them as big as you wish.
8438 * @see elm_gengrid_item_size_get()
8442 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8445 * Get the size set for the items of a given gengrid widget
8447 * @param obj The gengrid object.
8448 * @param w Pointer to a variable where to store the items' width.
8449 * @param h Pointer to a variable where to store the items' height.
8451 * @note Use @c NULL pointers on the size values you're not
8452 * interested in: they'll be ignored by the function.
8454 * @see elm_gengrid_item_size_get() for more details
8458 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8461 * Set the size for the group items of a given gengrid widget
8463 * @param obj The gengrid object.
8464 * @param w The group items' width.
8465 * @param h The group items' height;
8467 * A gengrid, after creation, has still no information on the size
8468 * to give to each of its cells. So, you most probably will end up
8469 * with squares one @ref Fingers "finger" wide, the default
8470 * size. Use this function to force a custom size for you group items,
8471 * making them as big as you wish.
8473 * @see elm_gengrid_group_item_size_get()
8477 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8480 * Get the size set for the group items of a given gengrid widget
8482 * @param obj The gengrid object.
8483 * @param w Pointer to a variable where to store the group items' width.
8484 * @param h Pointer to a variable where to store the group items' height.
8486 * @note Use @c NULL pointers on the size values you're not
8487 * interested in: they'll be ignored by the function.
8489 * @see elm_gengrid_group_item_size_get() for more details
8493 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8496 * Set the items grid's alignment within a given gengrid widget
8498 * @param obj The gengrid object.
8499 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8500 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8502 * This sets the alignment of the whole grid of items of a gengrid
8503 * within its given viewport. By default, those values are both
8504 * 0.5, meaning that the gengrid will have its items grid placed
8505 * exactly in the middle of its viewport.
8507 * @note If given alignment values are out of the cited ranges,
8508 * they'll be changed to the nearest boundary values on the valid
8511 * @see elm_gengrid_align_get()
8515 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8518 * Get the items grid's alignment values within a given gengrid
8521 * @param obj The gengrid object.
8522 * @param align_x Pointer to a variable where to store the
8523 * horizontal alignment.
8524 * @param align_y Pointer to a variable where to store the vertical
8527 * @note Use @c NULL pointers on the alignment values you're not
8528 * interested in: they'll be ignored by the function.
8530 * @see elm_gengrid_align_set() for more details
8534 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8537 * Set whether a given gengrid widget is or not able have items
8540 * @param obj The gengrid object
8541 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8542 * @c EINA_FALSE to turn it off
8544 * If a gengrid is set to allow reordering, a click held for more
8545 * than 0.5 over a given item will highlight it specially,
8546 * signalling the gengrid has entered the reordering state. From
8547 * that time on, the user will be able to, while still holding the
8548 * mouse button down, move the item freely in the gengrid's
8549 * viewport, replacing to said item to the locations it goes to.
8550 * The replacements will be animated and, whenever the user
8551 * releases the mouse button, the item being replaced gets a new
8552 * definitive place in the grid.
8554 * @see elm_gengrid_reorder_mode_get()
8558 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8561 * Get whether a given gengrid widget is or not able have items
8564 * @param obj The gengrid object
8565 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8568 * @see elm_gengrid_reorder_mode_set() for more details
8572 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8575 * Append a new item in a given gengrid widget.
8577 * @param obj The gengrid object.
8578 * @param gic The item class for the item.
8579 * @param data The item data.
8580 * @param func Convenience function called when the item is
8582 * @param func_data Data to be passed to @p func.
8583 * @return A handle to the item added or @c NULL, on errors.
8585 * This adds an item to the beginning of the gengrid.
8587 * @see elm_gengrid_item_prepend()
8588 * @see elm_gengrid_item_insert_before()
8589 * @see elm_gengrid_item_insert_after()
8590 * @see elm_gengrid_item_del()
8594 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);
8597 * Prepend a new item in a given gengrid widget.
8599 * @param obj The gengrid object.
8600 * @param gic The item class for the item.
8601 * @param data The item data.
8602 * @param func Convenience function called when the item is
8604 * @param func_data Data to be passed to @p func.
8605 * @return A handle to the item added or @c NULL, on errors.
8607 * This adds an item to the end of the gengrid.
8609 * @see elm_gengrid_item_append()
8610 * @see elm_gengrid_item_insert_before()
8611 * @see elm_gengrid_item_insert_after()
8612 * @see elm_gengrid_item_del()
8616 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);
8619 * Insert an item before another in a gengrid widget
8621 * @param obj The gengrid object.
8622 * @param gic The item class for the item.
8623 * @param data The item data.
8624 * @param relative The item to place this new one before.
8625 * @param func Convenience function called when the item is
8627 * @param func_data Data to be passed to @p func.
8628 * @return A handle to the item added or @c NULL, on errors.
8630 * This inserts an item before another in the gengrid.
8632 * @see elm_gengrid_item_append()
8633 * @see elm_gengrid_item_prepend()
8634 * @see elm_gengrid_item_insert_after()
8635 * @see elm_gengrid_item_del()
8639 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);
8642 * Insert an item after another in a gengrid widget
8644 * @param obj The gengrid object.
8645 * @param gic The item class for the item.
8646 * @param data The item data.
8647 * @param relative The item to place this new one after.
8648 * @param func Convenience function called when the item is
8650 * @param func_data Data to be passed to @p func.
8651 * @return A handle to the item added or @c NULL, on errors.
8653 * This inserts an item after another in the gengrid.
8655 * @see elm_gengrid_item_append()
8656 * @see elm_gengrid_item_prepend()
8657 * @see elm_gengrid_item_insert_after()
8658 * @see elm_gengrid_item_del()
8662 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);
8665 * Insert an item in a gengrid widget using a user-defined sort function.
8667 * @param obj The gengrid object.
8668 * @param gic The item class for the item.
8669 * @param data The item data.
8670 * @param comp User defined comparison function that defines the sort order based on
8671 * Elm_Gen_Item and its data param.
8672 * @param func Convenience function called when the item is selected.
8673 * @param func_data Data to be passed to @p func.
8674 * @return A handle to the item added or @c NULL, on errors.
8676 * This inserts an item in the gengrid based on user defined comparison function.
8678 * @see elm_gengrid_item_append()
8679 * @see elm_gengrid_item_prepend()
8680 * @see elm_gengrid_item_insert_after()
8681 * @see elm_gengrid_item_del()
8682 * @see elm_gengrid_item_direct_sorted_insert()
8686 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);
8689 * Insert an item in a gengrid widget using a user-defined sort function.
8691 * @param obj The gengrid object.
8692 * @param gic The item class for the item.
8693 * @param data The item data.
8694 * @param comp User defined comparison function that defines the sort order based on
8696 * @param func Convenience function called when the item is selected.
8697 * @param func_data Data to be passed to @p func.
8698 * @return A handle to the item added or @c NULL, on errors.
8700 * This inserts an item in the gengrid based on user defined comparison function.
8702 * @see elm_gengrid_item_append()
8703 * @see elm_gengrid_item_prepend()
8704 * @see elm_gengrid_item_insert_after()
8705 * @see elm_gengrid_item_del()
8706 * @see elm_gengrid_item_sorted_insert()
8710 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);
8713 * Set whether items on a given gengrid widget are to get their
8714 * selection callbacks issued for @b every subsequent selection
8715 * click on them or just for the first click.
8717 * @param obj The gengrid object
8718 * @param always_select @c EINA_TRUE to make items "always
8719 * selected", @c EINA_FALSE, otherwise
8721 * By default, grid items will only call their selection callback
8722 * function when firstly getting selected, any subsequent further
8723 * clicks will do nothing. With this call, you make those
8724 * subsequent clicks also to issue the selection callbacks.
8726 * @note <b>Double clicks</b> will @b always be reported on items.
8728 * @see elm_gengrid_always_select_mode_get()
8732 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8735 * Get whether items on a given gengrid widget have their selection
8736 * callbacks issued for @b every subsequent selection click on them
8737 * or just for the first click.
8739 * @param obj The gengrid object.
8740 * @return @c EINA_TRUE if the gengrid items are "always selected",
8741 * @c EINA_FALSE, otherwise
8743 * @see elm_gengrid_always_select_mode_set() for more details
8747 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8750 * Set whether items on a given gengrid widget can be selected or not.
8752 * @param obj The gengrid object
8753 * @param no_select @c EINA_TRUE to make items selectable,
8754 * @c EINA_FALSE otherwise
8756 * This will make items in @p obj selectable or not. In the latter
8757 * case, any user interaction on the gengrid items will neither make
8758 * them appear selected nor them call their selection callback
8761 * @see elm_gengrid_no_select_mode_get()
8765 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8768 * Get whether items on a given gengrid widget can be selected or
8771 * @param obj The gengrid object
8772 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8775 * @see elm_gengrid_no_select_mode_set() for more details
8779 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8782 * Enable or disable multi-selection in a given gengrid widget
8784 * @param obj The gengrid object.
8785 * @param multi @c EINA_TRUE, to enable multi-selection,
8786 * @c EINA_FALSE to disable it.
8788 * Multi-selection is the ability to have @b more than one
8789 * item selected, on a given gengrid, simultaneously. When it is
8790 * enabled, a sequence of clicks on different items will make them
8791 * all selected, progressively. A click on an already selected item
8792 * will unselect it. If interacting via the keyboard,
8793 * multi-selection is enabled while holding the "Shift" key.
8795 * @note By default, multi-selection is @b disabled on gengrids
8797 * @see elm_gengrid_multi_select_get()
8801 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8804 * Get whether multi-selection is enabled or disabled for a given
8807 * @param obj The gengrid object.
8808 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8809 * EINA_FALSE otherwise
8811 * @see elm_gengrid_multi_select_set() for more details
8815 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8818 * Enable or disable bouncing effect for a given gengrid widget
8820 * @param obj The gengrid object
8821 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8822 * @c EINA_FALSE to disable it
8823 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8824 * @c EINA_FALSE to disable it
8826 * The bouncing effect occurs whenever one reaches the gengrid's
8827 * edge's while panning it -- it will scroll past its limits a
8828 * little bit and return to the edge again, in a animated for,
8831 * @note By default, gengrids have bouncing enabled on both axis
8833 * @see elm_gengrid_bounce_get()
8837 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8840 * Get whether bouncing effects are enabled or disabled, for a
8841 * given gengrid widget, on each axis
8843 * @param obj The gengrid object
8844 * @param h_bounce Pointer to a variable where to store the
8845 * horizontal bouncing flag.
8846 * @param v_bounce Pointer to a variable where to store the
8847 * vertical bouncing flag.
8849 * @see elm_gengrid_bounce_set() for more details
8853 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8856 * Set a given gengrid widget's scrolling page size, relative to
8857 * its viewport size.
8859 * @param obj The gengrid object
8860 * @param h_pagerel The horizontal page (relative) size
8861 * @param v_pagerel The vertical page (relative) size
8863 * The gengrid's scroller is capable of binding scrolling by the
8864 * user to "pages". It means that, while scrolling and, specially
8865 * after releasing the mouse button, the grid will @b snap to the
8866 * nearest displaying page's area. When page sizes are set, the
8867 * grid's continuous content area is split into (equal) page sized
8870 * This function sets the size of a page <b>relatively to the
8871 * viewport dimensions</b> of the gengrid, for each axis. A value
8872 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8873 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8874 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8875 * 1.0. Values beyond those will make it behave behave
8876 * inconsistently. If you only want one axis to snap to pages, use
8877 * the value @c 0.0 for the other one.
8879 * There is a function setting page size values in @b absolute
8880 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8881 * is mutually exclusive to this one.
8883 * @see elm_gengrid_page_relative_get()
8887 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8890 * Get a given gengrid widget's scrolling page size, relative to
8891 * its viewport size.
8893 * @param obj The gengrid object
8894 * @param h_pagerel Pointer to a variable where to store the
8895 * horizontal page (relative) size
8896 * @param v_pagerel Pointer to a variable where to store the
8897 * vertical page (relative) size
8899 * @see elm_gengrid_page_relative_set() for more details
8903 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8906 * Set a given gengrid widget's scrolling page size
8908 * @param obj The gengrid object
8909 * @param h_pagerel The horizontal page size, in pixels
8910 * @param v_pagerel The vertical page size, in pixels
8912 * The gengrid's scroller is capable of binding scrolling by the
8913 * user to "pages". It means that, while scrolling and, specially
8914 * after releasing the mouse button, the grid will @b snap to the
8915 * nearest displaying page's area. When page sizes are set, the
8916 * grid's continuous content area is split into (equal) page sized
8919 * This function sets the size of a page of the gengrid, in pixels,
8920 * for each axis. Sane usable values are, between @c 0 and the
8921 * dimensions of @p obj, for each axis. Values beyond those will
8922 * make it behave behave inconsistently. If you only want one axis
8923 * to snap to pages, use the value @c 0 for the other one.
8925 * There is a function setting page size values in @b relative
8926 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8927 * use is mutually exclusive to this one.
8931 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8934 * @brief Get gengrid current page number.
8936 * @param obj The gengrid object
8937 * @param h_pagenumber The horizontal page number
8938 * @param v_pagenumber The vertical page number
8940 * The page number starts from 0. 0 is the first page.
8941 * Current page means the page which meet the top-left of the viewport.
8942 * If there are two or more pages in the viewport, it returns the number of page
8943 * which meet the top-left of the viewport.
8945 * @see elm_gengrid_last_page_get()
8946 * @see elm_gengrid_page_show()
8947 * @see elm_gengrid_page_brint_in()
8949 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8952 * @brief Get scroll last page number.
8954 * @param obj The gengrid object
8955 * @param h_pagenumber The horizontal page number
8956 * @param v_pagenumber The vertical page number
8958 * The page number starts from 0. 0 is the first page.
8959 * This returns the last page number among the pages.
8961 * @see elm_gengrid_current_page_get()
8962 * @see elm_gengrid_page_show()
8963 * @see elm_gengrid_page_brint_in()
8965 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8968 * Show a specific virtual region within the gengrid content object by page number.
8970 * @param obj The gengrid object
8971 * @param h_pagenumber The horizontal page number
8972 * @param v_pagenumber The vertical page number
8974 * 0, 0 of the indicated page is located at the top-left of the viewport.
8975 * This will jump to the page directly without animation.
8980 * sc = elm_gengrid_add(win);
8981 * elm_gengrid_content_set(sc, content);
8982 * elm_gengrid_page_relative_set(sc, 1, 0);
8983 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8984 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8987 * @see elm_gengrid_page_bring_in()
8989 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8992 * Show a specific virtual region within the gengrid content object by page number.
8994 * @param obj The gengrid object
8995 * @param h_pagenumber The horizontal page number
8996 * @param v_pagenumber The vertical page number
8998 * 0, 0 of the indicated page is located at the top-left of the viewport.
8999 * This will slide to the page with animation.
9004 * sc = elm_gengrid_add(win);
9005 * elm_gengrid_content_set(sc, content);
9006 * elm_gengrid_page_relative_set(sc, 1, 0);
9007 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9008 * elm_gengrid_page_bring_in(sc, h_page, v_page);
9011 * @see elm_gengrid_page_show()
9013 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9016 * Set the direction in which a given gengrid widget will expand while
9017 * placing its items.
9019 * @param obj The gengrid object.
9020 * @param setting @c EINA_TRUE to make the gengrid expand
9021 * horizontally, @c EINA_FALSE to expand vertically.
9023 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9024 * in @b columns, from top to bottom and, when the space for a
9025 * column is filled, another one is started on the right, thus
9026 * expanding the grid horizontally. When in "vertical mode"
9027 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9028 * to right and, when the space for a row is filled, another one is
9029 * started below, thus expanding the grid vertically.
9031 * @see elm_gengrid_horizontal_get()
9035 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9038 * Get for what direction a given gengrid widget will expand while
9039 * placing its items.
9041 * @param obj The gengrid object.
9042 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9043 * @c EINA_FALSE if it's set to expand vertically.
9045 * @see elm_gengrid_horizontal_set() for more detais
9049 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9052 * Get the first item in a given gengrid widget
9054 * @param obj The gengrid object
9055 * @return The first item's handle or @c NULL, if there are no
9056 * items in @p obj (and on errors)
9058 * This returns the first item in the @p obj's internal list of
9061 * @see elm_gengrid_last_item_get()
9065 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9068 * Get the last item in a given gengrid widget
9070 * @param obj The gengrid object
9071 * @return The last item's handle or @c NULL, if there are no
9072 * items in @p obj (and on errors)
9074 * This returns the last item in the @p obj's internal list of
9077 * @see elm_gengrid_first_item_get()
9081 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9084 * Get the @b next item in a gengrid widget's internal list of items,
9085 * given a handle to one of those items.
9087 * @param item The gengrid item to fetch next from
9088 * @return The item after @p item, or @c NULL if there's none (and
9091 * This returns the item placed after the @p item, on the container
9094 * @see elm_gengrid_item_prev_get()
9098 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9101 * Get the @b previous item in a gengrid widget's internal list of items,
9102 * given a handle to one of those items.
9104 * @param item The gengrid item to fetch previous from
9105 * @return The item before @p item, or @c NULL if there's none (and
9108 * This returns the item placed before the @p item, on the container
9111 * @see elm_gengrid_item_next_get()
9115 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9118 * Get the gengrid object's handle which contains a given gengrid
9121 * @param item The item to fetch the container from
9122 * @return The gengrid (parent) object
9124 * This returns the gengrid object itself that an item belongs to.
9128 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9131 * Remove a gengrid item from its parent, deleting it.
9133 * @param item The item to be removed.
9134 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9136 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9141 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9144 * Update the contents of a given gengrid item
9146 * @param item The gengrid item
9148 * This updates an item by calling all the item class functions
9149 * again to get the contents, texts and states. Use this when the
9150 * original item data has changed and you want the changes to be
9155 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9158 * Get the Gengrid Item class for the given Gengrid Item.
9160 * @param item The gengrid item
9162 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9163 * the function pointers and item_style.
9167 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9170 * Get the Gengrid Item class for the given Gengrid Item.
9172 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9173 * the function pointers and item_style.
9175 * @param item The gengrid item
9176 * @param gic The gengrid item class describing the function pointers and the item style.
9180 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9183 * Return the data associated to a given gengrid item
9185 * @param item The gengrid item.
9186 * @return the data associated with this item.
9188 * This returns the @c data value passed on the
9189 * elm_gengrid_item_append() and related item addition calls.
9191 * @see elm_gengrid_item_append()
9192 * @see elm_gengrid_item_data_set()
9196 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9199 * Set the data associated with a given gengrid item
9201 * @param item The gengrid item
9202 * @param data The data pointer to set on it
9204 * This @b overrides the @c data value passed on the
9205 * elm_gengrid_item_append() and related item addition calls. This
9206 * function @b won't call elm_gengrid_item_update() automatically,
9207 * so you'd issue it afterwards if you want to have the item
9208 * updated to reflect the new data.
9210 * @see elm_gengrid_item_data_get()
9211 * @see elm_gengrid_item_update()
9215 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9218 * Get a given gengrid item's position, relative to the whole
9219 * gengrid's grid area.
9221 * @param item The Gengrid item.
9222 * @param x Pointer to variable to store the item's <b>row number</b>.
9223 * @param y Pointer to variable to store the item's <b>column number</b>.
9225 * This returns the "logical" position of the item within the
9226 * gengrid. For example, @c (0, 1) would stand for first row,
9231 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9234 * Set whether a given gengrid item is selected or not
9236 * @param item The gengrid item
9237 * @param selected Use @c EINA_TRUE, to make it selected, @c
9238 * EINA_FALSE to make it unselected
9240 * This sets the selected state of an item. If multi-selection is
9241 * not enabled on the containing gengrid and @p selected is @c
9242 * EINA_TRUE, any other previously selected items will get
9243 * unselected in favor of this new one.
9245 * @see elm_gengrid_item_selected_get()
9249 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9252 * Get whether a given gengrid item is selected or not
9254 * @param item The gengrid item
9255 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9257 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9259 * @see elm_gengrid_item_selected_set() for more details
9263 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9266 * Get the real Evas object created to implement the view of a
9267 * given gengrid item
9269 * @param item The gengrid item.
9270 * @return the Evas object implementing this item's view.
9272 * This returns the actual Evas object used to implement the
9273 * specified gengrid item's view. This may be @c NULL, as it may
9274 * not have been created or may have been deleted, at any time, by
9275 * the gengrid. <b>Do not modify this object</b> (move, resize,
9276 * show, hide, etc.), as the gengrid is controlling it. This
9277 * function is for querying, emitting custom signals or hooking
9278 * lower level callbacks for events on that object. Do not delete
9279 * this object under any circumstances.
9281 * @see elm_gengrid_item_data_get()
9285 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9288 * Show the portion of a gengrid's internal grid containing a given
9289 * item, @b immediately.
9291 * @param item The item to display
9293 * This causes gengrid to @b redraw its viewport's contents to the
9294 * region contining the given @p item item, if it is not fully
9297 * @see elm_gengrid_item_bring_in()
9301 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9304 * Animatedly bring in, to the visible area of a gengrid, a given
9307 * @param item The gengrid item to display
9309 * This causes gengrid to jump to the given @p item and show
9310 * it (by scrolling), if it is not fully visible. This will use
9311 * animation to do so and take a period of time to complete.
9313 * @see elm_gengrid_item_show()
9317 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9320 * Set whether a given gengrid item is disabled or not.
9322 * @param item The gengrid item
9323 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9324 * to enable it back.
9326 * A disabled item cannot be selected or unselected. It will also
9327 * change its appearance, to signal the user it's disabled.
9329 * @see elm_gengrid_item_disabled_get()
9333 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9336 * Get whether a given gengrid item is disabled or not.
9338 * @param item The gengrid item
9339 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9342 * @see elm_gengrid_item_disabled_set() for more details
9346 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9349 * Set the text to be shown in a given gengrid item's tooltips.
9351 * @param item The gengrid item
9352 * @param text The text to set in the content
9354 * This call will setup the text to be used as tooltip to that item
9355 * (analogous to elm_object_tooltip_text_set(), but being item
9356 * tooltips with higher precedence than object tooltips). It can
9357 * have only one tooltip at a time, so any previous tooltip data
9362 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9365 * Set the content to be shown in a given gengrid item's tooltip
9367 * @param item The gengrid item.
9368 * @param func The function returning the tooltip contents.
9369 * @param data What to provide to @a func as callback data/context.
9370 * @param del_cb Called when data is not needed anymore, either when
9371 * another callback replaces @p func, the tooltip is unset with
9372 * elm_gengrid_item_tooltip_unset() or the owner @p item
9373 * dies. This callback receives as its first parameter the
9374 * given @p data, being @c event_info the item handle.
9376 * This call will setup the tooltip's contents to @p item
9377 * (analogous to elm_object_tooltip_content_cb_set(), but being
9378 * item tooltips with higher precedence than object tooltips). It
9379 * can have only one tooltip at a time, so any previous tooltip
9380 * content will get removed. @p func (with @p data) will be called
9381 * every time Elementary needs to show the tooltip and it should
9382 * return a valid Evas object, which will be fully managed by the
9383 * tooltip system, getting deleted when the tooltip is gone.
9387 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);
9390 * Unset a tooltip from a given gengrid item
9392 * @param item gengrid item to remove a previously set tooltip from.
9394 * This call removes any tooltip set on @p item. The callback
9395 * provided as @c del_cb to
9396 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9397 * notify it is not used anymore (and have resources cleaned, if
9400 * @see elm_gengrid_item_tooltip_content_cb_set()
9404 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9407 * Set a different @b style for a given gengrid item's tooltip.
9409 * @param item gengrid item with tooltip set
9410 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9411 * "default", @c "transparent", etc)
9413 * Tooltips can have <b>alternate styles</b> to be displayed on,
9414 * which are defined by the theme set on Elementary. This function
9415 * works analogously as elm_object_tooltip_style_set(), but here
9416 * applied only to gengrid item objects. The default style for
9417 * tooltips is @c "default".
9419 * @note before you set a style you should define a tooltip with
9420 * elm_gengrid_item_tooltip_content_cb_set() or
9421 * elm_gengrid_item_tooltip_text_set()
9423 * @see elm_gengrid_item_tooltip_style_get()
9427 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9430 * Get the style set a given gengrid item's tooltip.
9432 * @param item gengrid item with tooltip already set on.
9433 * @return style the theme style in use, which defaults to
9434 * "default". If the object does not have a tooltip set,
9435 * then @c NULL is returned.
9437 * @see elm_gengrid_item_tooltip_style_set() for more details
9441 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9443 * @brief Disable size restrictions on an object's tooltip
9444 * @param item The tooltip's anchor object
9445 * @param disable If EINA_TRUE, size restrictions are disabled
9446 * @return EINA_FALSE on failure, EINA_TRUE on success
9448 * This function allows a tooltip to expand beyond its parant window's canvas.
9449 * It will instead be limited only by the size of the display.
9451 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9453 * @brief Retrieve size restriction state of an object's tooltip
9454 * @param item The tooltip's anchor object
9455 * @return If EINA_TRUE, size restrictions are disabled
9457 * This function returns whether a tooltip is allowed to expand beyond
9458 * its parant window's canvas.
9459 * It will instead be limited only by the size of the display.
9461 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9463 * Set the type of mouse pointer/cursor decoration to be shown,
9464 * when the mouse pointer is over the given gengrid widget item
9466 * @param item gengrid item to customize cursor on
9467 * @param cursor the cursor type's name
9469 * This function works analogously as elm_object_cursor_set(), but
9470 * here the cursor's changing area is restricted to the item's
9471 * area, and not the whole widget's. Note that that item cursors
9472 * have precedence over widget cursors, so that a mouse over @p
9473 * item will always show cursor @p type.
9475 * If this function is called twice for an object, a previously set
9476 * cursor will be unset on the second call.
9478 * @see elm_object_cursor_set()
9479 * @see elm_gengrid_item_cursor_get()
9480 * @see elm_gengrid_item_cursor_unset()
9484 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9487 * Get the type of mouse pointer/cursor decoration set to be shown,
9488 * when the mouse pointer is over the given gengrid widget item
9490 * @param item gengrid item with custom cursor set
9491 * @return the cursor type's name or @c NULL, if no custom cursors
9492 * were set to @p item (and on errors)
9494 * @see elm_object_cursor_get()
9495 * @see elm_gengrid_item_cursor_set() for more details
9496 * @see elm_gengrid_item_cursor_unset()
9500 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9503 * Unset any custom mouse pointer/cursor decoration set to be
9504 * shown, when the mouse pointer is over the given gengrid widget
9505 * item, thus making it show the @b default cursor again.
9507 * @param item a gengrid item
9509 * Use this call to undo any custom settings on this item's cursor
9510 * decoration, bringing it back to defaults (no custom style set).
9512 * @see elm_object_cursor_unset()
9513 * @see elm_gengrid_item_cursor_set() for more details
9517 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9520 * Set a different @b style for a given custom cursor set for a
9523 * @param item gengrid item with custom cursor set
9524 * @param style the <b>theme style</b> to use (e.g. @c "default",
9525 * @c "transparent", etc)
9527 * This function only makes sense when one is using custom mouse
9528 * cursor decorations <b>defined in a theme file</b> , which can
9529 * have, given a cursor name/type, <b>alternate styles</b> on
9530 * it. It works analogously as elm_object_cursor_style_set(), but
9531 * here applied only to gengrid item objects.
9533 * @warning Before you set a cursor style you should have defined a
9534 * custom cursor previously on the item, with
9535 * elm_gengrid_item_cursor_set()
9537 * @see elm_gengrid_item_cursor_engine_only_set()
9538 * @see elm_gengrid_item_cursor_style_get()
9542 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9545 * Get the current @b style set for a given gengrid item's custom
9548 * @param item gengrid item with custom cursor set.
9549 * @return style the cursor style in use. If the object does not
9550 * have a cursor set, then @c NULL is returned.
9552 * @see elm_gengrid_item_cursor_style_set() for more details
9556 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9559 * Set if the (custom) cursor for a given gengrid item should be
9560 * searched in its theme, also, or should only rely on the
9563 * @param item item with custom (custom) cursor already set on
9564 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9565 * only on those provided by the rendering engine, @c EINA_FALSE to
9566 * have them searched on the widget's theme, as well.
9568 * @note This call is of use only if you've set a custom cursor
9569 * for gengrid items, with elm_gengrid_item_cursor_set().
9571 * @note By default, cursors will only be looked for between those
9572 * provided by the rendering engine.
9576 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9579 * Get if the (custom) cursor for a given gengrid item is being
9580 * searched in its theme, also, or is only relying on the rendering
9583 * @param item a gengrid item
9584 * @return @c EINA_TRUE, if cursors are being looked for only on
9585 * those provided by the rendering engine, @c EINA_FALSE if they
9586 * are being searched on the widget's theme, as well.
9588 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9592 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9595 * Remove all items from a given gengrid widget
9597 * @param obj The gengrid object.
9599 * This removes (and deletes) all items in @p obj, leaving it
9602 * @see elm_gengrid_item_del(), to remove just one item.
9606 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9609 * Get the selected item in a given gengrid widget
9611 * @param obj The gengrid object.
9612 * @return The selected item's handleor @c NULL, if none is
9613 * selected at the moment (and on errors)
9615 * This returns the selected item in @p obj. If multi selection is
9616 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9617 * the first item in the list is selected, which might not be very
9618 * useful. For that case, see elm_gengrid_selected_items_get().
9622 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9625 * Get <b>a list</b> of selected items in a given gengrid
9627 * @param obj The gengrid object.
9628 * @return The list of selected items or @c NULL, if none is
9629 * selected at the moment (and on errors)
9631 * This returns a list of the selected items, in the order that
9632 * they appear in the grid. This list is only valid as long as no
9633 * more items are selected or unselected (or unselected implictly
9634 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9637 * @see elm_gengrid_selected_item_get()
9641 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9648 * @defgroup Clock Clock
9650 * @image html img/widget/clock/preview-00.png
9651 * @image latex img/widget/clock/preview-00.eps
9653 * This is a @b digital clock widget. In its default theme, it has a
9654 * vintage "flipping numbers clock" appearance, which will animate
9655 * sheets of individual algarisms individually as time goes by.
9657 * A newly created clock will fetch system's time (already
9658 * considering local time adjustments) to start with, and will tick
9659 * accondingly. It may or may not show seconds.
9661 * Clocks have an @b edition mode. When in it, the sheets will
9662 * display extra arrow indications on the top and bottom and the
9663 * user may click on them to raise or lower the time values. After
9664 * it's told to exit edition mode, it will keep ticking with that
9665 * new time set (it keeps the difference from local time).
9667 * Also, when under edition mode, user clicks on the cited arrows
9668 * which are @b held for some time will make the clock to flip the
9669 * sheet, thus editing the time, continuosly and automatically for
9670 * the user. The interval between sheet flips will keep growing in
9671 * time, so that it helps the user to reach a time which is distant
9674 * The time display is, by default, in military mode (24h), but an
9675 * am/pm indicator may be optionally shown, too, when it will
9678 * Smart callbacks one can register to:
9679 * - "changed" - the clock's user changed the time
9681 * Here is an example on its usage:
9682 * @li @ref clock_example
9691 * Identifiers for which clock digits should be editable, when a
9692 * clock widget is in edition mode. Values may be ORed together to
9693 * make a mask, naturally.
9695 * @see elm_clock_edit_set()
9696 * @see elm_clock_digit_edit_set()
9698 typedef enum _Elm_Clock_Digedit
9700 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9701 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9702 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9703 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9704 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9705 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9706 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9707 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9708 } Elm_Clock_Digedit;
9711 * Add a new clock widget to the given parent Elementary
9712 * (container) object
9714 * @param parent The parent object
9715 * @return a new clock widget handle or @c NULL, on errors
9717 * This function inserts a new clock widget on the canvas.
9721 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9724 * Set a clock widget's time, programmatically
9726 * @param obj The clock widget object
9727 * @param hrs The hours to set
9728 * @param min The minutes to set
9729 * @param sec The secondes to set
9731 * This function updates the time that is showed by the clock
9734 * Values @b must be set within the following ranges:
9735 * - 0 - 23, for hours
9736 * - 0 - 59, for minutes
9737 * - 0 - 59, for seconds,
9739 * even if the clock is not in "military" mode.
9741 * @warning The behavior for values set out of those ranges is @b
9746 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9749 * Get a clock widget's time values
9751 * @param obj The clock object
9752 * @param[out] hrs Pointer to the variable to get the hours value
9753 * @param[out] min Pointer to the variable to get the minutes value
9754 * @param[out] sec Pointer to the variable to get the seconds value
9756 * This function gets the time set for @p obj, returning
9757 * it on the variables passed as the arguments to function
9759 * @note Use @c NULL pointers on the time values you're not
9760 * interested in: they'll be ignored by the function.
9764 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9767 * Set whether a given clock widget is under <b>edition mode</b> or
9768 * under (default) displaying-only mode.
9770 * @param obj The clock object
9771 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9772 * put it back to "displaying only" mode
9774 * This function makes a clock's time to be editable or not <b>by
9775 * user interaction</b>. When in edition mode, clocks @b stop
9776 * ticking, until one brings them back to canonical mode. The
9777 * elm_clock_digit_edit_set() function will influence which digits
9778 * of the clock will be editable. By default, all of them will be
9779 * (#ELM_CLOCK_NONE).
9781 * @note am/pm sheets, if being shown, will @b always be editable
9782 * under edition mode.
9784 * @see elm_clock_edit_get()
9788 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9791 * Retrieve whether a given clock widget is under <b>edition
9792 * mode</b> or under (default) displaying-only mode.
9794 * @param obj The clock object
9795 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9798 * This function retrieves whether the clock's time can be edited
9799 * or not by user interaction.
9801 * @see elm_clock_edit_set() for more details
9805 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9808 * Set what digits of the given clock widget should be editable
9809 * when in edition mode.
9811 * @param obj The clock object
9812 * @param digedit Bit mask indicating the digits to be editable
9813 * (values in #Elm_Clock_Digedit).
9815 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9816 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9819 * @see elm_clock_digit_edit_get()
9823 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9826 * Retrieve what digits of the given clock widget should be
9827 * editable when in edition mode.
9829 * @param obj The clock object
9830 * @return Bit mask indicating the digits to be editable
9831 * (values in #Elm_Clock_Digedit).
9833 * @see elm_clock_digit_edit_set() for more details
9837 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9840 * Set if the given clock widget must show hours in military or
9843 * @param obj The clock object
9844 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9847 * This function sets if the clock must show hours in military or
9848 * am/pm mode. In some countries like Brazil the military mode
9849 * (00-24h-format) is used, in opposition to the USA, where the
9850 * am/pm mode is more commonly used.
9852 * @see elm_clock_show_am_pm_get()
9856 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9859 * Get if the given clock widget shows hours in military or am/pm
9862 * @param obj The clock object
9863 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9866 * This function gets if the clock shows hours in military or am/pm
9869 * @see elm_clock_show_am_pm_set() for more details
9873 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9876 * Set if the given clock widget must show time with seconds or not
9878 * @param obj The clock object
9879 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9881 * This function sets if the given clock must show or not elapsed
9882 * seconds. By default, they are @b not shown.
9884 * @see elm_clock_show_seconds_get()
9888 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9891 * Get whether the given clock widget is showing time with seconds
9894 * @param obj The clock object
9895 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9897 * This function gets whether @p obj is showing or not the elapsed
9900 * @see elm_clock_show_seconds_set()
9904 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9907 * Set the interval on time updates for an user mouse button hold
9908 * on clock widgets' time edition.
9910 * @param obj The clock object
9911 * @param interval The (first) interval value in seconds
9913 * This interval value is @b decreased while the user holds the
9914 * mouse pointer either incrementing or decrementing a given the
9915 * clock digit's value.
9917 * This helps the user to get to a given time distant from the
9918 * current one easier/faster, as it will start to flip quicker and
9919 * quicker on mouse button holds.
9921 * The calculation for the next flip interval value, starting from
9922 * the one set with this call, is the previous interval divided by
9923 * 1.05, so it decreases a little bit.
9925 * The default starting interval value for automatic flips is
9928 * @see elm_clock_interval_get()
9932 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9935 * Get the interval on time updates for an user mouse button hold
9936 * on clock widgets' time edition.
9938 * @param obj The clock object
9939 * @return The (first) interval value, in seconds, set on it
9941 * @see elm_clock_interval_set() for more details
9945 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9952 * @defgroup Layout Layout
9954 * @image html img/widget/layout/preview-00.png
9955 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9957 * @image html img/layout-predefined.png
9958 * @image latex img/layout-predefined.eps width=\textwidth
9960 * This is a container widget that takes a standard Edje design file and
9961 * wraps it very thinly in a widget.
9963 * An Edje design (theme) file has a very wide range of possibilities to
9964 * describe the behavior of elements added to the Layout. Check out the Edje
9965 * documentation and the EDC reference to get more information about what can
9966 * be done with Edje.
9968 * Just like @ref List, @ref Box, and other container widgets, any
9969 * object added to the Layout will become its child, meaning that it will be
9970 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9972 * The Layout widget can contain as many Contents, Boxes or Tables as
9973 * described in its theme file. For instance, objects can be added to
9974 * different Tables by specifying the respective Table part names. The same
9975 * is valid for Content and Box.
9977 * The objects added as child of the Layout will behave as described in the
9978 * part description where they were added. There are 3 possible types of
9979 * parts where a child can be added:
9981 * @section secContent Content (SWALLOW part)
9983 * Only one object can be added to the @c SWALLOW part (but you still can
9984 * have many @c SWALLOW parts and one object on each of them). Use the @c
9985 * elm_object_content_set/get/unset functions to set, retrieve and unset
9986 * objects as content of the @c SWALLOW. After being set to this part, the
9987 * object size, position, visibility, clipping and other description
9988 * properties will be totally controlled by the description of the given part
9989 * (inside the Edje theme file).
9991 * One can use @c evas_object_size_hint_* functions on the child to have some
9992 * kind of control over its behavior, but the resulting behavior will still
9993 * depend heavily on the @c SWALLOW part description.
9995 * The Edje theme also can change the part description, based on signals or
9996 * scripts running inside the theme. This change can also be animated. All of
9997 * this will affect the child object set as content accordingly. The object
9998 * size will be changed if the part size is changed, it will animate move if
9999 * the part is moving, and so on.
10001 * The following picture demonstrates a Layout widget with a child object
10002 * added to its @c SWALLOW:
10004 * @image html layout_swallow.png
10005 * @image latex layout_swallow.eps width=\textwidth
10007 * @section secBox Box (BOX part)
10009 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10010 * allows one to add objects to the box and have them distributed along its
10011 * area, accordingly to the specified @a layout property (now by @a layout we
10012 * mean the chosen layouting design of the Box, not the Layout widget
10015 * A similar effect for having a box with its position, size and other things
10016 * controlled by the Layout theme would be to create an Elementary @ref Box
10017 * widget and add it as a Content in the @c SWALLOW part.
10019 * The main difference of using the Layout Box is that its behavior, the box
10020 * properties like layouting format, padding, align, etc. will be all
10021 * controlled by the theme. This means, for example, that a signal could be
10022 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10023 * handled the signal by changing the box padding, or align, or both. Using
10024 * the Elementary @ref Box widget is not necessarily harder or easier, it
10025 * just depends on the circunstances and requirements.
10027 * The Layout Box can be used through the @c elm_layout_box_* set of
10030 * The following picture demonstrates a Layout widget with many child objects
10031 * added to its @c BOX part:
10033 * @image html layout_box.png
10034 * @image latex layout_box.eps width=\textwidth
10036 * @section secTable Table (TABLE part)
10038 * Just like the @ref secBox, the Layout Table is very similar to the
10039 * Elementary @ref Table widget. It allows one to add objects to the Table
10040 * specifying the row and column where the object should be added, and any
10041 * column or row span if necessary.
10043 * Again, we could have this design by adding a @ref Table widget to the @c
10044 * SWALLOW part using elm_object_part_content_set(). The same difference happens
10045 * here when choosing to use the Layout Table (a @c TABLE part) instead of
10046 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10048 * The Layout Table can be used through the @c elm_layout_table_* set of
10051 * The following picture demonstrates a Layout widget with many child objects
10052 * added to its @c TABLE part:
10054 * @image html layout_table.png
10055 * @image latex layout_table.eps width=\textwidth
10057 * @section secPredef Predefined Layouts
10059 * Another interesting thing about the Layout widget is that it offers some
10060 * predefined themes that come with the default Elementary theme. These
10061 * themes can be set by the call elm_layout_theme_set(), and provide some
10062 * basic functionality depending on the theme used.
10064 * Most of them already send some signals, some already provide a toolbar or
10065 * back and next buttons.
10067 * These are available predefined theme layouts. All of them have class = @c
10068 * layout, group = @c application, and style = one of the following options:
10070 * @li @c toolbar-content - application with toolbar and main content area
10071 * @li @c toolbar-content-back - application with toolbar and main content
10072 * area with a back button and title area
10073 * @li @c toolbar-content-back-next - application with toolbar and main
10074 * content area with a back and next buttons and title area
10075 * @li @c content-back - application with a main content area with a back
10076 * button and title area
10077 * @li @c content-back-next - application with a main content area with a
10078 * back and next buttons and title area
10079 * @li @c toolbar-vbox - application with toolbar and main content area as a
10081 * @li @c toolbar-table - application with toolbar and main content area as a
10084 * @section secExamples Examples
10086 * Some examples of the Layout widget can be found here:
10087 * @li @ref layout_example_01
10088 * @li @ref layout_example_02
10089 * @li @ref layout_example_03
10090 * @li @ref layout_example_edc
10095 * Add a new layout to the parent
10097 * @param parent The parent object
10098 * @return The new object or NULL if it cannot be created
10100 * @see elm_layout_file_set()
10101 * @see elm_layout_theme_set()
10105 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10107 * Set the file that will be used as layout
10109 * @param obj The layout object
10110 * @param file The path to file (edj) that will be used as layout
10111 * @param group The group that the layout belongs in edje file
10113 * @return (1 = success, 0 = error)
10117 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10119 * Set the edje group from the elementary theme that will be used as layout
10121 * @param obj The layout object
10122 * @param clas the clas of the group
10123 * @param group the group
10124 * @param style the style to used
10126 * @return (1 = success, 0 = error)
10130 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10132 * Set the layout content.
10134 * @param obj The layout object
10135 * @param swallow The swallow part name in the edje file
10136 * @param content The child that will be added in this layout object
10138 * Once the content object is set, a previously set one will be deleted.
10139 * If you want to keep that old content object, use the
10140 * elm_object_part_content_unset() function.
10142 * @note In an Edje theme, the part used as a content container is called @c
10143 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10144 * expected to be a part name just like the second parameter of
10145 * elm_layout_box_append().
10147 * @see elm_layout_box_append()
10148 * @see elm_object_part_content_get()
10149 * @see elm_object_part_content_unset()
10151 * @deprecated use elm_object_part_content_set() instead
10155 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10157 * Get the child object in the given content part.
10159 * @param obj The layout object
10160 * @param swallow The SWALLOW part to get its content
10162 * @return The swallowed object or NULL if none or an error occurred
10164 * @deprecated use elm_object_part_content_get() instead
10168 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10170 * Unset the layout content.
10172 * @param obj The layout object
10173 * @param swallow The swallow part name in the edje file
10174 * @return The content that was being used
10176 * Unparent and return the content object which was set for this part.
10178 * @deprecated use elm_object_part_content_unset() instead
10182 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10184 * Set the text of the given part
10186 * @param obj The layout object
10187 * @param part The TEXT part where to set the text
10188 * @param text The text to set
10191 * @deprecated use elm_object_part_text_set() instead.
10193 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10195 * Get the text set in the given part
10197 * @param obj The layout object
10198 * @param part The TEXT part to retrieve the text off
10200 * @return The text set in @p part
10203 * @deprecated use elm_object_part_text_get() instead.
10205 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10207 * Append child to layout box part.
10209 * @param obj the layout object
10210 * @param part the box part to which the object will be appended.
10211 * @param child the child object to append to box.
10213 * Once the object is appended, it will become child of the layout. Its
10214 * lifetime will be bound to the layout, whenever the layout dies the child
10215 * will be deleted automatically. One should use elm_layout_box_remove() to
10216 * make this layout forget about the object.
10218 * @see elm_layout_box_prepend()
10219 * @see elm_layout_box_insert_before()
10220 * @see elm_layout_box_insert_at()
10221 * @see elm_layout_box_remove()
10225 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10227 * Prepend child to layout box part.
10229 * @param obj the layout object
10230 * @param part the box part to prepend.
10231 * @param child the child object to prepend to box.
10233 * Once the object is prepended, it will become child of the layout. Its
10234 * lifetime will be bound to the layout, whenever the layout dies the child
10235 * will be deleted automatically. One should use elm_layout_box_remove() to
10236 * make this layout forget about the object.
10238 * @see elm_layout_box_append()
10239 * @see elm_layout_box_insert_before()
10240 * @see elm_layout_box_insert_at()
10241 * @see elm_layout_box_remove()
10245 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10247 * Insert child to layout box part before a reference object.
10249 * @param obj the layout object
10250 * @param part the box part to insert.
10251 * @param child the child object to insert into box.
10252 * @param reference another reference object to insert before in box.
10254 * Once the object is inserted, it will become child of the layout. Its
10255 * lifetime will be bound to the layout, whenever the layout dies the child
10256 * will be deleted automatically. One should use elm_layout_box_remove() to
10257 * make this layout forget about the object.
10259 * @see elm_layout_box_append()
10260 * @see elm_layout_box_prepend()
10261 * @see elm_layout_box_insert_before()
10262 * @see elm_layout_box_remove()
10266 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10268 * Insert child to layout box part at a given position.
10270 * @param obj the layout object
10271 * @param part the box part to insert.
10272 * @param child the child object to insert into box.
10273 * @param pos the numeric position >=0 to insert the child.
10275 * Once the object is inserted, it will become child of the layout. Its
10276 * lifetime will be bound to the layout, whenever the layout dies the child
10277 * will be deleted automatically. One should use elm_layout_box_remove() to
10278 * make this layout forget about the object.
10280 * @see elm_layout_box_append()
10281 * @see elm_layout_box_prepend()
10282 * @see elm_layout_box_insert_before()
10283 * @see elm_layout_box_remove()
10287 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10289 * Remove a child of the given part box.
10291 * @param obj The layout object
10292 * @param part The box part name to remove child.
10293 * @param child The object to remove from box.
10294 * @return The object that was being used, or NULL if not found.
10296 * The object will be removed from the box part and its lifetime will
10297 * not be handled by the layout anymore. This is equivalent to
10298 * elm_object_part_content_unset() for box.
10300 * @see elm_layout_box_append()
10301 * @see elm_layout_box_remove_all()
10305 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10307 * Remove all children of the given part box.
10309 * @param obj The layout object
10310 * @param part The box part name to remove child.
10311 * @param clear If EINA_TRUE, then all objects will be deleted as
10312 * well, otherwise they will just be removed and will be
10313 * dangling on the canvas.
10315 * The objects will be removed from the box part and their lifetime will
10316 * not be handled by the layout anymore. This is equivalent to
10317 * elm_layout_box_remove() for all box children.
10319 * @see elm_layout_box_append()
10320 * @see elm_layout_box_remove()
10324 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10326 * Insert child to layout table part.
10328 * @param obj the layout object
10329 * @param part the box part to pack child.
10330 * @param child_obj the child object to pack into table.
10331 * @param col the column to which the child should be added. (>= 0)
10332 * @param row the row to which the child should be added. (>= 0)
10333 * @param colspan how many columns should be used to store this object. (>=
10335 * @param rowspan how many rows should be used to store this object. (>= 1)
10337 * Once the object is inserted, it will become child of the table. Its
10338 * lifetime will be bound to the layout, and whenever the layout dies the
10339 * child will be deleted automatically. One should use
10340 * elm_layout_table_remove() to make this layout forget about the object.
10342 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10343 * more space than a single cell. For instance, the following code:
10345 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10348 * Would result in an object being added like the following picture:
10350 * @image html layout_colspan.png
10351 * @image latex layout_colspan.eps width=\textwidth
10353 * @see elm_layout_table_unpack()
10354 * @see elm_layout_table_clear()
10358 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);
10360 * Unpack (remove) a child of the given part table.
10362 * @param obj The layout object
10363 * @param part The table part name to remove child.
10364 * @param child_obj The object to remove from table.
10365 * @return The object that was being used, or NULL if not found.
10367 * The object will be unpacked from the table part and its lifetime
10368 * will not be handled by the layout anymore. This is equivalent to
10369 * elm_object_part_content_unset() for table.
10371 * @see elm_layout_table_pack()
10372 * @see elm_layout_table_clear()
10376 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10378 * Remove all the child objects of the given part table.
10380 * @param obj The layout object
10381 * @param part The table part name to remove child.
10382 * @param clear If EINA_TRUE, then all objects will be deleted as
10383 * well, otherwise they will just be removed and will be
10384 * dangling on the canvas.
10386 * The objects will be removed from the table part and their lifetime will
10387 * not be handled by the layout anymore. This is equivalent to
10388 * elm_layout_table_unpack() for all table children.
10390 * @see elm_layout_table_pack()
10391 * @see elm_layout_table_unpack()
10395 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10397 * Get the edje layout
10399 * @param obj The layout object
10401 * @return A Evas_Object with the edje layout settings loaded
10402 * with function elm_layout_file_set
10404 * This returns the edje object. It is not expected to be used to then
10405 * swallow objects via edje_object_part_swallow() for example. Use
10406 * elm_object_part_content_set() instead so child object handling and sizing is
10409 * @note This function should only be used if you really need to call some
10410 * low level Edje function on this edje object. All the common stuff (setting
10411 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10412 * with proper elementary functions.
10414 * @see elm_object_signal_callback_add()
10415 * @see elm_object_signal_emit()
10416 * @see elm_object_part_text_set()
10417 * @see elm_object_part_content_set()
10418 * @see elm_layout_box_append()
10419 * @see elm_layout_table_pack()
10420 * @see elm_layout_data_get()
10424 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10426 * Get the edje data from the given layout
10428 * @param obj The layout object
10429 * @param key The data key
10431 * @return The edje data string
10433 * This function fetches data specified inside the edje theme of this layout.
10434 * This function return NULL if data is not found.
10436 * In EDC this comes from a data block within the group block that @p
10437 * obj was loaded from. E.g.
10444 * item: "key1" "value1";
10445 * item: "key2" "value2";
10453 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10457 * @param obj The layout object
10459 * Manually forces a sizing re-evaluation. This is useful when the minimum
10460 * size required by the edje theme of this layout has changed. The change on
10461 * the minimum size required by the edje theme is not immediately reported to
10462 * the elementary layout, so one needs to call this function in order to tell
10463 * the widget (layout) that it needs to reevaluate its own size.
10465 * The minimum size of the theme is calculated based on minimum size of
10466 * parts, the size of elements inside containers like box and table, etc. All
10467 * of this can change due to state changes, and that's when this function
10468 * should be called.
10470 * Also note that a standard signal of "size,eval" "elm" emitted from the
10471 * edje object will cause this to happen too.
10475 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10478 * Sets a specific cursor for an edje part.
10480 * @param obj The layout object.
10481 * @param part_name a part from loaded edje group.
10482 * @param cursor cursor name to use, see Elementary_Cursor.h
10484 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10485 * part not exists or it has "mouse_events: 0".
10489 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10492 * Get the cursor to be shown when mouse is over an edje part
10494 * @param obj The layout object.
10495 * @param part_name a part from loaded edje group.
10496 * @return the cursor name.
10500 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10503 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10505 * @param obj The layout object.
10506 * @param part_name a part from loaded edje group, that had a cursor set
10507 * with elm_layout_part_cursor_set().
10511 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10514 * Sets a specific cursor style for an edje part.
10516 * @param obj The layout object.
10517 * @param part_name a part from loaded edje group.
10518 * @param style the theme style to use (default, transparent, ...)
10520 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10521 * part not exists or it did not had a cursor set.
10525 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10528 * Gets a specific cursor style for an edje part.
10530 * @param obj The layout object.
10531 * @param part_name a part from loaded edje group.
10533 * @return the theme style in use, defaults to "default". If the
10534 * object does not have a cursor set, then NULL is returned.
10538 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10541 * Sets if the cursor set should be searched on the theme or should use
10542 * the provided by the engine, only.
10544 * @note before you set if should look on theme you should define a
10545 * cursor with elm_layout_part_cursor_set(). By default it will only
10546 * look for cursors provided by the engine.
10548 * @param obj The layout object.
10549 * @param part_name a part from loaded edje group.
10550 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10551 * or should also search on widget's theme as well (EINA_FALSE)
10553 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10554 * part not exists or it did not had a cursor set.
10558 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);
10561 * Gets a specific cursor engine_only for an edje part.
10563 * @param obj The layout object.
10564 * @param part_name a part from loaded edje group.
10566 * @return whenever the cursor is just provided by engine or also from theme.
10570 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10573 * @def elm_layout_icon_set
10574 * Convenience macro to set the icon object in a layout that follows the
10575 * Elementary naming convention for its parts.
10579 #define elm_layout_icon_set(_ly, _obj) \
10582 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10583 if ((_obj)) sig = "elm,state,icon,visible"; \
10584 else sig = "elm,state,icon,hidden"; \
10585 elm_object_signal_emit((_ly), sig, "elm"); \
10589 * @def elm_layout_icon_get
10590 * Convienience macro to get the icon object from a layout that follows the
10591 * Elementary naming convention for its parts.
10595 #define elm_layout_icon_get(_ly) \
10596 elm_object_part_content_get((_ly), "elm.swallow.icon")
10599 * @def elm_layout_end_set
10600 * Convienience macro to set the end object in a layout that follows the
10601 * Elementary naming convention for its parts.
10605 #define elm_layout_end_set(_ly, _obj) \
10608 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10609 if ((_obj)) sig = "elm,state,end,visible"; \
10610 else sig = "elm,state,end,hidden"; \
10611 elm_object_signal_emit((_ly), sig, "elm"); \
10615 * @def elm_layout_end_get
10616 * Convienience macro to get the end object in a layout that follows the
10617 * Elementary naming convention for its parts.
10621 #define elm_layout_end_get(_ly) \
10622 elm_object_part_content_get((_ly), "elm.swallow.end")
10625 * @def elm_layout_label_set
10626 * Convienience macro to set the label in a layout that follows the
10627 * Elementary naming convention for its parts.
10630 * @deprecated use elm_object_text_set() instead.
10632 #define elm_layout_label_set(_ly, _txt) \
10633 elm_layout_text_set((_ly), "elm.text", (_txt))
10636 * @def elm_layout_label_get
10637 * Convenience macro to get the label in a layout that follows the
10638 * Elementary naming convention for its parts.
10641 * @deprecated use elm_object_text_set() instead.
10643 #define elm_layout_label_get(_ly) \
10644 elm_layout_text_get((_ly), "elm.text")
10646 /* smart callbacks called:
10647 * "theme,changed" - when elm theme is changed.
10651 * @defgroup Notify Notify
10653 * @image html img/widget/notify/preview-00.png
10654 * @image latex img/widget/notify/preview-00.eps
10656 * Display a container in a particular region of the parent(top, bottom,
10657 * etc). A timeout can be set to automatically hide the notify. This is so
10658 * that, after an evas_object_show() on a notify object, if a timeout was set
10659 * on it, it will @b automatically get hidden after that time.
10661 * Signals that you can add callbacks for are:
10662 * @li "timeout" - when timeout happens on notify and it's hidden
10663 * @li "block,clicked" - when a click outside of the notify happens
10665 * Default contents parts of the notify widget that you can use for are:
10666 * @li "default" - A content of the notify
10668 * @ref tutorial_notify show usage of the API.
10673 * @brief Possible orient values for notify.
10675 * This values should be used in conjunction to elm_notify_orient_set() to
10676 * set the position in which the notify should appear(relative to its parent)
10677 * and in conjunction with elm_notify_orient_get() to know where the notify
10680 typedef enum _Elm_Notify_Orient
10682 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10683 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10684 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10685 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10686 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10687 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10688 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10689 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10690 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10691 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10692 } Elm_Notify_Orient;
10694 * @brief Add a new notify to the parent
10696 * @param parent The parent object
10697 * @return The new object or NULL if it cannot be created
10699 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10701 * @brief Set the content of the notify widget
10703 * @param obj The notify object
10704 * @param content The content will be filled in this notify object
10706 * Once the content object is set, a previously set one will be deleted. If
10707 * you want to keep that old content object, use the
10708 * elm_notify_content_unset() function.
10710 * @deprecated use elm_object_content_set() instead
10713 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10715 * @brief Unset the content of the notify widget
10717 * @param obj The notify object
10718 * @return The content that was being used
10720 * Unparent and return the content object which was set for this widget
10722 * @see elm_notify_content_set()
10723 * @deprecated use elm_object_content_unset() instead
10726 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10728 * @brief Return the content of the notify widget
10730 * @param obj The notify object
10731 * @return The content that is being used
10733 * @see elm_notify_content_set()
10734 * @deprecated use elm_object_content_get() instead
10737 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10739 * @brief Set the notify parent
10741 * @param obj The notify object
10742 * @param content The new parent
10744 * Once the parent object is set, a previously set one will be disconnected
10747 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10749 * @brief Get the notify parent
10751 * @param obj The notify object
10752 * @return The parent
10754 * @see elm_notify_parent_set()
10756 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10758 * @brief Set the orientation
10760 * @param obj The notify object
10761 * @param orient The new orientation
10763 * Sets the position in which the notify will appear in its parent.
10765 * @see @ref Elm_Notify_Orient for possible values.
10767 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10769 * @brief Return the orientation
10770 * @param obj The notify object
10771 * @return The orientation of the notification
10773 * @see elm_notify_orient_set()
10774 * @see Elm_Notify_Orient
10776 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10778 * @brief Set the time interval after which the notify window is going to be
10781 * @param obj The notify object
10782 * @param time The timeout in seconds
10784 * This function sets a timeout and starts the timer controlling when the
10785 * notify is hidden. Since calling evas_object_show() on a notify restarts
10786 * the timer controlling when the notify is hidden, setting this before the
10787 * notify is shown will in effect mean starting the timer when the notify is
10790 * @note Set a value <= 0.0 to disable a running timer.
10792 * @note If the value > 0.0 and the notify is previously visible, the
10793 * timer will be started with this value, canceling any running timer.
10795 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10797 * @brief Return the timeout value (in seconds)
10798 * @param obj the notify object
10800 * @see elm_notify_timeout_set()
10802 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10804 * @brief Sets whether events should be passed to by a click outside
10807 * @param obj The notify object
10808 * @param repeats EINA_TRUE Events are repeats, else no
10810 * When true if the user clicks outside the window the events will be caught
10811 * by the others widgets, else the events are blocked.
10813 * @note The default value is EINA_TRUE.
10815 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10817 * @brief Return true if events are repeat below the notify object
10818 * @param obj the notify object
10820 * @see elm_notify_repeat_events_set()
10822 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10828 * @defgroup Hover Hover
10830 * @image html img/widget/hover/preview-00.png
10831 * @image latex img/widget/hover/preview-00.eps
10833 * A Hover object will hover over its @p parent object at the @p target
10834 * location. Anything in the background will be given a darker coloring to
10835 * indicate that the hover object is on top (at the default theme). When the
10836 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10837 * clicked that @b doesn't cause the hover to be dismissed.
10839 * A Hover object has two parents. One parent that owns it during creation
10840 * and the other parent being the one over which the hover object spans.
10843 * @note The hover object will take up the entire space of @p target
10846 * Elementary has the following styles for the hover widget:
10850 * @li hoversel_vertical
10852 * The following are the available position for content:
10864 * Signals that you can add callbacks for are:
10865 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10866 * @li "smart,changed" - a content object placed under the "smart"
10867 * policy was replaced to a new slot direction.
10869 * See @ref tutorial_hover for more information.
10873 typedef enum _Elm_Hover_Axis
10875 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10876 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10877 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10878 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10881 * @brief Adds a hover object to @p parent
10883 * @param parent The parent object
10884 * @return The hover object or NULL if one could not be created
10886 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10888 * @brief Sets the target object for the hover.
10890 * @param obj The hover object
10891 * @param target The object to center the hover onto.
10893 * This function will cause the hover to be centered on the target object.
10895 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10897 * @brief Gets the target object for the hover.
10899 * @param obj The hover object
10900 * @return The target object for the hover.
10902 * @see elm_hover_target_set()
10904 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10906 * @brief Sets the parent object for the hover.
10908 * @param obj The hover object
10909 * @param parent The object to locate the hover over.
10911 * This function will cause the hover to take up the entire space that the
10912 * parent object fills.
10914 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10916 * @brief Gets the parent object for the hover.
10918 * @param obj The hover object
10919 * @return The parent object to locate the hover over.
10921 * @see elm_hover_parent_set()
10923 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10925 * @brief Sets the content of the hover object and the direction in which it
10928 * @param obj The hover object
10929 * @param swallow The direction that the object will be displayed
10930 * at. Accepted values are "left", "top-left", "top", "top-right",
10931 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10933 * @param content The content to place at @p swallow
10935 * Once the content object is set for a given direction, a previously
10936 * set one (on the same direction) will be deleted. If you want to
10937 * keep that old content object, use the elm_hover_content_unset()
10940 * All directions may have contents at the same time, except for
10941 * "smart". This is a special placement hint and its use case
10942 * independs of the calculations coming from
10943 * elm_hover_best_content_location_get(). Its use is for cases when
10944 * one desires only one hover content, but with a dynamic special
10945 * placement within the hover area. The content's geometry, whenever
10946 * it changes, will be used to decide on a best location, not
10947 * extrapolating the hover's parent object view to show it in (still
10948 * being the hover's target determinant of its medium part -- move and
10949 * resize it to simulate finger sizes, for example). If one of the
10950 * directions other than "smart" are used, a previously content set
10951 * using it will be deleted, and vice-versa.
10953 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10955 * @brief Get the content of the hover object, in a given direction.
10957 * Return the content object which was set for this widget in the
10958 * @p swallow direction.
10960 * @param obj The hover object
10961 * @param swallow The direction that the object was display at.
10962 * @return The content that was being used
10964 * @see elm_hover_content_set()
10966 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10968 * @brief Unset the content of the hover object, in a given direction.
10970 * Unparent and return the content object set at @p swallow direction.
10972 * @param obj The hover object
10973 * @param swallow The direction that the object was display at.
10974 * @return The content that was being used.
10976 * @see elm_hover_content_set()
10978 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10980 * @brief Returns the best swallow location for content in the hover.
10982 * @param obj The hover object
10983 * @param pref_axis The preferred orientation axis for the hover object to use
10984 * @return The edje location to place content into the hover or @c
10987 * Best is defined here as the location at which there is the most available
10990 * @p pref_axis may be one of
10991 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10992 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10993 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10994 * - @c ELM_HOVER_AXIS_BOTH -- both
10996 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10997 * nescessarily be along the horizontal axis("left" or "right"). If
10998 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10999 * be along the vertical axis("top" or "bottom"). Chossing
11000 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11001 * returned position may be in either axis.
11003 * @see elm_hover_content_set()
11005 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11012 * @defgroup Entry Entry
11014 * @image html img/widget/entry/preview-00.png
11015 * @image latex img/widget/entry/preview-00.eps width=\textwidth
11016 * @image html img/widget/entry/preview-01.png
11017 * @image latex img/widget/entry/preview-01.eps width=\textwidth
11018 * @image html img/widget/entry/preview-02.png
11019 * @image latex img/widget/entry/preview-02.eps width=\textwidth
11020 * @image html img/widget/entry/preview-03.png
11021 * @image latex img/widget/entry/preview-03.eps width=\textwidth
11023 * An entry is a convenience widget which shows a box that the user can
11024 * enter text into. Entries by default don't scroll, so they grow to
11025 * accomodate the entire text, resizing the parent window as needed. This
11026 * can be changed with the elm_entry_scrollable_set() function.
11028 * They can also be single line or multi line (the default) and when set
11029 * to multi line mode they support text wrapping in any of the modes
11030 * indicated by #Elm_Wrap_Type.
11032 * Other features include password mode, filtering of inserted text with
11033 * elm_entry_text_filter_append() and related functions, inline "items" and
11034 * formatted markup text.
11036 * @section entry-markup Formatted text
11038 * The markup tags supported by the Entry are defined by the theme, but
11039 * even when writing new themes or extensions it's a good idea to stick to
11040 * a sane default, to maintain coherency and avoid application breakages.
11041 * Currently defined by the default theme are the following tags:
11042 * @li \<br\>: Inserts a line break.
11043 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11045 * @li \<tab\>: Inserts a tab.
11046 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11048 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11049 * @li \<link\>...\</link\>: Underlines the enclosed text.
11050 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11052 * @section entry-special Special markups
11054 * Besides those used to format text, entries support two special markup
11055 * tags used to insert clickable portions of text or items inlined within
11058 * @subsection entry-anchors Anchors
11060 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11061 * \</a\> tags and an event will be generated when this text is clicked,
11065 * This text is outside <a href=anc-01>but this one is an anchor</a>
11068 * The @c href attribute in the opening tag gives the name that will be
11069 * used to identify the anchor and it can be any valid utf8 string.
11071 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11072 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11073 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11074 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11077 * @subsection entry-items Items
11079 * Inlined in the text, any other @c Evas_Object can be inserted by using
11080 * \<item\> tags this way:
11083 * <item size=16x16 vsize=full href=emoticon/haha></item>
11086 * Just like with anchors, the @c href identifies each item, but these need,
11087 * in addition, to indicate their size, which is done using any one of
11088 * @c size, @c absize or @c relsize attributes. These attributes take their
11089 * value in the WxH format, where W is the width and H the height of the
11092 * @li absize: Absolute pixel size for the item. Whatever value is set will
11093 * be the item's size regardless of any scale value the object may have
11094 * been set to. The final line height will be adjusted to fit larger items.
11095 * @li size: Similar to @c absize, but it's adjusted to the scale value set
11097 * @li relsize: Size is adjusted for the item to fit within the current
11100 * Besides their size, items are specificed a @c vsize value that affects
11101 * how their final size and position are calculated. The possible values
11103 * @li ascent: Item will be placed within the line's baseline and its
11104 * ascent. That is, the height between the line where all characters are
11105 * positioned and the highest point in the line. For @c size and @c absize
11106 * items, the descent value will be added to the total line height to make
11107 * them fit. @c relsize items will be adjusted to fit within this space.
11108 * @li full: Items will be placed between the descent and ascent, or the
11109 * lowest point in the line and its highest.
11111 * The next image shows different configurations of items and how
11112 * the previously mentioned options affect their sizes. In all cases,
11113 * the green line indicates the ascent, blue for the baseline and red for
11116 * @image html entry_item.png
11117 * @image latex entry_item.eps width=\textwidth
11119 * And another one to show how size differs from absize. In the first one,
11120 * the scale value is set to 1.0, while the second one is using one of 2.0.
11122 * @image html entry_item_scale.png
11123 * @image latex entry_item_scale.eps width=\textwidth
11125 * After the size for an item is calculated, the entry will request an
11126 * object to place in its space. For this, the functions set with
11127 * elm_entry_item_provider_append() and related functions will be called
11128 * in order until one of them returns a @c non-NULL value. If no providers
11129 * are available, or all of them return @c NULL, then the entry falls back
11130 * to one of the internal defaults, provided the name matches with one of
11133 * All of the following are currently supported:
11136 * - emoticon/angry-shout
11137 * - emoticon/crazy-laugh
11138 * - emoticon/evil-laugh
11140 * - emoticon/goggle-smile
11141 * - emoticon/grumpy
11142 * - emoticon/grumpy-smile
11143 * - emoticon/guilty
11144 * - emoticon/guilty-smile
11146 * - emoticon/half-smile
11147 * - emoticon/happy-panting
11149 * - emoticon/indifferent
11151 * - emoticon/knowing-grin
11153 * - emoticon/little-bit-sorry
11154 * - emoticon/love-lots
11156 * - emoticon/minimal-smile
11157 * - emoticon/not-happy
11158 * - emoticon/not-impressed
11160 * - emoticon/opensmile
11163 * - emoticon/squint-laugh
11164 * - emoticon/surprised
11165 * - emoticon/suspicious
11166 * - emoticon/tongue-dangling
11167 * - emoticon/tongue-poke
11169 * - emoticon/unhappy
11170 * - emoticon/very-sorry
11173 * - emoticon/worried
11176 * Alternatively, an item may reference an image by its path, using
11177 * the URI form @c file:///path/to/an/image.png and the entry will then
11178 * use that image for the item.
11180 * @section entry-files Loading and saving files
11182 * Entries have convinience functions to load text from a file and save
11183 * changes back to it after a short delay. The automatic saving is enabled
11184 * by default, but can be disabled with elm_entry_autosave_set() and files
11185 * can be loaded directly as plain text or have any markup in them
11186 * recognized. See elm_entry_file_set() for more details.
11188 * @section entry-signals Emitted signals
11190 * This widget emits the following signals:
11192 * @li "changed": The text within the entry was changed.
11193 * @li "changed,user": The text within the entry was changed because of user interaction.
11194 * @li "activated": The enter key was pressed on a single line entry.
11195 * @li "press": A mouse button has been pressed on the entry.
11196 * @li "longpressed": A mouse button has been pressed and held for a couple
11198 * @li "clicked": The entry has been clicked (mouse press and release).
11199 * @li "clicked,double": The entry has been double clicked.
11200 * @li "clicked,triple": The entry has been triple clicked.
11201 * @li "focused": The entry has received focus.
11202 * @li "unfocused": The entry has lost focus.
11203 * @li "selection,paste": A paste of the clipboard contents was requested.
11204 * @li "selection,copy": A copy of the selected text into the clipboard was
11206 * @li "selection,cut": A cut of the selected text into the clipboard was
11208 * @li "selection,start": A selection has begun and no previous selection
11210 * @li "selection,changed": The current selection has changed.
11211 * @li "selection,cleared": The current selection has been cleared.
11212 * @li "cursor,changed": The cursor has changed position.
11213 * @li "anchor,clicked": An anchor has been clicked. The event_info
11214 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11215 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11216 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11217 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11218 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11219 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11220 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11221 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11222 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11223 * @li "preedit,changed": The preedit string has changed.
11224 * @li "language,changed": Program language changed.
11226 * @section entry-examples
11228 * An overview of the Entry API can be seen in @ref entry_example_01
11233 * @typedef Elm_Entry_Anchor_Info
11235 * The info sent in the callback for the "anchor,clicked" signals emitted
11238 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11240 * @struct _Elm_Entry_Anchor_Info
11242 * The info sent in the callback for the "anchor,clicked" signals emitted
11245 struct _Elm_Entry_Anchor_Info
11247 const char *name; /**< The name of the anchor, as stated in its href */
11248 int button; /**< The mouse button used to click on it */
11249 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11250 y, /**< Anchor geometry, relative to canvas */
11251 w, /**< Anchor geometry, relative to canvas */
11252 h; /**< Anchor geometry, relative to canvas */
11255 * @typedef Elm_Entry_Filter_Cb
11256 * This callback type is used by entry filters to modify text.
11257 * @param data The data specified as the last param when adding the filter
11258 * @param entry The entry object
11259 * @param text A pointer to the location of the text being filtered. This data can be modified,
11260 * but any additional allocations must be managed by the user.
11261 * @see elm_entry_text_filter_append
11262 * @see elm_entry_text_filter_prepend
11264 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11267 * @typedef Elm_Entry_Change_Info
11268 * This corresponds to Edje_Entry_Change_Info. Includes information about
11269 * a change in the entry.
11271 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11275 * This adds an entry to @p parent object.
11277 * By default, entries are:
11281 * @li autosave is enabled
11283 * @param parent The parent object
11284 * @return The new object or NULL if it cannot be created
11286 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11288 * Sets the entry to single line mode.
11290 * In single line mode, entries don't ever wrap when the text reaches the
11291 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11292 * key will generate an @c "activate" event instead of adding a new line.
11294 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11295 * and pressing enter will break the text into a different line
11296 * without generating any events.
11298 * @param obj The entry object
11299 * @param single_line If true, the text in the entry
11300 * will be on a single line.
11302 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11304 * Gets whether the entry is set to be single line.
11306 * @param obj The entry object
11307 * @return single_line If true, the text in the entry is set to display
11308 * on a single line.
11310 * @see elm_entry_single_line_set()
11312 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11314 * Sets the entry to password mode.
11316 * In password mode, entries are implicitly single line and the display of
11317 * any text in them is replaced with asterisks (*).
11319 * @param obj The entry object
11320 * @param password If true, password mode is enabled.
11322 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11324 * Gets whether the entry is set to password mode.
11326 * @param obj The entry object
11327 * @return If true, the entry is set to display all characters
11328 * as asterisks (*).
11330 * @see elm_entry_password_set()
11332 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11334 * This sets the text displayed within the entry to @p entry.
11336 * @param obj The entry object
11337 * @param entry The text to be displayed
11339 * @deprecated Use elm_object_text_set() instead.
11340 * @note Using this function bypasses text filters
11342 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11344 * This returns the text currently shown in object @p entry.
11345 * See also elm_entry_entry_set().
11347 * @param obj The entry object
11348 * @return The currently displayed text or NULL on failure
11350 * @deprecated Use elm_object_text_get() instead.
11352 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11354 * Appends @p entry to the text of the entry.
11356 * Adds the text in @p entry to the end of any text already present in the
11359 * The appended text is subject to any filters set for the widget.
11361 * @param obj The entry object
11362 * @param entry The text to be displayed
11364 * @see elm_entry_text_filter_append()
11366 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11368 * Gets whether the entry is empty.
11370 * Empty means no text at all. If there are any markup tags, like an item
11371 * tag for which no provider finds anything, and no text is displayed, this
11372 * function still returns EINA_FALSE.
11374 * @param obj The entry object
11375 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11377 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11379 * Gets any selected text within the entry.
11381 * If there's any selected text in the entry, this function returns it as
11382 * a string in markup format. NULL is returned if no selection exists or
11383 * if an error occurred.
11385 * The returned value points to an internal string and should not be freed
11386 * or modified in any way. If the @p entry object is deleted or its
11387 * contents are changed, the returned pointer should be considered invalid.
11389 * @param obj The entry object
11390 * @return The selected text within the entry or NULL on failure
11392 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11394 * Returns the actual textblock object of the entry.
11396 * This function exposes the internal textblock object that actually
11397 * contains and draws the text. This should be used for low-level
11398 * manipulations that are otherwise not possible.
11400 * Changing the textblock directly from here will not notify edje/elm to
11401 * recalculate the textblock size automatically, so any modifications
11402 * done to the textblock returned by this function should be followed by
11403 * a call to elm_entry_calc_force().
11405 * The return value is marked as const as an additional warning.
11406 * One should not use the returned object with any of the generic evas
11407 * functions (geometry_get/resize/move and etc), but only with the textblock
11408 * functions; The former will either not work at all, or break the correct
11411 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11412 * the internal textblock object. Do NOT cache the returned object, and try
11413 * not to mix calls on this object with regular elm_entry calls (which may
11414 * change the internal textblock object). This applies to all cursors
11415 * returned from textblock calls, and all the other derivative values.
11417 * @param obj The entry object
11418 * @return The textblock object.
11420 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11422 * Forces calculation of the entry size and text layouting.
11424 * This should be used after modifying the textblock object directly. See
11425 * elm_entry_textblock_get() for more information.
11427 * @param obj The entry object
11429 * @see elm_entry_textblock_get()
11431 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11433 * Inserts the given text into the entry at the current cursor position.
11435 * This inserts text at the cursor position as if it was typed
11436 * by the user (note that this also allows markup which a user
11437 * can't just "type" as it would be converted to escaped text, so this
11438 * call can be used to insert things like emoticon items or bold push/pop
11439 * tags, other font and color change tags etc.)
11441 * If any selection exists, it will be replaced by the inserted text.
11443 * The inserted text is subject to any filters set for the widget.
11445 * @param obj The entry object
11446 * @param entry The text to insert
11448 * @see elm_entry_text_filter_append()
11450 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11452 * Set the line wrap type to use on multi-line entries.
11454 * Sets the wrap type used by the entry to any of the specified in
11455 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11456 * line (without inserting a line break or paragraph separator) when it
11457 * reaches the far edge of the widget.
11459 * Note that this only makes sense for multi-line entries. A widget set
11460 * to be single line will never wrap.
11462 * @param obj The entry object
11463 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11465 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11467 * Gets the wrap mode the entry was set to use.
11469 * @param obj The entry object
11470 * @return Wrap type
11472 * @see also elm_entry_line_wrap_set()
11474 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11476 * Sets if the entry is to be editable or not.
11478 * By default, entries are editable and when focused, any text input by the
11479 * user will be inserted at the current cursor position. But calling this
11480 * function with @p editable as EINA_FALSE will prevent the user from
11481 * inputting text into the entry.
11483 * The only way to change the text of a non-editable entry is to use
11484 * elm_object_text_set(), elm_entry_entry_insert() and other related
11487 * @param obj The entry object
11488 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11489 * if not, the entry is read-only and no user input is allowed.
11491 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11493 * Gets whether the entry is editable or not.
11495 * @param obj The entry object
11496 * @return If true, the entry is editable by the user.
11497 * If false, it is not editable by the user
11499 * @see elm_entry_editable_set()
11501 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11503 * This drops any existing text selection within the entry.
11505 * @param obj The entry object
11507 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11509 * This selects all text within the entry.
11511 * @param obj The entry object
11513 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11515 * This moves the cursor one place to the right within the entry.
11517 * @param obj The entry object
11518 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11520 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11522 * This moves the cursor one place to the left within the entry.
11524 * @param obj The entry object
11525 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11527 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11529 * This moves the cursor one line up within the entry.
11531 * @param obj The entry object
11532 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11534 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11536 * This moves the cursor one line down within the entry.
11538 * @param obj The entry object
11539 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11541 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11543 * This moves the cursor to the beginning of the entry.
11545 * @param obj The entry object
11547 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11549 * This moves the cursor to the end of the entry.
11551 * @param obj The entry object
11553 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11555 * This moves the cursor to the beginning of the current line.
11557 * @param obj The entry object
11559 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11561 * This moves the cursor to the end of the current line.
11563 * @param obj The entry object
11565 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11567 * This begins a selection within the entry as though
11568 * the user were holding down the mouse button to make a selection.
11570 * @param obj The entry object
11572 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11574 * This ends a selection within the entry as though
11575 * the user had just released the mouse button while making a selection.
11577 * @param obj The entry object
11579 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11581 * Gets whether a format node exists at the current cursor position.
11583 * A format node is anything that defines how the text is rendered. It can
11584 * be a visible format node, such as a line break or a paragraph separator,
11585 * or an invisible one, such as bold begin or end tag.
11586 * This function returns whether any format node exists at the current
11589 * @param obj The entry object
11590 * @return EINA_TRUE if the current cursor position contains a format node,
11591 * EINA_FALSE otherwise.
11593 * @see elm_entry_cursor_is_visible_format_get()
11595 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11597 * Gets if the current cursor position holds a visible format node.
11599 * @param obj The entry object
11600 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11601 * if it's an invisible one or no format exists.
11603 * @see elm_entry_cursor_is_format_get()
11605 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11607 * Gets the character pointed by the cursor at its current position.
11609 * This function returns a string with the utf8 character stored at the
11610 * current cursor position.
11611 * Only the text is returned, any format that may exist will not be part
11612 * of the return value.
11614 * @param obj The entry object
11615 * @return The text pointed by the cursors.
11617 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11619 * This function returns the geometry of the cursor.
11621 * It's useful if you want to draw something on the cursor (or where it is),
11622 * or for example in the case of scrolled entry where you want to show the
11625 * @param obj The entry object
11626 * @param x returned geometry
11627 * @param y returned geometry
11628 * @param w returned geometry
11629 * @param h returned geometry
11630 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11632 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);
11634 * Sets the cursor position in the entry to the given value
11636 * The value in @p pos is the index of the character position within the
11637 * contents of the string as returned by elm_entry_cursor_pos_get().
11639 * @param obj The entry object
11640 * @param pos The position of the cursor
11642 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11644 * Retrieves the current position of the cursor in the entry
11646 * @param obj The entry object
11647 * @return The cursor position
11649 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11651 * This executes a "cut" action on the selected text in the entry.
11653 * @param obj The entry object
11655 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11657 * This executes a "copy" action on the selected text in the entry.
11659 * @param obj The entry object
11661 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11663 * This executes a "paste" action in the entry.
11665 * @param obj The entry object
11667 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11669 * This clears and frees the items in a entry's contextual (longpress)
11672 * @param obj The entry object
11674 * @see elm_entry_context_menu_item_add()
11676 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11678 * This adds an item to the entry's contextual menu.
11680 * A longpress on an entry will make the contextual menu show up, if this
11681 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11682 * By default, this menu provides a few options like enabling selection mode,
11683 * which is useful on embedded devices that need to be explicit about it,
11684 * and when a selection exists it also shows the copy and cut actions.
11686 * With this function, developers can add other options to this menu to
11687 * perform any action they deem necessary.
11689 * @param obj The entry object
11690 * @param label The item's text label
11691 * @param icon_file The item's icon file
11692 * @param icon_type The item's icon type
11693 * @param func The callback to execute when the item is clicked
11694 * @param data The data to associate with the item for related functions
11696 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);
11698 * This disables the entry's contextual (longpress) menu.
11700 * @param obj The entry object
11701 * @param disabled If true, the menu is disabled
11703 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11705 * This returns whether the entry's contextual (longpress) menu is
11708 * @param obj The entry object
11709 * @return If true, the menu is disabled
11711 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11713 * This appends a custom item provider to the list for that entry
11715 * This appends the given callback. The list is walked from beginning to end
11716 * with each function called given the item href string in the text. If the
11717 * function returns an object handle other than NULL (it should create an
11718 * object to do this), then this object is used to replace that item. If
11719 * not the next provider is called until one provides an item object, or the
11720 * default provider in entry does.
11722 * @param obj The entry object
11723 * @param func The function called to provide the item object
11724 * @param data The data passed to @p func
11726 * @see @ref entry-items
11728 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);
11730 * This prepends a custom item provider to the list for that entry
11732 * This prepends the given callback. See elm_entry_item_provider_append() for
11735 * @param obj The entry object
11736 * @param func The function called to provide the item object
11737 * @param data The data passed to @p func
11739 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);
11741 * This removes a custom item provider to the list for that entry
11743 * This removes the given callback. See elm_entry_item_provider_append() for
11746 * @param obj The entry object
11747 * @param func The function called to provide the item object
11748 * @param data The data passed to @p func
11750 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);
11752 * Append a filter function for text inserted in the entry
11754 * Append the given callback to the list. This functions will be called
11755 * whenever any text is inserted into the entry, with the text to be inserted
11756 * as a parameter. The callback function is free to alter the text in any way
11757 * it wants, but it must remember to free the given pointer and update it.
11758 * If the new text is to be discarded, the function can free it and set its
11759 * text parameter to NULL. This will also prevent any following filters from
11762 * @param obj The entry object
11763 * @param func The function to use as text filter
11764 * @param data User data to pass to @p func
11766 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11768 * Prepend a filter function for text insdrted in the entry
11770 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11771 * for more information
11773 * @param obj The entry object
11774 * @param func The function to use as text filter
11775 * @param data User data to pass to @p func
11777 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11779 * Remove a filter from the list
11781 * Removes the given callback from the filter list. See
11782 * elm_entry_text_filter_append() for more information.
11784 * @param obj The entry object
11785 * @param func The filter function to remove
11786 * @param data The user data passed when adding the function
11788 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11790 * This converts a markup (HTML-like) string into UTF-8.
11792 * The returned string is a malloc'ed buffer and it should be freed when
11793 * not needed anymore.
11795 * @param s The string (in markup) to be converted
11796 * @return The converted string (in UTF-8). It should be freed.
11798 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11800 * This converts a UTF-8 string into markup (HTML-like).
11802 * The returned string is a malloc'ed buffer and it should be freed when
11803 * not needed anymore.
11805 * @param s The string (in UTF-8) to be converted
11806 * @return The converted string (in markup). It should be freed.
11808 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11810 * This sets the file (and implicitly loads it) for the text to display and
11811 * then edit. All changes are written back to the file after a short delay if
11812 * the entry object is set to autosave (which is the default).
11814 * If the entry had any other file set previously, any changes made to it
11815 * will be saved if the autosave feature is enabled, otherwise, the file
11816 * will be silently discarded and any non-saved changes will be lost.
11818 * @param obj The entry object
11819 * @param file The path to the file to load and save
11820 * @param format The file format
11822 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11824 * Gets the file being edited by the entry.
11826 * This function can be used to retrieve any file set on the entry for
11827 * edition, along with the format used to load and save it.
11829 * @param obj The entry object
11830 * @param file The path to the file to load and save
11831 * @param format The file format
11833 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11835 * This function writes any changes made to the file set with
11836 * elm_entry_file_set()
11838 * @param obj The entry object
11840 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11842 * This sets the entry object to 'autosave' the loaded text file or not.
11844 * @param obj The entry object
11845 * @param autosave Autosave the loaded file or not
11847 * @see elm_entry_file_set()
11849 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11851 * This gets the entry object's 'autosave' status.
11853 * @param obj The entry object
11854 * @return Autosave the loaded file or not
11856 * @see elm_entry_file_set()
11858 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11860 * Control pasting of text and images for the widget.
11862 * Normally the entry allows both text and images to be pasted. By setting
11863 * textonly to be true, this prevents images from being pasted.
11865 * Note this only changes the behaviour of text.
11867 * @param obj The entry object
11868 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11869 * text+image+other.
11871 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11873 * Getting elm_entry text paste/drop mode.
11875 * In textonly mode, only text may be pasted or dropped into the widget.
11877 * @param obj The entry object
11878 * @return If the widget only accepts text from pastes.
11880 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11882 * Enable or disable scrolling in entry
11884 * Normally the entry is not scrollable unless you enable it with this call.
11886 * @param obj The entry object
11887 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11889 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11891 * Get the scrollable state of the entry
11893 * Normally the entry is not scrollable. This gets the scrollable state
11894 * of the entry. See elm_entry_scrollable_set() for more information.
11896 * @param obj The entry object
11897 * @return The scrollable state
11899 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11901 * This sets a widget to be displayed to the left of a scrolled entry.
11903 * @param obj The scrolled entry object
11904 * @param icon The widget to display on the left side of the scrolled
11907 * @note A previously set widget will be destroyed.
11908 * @note If the object being set does not have minimum size hints set,
11909 * it won't get properly displayed.
11911 * @see elm_entry_end_set()
11913 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11915 * Gets the leftmost widget of the scrolled entry. This object is
11916 * owned by the scrolled entry and should not be modified.
11918 * @param obj The scrolled entry object
11919 * @return the left widget inside the scroller
11921 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11923 * Unset the leftmost widget of the scrolled entry, unparenting and
11926 * @param obj The scrolled entry object
11927 * @return the previously set icon sub-object of this entry, on
11930 * @see elm_entry_icon_set()
11932 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11934 * Sets the visibility of the left-side widget of the scrolled entry,
11935 * set by elm_entry_icon_set().
11937 * @param obj The scrolled entry object
11938 * @param setting EINA_TRUE if the object should be displayed,
11939 * EINA_FALSE if not.
11941 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11943 * This sets a widget to be displayed to the end of a scrolled entry.
11945 * @param obj The scrolled entry object
11946 * @param end The widget to display on the right side of the scrolled
11949 * @note A previously set widget will be destroyed.
11950 * @note If the object being set does not have minimum size hints set,
11951 * it won't get properly displayed.
11953 * @see elm_entry_icon_set
11955 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11957 * Gets the endmost widget of the scrolled entry. This object is owned
11958 * by the scrolled entry and should not be modified.
11960 * @param obj The scrolled entry object
11961 * @return the right widget inside the scroller
11963 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11965 * Unset the endmost widget of the scrolled entry, unparenting and
11968 * @param obj The scrolled entry object
11969 * @return the previously set icon sub-object of this entry, on
11972 * @see elm_entry_icon_set()
11974 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11976 * Sets the visibility of the end widget of the scrolled entry, set by
11977 * elm_entry_end_set().
11979 * @param obj The scrolled entry object
11980 * @param setting EINA_TRUE if the object should be displayed,
11981 * EINA_FALSE if not.
11983 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11985 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11988 * Setting an entry to single-line mode with elm_entry_single_line_set()
11989 * will automatically disable the display of scrollbars when the entry
11990 * moves inside its scroller.
11992 * @param obj The scrolled entry object
11993 * @param h The horizontal scrollbar policy to apply
11994 * @param v The vertical scrollbar policy to apply
11996 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11998 * This enables/disables bouncing within the entry.
12000 * This function sets whether the entry will bounce when scrolling reaches
12001 * the end of the contained entry.
12003 * @param obj The scrolled entry object
12004 * @param h The horizontal bounce state
12005 * @param v The vertical bounce state
12007 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12009 * Get the bounce mode
12011 * @param obj The Entry object
12012 * @param h_bounce Allow bounce horizontally
12013 * @param v_bounce Allow bounce vertically
12015 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12017 /* pre-made filters for entries */
12019 * @typedef Elm_Entry_Filter_Limit_Size
12021 * Data for the elm_entry_filter_limit_size() entry filter.
12023 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12025 * @struct _Elm_Entry_Filter_Limit_Size
12027 * Data for the elm_entry_filter_limit_size() entry filter.
12029 struct _Elm_Entry_Filter_Limit_Size
12031 int max_char_count; /**< The maximum number of characters allowed. */
12032 int max_byte_count; /**< The maximum number of bytes allowed*/
12035 * Filter inserted text based on user defined character and byte limits
12037 * Add this filter to an entry to limit the characters that it will accept
12038 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12039 * The funtion works on the UTF-8 representation of the string, converting
12040 * it from the set markup, thus not accounting for any format in it.
12042 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12043 * it as data when setting the filter. In it, it's possible to set limits
12044 * by character count or bytes (any of them is disabled if 0), and both can
12045 * be set at the same time. In that case, it first checks for characters,
12048 * The function will cut the inserted text in order to allow only the first
12049 * number of characters that are still allowed. The cut is made in
12050 * characters, even when limiting by bytes, in order to always contain
12051 * valid ones and avoid half unicode characters making it in.
12053 * This filter, like any others, does not apply when setting the entry text
12054 * directly with elm_object_text_set() (or the deprecated
12055 * elm_entry_entry_set()).
12057 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12059 * @typedef Elm_Entry_Filter_Accept_Set
12061 * Data for the elm_entry_filter_accept_set() entry filter.
12063 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12065 * @struct _Elm_Entry_Filter_Accept_Set
12067 * Data for the elm_entry_filter_accept_set() entry filter.
12069 struct _Elm_Entry_Filter_Accept_Set
12071 const char *accepted; /**< Set of characters accepted in the entry. */
12072 const char *rejected; /**< Set of characters rejected from the entry. */
12075 * Filter inserted text based on accepted or rejected sets of characters
12077 * Add this filter to an entry to restrict the set of accepted characters
12078 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12079 * This structure contains both accepted and rejected sets, but they are
12080 * mutually exclusive.
12082 * The @c accepted set takes preference, so if it is set, the filter will
12083 * only work based on the accepted characters, ignoring anything in the
12084 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12086 * In both cases, the function filters by matching utf8 characters to the
12087 * raw markup text, so it can be used to remove formatting tags.
12089 * This filter, like any others, does not apply when setting the entry text
12090 * directly with elm_object_text_set() (or the deprecated
12091 * elm_entry_entry_set()).
12093 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12095 * Set the input panel layout of the entry
12097 * @param obj The entry object
12098 * @param layout layout type
12100 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12102 * Get the input panel layout of the entry
12104 * @param obj The entry object
12105 * @return layout type
12107 * @see elm_entry_input_panel_layout_set
12109 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12111 * Set the autocapitalization type on the immodule.
12113 * @param obj The entry object
12114 * @param autocapital_type The type of autocapitalization
12116 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12118 * Retrieve the autocapitalization type on the immodule.
12120 * @param obj The entry object
12121 * @return autocapitalization type
12123 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12125 * Sets the attribute to show the input panel automatically.
12127 * @param obj The entry object
12128 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12130 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12132 * Retrieve the attribute to show the input panel automatically.
12134 * @param obj The entry object
12135 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12137 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12143 /* composite widgets - these basically put together basic widgets above
12144 * in convenient packages that do more than basic stuff */
12148 * @defgroup Anchorview Anchorview
12150 * @image html img/widget/anchorview/preview-00.png
12151 * @image latex img/widget/anchorview/preview-00.eps
12153 * Anchorview is for displaying text that contains markup with anchors
12154 * like <c>\<a href=1234\>something\</\></c> in it.
12156 * Besides being styled differently, the anchorview widget provides the
12157 * necessary functionality so that clicking on these anchors brings up a
12158 * popup with user defined content such as "call", "add to contacts" or
12159 * "open web page". This popup is provided using the @ref Hover widget.
12161 * This widget is very similar to @ref Anchorblock, so refer to that
12162 * widget for an example. The only difference Anchorview has is that the
12163 * widget is already provided with scrolling functionality, so if the
12164 * text set to it is too large to fit in the given space, it will scroll,
12165 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12166 * text can be displayed.
12168 * This widget emits the following signals:
12169 * @li "anchor,clicked": will be called when an anchor is clicked. The
12170 * @p event_info parameter on the callback will be a pointer of type
12171 * ::Elm_Entry_Anchorview_Info.
12173 * See @ref Anchorblock for an example on how to use both of them.
12182 * @typedef Elm_Entry_Anchorview_Info
12184 * The info sent in the callback for "anchor,clicked" signals emitted by
12185 * the Anchorview widget.
12187 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12189 * @struct _Elm_Entry_Anchorview_Info
12191 * The info sent in the callback for "anchor,clicked" signals emitted by
12192 * the Anchorview widget.
12194 struct _Elm_Entry_Anchorview_Info
12196 const char *name; /**< Name of the anchor, as indicated in its href
12198 int button; /**< The mouse button used to click on it */
12199 Evas_Object *hover; /**< The hover object to use for the popup */
12201 Evas_Coord x, y, w, h;
12202 } anchor, /**< Geometry selection of text used as anchor */
12203 hover_parent; /**< Geometry of the object used as parent by the
12205 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12206 for content on the left side of
12207 the hover. Before calling the
12208 callback, the widget will make the
12209 necessary calculations to check
12210 which sides are fit to be set with
12211 content, based on the position the
12212 hover is activated and its distance
12213 to the edges of its parent object
12215 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12216 the right side of the hover.
12217 See @ref hover_left */
12218 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12219 of the hover. See @ref hover_left */
12220 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12221 below the hover. See @ref
12225 * Add a new Anchorview object
12227 * @param parent The parent object
12228 * @return The new object or NULL if it cannot be created
12230 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12232 * Set the text to show in the anchorview
12234 * Sets the text of the anchorview to @p text. This text can include markup
12235 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12236 * text that will be specially styled and react to click events, ended with
12237 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12238 * "anchor,clicked" signal that you can attach a callback to with
12239 * evas_object_smart_callback_add(). The name of the anchor given in the
12240 * event info struct will be the one set in the href attribute, in this
12241 * case, anchorname.
12243 * Other markup can be used to style the text in different ways, but it's
12244 * up to the style defined in the theme which tags do what.
12245 * @deprecated use elm_object_text_set() instead.
12247 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12249 * Get the markup text set for the anchorview
12251 * Retrieves the text set on the anchorview, with markup tags included.
12253 * @param obj The anchorview object
12254 * @return The markup text set or @c NULL if nothing was set or an error
12256 * @deprecated use elm_object_text_set() instead.
12258 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12260 * Set the parent of the hover popup
12262 * Sets the parent object to use by the hover created by the anchorview
12263 * when an anchor is clicked. See @ref Hover for more details on this.
12264 * If no parent is set, the same anchorview object will be used.
12266 * @param obj The anchorview object
12267 * @param parent The object to use as parent for the hover
12269 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12271 * Get the parent of the hover popup
12273 * Get the object used as parent for the hover created by the anchorview
12274 * widget. See @ref Hover for more details on this.
12276 * @param obj The anchorview object
12277 * @return The object used as parent for the hover, NULL if none is set.
12279 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12281 * Set the style that the hover should use
12283 * When creating the popup hover, anchorview will request that it's
12284 * themed according to @p style.
12286 * @param obj The anchorview object
12287 * @param style The style to use for the underlying hover
12289 * @see elm_object_style_set()
12291 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12293 * Get the style that the hover should use
12295 * Get the style the hover created by anchorview will use.
12297 * @param obj The anchorview object
12298 * @return The style to use by the hover. NULL means the default is used.
12300 * @see elm_object_style_set()
12302 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12304 * Ends the hover popup in the anchorview
12306 * When an anchor is clicked, the anchorview widget will create a hover
12307 * object to use as a popup with user provided content. This function
12308 * terminates this popup, returning the anchorview to its normal state.
12310 * @param obj The anchorview object
12312 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12314 * Set bouncing behaviour when the scrolled content reaches an edge
12316 * Tell the internal scroller object whether it should bounce or not
12317 * when it reaches the respective edges for each axis.
12319 * @param obj The anchorview object
12320 * @param h_bounce Whether to bounce or not in the horizontal axis
12321 * @param v_bounce Whether to bounce or not in the vertical axis
12323 * @see elm_scroller_bounce_set()
12325 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12327 * Get the set bouncing behaviour of the internal scroller
12329 * Get whether the internal scroller should bounce when the edge of each
12330 * axis is reached scrolling.
12332 * @param obj The anchorview object
12333 * @param h_bounce Pointer where to store the bounce state of the horizontal
12335 * @param v_bounce Pointer where to store the bounce state of the vertical
12338 * @see elm_scroller_bounce_get()
12340 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12342 * Appends a custom item provider to the given anchorview
12344 * Appends the given function to the list of items providers. This list is
12345 * called, one function at a time, with the given @p data pointer, the
12346 * anchorview object and, in the @p item parameter, the item name as
12347 * referenced in its href string. Following functions in the list will be
12348 * called in order until one of them returns something different to NULL,
12349 * which should be an Evas_Object which will be used in place of the item
12352 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12353 * href=item/name\>\</item\>
12355 * @param obj The anchorview object
12356 * @param func The function to add to the list of providers
12357 * @param data User data that will be passed to the callback function
12359 * @see elm_entry_item_provider_append()
12361 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);
12363 * Prepend a custom item provider to the given anchorview
12365 * Like elm_anchorview_item_provider_append(), but it adds the function
12366 * @p func to the beginning of the list, instead of the end.
12368 * @param obj The anchorview object
12369 * @param func The function to add to the list of providers
12370 * @param data User data that will be passed to the callback function
12372 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);
12374 * Remove a custom item provider from the list of the given anchorview
12376 * Removes the function and data pairing that matches @p func and @p data.
12377 * That is, unless the same function and same user data are given, the
12378 * function will not be removed from the list. This allows us to add the
12379 * same callback several times, with different @p data pointers and be
12380 * able to remove them later without conflicts.
12382 * @param obj The anchorview object
12383 * @param func The function to remove from the list
12384 * @param data The data matching the function to remove from the list
12386 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);
12393 * @defgroup Anchorblock Anchorblock
12395 * @image html img/widget/anchorblock/preview-00.png
12396 * @image latex img/widget/anchorblock/preview-00.eps
12398 * Anchorblock is for displaying text that contains markup with anchors
12399 * like <c>\<a href=1234\>something\</\></c> in it.
12401 * Besides being styled differently, the anchorblock widget provides the
12402 * necessary functionality so that clicking on these anchors brings up a
12403 * popup with user defined content such as "call", "add to contacts" or
12404 * "open web page". This popup is provided using the @ref Hover widget.
12406 * This widget emits the following signals:
12407 * @li "anchor,clicked": will be called when an anchor is clicked. The
12408 * @p event_info parameter on the callback will be a pointer of type
12409 * ::Elm_Entry_Anchorblock_Info.
12415 * Since examples are usually better than plain words, we might as well
12416 * try @ref tutorial_anchorblock_example "one".
12419 * @addtogroup Anchorblock
12423 * @typedef Elm_Entry_Anchorblock_Info
12425 * The info sent in the callback for "anchor,clicked" signals emitted by
12426 * the Anchorblock widget.
12428 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12430 * @struct _Elm_Entry_Anchorblock_Info
12432 * The info sent in the callback for "anchor,clicked" signals emitted by
12433 * the Anchorblock widget.
12435 struct _Elm_Entry_Anchorblock_Info
12437 const char *name; /**< Name of the anchor, as indicated in its href
12439 int button; /**< The mouse button used to click on it */
12440 Evas_Object *hover; /**< The hover object to use for the popup */
12442 Evas_Coord x, y, w, h;
12443 } anchor, /**< Geometry selection of text used as anchor */
12444 hover_parent; /**< Geometry of the object used as parent by the
12446 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12447 for content on the left side of
12448 the hover. Before calling the
12449 callback, the widget will make the
12450 necessary calculations to check
12451 which sides are fit to be set with
12452 content, based on the position the
12453 hover is activated and its distance
12454 to the edges of its parent object
12456 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12457 the right side of the hover.
12458 See @ref hover_left */
12459 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12460 of the hover. See @ref hover_left */
12461 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12462 below the hover. See @ref
12466 * Add a new Anchorblock object
12468 * @param parent The parent object
12469 * @return The new object or NULL if it cannot be created
12471 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12473 * Set the text to show in the anchorblock
12475 * Sets the text of the anchorblock to @p text. This text can include markup
12476 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12477 * of text that will be specially styled and react to click events, ended
12478 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12479 * "anchor,clicked" signal that you can attach a callback to with
12480 * evas_object_smart_callback_add(). The name of the anchor given in the
12481 * event info struct will be the one set in the href attribute, in this
12482 * case, anchorname.
12484 * Other markup can be used to style the text in different ways, but it's
12485 * up to the style defined in the theme which tags do what.
12486 * @deprecated use elm_object_text_set() instead.
12488 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12490 * Get the markup text set for the anchorblock
12492 * Retrieves the text set on the anchorblock, with markup tags included.
12494 * @param obj The anchorblock object
12495 * @return The markup text set or @c NULL if nothing was set or an error
12497 * @deprecated use elm_object_text_set() instead.
12499 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12501 * Set the parent of the hover popup
12503 * Sets the parent object to use by the hover created by the anchorblock
12504 * when an anchor is clicked. See @ref Hover for more details on this.
12506 * @param obj The anchorblock object
12507 * @param parent The object to use as parent for the hover
12509 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12511 * Get the parent of the hover popup
12513 * Get the object used as parent for the hover created by the anchorblock
12514 * widget. See @ref Hover for more details on this.
12515 * If no parent is set, the same anchorblock object will be used.
12517 * @param obj The anchorblock object
12518 * @return The object used as parent for the hover, NULL if none is set.
12520 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12522 * Set the style that the hover should use
12524 * When creating the popup hover, anchorblock will request that it's
12525 * themed according to @p style.
12527 * @param obj The anchorblock object
12528 * @param style The style to use for the underlying hover
12530 * @see elm_object_style_set()
12532 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12534 * Get the style that the hover should use
12536 * Get the style, the hover created by anchorblock will use.
12538 * @param obj The anchorblock object
12539 * @return The style to use by the hover. NULL means the default is used.
12541 * @see elm_object_style_set()
12543 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12545 * Ends the hover popup in the anchorblock
12547 * When an anchor is clicked, the anchorblock widget will create a hover
12548 * object to use as a popup with user provided content. This function
12549 * terminates this popup, returning the anchorblock to its normal state.
12551 * @param obj The anchorblock object
12553 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12555 * Appends a custom item provider to the given anchorblock
12557 * Appends the given function to the list of items providers. This list is
12558 * called, one function at a time, with the given @p data pointer, the
12559 * anchorblock object and, in the @p item parameter, the item name as
12560 * referenced in its href string. Following functions in the list will be
12561 * called in order until one of them returns something different to NULL,
12562 * which should be an Evas_Object which will be used in place of the item
12565 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12566 * href=item/name\>\</item\>
12568 * @param obj The anchorblock object
12569 * @param func The function to add to the list of providers
12570 * @param data User data that will be passed to the callback function
12572 * @see elm_entry_item_provider_append()
12574 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);
12576 * Prepend a custom item provider to the given anchorblock
12578 * Like elm_anchorblock_item_provider_append(), but it adds the function
12579 * @p func to the beginning of the list, instead of the end.
12581 * @param obj The anchorblock object
12582 * @param func The function to add to the list of providers
12583 * @param data User data that will be passed to the callback function
12585 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);
12587 * Remove a custom item provider from the list of the given anchorblock
12589 * Removes the function and data pairing that matches @p func and @p data.
12590 * That is, unless the same function and same user data are given, the
12591 * function will not be removed from the list. This allows us to add the
12592 * same callback several times, with different @p data pointers and be
12593 * able to remove them later without conflicts.
12595 * @param obj The anchorblock object
12596 * @param func The function to remove from the list
12597 * @param data The data matching the function to remove from the list
12599 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);
12605 * @defgroup Bubble Bubble
12607 * @image html img/widget/bubble/preview-00.png
12608 * @image latex img/widget/bubble/preview-00.eps
12609 * @image html img/widget/bubble/preview-01.png
12610 * @image latex img/widget/bubble/preview-01.eps
12611 * @image html img/widget/bubble/preview-02.png
12612 * @image latex img/widget/bubble/preview-02.eps
12614 * @brief The Bubble is a widget to show text similar to how speech is
12615 * represented in comics.
12617 * The bubble widget contains 5 important visual elements:
12618 * @li The frame is a rectangle with rounded edjes and an "arrow".
12619 * @li The @p icon is an image to which the frame's arrow points to.
12620 * @li The @p label is a text which appears to the right of the icon if the
12621 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12623 * @li The @p info is a text which appears to the right of the label. Info's
12624 * font is of a ligther color than label.
12625 * @li The @p content is an evas object that is shown inside the frame.
12627 * The position of the arrow, icon, label and info depends on which corner is
12628 * selected. The four available corners are:
12629 * @li "top_left" - Default
12631 * @li "bottom_left"
12632 * @li "bottom_right"
12634 * Signals that you can add callbacks for are:
12635 * @li "clicked" - This is called when a user has clicked the bubble.
12637 * Default contents parts of the bubble that you can use for are:
12638 * @li "default" - A content of the bubble
12639 * @li "icon" - An icon of the bubble
12641 * Default text parts of the button widget that you can use for are:
12642 * @li NULL - Label of the bubble
12644 * For an example of using a buble see @ref bubble_01_example_page "this".
12650 * Add a new bubble to the parent
12652 * @param parent The parent object
12653 * @return The new object or NULL if it cannot be created
12655 * This function adds a text bubble to the given parent evas object.
12657 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12659 * Set the label of the bubble
12661 * @param obj The bubble object
12662 * @param label The string to set in the label
12664 * This function sets the title of the bubble. Where this appears depends on
12665 * the selected corner.
12666 * @deprecated use elm_object_text_set() instead.
12668 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12670 * Get the label of the bubble
12672 * @param obj The bubble object
12673 * @return The string of set in the label
12675 * This function gets the title of the bubble.
12676 * @deprecated use elm_object_text_get() instead.
12678 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12680 * Set the info of the bubble
12682 * @param obj The bubble object
12683 * @param info The given info about the bubble
12685 * This function sets the info of the bubble. Where this appears depends on
12686 * the selected corner.
12687 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12689 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12691 * Get the info of the bubble
12693 * @param obj The bubble object
12695 * @return The "info" string of the bubble
12697 * This function gets the info text.
12698 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12700 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12702 * Set the content to be shown in the bubble
12704 * Once the content object is set, a previously set one will be deleted.
12705 * If you want to keep the old content object, use the
12706 * elm_bubble_content_unset() function.
12708 * @param obj The bubble object
12709 * @param content The given content of the bubble
12711 * This function sets the content shown on the middle of the bubble.
12713 * @deprecated use elm_object_content_set() instead
12716 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12718 * Get the content shown in the bubble
12720 * Return the content object which is set for this widget.
12722 * @param obj The bubble object
12723 * @return The content that is being used
12725 * @deprecated use elm_object_content_get() instead
12728 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12730 * Unset the content shown in the bubble
12732 * Unparent and return the content object which was set for this widget.
12734 * @param obj The bubble object
12735 * @return The content that was being used
12737 * @deprecated use elm_object_content_unset() instead
12740 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12742 * Set the icon of the bubble
12744 * Once the icon object is set, a previously set one will be deleted.
12745 * If you want to keep the old content object, use the
12746 * elm_icon_content_unset() function.
12748 * @param obj The bubble object
12749 * @param icon The given icon for the bubble
12751 * @deprecated use elm_object_part_content_set() instead
12754 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12756 * Get the icon of the bubble
12758 * @param obj The bubble object
12759 * @return The icon for the bubble
12761 * This function gets the icon shown on the top left of bubble.
12763 * @deprecated use elm_object_part_content_get() instead
12766 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12768 * Unset the icon of the bubble
12770 * Unparent and return the icon object which was set for this widget.
12772 * @param obj The bubble object
12773 * @return The icon that was being used
12775 * @deprecated use elm_object_part_content_unset() instead
12778 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12780 * Set the corner of the bubble
12782 * @param obj The bubble object.
12783 * @param corner The given corner for the bubble.
12785 * This function sets the corner of the bubble. The corner will be used to
12786 * determine where the arrow in the frame points to and where label, icon and
12789 * Possible values for corner are:
12790 * @li "top_left" - Default
12792 * @li "bottom_left"
12793 * @li "bottom_right"
12795 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12797 * Get the corner of the bubble
12799 * @param obj The bubble object.
12800 * @return The given corner for the bubble.
12802 * This function gets the selected corner of the bubble.
12804 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12810 * @defgroup Photo Photo
12812 * For displaying the photo of a person (contact). Simple, yet
12813 * with a very specific purpose.
12815 * Signals that you can add callbacks for are:
12817 * "clicked" - This is called when a user has clicked the photo
12818 * "drag,start" - Someone started dragging the image out of the object
12819 * "drag,end" - Dragged item was dropped (somewhere)
12825 * Add a new photo to the parent
12827 * @param parent The parent object
12828 * @return The new object or NULL if it cannot be created
12832 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12835 * Set the file that will be used as photo
12837 * @param obj The photo object
12838 * @param file The path to file that will be used as photo
12840 * @return (1 = success, 0 = error)
12844 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12847 * Set the file that will be used as thumbnail in the photo.
12849 * @param obj The photo object.
12850 * @param file The path to file that will be used as thumb.
12851 * @param group The key used in case of an EET file.
12855 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12858 * Set the size that will be used on the photo
12860 * @param obj The photo object
12861 * @param size The size that the photo will be
12865 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12868 * Set if the photo should be completely visible or not.
12870 * @param obj The photo object
12871 * @param fill if true the photo will be completely visible
12875 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12878 * Set editability of the photo.
12880 * An editable photo can be dragged to or from, and can be cut or
12881 * pasted too. Note that pasting an image or dropping an item on
12882 * the image will delete the existing content.
12884 * @param obj The photo object.
12885 * @param set To set of clear editablity.
12887 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12893 /* gesture layer */
12895 * @defgroup Elm_Gesture_Layer Gesture Layer
12896 * Gesture Layer Usage:
12898 * Use Gesture Layer to detect gestures.
12899 * The advantage is that you don't have to implement
12900 * gesture detection, just set callbacks of gesture state.
12901 * By using gesture layer we make standard interface.
12903 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12904 * with a parent object parameter.
12905 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12906 * call. Usually with same object as target (2nd parameter).
12908 * Now you need to tell gesture layer what gestures you follow.
12909 * This is done with @ref elm_gesture_layer_cb_set call.
12910 * By setting the callback you actually saying to gesture layer:
12911 * I would like to know when the gesture @ref Elm_Gesture_Types
12912 * switches to state @ref Elm_Gesture_State.
12914 * Next, you need to implement the actual action that follows the input
12915 * in your callback.
12917 * Note that if you like to stop being reported about a gesture, just set
12918 * all callbacks referring this gesture to NULL.
12919 * (again with @ref elm_gesture_layer_cb_set)
12921 * The information reported by gesture layer to your callback is depending
12922 * on @ref Elm_Gesture_Types:
12923 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12924 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12925 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12927 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12928 * @ref ELM_GESTURE_MOMENTUM.
12930 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12931 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12932 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12933 * Note that we consider a flick as a line-gesture that should be completed
12934 * in flick-time-limit as defined in @ref Config.
12936 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12938 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12941 * Gesture Layer Tweaks:
12943 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12944 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12946 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12947 * so gesture starts when user touches (a *DOWN event) touch-surface
12948 * and ends when no fingers touches surface (a *UP event).
12952 * @enum _Elm_Gesture_Types
12953 * Enum of supported gesture types.
12954 * @ingroup Elm_Gesture_Layer
12956 enum _Elm_Gesture_Types
12958 ELM_GESTURE_FIRST = 0,
12960 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12961 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12962 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12963 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12965 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12967 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12968 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12970 ELM_GESTURE_ZOOM, /**< Zoom */
12971 ELM_GESTURE_ROTATE, /**< Rotate */
12977 * @typedef Elm_Gesture_Types
12978 * gesture types enum
12979 * @ingroup Elm_Gesture_Layer
12981 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12984 * @enum _Elm_Gesture_State
12985 * Enum of gesture states.
12986 * @ingroup Elm_Gesture_Layer
12988 enum _Elm_Gesture_State
12990 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12991 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12992 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12993 ELM_GESTURE_STATE_END, /**< Gesture completed */
12994 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12998 * @typedef Elm_Gesture_State
12999 * gesture states enum
13000 * @ingroup Elm_Gesture_Layer
13002 typedef enum _Elm_Gesture_State Elm_Gesture_State;
13005 * @struct _Elm_Gesture_Taps_Info
13006 * Struct holds taps info for user
13007 * @ingroup Elm_Gesture_Layer
13009 struct _Elm_Gesture_Taps_Info
13011 Evas_Coord x, y; /**< Holds center point between fingers */
13012 unsigned int n; /**< Number of fingers tapped */
13013 unsigned int timestamp; /**< event timestamp */
13017 * @typedef Elm_Gesture_Taps_Info
13018 * holds taps info for user
13019 * @ingroup Elm_Gesture_Layer
13021 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13024 * @struct _Elm_Gesture_Momentum_Info
13025 * Struct holds momentum info for user
13026 * x1 and y1 are not necessarily in sync
13027 * x1 holds x value of x direction starting point
13028 * and same holds for y1.
13029 * This is noticeable when doing V-shape movement
13030 * @ingroup Elm_Gesture_Layer
13032 struct _Elm_Gesture_Momentum_Info
13033 { /* Report line ends, timestamps, and momentum computed */
13034 Evas_Coord x1; /**< Final-swipe direction starting point on X */
13035 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13036 Evas_Coord x2; /**< Final-swipe direction ending point on X */
13037 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
13039 unsigned int tx; /**< Timestamp of start of final x-swipe */
13040 unsigned int ty; /**< Timestamp of start of final y-swipe */
13042 Evas_Coord mx; /**< Momentum on X */
13043 Evas_Coord my; /**< Momentum on Y */
13045 unsigned int n; /**< Number of fingers */
13049 * @typedef Elm_Gesture_Momentum_Info
13050 * holds momentum info for user
13051 * @ingroup Elm_Gesture_Layer
13053 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13056 * @struct _Elm_Gesture_Line_Info
13057 * Struct holds line info for user
13058 * @ingroup Elm_Gesture_Layer
13060 struct _Elm_Gesture_Line_Info
13061 { /* Report line ends, timestamps, and momentum computed */
13062 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13063 double angle; /**< Angle (direction) of lines */
13067 * @typedef Elm_Gesture_Line_Info
13068 * Holds line info for user
13069 * @ingroup Elm_Gesture_Layer
13071 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13074 * @struct _Elm_Gesture_Zoom_Info
13075 * Struct holds zoom info for user
13076 * @ingroup Elm_Gesture_Layer
13078 struct _Elm_Gesture_Zoom_Info
13080 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13081 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13082 double zoom; /**< Zoom value: 1.0 means no zoom */
13083 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13087 * @typedef Elm_Gesture_Zoom_Info
13088 * Holds zoom info for user
13089 * @ingroup Elm_Gesture_Layer
13091 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13094 * @struct _Elm_Gesture_Rotate_Info
13095 * Struct holds rotation info for user
13096 * @ingroup Elm_Gesture_Layer
13098 struct _Elm_Gesture_Rotate_Info
13100 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13101 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13102 double base_angle; /**< Holds start-angle */
13103 double angle; /**< Rotation value: 0.0 means no rotation */
13104 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13108 * @typedef Elm_Gesture_Rotate_Info
13109 * Holds rotation info for user
13110 * @ingroup Elm_Gesture_Layer
13112 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13115 * @typedef Elm_Gesture_Event_Cb
13116 * User callback used to stream gesture info from gesture layer
13117 * @param data user data
13118 * @param event_info gesture report info
13119 * Returns a flag field to be applied on the causing event.
13120 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13121 * upon the event, in an irreversible way.
13123 * @ingroup Elm_Gesture_Layer
13125 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13128 * Use function to set callbacks to be notified about
13129 * change of state of gesture.
13130 * When a user registers a callback with this function
13131 * this means this gesture has to be tested.
13133 * When ALL callbacks for a gesture are set to NULL
13134 * it means user isn't interested in gesture-state
13135 * and it will not be tested.
13137 * @param obj Pointer to gesture-layer.
13138 * @param idx The gesture you would like to track its state.
13139 * @param cb callback function pointer.
13140 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13141 * @param data user info to be sent to callback (usually, Smart Data)
13143 * @ingroup Elm_Gesture_Layer
13145 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);
13148 * Call this function to get repeat-events settings.
13150 * @param obj Pointer to gesture-layer.
13152 * @return repeat events settings.
13153 * @see elm_gesture_layer_hold_events_set()
13154 * @ingroup Elm_Gesture_Layer
13156 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13159 * This function called in order to make gesture-layer repeat events.
13160 * Set this of you like to get the raw events only if gestures were not detected.
13161 * Clear this if you like gesture layer to fwd events as testing gestures.
13163 * @param obj Pointer to gesture-layer.
13164 * @param r Repeat: TRUE/FALSE
13166 * @ingroup Elm_Gesture_Layer
13168 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13171 * This function sets step-value for zoom action.
13172 * Set step to any positive value.
13173 * Cancel step setting by setting to 0.0
13175 * @param obj Pointer to gesture-layer.
13176 * @param s new zoom step value.
13178 * @ingroup Elm_Gesture_Layer
13180 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13183 * This function sets step-value for rotate action.
13184 * Set step to any positive value.
13185 * Cancel step setting by setting to 0.0
13187 * @param obj Pointer to gesture-layer.
13188 * @param s new roatate step value.
13190 * @ingroup Elm_Gesture_Layer
13192 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13195 * This function called to attach gesture-layer to an Evas_Object.
13196 * @param obj Pointer to gesture-layer.
13197 * @param t Pointer to underlying object (AKA Target)
13199 * @return TRUE, FALSE on success, failure.
13201 * @ingroup Elm_Gesture_Layer
13203 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13206 * Call this function to construct a new gesture-layer object.
13207 * This does not activate the gesture layer. You have to
13208 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13210 * @param parent the parent object.
13212 * @return Pointer to new gesture-layer object.
13214 * @ingroup Elm_Gesture_Layer
13216 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13219 * @defgroup Thumb Thumb
13221 * @image html img/widget/thumb/preview-00.png
13222 * @image latex img/widget/thumb/preview-00.eps
13224 * A thumb object is used for displaying the thumbnail of an image or video.
13225 * You must have compiled Elementary with Ethumb_Client support and the DBus
13226 * service must be present and auto-activated in order to have thumbnails to
13229 * Once the thumbnail object becomes visible, it will check if there is a
13230 * previously generated thumbnail image for the file set on it. If not, it
13231 * will start generating this thumbnail.
13233 * Different config settings will cause different thumbnails to be generated
13234 * even on the same file.
13236 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13237 * Ethumb documentation to change this path, and to see other configuration
13240 * Signals that you can add callbacks for are:
13242 * - "clicked" - This is called when a user has clicked the thumb without dragging
13244 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13245 * - "press" - This is called when a user has pressed down the thumb.
13246 * - "generate,start" - The thumbnail generation started.
13247 * - "generate,stop" - The generation process stopped.
13248 * - "generate,error" - The generation failed.
13249 * - "load,error" - The thumbnail image loading failed.
13251 * available styles:
13255 * An example of use of thumbnail:
13257 * - @ref thumb_example_01
13261 * @addtogroup Thumb
13266 * @enum _Elm_Thumb_Animation_Setting
13267 * @typedef Elm_Thumb_Animation_Setting
13269 * Used to set if a video thumbnail is animating or not.
13273 typedef enum _Elm_Thumb_Animation_Setting
13275 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13276 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13277 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13278 ELM_THUMB_ANIMATION_LAST
13279 } Elm_Thumb_Animation_Setting;
13282 * Add a new thumb object to the parent.
13284 * @param parent The parent object.
13285 * @return The new object or NULL if it cannot be created.
13287 * @see elm_thumb_file_set()
13288 * @see elm_thumb_ethumb_client_get()
13292 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13294 * Reload thumbnail if it was generated before.
13296 * @param obj The thumb object to reload
13298 * This is useful if the ethumb client configuration changed, like its
13299 * size, aspect or any other property one set in the handle returned
13300 * by elm_thumb_ethumb_client_get().
13302 * If the options didn't change, the thumbnail won't be generated again, but
13303 * the old one will still be used.
13305 * @see elm_thumb_file_set()
13309 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13311 * Set the file that will be used as thumbnail.
13313 * @param obj The thumb object.
13314 * @param file The path to file that will be used as thumb.
13315 * @param key The key used in case of an EET file.
13317 * The file can be an image or a video (in that case, acceptable extensions are:
13318 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13319 * function elm_thumb_animate().
13321 * @see elm_thumb_file_get()
13322 * @see elm_thumb_reload()
13323 * @see elm_thumb_animate()
13327 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13329 * Get the image or video path and key used to generate the thumbnail.
13331 * @param obj The thumb object.
13332 * @param file Pointer to filename.
13333 * @param key Pointer to key.
13335 * @see elm_thumb_file_set()
13336 * @see elm_thumb_path_get()
13340 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13342 * Get the path and key to the image or video generated by ethumb.
13344 * One just need to make sure that the thumbnail was generated before getting
13345 * its path; otherwise, the path will be NULL. One way to do that is by asking
13346 * for the path when/after the "generate,stop" smart callback is called.
13348 * @param obj The thumb object.
13349 * @param file Pointer to thumb path.
13350 * @param key Pointer to thumb key.
13352 * @see elm_thumb_file_get()
13356 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13358 * Set the animation state for the thumb object. If its content is an animated
13359 * video, you may start/stop the animation or tell it to play continuously and
13362 * @param obj The thumb object.
13363 * @param setting The animation setting.
13365 * @see elm_thumb_file_set()
13369 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13371 * Get the animation state for the thumb object.
13373 * @param obj The thumb object.
13374 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13377 * @see elm_thumb_animate_set()
13381 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13383 * Get the ethumb_client handle so custom configuration can be made.
13385 * @return Ethumb_Client instance or NULL.
13387 * This must be called before the objects are created to be sure no object is
13388 * visible and no generation started.
13390 * Example of usage:
13393 * #include <Elementary.h>
13394 * #ifndef ELM_LIB_QUICKLAUNCH
13396 * elm_main(int argc, char **argv)
13398 * Ethumb_Client *client;
13400 * elm_need_ethumb();
13404 * client = elm_thumb_ethumb_client_get();
13407 * ERR("could not get ethumb_client");
13410 * ethumb_client_size_set(client, 100, 100);
13411 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13414 * // Create elm_thumb objects here
13424 * @note There's only one client handle for Ethumb, so once a configuration
13425 * change is done to it, any other request for thumbnails (for any thumbnail
13426 * object) will use that configuration. Thus, this configuration is global.
13430 EAPI void *elm_thumb_ethumb_client_get(void);
13432 * Get the ethumb_client connection state.
13434 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13437 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13439 * Make the thumbnail 'editable'.
13441 * @param obj Thumb object.
13442 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13444 * This means the thumbnail is a valid drag target for drag and drop, and can be
13445 * cut or pasted too.
13447 * @see elm_thumb_editable_get()
13451 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13453 * Make the thumbnail 'editable'.
13455 * @param obj Thumb object.
13456 * @return Editability.
13458 * This means the thumbnail is a valid drag target for drag and drop, and can be
13459 * cut or pasted too.
13461 * @see elm_thumb_editable_set()
13465 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13472 * @defgroup Web Web
13474 * @image html img/widget/web/preview-00.png
13475 * @image latex img/widget/web/preview-00.eps
13477 * A web object is used for displaying web pages (HTML/CSS/JS)
13478 * using WebKit-EFL. You must have compiled Elementary with
13481 * Signals that you can add callbacks for are:
13482 * @li "download,request": A file download has been requested. Event info is
13483 * a pointer to a Elm_Web_Download
13484 * @li "editorclient,contents,changed": Editor client's contents changed
13485 * @li "editorclient,selection,changed": Editor client's selection changed
13486 * @li "frame,created": A new frame was created. Event info is an
13487 * Evas_Object which can be handled with WebKit's ewk_frame API
13488 * @li "icon,received": An icon was received by the main frame
13489 * @li "inputmethod,changed": Input method changed. Event info is an
13490 * Eina_Bool indicating whether it's enabled or not
13491 * @li "js,windowobject,clear": JS window object has been cleared
13492 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13493 * is a char *link[2], where the first string contains the URL the link
13494 * points to, and the second one the title of the link
13495 * @li "link,hover,out": Mouse cursor left the link
13496 * @li "load,document,finished": Loading of a document finished. Event info
13497 * is the frame that finished loading
13498 * @li "load,error": Load failed. Event info is a pointer to
13499 * Elm_Web_Frame_Load_Error
13500 * @li "load,finished": Load finished. Event info is NULL on success, on
13501 * error it's a pointer to Elm_Web_Frame_Load_Error
13502 * @li "load,newwindow,show": A new window was created and is ready to be
13504 * @li "load,progress": Overall load progress. Event info is a pointer to
13505 * a double containing a value between 0.0 and 1.0
13506 * @li "load,provisional": Started provisional load
13507 * @li "load,started": Loading of a document started
13508 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13509 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13510 * the menubar is visible, or EINA_FALSE in case it's not
13511 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13512 * an Eina_Bool indicating the visibility
13513 * @li "popup,created": A dropdown widget was activated, requesting its
13514 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13515 * @li "popup,willdelete": The web object is ready to destroy the popup
13516 * object created. Event info is a pointer to Elm_Web_Menu
13517 * @li "ready": Page is fully loaded
13518 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13519 * info is a pointer to Eina_Bool where the visibility state should be set
13520 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13521 * is an Eina_Bool with the visibility state set
13522 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13523 * a string with the new text
13524 * @li "statusbar,visible,get": Queries visibility of the status bar.
13525 * Event info is a pointer to Eina_Bool where the visibility state should be
13527 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13528 * an Eina_Bool with the visibility value
13529 * @li "title,changed": Title of the main frame changed. Event info is a
13530 * string with the new title
13531 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13532 * is a pointer to Eina_Bool where the visibility state should be set
13533 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13534 * info is an Eina_Bool with the visibility state
13535 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13536 * a string with the text to show
13537 * @li "uri,changed": URI of the main frame changed. Event info is a string
13539 * @li "view,resized": The web object internal's view changed sized
13540 * @li "windows,close,request": A JavaScript request to close the current
13541 * window was requested
13542 * @li "zoom,animated,end": Animated zoom finished
13544 * available styles:
13547 * An example of use of web:
13549 * - @ref web_example_01 TBD
13558 * Structure used to report load errors.
13560 * Load errors are reported as signal by elm_web. All the strings are
13561 * temporary references and should @b not be used after the signal
13562 * callback returns. If it's required, make copies with strdup() or
13563 * eina_stringshare_add() (they are not even guaranteed to be
13564 * stringshared, so must use eina_stringshare_add() and not
13565 * eina_stringshare_ref()).
13567 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13569 * Structure used to report load errors.
13571 * Load errors are reported as signal by elm_web. All the strings are
13572 * temporary references and should @b not be used after the signal
13573 * callback returns. If it's required, make copies with strdup() or
13574 * eina_stringshare_add() (they are not even guaranteed to be
13575 * stringshared, so must use eina_stringshare_add() and not
13576 * eina_stringshare_ref()).
13578 struct _Elm_Web_Frame_Load_Error
13580 int code; /**< Numeric error code */
13581 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13582 const char *domain; /**< Error domain name */
13583 const char *description; /**< Error description (already localized) */
13584 const char *failing_url; /**< The URL that failed to load */
13585 Evas_Object *frame; /**< Frame object that produced the error */
13589 * The possibles types that the items in a menu can be
13591 typedef enum _Elm_Web_Menu_Item_Type
13593 ELM_WEB_MENU_SEPARATOR,
13594 ELM_WEB_MENU_GROUP,
13595 ELM_WEB_MENU_OPTION
13596 } Elm_Web_Menu_Item_Type;
13599 * Structure describing the items in a menu
13601 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13603 * Structure describing the items in a menu
13605 struct _Elm_Web_Menu_Item
13607 const char *text; /**< The text for the item */
13608 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13612 * Structure describing the menu of a popup
13614 * This structure will be passed as the @c event_info for the "popup,create"
13615 * signal, which is emitted when a dropdown menu is opened. Users wanting
13616 * to handle these popups by themselves should listen to this signal and
13617 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13618 * property as @c EINA_FALSE means that the user will not handle the popup
13619 * and the default implementation will be used.
13621 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13622 * will be emitted to notify the user that it can destroy any objects and
13623 * free all data related to it.
13625 * @see elm_web_popup_selected_set()
13626 * @see elm_web_popup_destroy()
13628 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13630 * Structure describing the menu of a popup
13632 * This structure will be passed as the @c event_info for the "popup,create"
13633 * signal, which is emitted when a dropdown menu is opened. Users wanting
13634 * to handle these popups by themselves should listen to this signal and
13635 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13636 * property as @c EINA_FALSE means that the user will not handle the popup
13637 * and the default implementation will be used.
13639 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13640 * will be emitted to notify the user that it can destroy any objects and
13641 * free all data related to it.
13643 * @see elm_web_popup_selected_set()
13644 * @see elm_web_popup_destroy()
13646 struct _Elm_Web_Menu
13648 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13649 int x; /**< The X position of the popup, relative to the elm_web object */
13650 int y; /**< The Y position of the popup, relative to the elm_web object */
13651 int width; /**< Width of the popup menu */
13652 int height; /**< Height of the popup menu */
13654 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. */
13657 typedef struct _Elm_Web_Download Elm_Web_Download;
13658 struct _Elm_Web_Download
13664 * Types of zoom available.
13666 typedef enum _Elm_Web_Zoom_Mode
13668 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13669 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13670 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13671 ELM_WEB_ZOOM_MODE_LAST
13672 } Elm_Web_Zoom_Mode;
13674 * Opaque handler containing the features (such as statusbar, menubar, etc)
13675 * that are to be set on a newly requested window.
13677 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13679 * Callback type for the create_window hook.
13681 * The function parameters are:
13682 * @li @p data User data pointer set when setting the hook function
13683 * @li @p obj The elm_web object requesting the new window
13684 * @li @p js Set to @c EINA_TRUE if the request was originated from
13685 * JavaScript. @c EINA_FALSE otherwise.
13686 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13687 * the features requested for the new window.
13689 * The returned value of the function should be the @c elm_web widget where
13690 * the request will be loaded. That is, if a new window or tab is created,
13691 * the elm_web widget in it should be returned, and @b NOT the window
13693 * Returning @c NULL should cancel the request.
13695 * @see elm_web_window_create_hook_set()
13697 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13699 * Callback type for the JS alert hook.
13701 * The function parameters are:
13702 * @li @p data User data pointer set when setting the hook function
13703 * @li @p obj The elm_web object requesting the new window
13704 * @li @p message The message to show in the alert dialog
13706 * The function should return the object representing the alert dialog.
13707 * Elm_Web will run a second main loop to handle the dialog and normal
13708 * flow of the application will be restored when the object is deleted, so
13709 * the user should handle the popup properly in order to delete the object
13710 * when the action is finished.
13711 * If the function returns @c NULL the popup will be ignored.
13713 * @see elm_web_dialog_alert_hook_set()
13715 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13717 * Callback type for the JS confirm hook.
13719 * The function parameters are:
13720 * @li @p data User data pointer set when setting the hook function
13721 * @li @p obj The elm_web object requesting the new window
13722 * @li @p message The message to show in the confirm dialog
13723 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13724 * the user selected @c Ok, @c EINA_FALSE otherwise.
13726 * The function should return the object representing the confirm dialog.
13727 * Elm_Web will run a second main loop to handle the dialog and normal
13728 * flow of the application will be restored when the object is deleted, so
13729 * the user should handle the popup properly in order to delete the object
13730 * when the action is finished.
13731 * If the function returns @c NULL the popup will be ignored.
13733 * @see elm_web_dialog_confirm_hook_set()
13735 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13737 * Callback type for the JS prompt hook.
13739 * The function parameters are:
13740 * @li @p data User data pointer set when setting the hook function
13741 * @li @p obj The elm_web object requesting the new window
13742 * @li @p message The message to show in the prompt dialog
13743 * @li @p def_value The default value to present the user in the entry
13744 * @li @p value Pointer where to store the value given by the user. Must
13745 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13746 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13747 * the user selected @c Ok, @c EINA_FALSE otherwise.
13749 * The function should return the object representing the prompt dialog.
13750 * Elm_Web will run a second main loop to handle the dialog and normal
13751 * flow of the application will be restored when the object is deleted, so
13752 * the user should handle the popup properly in order to delete the object
13753 * when the action is finished.
13754 * If the function returns @c NULL the popup will be ignored.
13756 * @see elm_web_dialog_prompt_hook_set()
13758 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13760 * Callback type for the JS file selector hook.
13762 * The function parameters are:
13763 * @li @p data User data pointer set when setting the hook function
13764 * @li @p obj The elm_web object requesting the new window
13765 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13766 * @li @p accept_types Mime types accepted
13767 * @li @p selected Pointer where to store the list of malloc'ed strings
13768 * containing the path to each file selected. Must be @c NULL if the file
13769 * dialog is cancelled
13770 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13771 * the user selected @c Ok, @c EINA_FALSE otherwise.
13773 * The function should return the object representing the file selector
13775 * Elm_Web will run a second main loop to handle the dialog and normal
13776 * flow of the application will be restored when the object is deleted, so
13777 * the user should handle the popup properly in order to delete the object
13778 * when the action is finished.
13779 * If the function returns @c NULL the popup will be ignored.
13781 * @see elm_web_dialog_file selector_hook_set()
13783 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);
13785 * Callback type for the JS console message hook.
13787 * When a console message is added from JavaScript, any set function to the
13788 * console message hook will be called for the user to handle. There is no
13789 * default implementation of this hook.
13791 * The function parameters are:
13792 * @li @p data User data pointer set when setting the hook function
13793 * @li @p obj The elm_web object that originated the message
13794 * @li @p message The message sent
13795 * @li @p line_number The line number
13796 * @li @p source_id Source id
13798 * @see elm_web_console_message_hook_set()
13800 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13802 * Add a new web object to the parent.
13804 * @param parent The parent object.
13805 * @return The new object or NULL if it cannot be created.
13807 * @see elm_web_uri_set()
13808 * @see elm_web_webkit_view_get()
13810 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13813 * Get internal ewk_view object from web object.
13815 * Elementary may not provide some low level features of EWebKit,
13816 * instead of cluttering the API with proxy methods we opted to
13817 * return the internal reference. Be careful using it as it may
13818 * interfere with elm_web behavior.
13820 * @param obj The web object.
13821 * @return The internal ewk_view object or NULL if it does not
13822 * exist. (Failure to create or Elementary compiled without
13825 * @see elm_web_add()
13827 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13830 * Sets the function to call when a new window is requested
13832 * This hook will be called when a request to create a new window is
13833 * issued from the web page loaded.
13834 * There is no default implementation for this feature, so leaving this
13835 * unset or passing @c NULL in @p func will prevent new windows from
13838 * @param obj The web object where to set the hook function
13839 * @param func The hook function to be called when a window is requested
13840 * @param data User data
13842 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13844 * Sets the function to call when an alert dialog
13846 * This hook will be called when a JavaScript alert dialog is requested.
13847 * If no function is set or @c NULL is passed in @p func, the default
13848 * implementation will take place.
13850 * @param obj The web object where to set the hook function
13851 * @param func The callback function to be used
13852 * @param data User data
13854 * @see elm_web_inwin_mode_set()
13856 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13858 * Sets the function to call when an confirm dialog
13860 * This hook will be called when a JavaScript confirm dialog is requested.
13861 * If no function is set or @c NULL is passed in @p func, the default
13862 * implementation will take place.
13864 * @param obj The web object where to set the hook function
13865 * @param func The callback function to be used
13866 * @param data User data
13868 * @see elm_web_inwin_mode_set()
13870 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13872 * Sets the function to call when an prompt dialog
13874 * This hook will be called when a JavaScript prompt dialog is requested.
13875 * If no function is set or @c NULL is passed in @p func, the default
13876 * implementation will take place.
13878 * @param obj The web object where to set the hook function
13879 * @param func The callback function to be used
13880 * @param data User data
13882 * @see elm_web_inwin_mode_set()
13884 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13886 * Sets the function to call when an file selector dialog
13888 * This hook will be called when a JavaScript file selector dialog is
13890 * If no function is set or @c NULL is passed in @p func, the default
13891 * implementation will take place.
13893 * @param obj The web object where to set the hook function
13894 * @param func The callback function to be used
13895 * @param data User data
13897 * @see elm_web_inwin_mode_set()
13899 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13901 * Sets the function to call when a console message is emitted from JS
13903 * This hook will be called when a console message is emitted from
13904 * JavaScript. There is no default implementation for this feature.
13906 * @param obj The web object where to set the hook function
13907 * @param func The callback function to be used
13908 * @param data User data
13910 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13912 * Gets the status of the tab propagation
13914 * @param obj The web object to query
13915 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13917 * @see elm_web_tab_propagate_set()
13919 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13921 * Sets whether to use tab propagation
13923 * If tab propagation is enabled, whenever the user presses the Tab key,
13924 * Elementary will handle it and switch focus to the next widget.
13925 * The default value is disabled, where WebKit will handle the Tab key to
13926 * cycle focus though its internal objects, jumping to the next widget
13927 * only when that cycle ends.
13929 * @param obj The web object
13930 * @param propagate Whether to propagate Tab keys to Elementary or not
13932 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13934 * Sets the URI for the web object
13936 * It must be a full URI, with resource included, in the form
13937 * http://www.enlightenment.org or file:///tmp/something.html
13939 * @param obj The web object
13940 * @param uri The URI to set
13941 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13943 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13945 * Gets the current URI for the object
13947 * The returned string must not be freed and is guaranteed to be
13950 * @param obj The web object
13951 * @return A stringshared internal string with the current URI, or NULL on
13954 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13956 * Gets the current title
13958 * The returned string must not be freed and is guaranteed to be
13961 * @param obj The web object
13962 * @return A stringshared internal string with the current title, or NULL on
13965 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13967 * Sets the background color to be used by the web object
13969 * This is the color that will be used by default when the loaded page
13970 * does not set it's own. Color values are pre-multiplied.
13972 * @param obj The web object
13973 * @param r Red component
13974 * @param g Green component
13975 * @param b Blue component
13976 * @param a Alpha component
13978 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13980 * Gets the background color to be used by the web object
13982 * This is the color that will be used by default when the loaded page
13983 * does not set it's own. Color values are pre-multiplied.
13985 * @param obj The web object
13986 * @param r Red component
13987 * @param g Green component
13988 * @param b Blue component
13989 * @param a Alpha component
13991 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13993 * Gets a copy of the currently selected text
13995 * The string returned must be freed by the user when it's done with it.
13997 * @param obj The web object
13998 * @return A newly allocated string, or NULL if nothing is selected or an
14001 EAPI char *elm_view_selection_get(const Evas_Object *obj);
14003 * Tells the web object which index in the currently open popup was selected
14005 * When the user handles the popup creation from the "popup,created" signal,
14006 * it needs to tell the web object which item was selected by calling this
14007 * function with the index corresponding to the item.
14009 * @param obj The web object
14010 * @param index The index selected
14012 * @see elm_web_popup_destroy()
14014 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
14016 * Dismisses an open dropdown popup
14018 * When the popup from a dropdown widget is to be dismissed, either after
14019 * selecting an option or to cancel it, this function must be called, which
14020 * will later emit an "popup,willdelete" signal to notify the user that
14021 * any memory and objects related to this popup can be freed.
14023 * @param obj The web object
14024 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14025 * if there was no menu to destroy
14027 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
14029 * Searches the given string in a document.
14031 * @param obj The web object where to search the text
14032 * @param string String to search
14033 * @param case_sensitive If search should be case sensitive or not
14034 * @param forward If search is from cursor and on or backwards
14035 * @param wrap If search should wrap at the end
14037 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14040 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14042 * Marks matches of the given string in a document.
14044 * @param obj The web object where to search text
14045 * @param string String to match
14046 * @param case_sensitive If match should be case sensitive or not
14047 * @param highlight If matches should be highlighted
14048 * @param limit Maximum amount of matches, or zero to unlimited
14050 * @return number of matched @a string
14052 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14054 * Clears all marked matches in the document
14056 * @param obj The web object
14058 * @return EINA_TRUE on success, EINA_FALSE otherwise
14060 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
14062 * Sets whether to highlight the matched marks
14064 * If enabled, marks set with elm_web_text_matches_mark() will be
14067 * @param obj The web object
14068 * @param highlight Whether to highlight the marks or not
14070 * @return EINA_TRUE on success, EINA_FALSE otherwise
14072 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14074 * Gets whether highlighting marks is enabled
14076 * @param The web object
14078 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14081 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
14083 * Gets the overall loading progress of the page
14085 * Returns the estimated loading progress of the page, with a value between
14086 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14087 * included in the page.
14089 * @param The web object
14091 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14094 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
14096 * Stops loading the current page
14098 * Cancels the loading of the current page in the web object. This will
14099 * cause a "load,error" signal to be emitted, with the is_cancellation
14100 * flag set to EINA_TRUE.
14102 * @param obj The web object
14104 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14106 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14108 * Requests a reload of the current document in the object
14110 * @param obj The web object
14112 * @return EINA_TRUE on success, EINA_FALSE otherwise
14114 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14116 * Requests a reload of the current document, avoiding any existing caches
14118 * @param obj The web object
14120 * @return EINA_TRUE on success, EINA_FALSE otherwise
14122 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14124 * Goes back one step in the browsing history
14126 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14128 * @param obj The web object
14130 * @return EINA_TRUE on success, EINA_FALSE otherwise
14132 * @see elm_web_history_enable_set()
14133 * @see elm_web_back_possible()
14134 * @see elm_web_forward()
14135 * @see elm_web_navigate()
14137 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14139 * Goes forward one step in the browsing history
14141 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14143 * @param obj The web object
14145 * @return EINA_TRUE on success, EINA_FALSE otherwise
14147 * @see elm_web_history_enable_set()
14148 * @see elm_web_forward_possible()
14149 * @see elm_web_back()
14150 * @see elm_web_navigate()
14152 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14154 * Jumps the given number of steps in the browsing history
14156 * The @p steps value can be a negative integer to back in history, or a
14157 * positive to move forward.
14159 * @param obj The web object
14160 * @param steps The number of steps to jump
14162 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14163 * history exists to jump the given number of steps
14165 * @see elm_web_history_enable_set()
14166 * @see elm_web_navigate_possible()
14167 * @see elm_web_back()
14168 * @see elm_web_forward()
14170 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14172 * Queries whether it's possible to go back in history
14174 * @param obj The web object
14176 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14179 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14181 * Queries whether it's possible to go forward in history
14183 * @param obj The web object
14185 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14188 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14190 * Queries whether it's possible to jump the given number of steps
14192 * The @p steps value can be a negative integer to back in history, or a
14193 * positive to move forward.
14195 * @param obj The web object
14196 * @param steps The number of steps to check for
14198 * @return EINA_TRUE if enough history exists to perform the given jump,
14199 * EINA_FALSE otherwise
14201 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14203 * Gets whether browsing history is enabled for the given object
14205 * @param obj The web object
14207 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14209 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14211 * Enables or disables the browsing history
14213 * @param obj The web object
14214 * @param enable Whether to enable or disable the browsing history
14216 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14218 * Sets the zoom level of the web object
14220 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14221 * values meaning zoom in and lower meaning zoom out. This function will
14222 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14223 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14225 * @param obj The web object
14226 * @param zoom The zoom level to set
14228 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14230 * Gets the current zoom level set on the web object
14232 * Note that this is the zoom level set on the web object and not that
14233 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14234 * the two zoom levels should match, but for the other two modes the
14235 * Webkit zoom is calculated internally to match the chosen mode without
14236 * changing the zoom level set for the web object.
14238 * @param obj The web object
14240 * @return The zoom level set on the object
14242 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14244 * Sets the zoom mode to use
14246 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14247 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14249 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14250 * with the elm_web_zoom_set() function.
14251 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14252 * make sure the entirety of the web object's contents are shown.
14253 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14254 * fit the contents in the web object's size, without leaving any space
14257 * @param obj The web object
14258 * @param mode The mode to set
14260 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14262 * Gets the currently set zoom mode
14264 * @param obj The web object
14266 * @return The current zoom mode set for the object, or
14267 * ::ELM_WEB_ZOOM_MODE_LAST on error
14269 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14271 * Shows the given region in the web object
14273 * @param obj The web object
14274 * @param x The x coordinate of the region to show
14275 * @param y The y coordinate of the region to show
14276 * @param w The width of the region to show
14277 * @param h The height of the region to show
14279 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14281 * Brings in the region to the visible area
14283 * Like elm_web_region_show(), but it animates the scrolling of the object
14286 * @param obj The web object
14287 * @param x The x coordinate of the region to show
14288 * @param y The y coordinate of the region to show
14289 * @param w The width of the region to show
14290 * @param h The height of the region to show
14292 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14294 * Sets the default dialogs to use an Inwin instead of a normal window
14296 * If set, then the default implementation for the JavaScript dialogs and
14297 * file selector will be opened in an Inwin. Otherwise they will use a
14298 * normal separated window.
14300 * @param obj The web object
14301 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14303 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14305 * Gets whether Inwin mode is set for the current object
14307 * @param obj The web object
14309 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14311 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14313 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14314 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14315 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);
14316 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14323 * @defgroup Hoversel Hoversel
14325 * @image html img/widget/hoversel/preview-00.png
14326 * @image latex img/widget/hoversel/preview-00.eps
14328 * A hoversel is a button that pops up a list of items (automatically
14329 * choosing the direction to display) that have a label and, optionally, an
14330 * icon to select from. It is a convenience widget to avoid the need to do
14331 * all the piecing together yourself. It is intended for a small number of
14332 * items in the hoversel menu (no more than 8), though is capable of many
14335 * Signals that you can add callbacks for are:
14336 * "clicked" - the user clicked the hoversel button and popped up the sel
14337 * "selected" - an item in the hoversel list is selected. event_info is the item
14338 * "dismissed" - the hover is dismissed
14340 * See @ref tutorial_hoversel for an example.
14343 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14345 * @brief Add a new Hoversel object
14347 * @param parent The parent object
14348 * @return The new object or NULL if it cannot be created
14350 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14352 * @brief This sets the hoversel to expand horizontally.
14354 * @param obj The hoversel object
14355 * @param horizontal If true, the hover will expand horizontally to the
14358 * @note The initial button will display horizontally regardless of this
14361 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14363 * @brief This returns whether the hoversel is set to expand horizontally.
14365 * @param obj The hoversel object
14366 * @return If true, the hover will expand horizontally to the right.
14368 * @see elm_hoversel_horizontal_set()
14370 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14372 * @brief Set the Hover parent
14374 * @param obj The hoversel object
14375 * @param parent The parent to use
14377 * Sets the hover parent object, the area that will be darkened when the
14378 * hoversel is clicked. Should probably be the window that the hoversel is
14379 * in. See @ref Hover objects for more information.
14381 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14383 * @brief Get the Hover parent
14385 * @param obj The hoversel object
14386 * @return The used parent
14388 * Gets the hover parent object.
14390 * @see elm_hoversel_hover_parent_set()
14392 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14394 * @brief Set the hoversel button label
14396 * @param obj The hoversel object
14397 * @param label The label text.
14399 * This sets the label of the button that is always visible (before it is
14400 * clicked and expanded).
14402 * @deprecated elm_object_text_set()
14404 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14406 * @brief Get the hoversel button label
14408 * @param obj The hoversel object
14409 * @return The label text.
14411 * @deprecated elm_object_text_get()
14413 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14415 * @brief Set the icon of the hoversel button
14417 * @param obj The hoversel object
14418 * @param icon The icon object
14420 * Sets the icon of the button that is always visible (before it is clicked
14421 * and expanded). Once the icon object is set, a previously set one will be
14422 * deleted, if you want to keep that old content object, use the
14423 * elm_hoversel_icon_unset() function.
14425 * @see elm_object_content_set() for the button widget
14427 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14429 * @brief Get the icon of the hoversel button
14431 * @param obj The hoversel object
14432 * @return The icon object
14434 * Get the icon of the button that is always visible (before it is clicked
14435 * and expanded). Also see elm_object_content_get() for the button widget.
14437 * @see elm_hoversel_icon_set()
14439 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14441 * @brief Get and unparent the icon of the hoversel button
14443 * @param obj The hoversel object
14444 * @return The icon object that was being used
14446 * Unparent and return the icon of the button that is always visible
14447 * (before it is clicked and expanded).
14449 * @see elm_hoversel_icon_set()
14450 * @see elm_object_content_unset() for the button widget
14452 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14454 * @brief This triggers the hoversel popup from code, the same as if the user
14455 * had clicked the button.
14457 * @param obj The hoversel object
14459 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14461 * @brief This dismisses the hoversel popup as if the user had clicked
14462 * outside the hover.
14464 * @param obj The hoversel object
14466 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14468 * @brief Returns whether the hoversel is expanded.
14470 * @param obj The hoversel object
14471 * @return This will return EINA_TRUE if the hoversel is expanded or
14472 * EINA_FALSE if it is not expanded.
14474 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14476 * @brief This will remove all the children items from the hoversel.
14478 * @param obj The hoversel object
14480 * @warning Should @b not be called while the hoversel is active; use
14481 * elm_hoversel_expanded_get() to check first.
14483 * @see elm_hoversel_item_del_cb_set()
14484 * @see elm_hoversel_item_del()
14486 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14488 * @brief Get the list of items within the given hoversel.
14490 * @param obj The hoversel object
14491 * @return Returns a list of Elm_Hoversel_Item*
14493 * @see elm_hoversel_item_add()
14495 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14497 * @brief Add an item to the hoversel button
14499 * @param obj The hoversel object
14500 * @param label The text label to use for the item (NULL if not desired)
14501 * @param icon_file An image file path on disk to use for the icon or standard
14502 * icon name (NULL if not desired)
14503 * @param icon_type The icon type if relevant
14504 * @param func Convenience function to call when this item is selected
14505 * @param data Data to pass to item-related functions
14506 * @return A handle to the item added.
14508 * This adds an item to the hoversel to show when it is clicked. Note: if you
14509 * need to use an icon from an edje file then use
14510 * elm_hoversel_item_icon_set() right after the this function, and set
14511 * icon_file to NULL here.
14513 * For more information on what @p icon_file and @p icon_type are see the
14514 * @ref Icon "icon documentation".
14516 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);
14518 * @brief Delete an item from the hoversel
14520 * @param item The item to delete
14522 * This deletes the item from the hoversel (should not be called while the
14523 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14525 * @see elm_hoversel_item_add()
14526 * @see elm_hoversel_item_del_cb_set()
14528 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14530 * @brief Set the function to be called when an item from the hoversel is
14533 * @param item The item to set the callback on
14534 * @param func The function called
14536 * That function will receive these parameters:
14537 * @li void *item_data
14538 * @li Evas_Object *the_item_object
14539 * @li Elm_Hoversel_Item *the_object_struct
14541 * @see elm_hoversel_item_add()
14543 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14545 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14546 * that will be passed to associated function callbacks.
14548 * @param item The item to get the data from
14549 * @return The data pointer set with elm_hoversel_item_add()
14551 * @see elm_hoversel_item_add()
14553 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14555 * @brief This returns the label text of the given hoversel item.
14557 * @param item The item to get the label
14558 * @return The label text of the hoversel item
14560 * @see elm_hoversel_item_add()
14562 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14564 * @brief This sets the icon for the given hoversel item.
14566 * @param item The item to set the icon
14567 * @param icon_file An image file path on disk to use for the icon or standard
14569 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14570 * to NULL if the icon is not an edje file
14571 * @param icon_type The icon type
14573 * The icon can be loaded from the standard set, from an image file, or from
14576 * @see elm_hoversel_item_add()
14578 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);
14580 * @brief Get the icon object of the hoversel item
14582 * @param item The item to get the icon from
14583 * @param icon_file The image file path on disk used for the icon or standard
14585 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14586 * if the icon is not an edje file
14587 * @param icon_type The icon type
14589 * @see elm_hoversel_item_icon_set()
14590 * @see elm_hoversel_item_add()
14592 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);
14598 * @defgroup Toolbar Toolbar
14599 * @ingroup Elementary
14601 * @image html img/widget/toolbar/preview-00.png
14602 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14604 * @image html img/toolbar.png
14605 * @image latex img/toolbar.eps width=\textwidth
14607 * A toolbar is a widget that displays a list of items inside
14608 * a box. It can be scrollable, show a menu with items that don't fit
14609 * to toolbar size or even crop them.
14611 * Only one item can be selected at a time.
14613 * Items can have multiple states, or show menus when selected by the user.
14615 * Smart callbacks one can listen to:
14616 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14617 * - "language,changed" - when the program language changes
14619 * Available styles for it:
14621 * - @c "transparent" - no background or shadow, just show the content
14623 * List of examples:
14624 * @li @ref toolbar_example_01
14625 * @li @ref toolbar_example_02
14626 * @li @ref toolbar_example_03
14630 * @addtogroup Toolbar
14635 * @enum _Elm_Toolbar_Shrink_Mode
14636 * @typedef Elm_Toolbar_Shrink_Mode
14638 * Set toolbar's items display behavior, it can be scrollabel,
14639 * show a menu with exceeding items, or simply hide them.
14641 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14644 * Values <b> don't </b> work as bitmask, only one can be choosen.
14646 * @see elm_toolbar_mode_shrink_set()
14647 * @see elm_toolbar_mode_shrink_get()
14651 typedef enum _Elm_Toolbar_Shrink_Mode
14653 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14654 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14655 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14656 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14657 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14658 } Elm_Toolbar_Shrink_Mode;
14660 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(). */
14663 * Add a new toolbar widget to the given parent Elementary
14664 * (container) object.
14666 * @param parent The parent object.
14667 * @return a new toolbar widget handle or @c NULL, on errors.
14669 * This function inserts a new toolbar widget on the canvas.
14673 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14675 * Set the icon size, in pixels, to be used by toolbar items.
14677 * @param obj The toolbar object
14678 * @param icon_size The icon size in pixels
14680 * @note Default value is @c 32. It reads value from elm config.
14682 * @see elm_toolbar_icon_size_get()
14686 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14688 * Get the icon size, in pixels, to be used by toolbar items.
14690 * @param obj The toolbar object.
14691 * @return The icon size in pixels.
14693 * @see elm_toolbar_icon_size_set() for details.
14697 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14699 * Sets icon lookup order, for toolbar items' icons.
14701 * @param obj The toolbar object.
14702 * @param order The icon lookup order.
14704 * Icons added before calling this function will not be affected.
14705 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14707 * @see elm_toolbar_icon_order_lookup_get()
14711 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14713 * Gets the icon lookup order.
14715 * @param obj The toolbar object.
14716 * @return The icon lookup order.
14718 * @see elm_toolbar_icon_order_lookup_set() for details.
14722 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14724 * Set whether the toolbar should always have an item selected.
14726 * @param obj The toolbar object.
14727 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14730 * This will cause the toolbar to always have an item selected, and clicking
14731 * the selected item will not cause a selected event to be emitted. Enabling this mode
14732 * will immediately select the first toolbar item.
14734 * Always-selected is disabled by default.
14736 * @see elm_toolbar_always_select_mode_get().
14740 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14742 * Get whether the toolbar should always have an item selected.
14744 * @param obj The toolbar object.
14745 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14746 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14748 * @see elm_toolbar_always_select_mode_set() for details.
14752 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14754 * Set whether the toolbar items' should be selected by the user or not.
14756 * @param obj The toolbar object.
14757 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14760 * This will turn off the ability to select items entirely and they will
14761 * neither appear selected nor emit selected signals. The clicked
14762 * callback function will still be called.
14764 * Selection is enabled by default.
14766 * @see elm_toolbar_no_select_mode_get().
14770 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14773 * Set whether the toolbar items' should be selected by the user or not.
14775 * @param obj The toolbar object.
14776 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14777 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14779 * @see elm_toolbar_no_select_mode_set() for details.
14783 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14785 * Append item to the toolbar.
14787 * @param obj The toolbar object.
14788 * @param icon A string with icon name or the absolute path of an image file.
14789 * @param label The label of the item.
14790 * @param func The function to call when the item is clicked.
14791 * @param data The data to associate with the item for related callbacks.
14792 * @return The created item or @c NULL upon failure.
14794 * A new item will be created and appended to the toolbar, i.e., will
14795 * be set as @b last item.
14797 * Items created with this method can be deleted with
14798 * elm_toolbar_item_del().
14800 * Associated @p data can be properly freed when item is deleted if a
14801 * callback function is set with elm_toolbar_item_del_cb_set().
14803 * If a function is passed as argument, it will be called everytime this item
14804 * is selected, i.e., the user clicks over an unselected item.
14805 * If such function isn't needed, just passing
14806 * @c NULL as @p func is enough. The same should be done for @p data.
14808 * Toolbar will load icon image from fdo or current theme.
14809 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14810 * If an absolute path is provided it will load it direct from a file.
14812 * @see elm_toolbar_item_icon_set()
14813 * @see elm_toolbar_item_del()
14814 * @see elm_toolbar_item_del_cb_set()
14818 EAPI Elm_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);
14820 * Prepend item to the toolbar.
14822 * @param obj The toolbar object.
14823 * @param icon A string with icon name or the absolute path of an image file.
14824 * @param label The label of the item.
14825 * @param func The function to call when the item is clicked.
14826 * @param data The data to associate with the item for related callbacks.
14827 * @return The created item or @c NULL upon failure.
14829 * A new item will be created and prepended to the toolbar, i.e., will
14830 * be set as @b first item.
14832 * Items created with this method can be deleted with
14833 * elm_toolbar_item_del().
14835 * Associated @p data can be properly freed when item is deleted if a
14836 * callback function is set with elm_toolbar_item_del_cb_set().
14838 * If a function is passed as argument, it will be called everytime this item
14839 * is selected, i.e., the user clicks over an unselected item.
14840 * If such function isn't needed, just passing
14841 * @c NULL as @p func is enough. The same should be done for @p data.
14843 * Toolbar will load icon image from fdo or current theme.
14844 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14845 * If an absolute path is provided it will load it direct from a file.
14847 * @see elm_toolbar_item_icon_set()
14848 * @see elm_toolbar_item_del()
14849 * @see elm_toolbar_item_del_cb_set()
14853 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);
14855 * Insert a new item into the toolbar object before item @p before.
14857 * @param obj The toolbar object.
14858 * @param before The toolbar item to insert before.
14859 * @param icon A string with icon name or the absolute path of an image file.
14860 * @param label The label of the item.
14861 * @param func The function to call when the item is clicked.
14862 * @param data The data to associate with the item for related callbacks.
14863 * @return The created item or @c NULL upon failure.
14865 * A new item will be created and added to the toolbar. Its position in
14866 * this toolbar will be just before item @p before.
14868 * Items created with this method can be deleted with
14869 * elm_toolbar_item_del().
14871 * Associated @p data can be properly freed when item is deleted if a
14872 * callback function is set with elm_toolbar_item_del_cb_set().
14874 * If a function is passed as argument, it will be called everytime this item
14875 * is selected, i.e., the user clicks over an unselected item.
14876 * If such function isn't needed, just passing
14877 * @c NULL as @p func is enough. The same should be done for @p data.
14879 * Toolbar will load icon image from fdo or current theme.
14880 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14881 * If an absolute path is provided it will load it direct from a file.
14883 * @see elm_toolbar_item_icon_set()
14884 * @see elm_toolbar_item_del()
14885 * @see elm_toolbar_item_del_cb_set()
14889 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);
14892 * Insert a new item into the toolbar object after item @p after.
14894 * @param obj The toolbar object.
14895 * @param after The toolbar item to insert after.
14896 * @param icon A string with icon name or the absolute path of an image file.
14897 * @param label The label of the item.
14898 * @param func The function to call when the item is clicked.
14899 * @param data The data to associate with the item for related callbacks.
14900 * @return The created item or @c NULL upon failure.
14902 * A new item will be created and added to the toolbar. Its position in
14903 * this toolbar will be just after item @p after.
14905 * Items created with this method can be deleted with
14906 * elm_toolbar_item_del().
14908 * Associated @p data can be properly freed when item is deleted if a
14909 * callback function is set with elm_toolbar_item_del_cb_set().
14911 * If a function is passed as argument, it will be called everytime this item
14912 * is selected, i.e., the user clicks over an unselected item.
14913 * If such function isn't needed, just passing
14914 * @c NULL as @p func is enough. The same should be done for @p data.
14916 * Toolbar will load icon image from fdo or current theme.
14917 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14918 * If an absolute path is provided it will load it direct from a file.
14920 * @see elm_toolbar_item_icon_set()
14921 * @see elm_toolbar_item_del()
14922 * @see elm_toolbar_item_del_cb_set()
14926 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);
14928 * Get the first item in the given toolbar widget's list of
14931 * @param obj The toolbar object
14932 * @return The first item or @c NULL, if it has no items (and on
14935 * @see elm_toolbar_item_append()
14936 * @see elm_toolbar_last_item_get()
14940 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14942 * Get the last item in the given toolbar widget's list of
14945 * @param obj The toolbar object
14946 * @return The last item or @c NULL, if it has no items (and on
14949 * @see elm_toolbar_item_prepend()
14950 * @see elm_toolbar_first_item_get()
14954 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14956 * Get the item after @p item in toolbar.
14958 * @param it The toolbar item.
14959 * @return The item after @p item, or @c NULL if none or on failure.
14961 * @note If it is the last item, @c NULL will be returned.
14963 * @see elm_toolbar_item_append()
14967 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14969 * Get the item before @p item in toolbar.
14971 * @param item The toolbar item.
14972 * @return The item before @p item, or @c NULL if none or on failure.
14974 * @note If it is the first item, @c NULL will be returned.
14976 * @see elm_toolbar_item_prepend()
14980 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14982 * Get the toolbar object from an item.
14984 * @param it The item.
14985 * @return The toolbar object.
14987 * This returns the toolbar object itself that an item belongs to.
14991 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14993 * Set the priority of a toolbar item.
14995 * @param it The toolbar item.
14996 * @param priority The item priority. The default is zero.
14998 * This is used only when the toolbar shrink mode is set to
14999 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15000 * When space is less than required, items with low priority
15001 * will be removed from the toolbar and added to a dynamically-created menu,
15002 * while items with higher priority will remain on the toolbar,
15003 * with the same order they were added.
15005 * @see elm_toolbar_item_priority_get()
15009 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15011 * Get the priority of a toolbar item.
15013 * @param it The toolbar item.
15014 * @return The @p item priority, or @c 0 on failure.
15016 * @see elm_toolbar_item_priority_set() for details.
15020 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15022 * Get the label of item.
15024 * @param it The item of toolbar.
15025 * @return The label of item.
15027 * The return value is a pointer to the label associated to @p item when
15028 * it was created, with function elm_toolbar_item_append() or similar,
15030 * with function elm_toolbar_item_label_set. If no label
15031 * was passed as argument, it will return @c NULL.
15033 * @see elm_toolbar_item_label_set() for more details.
15034 * @see elm_toolbar_item_append()
15038 EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15040 * Set the label of item.
15042 * @param it The item of toolbar.
15043 * @param text The label of item.
15045 * The label to be displayed by the item.
15046 * Label will be placed at icons bottom (if set).
15048 * If a label was passed as argument on item creation, with function
15049 * elm_toolbar_item_append() or similar, it will be already
15050 * displayed by the item.
15052 * @see elm_toolbar_item_label_get()
15053 * @see elm_toolbar_item_append()
15057 EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15059 * Return the data associated with a given toolbar widget item.
15061 * @param it The toolbar widget item handle.
15062 * @return The data associated with @p item.
15064 * @see elm_toolbar_item_data_set()
15068 EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15070 * Set the data associated with a given toolbar widget item.
15072 * @param it The toolbar widget item handle
15073 * @param data The new data pointer to set to @p item.
15075 * This sets new item data on @p item.
15077 * @warning The old data pointer won't be touched by this function, so
15078 * the user had better to free that old data himself/herself.
15082 EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15084 * Returns a pointer to a toolbar item by its label.
15086 * @param obj The toolbar object.
15087 * @param label The label of the item to find.
15089 * @return The pointer to the toolbar item matching @p label or @c NULL
15094 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15096 * Get whether the @p item is selected or not.
15098 * @param it The toolbar item.
15099 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15100 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15102 * @see elm_toolbar_selected_item_set() for details.
15103 * @see elm_toolbar_item_selected_get()
15107 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15109 * Set the selected state of an item.
15111 * @param it The toolbar item
15112 * @param selected The selected state
15114 * This sets the selected state of the given item @p it.
15115 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15117 * If a new item is selected the previosly selected will be unselected.
15118 * Previoulsy selected item can be get with function
15119 * elm_toolbar_selected_item_get().
15121 * Selected items will be highlighted.
15123 * @see elm_toolbar_item_selected_get()
15124 * @see elm_toolbar_selected_item_get()
15128 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15130 * Get the selected item.
15132 * @param obj The toolbar object.
15133 * @return The selected toolbar item.
15135 * The selected item can be unselected with function
15136 * elm_toolbar_item_selected_set().
15138 * The selected item always will be highlighted on toolbar.
15140 * @see elm_toolbar_selected_items_get()
15144 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15146 * Set the icon associated with @p item.
15148 * @param obj The parent of this item.
15149 * @param it The toolbar item.
15150 * @param icon A string with icon name or the absolute path of an image file.
15152 * Toolbar will load icon image from fdo or current theme.
15153 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15154 * If an absolute path is provided it will load it direct from a file.
15156 * @see elm_toolbar_icon_order_lookup_set()
15157 * @see elm_toolbar_icon_order_lookup_get()
15161 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15163 * Get the string used to set the icon of @p item.
15165 * @param it The toolbar item.
15166 * @return The string associated with the icon object.
15168 * @see elm_toolbar_item_icon_set() for details.
15172 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15174 * Get the object of @p item.
15176 * @param it The toolbar item.
15177 * @return The object
15181 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15183 * Get the icon object of @p item.
15185 * @param it The toolbar item.
15186 * @return The icon object
15188 * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15189 * or elm_toolbar_item_icon_memfile_set() for details.
15193 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15195 * Set the icon associated with @p item to an image in a binary buffer.
15197 * @param it The toolbar item.
15198 * @param img The binary data that will be used as an image
15199 * @param size The size of binary data @p img
15200 * @param format Optional format of @p img to pass to the image loader
15201 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15203 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15205 * @note The icon image set by this function can be changed by
15206 * elm_toolbar_item_icon_set().
15210 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);
15213 * Set the icon associated with @p item to an image in a binary buffer.
15215 * @param it The toolbar item.
15216 * @param file The file that contains the image
15217 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15219 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15221 * @note The icon image set by this function can be changed by
15222 * elm_toolbar_item_icon_set().
15226 EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
15229 * Delete them item from the toolbar.
15231 * @param it The item of toolbar to be deleted.
15233 * @see elm_toolbar_item_append()
15234 * @see elm_toolbar_item_del_cb_set()
15238 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15241 * Set the function called when a toolbar item is freed.
15243 * @param it The item to set the callback on.
15244 * @param func The function called.
15246 * If there is a @p func, then it will be called prior item's memory release.
15247 * That will be called with the following arguments:
15249 * @li item's Evas object;
15252 * This way, a data associated to a toolbar item could be properly freed.
15256 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15259 * Get a value whether toolbar item is disabled or not.
15261 * @param it The item.
15262 * @return The disabled state.
15264 * @see elm_toolbar_item_disabled_set() for more details.
15268 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15271 * Sets the disabled/enabled state of a toolbar item.
15273 * @param it The item.
15274 * @param disabled The disabled state.
15276 * A disabled item cannot be selected or unselected. It will also
15277 * change its appearance (generally greyed out). This sets the
15278 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15283 EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15286 * Set or unset item as a separator.
15288 * @param it The toolbar item.
15289 * @param setting @c EINA_TRUE to set item @p item as separator or
15290 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15292 * Items aren't set as separator by default.
15294 * If set as separator it will display separator theme, so won't display
15297 * @see elm_toolbar_item_separator_get()
15301 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
15304 * Get a value whether item is a separator or not.
15306 * @param it The toolbar item.
15307 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15308 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15310 * @see elm_toolbar_item_separator_set() for details.
15314 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15317 * Set the shrink state of toolbar @p obj.
15319 * @param obj The toolbar object.
15320 * @param shrink_mode Toolbar's items display behavior.
15322 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15323 * but will enforce a minimun size so all the items will fit, won't scroll
15324 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15325 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15326 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15330 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15333 * Get the shrink mode of toolbar @p obj.
15335 * @param obj The toolbar object.
15336 * @return Toolbar's items display behavior.
15338 * @see elm_toolbar_mode_shrink_set() for details.
15342 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15345 * Enable/disable homogeneous mode.
15347 * @param obj The toolbar object
15348 * @param homogeneous Assume the items within the toolbar are of the
15349 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15351 * This will enable the homogeneous mode where items are of the same size.
15352 * @see elm_toolbar_homogeneous_get()
15356 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15359 * Get whether the homogeneous mode is enabled.
15361 * @param obj The toolbar object.
15362 * @return Assume the items within the toolbar are of the same height
15363 * and width (EINA_TRUE = on, EINA_FALSE = off).
15365 * @see elm_toolbar_homogeneous_set()
15369 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15371 * Set the parent object of the toolbar items' menus.
15373 * @param obj The toolbar object.
15374 * @param parent The parent of the menu objects.
15376 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15378 * For more details about setting the parent for toolbar menus, see
15379 * elm_menu_parent_set().
15381 * @see elm_menu_parent_set() for details.
15382 * @see elm_toolbar_item_menu_set() for details.
15386 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15388 * Get the parent object of the toolbar items' menus.
15390 * @param obj The toolbar object.
15391 * @return The parent of the menu objects.
15393 * @see elm_toolbar_menu_parent_set() for details.
15397 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15399 * Set the alignment of the items.
15401 * @param obj The toolbar object.
15402 * @param align The new alignment, a float between <tt> 0.0 </tt>
15403 * and <tt> 1.0 </tt>.
15405 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15406 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15409 * Centered items by default.
15411 * @see elm_toolbar_align_get()
15415 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15417 * Get the alignment of the items.
15419 * @param obj The toolbar object.
15420 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15423 * @see elm_toolbar_align_set() for details.
15427 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15429 * Set whether the toolbar item opens a menu.
15431 * @param it The toolbar item.
15432 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15434 * A toolbar item can be set to be a menu, using this function.
15436 * Once it is set to be a menu, it can be manipulated through the
15437 * menu-like function elm_toolbar_menu_parent_set() and the other
15438 * elm_menu functions, using the Evas_Object @c menu returned by
15439 * elm_toolbar_item_menu_get().
15441 * So, items to be displayed in this item's menu should be added with
15442 * elm_menu_item_add().
15444 * The following code exemplifies the most basic usage:
15446 * tb = elm_toolbar_add(win)
15447 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15448 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15449 * elm_toolbar_menu_parent_set(tb, win);
15450 * menu = elm_toolbar_item_menu_get(item);
15451 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15452 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15456 * @see elm_toolbar_item_menu_get()
15460 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
15462 * Get toolbar item's menu.
15464 * @param it The toolbar item.
15465 * @return Item's menu object or @c NULL on failure.
15467 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15468 * this function will set it.
15470 * @see elm_toolbar_item_menu_set() for details.
15474 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15476 * Add a new state to @p item.
15478 * @param it The toolbar item.
15479 * @param icon A string with icon name or the absolute path of an image file.
15480 * @param label The label of the new state.
15481 * @param func The function to call when the item is clicked when this
15482 * state is selected.
15483 * @param data The data to associate with the state.
15484 * @return The toolbar item state, or @c NULL upon failure.
15486 * Toolbar will load icon image from fdo or current theme.
15487 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15488 * If an absolute path is provided it will load it direct from a file.
15490 * States created with this function can be removed with
15491 * elm_toolbar_item_state_del().
15493 * @see elm_toolbar_item_state_del()
15494 * @see elm_toolbar_item_state_sel()
15495 * @see elm_toolbar_item_state_get()
15499 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);
15501 * Delete a previoulsy added state to @p item.
15503 * @param it The toolbar item.
15504 * @param state The state to be deleted.
15505 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15507 * @see elm_toolbar_item_state_add()
15509 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15511 * Set @p state as the current state of @p it.
15513 * @param it The toolbar item.
15514 * @param state The state to use.
15515 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15517 * If @p state is @c NULL, it won't select any state and the default item's
15518 * icon and label will be used. It's the same behaviour than
15519 * elm_toolbar_item_state_unser().
15521 * @see elm_toolbar_item_state_unset()
15525 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15527 * Unset the state of @p it.
15529 * @param it The toolbar item.
15531 * The default icon and label from this item will be displayed.
15533 * @see elm_toolbar_item_state_set() for more details.
15537 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15539 * Get the current state of @p it.
15541 * @param it The toolbar item.
15542 * @return The selected state or @c NULL if none is selected or on failure.
15544 * @see elm_toolbar_item_state_set() for details.
15545 * @see elm_toolbar_item_state_unset()
15546 * @see elm_toolbar_item_state_add()
15550 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15552 * Get the state after selected state in toolbar's @p item.
15554 * @param it The toolbar item to change state.
15555 * @return The state after current state, or @c NULL on failure.
15557 * If last state is selected, this function will return first state.
15559 * @see elm_toolbar_item_state_set()
15560 * @see elm_toolbar_item_state_add()
15564 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15566 * Get the state before selected state in toolbar's @p item.
15568 * @param it The toolbar item to change state.
15569 * @return The state before current state, or @c NULL on failure.
15571 * If first state is selected, this function will return last state.
15573 * @see elm_toolbar_item_state_set()
15574 * @see elm_toolbar_item_state_add()
15578 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15580 * Set the text to be shown in a given toolbar item's tooltips.
15582 * @param it toolbar item.
15583 * @param text The text to set in the content.
15585 * Setup the text as tooltip to object. The item can have only one tooltip,
15586 * so any previous tooltip data - set with this function or
15587 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15589 * @see elm_object_tooltip_text_set() for more details.
15593 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
15595 * Set the content to be shown in the tooltip item.
15597 * Setup the tooltip to item. The item can have only one tooltip,
15598 * so any previous tooltip data is removed. @p func(with @p data) will
15599 * be called every time that need show the tooltip and it should
15600 * return a valid Evas_Object. This object is then managed fully by
15601 * tooltip system and is deleted when the tooltip is gone.
15603 * @param it the toolbar item being attached a tooltip.
15604 * @param func the function used to create the tooltip contents.
15605 * @param data what to provide to @a func as callback data/context.
15606 * @param del_cb called when data is not needed anymore, either when
15607 * another callback replaces @a func, the tooltip is unset with
15608 * elm_toolbar_item_tooltip_unset() or the owner @a item
15609 * dies. This callback receives as the first parameter the
15610 * given @a data, and @c event_info is the item.
15612 * @see elm_object_tooltip_content_cb_set() for more details.
15616 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);
15618 * Unset tooltip from item.
15620 * @param it toolbar item to remove previously set tooltip.
15622 * Remove tooltip from item. The callback provided as del_cb to
15623 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15624 * it is not used anymore.
15626 * @see elm_object_tooltip_unset() for more details.
15627 * @see elm_toolbar_item_tooltip_content_cb_set()
15631 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15633 * Sets a different style for this item tooltip.
15635 * @note before you set a style you should define a tooltip with
15636 * elm_toolbar_item_tooltip_content_cb_set() or
15637 * elm_toolbar_item_tooltip_text_set()
15639 * @param it toolbar item with tooltip already set.
15640 * @param style the theme style to use (default, transparent, ...)
15642 * @see elm_object_tooltip_style_set() for more details.
15646 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15648 * Get the style for this item tooltip.
15650 * @param it toolbar item with tooltip already set.
15651 * @return style the theme style in use, defaults to "default". If the
15652 * object does not have a tooltip set, then NULL is returned.
15654 * @see elm_object_tooltip_style_get() for more details.
15655 * @see elm_toolbar_item_tooltip_style_set()
15659 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15661 * Set the type of mouse pointer/cursor decoration to be shown,
15662 * when the mouse pointer is over the given toolbar widget item
15664 * @param it toolbar item to customize cursor on
15665 * @param cursor the cursor type's name
15667 * This function works analogously as elm_object_cursor_set(), but
15668 * here the cursor's changing area is restricted to the item's
15669 * area, and not the whole widget's. Note that that item cursors
15670 * have precedence over widget cursors, so that a mouse over an
15671 * item with custom cursor set will always show @b that cursor.
15673 * If this function is called twice for an object, a previously set
15674 * cursor will be unset on the second call.
15676 * @see elm_object_cursor_set()
15677 * @see elm_toolbar_item_cursor_get()
15678 * @see elm_toolbar_item_cursor_unset()
15682 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
15685 * Get the type of mouse pointer/cursor decoration set to be shown,
15686 * when the mouse pointer is over the given toolbar widget item
15688 * @param it toolbar item with custom cursor set
15689 * @return the cursor type's name or @c NULL, if no custom cursors
15690 * were set to @p item (and on errors)
15692 * @see elm_object_cursor_get()
15693 * @see elm_toolbar_item_cursor_set()
15694 * @see elm_toolbar_item_cursor_unset()
15698 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15701 * Unset any custom mouse pointer/cursor decoration set to be
15702 * shown, when the mouse pointer is over the given toolbar widget
15703 * item, thus making it show the @b default cursor again.
15705 * @param it a toolbar item
15707 * Use this call to undo any custom settings on this item's cursor
15708 * decoration, bringing it back to defaults (no custom style set).
15710 * @see elm_object_cursor_unset()
15711 * @see elm_toolbar_item_cursor_set()
15715 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15718 * Set a different @b style for a given custom cursor set for a
15721 * @param it toolbar item with custom cursor set
15722 * @param style the <b>theme style</b> to use (e.g. @c "default",
15723 * @c "transparent", etc)
15725 * This function only makes sense when one is using custom mouse
15726 * cursor decorations <b>defined in a theme file</b>, which can have,
15727 * given a cursor name/type, <b>alternate styles</b> on it. It
15728 * works analogously as elm_object_cursor_style_set(), but here
15729 * applyed only to toolbar item objects.
15731 * @warning Before you set a cursor style you should have definen a
15732 * custom cursor previously on the item, with
15733 * elm_toolbar_item_cursor_set()
15735 * @see elm_toolbar_item_cursor_engine_only_set()
15736 * @see elm_toolbar_item_cursor_style_get()
15740 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15743 * Get the current @b style set for a given toolbar item's custom
15746 * @param it toolbar item with custom cursor set.
15747 * @return style the cursor style in use. If the object does not
15748 * have a cursor set, then @c NULL is returned.
15750 * @see elm_toolbar_item_cursor_style_set() for more details
15754 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15757 * Set if the (custom)cursor for a given toolbar item should be
15758 * searched in its theme, also, or should only rely on the
15759 * rendering engine.
15761 * @param it item with custom (custom) cursor already set on
15762 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15763 * only on those provided by the rendering engine, @c EINA_FALSE to
15764 * have them searched on the widget's theme, as well.
15766 * @note This call is of use only if you've set a custom cursor
15767 * for toolbar items, with elm_toolbar_item_cursor_set().
15769 * @note By default, cursors will only be looked for between those
15770 * provided by the rendering engine.
15774 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15777 * Get if the (custom) cursor for a given toolbar item is being
15778 * searched in its theme, also, or is only relying on the rendering
15781 * @param it a toolbar item
15782 * @return @c EINA_TRUE, if cursors are being looked for only on
15783 * those provided by the rendering engine, @c EINA_FALSE if they
15784 * are being searched on the widget's theme, as well.
15786 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15790 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15793 * Change a toolbar's orientation
15794 * @param obj The toolbar object
15795 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15796 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15798 * @deprecated use elm_toolbar_horizontal_set() instead.
15800 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15803 * Change a toolbar's orientation
15804 * @param obj The toolbar object
15805 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15806 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15809 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15812 * Get a toolbar's orientation
15813 * @param obj The toolbar object
15814 * @return If @c EINA_TRUE, the toolbar is vertical
15815 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15817 * @deprecated use elm_toolbar_horizontal_get() instead.
15819 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15822 * Get a toolbar's orientation
15823 * @param obj The toolbar object
15824 * @return If @c EINA_TRUE, the toolbar is horizontal
15825 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15828 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15834 * @defgroup Tooltips Tooltips
15836 * The Tooltip is an (internal, for now) smart object used to show a
15837 * content in a frame on mouse hover of objects(or widgets), with
15838 * tips/information about them.
15843 EAPI double elm_tooltip_delay_get(void);
15844 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15845 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15846 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15847 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15848 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15849 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15850 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);
15851 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15852 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15853 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15854 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15855 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15862 * @defgroup Cursors Cursors
15864 * The Elementary cursor is an internal smart object used to
15865 * customize the mouse cursor displayed over objects (or
15866 * widgets). In the most common scenario, the cursor decoration
15867 * comes from the graphical @b engine Elementary is running
15868 * on. Those engines may provide different decorations for cursors,
15869 * and Elementary provides functions to choose them (think of X11
15870 * cursors, as an example).
15872 * There's also the possibility of, besides using engine provided
15873 * cursors, also use ones coming from Edje theming files. Both
15874 * globally and per widget, Elementary makes it possible for one to
15875 * make the cursors lookup to be held on engines only or on
15876 * Elementary's theme file, too. To set cursor's hot spot,
15877 * two data items should be added to cursor's theme: "hot_x" and
15878 * "hot_y", that are the offset from upper-left corner of the cursor
15879 * (coordinates 0,0).
15885 * Set the cursor to be shown when mouse is over the object
15887 * Set the cursor that will be displayed when mouse is over the
15888 * object. The object can have only one cursor set to it, so if
15889 * this function is called twice for an object, the previous set
15891 * If using X cursors, a definition of all the valid cursor names
15892 * is listed on Elementary_Cursors.h. If an invalid name is set
15893 * the default cursor will be used.
15895 * @param obj the object being set a cursor.
15896 * @param cursor the cursor name to be used.
15900 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15903 * Get the cursor to be shown when mouse is over the object
15905 * @param obj an object with cursor already set.
15906 * @return the cursor name.
15910 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15913 * Unset cursor for object
15915 * Unset cursor for object, and set the cursor to default if the mouse
15916 * was over this object.
15918 * @param obj Target object
15919 * @see elm_object_cursor_set()
15923 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15926 * Sets a different style for this object cursor.
15928 * @note before you set a style you should define a cursor with
15929 * elm_object_cursor_set()
15931 * @param obj an object with cursor already set.
15932 * @param style the theme style to use (default, transparent, ...)
15936 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15939 * Get the style for this object cursor.
15941 * @param obj an object with cursor already set.
15942 * @return style the theme style in use, defaults to "default". If the
15943 * object does not have a cursor set, then NULL is returned.
15947 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15950 * Set if the cursor set should be searched on the theme or should use
15951 * the provided by the engine, only.
15953 * @note before you set if should look on theme you should define a cursor
15954 * with elm_object_cursor_set(). By default it will only look for cursors
15955 * provided by the engine.
15957 * @param obj an object with cursor already set.
15958 * @param engine_only boolean to define it cursors should be looked only
15959 * between the provided by the engine or searched on widget's theme as well.
15963 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15966 * Get the cursor engine only usage for this object cursor.
15968 * @param obj an object with cursor already set.
15969 * @return engine_only boolean to define it cursors should be
15970 * looked only between the provided by the engine or searched on
15971 * widget's theme as well. If the object does not have a cursor
15972 * set, then EINA_FALSE is returned.
15976 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15979 * Get the configured cursor engine only usage
15981 * This gets the globally configured exclusive usage of engine cursors.
15983 * @return 1 if only engine cursors should be used
15986 EAPI int elm_cursor_engine_only_get(void);
15989 * Set the configured cursor engine only usage
15991 * This sets the globally configured exclusive usage of engine cursors.
15992 * It won't affect cursors set before changing this value.
15994 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15995 * look for them on theme before.
15996 * @return EINA_TRUE if value is valid and setted (0 or 1)
15999 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
16006 * @defgroup Menu Menu
16008 * @image html img/widget/menu/preview-00.png
16009 * @image latex img/widget/menu/preview-00.eps
16011 * A menu is a list of items displayed above its parent. When the menu is
16012 * showing its parent is darkened. Each item can have a sub-menu. The menu
16013 * object can be used to display a menu on a right click event, in a toolbar,
16016 * Signals that you can add callbacks for are:
16017 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16019 * Default contents parts of the menu items that you can use for are:
16020 * @li "default" - A main content of the menu item
16022 * Default text parts of the menu items that you can use for are:
16023 * @li "default" - label in the menu item
16025 * @see @ref tutorial_menu
16030 * @brief Add a new menu to the parent
16032 * @param parent The parent object.
16033 * @return The new object or NULL if it cannot be created.
16035 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16037 * @brief Set the parent for the given menu widget
16039 * @param obj The menu object.
16040 * @param parent The new parent.
16042 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16044 * @brief Get the parent for the given menu widget
16046 * @param obj The menu object.
16047 * @return The parent.
16049 * @see elm_menu_parent_set()
16051 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16053 * @brief Move the menu to a new position
16055 * @param obj The menu object.
16056 * @param x The new position.
16057 * @param y The new position.
16059 * Sets the top-left position of the menu to (@p x,@p y).
16061 * @note @p x and @p y coordinates are relative to parent.
16063 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16065 * @brief Close a opened menu
16067 * @param obj the menu object
16070 * Hides the menu and all it's sub-menus.
16072 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16074 * @brief Returns a list of @p item's items.
16076 * @param obj The menu object
16077 * @return An Eina_List* of @p item's items
16079 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16081 * @brief Get the Evas_Object of an Elm_Object_Item
16083 * @param it The menu item object.
16084 * @return The edje object containing the swallowed content
16086 * @warning Don't manipulate this object!
16089 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16091 * @brief Add an item at the end of the given menu widget
16093 * @param obj The menu object.
16094 * @param parent The parent menu item (optional)
16095 * @param icon An icon display on the item. The icon will be destryed by the menu.
16096 * @param label The label of the item.
16097 * @param func Function called when the user select the item.
16098 * @param data Data sent by the callback.
16099 * @return Returns the new item.
16101 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);
16103 * @brief Add an object swallowed in an item at the end of the given menu
16106 * @param obj The menu object.
16107 * @param parent The parent menu item (optional)
16108 * @param subobj The object to swallow
16109 * @param func Function called when the user select the item.
16110 * @param data Data sent by the callback.
16111 * @return Returns the new item.
16113 * Add an evas object as an item to the menu.
16115 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);
16117 * @brief Set the label of a menu item
16119 * @param it The menu item object.
16120 * @param label The label to set for @p item
16122 * @warning Don't use this funcion on items created with
16123 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16125 * @deprecated Use elm_object_item_text_set() instead
16127 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16129 * @brief Get the label of a menu item
16131 * @param it The menu item object.
16132 * @return The label of @p item
16133 * @deprecated Use elm_object_item_text_get() instead
16135 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16137 * @brief Set the icon of a menu item to the standard icon with name @p icon
16139 * @param it The menu item object.
16140 * @param icon The icon object to set for the content of @p item
16142 * Once this icon is set, any previously set icon will be deleted.
16144 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16146 * @brief Get the string representation from the icon of a menu item
16148 * @param it The menu item object.
16149 * @return The string representation of @p item's icon or NULL
16151 * @see elm_menu_item_object_icon_name_set()
16153 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16155 * @brief Set the content object of a menu item
16157 * @param it The menu item object
16158 * @param The content object or NULL
16159 * @return EINA_TRUE on success, else EINA_FALSE
16161 * Use this function to change the object swallowed by a menu item, deleting
16162 * any previously swallowed object.
16164 * @deprecated Use elm_object_item_content_set() instead
16166 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16168 * @brief Get the content object of a menu item
16170 * @param it The menu item object
16171 * @return The content object or NULL
16172 * @note If @p item was added with elm_menu_item_add_object, this
16173 * function will return the object passed, else it will return the
16176 * @see elm_menu_item_object_content_set()
16178 * @deprecated Use elm_object_item_content_get() instead
16180 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16182 * @brief Set the selected state of @p item.
16184 * @param it The menu item object.
16185 * @param selected The selected/unselected state of the item
16187 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16189 * @brief Get the selected state of @p item.
16191 * @param it The menu item object.
16192 * @return The selected/unselected state of the item
16194 * @see elm_menu_item_selected_set()
16196 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16198 * @brief Set the disabled state of @p item.
16200 * @param it The menu item object.
16201 * @param disabled The enabled/disabled state of the item
16202 * @deprecated Use elm_object_item_disabled_set() instead
16204 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16206 * @brief Get the disabled state of @p item.
16208 * @param it The menu item object.
16209 * @return The enabled/disabled state of the item
16211 * @see elm_menu_item_disabled_set()
16212 * @deprecated Use elm_object_item_disabled_get() instead
16214 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16216 * @brief Add a separator item to menu @p obj under @p parent.
16218 * @param obj The menu object
16219 * @param parent The item to add the separator under
16220 * @return The created item or NULL on failure
16222 * This is item is a @ref Separator.
16224 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16226 * @brief Returns whether @p item is a separator.
16228 * @param it The item to check
16229 * @return If true, @p item is a separator
16231 * @see elm_menu_item_separator_add()
16233 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16235 * @brief Deletes an item from the menu.
16237 * @param it The item to delete.
16239 * @see elm_menu_item_add()
16241 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16243 * @brief Set the function called when a menu item is deleted.
16245 * @param it The item to set the callback on
16246 * @param func The function called
16248 * @see elm_menu_item_add()
16249 * @see elm_menu_item_del()
16251 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16253 * @brief Returns the data associated with menu item @p item.
16255 * @param it The item
16256 * @return The data associated with @p item or NULL if none was set.
16258 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16260 * @deprecated Use elm_object_item_data_get() instead
16262 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16264 * @brief Sets the data to be associated with menu item @p item.
16266 * @param it The item
16267 * @param data The data to be associated with @p item
16269 * @deprecated Use elm_object_item_data_set() instead
16271 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16274 * @brief Returns a list of @p item's subitems.
16276 * @param it The item
16277 * @return An Eina_List* of @p item's subitems
16279 * @see elm_menu_add()
16281 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16283 * @brief Get the position of a menu item
16285 * @param it The menu item
16286 * @return The item's index
16288 * This function returns the index position of a menu item in a menu.
16289 * For a sub-menu, this number is relative to the first item in the sub-menu.
16291 * @note Index values begin with 0
16293 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16295 * @brief @brief Return a menu item's owner menu
16297 * @param it The menu item
16298 * @return The menu object owning @p item, or NULL on failure
16300 * Use this function to get the menu object owning an item.
16302 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16304 * @brief Get the selected item in the menu
16306 * @param obj The menu object
16307 * @return The selected item, or NULL if none
16309 * @see elm_menu_item_selected_get()
16310 * @see elm_menu_item_selected_set()
16312 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16314 * @brief Get the last item in the menu
16316 * @param obj The menu object
16317 * @return The last item, or NULL if none
16319 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16321 * @brief Get the first item in the menu
16323 * @param obj The menu object
16324 * @return The first item, or NULL if none
16326 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16328 * @brief Get the next item in the menu.
16330 * @param it The menu item object.
16331 * @return The item after it, or NULL if none
16333 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16335 * @brief Get the previous item in the menu.
16337 * @param it The menu item object.
16338 * @return The item before it, or NULL if none
16340 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16346 * @defgroup List List
16347 * @ingroup Elementary
16349 * @image html img/widget/list/preview-00.png
16350 * @image latex img/widget/list/preview-00.eps width=\textwidth
16352 * @image html img/list.png
16353 * @image latex img/list.eps width=\textwidth
16355 * A list widget is a container whose children are displayed vertically or
16356 * horizontally, in order, and can be selected.
16357 * The list can accept only one or multiple items selection. Also has many
16358 * modes of items displaying.
16360 * A list is a very simple type of list widget. For more robust
16361 * lists, @ref Genlist should probably be used.
16363 * Smart callbacks one can listen to:
16364 * - @c "activated" - The user has double-clicked or pressed
16365 * (enter|return|spacebar) on an item. The @c event_info parameter
16366 * is the item that was activated.
16367 * - @c "clicked,double" - The user has double-clicked an item.
16368 * The @c event_info parameter is the item that was double-clicked.
16369 * - "selected" - when the user selected an item
16370 * - "unselected" - when the user unselected an item
16371 * - "longpressed" - an item in the list is long-pressed
16372 * - "edge,top" - the list is scrolled until the top edge
16373 * - "edge,bottom" - the list is scrolled until the bottom edge
16374 * - "edge,left" - the list is scrolled until the left edge
16375 * - "edge,right" - the list is scrolled until the right edge
16376 * - "language,changed" - the program's language changed
16378 * Available styles for it:
16381 * List of examples:
16382 * @li @ref list_example_01
16383 * @li @ref list_example_02
16384 * @li @ref list_example_03
16393 * @enum _Elm_List_Mode
16394 * @typedef Elm_List_Mode
16396 * Set list's resize behavior, transverse axis scroll and
16397 * items cropping. See each mode's description for more details.
16399 * @note Default value is #ELM_LIST_SCROLL.
16401 * Values <b> don't </b> work as bitmask, only one can be choosen.
16403 * @see elm_list_mode_set()
16404 * @see elm_list_mode_get()
16408 typedef enum _Elm_List_Mode
16410 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. */
16411 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). */
16412 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. */
16413 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. */
16414 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16417 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(). */
16420 * Add a new list widget to the given parent Elementary
16421 * (container) object.
16423 * @param parent The parent object.
16424 * @return a new list widget handle or @c NULL, on errors.
16426 * This function inserts a new list widget on the canvas.
16430 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16435 * @param obj The list object
16437 * @note Call before running show() on the list object.
16438 * @warning If not called, it won't display the list properly.
16441 * li = elm_list_add(win);
16442 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16443 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16445 * evas_object_show(li);
16450 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16453 * Enable or disable multiple items selection on the list object.
16455 * @param obj The list object
16456 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16459 * Disabled by default. If disabled, the user can select a single item of
16460 * the list each time. Selected items are highlighted on list.
16461 * If enabled, many items can be selected.
16463 * If a selected item is selected again, it will be unselected.
16465 * @see elm_list_multi_select_get()
16469 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16472 * Get a value whether multiple items selection is enabled or not.
16474 * @see elm_list_multi_select_set() for details.
16476 * @param obj The list object.
16477 * @return @c EINA_TRUE means multiple items selection is enabled.
16478 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16479 * @c EINA_FALSE is returned.
16483 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16486 * Set which mode to use for the list object.
16488 * @param obj The list object
16489 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16490 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16492 * Set list's resize behavior, transverse axis scroll and
16493 * items cropping. See each mode's description for more details.
16495 * @note Default value is #ELM_LIST_SCROLL.
16497 * Only one can be set, if a previous one was set, it will be changed
16498 * by the new mode set. Bitmask won't work as well.
16500 * @see elm_list_mode_get()
16504 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16507 * Get the mode the list is at.
16509 * @param obj The list object
16510 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16511 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16513 * @note see elm_list_mode_set() for more information.
16517 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16520 * Enable or disable horizontal mode on the list object.
16522 * @param obj The list object.
16523 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16524 * disable it, i.e., to enable vertical mode.
16526 * @note Vertical mode is set by default.
16528 * On horizontal mode items are displayed on list from left to right,
16529 * instead of from top to bottom. Also, the list will scroll horizontally.
16530 * Each item will presents left icon on top and right icon, or end, at
16533 * @see elm_list_horizontal_get()
16537 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16540 * Get a value whether horizontal mode is enabled or not.
16542 * @param obj The list object.
16543 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16544 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16545 * @c EINA_FALSE is returned.
16547 * @see elm_list_horizontal_set() for details.
16551 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16554 * Enable or disable always select mode on the list object.
16556 * @param obj The list object
16557 * @param always_select @c EINA_TRUE to enable always select mode or
16558 * @c EINA_FALSE to disable it.
16560 * @note Always select mode is disabled by default.
16562 * Default behavior of list items is to only call its callback function
16563 * the first time it's pressed, i.e., when it is selected. If a selected
16564 * item is pressed again, and multi-select is disabled, it won't call
16565 * this function (if multi-select is enabled it will unselect the item).
16567 * If always select is enabled, it will call the callback function
16568 * everytime a item is pressed, so it will call when the item is selected,
16569 * and again when a selected item is pressed.
16571 * @see elm_list_always_select_mode_get()
16572 * @see elm_list_multi_select_set()
16576 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16579 * Get a value whether always select mode is enabled or not, meaning that
16580 * an item will always call its callback function, even if already selected.
16582 * @param obj The list object
16583 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16584 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16585 * @c EINA_FALSE is returned.
16587 * @see elm_list_always_select_mode_set() for details.
16591 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16594 * Set bouncing behaviour when the scrolled content reaches an edge.
16596 * Tell the internal scroller object whether it should bounce or not
16597 * when it reaches the respective edges for each axis.
16599 * @param obj The list object
16600 * @param h_bounce Whether to bounce or not in the horizontal axis.
16601 * @param v_bounce Whether to bounce or not in the vertical axis.
16603 * @see elm_scroller_bounce_set()
16607 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16610 * Get the bouncing behaviour of the internal scroller.
16612 * Get whether the internal scroller should bounce when the edge of each
16613 * axis is reached scrolling.
16615 * @param obj The list object.
16616 * @param h_bounce Pointer where to store the bounce state of the horizontal
16618 * @param v_bounce Pointer where to store the bounce state of the vertical
16621 * @see elm_scroller_bounce_get()
16622 * @see elm_list_bounce_set()
16626 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16629 * Set the scrollbar policy.
16631 * @param obj The list object
16632 * @param policy_h Horizontal scrollbar policy.
16633 * @param policy_v Vertical scrollbar policy.
16635 * This sets the scrollbar visibility policy for the given scroller.
16636 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16637 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16638 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16639 * This applies respectively for the horizontal and vertical scrollbars.
16641 * The both are disabled by default, i.e., are set to
16642 * #ELM_SCROLLER_POLICY_OFF.
16646 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16649 * Get the scrollbar policy.
16651 * @see elm_list_scroller_policy_get() for details.
16653 * @param obj The list object.
16654 * @param policy_h Pointer where to store horizontal scrollbar policy.
16655 * @param policy_v Pointer where to store vertical scrollbar policy.
16659 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);
16662 * Append a new item to the list object.
16664 * @param obj The list object.
16665 * @param label The label of the list item.
16666 * @param icon The icon object to use for the left side of the item. An
16667 * icon can be any Evas object, but usually it is an icon created
16668 * with elm_icon_add().
16669 * @param end The icon object to use for the right side of the item. An
16670 * icon can be any Evas object.
16671 * @param func The function to call when the item is clicked.
16672 * @param data The data to associate with the item for related callbacks.
16674 * @return The created item or @c NULL upon failure.
16676 * A new item will be created and appended to the list, i.e., will
16677 * be set as @b last item.
16679 * Items created with this method can be deleted with
16680 * elm_list_item_del().
16682 * Associated @p data can be properly freed when item is deleted if a
16683 * callback function is set with elm_list_item_del_cb_set().
16685 * If a function is passed as argument, it will be called everytime this item
16686 * is selected, i.e., the user clicks over an unselected item.
16687 * If always select is enabled it will call this function every time
16688 * user clicks over an item (already selected or not).
16689 * If such function isn't needed, just passing
16690 * @c NULL as @p func is enough. The same should be done for @p data.
16692 * Simple example (with no function callback or data associated):
16694 * li = elm_list_add(win);
16695 * ic = elm_icon_add(win);
16696 * elm_icon_file_set(ic, "path/to/image", NULL);
16697 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16698 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16700 * evas_object_show(li);
16703 * @see elm_list_always_select_mode_set()
16704 * @see elm_list_item_del()
16705 * @see elm_list_item_del_cb_set()
16706 * @see elm_list_clear()
16707 * @see elm_icon_add()
16711 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);
16714 * Prepend a new item to the list object.
16716 * @param obj The list object.
16717 * @param label The label of the list item.
16718 * @param icon The icon object to use for the left side of the item. An
16719 * icon can be any Evas object, but usually it is an icon created
16720 * with elm_icon_add().
16721 * @param end The icon object to use for the right side of the item. An
16722 * icon can be any Evas object.
16723 * @param func The function to call when the item is clicked.
16724 * @param data The data to associate with the item for related callbacks.
16726 * @return The created item or @c NULL upon failure.
16728 * A new item will be created and prepended to the list, i.e., will
16729 * be set as @b first item.
16731 * Items created with this method can be deleted with
16732 * elm_list_item_del().
16734 * Associated @p data can be properly freed when item is deleted if a
16735 * callback function is set with elm_list_item_del_cb_set().
16737 * If a function is passed as argument, it will be called everytime this item
16738 * is selected, i.e., the user clicks over an unselected item.
16739 * If always select is enabled it will call this function every time
16740 * user clicks over an item (already selected or not).
16741 * If such function isn't needed, just passing
16742 * @c NULL as @p func is enough. The same should be done for @p data.
16744 * @see elm_list_item_append() for a simple code example.
16745 * @see elm_list_always_select_mode_set()
16746 * @see elm_list_item_del()
16747 * @see elm_list_item_del_cb_set()
16748 * @see elm_list_clear()
16749 * @see elm_icon_add()
16753 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);
16756 * Insert a new item into the list object before item @p before.
16758 * @param obj The list object.
16759 * @param before The list item to insert before.
16760 * @param label The label of the list item.
16761 * @param icon The icon object to use for the left side of the item. An
16762 * icon can be any Evas object, but usually it is an icon created
16763 * with elm_icon_add().
16764 * @param end The icon object to use for the right side of the item. An
16765 * icon can be any Evas object.
16766 * @param func The function to call when the item is clicked.
16767 * @param data The data to associate with the item for related callbacks.
16769 * @return The created item or @c NULL upon failure.
16771 * A new item will be created and added to the list. Its position in
16772 * this list will be just before item @p before.
16774 * Items created with this method can be deleted with
16775 * elm_list_item_del().
16777 * Associated @p data can be properly freed when item is deleted if a
16778 * callback function is set with elm_list_item_del_cb_set().
16780 * If a function is passed as argument, it will be called everytime this item
16781 * is selected, i.e., the user clicks over an unselected item.
16782 * If always select is enabled it will call this function every time
16783 * user clicks over an item (already selected or not).
16784 * If such function isn't needed, just passing
16785 * @c NULL as @p func is enough. The same should be done for @p data.
16787 * @see elm_list_item_append() for a simple code example.
16788 * @see elm_list_always_select_mode_set()
16789 * @see elm_list_item_del()
16790 * @see elm_list_item_del_cb_set()
16791 * @see elm_list_clear()
16792 * @see elm_icon_add()
16796 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);
16799 * Insert a new item into the list object after item @p after.
16801 * @param obj The list object.
16802 * @param after The list item to insert after.
16803 * @param label The label of the list item.
16804 * @param icon The icon object to use for the left side of the item. An
16805 * icon can be any Evas object, but usually it is an icon created
16806 * with elm_icon_add().
16807 * @param end The icon object to use for the right side of the item. An
16808 * icon can be any Evas object.
16809 * @param func The function to call when the item is clicked.
16810 * @param data The data to associate with the item for related callbacks.
16812 * @return The created item or @c NULL upon failure.
16814 * A new item will be created and added to the list. Its position in
16815 * this list will be just after item @p after.
16817 * Items created with this method can be deleted with
16818 * elm_list_item_del().
16820 * Associated @p data can be properly freed when item is deleted if a
16821 * callback function is set with elm_list_item_del_cb_set().
16823 * If a function is passed as argument, it will be called everytime this item
16824 * is selected, i.e., the user clicks over an unselected item.
16825 * If always select is enabled it will call this function every time
16826 * user clicks over an item (already selected or not).
16827 * If such function isn't needed, just passing
16828 * @c NULL as @p func is enough. The same should be done for @p data.
16830 * @see elm_list_item_append() for a simple code example.
16831 * @see elm_list_always_select_mode_set()
16832 * @see elm_list_item_del()
16833 * @see elm_list_item_del_cb_set()
16834 * @see elm_list_clear()
16835 * @see elm_icon_add()
16839 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);
16842 * Insert a new item into the sorted list object.
16844 * @param obj The list object.
16845 * @param label The label of the list item.
16846 * @param icon The icon object to use for the left side of the item. An
16847 * icon can be any Evas object, but usually it is an icon created
16848 * with elm_icon_add().
16849 * @param end The icon object to use for the right side of the item. An
16850 * icon can be any Evas object.
16851 * @param func The function to call when the item is clicked.
16852 * @param data The data to associate with the item for related callbacks.
16853 * @param cmp_func The comparing function to be used to sort list
16854 * items <b>by #Elm_List_Item item handles</b>. This function will
16855 * receive two items and compare them, returning a non-negative integer
16856 * if the second item should be place after the first, or negative value
16857 * if should be placed before.
16859 * @return The created item or @c NULL upon failure.
16861 * @note This function inserts values into a list object assuming it was
16862 * sorted and the result will be sorted.
16864 * A new item will be created and added to the list. Its position in
16865 * this list will be found comparing the new item with previously inserted
16866 * items using function @p cmp_func.
16868 * Items created with this method can be deleted with
16869 * elm_list_item_del().
16871 * Associated @p data can be properly freed when item is deleted if a
16872 * callback function is set with elm_list_item_del_cb_set().
16874 * If a function is passed as argument, it will be called everytime this item
16875 * is selected, i.e., the user clicks over an unselected item.
16876 * If always select is enabled it will call this function every time
16877 * user clicks over an item (already selected or not).
16878 * If such function isn't needed, just passing
16879 * @c NULL as @p func is enough. The same should be done for @p data.
16881 * @see elm_list_item_append() for a simple code example.
16882 * @see elm_list_always_select_mode_set()
16883 * @see elm_list_item_del()
16884 * @see elm_list_item_del_cb_set()
16885 * @see elm_list_clear()
16886 * @see elm_icon_add()
16890 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);
16893 * Remove all list's items.
16895 * @param obj The list object
16897 * @see elm_list_item_del()
16898 * @see elm_list_item_append()
16902 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16905 * Get a list of all the list items.
16907 * @param obj The list object
16908 * @return An @c Eina_List of list items, #Elm_List_Item,
16909 * or @c NULL on failure.
16911 * @see elm_list_item_append()
16912 * @see elm_list_item_del()
16913 * @see elm_list_clear()
16917 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16920 * Get the selected item.
16922 * @param obj The list object.
16923 * @return The selected list item.
16925 * The selected item can be unselected with function
16926 * elm_list_item_selected_set().
16928 * The selected item always will be highlighted on list.
16930 * @see elm_list_selected_items_get()
16934 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16937 * Return a list of the currently selected list items.
16939 * @param obj The list object.
16940 * @return An @c Eina_List of list items, #Elm_List_Item,
16941 * or @c NULL on failure.
16943 * Multiple items can be selected if multi select is enabled. It can be
16944 * done with elm_list_multi_select_set().
16946 * @see elm_list_selected_item_get()
16947 * @see elm_list_multi_select_set()
16951 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16954 * Set the selected state of an item.
16956 * @param item The list item
16957 * @param selected The selected state
16959 * This sets the selected state of the given item @p it.
16960 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16962 * If a new item is selected the previosly selected will be unselected,
16963 * unless multiple selection is enabled with elm_list_multi_select_set().
16964 * Previoulsy selected item can be get with function
16965 * elm_list_selected_item_get().
16967 * Selected items will be highlighted.
16969 * @see elm_list_item_selected_get()
16970 * @see elm_list_selected_item_get()
16971 * @see elm_list_multi_select_set()
16975 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16978 * Get whether the @p item is selected or not.
16980 * @param item The list item.
16981 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16982 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16984 * @see elm_list_selected_item_set() for details.
16985 * @see elm_list_item_selected_get()
16989 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16992 * Set or unset item as a separator.
16994 * @param it The list item.
16995 * @param setting @c EINA_TRUE to set item @p it as separator or
16996 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16998 * Items aren't set as separator by default.
17000 * If set as separator it will display separator theme, so won't display
17003 * @see elm_list_item_separator_get()
17007 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17010 * Get a value whether item is a separator or not.
17012 * @see elm_list_item_separator_set() for details.
17014 * @param it The list item.
17015 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17016 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17020 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17023 * Show @p item in the list view.
17025 * @param item The list item to be shown.
17027 * It won't animate list until item is visible. If such behavior is wanted,
17028 * use elm_list_bring_in() intead.
17032 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17035 * Bring in the given item to list view.
17037 * @param item The item.
17039 * This causes list to jump to the given item @p item and show it
17040 * (by scrolling), if it is not fully visible.
17042 * This may use animation to do so and take a period of time.
17044 * If animation isn't wanted, elm_list_item_show() can be used.
17048 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17051 * Delete them item from the list.
17053 * @param item The item of list to be deleted.
17055 * If deleting all list items is required, elm_list_clear()
17056 * should be used instead of getting items list and deleting each one.
17058 * @see elm_list_clear()
17059 * @see elm_list_item_append()
17060 * @see elm_list_item_del_cb_set()
17064 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17067 * Set the function called when a list item is freed.
17069 * @param item The item to set the callback on
17070 * @param func The function called
17072 * If there is a @p func, then it will be called prior item's memory release.
17073 * That will be called with the following arguments:
17075 * @li item's Evas object;
17078 * This way, a data associated to a list item could be properly freed.
17082 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17085 * Get the data associated to the item.
17087 * @param item The list item
17088 * @return The data associated to @p item
17090 * The return value is a pointer to data associated to @p item when it was
17091 * created, with function elm_list_item_append() or similar. If no data
17092 * was passed as argument, it will return @c NULL.
17094 * @see elm_list_item_append()
17098 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17101 * Get the left side icon associated to the item.
17103 * @param item The list item
17104 * @return The left side icon associated to @p item
17106 * The return value is a pointer to the icon associated to @p item when
17108 * created, with function elm_list_item_append() or similar, or later
17109 * with function elm_list_item_icon_set(). If no icon
17110 * was passed as argument, it will return @c NULL.
17112 * @see elm_list_item_append()
17113 * @see elm_list_item_icon_set()
17117 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17120 * Set the left side icon associated to the item.
17122 * @param item The list item
17123 * @param icon The left side icon object to associate with @p item
17125 * The icon object to use at left side of the item. An
17126 * icon can be any Evas object, but usually it is an icon created
17127 * with elm_icon_add().
17129 * Once the icon object is set, a previously set one will be deleted.
17130 * @warning Setting the same icon for two items will cause the icon to
17131 * dissapear from the first item.
17133 * If an icon was passed as argument on item creation, with function
17134 * elm_list_item_append() or similar, it will be already
17135 * associated to the item.
17137 * @see elm_list_item_append()
17138 * @see elm_list_item_icon_get()
17142 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17145 * Get the right side icon associated to the item.
17147 * @param item The list item
17148 * @return The right side icon associated to @p item
17150 * The return value is a pointer to the icon associated to @p item when
17152 * created, with function elm_list_item_append() or similar, or later
17153 * with function elm_list_item_icon_set(). If no icon
17154 * was passed as argument, it will return @c NULL.
17156 * @see elm_list_item_append()
17157 * @see elm_list_item_icon_set()
17161 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17164 * Set the right side icon associated to the item.
17166 * @param item The list item
17167 * @param end The right side icon object to associate with @p item
17169 * The icon object to use at right side of the item. An
17170 * icon can be any Evas object, but usually it is an icon created
17171 * with elm_icon_add().
17173 * Once the icon object is set, a previously set one will be deleted.
17174 * @warning Setting the same icon for two items will cause the icon to
17175 * dissapear from the first item.
17177 * If an icon was passed as argument on item creation, with function
17178 * elm_list_item_append() or similar, it will be already
17179 * associated to the item.
17181 * @see elm_list_item_append()
17182 * @see elm_list_item_end_get()
17186 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17189 * Gets the base object of the item.
17191 * @param item The list item
17192 * @return The base object associated with @p item
17194 * Base object is the @c Evas_Object that represents that item.
17198 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17199 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17202 * Get the label of item.
17204 * @param item The item of list.
17205 * @return The label of item.
17207 * The return value is a pointer to the label associated to @p item when
17208 * it was created, with function elm_list_item_append(), or later
17209 * with function elm_list_item_label_set. If no label
17210 * was passed as argument, it will return @c NULL.
17212 * @see elm_list_item_label_set() for more details.
17213 * @see elm_list_item_append()
17217 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17220 * Set the label of item.
17222 * @param item The item of list.
17223 * @param text The label of item.
17225 * The label to be displayed by the item.
17226 * Label will be placed between left and right side icons (if set).
17228 * If a label was passed as argument on item creation, with function
17229 * elm_list_item_append() or similar, it will be already
17230 * displayed by the item.
17232 * @see elm_list_item_label_get()
17233 * @see elm_list_item_append()
17237 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17241 * Get the item before @p it in list.
17243 * @param it The list item.
17244 * @return The item before @p it, or @c NULL if none or on failure.
17246 * @note If it is the first item, @c NULL will be returned.
17248 * @see elm_list_item_append()
17249 * @see elm_list_items_get()
17253 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17256 * Get the item after @p it in list.
17258 * @param it The list item.
17259 * @return The item after @p it, or @c NULL if none or on failure.
17261 * @note If it is the last item, @c NULL will be returned.
17263 * @see elm_list_item_append()
17264 * @see elm_list_items_get()
17268 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17271 * Sets the disabled/enabled state of a list item.
17273 * @param it The item.
17274 * @param disabled The disabled state.
17276 * A disabled item cannot be selected or unselected. It will also
17277 * change its appearance (generally greyed out). This sets the
17278 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17283 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17286 * Get a value whether list item is disabled or not.
17288 * @param it The item.
17289 * @return The disabled state.
17291 * @see elm_list_item_disabled_set() for more details.
17295 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17298 * Set the text to be shown in a given list item's tooltips.
17300 * @param item Target item.
17301 * @param text The text to set in the content.
17303 * Setup the text as tooltip to object. The item can have only one tooltip,
17304 * so any previous tooltip data - set with this function or
17305 * elm_list_item_tooltip_content_cb_set() - is removed.
17307 * @see elm_object_tooltip_text_set() for more details.
17311 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17315 * @brief Disable size restrictions on an object's tooltip
17316 * @param item The tooltip's anchor object
17317 * @param disable If EINA_TRUE, size restrictions are disabled
17318 * @return EINA_FALSE on failure, EINA_TRUE on success
17320 * This function allows a tooltip to expand beyond its parant window's canvas.
17321 * It will instead be limited only by the size of the display.
17323 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17325 * @brief Retrieve size restriction state of an object's tooltip
17326 * @param obj The tooltip's anchor object
17327 * @return If EINA_TRUE, size restrictions are disabled
17329 * This function returns whether a tooltip is allowed to expand beyond
17330 * its parant window's canvas.
17331 * It will instead be limited only by the size of the display.
17333 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17336 * Set the content to be shown in the tooltip item.
17338 * Setup the tooltip to item. The item can have only one tooltip,
17339 * so any previous tooltip data is removed. @p func(with @p data) will
17340 * be called every time that need show the tooltip and it should
17341 * return a valid Evas_Object. This object is then managed fully by
17342 * tooltip system and is deleted when the tooltip is gone.
17344 * @param item the list item being attached a tooltip.
17345 * @param func the function used to create the tooltip contents.
17346 * @param data what to provide to @a func as callback data/context.
17347 * @param del_cb called when data is not needed anymore, either when
17348 * another callback replaces @a func, the tooltip is unset with
17349 * elm_list_item_tooltip_unset() or the owner @a item
17350 * dies. This callback receives as the first parameter the
17351 * given @a data, and @c event_info is the item.
17353 * @see elm_object_tooltip_content_cb_set() for more details.
17357 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);
17360 * Unset tooltip from item.
17362 * @param item list item to remove previously set tooltip.
17364 * Remove tooltip from item. The callback provided as del_cb to
17365 * elm_list_item_tooltip_content_cb_set() will be called to notify
17366 * it is not used anymore.
17368 * @see elm_object_tooltip_unset() for more details.
17369 * @see elm_list_item_tooltip_content_cb_set()
17373 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17376 * Sets a different style for this item tooltip.
17378 * @note before you set a style you should define a tooltip with
17379 * elm_list_item_tooltip_content_cb_set() or
17380 * elm_list_item_tooltip_text_set()
17382 * @param item list item with tooltip already set.
17383 * @param style the theme style to use (default, transparent, ...)
17385 * @see elm_object_tooltip_style_set() for more details.
17389 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17392 * Get the style for this item tooltip.
17394 * @param item list item with tooltip already set.
17395 * @return style the theme style in use, defaults to "default". If the
17396 * object does not have a tooltip set, then NULL is returned.
17398 * @see elm_object_tooltip_style_get() for more details.
17399 * @see elm_list_item_tooltip_style_set()
17403 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17406 * Set the type of mouse pointer/cursor decoration to be shown,
17407 * when the mouse pointer is over the given list widget item
17409 * @param item list item to customize cursor on
17410 * @param cursor the cursor type's name
17412 * This function works analogously as elm_object_cursor_set(), but
17413 * here the cursor's changing area is restricted to the item's
17414 * area, and not the whole widget's. Note that that item cursors
17415 * have precedence over widget cursors, so that a mouse over an
17416 * item with custom cursor set will always show @b that cursor.
17418 * If this function is called twice for an object, a previously set
17419 * cursor will be unset on the second call.
17421 * @see elm_object_cursor_set()
17422 * @see elm_list_item_cursor_get()
17423 * @see elm_list_item_cursor_unset()
17427 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17430 * Get the type of mouse pointer/cursor decoration set to be shown,
17431 * when the mouse pointer is over the given list widget item
17433 * @param item list item with custom cursor set
17434 * @return the cursor type's name or @c NULL, if no custom cursors
17435 * were set to @p item (and on errors)
17437 * @see elm_object_cursor_get()
17438 * @see elm_list_item_cursor_set()
17439 * @see elm_list_item_cursor_unset()
17443 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17446 * Unset any custom mouse pointer/cursor decoration set to be
17447 * shown, when the mouse pointer is over the given list widget
17448 * item, thus making it show the @b default cursor again.
17450 * @param item a list item
17452 * Use this call to undo any custom settings on this item's cursor
17453 * decoration, bringing it back to defaults (no custom style set).
17455 * @see elm_object_cursor_unset()
17456 * @see elm_list_item_cursor_set()
17460 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17463 * Set a different @b style for a given custom cursor set for a
17466 * @param item list item with custom cursor set
17467 * @param style the <b>theme style</b> to use (e.g. @c "default",
17468 * @c "transparent", etc)
17470 * This function only makes sense when one is using custom mouse
17471 * cursor decorations <b>defined in a theme file</b>, which can have,
17472 * given a cursor name/type, <b>alternate styles</b> on it. It
17473 * works analogously as elm_object_cursor_style_set(), but here
17474 * applyed only to list item objects.
17476 * @warning Before you set a cursor style you should have definen a
17477 * custom cursor previously on the item, with
17478 * elm_list_item_cursor_set()
17480 * @see elm_list_item_cursor_engine_only_set()
17481 * @see elm_list_item_cursor_style_get()
17485 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17488 * Get the current @b style set for a given list item's custom
17491 * @param item list item with custom cursor set.
17492 * @return style the cursor style in use. If the object does not
17493 * have a cursor set, then @c NULL is returned.
17495 * @see elm_list_item_cursor_style_set() for more details
17499 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17502 * Set if the (custom)cursor for a given list item should be
17503 * searched in its theme, also, or should only rely on the
17504 * rendering engine.
17506 * @param item item with custom (custom) cursor already set on
17507 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17508 * only on those provided by the rendering engine, @c EINA_FALSE to
17509 * have them searched on the widget's theme, as well.
17511 * @note This call is of use only if you've set a custom cursor
17512 * for list items, with elm_list_item_cursor_set().
17514 * @note By default, cursors will only be looked for between those
17515 * provided by the rendering engine.
17519 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17522 * Get if the (custom) cursor for a given list item is being
17523 * searched in its theme, also, or is only relying on the rendering
17526 * @param item a list item
17527 * @return @c EINA_TRUE, if cursors are being looked for only on
17528 * those provided by the rendering engine, @c EINA_FALSE if they
17529 * are being searched on the widget's theme, as well.
17531 * @see elm_list_item_cursor_engine_only_set(), for more details
17535 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17542 * @defgroup Slider Slider
17543 * @ingroup Elementary
17545 * @image html img/widget/slider/preview-00.png
17546 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17548 * The slider adds a dragable āsliderā widget for selecting the value of
17549 * something within a range.
17551 * A slider can be horizontal or vertical. It can contain an Icon and has a
17552 * primary label as well as a units label (that is formatted with floating
17553 * point values and thus accepts a printf-style format string, like
17554 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17555 * else (like on the slider itself) that also accepts a format string like
17556 * units. Label, Icon Unit and Indicator strings/objects are optional.
17558 * A slider may be inverted which means values invert, with high vales being
17559 * on the left or top and low values on the right or bottom (as opposed to
17560 * normally being low on the left or top and high on the bottom and right).
17562 * The slider should have its minimum and maximum values set by the
17563 * application with elm_slider_min_max_set() and value should also be set by
17564 * the application before use with elm_slider_value_set(). The span of the
17565 * slider is its length (horizontally or vertically). This will be scaled by
17566 * the object or applications scaling factor. At any point code can query the
17567 * slider for its value with elm_slider_value_get().
17569 * Smart callbacks one can listen to:
17570 * - "changed" - Whenever the slider value is changed by the user.
17571 * - "slider,drag,start" - dragging the slider indicator around has started.
17572 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17573 * - "delay,changed" - A short time after the value is changed by the user.
17574 * This will be called only when the user stops dragging for
17575 * a very short period or when they release their
17576 * finger/mouse, so it avoids possibly expensive reactions to
17577 * the value change.
17579 * Available styles for it:
17582 * Default contents parts of the slider widget that you can use for are:
17583 * @li "icon" - An icon of the slider
17584 * @li "end" - A end part content of the slider
17586 * Default text parts of the silder widget that you can use for are:
17587 * @li "default" - Label of the silder
17588 * Here is an example on its usage:
17589 * @li @ref slider_example
17593 * @addtogroup Slider
17598 * Add a new slider widget to the given parent Elementary
17599 * (container) object.
17601 * @param parent The parent object.
17602 * @return a new slider widget handle or @c NULL, on errors.
17604 * This function inserts a new slider widget on the canvas.
17608 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17611 * Set the label of a given slider widget
17613 * @param obj The progress bar object
17614 * @param label The text label string, in UTF-8
17617 * @deprecated use elm_object_text_set() instead.
17619 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17622 * Get the label of a given slider widget
17624 * @param obj The progressbar object
17625 * @return The text label string, in UTF-8
17628 * @deprecated use elm_object_text_get() instead.
17630 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17633 * Set the icon object of the slider object.
17635 * @param obj The slider object.
17636 * @param icon The icon object.
17638 * On horizontal mode, icon is placed at left, and on vertical mode,
17641 * @note Once the icon object is set, a previously set one will be deleted.
17642 * If you want to keep that old content object, use the
17643 * elm_slider_icon_unset() function.
17645 * @warning If the object being set does not have minimum size hints set,
17646 * it won't get properly displayed.
17649 * @deprecated use elm_object_part_content_set() instead.
17651 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17654 * Unset an icon set on a given slider widget.
17656 * @param obj The slider object.
17657 * @return The icon object that was being used, if any was set, or
17658 * @c NULL, otherwise (and on errors).
17660 * On horizontal mode, icon is placed at left, and on vertical mode,
17663 * This call will unparent and return the icon object which was set
17664 * for this widget, previously, on success.
17666 * @see elm_slider_icon_set() for more details
17667 * @see elm_slider_icon_get()
17668 * @deprecated use elm_object_part_content_unset() instead.
17672 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17675 * Retrieve the icon object set for a given slider widget.
17677 * @param obj The slider object.
17678 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17679 * otherwise (and on errors).
17681 * On horizontal mode, icon is placed at left, and on vertical mode,
17684 * @see elm_slider_icon_set() for more details
17685 * @see elm_slider_icon_unset()
17687 * @deprecated use elm_object_part_content_get() instead.
17691 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17694 * Set the end object of the slider object.
17696 * @param obj The slider object.
17697 * @param end The end object.
17699 * On horizontal mode, end is placed at left, and on vertical mode,
17700 * placed at bottom.
17702 * @note Once the icon object is set, a previously set one will be deleted.
17703 * If you want to keep that old content object, use the
17704 * elm_slider_end_unset() function.
17706 * @warning If the object being set does not have minimum size hints set,
17707 * it won't get properly displayed.
17709 * @deprecated use elm_object_part_content_set() instead.
17713 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17716 * Unset an end object set on a given slider widget.
17718 * @param obj The slider object.
17719 * @return The end object that was being used, if any was set, or
17720 * @c NULL, otherwise (and on errors).
17722 * On horizontal mode, end is placed at left, and on vertical mode,
17723 * placed at bottom.
17725 * This call will unparent and return the icon object which was set
17726 * for this widget, previously, on success.
17728 * @see elm_slider_end_set() for more details.
17729 * @see elm_slider_end_get()
17731 * @deprecated use elm_object_part_content_unset() instead
17736 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17739 * Retrieve the end object set for a given slider widget.
17741 * @param obj The slider object.
17742 * @return The end object's handle, if @p obj had one set, or @c NULL,
17743 * otherwise (and on errors).
17745 * On horizontal mode, icon is placed at right, and on vertical mode,
17746 * placed at bottom.
17748 * @see elm_slider_end_set() for more details.
17749 * @see elm_slider_end_unset()
17752 * @deprecated use elm_object_part_content_get() instead
17757 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17760 * Set the (exact) length of the bar region of a given slider widget.
17762 * @param obj The slider object.
17763 * @param size The length of the slider's bar region.
17765 * This sets the minimum width (when in horizontal mode) or height
17766 * (when in vertical mode) of the actual bar area of the slider
17767 * @p obj. This in turn affects the object's minimum size. Use
17768 * this when you're not setting other size hints expanding on the
17769 * given direction (like weight and alignment hints) and you would
17770 * like it to have a specific size.
17772 * @note Icon, end, label, indicator and unit text around @p obj
17773 * will require their
17774 * own space, which will make @p obj to require more the @p size,
17777 * @see elm_slider_span_size_get()
17781 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17784 * Get the length set for the bar region of a given slider widget
17786 * @param obj The slider object.
17787 * @return The length of the slider's bar region.
17789 * If that size was not set previously, with
17790 * elm_slider_span_size_set(), this call will return @c 0.
17794 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17797 * Set the format string for the unit label.
17799 * @param obj The slider object.
17800 * @param format The format string for the unit display.
17802 * Unit label is displayed all the time, if set, after slider's bar.
17803 * In horizontal mode, at right and in vertical mode, at bottom.
17805 * If @c NULL, unit label won't be visible. If not it sets the format
17806 * string for the label text. To the label text is provided a floating point
17807 * value, so the label text can display up to 1 floating point value.
17808 * Note that this is optional.
17810 * Use a format string such as "%1.2f meters" for example, and it will
17811 * display values like: "3.14 meters" for a value equal to 3.14159.
17813 * Default is unit label disabled.
17815 * @see elm_slider_indicator_format_get()
17819 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17822 * Get the unit label format of the slider.
17824 * @param obj The slider object.
17825 * @return The unit label format string in UTF-8.
17827 * Unit label is displayed all the time, if set, after slider's bar.
17828 * In horizontal mode, at right and in vertical mode, at bottom.
17830 * @see elm_slider_unit_format_set() for more
17831 * information on how this works.
17835 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17838 * Set the format string for the indicator label.
17840 * @param obj The slider object.
17841 * @param indicator The format string for the indicator display.
17843 * The slider may display its value somewhere else then unit label,
17844 * for example, above the slider knob that is dragged around. This function
17845 * sets the format string used for this.
17847 * If @c NULL, indicator label won't be visible. If not it sets the format
17848 * string for the label text. To the label text is provided a floating point
17849 * value, so the label text can display up to 1 floating point value.
17850 * Note that this is optional.
17852 * Use a format string such as "%1.2f meters" for example, and it will
17853 * display values like: "3.14 meters" for a value equal to 3.14159.
17855 * Default is indicator label disabled.
17857 * @see elm_slider_indicator_format_get()
17861 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17864 * Get the indicator label format of the slider.
17866 * @param obj The slider object.
17867 * @return The indicator label format string in UTF-8.
17869 * The slider may display its value somewhere else then unit label,
17870 * for example, above the slider knob that is dragged around. This function
17871 * gets the format string used for this.
17873 * @see elm_slider_indicator_format_set() for more
17874 * information on how this works.
17878 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17881 * Set the format function pointer for the indicator label
17883 * @param obj The slider object.
17884 * @param func The indicator format function.
17885 * @param free_func The freeing function for the format string.
17887 * Set the callback function to format the indicator string.
17889 * @see elm_slider_indicator_format_set() for more info on how this works.
17893 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);
17896 * Set the format function pointer for the units label
17898 * @param obj The slider object.
17899 * @param func The units format function.
17900 * @param free_func The freeing function for the format string.
17902 * Set the callback function to format the indicator string.
17904 * @see elm_slider_units_format_set() for more info on how this works.
17908 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);
17911 * Set the orientation of a given slider widget.
17913 * @param obj The slider object.
17914 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17915 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17917 * Use this function to change how your slider is to be
17918 * disposed: vertically or horizontally.
17920 * By default it's displayed horizontally.
17922 * @see elm_slider_horizontal_get()
17926 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17929 * Retrieve the orientation of a given slider widget
17931 * @param obj The slider object.
17932 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17933 * @c EINA_FALSE if it's @b vertical (and on errors).
17935 * @see elm_slider_horizontal_set() for more details.
17939 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17942 * Set the minimum and maximum values for the slider.
17944 * @param obj The slider object.
17945 * @param min The minimum value.
17946 * @param max The maximum value.
17948 * Define the allowed range of values to be selected by the user.
17950 * If actual value is less than @p min, it will be updated to @p min. If it
17951 * is bigger then @p max, will be updated to @p max. Actual value can be
17952 * get with elm_slider_value_get().
17954 * By default, min is equal to 0.0, and max is equal to 1.0.
17956 * @warning Maximum must be greater than minimum, otherwise behavior
17959 * @see elm_slider_min_max_get()
17963 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17966 * Get the minimum and maximum values of the slider.
17968 * @param obj The slider object.
17969 * @param min Pointer where to store the minimum value.
17970 * @param max Pointer where to store the maximum value.
17972 * @note If only one value is needed, the other pointer can be passed
17975 * @see elm_slider_min_max_set() for details.
17979 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17982 * Set the value the slider displays.
17984 * @param obj The slider object.
17985 * @param val The value to be displayed.
17987 * Value will be presented on the unit label following format specified with
17988 * elm_slider_unit_format_set() and on indicator with
17989 * elm_slider_indicator_format_set().
17991 * @warning The value must to be between min and max values. This values
17992 * are set by elm_slider_min_max_set().
17994 * @see elm_slider_value_get()
17995 * @see elm_slider_unit_format_set()
17996 * @see elm_slider_indicator_format_set()
17997 * @see elm_slider_min_max_set()
18001 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18004 * Get the value displayed by the spinner.
18006 * @param obj The spinner object.
18007 * @return The value displayed.
18009 * @see elm_spinner_value_set() for details.
18013 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18016 * Invert a given slider widget's displaying values order
18018 * @param obj The slider object.
18019 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18020 * @c EINA_FALSE to bring it back to default, non-inverted values.
18022 * A slider may be @b inverted, in which state it gets its
18023 * values inverted, with high vales being on the left or top and
18024 * low values on the right or bottom, as opposed to normally have
18025 * the low values on the former and high values on the latter,
18026 * respectively, for horizontal and vertical modes.
18028 * @see elm_slider_inverted_get()
18032 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18035 * Get whether a given slider widget's displaying values are
18038 * @param obj The slider object.
18039 * @return @c EINA_TRUE, if @p obj has inverted values,
18040 * @c EINA_FALSE otherwise (and on errors).
18042 * @see elm_slider_inverted_set() for more details.
18046 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18049 * Set whether to enlarge slider indicator (augmented knob) or not.
18051 * @param obj The slider object.
18052 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18053 * let the knob always at default size.
18055 * By default, indicator will be bigger while dragged by the user.
18057 * @warning It won't display values set with
18058 * elm_slider_indicator_format_set() if you disable indicator.
18062 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18065 * Get whether a given slider widget's enlarging indicator or not.
18067 * @param obj The slider object.
18068 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18069 * @c EINA_FALSE otherwise (and on errors).
18071 * @see elm_slider_indicator_show_set() for details.
18075 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18082 * @addtogroup Actionslider Actionslider
18084 * @image html img/widget/actionslider/preview-00.png
18085 * @image latex img/widget/actionslider/preview-00.eps
18087 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18088 * properties. The user drags and releases the indicator, to choose a label.
18090 * Labels occupy the following positions.
18095 * Positions can be enabled or disabled.
18097 * Magnets can be set on the above positions.
18099 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18101 * @note By default all positions are set as enabled.
18103 * Signals that you can add callbacks for are:
18105 * "selected" - when user selects an enabled position (the label is passed
18108 * "pos_changed" - when the indicator reaches any of the positions("left",
18109 * "right" or "center").
18111 * See an example of actionslider usage @ref actionslider_example_page "here"
18114 typedef enum _Elm_Actionslider_Pos
18116 ELM_ACTIONSLIDER_NONE = 0,
18117 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18118 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18119 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18120 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18121 } Elm_Actionslider_Pos;
18124 * Add a new actionslider to the parent.
18126 * @param parent The parent object
18127 * @return The new actionslider object or NULL if it cannot be created
18129 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18131 * Set actionslider labels.
18133 * @param obj The actionslider object
18134 * @param left_label The label to be set on the left.
18135 * @param center_label The label to be set on the center.
18136 * @param right_label The label to be set on the right.
18137 * @deprecated use elm_object_text_set() instead.
18139 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);
18141 * Get actionslider labels.
18143 * @param obj The actionslider object
18144 * @param left_label A char** to place the left_label of @p obj into.
18145 * @param center_label A char** to place the center_label of @p obj into.
18146 * @param right_label A char** to place the right_label of @p obj into.
18147 * @deprecated use elm_object_text_set() instead.
18149 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);
18151 * Get actionslider selected label.
18153 * @param obj The actionslider object
18154 * @return The selected label
18156 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18158 * Set actionslider indicator position.
18160 * @param obj The actionslider object.
18161 * @param pos The position of the indicator.
18163 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18165 * Get actionslider indicator position.
18167 * @param obj The actionslider object.
18168 * @return The position of the indicator.
18170 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18172 * Set actionslider magnet position. To make multiple positions magnets @c or
18173 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18175 * @param obj The actionslider object.
18176 * @param pos Bit mask indicating the magnet positions.
18178 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18180 * Get actionslider magnet position.
18182 * @param obj The actionslider object.
18183 * @return The positions with magnet property.
18185 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18187 * Set actionslider enabled position. To set multiple positions as enabled @c or
18188 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18190 * @note All the positions are enabled by default.
18192 * @param obj The actionslider object.
18193 * @param pos Bit mask indicating the enabled positions.
18195 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18197 * Get actionslider enabled position.
18199 * @param obj The actionslider object.
18200 * @return The enabled positions.
18202 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18204 * Set the label used on the indicator.
18206 * @param obj The actionslider object
18207 * @param label The label to be set on the indicator.
18208 * @deprecated use elm_object_text_set() instead.
18210 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18212 * Get the label used on the indicator object.
18214 * @param obj The actionslider object
18215 * @return The indicator label
18216 * @deprecated use elm_object_text_get() instead.
18218 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18224 * @defgroup Genlist Genlist
18226 * @image html img/widget/genlist/preview-00.png
18227 * @image latex img/widget/genlist/preview-00.eps
18228 * @image html img/genlist.png
18229 * @image latex img/genlist.eps
18231 * This widget aims to have more expansive list than the simple list in
18232 * Elementary that could have more flexible items and allow many more entries
18233 * while still being fast and low on memory usage. At the same time it was
18234 * also made to be able to do tree structures. But the price to pay is more
18235 * complexity when it comes to usage. If all you want is a simple list with
18236 * icons and a single text, use the normal @ref List object.
18238 * Genlist has a fairly large API, mostly because it's relatively complex,
18239 * trying to be both expansive, powerful and efficient. First we will begin
18240 * an overview on the theory behind genlist.
18242 * @section Genlist_Item_Class Genlist item classes - creating items
18244 * In order to have the ability to add and delete items on the fly, genlist
18245 * implements a class (callback) system where the application provides a
18246 * structure with information about that type of item (genlist may contain
18247 * multiple different items with different classes, states and styles).
18248 * Genlist will call the functions in this struct (methods) when an item is
18249 * "realized" (i.e., created dynamically, while the user is scrolling the
18250 * grid). All objects will simply be deleted when no longer needed with
18251 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18252 * following members:
18253 * - @c item_style - This is a constant string and simply defines the name
18254 * of the item style. It @b must be specified and the default should be @c
18257 * - @c func - A struct with pointers to functions that will be called when
18258 * an item is going to be actually created. All of them receive a @c data
18259 * parameter that will point to the same data passed to
18260 * elm_genlist_item_append() and related item creation functions, and a @c
18261 * obj parameter that points to the genlist object itself.
18263 * The function pointers inside @c func are @c text_get, @c content_get, @c
18264 * state_get and @c del. The 3 first functions also receive a @c part
18265 * parameter described below. A brief description of these functions follows:
18267 * - @c text_get - The @c part parameter is the name string of one of the
18268 * existing text parts in the Edje group implementing the item's theme.
18269 * This function @b must return a strdup'()ed string, as the caller will
18270 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
18271 * - @c content_get - The @c part parameter is the name string of one of the
18272 * existing (content) swallow parts in the Edje group implementing the item's
18273 * theme. It must return @c NULL, when no content is desired, or a valid
18274 * object handle, otherwise. The object will be deleted by the genlist on
18275 * its deletion or when the item is "unrealized". See
18276 * #Elm_Genlist_Item_Content_Get_Cb.
18277 * - @c func.state_get - The @c part parameter is the name string of one of
18278 * the state parts in the Edje group implementing the item's theme. Return
18279 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18280 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18281 * and @c "elm" as "emission" and "source" arguments, respectively, when
18282 * the state is true (the default is false), where @c XXX is the name of
18283 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18284 * - @c func.del - This is intended for use when genlist items are deleted,
18285 * so any data attached to the item (e.g. its data parameter on creation)
18286 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18288 * available item styles:
18290 * - default_style - The text part is a textblock
18292 * @image html img/widget/genlist/preview-04.png
18293 * @image latex img/widget/genlist/preview-04.eps
18297 * @image html img/widget/genlist/preview-01.png
18298 * @image latex img/widget/genlist/preview-01.eps
18300 * - icon_top_text_bottom
18302 * @image html img/widget/genlist/preview-02.png
18303 * @image latex img/widget/genlist/preview-02.eps
18307 * @image html img/widget/genlist/preview-03.png
18308 * @image latex img/widget/genlist/preview-03.eps
18310 * @section Genlist_Items Structure of items
18312 * An item in a genlist can have 0 or more texts (they can be regular
18313 * text or textblock Evas objects - that's up to the style to determine), 0
18314 * or more contents (which are simply objects swallowed into the genlist item's
18315 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18316 * behavior left to the user to define. The Edje part names for each of
18317 * these properties will be looked up, in the theme file for the genlist,
18318 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18319 * "states", respectively. For each of those properties, if more than one
18320 * part is provided, they must have names listed separated by spaces in the
18321 * data fields. For the default genlist item theme, we have @b one text
18322 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18323 * "elm.swallow.end") and @b no state parts.
18325 * A genlist item may be at one of several styles. Elementary provides one
18326 * by default - "default", but this can be extended by system or application
18327 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18330 * @section Genlist_Manipulation Editing and Navigating
18332 * Items can be added by several calls. All of them return a @ref
18333 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18334 * They all take a data parameter that is meant to be used for a handle to
18335 * the applications internal data (eg the struct with the original item
18336 * data). The parent parameter is the parent genlist item this belongs to if
18337 * it is a tree or an indexed group, and NULL if there is no parent. The
18338 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18339 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18340 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18341 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18342 * is set then this item is group index item that is displayed at the top
18343 * until the next group comes. The func parameter is a convenience callback
18344 * that is called when the item is selected and the data parameter will be
18345 * the func_data parameter, obj be the genlist object and event_info will be
18346 * the genlist item.
18348 * elm_genlist_item_append() adds an item to the end of the list, or if
18349 * there is a parent, to the end of all the child items of the parent.
18350 * elm_genlist_item_prepend() is the same but adds to the beginning of
18351 * the list or children list. elm_genlist_item_insert_before() inserts at
18352 * item before another item and elm_genlist_item_insert_after() inserts after
18353 * the indicated item.
18355 * The application can clear the list with elm_genlist_clear() which deletes
18356 * all the items in the list and elm_genlist_item_del() will delete a specific
18357 * item. elm_genlist_item_subitems_clear() will clear all items that are
18358 * children of the indicated parent item.
18360 * To help inspect list items you can jump to the item at the top of the list
18361 * with elm_genlist_first_item_get() which will return the item pointer, and
18362 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18363 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18364 * and previous items respectively relative to the indicated item. Using
18365 * these calls you can walk the entire item list/tree. Note that as a tree
18366 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18367 * let you know which item is the parent (and thus know how to skip them if
18370 * @section Genlist_Muti_Selection Multi-selection
18372 * If the application wants multiple items to be able to be selected,
18373 * elm_genlist_multi_select_set() can enable this. If the list is
18374 * single-selection only (the default), then elm_genlist_selected_item_get()
18375 * will return the selected item, if any, or NULL if none is selected. If the
18376 * list is multi-select then elm_genlist_selected_items_get() will return a
18377 * list (that is only valid as long as no items are modified (added, deleted,
18378 * selected or unselected)).
18380 * @section Genlist_Usage_Hints Usage hints
18382 * There are also convenience functions. elm_genlist_item_genlist_get() will
18383 * return the genlist object the item belongs to. elm_genlist_item_show()
18384 * will make the scroller scroll to show that specific item so its visible.
18385 * elm_genlist_item_data_get() returns the data pointer set by the item
18386 * creation functions.
18388 * If an item changes (state of boolean changes, text or contents change),
18389 * then use elm_genlist_item_update() to have genlist update the item with
18390 * the new state. Genlist will re-realize the item thus call the functions
18391 * in the _Elm_Genlist_Item_Class for that item.
18393 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18394 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18395 * to expand/contract an item and get its expanded state, use
18396 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18397 * again to make an item disabled (unable to be selected and appear
18398 * differently) use elm_genlist_item_disabled_set() to set this and
18399 * elm_genlist_item_disabled_get() to get the disabled state.
18401 * In general to indicate how the genlist should expand items horizontally to
18402 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18403 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18404 * mode means that if items are too wide to fit, the scroller will scroll
18405 * horizontally. Otherwise items are expanded to fill the width of the
18406 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18407 * to the viewport width and limited to that size. This can be combined with
18408 * a different style that uses edjes' ellipsis feature (cutting text off like
18411 * Items will only call their selection func and callback when first becoming
18412 * selected. Any further clicks will do nothing, unless you enable always
18413 * select with elm_genlist_always_select_mode_set(). This means even if
18414 * selected, every click will make the selected callbacks be called.
18415 * elm_genlist_no_select_mode_set() will turn off the ability to select
18416 * items entirely and they will neither appear selected nor call selected
18417 * callback functions.
18419 * Remember that you can create new styles and add your own theme augmentation
18420 * per application with elm_theme_extension_add(). If you absolutely must
18421 * have a specific style that overrides any theme the user or system sets up
18422 * you can use elm_theme_overlay_add() to add such a file.
18424 * @section Genlist_Implementation Implementation
18426 * Evas tracks every object you create. Every time it processes an event
18427 * (mouse move, down, up etc.) it needs to walk through objects and find out
18428 * what event that affects. Even worse every time it renders display updates,
18429 * in order to just calculate what to re-draw, it needs to walk through many
18430 * many many objects. Thus, the more objects you keep active, the more
18431 * overhead Evas has in just doing its work. It is advisable to keep your
18432 * active objects to the minimum working set you need. Also remember that
18433 * object creation and deletion carries an overhead, so there is a
18434 * middle-ground, which is not easily determined. But don't keep massive lists
18435 * of objects you can't see or use. Genlist does this with list objects. It
18436 * creates and destroys them dynamically as you scroll around. It groups them
18437 * into blocks so it can determine the visibility etc. of a whole block at
18438 * once as opposed to having to walk the whole list. This 2-level list allows
18439 * for very large numbers of items to be in the list (tests have used up to
18440 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18441 * may be different sizes, every item added needs to be calculated as to its
18442 * size and thus this presents a lot of overhead on populating the list, this
18443 * genlist employs a queue. Any item added is queued and spooled off over
18444 * time, actually appearing some time later, so if your list has many members
18445 * you may find it takes a while for them to all appear, with your process
18446 * consuming a lot of CPU while it is busy spooling.
18448 * Genlist also implements a tree structure, but it does so with callbacks to
18449 * the application, with the application filling in tree structures when
18450 * requested (allowing for efficient building of a very deep tree that could
18451 * even be used for file-management). See the above smart signal callbacks for
18454 * @section Genlist_Smart_Events Genlist smart events
18456 * Signals that you can add callbacks for are:
18457 * - @c "activated" - The user has double-clicked or pressed
18458 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18459 * item that was activated.
18460 * - @c "clicked,double" - The user has double-clicked an item. The @c
18461 * event_info parameter is the item that was double-clicked.
18462 * - @c "selected" - This is called when a user has made an item selected.
18463 * The event_info parameter is the genlist item that was selected.
18464 * - @c "unselected" - This is called when a user has made an item
18465 * unselected. The event_info parameter is the genlist item that was
18467 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18468 * called and the item is now meant to be expanded. The event_info
18469 * parameter is the genlist item that was indicated to expand. It is the
18470 * job of this callback to then fill in the child items.
18471 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18472 * called and the item is now meant to be contracted. The event_info
18473 * parameter is the genlist item that was indicated to contract. It is the
18474 * job of this callback to then delete the child items.
18475 * - @c "expand,request" - This is called when a user has indicated they want
18476 * to expand a tree branch item. The callback should decide if the item can
18477 * expand (has any children) and then call elm_genlist_item_expanded_set()
18478 * appropriately to set the state. The event_info parameter is the genlist
18479 * item that was indicated to expand.
18480 * - @c "contract,request" - This is called when a user has indicated they
18481 * want to contract a tree branch item. The callback should decide if the
18482 * item can contract (has any children) and then call
18483 * elm_genlist_item_expanded_set() appropriately to set the state. The
18484 * event_info parameter is the genlist item that was indicated to contract.
18485 * - @c "realized" - This is called when the item in the list is created as a
18486 * real evas object. event_info parameter is the genlist item that was
18487 * created. The object may be deleted at any time, so it is up to the
18488 * caller to not use the object pointer from elm_genlist_item_object_get()
18489 * in a way where it may point to freed objects.
18490 * - @c "unrealized" - This is called just before an item is unrealized.
18491 * After this call content objects provided will be deleted and the item
18492 * object itself delete or be put into a floating cache.
18493 * - @c "drag,start,up" - This is called when the item in the list has been
18494 * dragged (not scrolled) up.
18495 * - @c "drag,start,down" - This is called when the item in the list has been
18496 * dragged (not scrolled) down.
18497 * - @c "drag,start,left" - This is called when the item in the list has been
18498 * dragged (not scrolled) left.
18499 * - @c "drag,start,right" - This is called when the item in the list has
18500 * been dragged (not scrolled) right.
18501 * - @c "drag,stop" - This is called when the item in the list has stopped
18503 * - @c "drag" - This is called when the item in the list is being dragged.
18504 * - @c "longpressed" - This is called when the item is pressed for a certain
18505 * amount of time. By default it's 1 second.
18506 * - @c "scroll,anim,start" - This is called when scrolling animation has
18508 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18510 * - @c "scroll,drag,start" - This is called when dragging the content has
18512 * - @c "scroll,drag,stop" - This is called when dragging the content has
18514 * - @c "edge,top" - This is called when the genlist is scrolled until
18516 * - @c "edge,bottom" - This is called when the genlist is scrolled
18517 * until the bottom edge.
18518 * - @c "edge,left" - This is called when the genlist is scrolled
18519 * until the left edge.
18520 * - @c "edge,right" - This is called when the genlist is scrolled
18521 * until the right edge.
18522 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18524 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18526 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18528 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18530 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18531 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18532 * multi-touch pinched in.
18533 * - @c "swipe" - This is called when the genlist is swiped.
18534 * - @c "moved" - This is called when a genlist item is moved.
18535 * - @c "language,changed" - This is called when the program's language is
18538 * @section Genlist_Examples Examples
18540 * Here is a list of examples that use the genlist, trying to show some of
18541 * its capabilities:
18542 * - @ref genlist_example_01
18543 * - @ref genlist_example_02
18544 * - @ref genlist_example_03
18545 * - @ref genlist_example_04
18546 * - @ref genlist_example_05
18550 * @addtogroup Genlist
18555 * @enum _Elm_Genlist_Item_Flags
18556 * @typedef Elm_Genlist_Item_Flags
18558 * Defines if the item is of any special type (has subitems or it's the
18559 * index of a group), or is just a simple item.
18563 typedef enum _Elm_Genlist_Item_Flags
18565 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18566 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18567 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18568 } Elm_Genlist_Item_Flags;
18569 typedef enum _Elm_Genlist_Item_Field_Flags
18571 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18572 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18573 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
18574 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18575 } Elm_Genlist_Item_Field_Flags;
18576 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18577 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18578 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18579 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18580 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18582 * Text fetching class function for Elm_Gen_Item_Class.
18583 * @param data The data passed in the item creation function
18584 * @param obj The base widget object
18585 * @param part The part name of the swallow
18586 * @return The allocated (NOT stringshared) string to set as the text
18588 typedef char *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18590 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18591 * @param data The data passed in the item creation function
18592 * @param obj The base widget object
18593 * @param part The part name of the swallow
18594 * @return The content object to swallow
18596 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18598 * State fetching class function for Elm_Gen_Item_Class.
18599 * @param data The data passed in the item creation function
18600 * @param obj The base widget object
18601 * @param part The part name of the swallow
18602 * @return The hell if I know
18604 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18606 * Deletion class function for Elm_Gen_Item_Class.
18607 * @param data The data passed in the item creation function
18608 * @param obj The base widget object
18610 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18613 * @struct _Elm_Genlist_Item_Class
18615 * Genlist item class definition structs.
18617 * This struct contains the style and fetching functions that will define the
18618 * contents of each item.
18620 * @see @ref Genlist_Item_Class
18622 struct _Elm_Genlist_Item_Class
18624 const char *item_style; /**< style of this class. */
18625 struct Elm_Genlist_Item_Class_Func
18627 Elm_Genlist_Item_Text_Get_Cb text_get; /**< Text fetching class function for genlist item classes.*/
18628 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18629 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18630 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18633 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18635 * Add a new genlist widget to the given parent Elementary
18636 * (container) object
18638 * @param parent The parent object
18639 * @return a new genlist widget handle or @c NULL, on errors
18641 * This function inserts a new genlist widget on the canvas.
18643 * @see elm_genlist_item_append()
18644 * @see elm_genlist_item_del()
18645 * @see elm_genlist_clear()
18649 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18651 * Remove all items from a given genlist widget.
18653 * @param obj The genlist object
18655 * This removes (and deletes) all items in @p obj, leaving it empty.
18657 * @see elm_genlist_item_del(), to remove just one item.
18661 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18663 * Enable or disable multi-selection in the genlist
18665 * @param obj The genlist object
18666 * @param multi Multi-select enable/disable. Default is disabled.
18668 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18669 * the list. This allows more than 1 item to be selected. To retrieve the list
18670 * of selected items, use elm_genlist_selected_items_get().
18672 * @see elm_genlist_selected_items_get()
18673 * @see elm_genlist_multi_select_get()
18677 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18679 * Gets if multi-selection in genlist is enabled or disabled.
18681 * @param obj The genlist object
18682 * @return Multi-select enabled/disabled
18683 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18685 * @see elm_genlist_multi_select_set()
18689 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18691 * This sets the horizontal stretching mode.
18693 * @param obj The genlist object
18694 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18696 * This sets the mode used for sizing items horizontally. Valid modes
18697 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18698 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18699 * the scroller will scroll horizontally. Otherwise items are expanded
18700 * to fill the width of the viewport of the scroller. If it is
18701 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18702 * limited to that size.
18704 * @see elm_genlist_horizontal_get()
18708 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18709 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18711 * Gets the horizontal stretching mode.
18713 * @param obj The genlist object
18714 * @return The mode to use
18715 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18717 * @see elm_genlist_horizontal_set()
18721 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18722 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18724 * Set the always select mode.
18726 * @param obj The genlist object
18727 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18728 * EINA_FALSE = off). Default is @c EINA_FALSE.
18730 * Items will only call their selection func and callback when first
18731 * becoming selected. Any further clicks will do nothing, unless you
18732 * enable always select with elm_genlist_always_select_mode_set().
18733 * This means that, even if selected, every click will make the selected
18734 * callbacks be called.
18736 * @see elm_genlist_always_select_mode_get()
18740 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18742 * Get the always select mode.
18744 * @param obj The genlist object
18745 * @return The always select mode
18746 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18748 * @see elm_genlist_always_select_mode_set()
18752 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18754 * Enable/disable the no select mode.
18756 * @param obj The genlist object
18757 * @param no_select The no select mode
18758 * (EINA_TRUE = on, EINA_FALSE = off)
18760 * This will turn off the ability to select items entirely and they
18761 * will neither appear selected nor call selected callback functions.
18763 * @see elm_genlist_no_select_mode_get()
18767 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18769 * Gets whether the no select mode is enabled.
18771 * @param obj The genlist object
18772 * @return The no select mode
18773 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18775 * @see elm_genlist_no_select_mode_set()
18779 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18781 * Enable/disable compress mode.
18783 * @param obj The genlist object
18784 * @param compress The compress mode
18785 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18787 * This will enable the compress mode where items are "compressed"
18788 * horizontally to fit the genlist scrollable viewport width. This is
18789 * special for genlist. Do not rely on
18790 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18791 * work as genlist needs to handle it specially.
18793 * @see elm_genlist_compress_mode_get()
18797 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18799 * Get whether the compress mode is enabled.
18801 * @param obj The genlist object
18802 * @return The compress mode
18803 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18805 * @see elm_genlist_compress_mode_set()
18809 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18811 * Enable/disable height-for-width mode.
18813 * @param obj The genlist object
18814 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18815 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18817 * With height-for-width mode the item width will be fixed (restricted
18818 * to a minimum of) to the list width when calculating its size in
18819 * order to allow the height to be calculated based on it. This allows,
18820 * for instance, text block to wrap lines if the Edje part is
18821 * configured with "text.min: 0 1".
18823 * @note This mode will make list resize slower as it will have to
18824 * recalculate every item height again whenever the list width
18827 * @note When height-for-width mode is enabled, it also enables
18828 * compress mode (see elm_genlist_compress_mode_set()) and
18829 * disables homogeneous (see elm_genlist_homogeneous_set()).
18833 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18835 * Get whether the height-for-width mode is enabled.
18837 * @param obj The genlist object
18838 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18843 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18845 * Enable/disable horizontal and vertical bouncing effect.
18847 * @param obj The genlist object
18848 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18849 * EINA_FALSE = off). Default is @c EINA_FALSE.
18850 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18851 * EINA_FALSE = off). Default is @c EINA_TRUE.
18853 * This will enable or disable the scroller bouncing effect for the
18854 * genlist. See elm_scroller_bounce_set() for details.
18856 * @see elm_scroller_bounce_set()
18857 * @see elm_genlist_bounce_get()
18861 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18863 * Get whether the horizontal and vertical bouncing effect is enabled.
18865 * @param obj The genlist object
18866 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18868 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18871 * @see elm_genlist_bounce_set()
18875 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18877 * Enable/disable homogeneous mode.
18879 * @param obj The genlist object
18880 * @param homogeneous Assume the items within the genlist are of the
18881 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18884 * This will enable the homogeneous mode where items are of the same
18885 * height and width so that genlist may do the lazy-loading at its
18886 * maximum (which increases the performance for scrolling the list). This
18887 * implies 'compressed' mode.
18889 * @see elm_genlist_compress_mode_set()
18890 * @see elm_genlist_homogeneous_get()
18894 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18896 * Get whether the homogeneous mode is enabled.
18898 * @param obj The genlist object
18899 * @return Assume the items within the genlist are of the same height
18900 * and width (EINA_TRUE = on, EINA_FALSE = off)
18902 * @see elm_genlist_homogeneous_set()
18906 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18908 * Set the maximum number of items within an item block
18910 * @param obj The genlist object
18911 * @param n Maximum number of items within an item block. Default is 32.
18913 * This will configure the block count to tune to the target with
18914 * particular performance matrix.
18916 * A block of objects will be used to reduce the number of operations due to
18917 * many objects in the screen. It can determine the visibility, or if the
18918 * object has changed, it theme needs to be updated, etc. doing this kind of
18919 * calculation to the entire block, instead of per object.
18921 * The default value for the block count is enough for most lists, so unless
18922 * you know you will have a lot of objects visible in the screen at the same
18923 * time, don't try to change this.
18925 * @see elm_genlist_block_count_get()
18926 * @see @ref Genlist_Implementation
18930 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18932 * Get the maximum number of items within an item block
18934 * @param obj The genlist object
18935 * @return Maximum number of items within an item block
18937 * @see elm_genlist_block_count_set()
18941 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18943 * Set the timeout in seconds for the longpress event.
18945 * @param obj The genlist object
18946 * @param timeout timeout in seconds. Default is 1.
18948 * This option will change how long it takes to send an event "longpressed"
18949 * after the mouse down signal is sent to the list. If this event occurs, no
18950 * "clicked" event will be sent.
18952 * @see elm_genlist_longpress_timeout_set()
18956 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18958 * Get the timeout in seconds for the longpress event.
18960 * @param obj The genlist object
18961 * @return timeout in seconds
18963 * @see elm_genlist_longpress_timeout_get()
18967 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18969 * Append a new item in a given genlist widget.
18971 * @param obj The genlist object
18972 * @param itc The item class for the item
18973 * @param data The item data
18974 * @param parent The parent item, or NULL if none
18975 * @param flags Item flags
18976 * @param func Convenience function called when the item is selected
18977 * @param func_data Data passed to @p func above.
18978 * @return A handle to the item added or @c NULL if not possible
18980 * This adds the given item to the end of the list or the end of
18981 * the children list if the @p parent is given.
18983 * @see elm_genlist_item_prepend()
18984 * @see elm_genlist_item_insert_before()
18985 * @see elm_genlist_item_insert_after()
18986 * @see elm_genlist_item_del()
18990 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);
18992 * Prepend a new item in a given genlist widget.
18994 * @param obj The genlist object
18995 * @param itc The item class for the item
18996 * @param data The item data
18997 * @param parent The parent item, or NULL if none
18998 * @param flags Item flags
18999 * @param func Convenience function called when the item is selected
19000 * @param func_data Data passed to @p func above.
19001 * @return A handle to the item added or NULL if not possible
19003 * This adds an item to the beginning of the list or beginning of the
19004 * children of the parent if given.
19006 * @see elm_genlist_item_append()
19007 * @see elm_genlist_item_insert_before()
19008 * @see elm_genlist_item_insert_after()
19009 * @see elm_genlist_item_del()
19013 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);
19015 * Insert an item before another in a genlist widget
19017 * @param obj The genlist object
19018 * @param itc The item class for the item
19019 * @param data The item data
19020 * @param before The item to place this new one before.
19021 * @param flags Item flags
19022 * @param func Convenience function called when the item is selected
19023 * @param func_data Data passed to @p func above.
19024 * @return A handle to the item added or @c NULL if not possible
19026 * This inserts an item before another in the list. It will be in the
19027 * same tree level or group as the item it is inserted before.
19029 * @see elm_genlist_item_append()
19030 * @see elm_genlist_item_prepend()
19031 * @see elm_genlist_item_insert_after()
19032 * @see elm_genlist_item_del()
19036 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);
19038 * Insert an item after another in a genlist widget
19040 * @param obj The genlist object
19041 * @param itc The item class for the item
19042 * @param data The item data
19043 * @param after The item to place this new one after.
19044 * @param flags Item flags
19045 * @param func Convenience function called when the item is selected
19046 * @param func_data Data passed to @p func above.
19047 * @return A handle to the item added or @c NULL if not possible
19049 * This inserts an item after another in the list. It will be in the
19050 * same tree level or group as the item it is inserted after.
19052 * @see elm_genlist_item_append()
19053 * @see elm_genlist_item_prepend()
19054 * @see elm_genlist_item_insert_before()
19055 * @see elm_genlist_item_del()
19059 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);
19061 * Insert a new item into the sorted genlist object
19063 * @param obj The genlist object
19064 * @param itc The item class for the item
19065 * @param data The item data
19066 * @param parent The parent item, or NULL if none
19067 * @param flags Item flags
19068 * @param comp The function called for the sort
19069 * @param func Convenience function called when item selected
19070 * @param func_data Data passed to @p func above.
19071 * @return A handle to the item added or NULL if not possible
19075 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);
19076 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);
19077 /* operations to retrieve existing items */
19079 * Get the selectd item in the genlist.
19081 * @param obj The genlist object
19082 * @return The selected item, or NULL if none is selected.
19084 * This gets the selected item in the list (if multi-selection is enabled, only
19085 * the item that was first selected in the list is returned - which is not very
19086 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19089 * If no item is selected, NULL is returned.
19091 * @see elm_genlist_selected_items_get()
19095 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19097 * Get a list of selected items in the genlist.
19099 * @param obj The genlist object
19100 * @return The list of selected items, or NULL if none are selected.
19102 * It returns a list of the selected items. This list pointer is only valid so
19103 * long as the selection doesn't change (no items are selected or unselected, or
19104 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19105 * pointers. The order of the items in this list is the order which they were
19106 * selected, i.e. the first item in this list is the first item that was
19107 * selected, and so on.
19109 * @note If not in multi-select mode, consider using function
19110 * elm_genlist_selected_item_get() instead.
19112 * @see elm_genlist_multi_select_set()
19113 * @see elm_genlist_selected_item_get()
19117 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19119 * Get the mode item style of items in the genlist
19120 * @param obj The genlist object
19121 * @return The mode item style string, or NULL if none is specified
19123 * This is a constant string and simply defines the name of the
19124 * style that will be used for mode animations. It can be
19125 * @c NULL if you don't plan to use Genlist mode. See
19126 * elm_genlist_item_mode_set() for more info.
19130 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19132 * Set the mode item style of items in the genlist
19133 * @param obj The genlist object
19134 * @param style The mode item style string, or NULL if none is desired
19136 * This is a constant string and simply defines the name of the
19137 * style that will be used for mode animations. It can be
19138 * @c NULL if you don't plan to use Genlist mode. See
19139 * elm_genlist_item_mode_set() for more info.
19143 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19145 * Get a list of realized items in genlist
19147 * @param obj The genlist object
19148 * @return The list of realized items, nor NULL if none are realized.
19150 * This returns a list of the realized items in the genlist. The list
19151 * contains Elm_Genlist_Item pointers. The list must be freed by the
19152 * caller when done with eina_list_free(). The item pointers in the
19153 * list are only valid so long as those items are not deleted or the
19154 * genlist is not deleted.
19156 * @see elm_genlist_realized_items_update()
19160 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19162 * Get the item that is at the x, y canvas coords.
19164 * @param obj The gelinst object.
19165 * @param x The input x coordinate
19166 * @param y The input y coordinate
19167 * @param posret The position relative to the item returned here
19168 * @return The item at the coordinates or NULL if none
19170 * This returns the item at the given coordinates (which are canvas
19171 * relative, not object-relative). If an item is at that coordinate,
19172 * that item handle is returned, and if @p posret is not NULL, the
19173 * integer pointed to is set to a value of -1, 0 or 1, depending if
19174 * the coordinate is on the upper portion of that item (-1), on the
19175 * middle section (0) or on the lower part (1). If NULL is returned as
19176 * an item (no item found there), then posret may indicate -1 or 1
19177 * based if the coordinate is above or below all items respectively in
19182 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);
19184 * Get the first item in the genlist
19186 * This returns the first item in the list.
19188 * @param obj The genlist object
19189 * @return The first item, or NULL if none
19193 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19195 * Get the last item in the genlist
19197 * This returns the last item in the list.
19199 * @return The last item, or NULL if none
19203 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19205 * Set the scrollbar policy
19207 * @param obj The genlist object
19208 * @param policy_h Horizontal scrollbar policy.
19209 * @param policy_v Vertical scrollbar policy.
19211 * This sets the scrollbar visibility policy for the given genlist
19212 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19213 * made visible if it is needed, and otherwise kept hidden.
19214 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19215 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19216 * respectively for the horizontal and vertical scrollbars. Default is
19217 * #ELM_SMART_SCROLLER_POLICY_AUTO
19219 * @see elm_genlist_scroller_policy_get()
19223 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19225 * Get the scrollbar policy
19227 * @param obj The genlist object
19228 * @param policy_h Pointer to store the horizontal scrollbar policy.
19229 * @param policy_v Pointer to store the vertical scrollbar policy.
19231 * @see elm_genlist_scroller_policy_set()
19235 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);
19237 * Get the @b next item in a genlist widget's internal list of items,
19238 * given a handle to one of those items.
19240 * @param item The genlist item to fetch next from
19241 * @return The item after @p item, or @c NULL if there's none (and
19244 * This returns the item placed after the @p item, on the container
19247 * @see elm_genlist_item_prev_get()
19251 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19253 * Get the @b previous item in a genlist widget's internal list of items,
19254 * given a handle to one of those items.
19256 * @param item The genlist item to fetch previous from
19257 * @return The item before @p item, or @c NULL if there's none (and
19260 * This returns the item placed before the @p item, on the container
19263 * @see elm_genlist_item_next_get()
19267 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19269 * Get the genlist object's handle which contains a given genlist
19272 * @param item The item to fetch the container from
19273 * @return The genlist (parent) object
19275 * This returns the genlist object itself that an item belongs to.
19279 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19281 * Get the parent item of the given item
19283 * @param it The item
19284 * @return The parent of the item or @c NULL if it has no parent.
19286 * This returns the item that was specified as parent of the item @p it on
19287 * elm_genlist_item_append() and insertion related functions.
19291 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19293 * Remove all sub-items (children) of the given item
19295 * @param it The item
19297 * This removes all items that are children (and their descendants) of the
19298 * given item @p it.
19300 * @see elm_genlist_clear()
19301 * @see elm_genlist_item_del()
19305 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19307 * Set whether a given genlist item is selected or not
19309 * @param it The item
19310 * @param selected Use @c EINA_TRUE, to make it selected, @c
19311 * EINA_FALSE to make it unselected
19313 * This sets the selected state of an item. If multi selection is
19314 * not enabled on the containing genlist and @p selected is @c
19315 * EINA_TRUE, any other previously selected items will get
19316 * unselected in favor of this new one.
19318 * @see elm_genlist_item_selected_get()
19322 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19324 * Get whether a given genlist item is selected or not
19326 * @param it The item
19327 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19329 * @see elm_genlist_item_selected_set() for more details
19333 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19335 * Sets the expanded state of an item.
19337 * @param it The item
19338 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19340 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19343 * The theme will respond to this change visually, and a signal "expanded" or
19344 * "contracted" will be sent from the genlist with a pointer to the item that
19345 * has been expanded/contracted.
19347 * Calling this function won't show or hide any child of this item (if it is
19348 * a parent). You must manually delete and create them on the callbacks fo
19349 * the "expanded" or "contracted" signals.
19351 * @see elm_genlist_item_expanded_get()
19355 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19357 * Get the expanded state of an item
19359 * @param it The item
19360 * @return The expanded state
19362 * This gets the expanded state of an item.
19364 * @see elm_genlist_item_expanded_set()
19368 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19370 * Get the depth of expanded item
19372 * @param it The genlist item object
19373 * @return The depth of expanded item
19377 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19379 * Set whether a given genlist item is disabled or not.
19381 * @param it The item
19382 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19383 * to enable it back.
19385 * A disabled item cannot be selected or unselected. It will also
19386 * change its appearance, to signal the user it's disabled.
19388 * @see elm_genlist_item_disabled_get()
19392 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19394 * Get whether a given genlist item is disabled or not.
19396 * @param it The item
19397 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19400 * @see elm_genlist_item_disabled_set() for more details
19404 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19406 * Sets the display only state of an item.
19408 * @param it The item
19409 * @param display_only @c EINA_TRUE if the item is display only, @c
19410 * EINA_FALSE otherwise.
19412 * A display only item cannot be selected or unselected. It is for
19413 * display only and not selecting or otherwise clicking, dragging
19414 * etc. by the user, thus finger size rules will not be applied to
19417 * It's good to set group index items to display only state.
19419 * @see elm_genlist_item_display_only_get()
19423 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19425 * Get the display only state of an item
19427 * @param it The item
19428 * @return @c EINA_TRUE if the item is display only, @c
19429 * EINA_FALSE otherwise.
19431 * @see elm_genlist_item_display_only_set()
19435 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19437 * Show the portion of a genlist's internal list containing a given
19438 * item, immediately.
19440 * @param it The item to display
19442 * This causes genlist to jump to the given item @p it and show it (by
19443 * immediately scrolling to that position), if it is not fully visible.
19445 * @see elm_genlist_item_bring_in()
19446 * @see elm_genlist_item_top_show()
19447 * @see elm_genlist_item_middle_show()
19451 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19453 * Animatedly bring in, to the visible are of a genlist, a given
19456 * @param it The item to display
19458 * This causes genlist to jump to the given item @p it and show it (by
19459 * animatedly scrolling), if it is not fully visible. This may use animation
19460 * to do so and take a period of time
19462 * @see elm_genlist_item_show()
19463 * @see elm_genlist_item_top_bring_in()
19464 * @see elm_genlist_item_middle_bring_in()
19468 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19470 * Show the portion of a genlist's internal list containing a given
19471 * item, immediately.
19473 * @param it The item to display
19475 * This causes genlist to jump to the given item @p it and show it (by
19476 * immediately scrolling to that position), if it is not fully visible.
19478 * The item will be positioned at the top of the genlist viewport.
19480 * @see elm_genlist_item_show()
19481 * @see elm_genlist_item_top_bring_in()
19485 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19487 * Animatedly bring in, to the visible are of a genlist, a given
19490 * @param it The item
19492 * This causes genlist to jump to the given item @p it and show it (by
19493 * animatedly scrolling), if it is not fully visible. This may use animation
19494 * to do so and take a period of time
19496 * The item will be positioned at the top of the genlist viewport.
19498 * @see elm_genlist_item_bring_in()
19499 * @see elm_genlist_item_top_show()
19503 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19505 * Show the portion of a genlist's internal list containing a given
19506 * item, immediately.
19508 * @param it The item to display
19510 * This causes genlist to jump to the given item @p it and show it (by
19511 * immediately scrolling to that position), if it is not fully visible.
19513 * The item will be positioned at the middle of the genlist viewport.
19515 * @see elm_genlist_item_show()
19516 * @see elm_genlist_item_middle_bring_in()
19520 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19522 * Animatedly bring in, to the visible are of a genlist, a given
19525 * @param it The item
19527 * This causes genlist to jump to the given item @p it and show it (by
19528 * animatedly scrolling), if it is not fully visible. This may use animation
19529 * to do so and take a period of time
19531 * The item will be positioned at the middle of the genlist viewport.
19533 * @see elm_genlist_item_bring_in()
19534 * @see elm_genlist_item_middle_show()
19538 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19540 * Remove a genlist item from the its parent, deleting it.
19542 * @param item The item to be removed.
19543 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19545 * @see elm_genlist_clear(), to remove all items in a genlist at
19550 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19552 * Return the data associated to a given genlist item
19554 * @param item The genlist item.
19555 * @return the data associated to this item.
19557 * This returns the @c data value passed on the
19558 * elm_genlist_item_append() and related item addition calls.
19560 * @see elm_genlist_item_append()
19561 * @see elm_genlist_item_data_set()
19565 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19567 * Set the data associated to a given genlist item
19569 * @param item The genlist item
19570 * @param data The new data pointer to set on it
19572 * This @b overrides the @c data value passed on the
19573 * elm_genlist_item_append() and related item addition calls. This
19574 * function @b won't call elm_genlist_item_update() automatically,
19575 * so you'd issue it afterwards if you want to hove the item
19576 * updated to reflect the that new data.
19578 * @see elm_genlist_item_data_get()
19582 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19584 * Tells genlist to "orphan" contents fetchs by the item class
19586 * @param it The item
19588 * This instructs genlist to release references to contents in the item,
19589 * meaning that they will no longer be managed by genlist and are
19590 * floating "orphans" that can be re-used elsewhere if the user wants
19595 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19596 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19598 * Get the real Evas object created to implement the view of a
19599 * given genlist item
19601 * @param item The genlist item.
19602 * @return the Evas object implementing this item's view.
19604 * This returns the actual Evas object used to implement the
19605 * specified genlist item's view. This may be @c NULL, as it may
19606 * not have been created or may have been deleted, at any time, by
19607 * the genlist. <b>Do not modify this object</b> (move, resize,
19608 * show, hide, etc.), as the genlist is controlling it. This
19609 * function is for querying, emitting custom signals or hooking
19610 * lower level callbacks for events on that object. Do not delete
19611 * this object under any circumstances.
19613 * @see elm_genlist_item_data_get()
19617 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19619 * Update the contents of an item
19621 * @param it The item
19623 * This updates an item by calling all the item class functions again
19624 * to get the contents, texts and states. Use this when the original
19625 * item data has changed and the changes are desired to be reflected.
19627 * Use elm_genlist_realized_items_update() to update all already realized
19630 * @see elm_genlist_realized_items_update()
19634 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19636 * Promote an item to the top of the list
19638 * @param it The item
19642 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19644 * Demote an item to the end of the list
19646 * @param it The item
19650 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19652 * Update the part of an item
19654 * @param it The item
19655 * @param parts The name of item's part
19656 * @param itf The flags of item's part type
19658 * This updates an item's part by calling item's fetching functions again
19659 * to get the contents, texts and states. Use this when the original
19660 * item data has changed and the changes are desired to be reflected.
19661 * Second parts argument is used for globbing to match '*', '?', and '.'
19662 * It can be used at updating multi fields.
19664 * Use elm_genlist_realized_items_update() to update an item's all
19667 * @see elm_genlist_item_update()
19671 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19673 * Update the item class of an item
19675 * @param it The item
19676 * @param itc The item class for the item
19678 * This sets another class fo the item, changing the way that it is
19679 * displayed. After changing the item class, elm_genlist_item_update() is
19680 * called on the item @p it.
19684 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19685 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19687 * Set the text to be shown in a given genlist item's tooltips.
19689 * @param item The genlist item
19690 * @param text The text to set in the content
19692 * This call will setup the text to be used as tooltip to that item
19693 * (analogous to elm_object_tooltip_text_set(), but being item
19694 * tooltips with higher precedence than object tooltips). It can
19695 * have only one tooltip at a time, so any previous tooltip data
19696 * will get removed.
19698 * In order to set a content or something else as a tooltip, look at
19699 * elm_genlist_item_tooltip_content_cb_set().
19703 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19705 * Set the content to be shown in a given genlist item's tooltips
19707 * @param item The genlist item.
19708 * @param func The function returning the tooltip contents.
19709 * @param data What to provide to @a func as callback data/context.
19710 * @param del_cb Called when data is not needed anymore, either when
19711 * another callback replaces @p func, the tooltip is unset with
19712 * elm_genlist_item_tooltip_unset() or the owner @p item
19713 * dies. This callback receives as its first parameter the
19714 * given @p data, being @c event_info the item handle.
19716 * This call will setup the tooltip's contents to @p item
19717 * (analogous to elm_object_tooltip_content_cb_set(), but being
19718 * item tooltips with higher precedence than object tooltips). It
19719 * can have only one tooltip at a time, so any previous tooltip
19720 * content will get removed. @p func (with @p data) will be called
19721 * every time Elementary needs to show the tooltip and it should
19722 * return a valid Evas object, which will be fully managed by the
19723 * tooltip system, getting deleted when the tooltip is gone.
19725 * In order to set just a text as a tooltip, look at
19726 * elm_genlist_item_tooltip_text_set().
19730 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);
19732 * Unset a tooltip from a given genlist item
19734 * @param item genlist item to remove a previously set tooltip from.
19736 * This call removes any tooltip set on @p item. The callback
19737 * provided as @c del_cb to
19738 * elm_genlist_item_tooltip_content_cb_set() will be called to
19739 * notify it is not used anymore (and have resources cleaned, if
19742 * @see elm_genlist_item_tooltip_content_cb_set()
19746 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19748 * Set a different @b style for a given genlist item's tooltip.
19750 * @param item genlist item with tooltip set
19751 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19752 * "default", @c "transparent", etc)
19754 * Tooltips can have <b>alternate styles</b> to be displayed on,
19755 * which are defined by the theme set on Elementary. This function
19756 * works analogously as elm_object_tooltip_style_set(), but here
19757 * applied only to genlist item objects. The default style for
19758 * tooltips is @c "default".
19760 * @note before you set a style you should define a tooltip with
19761 * elm_genlist_item_tooltip_content_cb_set() or
19762 * elm_genlist_item_tooltip_text_set()
19764 * @see elm_genlist_item_tooltip_style_get()
19768 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19770 * Get the style set a given genlist item's tooltip.
19772 * @param item genlist item with tooltip already set on.
19773 * @return style the theme style in use, which defaults to
19774 * "default". If the object does not have a tooltip set,
19775 * then @c NULL is returned.
19777 * @see elm_genlist_item_tooltip_style_set() for more details
19781 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19783 * @brief Disable size restrictions on an object's tooltip
19784 * @param item The tooltip's anchor object
19785 * @param disable If EINA_TRUE, size restrictions are disabled
19786 * @return EINA_FALSE on failure, EINA_TRUE on success
19788 * This function allows a tooltip to expand beyond its parant window's canvas.
19789 * It will instead be limited only by the size of the display.
19791 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19793 * @brief Retrieve size restriction state of an object's tooltip
19794 * @param item The tooltip's anchor object
19795 * @return If EINA_TRUE, size restrictions are disabled
19797 * This function returns whether a tooltip is allowed to expand beyond
19798 * its parant window's canvas.
19799 * It will instead be limited only by the size of the display.
19801 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19803 * Set the type of mouse pointer/cursor decoration to be shown,
19804 * when the mouse pointer is over the given genlist widget item
19806 * @param item genlist item to customize cursor on
19807 * @param cursor the cursor type's name
19809 * This function works analogously as elm_object_cursor_set(), but
19810 * here the cursor's changing area is restricted to the item's
19811 * area, and not the whole widget's. Note that that item cursors
19812 * have precedence over widget cursors, so that a mouse over @p
19813 * item will always show cursor @p type.
19815 * If this function is called twice for an object, a previously set
19816 * cursor will be unset on the second call.
19818 * @see elm_object_cursor_set()
19819 * @see elm_genlist_item_cursor_get()
19820 * @see elm_genlist_item_cursor_unset()
19824 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19826 * Get the type of mouse pointer/cursor decoration set to be shown,
19827 * when the mouse pointer is over the given genlist widget item
19829 * @param item genlist item with custom cursor set
19830 * @return the cursor type's name or @c NULL, if no custom cursors
19831 * were set to @p item (and on errors)
19833 * @see elm_object_cursor_get()
19834 * @see elm_genlist_item_cursor_set() for more details
19835 * @see elm_genlist_item_cursor_unset()
19839 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19841 * Unset any custom mouse pointer/cursor decoration set to be
19842 * shown, when the mouse pointer is over the given genlist widget
19843 * item, thus making it show the @b default cursor again.
19845 * @param item a genlist item
19847 * Use this call to undo any custom settings on this item's cursor
19848 * decoration, bringing it back to defaults (no custom style set).
19850 * @see elm_object_cursor_unset()
19851 * @see elm_genlist_item_cursor_set() for more details
19855 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19857 * Set a different @b style for a given custom cursor set for a
19860 * @param item genlist item with custom cursor set
19861 * @param style the <b>theme style</b> to use (e.g. @c "default",
19862 * @c "transparent", etc)
19864 * This function only makes sense when one is using custom mouse
19865 * cursor decorations <b>defined in a theme file</b> , which can
19866 * have, given a cursor name/type, <b>alternate styles</b> on
19867 * it. It works analogously as elm_object_cursor_style_set(), but
19868 * here applied only to genlist item objects.
19870 * @warning Before you set a cursor style you should have defined a
19871 * custom cursor previously on the item, with
19872 * elm_genlist_item_cursor_set()
19874 * @see elm_genlist_item_cursor_engine_only_set()
19875 * @see elm_genlist_item_cursor_style_get()
19879 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19881 * Get the current @b style set for a given genlist item's custom
19884 * @param item genlist item with custom cursor set.
19885 * @return style the cursor style in use. If the object does not
19886 * have a cursor set, then @c NULL is returned.
19888 * @see elm_genlist_item_cursor_style_set() for more details
19892 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19894 * Set if the (custom) cursor for a given genlist item should be
19895 * searched in its theme, also, or should only rely on the
19896 * rendering engine.
19898 * @param item item with custom (custom) cursor already set on
19899 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19900 * only on those provided by the rendering engine, @c EINA_FALSE to
19901 * have them searched on the widget's theme, as well.
19903 * @note This call is of use only if you've set a custom cursor
19904 * for genlist items, with elm_genlist_item_cursor_set().
19906 * @note By default, cursors will only be looked for between those
19907 * provided by the rendering engine.
19911 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19913 * Get if the (custom) cursor for a given genlist item is being
19914 * searched in its theme, also, or is only relying on the rendering
19917 * @param item a genlist item
19918 * @return @c EINA_TRUE, if cursors are being looked for only on
19919 * those provided by the rendering engine, @c EINA_FALSE if they
19920 * are being searched on the widget's theme, as well.
19922 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19926 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19928 * Update the contents of all realized items.
19930 * @param obj The genlist object.
19932 * This updates all realized items by calling all the item class functions again
19933 * to get the contents, texts and states. Use this when the original
19934 * item data has changed and the changes are desired to be reflected.
19936 * To update just one item, use elm_genlist_item_update().
19938 * @see elm_genlist_realized_items_get()
19939 * @see elm_genlist_item_update()
19943 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19945 * Activate a genlist mode on an item
19947 * @param item The genlist item
19948 * @param mode Mode name
19949 * @param mode_set Boolean to define set or unset mode.
19951 * A genlist mode is a different way of selecting an item. Once a mode is
19952 * activated on an item, any other selected item is immediately unselected.
19953 * This feature provides an easy way of implementing a new kind of animation
19954 * for selecting an item, without having to entirely rewrite the item style
19955 * theme. However, the elm_genlist_selected_* API can't be used to get what
19956 * item is activate for a mode.
19958 * The current item style will still be used, but applying a genlist mode to
19959 * an item will select it using a different kind of animation.
19961 * The current active item for a mode can be found by
19962 * elm_genlist_mode_item_get().
19964 * The characteristics of genlist mode are:
19965 * - Only one mode can be active at any time, and for only one item.
19966 * - Genlist handles deactivating other items when one item is activated.
19967 * - A mode is defined in the genlist theme (edc), and more modes can easily
19969 * - A mode style and the genlist item style are different things. They
19970 * can be combined to provide a default style to the item, with some kind
19971 * of animation for that item when the mode is activated.
19973 * When a mode is activated on an item, a new view for that item is created.
19974 * The theme of this mode defines the animation that will be used to transit
19975 * the item from the old view to the new view. This second (new) view will be
19976 * active for that item while the mode is active on the item, and will be
19977 * destroyed after the mode is totally deactivated from that item.
19979 * @see elm_genlist_mode_get()
19980 * @see elm_genlist_mode_item_get()
19984 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19986 * Get the last (or current) genlist mode used.
19988 * @param obj The genlist object
19990 * This function just returns the name of the last used genlist mode. It will
19991 * be the current mode if it's still active.
19993 * @see elm_genlist_item_mode_set()
19994 * @see elm_genlist_mode_item_get()
19998 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20000 * Get active genlist mode item
20002 * @param obj The genlist object
20003 * @return The active item for that current mode. Or @c NULL if no item is
20004 * activated with any mode.
20006 * This function returns the item that was activated with a mode, by the
20007 * function elm_genlist_item_mode_set().
20009 * @see elm_genlist_item_mode_set()
20010 * @see elm_genlist_mode_get()
20014 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20019 * @param obj The genlist object
20020 * @param reorder_mode The reorder mode
20021 * (EINA_TRUE = on, EINA_FALSE = off)
20025 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20028 * Get the reorder mode
20030 * @param obj The genlist object
20031 * @return The reorder mode
20032 * (EINA_TRUE = on, EINA_FALSE = off)
20036 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20043 * @defgroup Check Check
20045 * @image html img/widget/check/preview-00.png
20046 * @image latex img/widget/check/preview-00.eps
20047 * @image html img/widget/check/preview-01.png
20048 * @image latex img/widget/check/preview-01.eps
20049 * @image html img/widget/check/preview-02.png
20050 * @image latex img/widget/check/preview-02.eps
20052 * @brief The check widget allows for toggling a value between true and
20055 * Check objects are a lot like radio objects in layout and functionality
20056 * except they do not work as a group, but independently and only toggle the
20057 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20058 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20059 * returns the current state. For convenience, like the radio objects, you
20060 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20061 * for it to modify.
20063 * Signals that you can add callbacks for are:
20064 * "changed" - This is called whenever the user changes the state of one of
20065 * the check object(event_info is NULL).
20067 * Default contents parts of the check widget that you can use for are:
20068 * @li "icon" - An icon of the check
20070 * Default text parts of the check widget that you can use for are:
20071 * @li "elm.text" - Label of the check
20073 * @ref tutorial_check should give you a firm grasp of how to use this widget
20078 * @brief Add a new Check object
20080 * @param parent The parent object
20081 * @return The new object or NULL if it cannot be created
20083 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20085 * @brief Set the text label of the check object
20087 * @param obj The check object
20088 * @param label The text label string in UTF-8
20090 * @deprecated use elm_object_text_set() instead.
20092 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20094 * @brief Get the text label of the check object
20096 * @param obj The check object
20097 * @return The text label string in UTF-8
20099 * @deprecated use elm_object_text_get() instead.
20101 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20103 * @brief Set the icon object of the check object
20105 * @param obj The check object
20106 * @param icon The icon object
20108 * Once the icon object is set, a previously set one will be deleted.
20109 * If you want to keep that old content object, use the
20110 * elm_object_content_unset() function.
20112 * @deprecated use elm_object_part_content_set() instead.
20115 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20117 * @brief Get the icon object of the check object
20119 * @param obj The check object
20120 * @return The icon object
20122 * @deprecated use elm_object_part_content_get() instead.
20125 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20127 * @brief Unset the icon used for the check object
20129 * @param obj The check object
20130 * @return The icon object that was being used
20132 * Unparent and return the icon object which was set for this widget.
20134 * @deprecated use elm_object_part_content_unset() instead.
20137 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20139 * @brief Set the on/off state of the check object
20141 * @param obj The check object
20142 * @param state The state to use (1 == on, 0 == off)
20144 * This sets the state of the check. If set
20145 * with elm_check_state_pointer_set() the state of that variable is also
20146 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20148 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20150 * @brief Get the state of the check object
20152 * @param obj The check object
20153 * @return The boolean state
20155 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20157 * @brief Set a convenience pointer to a boolean to change
20159 * @param obj The check object
20160 * @param statep Pointer to the boolean to modify
20162 * This sets a pointer to a boolean, that, in addition to the check objects
20163 * state will also be modified directly. To stop setting the object pointed
20164 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20165 * then when this is called, the check objects state will also be modified to
20166 * reflect the value of the boolean @p statep points to, just like calling
20167 * elm_check_state_set().
20169 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20170 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20171 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);
20178 * @defgroup Radio Radio
20180 * @image html img/widget/radio/preview-00.png
20181 * @image latex img/widget/radio/preview-00.eps
20183 * @brief Radio is a widget that allows for 1 or more options to be displayed
20184 * and have the user choose only 1 of them.
20186 * A radio object contains an indicator, an optional Label and an optional
20187 * icon object. While it's possible to have a group of only one radio they,
20188 * are normally used in groups of 2 or more. To add a radio to a group use
20189 * elm_radio_group_add(). The radio object(s) will select from one of a set
20190 * of integer values, so any value they are configuring needs to be mapped to
20191 * a set of integers. To configure what value that radio object represents,
20192 * use elm_radio_state_value_set() to set the integer it represents. To set
20193 * the value the whole group(which one is currently selected) is to indicate
20194 * use elm_radio_value_set() on any group member, and to get the groups value
20195 * use elm_radio_value_get(). For convenience the radio objects are also able
20196 * to directly set an integer(int) to the value that is selected. To specify
20197 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20198 * The radio objects will modify this directly. That implies the pointer must
20199 * point to valid memory for as long as the radio objects exist.
20201 * Signals that you can add callbacks for are:
20202 * @li changed - This is called whenever the user changes the state of one of
20203 * the radio objects within the group of radio objects that work together.
20205 * Default contents parts of the radio widget that you can use for are:
20206 * @li "icon" - An icon of the radio
20208 * @ref tutorial_radio show most of this API in action.
20212 * @brief Add a new radio to the parent
20214 * @param parent The parent object
20215 * @return The new object or NULL if it cannot be created
20217 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20219 * @brief Set the text label of the radio object
20221 * @param obj The radio object
20222 * @param label The text label string in UTF-8
20224 * @deprecated use elm_object_text_set() instead.
20226 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20228 * @brief Get the text label of the radio object
20230 * @param obj The radio object
20231 * @return The text label string in UTF-8
20233 * @deprecated use elm_object_text_set() instead.
20235 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20237 * @brief Set the icon object of the radio object
20239 * @param obj The radio object
20240 * @param icon The icon object
20242 * Once the icon object is set, a previously set one will be deleted. If you
20243 * want to keep that old content object, use the elm_radio_icon_unset()
20246 * @deprecated use elm_object_part_content_set() instead.
20249 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20251 * @brief Get the icon object of the radio object
20253 * @param obj The radio object
20254 * @return The icon object
20256 * @see elm_radio_icon_set()
20258 * @deprecated use elm_object_part_content_get() instead.
20261 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20263 * @brief Unset the icon used for the radio object
20265 * @param obj The radio object
20266 * @return The icon object that was being used
20268 * Unparent and return the icon object which was set for this widget.
20270 * @see elm_radio_icon_set()
20271 * @deprecated use elm_object_part_content_unset() instead.
20274 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20276 * @brief Add this radio to a group of other radio objects
20278 * @param obj The radio object
20279 * @param group Any object whose group the @p obj is to join.
20281 * Radio objects work in groups. Each member should have a different integer
20282 * value assigned. In order to have them work as a group, they need to know
20283 * about each other. This adds the given radio object to the group of which
20284 * the group object indicated is a member.
20286 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20288 * @brief Set the integer value that this radio object represents
20290 * @param obj The radio object
20291 * @param value The value to use if this radio object is selected
20293 * This sets the value of the radio.
20295 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20297 * @brief Get the integer value that this radio object represents
20299 * @param obj The radio object
20300 * @return The value used if this radio object is selected
20302 * This gets the value of the radio.
20304 * @see elm_radio_value_set()
20306 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20308 * @brief Set the value of the radio.
20310 * @param obj The radio object
20311 * @param value The value to use for the group
20313 * This sets the value of the radio group and will also set the value if
20314 * pointed to, to the value supplied, but will not call any callbacks.
20316 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20318 * @brief Get the state of the radio object
20320 * @param obj The radio object
20321 * @return The integer state
20323 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20325 * @brief Set a convenience pointer to a integer to change
20327 * @param obj The radio object
20328 * @param valuep Pointer to the integer to modify
20330 * This sets a pointer to a integer, that, in addition to the radio objects
20331 * state will also be modified directly. To stop setting the object pointed
20332 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20333 * when this is called, the radio objects state will also be modified to
20334 * reflect the value of the integer valuep points to, just like calling
20335 * elm_radio_value_set().
20337 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20343 * @defgroup Pager Pager
20345 * @image html img/widget/pager/preview-00.png
20346 * @image latex img/widget/pager/preview-00.eps
20348 * @brief Widget that allows flipping between one or more āpagesā
20351 * The flipping between pages of objects is animated. All content
20352 * in the pager is kept in a stack, being the last content added
20353 * (visible one) on the top of that stack.
20355 * Objects can be pushed or popped from the stack or deleted as
20356 * well. Pushes and pops will animate the widget accordingly to its
20357 * style (a pop will also delete the child object once the
20358 * animation is finished). Any object already in the pager can be
20359 * promoted to the top (from its current stacking position) through
20360 * the use of elm_pager_content_promote(). New objects are pushed
20361 * to the top with elm_pager_content_push(). When the top item is
20362 * no longer wanted, simply pop it with elm_pager_content_pop() and
20363 * it will also be deleted. If an object is no longer needed and is
20364 * not the top item, just delete it as normal. You can query which
20365 * objects are the top and bottom with
20366 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20368 * Signals that you can add callbacks for are:
20369 * - @c "show,finished" - when a new page is actually shown on the top
20370 * - @c "hide,finished" - when a previous page is hidden
20372 * Only after the first of that signals the child object is
20373 * guaranteed to be visible, as in @c evas_object_visible_get().
20375 * This widget has the following styles available:
20378 * - @c "fade_translucide"
20379 * - @c "fade_invisible"
20381 * @note These styles affect only the flipping animations on the
20382 * default theme; the appearance when not animating is unaffected
20385 * @ref tutorial_pager gives a good overview of the usage of the API.
20390 * Add a new pager to the parent
20392 * @param parent The parent object
20393 * @return The new object or NULL if it cannot be created
20397 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20400 * @brief Push an object to the top of the pager stack (and show it).
20402 * @param obj The pager object
20403 * @param content The object to push
20405 * The object pushed becomes a child of the pager, it will be controlled and
20406 * deleted when the pager is deleted.
20408 * @note If the content is already in the stack use
20409 * elm_pager_content_promote().
20410 * @warning Using this function on @p content already in the stack results in
20411 * undefined behavior.
20413 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20416 * @brief Pop the object that is on top of the stack
20418 * @param obj The pager object
20420 * This pops the object that is on the top(visible) of the pager, makes it
20421 * disappear, then deletes the object. The object that was underneath it on
20422 * the stack will become visible.
20424 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20427 * @brief Moves an object already in the pager stack to the top of the stack.
20429 * @param obj The pager object
20430 * @param content The object to promote
20432 * This will take the @p content and move it to the top of the stack as
20433 * if it had been pushed there.
20435 * @note If the content isn't already in the stack use
20436 * elm_pager_content_push().
20437 * @warning Using this function on @p content not already in the stack
20438 * results in undefined behavior.
20440 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20443 * @brief Return the object at the bottom of the pager stack
20445 * @param obj The pager object
20446 * @return The bottom object or NULL if none
20448 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20451 * @brief Return the object at the top of the pager stack
20453 * @param obj The pager object
20454 * @return The top object or NULL if none
20456 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20463 * @defgroup Slideshow Slideshow
20465 * @image html img/widget/slideshow/preview-00.png
20466 * @image latex img/widget/slideshow/preview-00.eps
20468 * This widget, as the name indicates, is a pre-made image
20469 * slideshow panel, with API functions acting on (child) image
20470 * items presentation. Between those actions, are:
20471 * - advance to next/previous image
20472 * - select the style of image transition animation
20473 * - set the exhibition time for each image
20474 * - start/stop the slideshow
20476 * The transition animations are defined in the widget's theme,
20477 * consequently new animations can be added without having to
20478 * update the widget's code.
20480 * @section Slideshow_Items Slideshow items
20482 * For slideshow items, just like for @ref Genlist "genlist" ones,
20483 * the user defines a @b classes, specifying functions that will be
20484 * called on the item's creation and deletion times.
20486 * The #Elm_Slideshow_Item_Class structure contains the following
20489 * - @c func.get - When an item is displayed, this function is
20490 * called, and it's where one should create the item object, de
20491 * facto. For example, the object can be a pure Evas image object
20492 * or an Elementary @ref Photocam "photocam" widget. See
20493 * #SlideshowItemGetFunc.
20494 * - @c func.del - When an item is no more displayed, this function
20495 * is called, where the user must delete any data associated to
20496 * the item. See #SlideshowItemDelFunc.
20498 * @section Slideshow_Caching Slideshow caching
20500 * The slideshow provides facilities to have items adjacent to the
20501 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20502 * you, so that the system does not have to decode image data
20503 * anymore at the time it has to actually switch images on its
20504 * viewport. The user is able to set the numbers of items to be
20505 * cached @b before and @b after the current item, in the widget's
20508 * Smart events one can add callbacks for are:
20510 * - @c "changed" - when the slideshow switches its view to a new
20513 * List of examples for the slideshow widget:
20514 * @li @ref slideshow_example
20518 * @addtogroup Slideshow
20522 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20523 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20524 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20525 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20526 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20529 * @struct _Elm_Slideshow_Item_Class
20531 * Slideshow item class definition. See @ref Slideshow_Items for
20534 struct _Elm_Slideshow_Item_Class
20536 struct _Elm_Slideshow_Item_Class_Func
20538 SlideshowItemGetFunc get;
20539 SlideshowItemDelFunc del;
20541 }; /**< #Elm_Slideshow_Item_Class member definitions */
20544 * Add a new slideshow widget to the given parent Elementary
20545 * (container) object
20547 * @param parent The parent object
20548 * @return A new slideshow widget handle or @c NULL, on errors
20550 * This function inserts a new slideshow widget on the canvas.
20552 * @ingroup Slideshow
20554 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20557 * Add (append) a new item in a given slideshow widget.
20559 * @param obj The slideshow object
20560 * @param itc The item class for the item
20561 * @param data The item's data
20562 * @return A handle to the item added or @c NULL, on errors
20564 * Add a new item to @p obj's internal list of items, appending it.
20565 * The item's class must contain the function really fetching the
20566 * image object to show for this item, which could be an Evas image
20567 * object or an Elementary photo, for example. The @p data
20568 * parameter is going to be passed to both class functions of the
20571 * @see #Elm_Slideshow_Item_Class
20572 * @see elm_slideshow_item_sorted_insert()
20574 * @ingroup Slideshow
20576 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20579 * Insert a new item into the given slideshow widget, using the @p func
20580 * function to sort items (by item handles).
20582 * @param obj The slideshow object
20583 * @param itc The item class for the item
20584 * @param data The item's data
20585 * @param func The comparing function to be used to sort slideshow
20586 * items <b>by #Elm_Slideshow_Item item handles</b>
20587 * @return Returns The slideshow item handle, on success, or
20588 * @c NULL, on errors
20590 * Add a new item to @p obj's internal list of items, in a position
20591 * determined by the @p func comparing function. The item's class
20592 * must contain the function really fetching the image object to
20593 * show for this item, which could be an Evas image object or an
20594 * Elementary photo, for example. The @p data parameter is going to
20595 * be passed to both class functions of the item.
20597 * @see #Elm_Slideshow_Item_Class
20598 * @see elm_slideshow_item_add()
20600 * @ingroup Slideshow
20602 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);
20605 * Display a given slideshow widget's item, programmatically.
20607 * @param obj The slideshow object
20608 * @param item The item to display on @p obj's viewport
20610 * The change between the current item and @p item will use the
20611 * transition @p obj is set to use (@see
20612 * elm_slideshow_transition_set()).
20614 * @ingroup Slideshow
20616 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20619 * Slide to the @b next item, in a given slideshow widget
20621 * @param obj The slideshow object
20623 * The sliding animation @p obj is set to use will be the
20624 * transition effect used, after this call is issued.
20626 * @note If the end of the slideshow's internal list of items is
20627 * reached, it'll wrap around to the list's beginning, again.
20629 * @ingroup Slideshow
20631 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20634 * Slide to the @b previous item, in a given slideshow widget
20636 * @param obj The slideshow object
20638 * The sliding animation @p obj is set to use will be the
20639 * transition effect used, after this call is issued.
20641 * @note If the beginning of the slideshow's internal list of items
20642 * is reached, it'll wrap around to the list's end, again.
20644 * @ingroup Slideshow
20646 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20649 * Returns the list of sliding transition/effect names available, for a
20650 * given slideshow widget.
20652 * @param obj The slideshow object
20653 * @return The list of transitions (list of @b stringshared strings
20656 * The transitions, which come from @p obj's theme, must be an EDC
20657 * data item named @c "transitions" on the theme file, with (prefix)
20658 * names of EDC programs actually implementing them.
20660 * The available transitions for slideshows on the default theme are:
20661 * - @c "fade" - the current item fades out, while the new one
20662 * fades in to the slideshow's viewport.
20663 * - @c "black_fade" - the current item fades to black, and just
20664 * then, the new item will fade in.
20665 * - @c "horizontal" - the current item slides horizontally, until
20666 * it gets out of the slideshow's viewport, while the new item
20667 * comes from the left to take its place.
20668 * - @c "vertical" - the current item slides vertically, until it
20669 * gets out of the slideshow's viewport, while the new item comes
20670 * from the bottom to take its place.
20671 * - @c "square" - the new item starts to appear from the middle of
20672 * the current one, but with a tiny size, growing until its
20673 * target (full) size and covering the old one.
20675 * @warning The stringshared strings get no new references
20676 * exclusive to the user grabbing the list, here, so if you'd like
20677 * to use them out of this call's context, you'd better @c
20678 * eina_stringshare_ref() them.
20680 * @see elm_slideshow_transition_set()
20682 * @ingroup Slideshow
20684 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20687 * Set the current slide transition/effect in use for a given
20690 * @param obj The slideshow object
20691 * @param transition The new transition's name string
20693 * If @p transition is implemented in @p obj's theme (i.e., is
20694 * contained in the list returned by
20695 * elm_slideshow_transitions_get()), this new sliding effect will
20696 * be used on the widget.
20698 * @see elm_slideshow_transitions_get() for more details
20700 * @ingroup Slideshow
20702 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20705 * Get the current slide transition/effect in use for a given
20708 * @param obj The slideshow object
20709 * @return The current transition's name
20711 * @see elm_slideshow_transition_set() for more details
20713 * @ingroup Slideshow
20715 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20718 * Set the interval between each image transition on a given
20719 * slideshow widget, <b>and start the slideshow, itself</b>
20721 * @param obj The slideshow object
20722 * @param timeout The new displaying timeout for images
20724 * After this call, the slideshow widget will start cycling its
20725 * view, sequentially and automatically, with the images of the
20726 * items it has. The time between each new image displayed is going
20727 * to be @p timeout, in @b seconds. If a different timeout was set
20728 * previously and an slideshow was in progress, it will continue
20729 * with the new time between transitions, after this call.
20731 * @note A value less than or equal to 0 on @p timeout will disable
20732 * the widget's internal timer, thus halting any slideshow which
20733 * could be happening on @p obj.
20735 * @see elm_slideshow_timeout_get()
20737 * @ingroup Slideshow
20739 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20742 * Get the interval set for image transitions on a given slideshow
20745 * @param obj The slideshow object
20746 * @return Returns the timeout set on it
20748 * @see elm_slideshow_timeout_set() for more details
20750 * @ingroup Slideshow
20752 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20755 * Set if, after a slideshow is started, for a given slideshow
20756 * widget, its items should be displayed cyclically or not.
20758 * @param obj The slideshow object
20759 * @param loop Use @c EINA_TRUE to make it cycle through items or
20760 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20763 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20764 * ignore what is set by this functions, i.e., they'll @b always
20765 * cycle through items. This affects only the "automatic"
20766 * slideshow, as set by elm_slideshow_timeout_set().
20768 * @see elm_slideshow_loop_get()
20770 * @ingroup Slideshow
20772 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20775 * Get if, after a slideshow is started, for a given slideshow
20776 * widget, its items are to be displayed cyclically or not.
20778 * @param obj The slideshow object
20779 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20780 * through or @c EINA_FALSE, otherwise
20782 * @see elm_slideshow_loop_set() for more details
20784 * @ingroup Slideshow
20786 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20789 * Remove all items from a given slideshow widget
20791 * @param obj The slideshow object
20793 * This removes (and deletes) all items in @p obj, leaving it
20796 * @see elm_slideshow_item_del(), to remove just one item.
20798 * @ingroup Slideshow
20800 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20803 * Get the internal list of items in a given slideshow widget.
20805 * @param obj The slideshow object
20806 * @return The list of items (#Elm_Slideshow_Item as data) or
20807 * @c NULL on errors.
20809 * This list is @b not to be modified in any way and must not be
20810 * freed. Use the list members with functions like
20811 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20813 * @warning This list is only valid until @p obj object's internal
20814 * items list is changed. It should be fetched again with another
20815 * call to this function when changes happen.
20817 * @ingroup Slideshow
20819 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20822 * Delete a given item from a slideshow widget.
20824 * @param item The slideshow item
20826 * @ingroup Slideshow
20828 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20831 * Return the data associated with a given slideshow item
20833 * @param item The slideshow item
20834 * @return Returns the data associated to this item
20836 * @ingroup Slideshow
20838 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20841 * Returns the currently displayed item, in a given slideshow widget
20843 * @param obj The slideshow object
20844 * @return A handle to the item being displayed in @p obj or
20845 * @c NULL, if none is (and on errors)
20847 * @ingroup Slideshow
20849 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20852 * Get the real Evas object created to implement the view of a
20853 * given slideshow item
20855 * @param item The slideshow item.
20856 * @return the Evas object implementing this item's view.
20858 * This returns the actual Evas object used to implement the
20859 * specified slideshow item's view. This may be @c NULL, as it may
20860 * not have been created or may have been deleted, at any time, by
20861 * the slideshow. <b>Do not modify this object</b> (move, resize,
20862 * show, hide, etc.), as the slideshow is controlling it. This
20863 * function is for querying, emitting custom signals or hooking
20864 * lower level callbacks for events on that object. Do not delete
20865 * this object under any circumstances.
20867 * @see elm_slideshow_item_data_get()
20869 * @ingroup Slideshow
20871 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20874 * Get the the item, in a given slideshow widget, placed at
20875 * position @p nth, in its internal items list
20877 * @param obj The slideshow object
20878 * @param nth The number of the item to grab a handle to (0 being
20880 * @return The item stored in @p obj at position @p nth or @c NULL,
20881 * if there's no item with that index (and on errors)
20883 * @ingroup Slideshow
20885 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20888 * Set the current slide layout in use for a given slideshow widget
20890 * @param obj The slideshow object
20891 * @param layout The new layout's name string
20893 * If @p layout is implemented in @p obj's theme (i.e., is contained
20894 * in the list returned by elm_slideshow_layouts_get()), this new
20895 * images layout will be used on the widget.
20897 * @see elm_slideshow_layouts_get() for more details
20899 * @ingroup Slideshow
20901 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20904 * Get the current slide layout in use for a given slideshow widget
20906 * @param obj The slideshow object
20907 * @return The current layout's name
20909 * @see elm_slideshow_layout_set() for more details
20911 * @ingroup Slideshow
20913 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20916 * Returns the list of @b layout names available, for a given
20917 * slideshow widget.
20919 * @param obj The slideshow object
20920 * @return The list of layouts (list of @b stringshared strings
20923 * Slideshow layouts will change how the widget is to dispose each
20924 * image item in its viewport, with regard to cropping, scaling,
20927 * The layouts, which come from @p obj's theme, must be an EDC
20928 * data item name @c "layouts" on the theme file, with (prefix)
20929 * names of EDC programs actually implementing them.
20931 * The available layouts for slideshows on the default theme are:
20932 * - @c "fullscreen" - item images with original aspect, scaled to
20933 * touch top and down slideshow borders or, if the image's heigh
20934 * is not enough, left and right slideshow borders.
20935 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20936 * one, but always leaving 10% of the slideshow's dimensions of
20937 * distance between the item image's borders and the slideshow
20938 * borders, for each axis.
20940 * @warning The stringshared strings get no new references
20941 * exclusive to the user grabbing the list, here, so if you'd like
20942 * to use them out of this call's context, you'd better @c
20943 * eina_stringshare_ref() them.
20945 * @see elm_slideshow_layout_set()
20947 * @ingroup Slideshow
20949 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20952 * Set the number of items to cache, on a given slideshow widget,
20953 * <b>before the current item</b>
20955 * @param obj The slideshow object
20956 * @param count Number of items to cache before the current one
20958 * The default value for this property is @c 2. See
20959 * @ref Slideshow_Caching "slideshow caching" for more details.
20961 * @see elm_slideshow_cache_before_get()
20963 * @ingroup Slideshow
20965 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20968 * Retrieve the number of items to cache, on a given slideshow widget,
20969 * <b>before the current item</b>
20971 * @param obj The slideshow object
20972 * @return The number of items set to be cached before the current one
20974 * @see elm_slideshow_cache_before_set() for more details
20976 * @ingroup Slideshow
20978 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20981 * Set the number of items to cache, on a given slideshow widget,
20982 * <b>after the current item</b>
20984 * @param obj The slideshow object
20985 * @param count Number of items to cache after the current one
20987 * The default value for this property is @c 2. See
20988 * @ref Slideshow_Caching "slideshow caching" for more details.
20990 * @see elm_slideshow_cache_after_get()
20992 * @ingroup Slideshow
20994 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20997 * Retrieve the number of items to cache, on a given slideshow widget,
20998 * <b>after the current item</b>
21000 * @param obj The slideshow object
21001 * @return The number of items set to be cached after the current one
21003 * @see elm_slideshow_cache_after_set() for more details
21005 * @ingroup Slideshow
21007 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21010 * Get the number of items stored in a given slideshow widget
21012 * @param obj The slideshow object
21013 * @return The number of items on @p obj, at the moment of this call
21015 * @ingroup Slideshow
21017 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21024 * @defgroup Fileselector File Selector
21026 * @image html img/widget/fileselector/preview-00.png
21027 * @image latex img/widget/fileselector/preview-00.eps
21029 * A file selector is a widget that allows a user to navigate
21030 * through a file system, reporting file selections back via its
21033 * It contains shortcut buttons for home directory (@c ~) and to
21034 * jump one directory upwards (..), as well as cancel/ok buttons to
21035 * confirm/cancel a given selection. After either one of those two
21036 * former actions, the file selector will issue its @c "done" smart
21039 * There's a text entry on it, too, showing the name of the current
21040 * selection. There's the possibility of making it editable, so it
21041 * is useful on file saving dialogs on applications, where one
21042 * gives a file name to save contents to, in a given directory in
21043 * the system. This custom file name will be reported on the @c
21044 * "done" smart callback (explained in sequence).
21046 * Finally, it has a view to display file system items into in two
21051 * If Elementary is built with support of the Ethumb thumbnailing
21052 * library, the second form of view will display preview thumbnails
21053 * of files which it supports.
21055 * Smart callbacks one can register to:
21057 * - @c "selected" - the user has clicked on a file (when not in
21058 * folders-only mode) or directory (when in folders-only mode)
21059 * - @c "directory,open" - the list has been populated with new
21060 * content (@c event_info is a pointer to the directory's
21061 * path, a @b stringshared string)
21062 * - @c "done" - the user has clicked on the "ok" or "cancel"
21063 * buttons (@c event_info is a pointer to the selection's
21064 * path, a @b stringshared string)
21066 * Here is an example on its usage:
21067 * @li @ref fileselector_example
21071 * @addtogroup Fileselector
21076 * Defines how a file selector widget is to layout its contents
21077 * (file system entries).
21079 typedef enum _Elm_Fileselector_Mode
21081 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21082 ELM_FILESELECTOR_GRID, /**< layout as a grid */
21083 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21084 } Elm_Fileselector_Mode;
21087 * Add a new file selector widget to the given parent Elementary
21088 * (container) object
21090 * @param parent The parent object
21091 * @return a new file selector widget handle or @c NULL, on errors
21093 * This function inserts a new file selector widget on the canvas.
21095 * @ingroup Fileselector
21097 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21100 * Enable/disable the file name entry box where the user can type
21101 * in a name for a file, in a given file selector widget
21103 * @param obj The file selector object
21104 * @param is_save @c EINA_TRUE to make the file selector a "saving
21105 * dialog", @c EINA_FALSE otherwise
21107 * Having the entry editable is useful on file saving dialogs on
21108 * applications, where one gives a file name to save contents to,
21109 * in a given directory in the system. This custom file name will
21110 * be reported on the @c "done" smart callback.
21112 * @see elm_fileselector_is_save_get()
21114 * @ingroup Fileselector
21116 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21119 * Get whether the given file selector is in "saving dialog" mode
21121 * @param obj The file selector object
21122 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21123 * mode, @c EINA_FALSE otherwise (and on errors)
21125 * @see elm_fileselector_is_save_set() for more details
21127 * @ingroup Fileselector
21129 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21132 * Enable/disable folder-only view for a given file selector widget
21134 * @param obj The file selector object
21135 * @param only @c EINA_TRUE to make @p obj only display
21136 * directories, @c EINA_FALSE to make files to be displayed in it
21139 * If enabled, the widget's view will only display folder items,
21142 * @see elm_fileselector_folder_only_get()
21144 * @ingroup Fileselector
21146 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21149 * Get whether folder-only view is set for a given file selector
21152 * @param obj The file selector object
21153 * @return only @c EINA_TRUE if @p obj is only displaying
21154 * directories, @c EINA_FALSE if files are being displayed in it
21155 * too (and on errors)
21157 * @see elm_fileselector_folder_only_get()
21159 * @ingroup Fileselector
21161 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21164 * Enable/disable the "ok" and "cancel" buttons on a given file
21167 * @param obj The file selector object
21168 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21170 * @note A file selector without those buttons will never emit the
21171 * @c "done" smart event, and is only usable if one is just hooking
21172 * to the other two events.
21174 * @see elm_fileselector_buttons_ok_cancel_get()
21176 * @ingroup Fileselector
21178 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21181 * Get whether the "ok" and "cancel" buttons on a given file
21182 * selector widget are being shown.
21184 * @param obj The file selector object
21185 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21186 * otherwise (and on errors)
21188 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21190 * @ingroup Fileselector
21192 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21195 * Enable/disable a tree view in the given file selector widget,
21196 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21198 * @param obj The file selector object
21199 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21202 * In a tree view, arrows are created on the sides of directories,
21203 * allowing them to expand in place.
21205 * @note If it's in other mode, the changes made by this function
21206 * will only be visible when one switches back to "list" mode.
21208 * @see elm_fileselector_expandable_get()
21210 * @ingroup Fileselector
21212 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21215 * Get whether tree view is enabled for the given file selector
21218 * @param obj The file selector object
21219 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21220 * otherwise (and or errors)
21222 * @see elm_fileselector_expandable_set() for more details
21224 * @ingroup Fileselector
21226 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21229 * Set, programmatically, the @b directory that a given file
21230 * selector widget will display contents from
21232 * @param obj The file selector object
21233 * @param path The path to display in @p obj
21235 * This will change the @b directory that @p obj is displaying. It
21236 * will also clear the text entry area on the @p obj object, which
21237 * displays select files' names.
21239 * @see elm_fileselector_path_get()
21241 * @ingroup Fileselector
21243 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21246 * Get the parent directory's path that a given file selector
21247 * widget is displaying
21249 * @param obj The file selector object
21250 * @return The (full) path of the directory the file selector is
21251 * displaying, a @b stringshared string
21253 * @see elm_fileselector_path_set()
21255 * @ingroup Fileselector
21257 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21260 * Set, programmatically, the currently selected file/directory in
21261 * the given file selector widget
21263 * @param obj The file selector object
21264 * @param path The (full) path to a file or directory
21265 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21266 * latter case occurs if the directory or file pointed to do not
21269 * @see elm_fileselector_selected_get()
21271 * @ingroup Fileselector
21273 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21276 * Get the currently selected item's (full) path, in the given file
21279 * @param obj The file selector object
21280 * @return The absolute path of the selected item, a @b
21281 * stringshared string
21283 * @note Custom editions on @p obj object's text entry, if made,
21284 * will appear on the return string of this function, naturally.
21286 * @see elm_fileselector_selected_set() for more details
21288 * @ingroup Fileselector
21290 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21293 * Set the mode in which a given file selector widget will display
21294 * (layout) file system entries in its view
21296 * @param obj The file selector object
21297 * @param mode The mode of the fileselector, being it one of
21298 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21299 * first one, naturally, will display the files in a list. The
21300 * latter will make the widget to display its entries in a grid
21303 * @note By using elm_fileselector_expandable_set(), the user may
21304 * trigger a tree view for that list.
21306 * @note If Elementary is built with support of the Ethumb
21307 * thumbnailing library, the second form of view will display
21308 * preview thumbnails of files which it supports. You must have
21309 * elm_need_ethumb() called in your Elementary for thumbnailing to
21312 * @see elm_fileselector_expandable_set().
21313 * @see elm_fileselector_mode_get().
21315 * @ingroup Fileselector
21317 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21320 * Get the mode in which a given file selector widget is displaying
21321 * (layouting) file system entries in its view
21323 * @param obj The fileselector object
21324 * @return The mode in which the fileselector is at
21326 * @see elm_fileselector_mode_set() for more details
21328 * @ingroup Fileselector
21330 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21337 * @defgroup Progressbar Progress bar
21339 * The progress bar is a widget for visually representing the
21340 * progress status of a given job/task.
21342 * A progress bar may be horizontal or vertical. It may display an
21343 * icon besides it, as well as primary and @b units labels. The
21344 * former is meant to label the widget as a whole, while the
21345 * latter, which is formatted with floating point values (and thus
21346 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21347 * units"</c>), is meant to label the widget's <b>progress
21348 * value</b>. Label, icon and unit strings/objects are @b optional
21349 * for progress bars.
21351 * A progress bar may be @b inverted, in which state it gets its
21352 * values inverted, with high values being on the left or top and
21353 * low values on the right or bottom, as opposed to normally have
21354 * the low values on the former and high values on the latter,
21355 * respectively, for horizontal and vertical modes.
21357 * The @b span of the progress, as set by
21358 * elm_progressbar_span_size_set(), is its length (horizontally or
21359 * vertically), unless one puts size hints on the widget to expand
21360 * on desired directions, by any container. That length will be
21361 * scaled by the object or applications scaling factor. At any
21362 * point code can query the progress bar for its value with
21363 * elm_progressbar_value_get().
21365 * Available widget styles for progress bars:
21367 * - @c "wheel" (simple style, no text, no progression, only
21368 * "pulse" effect is available)
21370 * Default contents parts of the progressbar widget that you can use for are:
21371 * @li "icon" - An icon of the progressbar
21373 * Here is an example on its usage:
21374 * @li @ref progressbar_example
21378 * Add a new progress bar widget to the given parent Elementary
21379 * (container) object
21381 * @param parent The parent object
21382 * @return a new progress bar widget handle or @c NULL, on errors
21384 * This function inserts a new progress bar widget on the canvas.
21386 * @ingroup Progressbar
21388 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21391 * Set whether a given progress bar widget is at "pulsing mode" or
21394 * @param obj The progress bar object
21395 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21396 * @c EINA_FALSE to put it back to its default one
21398 * By default, progress bars will display values from the low to
21399 * high value boundaries. There are, though, contexts in which the
21400 * state of progression of a given task is @b unknown. For those,
21401 * one can set a progress bar widget to a "pulsing state", to give
21402 * the user an idea that some computation is being held, but
21403 * without exact progress values. In the default theme it will
21404 * animate its bar with the contents filling in constantly and back
21405 * to non-filled, in a loop. To start and stop this pulsing
21406 * animation, one has to explicitly call elm_progressbar_pulse().
21408 * @see elm_progressbar_pulse_get()
21409 * @see elm_progressbar_pulse()
21411 * @ingroup Progressbar
21413 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21416 * Get whether a given progress bar widget is at "pulsing mode" or
21419 * @param obj The progress bar object
21420 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21421 * if it's in the default one (and on errors)
21423 * @ingroup Progressbar
21425 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21428 * Start/stop a given progress bar "pulsing" animation, if its
21431 * @param obj The progress bar object
21432 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21433 * @c EINA_FALSE to @b stop it
21435 * @note This call won't do anything if @p obj is not under "pulsing mode".
21437 * @see elm_progressbar_pulse_set() for more details.
21439 * @ingroup Progressbar
21441 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21444 * Set the progress value (in percentage) on a given progress bar
21447 * @param obj The progress bar object
21448 * @param val The progress value (@b must be between @c 0.0 and @c
21451 * Use this call to set progress bar levels.
21453 * @note If you passes a value out of the specified range for @p
21454 * val, it will be interpreted as the @b closest of the @b boundary
21455 * values in the range.
21457 * @ingroup Progressbar
21459 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21462 * Get the progress value (in percentage) on a given progress bar
21465 * @param obj The progress bar object
21466 * @return The value of the progressbar
21468 * @see elm_progressbar_value_set() for more details
21470 * @ingroup Progressbar
21472 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21475 * Set the label of a given progress bar widget
21477 * @param obj The progress bar object
21478 * @param label The text label string, in UTF-8
21480 * @ingroup Progressbar
21481 * @deprecated use elm_object_text_set() instead.
21483 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21486 * Get the label of a given progress bar widget
21488 * @param obj The progressbar object
21489 * @return The text label string, in UTF-8
21491 * @ingroup Progressbar
21492 * @deprecated use elm_object_text_set() instead.
21494 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21497 * Set the icon object of a given progress bar widget
21499 * @param obj The progress bar object
21500 * @param icon The icon object
21502 * Use this call to decorate @p obj with an icon next to it.
21504 * @note Once the icon object is set, a previously set one will be
21505 * deleted. If you want to keep that old content object, use the
21506 * elm_progressbar_icon_unset() function.
21508 * @see elm_progressbar_icon_get()
21509 * @deprecated use elm_object_part_content_set() instead.
21511 * @ingroup Progressbar
21513 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21516 * Retrieve the icon object set for a given progress bar widget
21518 * @param obj The progress bar object
21519 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21520 * otherwise (and on errors)
21522 * @see elm_progressbar_icon_set() for more details
21523 * @deprecated use elm_object_part_content_get() instead.
21525 * @ingroup Progressbar
21527 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21530 * Unset an icon set on a given progress bar widget
21532 * @param obj The progress bar object
21533 * @return The icon object that was being used, if any was set, or
21534 * @c NULL, otherwise (and on errors)
21536 * This call will unparent and return the icon object which was set
21537 * for this widget, previously, on success.
21539 * @see elm_progressbar_icon_set() for more details
21540 * @deprecated use elm_object_part_content_unset() instead.
21542 * @ingroup Progressbar
21544 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21547 * Set the (exact) length of the bar region of a given progress bar
21550 * @param obj The progress bar object
21551 * @param size The length of the progress bar's bar region
21553 * This sets the minimum width (when in horizontal mode) or height
21554 * (when in vertical mode) of the actual bar area of the progress
21555 * bar @p obj. This in turn affects the object's minimum size. Use
21556 * this when you're not setting other size hints expanding on the
21557 * given direction (like weight and alignment hints) and you would
21558 * like it to have a specific size.
21560 * @note Icon, label and unit text around @p obj will require their
21561 * own space, which will make @p obj to require more the @p size,
21564 * @see elm_progressbar_span_size_get()
21566 * @ingroup Progressbar
21568 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21571 * Get the length set for the bar region of a given progress bar
21574 * @param obj The progress bar object
21575 * @return The length of the progress bar's bar region
21577 * If that size was not set previously, with
21578 * elm_progressbar_span_size_set(), this call will return @c 0.
21580 * @ingroup Progressbar
21582 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21585 * Set the format string for a given progress bar widget's units
21588 * @param obj The progress bar object
21589 * @param format The format string for @p obj's units label
21591 * If @c NULL is passed on @p format, it will make @p obj's units
21592 * area to be hidden completely. If not, it'll set the <b>format
21593 * string</b> for the units label's @b text. The units label is
21594 * provided a floating point value, so the units text is up display
21595 * at most one floating point falue. Note that the units label is
21596 * optional. Use a format string such as "%1.2f meters" for
21599 * @note The default format string for a progress bar is an integer
21600 * percentage, as in @c "%.0f %%".
21602 * @see elm_progressbar_unit_format_get()
21604 * @ingroup Progressbar
21606 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21609 * Retrieve the format string set for a given progress bar widget's
21612 * @param obj The progress bar object
21613 * @return The format set string for @p obj's units label or
21614 * @c NULL, if none was set (and on errors)
21616 * @see elm_progressbar_unit_format_set() for more details
21618 * @ingroup Progressbar
21620 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21623 * Set the orientation of a given progress bar widget
21625 * @param obj The progress bar object
21626 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21627 * @b horizontal, @c EINA_FALSE to make it @b vertical
21629 * Use this function to change how your progress bar is to be
21630 * disposed: vertically or horizontally.
21632 * @see elm_progressbar_horizontal_get()
21634 * @ingroup Progressbar
21636 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21639 * Retrieve the orientation of a given progress bar widget
21641 * @param obj The progress bar object
21642 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21643 * @c EINA_FALSE if it's @b vertical (and on errors)
21645 * @see elm_progressbar_horizontal_set() for more details
21647 * @ingroup Progressbar
21649 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21652 * Invert a given progress bar widget's displaying values order
21654 * @param obj The progress bar object
21655 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21656 * @c EINA_FALSE to bring it back to default, non-inverted values.
21658 * A progress bar may be @b inverted, in which state it gets its
21659 * values inverted, with high values being on the left or top and
21660 * low values on the right or bottom, as opposed to normally have
21661 * the low values on the former and high values on the latter,
21662 * respectively, for horizontal and vertical modes.
21664 * @see elm_progressbar_inverted_get()
21666 * @ingroup Progressbar
21668 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21671 * Get whether a given progress bar widget's displaying values are
21674 * @param obj The progress bar object
21675 * @return @c EINA_TRUE, if @p obj has inverted values,
21676 * @c EINA_FALSE otherwise (and on errors)
21678 * @see elm_progressbar_inverted_set() for more details
21680 * @ingroup Progressbar
21682 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21685 * @defgroup Separator Separator
21687 * @brief Separator is a very thin object used to separate other objects.
21689 * A separator can be vertical or horizontal.
21691 * @ref tutorial_separator is a good example of how to use a separator.
21695 * @brief Add a separator object to @p parent
21697 * @param parent The parent object
21699 * @return The separator object, or NULL upon failure
21701 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21703 * @brief Set the horizontal mode of a separator object
21705 * @param obj The separator object
21706 * @param horizontal If true, the separator is horizontal
21708 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21710 * @brief Get the horizontal mode of a separator object
21712 * @param obj The separator object
21713 * @return If true, the separator is horizontal
21715 * @see elm_separator_horizontal_set()
21717 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21723 * @defgroup Spinner Spinner
21724 * @ingroup Elementary
21726 * @image html img/widget/spinner/preview-00.png
21727 * @image latex img/widget/spinner/preview-00.eps
21729 * A spinner is a widget which allows the user to increase or decrease
21730 * numeric values using arrow buttons, or edit values directly, clicking
21731 * over it and typing the new value.
21733 * By default the spinner will not wrap and has a label
21734 * of "%.0f" (just showing the integer value of the double).
21736 * A spinner has a label that is formatted with floating
21737 * point values and thus accepts a printf-style format string, like
21738 * ā%1.2f unitsā.
21740 * It also allows specific values to be replaced by pre-defined labels.
21742 * Smart callbacks one can register to:
21744 * - "changed" - Whenever the spinner value is changed.
21745 * - "delay,changed" - A short time after the value is changed by the user.
21746 * This will be called only when the user stops dragging for a very short
21747 * period or when they release their finger/mouse, so it avoids possibly
21748 * expensive reactions to the value change.
21750 * Available styles for it:
21752 * - @c "vertical": up/down buttons at the right side and text left aligned.
21754 * Here is an example on its usage:
21755 * @ref spinner_example
21759 * @addtogroup Spinner
21764 * Add a new spinner widget to the given parent Elementary
21765 * (container) object.
21767 * @param parent The parent object.
21768 * @return a new spinner widget handle or @c NULL, on errors.
21770 * This function inserts a new spinner widget on the canvas.
21775 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21778 * Set the format string of the displayed label.
21780 * @param obj The spinner object.
21781 * @param fmt The format string for the label display.
21783 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21784 * string for the label text. The label text is provided a floating point
21785 * value, so the label text can display up to 1 floating point value.
21786 * Note that this is optional.
21788 * Use a format string such as "%1.2f meters" for example, and it will
21789 * display values like: "3.14 meters" for a value equal to 3.14159.
21791 * Default is "%0.f".
21793 * @see elm_spinner_label_format_get()
21797 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21800 * Get the label format of the spinner.
21802 * @param obj The spinner object.
21803 * @return The text label format string in UTF-8.
21805 * @see elm_spinner_label_format_set() for details.
21809 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21812 * Set the minimum and maximum values for the spinner.
21814 * @param obj The spinner object.
21815 * @param min The minimum value.
21816 * @param max The maximum value.
21818 * Define the allowed range of values to be selected by the user.
21820 * If actual value is less than @p min, it will be updated to @p min. If it
21821 * is bigger then @p max, will be updated to @p max. Actual value can be
21822 * get with elm_spinner_value_get().
21824 * By default, min is equal to 0, and max is equal to 100.
21826 * @warning Maximum must be greater than minimum.
21828 * @see elm_spinner_min_max_get()
21832 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21835 * Get the minimum and maximum values of the spinner.
21837 * @param obj The spinner object.
21838 * @param min Pointer where to store the minimum value.
21839 * @param max Pointer where to store the maximum value.
21841 * @note If only one value is needed, the other pointer can be passed
21844 * @see elm_spinner_min_max_set() for details.
21848 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21851 * Set the step used to increment or decrement the spinner value.
21853 * @param obj The spinner object.
21854 * @param step The step value.
21856 * This value will be incremented or decremented to the displayed value.
21857 * It will be incremented while the user keep right or top arrow pressed,
21858 * and will be decremented while the user keep left or bottom arrow pressed.
21860 * The interval to increment / decrement can be set with
21861 * elm_spinner_interval_set().
21863 * By default step value is equal to 1.
21865 * @see elm_spinner_step_get()
21869 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21872 * Get the step used to increment or decrement the spinner value.
21874 * @param obj The spinner object.
21875 * @return The step value.
21877 * @see elm_spinner_step_get() for more details.
21881 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21884 * Set the value the spinner displays.
21886 * @param obj The spinner object.
21887 * @param val The value to be displayed.
21889 * Value will be presented on the label following format specified with
21890 * elm_spinner_format_set().
21892 * @warning The value must to be between min and max values. This values
21893 * are set by elm_spinner_min_max_set().
21895 * @see elm_spinner_value_get().
21896 * @see elm_spinner_format_set().
21897 * @see elm_spinner_min_max_set().
21901 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21904 * Get the value displayed by the spinner.
21906 * @param obj The spinner object.
21907 * @return The value displayed.
21909 * @see elm_spinner_value_set() for details.
21913 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21916 * Set whether the spinner should wrap when it reaches its
21917 * minimum or maximum value.
21919 * @param obj The spinner object.
21920 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21923 * Disabled by default. If disabled, when the user tries to increment the
21925 * but displayed value plus step value is bigger than maximum value,
21927 * won't allow it. The same happens when the user tries to decrement it,
21928 * but the value less step is less than minimum value.
21930 * When wrap is enabled, in such situations it will allow these changes,
21931 * but will get the value that would be less than minimum and subtracts
21932 * from maximum. Or add the value that would be more than maximum to
21936 * @li min value = 10
21937 * @li max value = 50
21938 * @li step value = 20
21939 * @li displayed value = 20
21941 * When the user decrement value (using left or bottom arrow), it will
21942 * displays @c 40, because max - (min - (displayed - step)) is
21943 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21945 * @see elm_spinner_wrap_get().
21949 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21952 * Get whether the spinner should wrap when it reaches its
21953 * minimum or maximum value.
21955 * @param obj The spinner object
21956 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21957 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21959 * @see elm_spinner_wrap_set() for details.
21963 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21966 * Set whether the spinner can be directly edited by the user or not.
21968 * @param obj The spinner object.
21969 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21970 * don't allow users to edit it directly.
21972 * Spinner objects can have edition @b disabled, in which state they will
21973 * be changed only by arrows.
21974 * Useful for contexts
21975 * where you don't want your users to interact with it writting the value.
21977 * when using special values, the user can see real value instead
21978 * of special label on edition.
21980 * It's enabled by default.
21982 * @see elm_spinner_editable_get()
21986 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21989 * Get whether the spinner can be directly edited by the user or not.
21991 * @param obj The spinner object.
21992 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21993 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21995 * @see elm_spinner_editable_set() for details.
21999 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22002 * Set a special string to display in the place of the numerical value.
22004 * @param obj The spinner object.
22005 * @param value The value to be replaced.
22006 * @param label The label to be used.
22008 * It's useful for cases when a user should select an item that is
22009 * better indicated by a label than a value. For example, weekdays or months.
22013 * sp = elm_spinner_add(win);
22014 * elm_spinner_min_max_set(sp, 1, 3);
22015 * elm_spinner_special_value_add(sp, 1, "January");
22016 * elm_spinner_special_value_add(sp, 2, "February");
22017 * elm_spinner_special_value_add(sp, 3, "March");
22018 * evas_object_show(sp);
22023 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22026 * Set the interval on time updates for an user mouse button hold
22027 * on spinner widgets' arrows.
22029 * @param obj The spinner object.
22030 * @param interval The (first) interval value in seconds.
22032 * This interval value is @b decreased while the user holds the
22033 * mouse pointer either incrementing or decrementing spinner's value.
22035 * This helps the user to get to a given value distant from the
22036 * current one easier/faster, as it will start to change quicker and
22037 * quicker on mouse button holds.
22039 * The calculation for the next change interval value, starting from
22040 * the one set with this call, is the previous interval divided by
22041 * @c 1.05, so it decreases a little bit.
22043 * The default starting interval value for automatic changes is
22046 * @see elm_spinner_interval_get()
22050 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22053 * Get the interval on time updates for an user mouse button hold
22054 * on spinner widgets' arrows.
22056 * @param obj The spinner object.
22057 * @return The (first) interval value, in seconds, set on it.
22059 * @see elm_spinner_interval_set() for more details.
22063 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22070 * @defgroup Index Index
22072 * @image html img/widget/index/preview-00.png
22073 * @image latex img/widget/index/preview-00.eps
22075 * An index widget gives you an index for fast access to whichever
22076 * group of other UI items one might have. It's a list of text
22077 * items (usually letters, for alphabetically ordered access).
22079 * Index widgets are by default hidden and just appear when the
22080 * user clicks over it's reserved area in the canvas. In its
22081 * default theme, it's an area one @ref Fingers "finger" wide on
22082 * the right side of the index widget's container.
22084 * When items on the index are selected, smart callbacks get
22085 * called, so that its user can make other container objects to
22086 * show a given area or child object depending on the index item
22087 * selected. You'd probably be using an index together with @ref
22088 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22091 * Smart events one can add callbacks for are:
22092 * - @c "changed" - When the selected index item changes. @c
22093 * event_info is the selected item's data pointer.
22094 * - @c "delay,changed" - When the selected index item changes, but
22095 * after a small idling period. @c event_info is the selected
22096 * item's data pointer.
22097 * - @c "selected" - When the user releases a mouse button and
22098 * selects an item. @c event_info is the selected item's data
22100 * - @c "level,up" - when the user moves a finger from the first
22101 * level to the second level
22102 * - @c "level,down" - when the user moves a finger from the second
22103 * level to the first level
22105 * The @c "delay,changed" event is so that it'll wait a small time
22106 * before actually reporting those events and, moreover, just the
22107 * last event happening on those time frames will actually be
22110 * Here are some examples on its usage:
22111 * @li @ref index_example_01
22112 * @li @ref index_example_02
22116 * @addtogroup Index
22120 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22123 * Add a new index widget to the given parent Elementary
22124 * (container) object
22126 * @param parent The parent object
22127 * @return a new index widget handle or @c NULL, on errors
22129 * This function inserts a new index widget on the canvas.
22133 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22136 * Set whether a given index widget is or not visible,
22139 * @param obj The index object
22140 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22142 * Not to be confused with visible as in @c evas_object_show() --
22143 * visible with regard to the widget's auto hiding feature.
22145 * @see elm_index_active_get()
22149 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22152 * Get whether a given index widget is currently visible or not.
22154 * @param obj The index object
22155 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22157 * @see elm_index_active_set() for more details
22161 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22164 * Set the items level for a given index widget.
22166 * @param obj The index object.
22167 * @param level @c 0 or @c 1, the currently implemented levels.
22169 * @see elm_index_item_level_get()
22173 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22176 * Get the items level set for a given index widget.
22178 * @param obj The index object.
22179 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22181 * @see elm_index_item_level_set() for more information
22185 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22188 * Returns the last selected item's data, for a given index widget.
22190 * @param obj The index object.
22191 * @return The item @b data associated to the last selected item on
22192 * @p obj (or @c NULL, on errors).
22194 * @warning The returned value is @b not an #Elm_Index_Item item
22195 * handle, but the data associated to it (see the @c item parameter
22196 * in elm_index_item_append(), as an example).
22200 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22203 * Append a new item on a given index widget.
22205 * @param obj The index object.
22206 * @param letter Letter under which the item should be indexed
22207 * @param item The item data to set for the index's item
22209 * Despite the most common usage of the @p letter argument is for
22210 * single char strings, one could use arbitrary strings as index
22213 * @c item will be the pointer returned back on @c "changed", @c
22214 * "delay,changed" and @c "selected" smart events.
22218 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22221 * Prepend a new item on a given index widget.
22223 * @param obj The index object.
22224 * @param letter Letter under which the item should be indexed
22225 * @param item The item data to set for the index's item
22227 * Despite the most common usage of the @p letter argument is for
22228 * single char strings, one could use arbitrary strings as index
22231 * @c item will be the pointer returned back on @c "changed", @c
22232 * "delay,changed" and @c "selected" smart events.
22236 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22239 * Append a new item, on a given index widget, <b>after the item
22240 * having @p relative as data</b>.
22242 * @param obj The index object.
22243 * @param letter Letter under which the item should be indexed
22244 * @param item The item data to set for the index's item
22245 * @param relative The item data of the index item to be the
22246 * predecessor of this new one
22248 * Despite the most common usage of the @p letter argument is for
22249 * single char strings, one could use arbitrary strings as index
22252 * @c item will be the pointer returned back on @c "changed", @c
22253 * "delay,changed" and @c "selected" smart events.
22255 * @note If @p relative is @c NULL or if it's not found to be data
22256 * set on any previous item on @p obj, this function will behave as
22257 * elm_index_item_append().
22261 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22264 * Prepend a new item, on a given index widget, <b>after the item
22265 * having @p relative as data</b>.
22267 * @param obj The index object.
22268 * @param letter Letter under which the item should be indexed
22269 * @param item The item data to set for the index's item
22270 * @param relative The item data of the index item to be the
22271 * successor of this new one
22273 * Despite the most common usage of the @p letter argument is for
22274 * single char strings, one could use arbitrary strings as index
22277 * @c item will be the pointer returned back on @c "changed", @c
22278 * "delay,changed" and @c "selected" smart events.
22280 * @note If @p relative is @c NULL or if it's not found to be data
22281 * set on any previous item on @p obj, this function will behave as
22282 * elm_index_item_prepend().
22286 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22289 * Insert a new item into the given index widget, using @p cmp_func
22290 * function to sort items (by item handles).
22292 * @param obj The index object.
22293 * @param letter Letter under which the item should be indexed
22294 * @param item The item data to set for the index's item
22295 * @param cmp_func The comparing function to be used to sort index
22296 * items <b>by #Elm_Index_Item item handles</b>
22297 * @param cmp_data_func A @b fallback function to be called for the
22298 * sorting of index items <b>by item data</b>). It will be used
22299 * when @p cmp_func returns @c 0 (equality), which means an index
22300 * item with provided item data already exists. To decide which
22301 * data item should be pointed to by the index item in question, @p
22302 * cmp_data_func will be used. If @p cmp_data_func returns a
22303 * non-negative value, the previous index item data will be
22304 * replaced by the given @p item pointer. If the previous data need
22305 * to be freed, it should be done by the @p cmp_data_func function,
22306 * because all references to it will be lost. If this function is
22307 * not provided (@c NULL is given), index items will be @b
22308 * duplicated, if @p cmp_func returns @c 0.
22310 * Despite the most common usage of the @p letter argument is for
22311 * single char strings, one could use arbitrary strings as index
22314 * @c item will be the pointer returned back on @c "changed", @c
22315 * "delay,changed" and @c "selected" smart events.
22319 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);
22322 * Remove an item from a given index widget, <b>to be referenced by
22323 * it's data value</b>.
22325 * @param obj The index object
22326 * @param item The item's data pointer for the item to be removed
22329 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22330 * that callback function will be called by this one.
22332 * @warning The item to be removed from @p obj will be found via
22333 * its item data pointer, and not by an #Elm_Index_Item handle.
22337 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22340 * Find a given index widget's item, <b>using item data</b>.
22342 * @param obj The index object
22343 * @param item The item data pointed to by the desired index item
22344 * @return The index item handle, if found, or @c NULL otherwise
22348 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22351 * Removes @b all items from a given index widget.
22353 * @param obj The index object.
22355 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22356 * that callback function will be called for each item in @p obj.
22360 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22363 * Go to a given items level on a index widget
22365 * @param obj The index object
22366 * @param level The index level (one of @c 0 or @c 1)
22370 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22373 * Return the data associated with a given index widget item
22375 * @param it The index widget item handle
22376 * @return The data associated with @p it
22378 * @see elm_index_item_data_set()
22382 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22385 * Set the data associated with a given index widget item
22387 * @param it The index widget item handle
22388 * @param data The new data pointer to set to @p it
22390 * This sets new item data on @p it.
22392 * @warning The old data pointer won't be touched by this function, so
22393 * the user had better to free that old data himself/herself.
22397 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22400 * Set the function to be called when a given index widget item is freed.
22402 * @param it The item to set the callback on
22403 * @param func The function to call on the item's deletion
22405 * When called, @p func will have both @c data and @c event_info
22406 * arguments with the @p it item's data value and, naturally, the
22407 * @c obj argument with a handle to the parent index widget.
22411 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22414 * Get the letter (string) set on a given index widget item.
22416 * @param it The index item handle
22417 * @return The letter string set on @p it
22421 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22428 * @defgroup Photocam Photocam
22430 * @image html img/widget/photocam/preview-00.png
22431 * @image latex img/widget/photocam/preview-00.eps
22433 * This is a widget specifically for displaying high-resolution digital
22434 * camera photos giving speedy feedback (fast load), low memory footprint
22435 * and zooming and panning as well as fitting logic. It is entirely focused
22436 * on jpeg images, and takes advantage of properties of the jpeg format (via
22437 * evas loader features in the jpeg loader).
22439 * Signals that you can add callbacks for are:
22440 * @li "clicked" - This is called when a user has clicked the photo without
22442 * @li "press" - This is called when a user has pressed down on the photo.
22443 * @li "longpressed" - This is called when a user has pressed down on the
22444 * photo for a long time without dragging around.
22445 * @li "clicked,double" - This is called when a user has double-clicked the
22447 * @li "load" - Photo load begins.
22448 * @li "loaded" - This is called when the image file load is complete for the
22449 * first view (low resolution blurry version).
22450 * @li "load,detail" - Photo detailed data load begins.
22451 * @li "loaded,detail" - This is called when the image file load is complete
22452 * for the detailed image data (full resolution needed).
22453 * @li "zoom,start" - Zoom animation started.
22454 * @li "zoom,stop" - Zoom animation stopped.
22455 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22456 * @li "scroll" - the content has been scrolled (moved)
22457 * @li "scroll,anim,start" - scrolling animation has started
22458 * @li "scroll,anim,stop" - scrolling animation has stopped
22459 * @li "scroll,drag,start" - dragging the contents around has started
22460 * @li "scroll,drag,stop" - dragging the contents around has stopped
22462 * @ref tutorial_photocam shows the API in action.
22466 * @brief Types of zoom available.
22468 typedef enum _Elm_Photocam_Zoom_Mode
22470 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22471 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22472 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22473 ELM_PHOTOCAM_ZOOM_MODE_LAST
22474 } Elm_Photocam_Zoom_Mode;
22476 * @brief Add a new Photocam object
22478 * @param parent The parent object
22479 * @return The new object or NULL if it cannot be created
22481 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22483 * @brief Set the photo file to be shown
22485 * @param obj The photocam object
22486 * @param file The photo file
22487 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22489 * This sets (and shows) the specified file (with a relative or absolute
22490 * path) and will return a load error (same error that
22491 * evas_object_image_load_error_get() will return). The image will change and
22492 * adjust its size at this point and begin a background load process for this
22493 * photo that at some time in the future will be displayed at the full
22496 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22498 * @brief Returns the path of the current image file
22500 * @param obj The photocam object
22501 * @return Returns the path
22503 * @see elm_photocam_file_set()
22505 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22507 * @brief Set the zoom level of the photo
22509 * @param obj The photocam object
22510 * @param zoom The zoom level to set
22512 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22513 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22514 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22515 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22518 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22520 * @brief Get the zoom level of the photo
22522 * @param obj The photocam object
22523 * @return The current zoom level
22525 * This returns the current zoom level of the photocam object. Note that if
22526 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22527 * (which is the default), the zoom level may be changed at any time by the
22528 * photocam object itself to account for photo size and photocam viewpoer
22531 * @see elm_photocam_zoom_set()
22532 * @see elm_photocam_zoom_mode_set()
22534 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22536 * @brief Set the zoom mode
22538 * @param obj The photocam object
22539 * @param mode The desired mode
22541 * This sets the zoom mode to manual or one of several automatic levels.
22542 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22543 * elm_photocam_zoom_set() and will stay at that level until changed by code
22544 * or until zoom mode is changed. This is the default mode. The Automatic
22545 * modes will allow the photocam object to automatically adjust zoom mode
22546 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22547 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22548 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22549 * pixels within the frame are left unfilled.
22551 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22553 * @brief Get the zoom mode
22555 * @param obj The photocam object
22556 * @return The current zoom mode
22558 * This gets the current zoom mode of the photocam object.
22560 * @see elm_photocam_zoom_mode_set()
22562 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22564 * @brief Get the current image pixel width and height
22566 * @param obj The photocam object
22567 * @param w A pointer to the width return
22568 * @param h A pointer to the height return
22570 * This gets the current photo pixel width and height (for the original).
22571 * The size will be returned in the integers @p w and @p h that are pointed
22574 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22576 * @brief Get the area of the image that is currently shown
22579 * @param x A pointer to the X-coordinate of region
22580 * @param y A pointer to the Y-coordinate of region
22581 * @param w A pointer to the width
22582 * @param h A pointer to the height
22584 * @see elm_photocam_image_region_show()
22585 * @see elm_photocam_image_region_bring_in()
22587 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22589 * @brief Set the viewed portion of the image
22591 * @param obj The photocam object
22592 * @param x X-coordinate of region in image original pixels
22593 * @param y Y-coordinate of region in image original pixels
22594 * @param w Width of region in image original pixels
22595 * @param h Height of region in image original pixels
22597 * This shows the region of the image without using animation.
22599 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22601 * @brief Bring in the viewed portion of the image
22603 * @param obj The photocam object
22604 * @param x X-coordinate of region in image original pixels
22605 * @param y Y-coordinate of region in image original pixels
22606 * @param w Width of region in image original pixels
22607 * @param h Height of region in image original pixels
22609 * This shows the region of the image using animation.
22611 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22613 * @brief Set the paused state for photocam
22615 * @param obj The photocam object
22616 * @param paused The pause state to set
22618 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22619 * photocam. The default is off. This will stop zooming using animation on
22620 * zoom levels changes and change instantly. This will stop any existing
22621 * animations that are running.
22623 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22625 * @brief Get the paused state for photocam
22627 * @param obj The photocam object
22628 * @return The current paused state
22630 * This gets the current paused state for the photocam object.
22632 * @see elm_photocam_paused_set()
22634 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22636 * @brief Get the internal low-res image used for photocam
22638 * @param obj The photocam object
22639 * @return The internal image object handle, or NULL if none exists
22641 * This gets the internal image object inside photocam. Do not modify it. It
22642 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22643 * deleted at any time as well.
22645 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22647 * @brief Set the photocam scrolling bouncing.
22649 * @param obj The photocam object
22650 * @param h_bounce bouncing for horizontal
22651 * @param v_bounce bouncing for vertical
22653 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22655 * @brief Get the photocam scrolling bouncing.
22657 * @param obj The photocam object
22658 * @param h_bounce bouncing for horizontal
22659 * @param v_bounce bouncing for vertical
22661 * @see elm_photocam_bounce_set()
22663 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22669 * @defgroup Map Map
22670 * @ingroup Elementary
22672 * @image html img/widget/map/preview-00.png
22673 * @image latex img/widget/map/preview-00.eps
22675 * This is a widget specifically for displaying a map. It uses basically
22676 * OpenStreetMap provider http://www.openstreetmap.org/,
22677 * but custom providers can be added.
22679 * It supports some basic but yet nice features:
22680 * @li zoom and scroll
22681 * @li markers with content to be displayed when user clicks over it
22682 * @li group of markers
22685 * Smart callbacks one can listen to:
22687 * - "clicked" - This is called when a user has clicked the map without
22689 * - "press" - This is called when a user has pressed down on the map.
22690 * - "longpressed" - This is called when a user has pressed down on the map
22691 * for a long time without dragging around.
22692 * - "clicked,double" - This is called when a user has double-clicked
22694 * - "load,detail" - Map detailed data load begins.
22695 * - "loaded,detail" - This is called when all currently visible parts of
22696 * the map are loaded.
22697 * - "zoom,start" - Zoom animation started.
22698 * - "zoom,stop" - Zoom animation stopped.
22699 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22700 * - "scroll" - the content has been scrolled (moved).
22701 * - "scroll,anim,start" - scrolling animation has started.
22702 * - "scroll,anim,stop" - scrolling animation has stopped.
22703 * - "scroll,drag,start" - dragging the contents around has started.
22704 * - "scroll,drag,stop" - dragging the contents around has stopped.
22705 * - "downloaded" - This is called when all currently required map images
22707 * - "route,load" - This is called when route request begins.
22708 * - "route,loaded" - This is called when route request ends.
22709 * - "name,load" - This is called when name request begins.
22710 * - "name,loaded- This is called when name request ends.
22712 * Available style for map widget:
22715 * Available style for markers:
22720 * Available style for marker bubble:
22723 * List of examples:
22724 * @li @ref map_example_01
22725 * @li @ref map_example_02
22726 * @li @ref map_example_03
22735 * @enum _Elm_Map_Zoom_Mode
22736 * @typedef Elm_Map_Zoom_Mode
22738 * Set map's zoom behavior. It can be set to manual or automatic.
22740 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22742 * Values <b> don't </b> work as bitmask, only one can be choosen.
22744 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22745 * than the scroller view.
22747 * @see elm_map_zoom_mode_set()
22748 * @see elm_map_zoom_mode_get()
22752 typedef enum _Elm_Map_Zoom_Mode
22754 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22755 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22756 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22757 ELM_MAP_ZOOM_MODE_LAST
22758 } Elm_Map_Zoom_Mode;
22761 * @enum _Elm_Map_Route_Sources
22762 * @typedef Elm_Map_Route_Sources
22764 * Set route service to be used. By default used source is
22765 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22767 * @see elm_map_route_source_set()
22768 * @see elm_map_route_source_get()
22772 typedef enum _Elm_Map_Route_Sources
22774 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22775 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. */
22776 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22777 ELM_MAP_ROUTE_SOURCE_LAST
22778 } Elm_Map_Route_Sources;
22780 typedef enum _Elm_Map_Name_Sources
22782 ELM_MAP_NAME_SOURCE_NOMINATIM,
22783 ELM_MAP_NAME_SOURCE_LAST
22784 } Elm_Map_Name_Sources;
22787 * @enum _Elm_Map_Route_Type
22788 * @typedef Elm_Map_Route_Type
22790 * Set type of transport used on route.
22792 * @see elm_map_route_add()
22796 typedef enum _Elm_Map_Route_Type
22798 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22799 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22800 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22801 ELM_MAP_ROUTE_TYPE_LAST
22802 } Elm_Map_Route_Type;
22805 * @enum _Elm_Map_Route_Method
22806 * @typedef Elm_Map_Route_Method
22808 * Set the routing method, what should be priorized, time or distance.
22810 * @see elm_map_route_add()
22814 typedef enum _Elm_Map_Route_Method
22816 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22817 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22818 ELM_MAP_ROUTE_METHOD_LAST
22819 } Elm_Map_Route_Method;
22821 typedef enum _Elm_Map_Name_Method
22823 ELM_MAP_NAME_METHOD_SEARCH,
22824 ELM_MAP_NAME_METHOD_REVERSE,
22825 ELM_MAP_NAME_METHOD_LAST
22826 } Elm_Map_Name_Method;
22828 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(). */
22829 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(). */
22830 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(). */
22831 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(). */
22832 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22833 typedef struct _Elm_Map_Track Elm_Map_Track;
22835 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. */
22836 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22837 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22838 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22840 typedef char *(*ElmMapModuleSourceFunc) (void);
22841 typedef int (*ElmMapModuleZoomMinFunc) (void);
22842 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22843 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22844 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22845 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22846 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22847 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22848 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22851 * Add a new map widget to the given parent Elementary (container) object.
22853 * @param parent The parent object.
22854 * @return a new map widget handle or @c NULL, on errors.
22856 * This function inserts a new map widget on the canvas.
22860 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22863 * Set the zoom level of the map.
22865 * @param obj The map object.
22866 * @param zoom The zoom level to set.
22868 * This sets the zoom level.
22870 * It will respect limits defined by elm_map_source_zoom_min_set() and
22871 * elm_map_source_zoom_max_set().
22873 * By default these values are 0 (world map) and 18 (maximum zoom).
22875 * This function should be used when zoom mode is set to
22876 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22877 * with elm_map_zoom_mode_set().
22879 * @see elm_map_zoom_mode_set().
22880 * @see elm_map_zoom_get().
22884 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22887 * Get the zoom level of the map.
22889 * @param obj The map object.
22890 * @return The current zoom level.
22892 * This returns the current zoom level of the map object.
22894 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22895 * (which is the default), the zoom level may be changed at any time by the
22896 * map object itself to account for map size and map viewport size.
22898 * @see elm_map_zoom_set() for details.
22902 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22905 * Set the zoom mode used by the map object.
22907 * @param obj The map object.
22908 * @param mode The zoom mode of the map, being it one of
22909 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22910 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22912 * This sets the zoom mode to manual or one of the automatic levels.
22913 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22914 * elm_map_zoom_set() and will stay at that level until changed by code
22915 * or until zoom mode is changed. This is the default mode.
22917 * The Automatic modes will allow the map object to automatically
22918 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22919 * adjust zoom so the map fits inside the scroll frame with no pixels
22920 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22921 * ensure no pixels within the frame are left unfilled. Do not forget that
22922 * the valid sizes are 2^zoom, consequently the map may be smaller than
22923 * the scroller view.
22925 * @see elm_map_zoom_set()
22929 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22932 * Get the zoom mode used by the map object.
22934 * @param obj The map object.
22935 * @return The zoom mode of the map, being it one of
22936 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22937 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22939 * This function returns the current zoom mode used by the map object.
22941 * @see elm_map_zoom_mode_set() for more details.
22945 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22948 * Get the current coordinates of the map.
22950 * @param obj The map object.
22951 * @param lon Pointer where to store longitude.
22952 * @param lat Pointer where to store latitude.
22954 * This gets the current center coordinates of the map object. It can be
22955 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22957 * @see elm_map_geo_region_bring_in()
22958 * @see elm_map_geo_region_show()
22962 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22965 * Animatedly bring in given coordinates to the center of the map.
22967 * @param obj The map object.
22968 * @param lon Longitude to center at.
22969 * @param lat Latitude to center at.
22971 * This causes map to jump to the given @p lat and @p lon coordinates
22972 * and show it (by scrolling) in the center of the viewport, if it is not
22973 * already centered. This will use animation to do so and take a period
22974 * of time to complete.
22976 * @see elm_map_geo_region_show() for a function to avoid animation.
22977 * @see elm_map_geo_region_get()
22981 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22984 * Show the given coordinates at the center of the map, @b immediately.
22986 * @param obj The map object.
22987 * @param lon Longitude to center at.
22988 * @param lat Latitude to center at.
22990 * This causes map to @b redraw its viewport's contents to the
22991 * region contining the given @p lat and @p lon, that will be moved to the
22992 * center of the map.
22994 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22995 * @see elm_map_geo_region_get()
22999 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23002 * Pause or unpause the map.
23004 * @param obj The map object.
23005 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23008 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23011 * The default is off.
23013 * This will stop zooming using animation, changing zoom levels will
23014 * change instantly. This will stop any existing animations that are running.
23016 * @see elm_map_paused_get()
23020 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23023 * Get a value whether map is paused or not.
23025 * @param obj The map object.
23026 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23027 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23029 * This gets the current paused state for the map object.
23031 * @see elm_map_paused_set() for details.
23035 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23038 * Set to show markers during zoom level changes or not.
23040 * @param obj The map object.
23041 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23044 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23047 * The default is off.
23049 * This will stop zooming using animation, changing zoom levels will
23050 * change instantly. This will stop any existing animations that are running.
23052 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23055 * The default is off.
23057 * Enabling it will force the map to stop displaying the markers during
23058 * zoom level changes. Set to on if you have a large number of markers.
23060 * @see elm_map_paused_markers_get()
23064 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23067 * Get a value whether markers will be displayed on zoom level changes or not
23069 * @param obj The map object.
23070 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23071 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23073 * This gets the current markers paused state for the map object.
23075 * @see elm_map_paused_markers_set() for details.
23079 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23082 * Get the information of downloading status.
23084 * @param obj The map object.
23085 * @param try_num Pointer where to store number of tiles being downloaded.
23086 * @param finish_num Pointer where to store number of tiles successfully
23089 * This gets the current downloading status for the map object, the number
23090 * of tiles being downloaded and the number of tiles already downloaded.
23094 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23097 * Convert a pixel coordinate (x,y) into a geographic coordinate
23098 * (longitude, latitude).
23100 * @param obj The map object.
23101 * @param x the coordinate.
23102 * @param y the coordinate.
23103 * @param size the size in pixels of the map.
23104 * The map is a square and generally his size is : pow(2.0, zoom)*256.
23105 * @param lon Pointer where to store the longitude that correspond to x.
23106 * @param lat Pointer where to store the latitude that correspond to y.
23108 * @note Origin pixel point is the top left corner of the viewport.
23109 * Map zoom and size are taken on account.
23111 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23115 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);
23118 * Convert a geographic coordinate (longitude, latitude) into a pixel
23119 * coordinate (x, y).
23121 * @param obj The map object.
23122 * @param lon the longitude.
23123 * @param lat the latitude.
23124 * @param size the size in pixels of the map. The map is a square
23125 * and generally his size is : pow(2.0, zoom)*256.
23126 * @param x Pointer where to store the horizontal pixel coordinate that
23127 * correspond to the longitude.
23128 * @param y Pointer where to store the vertical pixel coordinate that
23129 * correspond to the latitude.
23131 * @note Origin pixel point is the top left corner of the viewport.
23132 * Map zoom and size are taken on account.
23134 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23138 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);
23141 * Convert a geographic coordinate (longitude, latitude) into a name
23144 * @param obj The map object.
23145 * @param lon the longitude.
23146 * @param lat the latitude.
23147 * @return name A #Elm_Map_Name handle for this coordinate.
23149 * To get the string for this address, elm_map_name_address_get()
23152 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23156 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23159 * Convert a name (address) into a geographic coordinate
23160 * (longitude, latitude).
23162 * @param obj The map object.
23163 * @param name The address.
23164 * @return name A #Elm_Map_Name handle for this address.
23166 * To get the longitude and latitude, elm_map_name_region_get()
23169 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23173 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23176 * Convert a pixel coordinate into a rotated pixel coordinate.
23178 * @param obj The map object.
23179 * @param x horizontal coordinate of the point to rotate.
23180 * @param y vertical coordinate of the point to rotate.
23181 * @param cx rotation's center horizontal position.
23182 * @param cy rotation's center vertical position.
23183 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23184 * @param xx Pointer where to store rotated x.
23185 * @param yy Pointer where to store rotated y.
23189 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);
23192 * Add a new marker to the map object.
23194 * @param obj The map object.
23195 * @param lon The longitude of the marker.
23196 * @param lat The latitude of the marker.
23197 * @param clas The class, to use when marker @b isn't grouped to others.
23198 * @param clas_group The class group, to use when marker is grouped to others
23199 * @param data The data passed to the callbacks.
23201 * @return The created marker or @c NULL upon failure.
23203 * A marker will be created and shown in a specific point of the map, defined
23204 * by @p lon and @p lat.
23206 * It will be displayed using style defined by @p class when this marker
23207 * is displayed alone (not grouped). A new class can be created with
23208 * elm_map_marker_class_new().
23210 * If the marker is grouped to other markers, it will be displayed with
23211 * style defined by @p class_group. Markers with the same group are grouped
23212 * if they are close. A new group class can be created with
23213 * elm_map_marker_group_class_new().
23215 * Markers created with this method can be deleted with
23216 * elm_map_marker_remove().
23218 * A marker can have associated content to be displayed by a bubble,
23219 * when a user click over it, as well as an icon. These objects will
23220 * be fetch using class' callback functions.
23222 * @see elm_map_marker_class_new()
23223 * @see elm_map_marker_group_class_new()
23224 * @see elm_map_marker_remove()
23228 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);
23231 * Set the maximum numbers of markers' content to be displayed in a group.
23233 * @param obj The map object.
23234 * @param max The maximum numbers of items displayed in a bubble.
23236 * A bubble will be displayed when the user clicks over the group,
23237 * and will place the content of markers that belong to this group
23240 * A group can have a long list of markers, consequently the creation
23241 * of the content of the bubble can be very slow.
23243 * In order to avoid this, a maximum number of items is displayed
23246 * By default this number is 30.
23248 * Marker with the same group class are grouped if they are close.
23250 * @see elm_map_marker_add()
23254 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23257 * Remove a marker from the map.
23259 * @param marker The marker to remove.
23261 * @see elm_map_marker_add()
23265 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23268 * Get the current coordinates of the marker.
23270 * @param marker marker.
23271 * @param lat Pointer where to store the marker's latitude.
23272 * @param lon Pointer where to store the marker's longitude.
23274 * These values are set when adding markers, with function
23275 * elm_map_marker_add().
23277 * @see elm_map_marker_add()
23281 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23284 * Animatedly bring in given marker to the center of the map.
23286 * @param marker The marker to center at.
23288 * This causes map to jump to the given @p marker's coordinates
23289 * and show it (by scrolling) in the center of the viewport, if it is not
23290 * already centered. This will use animation to do so and take a period
23291 * of time to complete.
23293 * @see elm_map_marker_show() for a function to avoid animation.
23294 * @see elm_map_marker_region_get()
23298 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23301 * Show the given marker at the center of the map, @b immediately.
23303 * @param marker The marker to center at.
23305 * This causes map to @b redraw its viewport's contents to the
23306 * region contining the given @p marker's coordinates, that will be
23307 * moved to the center of the map.
23309 * @see elm_map_marker_bring_in() for a function to move with animation.
23310 * @see elm_map_markers_list_show() if more than one marker need to be
23312 * @see elm_map_marker_region_get()
23316 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23319 * Move and zoom the map to display a list of markers.
23321 * @param markers A list of #Elm_Map_Marker handles.
23323 * The map will be centered on the center point of the markers in the list.
23324 * Then the map will be zoomed in order to fit the markers using the maximum
23325 * zoom which allows display of all the markers.
23327 * @warning All the markers should belong to the same map object.
23329 * @see elm_map_marker_show() to show a single marker.
23330 * @see elm_map_marker_bring_in()
23334 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23337 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23339 * @param marker The marker wich content should be returned.
23340 * @return Return the evas object if it exists, else @c NULL.
23342 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23343 * elm_map_marker_class_get_cb_set() should be used.
23345 * This content is what will be inside the bubble that will be displayed
23346 * when an user clicks over the marker.
23348 * This returns the actual Evas object used to be placed inside
23349 * the bubble. This may be @c NULL, as it may
23350 * not have been created or may have been deleted, at any time, by
23351 * the map. <b>Do not modify this object</b> (move, resize,
23352 * show, hide, etc.), as the map is controlling it. This
23353 * function is for querying, emitting custom signals or hooking
23354 * lower level callbacks for events on that object. Do not delete
23355 * this object under any circumstances.
23359 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23362 * Update the marker
23364 * @param marker The marker to be updated.
23366 * If a content is set to this marker, it will call function to delete it,
23367 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23368 * #ElmMapMarkerGetFunc.
23370 * These functions are set for the marker class with
23371 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23375 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23378 * Close all the bubbles opened by the user.
23380 * @param obj The map object.
23382 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23383 * when the user clicks on a marker.
23385 * This functions is set for the marker class with
23386 * elm_map_marker_class_get_cb_set().
23390 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23393 * Create a new group class.
23395 * @param obj The map object.
23396 * @return Returns the new group class.
23398 * Each marker must be associated to a group class. Markers in the same
23399 * group are grouped if they are close.
23401 * The group class defines the style of the marker when a marker is grouped
23402 * to others markers. When it is alone, another class will be used.
23404 * A group class will need to be provided when creating a marker with
23405 * elm_map_marker_add().
23407 * Some properties and functions can be set by class, as:
23408 * - style, with elm_map_group_class_style_set()
23409 * - data - to be associated to the group class. It can be set using
23410 * elm_map_group_class_data_set().
23411 * - min zoom to display markers, set with
23412 * elm_map_group_class_zoom_displayed_set().
23413 * - max zoom to group markers, set using
23414 * elm_map_group_class_zoom_grouped_set().
23415 * - visibility - set if markers will be visible or not, set with
23416 * elm_map_group_class_hide_set().
23417 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23418 * It can be set using elm_map_group_class_icon_cb_set().
23420 * @see elm_map_marker_add()
23421 * @see elm_map_group_class_style_set()
23422 * @see elm_map_group_class_data_set()
23423 * @see elm_map_group_class_zoom_displayed_set()
23424 * @see elm_map_group_class_zoom_grouped_set()
23425 * @see elm_map_group_class_hide_set()
23426 * @see elm_map_group_class_icon_cb_set()
23430 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23433 * Set the marker's style of a group class.
23435 * @param clas The group class.
23436 * @param style The style to be used by markers.
23438 * Each marker must be associated to a group class, and will use the style
23439 * defined by such class when grouped to other markers.
23441 * The following styles are provided by default theme:
23442 * @li @c radio - blue circle
23443 * @li @c radio2 - green circle
23446 * @see elm_map_group_class_new() for more details.
23447 * @see elm_map_marker_add()
23451 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23454 * Set the icon callback function of a group class.
23456 * @param clas The group class.
23457 * @param icon_get The callback function that will return the icon.
23459 * Each marker must be associated to a group class, and it can display a
23460 * custom icon. The function @p icon_get must return this icon.
23462 * @see elm_map_group_class_new() for more details.
23463 * @see elm_map_marker_add()
23467 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23470 * Set the data associated to the group class.
23472 * @param clas The group class.
23473 * @param data The new user data.
23475 * This data will be passed for callback functions, like icon get callback,
23476 * that can be set with elm_map_group_class_icon_cb_set().
23478 * If a data was previously set, the object will lose the pointer for it,
23479 * so if needs to be freed, you must do it yourself.
23481 * @see elm_map_group_class_new() for more details.
23482 * @see elm_map_group_class_icon_cb_set()
23483 * @see elm_map_marker_add()
23487 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23490 * Set the minimum zoom from where the markers are displayed.
23492 * @param clas The group class.
23493 * @param zoom The minimum zoom.
23495 * Markers only will be displayed when the map is displayed at @p zoom
23498 * @see elm_map_group_class_new() for more details.
23499 * @see elm_map_marker_add()
23503 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23506 * Set the zoom from where the markers are no more grouped.
23508 * @param clas The group class.
23509 * @param zoom The maximum zoom.
23511 * Markers only will be grouped when the map is displayed at
23512 * less than @p zoom.
23514 * @see elm_map_group_class_new() for more details.
23515 * @see elm_map_marker_add()
23519 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23522 * Set if the markers associated to the group class @clas are hidden or not.
23524 * @param clas The group class.
23525 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23528 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23533 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23536 * Create a new marker class.
23538 * @param obj The map object.
23539 * @return Returns the new group class.
23541 * Each marker must be associated to a class.
23543 * The marker class defines the style of the marker when a marker is
23544 * displayed alone, i.e., not grouped to to others markers. When grouped
23545 * it will use group class style.
23547 * A marker class will need to be provided when creating a marker with
23548 * elm_map_marker_add().
23550 * Some properties and functions can be set by class, as:
23551 * - style, with elm_map_marker_class_style_set()
23552 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23553 * It can be set using elm_map_marker_class_icon_cb_set().
23554 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23555 * Set using elm_map_marker_class_get_cb_set().
23556 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23557 * Set using elm_map_marker_class_del_cb_set().
23559 * @see elm_map_marker_add()
23560 * @see elm_map_marker_class_style_set()
23561 * @see elm_map_marker_class_icon_cb_set()
23562 * @see elm_map_marker_class_get_cb_set()
23563 * @see elm_map_marker_class_del_cb_set()
23567 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23570 * Set the marker's style of a marker class.
23572 * @param clas The marker class.
23573 * @param style The style to be used by markers.
23575 * Each marker must be associated to a marker class, and will use the style
23576 * defined by such class when alone, i.e., @b not grouped to other markers.
23578 * The following styles are provided by default theme:
23583 * @see elm_map_marker_class_new() for more details.
23584 * @see elm_map_marker_add()
23588 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23591 * Set the icon callback function of a marker class.
23593 * @param clas The marker class.
23594 * @param icon_get The callback function that will return the icon.
23596 * Each marker must be associated to a marker class, and it can display a
23597 * custom icon. The function @p icon_get must return this icon.
23599 * @see elm_map_marker_class_new() for more details.
23600 * @see elm_map_marker_add()
23604 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23607 * Set the bubble content callback function of a marker class.
23609 * @param clas The marker class.
23610 * @param get The callback function that will return the content.
23612 * Each marker must be associated to a marker class, and it can display a
23613 * a content on a bubble that opens when the user click over the marker.
23614 * The function @p get must return this content object.
23616 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23619 * @see elm_map_marker_class_new() for more details.
23620 * @see elm_map_marker_class_del_cb_set()
23621 * @see elm_map_marker_add()
23625 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23628 * Set the callback function used to delete bubble content of a marker class.
23630 * @param clas The marker class.
23631 * @param del The callback function that will delete the content.
23633 * Each marker must be associated to a marker class, and it can display a
23634 * a content on a bubble that opens when the user click over the marker.
23635 * The function to return such content can be set with
23636 * elm_map_marker_class_get_cb_set().
23638 * If this content must be freed, a callback function need to be
23639 * set for that task with this function.
23641 * If this callback is defined it will have to delete (or not) the
23642 * object inside, but if the callback is not defined the object will be
23643 * destroyed with evas_object_del().
23645 * @see elm_map_marker_class_new() for more details.
23646 * @see elm_map_marker_class_get_cb_set()
23647 * @see elm_map_marker_add()
23651 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23654 * Get the list of available sources.
23656 * @param obj The map object.
23657 * @return The source names list.
23659 * It will provide a list with all available sources, that can be set as
23660 * current source with elm_map_source_name_set(), or get with
23661 * elm_map_source_name_get().
23663 * Available sources:
23669 * @see elm_map_source_name_set() for more details.
23670 * @see elm_map_source_name_get()
23674 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23677 * Set the source of the map.
23679 * @param obj The map object.
23680 * @param source The source to be used.
23682 * Map widget retrieves images that composes the map from a web service.
23683 * This web service can be set with this method.
23685 * A different service can return a different maps with different
23686 * information and it can use different zoom values.
23688 * The @p source_name need to match one of the names provided by
23689 * elm_map_source_names_get().
23691 * The current source can be get using elm_map_source_name_get().
23693 * @see elm_map_source_names_get()
23694 * @see elm_map_source_name_get()
23699 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23702 * Get the name of currently used source.
23704 * @param obj The map object.
23705 * @return Returns the name of the source in use.
23707 * @see elm_map_source_name_set() for more details.
23711 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23714 * Set the source of the route service to be used by the map.
23716 * @param obj The map object.
23717 * @param source The route service to be used, being it one of
23718 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23719 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23721 * Each one has its own algorithm, so the route retrieved may
23722 * differ depending on the source route. Now, only the default is working.
23724 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23725 * http://www.yournavigation.org/.
23727 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23728 * assumptions. Its routing core is based on Contraction Hierarchies.
23730 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23732 * @see elm_map_route_source_get().
23736 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23739 * Get the current route source.
23741 * @param obj The map object.
23742 * @return The source of the route service used by the map.
23744 * @see elm_map_route_source_set() for details.
23748 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23751 * Set the minimum zoom of the source.
23753 * @param obj The map object.
23754 * @param zoom New minimum zoom value to be used.
23756 * By default, it's 0.
23760 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23763 * Get the minimum zoom of the source.
23765 * @param obj The map object.
23766 * @return Returns the minimum zoom of the source.
23768 * @see elm_map_source_zoom_min_set() for details.
23772 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23775 * Set the maximum zoom of the source.
23777 * @param obj The map object.
23778 * @param zoom New maximum zoom value to be used.
23780 * By default, it's 18.
23784 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23787 * Get the maximum zoom of the source.
23789 * @param obj The map object.
23790 * @return Returns the maximum zoom of the source.
23792 * @see elm_map_source_zoom_min_set() for details.
23796 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23799 * Set the user agent used by the map object to access routing services.
23801 * @param obj The map object.
23802 * @param user_agent The user agent to be used by the map.
23804 * User agent is a client application implementing a network protocol used
23805 * in communications within a clientāserver distributed computing system
23807 * The @p user_agent identification string will transmitted in a header
23808 * field @c User-Agent.
23810 * @see elm_map_user_agent_get()
23814 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23817 * Get the user agent used by the map object.
23819 * @param obj The map object.
23820 * @return The user agent identification string used by the map.
23822 * @see elm_map_user_agent_set() for details.
23826 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23829 * Add a new route to the map object.
23831 * @param obj The map object.
23832 * @param type The type of transport to be considered when tracing a route.
23833 * @param method The routing method, what should be priorized.
23834 * @param flon The start longitude.
23835 * @param flat The start latitude.
23836 * @param tlon The destination longitude.
23837 * @param tlat The destination latitude.
23839 * @return The created route or @c NULL upon failure.
23841 * A route will be traced by point on coordinates (@p flat, @p flon)
23842 * to point on coordinates (@p tlat, @p tlon), using the route service
23843 * set with elm_map_route_source_set().
23845 * It will take @p type on consideration to define the route,
23846 * depending if the user will be walking or driving, the route may vary.
23847 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23848 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23850 * Another parameter is what the route should priorize, the minor distance
23851 * or the less time to be spend on the route. So @p method should be one
23852 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23854 * Routes created with this method can be deleted with
23855 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23856 * and distance can be get with elm_map_route_distance_get().
23858 * @see elm_map_route_remove()
23859 * @see elm_map_route_color_set()
23860 * @see elm_map_route_distance_get()
23861 * @see elm_map_route_source_set()
23865 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);
23868 * Remove a route from the map.
23870 * @param route The route to remove.
23872 * @see elm_map_route_add()
23876 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23879 * Set the route color.
23881 * @param route The route object.
23882 * @param r Red channel value, from 0 to 255.
23883 * @param g Green channel value, from 0 to 255.
23884 * @param b Blue channel value, from 0 to 255.
23885 * @param a Alpha channel value, from 0 to 255.
23887 * It uses an additive color model, so each color channel represents
23888 * how much of each primary colors must to be used. 0 represents
23889 * ausence of this color, so if all of the three are set to 0,
23890 * the color will be black.
23892 * These component values should be integers in the range 0 to 255,
23893 * (single 8-bit byte).
23895 * This sets the color used for the route. By default, it is set to
23896 * solid red (r = 255, g = 0, b = 0, a = 255).
23898 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23900 * @see elm_map_route_color_get()
23904 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23907 * Get the route color.
23909 * @param route The route object.
23910 * @param r Pointer where to store the red channel value.
23911 * @param g Pointer where to store the green channel value.
23912 * @param b Pointer where to store the blue channel value.
23913 * @param a Pointer where to store the alpha channel value.
23915 * @see elm_map_route_color_set() for details.
23919 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23922 * Get the route distance in kilometers.
23924 * @param route The route object.
23925 * @return The distance of route (unit : km).
23929 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23932 * Get the information of route nodes.
23934 * @param route The route object.
23935 * @return Returns a string with the nodes of route.
23939 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23942 * Get the information of route waypoint.
23944 * @param route the route object.
23945 * @return Returns a string with information about waypoint of route.
23949 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23952 * Get the address of the name.
23954 * @param name The name handle.
23955 * @return Returns the address string of @p name.
23957 * This gets the coordinates of the @p name, created with one of the
23958 * conversion functions.
23960 * @see elm_map_utils_convert_name_into_coord()
23961 * @see elm_map_utils_convert_coord_into_name()
23965 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23968 * Get the current coordinates of the name.
23970 * @param name The name handle.
23971 * @param lat Pointer where to store the latitude.
23972 * @param lon Pointer where to store The longitude.
23974 * This gets the coordinates of the @p name, created with one of the
23975 * conversion functions.
23977 * @see elm_map_utils_convert_name_into_coord()
23978 * @see elm_map_utils_convert_coord_into_name()
23982 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23985 * Remove a name from the map.
23987 * @param name The name to remove.
23989 * Basically the struct handled by @p name will be freed, so convertions
23990 * between address and coordinates will be lost.
23992 * @see elm_map_utils_convert_name_into_coord()
23993 * @see elm_map_utils_convert_coord_into_name()
23997 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24002 * @param obj The map object.
24003 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
24004 * @param cx Rotation's center horizontal position.
24005 * @param cy Rotation's center vertical position.
24007 * @see elm_map_rotate_get()
24011 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24014 * Get the rotate degree of the map
24016 * @param obj The map object
24017 * @param degree Pointer where to store degrees from 0.0 to 360.0
24018 * to rotate arount Z axis.
24019 * @param cx Pointer where to store rotation's center horizontal position.
24020 * @param cy Pointer where to store rotation's center vertical position.
24022 * @see elm_map_rotate_set() to set map rotation.
24026 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);
24029 * Enable or disable mouse wheel to be used to zoom in / out the map.
24031 * @param obj The map object.
24032 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24035 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24037 * It's disabled by default.
24039 * @see elm_map_wheel_disabled_get()
24043 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24046 * Get a value whether mouse wheel is enabled or not.
24048 * @param obj The map object.
24049 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24050 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24052 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24054 * @see elm_map_wheel_disabled_set() for details.
24058 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24062 * Add a track on the map
24064 * @param obj The map object.
24065 * @param emap The emap route object.
24066 * @return The route object. This is an elm object of type Route.
24068 * @see elm_route_add() for details.
24072 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24076 * Remove a track from the map
24078 * @param obj The map object.
24079 * @param route The track to remove.
24083 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24090 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24092 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24094 EAPI double elm_route_lon_min_get(Evas_Object *obj);
24095 EAPI double elm_route_lat_min_get(Evas_Object *obj);
24096 EAPI double elm_route_lon_max_get(Evas_Object *obj);
24097 EAPI double elm_route_lat_max_get(Evas_Object *obj);
24101 * @defgroup Panel Panel
24103 * @image html img/widget/panel/preview-00.png
24104 * @image latex img/widget/panel/preview-00.eps
24106 * @brief A panel is a type of animated container that contains subobjects.
24107 * It can be expanded or contracted by clicking the button on it's edge.
24109 * Orientations are as follows:
24110 * @li ELM_PANEL_ORIENT_TOP
24111 * @li ELM_PANEL_ORIENT_LEFT
24112 * @li ELM_PANEL_ORIENT_RIGHT
24114 * Default contents parts of the panel widget that you can use for are:
24115 * @li "default" - A content of the panel
24117 * @ref tutorial_panel shows one way to use this widget.
24120 typedef enum _Elm_Panel_Orient
24122 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24123 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24124 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24125 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24126 } Elm_Panel_Orient;
24128 * @brief Adds a panel object
24130 * @param parent The parent object
24132 * @return The panel object, or NULL on failure
24134 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24136 * @brief Sets the orientation of the panel
24138 * @param parent The parent object
24139 * @param orient The panel orientation. Can be one of the following:
24140 * @li ELM_PANEL_ORIENT_TOP
24141 * @li ELM_PANEL_ORIENT_LEFT
24142 * @li ELM_PANEL_ORIENT_RIGHT
24144 * Sets from where the panel will (dis)appear.
24146 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24148 * @brief Get the orientation of the panel.
24150 * @param obj The panel object
24151 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24153 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24155 * @brief Set the content of the panel.
24157 * @param obj The panel object
24158 * @param content The panel content
24160 * Once the content object is set, a previously set one will be deleted.
24161 * If you want to keep that old content object, use the
24162 * elm_panel_content_unset() function.
24164 * @deprecated use elm_object_content_set() instead
24167 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24169 * @brief Get the content of the panel.
24171 * @param obj The panel object
24172 * @return The content that is being used
24174 * Return the content object which is set for this widget.
24176 * @see elm_panel_content_set()
24178 * @deprecated use elm_object_content_get() instead
24181 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24183 * @brief Unset the content of the panel.
24185 * @param obj The panel object
24186 * @return The content that was being used
24188 * Unparent and return the content object which was set for this widget.
24190 * @see elm_panel_content_set()
24192 * @deprecated use elm_object_content_unset() instead
24195 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24197 * @brief Set the state of the panel.
24199 * @param obj The panel object
24200 * @param hidden If true, the panel will run the animation to contract
24202 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24204 * @brief Get the state of the panel.
24206 * @param obj The panel object
24207 * @param hidden If true, the panel is in the "hide" state
24209 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24211 * @brief Toggle the hidden state of the panel from code
24213 * @param obj The panel object
24215 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24221 * @defgroup Panes Panes
24222 * @ingroup Elementary
24224 * @image html img/widget/panes/preview-00.png
24225 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24227 * @image html img/panes.png
24228 * @image latex img/panes.eps width=\textwidth
24230 * The panes adds a dragable bar between two contents. When dragged
24231 * this bar will resize contents size.
24233 * Panes can be displayed vertically or horizontally, and contents
24234 * size proportion can be customized (homogeneous by default).
24236 * Smart callbacks one can listen to:
24237 * - "press" - The panes has been pressed (button wasn't released yet).
24238 * - "unpressed" - The panes was released after being pressed.
24239 * - "clicked" - The panes has been clicked>
24240 * - "clicked,double" - The panes has been double clicked
24242 * Available styles for it:
24245 * Default contents parts of the panes widget that you can use for are:
24246 * @li "left" - A leftside content of the panes
24247 * @li "right" - A rightside content of the panes
24249 * If panes is displayed vertically, left content will be displayed at
24252 * Here is an example on its usage:
24253 * @li @ref panes_example
24257 * @addtogroup Panes
24262 * Add a new panes widget to the given parent Elementary
24263 * (container) object.
24265 * @param parent The parent object.
24266 * @return a new panes widget handle or @c NULL, on errors.
24268 * This function inserts a new panes widget on the canvas.
24272 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24275 * Set the left content of the panes widget.
24277 * @param obj The panes object.
24278 * @param content The new left content object.
24280 * Once the content object is set, a previously set one will be deleted.
24281 * If you want to keep that old content object, use the
24282 * elm_panes_content_left_unset() function.
24284 * If panes is displayed vertically, left content will be displayed at
24287 * @see elm_panes_content_left_get()
24288 * @see elm_panes_content_right_set() to set content on the other side.
24290 * @deprecated use elm_object_part_content_set() instead
24294 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24297 * Set the right content of the panes widget.
24299 * @param obj The panes object.
24300 * @param content The new right content object.
24302 * Once the content object is set, a previously set one will be deleted.
24303 * If you want to keep that old content object, use the
24304 * elm_panes_content_right_unset() function.
24306 * If panes is displayed vertically, left content will be displayed at
24309 * @see elm_panes_content_right_get()
24310 * @see elm_panes_content_left_set() to set content on the other side.
24312 * @deprecated use elm_object_part_content_set() instead
24316 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24319 * Get the left content of the panes.
24321 * @param obj The panes object.
24322 * @return The left content object that is being used.
24324 * Return the left content object which is set for this widget.
24326 * @see elm_panes_content_left_set() for details.
24328 * @deprecated use elm_object_part_content_get() instead
24332 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24335 * Get the right content of the panes.
24337 * @param obj The panes object
24338 * @return The right content object that is being used
24340 * Return the right content object which is set for this widget.
24342 * @see elm_panes_content_right_set() for details.
24344 * @deprecated use elm_object_part_content_get() instead
24348 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24351 * Unset the left content used for the panes.
24353 * @param obj The panes object.
24354 * @return The left content object that was being used.
24356 * Unparent and return the left content object which was set for this widget.
24358 * @see elm_panes_content_left_set() for details.
24359 * @see elm_panes_content_left_get().
24361 * @deprecated use elm_object_part_content_unset() instead
24365 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24368 * Unset the right content used for the panes.
24370 * @param obj The panes object.
24371 * @return The right content object that was being used.
24373 * Unparent and return the right content object which was set for this
24376 * @see elm_panes_content_right_set() for details.
24377 * @see elm_panes_content_right_get().
24379 * @deprecated use elm_object_part_content_unset() instead
24383 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24386 * Get the size proportion of panes widget's left side.
24388 * @param obj The panes object.
24389 * @return float value between 0.0 and 1.0 representing size proportion
24392 * @see elm_panes_content_left_size_set() for more details.
24396 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24399 * Set the size proportion of panes widget's left side.
24401 * @param obj The panes object.
24402 * @param size Value between 0.0 and 1.0 representing size proportion
24405 * By default it's homogeneous, i.e., both sides have the same size.
24407 * If something different is required, it can be set with this function.
24408 * For example, if the left content should be displayed over
24409 * 75% of the panes size, @p size should be passed as @c 0.75.
24410 * This way, right content will be resized to 25% of panes size.
24412 * If displayed vertically, left content is displayed at top, and
24413 * right content at bottom.
24415 * @note This proportion will change when user drags the panes bar.
24417 * @see elm_panes_content_left_size_get()
24421 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24424 * Set the orientation of a given panes widget.
24426 * @param obj The panes object.
24427 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24428 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24430 * Use this function to change how your panes is to be
24431 * disposed: vertically or horizontally.
24433 * By default it's displayed horizontally.
24435 * @see elm_panes_horizontal_get()
24439 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24442 * Retrieve the orientation of a given panes widget.
24444 * @param obj The panes object.
24445 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24446 * @c EINA_FALSE if it's @b vertical (and on errors).
24448 * @see elm_panes_horizontal_set() for more details.
24452 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24453 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24454 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24461 * @defgroup Flip Flip
24463 * @image html img/widget/flip/preview-00.png
24464 * @image latex img/widget/flip/preview-00.eps
24466 * This widget holds 2 content objects(Evas_Object): one on the front and one
24467 * on the back. It allows you to flip from front to back and vice-versa using
24468 * various animations.
24470 * If either the front or back contents are not set the flip will treat that
24471 * as transparent. So if you wore to set the front content but not the back,
24472 * and then call elm_flip_go() you would see whatever is below the flip.
24474 * For a list of supported animations see elm_flip_go().
24476 * Signals that you can add callbacks for are:
24477 * "animate,begin" - when a flip animation was started
24478 * "animate,done" - when a flip animation is finished
24480 * @ref tutorial_flip show how to use most of the API.
24484 typedef enum _Elm_Flip_Mode
24486 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24487 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24488 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24489 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24490 ELM_FLIP_CUBE_LEFT,
24491 ELM_FLIP_CUBE_RIGHT,
24493 ELM_FLIP_CUBE_DOWN,
24494 ELM_FLIP_PAGE_LEFT,
24495 ELM_FLIP_PAGE_RIGHT,
24499 typedef enum _Elm_Flip_Interaction
24501 ELM_FLIP_INTERACTION_NONE,
24502 ELM_FLIP_INTERACTION_ROTATE,
24503 ELM_FLIP_INTERACTION_CUBE,
24504 ELM_FLIP_INTERACTION_PAGE
24505 } Elm_Flip_Interaction;
24506 typedef enum _Elm_Flip_Direction
24508 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24509 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24510 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24511 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24512 } Elm_Flip_Direction;
24514 * @brief Add a new flip to the parent
24516 * @param parent The parent object
24517 * @return The new object or NULL if it cannot be created
24519 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24521 * @brief Set the front content of the flip widget.
24523 * @param obj The flip object
24524 * @param content The new front content object
24526 * Once the content object is set, a previously set one will be deleted.
24527 * If you want to keep that old content object, use the
24528 * elm_flip_content_front_unset() function.
24530 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24532 * @brief Set the back content of the flip widget.
24534 * @param obj The flip object
24535 * @param content The new back content object
24537 * Once the content object is set, a previously set one will be deleted.
24538 * If you want to keep that old content object, use the
24539 * elm_flip_content_back_unset() function.
24541 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24543 * @brief Get the front content used for the flip
24545 * @param obj The flip object
24546 * @return The front content object that is being used
24548 * Return the front content object which is set for this widget.
24550 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24552 * @brief Get the back content used for the flip
24554 * @param obj The flip object
24555 * @return The back content object that is being used
24557 * Return the back content object which is set for this widget.
24559 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24561 * @brief Unset the front content used for the flip
24563 * @param obj The flip object
24564 * @return The front content object that was being used
24566 * Unparent and return the front content object which was set for this widget.
24568 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24570 * @brief Unset the back content used for the flip
24572 * @param obj The flip object
24573 * @return The back content object that was being used
24575 * Unparent and return the back content object which was set for this widget.
24577 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24579 * @brief Get flip front visibility state
24581 * @param obj The flip objct
24582 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24585 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24587 * @brief Set flip perspective
24589 * @param obj The flip object
24590 * @param foc The coordinate to set the focus on
24591 * @param x The X coordinate
24592 * @param y The Y coordinate
24594 * @warning This function currently does nothing.
24596 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24598 * @brief Runs the flip animation
24600 * @param obj The flip object
24601 * @param mode The mode type
24603 * Flips the front and back contents using the @p mode animation. This
24604 * efectively hides the currently visible content and shows the hidden one.
24606 * There a number of possible animations to use for the flipping:
24607 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24608 * around a horizontal axis in the middle of its height, the other content
24609 * is shown as the other side of the flip.
24610 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24611 * around a vertical axis in the middle of its width, the other content is
24612 * shown as the other side of the flip.
24613 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24614 * around a diagonal axis in the middle of its width, the other content is
24615 * shown as the other side of the flip.
24616 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24617 * around a diagonal axis in the middle of its height, the other content is
24618 * shown as the other side of the flip.
24619 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24620 * as if the flip was a cube, the other content is show as the right face of
24622 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24623 * right as if the flip was a cube, the other content is show as the left
24624 * face of the cube.
24625 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24626 * flip was a cube, the other content is show as the bottom face of the cube.
24627 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24628 * the flip was a cube, the other content is show as the upper face of the
24630 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24631 * if the flip was a book, the other content is shown as the page below that.
24632 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24633 * as if the flip was a book, the other content is shown as the page below
24635 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24636 * flip was a book, the other content is shown as the page below that.
24637 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24638 * flip was a book, the other content is shown as the page below that.
24640 * @image html elm_flip.png
24641 * @image latex elm_flip.eps width=\textwidth
24643 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24645 * @brief Set the interactive flip mode
24647 * @param obj The flip object
24648 * @param mode The interactive flip mode to use
24650 * This sets if the flip should be interactive (allow user to click and
24651 * drag a side of the flip to reveal the back page and cause it to flip).
24652 * By default a flip is not interactive. You may also need to set which
24653 * sides of the flip are "active" for flipping and how much space they use
24654 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24655 * and elm_flip_interacton_direction_hitsize_set()
24657 * The four avilable mode of interaction are:
24658 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24659 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24660 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24661 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24663 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24664 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24665 * happen, those can only be acheived with elm_flip_go();
24667 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24669 * @brief Get the interactive flip mode
24671 * @param obj The flip object
24672 * @return The interactive flip mode
24674 * Returns the interactive flip mode set by elm_flip_interaction_set()
24676 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24678 * @brief Set which directions of the flip respond to interactive flip
24680 * @param obj The flip object
24681 * @param dir The direction to change
24682 * @param enabled If that direction is enabled or not
24684 * By default all directions are disabled, so you may want to enable the
24685 * desired directions for flipping if you need interactive flipping. You must
24686 * call this function once for each direction that should be enabled.
24688 * @see elm_flip_interaction_set()
24690 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24692 * @brief Get the enabled state of that flip direction
24694 * @param obj The flip object
24695 * @param dir The direction to check
24696 * @return If that direction is enabled or not
24698 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24700 * @see elm_flip_interaction_set()
24702 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24704 * @brief Set the amount of the flip that is sensitive to interactive flip
24706 * @param obj The flip object
24707 * @param dir The direction to modify
24708 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24710 * Set the amount of the flip that is sensitive to interactive flip, with 0
24711 * representing no area in the flip and 1 representing the entire flip. There
24712 * is however a consideration to be made in that the area will never be
24713 * smaller than the finger size set(as set in your Elementary configuration).
24715 * @see elm_flip_interaction_set()
24717 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24719 * @brief Get the amount of the flip that is sensitive to interactive flip
24721 * @param obj The flip object
24722 * @param dir The direction to check
24723 * @return The size set for that direction
24725 * Returns the amount os sensitive area set by
24726 * elm_flip_interacton_direction_hitsize_set().
24728 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24733 /* scrolledentry */
24734 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24735 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24736 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24737 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24738 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24739 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24740 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24741 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24742 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24743 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24744 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24745 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24746 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24747 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24748 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24749 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24750 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24751 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24752 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24753 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24754 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24755 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24756 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24757 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24758 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24759 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24760 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24761 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24762 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24763 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24764 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24765 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24766 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24767 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24768 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24769 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);
24770 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24771 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24772 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);
24773 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24774 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);
24775 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24776 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24777 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24778 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24779 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24780 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24781 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24782 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24783 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);
24784 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);
24785 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);
24786 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);
24787 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);
24788 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);
24789 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24790 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24791 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24792 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24793 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24794 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24795 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24798 * @defgroup Conformant Conformant
24799 * @ingroup Elementary
24801 * @image html img/widget/conformant/preview-00.png
24802 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24804 * @image html img/conformant.png
24805 * @image latex img/conformant.eps width=\textwidth
24807 * The aim is to provide a widget that can be used in elementary apps to
24808 * account for space taken up by the indicator, virtual keypad & softkey
24809 * windows when running the illume2 module of E17.
24811 * So conformant content will be sized and positioned considering the
24812 * space required for such stuff, and when they popup, as a keyboard
24813 * shows when an entry is selected, conformant content won't change.
24815 * Available styles for it:
24818 * Default contents parts of the conformant widget that you can use for are:
24819 * @li "default" - A content of the conformant
24821 * See how to use this widget in this example:
24822 * @ref conformant_example
24826 * @addtogroup Conformant
24831 * Add a new conformant widget to the given parent Elementary
24832 * (container) object.
24834 * @param parent The parent object.
24835 * @return A new conformant widget handle or @c NULL, on errors.
24837 * This function inserts a new conformant widget on the canvas.
24839 * @ingroup Conformant
24841 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24844 * Set the content of the conformant widget.
24846 * @param obj The conformant object.
24847 * @param content The content to be displayed by the conformant.
24849 * Content will be sized and positioned considering the space required
24850 * to display a virtual keyboard. So it won't fill all the conformant
24851 * size. This way is possible to be sure that content won't resize
24852 * or be re-positioned after the keyboard is displayed.
24854 * Once the content object is set, a previously set one will be deleted.
24855 * If you want to keep that old content object, use the
24856 * elm_object_content_unset() function.
24858 * @see elm_object_content_unset()
24859 * @see elm_object_content_get()
24861 * @deprecated use elm_object_content_set() instead
24863 * @ingroup Conformant
24865 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24868 * Get the content of the conformant widget.
24870 * @param obj The conformant object.
24871 * @return The content that is being used.
24873 * Return the content object which is set for this widget.
24874 * It won't be unparent from conformant. For that, use
24875 * elm_object_content_unset().
24877 * @see elm_object_content_set().
24878 * @see elm_object_content_unset()
24880 * @deprecated use elm_object_content_get() instead
24882 * @ingroup Conformant
24884 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24887 * Unset the content of the conformant widget.
24889 * @param obj The conformant object.
24890 * @return The content that was being used.
24892 * Unparent and return the content object which was set for this widget.
24894 * @see elm_object_content_set().
24896 * @deprecated use elm_object_content_unset() instead
24898 * @ingroup Conformant
24900 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24903 * Returns the Evas_Object that represents the content area.
24905 * @param obj The conformant object.
24906 * @return The content area of the widget.
24908 * @ingroup Conformant
24910 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24917 * @defgroup Mapbuf Mapbuf
24918 * @ingroup Elementary
24920 * @image html img/widget/mapbuf/preview-00.png
24921 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24923 * This holds one content object and uses an Evas Map of transformation
24924 * points to be later used with this content. So the content will be
24925 * moved, resized, etc as a single image. So it will improve performance
24926 * when you have a complex interafce, with a lot of elements, and will
24927 * need to resize or move it frequently (the content object and its
24930 * Default contents parts of the mapbuf widget that you can use for are:
24931 * @li "default" - A content of the mapbuf
24933 * To enable map, elm_mapbuf_enabled_set() should be used.
24935 * See how to use this widget in this example:
24936 * @ref mapbuf_example
24940 * @addtogroup Mapbuf
24945 * Add a new mapbuf widget to the given parent Elementary
24946 * (container) object.
24948 * @param parent The parent object.
24949 * @return A new mapbuf widget handle or @c NULL, on errors.
24951 * This function inserts a new mapbuf widget on the canvas.
24955 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24958 * Set the content of the mapbuf.
24960 * @param obj The mapbuf object.
24961 * @param content The content that will be filled in this mapbuf object.
24963 * Once the content object is set, a previously set one will be deleted.
24964 * If you want to keep that old content object, use the
24965 * elm_mapbuf_content_unset() function.
24967 * To enable map, elm_mapbuf_enabled_set() should be used.
24969 * @deprecated use elm_object_content_set() instead
24973 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24976 * Get the content of the mapbuf.
24978 * @param obj The mapbuf object.
24979 * @return The content that is being used.
24981 * Return the content object which is set for this widget.
24983 * @see elm_mapbuf_content_set() for details.
24985 * @deprecated use elm_object_content_get() instead
24989 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24992 * Unset the content of the mapbuf.
24994 * @param obj The mapbuf object.
24995 * @return The content that was being used.
24997 * Unparent and return the content object which was set for this widget.
24999 * @see elm_mapbuf_content_set() for details.
25001 * @deprecated use elm_object_content_unset() instead
25005 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25008 * Enable or disable the map.
25010 * @param obj The mapbuf object.
25011 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25013 * This enables the map that is set or disables it. On enable, the object
25014 * geometry will be saved, and the new geometry will change (position and
25015 * size) to reflect the map geometry set.
25017 * Also, when enabled, alpha and smooth states will be used, so if the
25018 * content isn't solid, alpha should be enabled, for example, otherwise
25019 * a black retangle will fill the content.
25021 * When disabled, the stored map will be freed and geometry prior to
25022 * enabling the map will be restored.
25024 * It's disabled by default.
25026 * @see elm_mapbuf_alpha_set()
25027 * @see elm_mapbuf_smooth_set()
25031 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25034 * Get a value whether map is enabled or not.
25036 * @param obj The mapbuf object.
25037 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25038 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25040 * @see elm_mapbuf_enabled_set() for details.
25044 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25047 * Enable or disable smooth map rendering.
25049 * @param obj The mapbuf object.
25050 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25053 * This sets smoothing for map rendering. If the object is a type that has
25054 * its own smoothing settings, then both the smooth settings for this object
25055 * and the map must be turned off.
25057 * By default smooth maps are enabled.
25061 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25064 * Get a value whether smooth map rendering is enabled or not.
25066 * @param obj The mapbuf object.
25067 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25068 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25070 * @see elm_mapbuf_smooth_set() for details.
25074 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25077 * Set or unset alpha flag for map rendering.
25079 * @param obj The mapbuf object.
25080 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25083 * This sets alpha flag for map rendering. If the object is a type that has
25084 * its own alpha settings, then this will take precedence. Only image objects
25085 * have this currently. It stops alpha blending of the map area, and is
25086 * useful if you know the object and/or all sub-objects is 100% solid.
25088 * Alpha is enabled by default.
25092 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25095 * Get a value whether alpha blending is enabled or not.
25097 * @param obj The mapbuf object.
25098 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25099 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25101 * @see elm_mapbuf_alpha_set() for details.
25105 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25112 * @defgroup Flipselector Flip Selector
25114 * @image html img/widget/flipselector/preview-00.png
25115 * @image latex img/widget/flipselector/preview-00.eps
25117 * A flip selector is a widget to show a set of @b text items, one
25118 * at a time, with the same sheet switching style as the @ref Clock
25119 * "clock" widget, when one changes the current displaying sheet
25120 * (thus, the "flip" in the name).
25122 * User clicks to flip sheets which are @b held for some time will
25123 * make the flip selector to flip continuosly and automatically for
25124 * the user. The interval between flips will keep growing in time,
25125 * so that it helps the user to reach an item which is distant from
25126 * the current selection.
25128 * Smart callbacks one can register to:
25129 * - @c "selected" - when the widget's selected text item is changed
25130 * - @c "overflowed" - when the widget's current selection is changed
25131 * from the first item in its list to the last
25132 * - @c "underflowed" - when the widget's current selection is changed
25133 * from the last item in its list to the first
25135 * Available styles for it:
25138 * To set/get the label of the flipselector item, you can use
25139 * elm_object_item_text_set/get APIs.
25140 * Once the text is set, a previously set one will be deleted.
25142 * Here is an example on its usage:
25143 * @li @ref flipselector_example
25147 * @addtogroup Flipselector
25152 * Add a new flip selector widget to the given parent Elementary
25153 * (container) widget
25155 * @param parent The parent object
25156 * @return a new flip selector widget handle or @c NULL, on errors
25158 * This function inserts a new flip selector widget on the canvas.
25160 * @ingroup Flipselector
25162 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25165 * Programmatically select the next item of a flip selector widget
25167 * @param obj The flipselector object
25169 * @note The selection will be animated. Also, if it reaches the
25170 * end of its list of member items, it will continue with the first
25173 * @ingroup Flipselector
25175 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25178 * Programmatically select the previous item of a flip selector
25181 * @param obj The flipselector object
25183 * @note The selection will be animated. Also, if it reaches the
25184 * beginning of its list of member items, it will continue with the
25185 * last one backwards.
25187 * @ingroup Flipselector
25189 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25192 * Append a (text) item to a flip selector widget
25194 * @param obj The flipselector object
25195 * @param label The (text) label of the new item
25196 * @param func Convenience callback function to take place when
25198 * @param data Data passed to @p func, above
25199 * @return A handle to the item added or @c NULL, on errors
25201 * The widget's list of labels to show will be appended with the
25202 * given value. If the user wishes so, a callback function pointer
25203 * can be passed, which will get called when this same item is
25206 * @note The current selection @b won't be modified by appending an
25207 * element to the list.
25209 * @note The maximum length of the text label is going to be
25210 * determined <b>by the widget's theme</b>. Strings larger than
25211 * that value are going to be @b truncated.
25213 * @ingroup Flipselector
25215 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25218 * Prepend a (text) item to a flip selector widget
25220 * @param obj The flipselector object
25221 * @param label The (text) label of the new item
25222 * @param func Convenience callback function to take place when
25224 * @param data Data passed to @p func, above
25225 * @return A handle to the item added or @c NULL, on errors
25227 * The widget's list of labels to show will be prepended with the
25228 * given value. If the user wishes so, a callback function pointer
25229 * can be passed, which will get called when this same item is
25232 * @note The current selection @b won't be modified by prepending
25233 * an element to the list.
25235 * @note The maximum length of the text label is going to be
25236 * determined <b>by the widget's theme</b>. Strings larger than
25237 * that value are going to be @b truncated.
25239 * @ingroup Flipselector
25241 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25244 * Get the internal list of items in a given flip selector widget.
25246 * @param obj The flipselector object
25247 * @return The list of items (#Elm_Object_Item as data) or
25248 * @c NULL on errors.
25250 * This list is @b not to be modified in any way and must not be
25251 * freed. Use the list members with functions like
25252 * elm_object_item_text_set(),
25253 * elm_object_item_text_get(),
25254 * elm_flipselector_item_del(),
25255 * elm_flipselector_item_selected_get(),
25256 * elm_flipselector_item_selected_set().
25258 * @warning This list is only valid until @p obj object's internal
25259 * items list is changed. It should be fetched again with another
25260 * call to this function when changes happen.
25262 * @ingroup Flipselector
25264 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25267 * Get the first item in the given flip selector widget's list of
25270 * @param obj The flipselector object
25271 * @return The first item or @c NULL, if it has no items (and on
25274 * @see elm_flipselector_item_append()
25275 * @see elm_flipselector_last_item_get()
25277 * @ingroup Flipselector
25279 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25282 * Get the last item in the given flip selector widget's list of
25285 * @param obj The flipselector object
25286 * @return The last item or @c NULL, if it has no items (and on
25289 * @see elm_flipselector_item_prepend()
25290 * @see elm_flipselector_first_item_get()
25292 * @ingroup Flipselector
25294 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25297 * Get the currently selected item in a flip selector widget.
25299 * @param obj The flipselector object
25300 * @return The selected item or @c NULL, if the widget has no items
25303 * @ingroup Flipselector
25305 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25308 * Set whether a given flip selector widget's item should be the
25309 * currently selected one.
25311 * @param it The flip selector item
25312 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25314 * This sets whether @p item is or not the selected (thus, under
25315 * display) one. If @p item is different than one under display,
25316 * the latter will be unselected. If the @p item is set to be
25317 * unselected, on the other hand, the @b first item in the widget's
25318 * internal members list will be the new selected one.
25320 * @see elm_flipselector_item_selected_get()
25322 * @ingroup Flipselector
25324 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25327 * Get whether a given flip selector widget's item is the currently
25330 * @param it The flip selector item
25331 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25334 * @see elm_flipselector_item_selected_set()
25336 * @ingroup Flipselector
25338 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25341 * Delete a given item from a flip selector widget.
25343 * @param it The item to delete
25345 * @ingroup Flipselector
25347 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25350 * Get the label of a given flip selector widget's item.
25352 * @param it The item to get label from
25353 * @return The text label of @p item or @c NULL, on errors
25355 * @see elm_object_item_text_set()
25357 * @deprecated see elm_object_item_text_get() instead
25358 * @ingroup Flipselector
25360 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25363 * Set the label of a given flip selector widget's item.
25365 * @param it The item to set label on
25366 * @param label The text label string, in UTF-8 encoding
25368 * @see elm_object_item_text_get()
25370 * @deprecated see elm_object_item_text_set() instead
25371 * @ingroup Flipselector
25373 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25376 * Gets the item before @p item in a flip selector widget's
25377 * internal list of items.
25379 * @param it The item to fetch previous from
25380 * @return The item before the @p item, in its parent's list. If
25381 * there is no previous item for @p item or there's an
25382 * error, @c NULL is returned.
25384 * @see elm_flipselector_item_next_get()
25386 * @ingroup Flipselector
25388 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25391 * Gets the item after @p item in a flip selector widget's
25392 * internal list of items.
25394 * @param it The item to fetch next from
25395 * @return The item after the @p item, in its parent's list. If
25396 * there is no next item for @p item or there's an
25397 * error, @c NULL is returned.
25399 * @see elm_flipselector_item_next_get()
25401 * @ingroup Flipselector
25403 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25406 * Set the interval on time updates for an user mouse button hold
25407 * on a flip selector widget.
25409 * @param obj The flip selector object
25410 * @param interval The (first) interval value in seconds
25412 * This interval value is @b decreased while the user holds the
25413 * mouse pointer either flipping up or flipping doww a given flip
25416 * This helps the user to get to a given item distant from the
25417 * current one easier/faster, as it will start to flip quicker and
25418 * quicker on mouse button holds.
25420 * The calculation for the next flip interval value, starting from
25421 * the one set with this call, is the previous interval divided by
25422 * 1.05, so it decreases a little bit.
25424 * The default starting interval value for automatic flips is
25427 * @see elm_flipselector_interval_get()
25429 * @ingroup Flipselector
25431 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25434 * Get the interval on time updates for an user mouse button hold
25435 * on a flip selector widget.
25437 * @param obj The flip selector object
25438 * @return The (first) interval value, in seconds, set on it
25440 * @see elm_flipselector_interval_set() for more details
25442 * @ingroup Flipselector
25444 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25450 * @addtogroup Calendar
25455 * @enum _Elm_Calendar_Mark_Repeat
25456 * @typedef Elm_Calendar_Mark_Repeat
25458 * Event periodicity, used to define if a mark should be repeated
25459 * @b beyond event's day. It's set when a mark is added.
25461 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25462 * there will be marks every week after this date. Marks will be displayed
25463 * at 13th, 20th, 27th, 3rd June ...
25465 * Values don't work as bitmask, only one can be choosen.
25467 * @see elm_calendar_mark_add()
25469 * @ingroup Calendar
25471 typedef enum _Elm_Calendar_Mark_Repeat
25473 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25474 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25475 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25476 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*/
25477 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. */
25478 } Elm_Calendar_Mark_Repeat;
25480 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(). */
25483 * Add a new calendar widget to the given parent Elementary
25484 * (container) object.
25486 * @param parent The parent object.
25487 * @return a new calendar widget handle or @c NULL, on errors.
25489 * This function inserts a new calendar widget on the canvas.
25491 * @ref calendar_example_01
25493 * @ingroup Calendar
25495 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25498 * Get weekdays names displayed by the calendar.
25500 * @param obj The calendar object.
25501 * @return Array of seven strings to be used as weekday names.
25503 * By default, weekdays abbreviations get from system are displayed:
25504 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25505 * The first string is related to Sunday, the second to Monday...
25507 * @see elm_calendar_weekdays_name_set()
25509 * @ref calendar_example_05
25511 * @ingroup Calendar
25513 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25516 * Set weekdays names to be displayed by the calendar.
25518 * @param obj The calendar object.
25519 * @param weekdays Array of seven strings to be used as weekday names.
25520 * @warning It must have 7 elements, or it will access invalid memory.
25521 * @warning The strings must be NULL terminated ('@\0').
25523 * By default, weekdays abbreviations get from system are displayed:
25524 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25526 * The first string should be related to Sunday, the second to Monday...
25528 * The usage should be like this:
25530 * const char *weekdays[] =
25532 * "Sunday", "Monday", "Tuesday", "Wednesday",
25533 * "Thursday", "Friday", "Saturday"
25535 * elm_calendar_weekdays_names_set(calendar, weekdays);
25538 * @see elm_calendar_weekdays_name_get()
25540 * @ref calendar_example_02
25542 * @ingroup Calendar
25544 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25547 * Set the minimum and maximum values for the year
25549 * @param obj The calendar object
25550 * @param min The minimum year, greater than 1901;
25551 * @param max The maximum year;
25553 * Maximum must be greater than minimum, except if you don't wan't to set
25555 * Default values are 1902 and -1.
25557 * If the maximum year is a negative value, it will be limited depending
25558 * on the platform architecture (year 2037 for 32 bits);
25560 * @see elm_calendar_min_max_year_get()
25562 * @ref calendar_example_03
25564 * @ingroup Calendar
25566 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25569 * Get the minimum and maximum values for the year
25571 * @param obj The calendar object.
25572 * @param min The minimum year.
25573 * @param max The maximum year.
25575 * Default values are 1902 and -1.
25577 * @see elm_calendar_min_max_year_get() for more details.
25579 * @ref calendar_example_05
25581 * @ingroup Calendar
25583 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25586 * Enable or disable day selection
25588 * @param obj The calendar object.
25589 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25592 * Enabled by default. If disabled, the user still can select months,
25593 * but not days. Selected days are highlighted on calendar.
25594 * It should be used if you won't need such selection for the widget usage.
25596 * When a day is selected, or month is changed, smart callbacks for
25597 * signal "changed" will be called.
25599 * @see elm_calendar_day_selection_enable_get()
25601 * @ref calendar_example_04
25603 * @ingroup Calendar
25605 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25608 * Get a value whether day selection is enabled or not.
25610 * @see elm_calendar_day_selection_enable_set() for details.
25612 * @param obj The calendar object.
25613 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25614 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25616 * @ref calendar_example_05
25618 * @ingroup Calendar
25620 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25624 * Set selected date to be highlighted on calendar.
25626 * @param obj The calendar object.
25627 * @param selected_time A @b tm struct to represent the selected date.
25629 * Set the selected date, changing the displayed month if needed.
25630 * Selected date changes when the user goes to next/previous month or
25631 * select a day pressing over it on calendar.
25633 * @see elm_calendar_selected_time_get()
25635 * @ref calendar_example_04
25637 * @ingroup Calendar
25639 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25642 * Get selected date.
25644 * @param obj The calendar object
25645 * @param selected_time A @b tm struct to point to selected date
25646 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25649 * Get date selected by the user or set by function
25650 * elm_calendar_selected_time_set().
25651 * Selected date changes when the user goes to next/previous month or
25652 * select a day pressing over it on calendar.
25654 * @see elm_calendar_selected_time_get()
25656 * @ref calendar_example_05
25658 * @ingroup Calendar
25660 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25663 * Set a function to format the string that will be used to display
25666 * @param obj The calendar object
25667 * @param format_function Function to set the month-year string given
25668 * the selected date
25670 * By default it uses strftime with "%B %Y" format string.
25671 * It should allocate the memory that will be used by the string,
25672 * that will be freed by the widget after usage.
25673 * A pointer to the string and a pointer to the time struct will be provided.
25678 * _format_month_year(struct tm *selected_time)
25681 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25682 * return strdup(buf);
25685 * elm_calendar_format_function_set(calendar, _format_month_year);
25688 * @ref calendar_example_02
25690 * @ingroup Calendar
25692 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25695 * Add a new mark to the calendar
25697 * @param obj The calendar object
25698 * @param mark_type A string used to define the type of mark. It will be
25699 * emitted to the theme, that should display a related modification on these
25700 * days representation.
25701 * @param mark_time A time struct to represent the date of inclusion of the
25702 * mark. For marks that repeats it will just be displayed after the inclusion
25703 * date in the calendar.
25704 * @param repeat Repeat the event following this periodicity. Can be a unique
25705 * mark (that don't repeat), daily, weekly, monthly or annually.
25706 * @return The created mark or @p NULL upon failure.
25708 * Add a mark that will be drawn in the calendar respecting the insertion
25709 * time and periodicity. It will emit the type as signal to the widget theme.
25710 * Default theme supports "holiday" and "checked", but it can be extended.
25712 * It won't immediately update the calendar, drawing the marks.
25713 * For this, call elm_calendar_marks_draw(). However, when user selects
25714 * next or previous month calendar forces marks drawn.
25716 * Marks created with this method can be deleted with
25717 * elm_calendar_mark_del().
25721 * struct tm selected_time;
25722 * time_t current_time;
25724 * current_time = time(NULL) + 5 * 84600;
25725 * localtime_r(¤t_time, &selected_time);
25726 * elm_calendar_mark_add(cal, "holiday", selected_time,
25727 * ELM_CALENDAR_ANNUALLY);
25729 * current_time = time(NULL) + 1 * 84600;
25730 * localtime_r(¤t_time, &selected_time);
25731 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25733 * elm_calendar_marks_draw(cal);
25736 * @see elm_calendar_marks_draw()
25737 * @see elm_calendar_mark_del()
25739 * @ref calendar_example_06
25741 * @ingroup Calendar
25743 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);
25746 * Delete mark from the calendar.
25748 * @param mark The mark to be deleted.
25750 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25751 * should be used instead of getting marks list and deleting each one.
25753 * @see elm_calendar_mark_add()
25755 * @ref calendar_example_06
25757 * @ingroup Calendar
25759 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25762 * Remove all calendar's marks
25764 * @param obj The calendar object.
25766 * @see elm_calendar_mark_add()
25767 * @see elm_calendar_mark_del()
25769 * @ingroup Calendar
25771 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25775 * Get a list of all the calendar marks.
25777 * @param obj The calendar object.
25778 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25780 * @see elm_calendar_mark_add()
25781 * @see elm_calendar_mark_del()
25782 * @see elm_calendar_marks_clear()
25784 * @ingroup Calendar
25786 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25789 * Draw calendar marks.
25791 * @param obj The calendar object.
25793 * Should be used after adding, removing or clearing marks.
25794 * It will go through the entire marks list updating the calendar.
25795 * If lots of marks will be added, add all the marks and then call
25798 * When the month is changed, i.e. user selects next or previous month,
25799 * marks will be drawed.
25801 * @see elm_calendar_mark_add()
25802 * @see elm_calendar_mark_del()
25803 * @see elm_calendar_marks_clear()
25805 * @ref calendar_example_06
25807 * @ingroup Calendar
25809 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25812 * Set a day text color to the same that represents Saturdays.
25814 * @param obj The calendar object.
25815 * @param pos The text position. Position is the cell counter, from left
25816 * to right, up to down. It starts on 0 and ends on 41.
25818 * @deprecated use elm_calendar_mark_add() instead like:
25821 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25822 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25825 * @see elm_calendar_mark_add()
25827 * @ingroup Calendar
25829 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25832 * Set a day text color to the same that represents Sundays.
25834 * @param obj The calendar object.
25835 * @param pos The text position. Position is the cell counter, from left
25836 * to right, up to down. It starts on 0 and ends on 41.
25838 * @deprecated use elm_calendar_mark_add() instead like:
25841 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25842 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25845 * @see elm_calendar_mark_add()
25847 * @ingroup Calendar
25849 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25852 * Set a day text color to the same that represents Weekdays.
25854 * @param obj The calendar object
25855 * @param pos The text position. Position is the cell counter, from left
25856 * to right, up to down. It starts on 0 and ends on 41.
25858 * @deprecated use elm_calendar_mark_add() instead like:
25861 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25863 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25864 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25865 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25866 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25867 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25868 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25869 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25870 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25871 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25874 * @see elm_calendar_mark_add()
25876 * @ingroup Calendar
25878 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25881 * Set the interval on time updates for an user mouse button hold
25882 * on calendar widgets' month selection.
25884 * @param obj The calendar object
25885 * @param interval The (first) interval value in seconds
25887 * This interval value is @b decreased while the user holds the
25888 * mouse pointer either selecting next or previous month.
25890 * This helps the user to get to a given month distant from the
25891 * current one easier/faster, as it will start to change quicker and
25892 * quicker on mouse button holds.
25894 * The calculation for the next change interval value, starting from
25895 * the one set with this call, is the previous interval divided by
25896 * 1.05, so it decreases a little bit.
25898 * The default starting interval value for automatic changes is
25901 * @see elm_calendar_interval_get()
25903 * @ingroup Calendar
25905 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25908 * Get the interval on time updates for an user mouse button hold
25909 * on calendar widgets' month selection.
25911 * @param obj The calendar object
25912 * @return The (first) interval value, in seconds, set on it
25914 * @see elm_calendar_interval_set() for more details
25916 * @ingroup Calendar
25918 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25925 * @defgroup Diskselector Diskselector
25926 * @ingroup Elementary
25928 * @image html img/widget/diskselector/preview-00.png
25929 * @image latex img/widget/diskselector/preview-00.eps
25931 * A diskselector is a kind of list widget. It scrolls horizontally,
25932 * and can contain label and icon objects. Three items are displayed
25933 * with the selected one in the middle.
25935 * It can act like a circular list with round mode and labels can be
25936 * reduced for a defined length for side items.
25938 * Smart callbacks one can listen to:
25939 * - "selected" - when item is selected, i.e. scroller stops.
25941 * Available styles for it:
25944 * List of examples:
25945 * @li @ref diskselector_example_01
25946 * @li @ref diskselector_example_02
25950 * @addtogroup Diskselector
25954 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(). */
25957 * Add a new diskselector widget to the given parent Elementary
25958 * (container) object.
25960 * @param parent The parent object.
25961 * @return a new diskselector widget handle or @c NULL, on errors.
25963 * This function inserts a new diskselector widget on the canvas.
25965 * @ingroup Diskselector
25967 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25970 * Enable or disable round mode.
25972 * @param obj The diskselector object.
25973 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25976 * Disabled by default. If round mode is enabled the items list will
25977 * work like a circle list, so when the user reaches the last item,
25978 * the first one will popup.
25980 * @see elm_diskselector_round_get()
25982 * @ingroup Diskselector
25984 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25987 * Get a value whether round mode is enabled or not.
25989 * @see elm_diskselector_round_set() for details.
25991 * @param obj The diskselector object.
25992 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25993 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25995 * @ingroup Diskselector
25997 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26000 * Get the side labels max length.
26002 * @deprecated use elm_diskselector_side_label_length_get() instead:
26004 * @param obj The diskselector object.
26005 * @return The max length defined for side labels, or 0 if not a valid
26008 * @ingroup Diskselector
26010 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26013 * Set the side labels max length.
26015 * @deprecated use elm_diskselector_side_label_length_set() instead:
26017 * @param obj The diskselector object.
26018 * @param len The max length defined for side labels.
26020 * @ingroup Diskselector
26022 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26025 * Get the side labels max length.
26027 * @see elm_diskselector_side_label_length_set() for details.
26029 * @param obj The diskselector object.
26030 * @return The max length defined for side labels, or 0 if not a valid
26033 * @ingroup Diskselector
26035 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26038 * Set the side labels max length.
26040 * @param obj The diskselector object.
26041 * @param len The max length defined for side labels.
26043 * Length is the number of characters of items' label that will be
26044 * visible when it's set on side positions. It will just crop
26045 * the string after defined size. E.g.:
26047 * An item with label "January" would be displayed on side position as
26048 * "Jan" if max length is set to 3, or "Janu", if this property
26051 * When it's selected, the entire label will be displayed, except for
26052 * width restrictions. In this case label will be cropped and "..."
26053 * will be concatenated.
26055 * Default side label max length is 3.
26057 * This property will be applyed over all items, included before or
26058 * later this function call.
26060 * @ingroup Diskselector
26062 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26065 * Set the number of items to be displayed.
26067 * @param obj The diskselector object.
26068 * @param num The number of items the diskselector will display.
26070 * Default value is 3, and also it's the minimun. If @p num is less
26071 * than 3, it will be set to 3.
26073 * Also, it can be set on theme, using data item @c display_item_num
26074 * on group "elm/diskselector/item/X", where X is style set.
26077 * group { name: "elm/diskselector/item/X";
26079 * item: "display_item_num" "5";
26082 * @ingroup Diskselector
26084 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26087 * Get the number of items in the diskselector object.
26089 * @param obj The diskselector object.
26091 * @ingroup Diskselector
26093 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26096 * Set bouncing behaviour when the scrolled content reaches an edge.
26098 * Tell the internal scroller object whether it should bounce or not
26099 * when it reaches the respective edges for each axis.
26101 * @param obj The diskselector object.
26102 * @param h_bounce Whether to bounce or not in the horizontal axis.
26103 * @param v_bounce Whether to bounce or not in the vertical axis.
26105 * @see elm_scroller_bounce_set()
26107 * @ingroup Diskselector
26109 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26112 * Get the bouncing behaviour of the internal scroller.
26114 * Get whether the internal scroller should bounce when the edge of each
26115 * axis is reached scrolling.
26117 * @param obj The diskselector object.
26118 * @param h_bounce Pointer where to store the bounce state of the horizontal
26120 * @param v_bounce Pointer where to store the bounce state of the vertical
26123 * @see elm_scroller_bounce_get()
26124 * @see elm_diskselector_bounce_set()
26126 * @ingroup Diskselector
26128 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26131 * Get the scrollbar policy.
26133 * @see elm_diskselector_scroller_policy_get() for details.
26135 * @param obj The diskselector object.
26136 * @param policy_h Pointer where to store horizontal scrollbar policy.
26137 * @param policy_v Pointer where to store vertical scrollbar policy.
26139 * @ingroup Diskselector
26141 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);
26144 * Set the scrollbar policy.
26146 * @param obj The diskselector object.
26147 * @param policy_h Horizontal scrollbar policy.
26148 * @param policy_v Vertical scrollbar policy.
26150 * This sets the scrollbar visibility policy for the given scroller.
26151 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26152 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26153 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26154 * This applies respectively for the horizontal and vertical scrollbars.
26156 * The both are disabled by default, i.e., are set to
26157 * #ELM_SCROLLER_POLICY_OFF.
26159 * @ingroup Diskselector
26161 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26164 * Remove all diskselector's items.
26166 * @param obj The diskselector object.
26168 * @see elm_diskselector_item_del()
26169 * @see elm_diskselector_item_append()
26171 * @ingroup Diskselector
26173 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26176 * Get a list of all the diskselector items.
26178 * @param obj The diskselector object.
26179 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26180 * or @c NULL on failure.
26182 * @see elm_diskselector_item_append()
26183 * @see elm_diskselector_item_del()
26184 * @see elm_diskselector_clear()
26186 * @ingroup Diskselector
26188 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26191 * Appends a new item to the diskselector object.
26193 * @param obj The diskselector object.
26194 * @param label The label of the diskselector item.
26195 * @param icon The icon object to use at left side of the item. An
26196 * icon can be any Evas object, but usually it is an icon created
26197 * with elm_icon_add().
26198 * @param func The function to call when the item is selected.
26199 * @param data The data to associate with the item for related callbacks.
26201 * @return The created item or @c NULL upon failure.
26203 * A new item will be created and appended to the diskselector, i.e., will
26204 * be set as last item. Also, if there is no selected item, it will
26205 * be selected. This will always happens for the first appended item.
26207 * If no icon is set, label will be centered on item position, otherwise
26208 * the icon will be placed at left of the label, that will be shifted
26211 * Items created with this method can be deleted with
26212 * elm_diskselector_item_del().
26214 * Associated @p data can be properly freed when item is deleted if a
26215 * callback function is set with elm_diskselector_item_del_cb_set().
26217 * If a function is passed as argument, it will be called everytime this item
26218 * is selected, i.e., the user stops the diskselector with this
26219 * item on center position. If such function isn't needed, just passing
26220 * @c NULL as @p func is enough. The same should be done for @p data.
26222 * Simple example (with no function callback or data associated):
26224 * disk = elm_diskselector_add(win);
26225 * ic = elm_icon_add(win);
26226 * elm_icon_file_set(ic, "path/to/image", NULL);
26227 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26228 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26231 * @see elm_diskselector_item_del()
26232 * @see elm_diskselector_item_del_cb_set()
26233 * @see elm_diskselector_clear()
26234 * @see elm_icon_add()
26236 * @ingroup Diskselector
26238 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);
26242 * Delete them item from the diskselector.
26244 * @param it The item of diskselector to be deleted.
26246 * If deleting all diskselector items is required, elm_diskselector_clear()
26247 * should be used instead of getting items list and deleting each one.
26249 * @see elm_diskselector_clear()
26250 * @see elm_diskselector_item_append()
26251 * @see elm_diskselector_item_del_cb_set()
26253 * @ingroup Diskselector
26255 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26258 * Set the function called when a diskselector item is freed.
26260 * @param it The item to set the callback on
26261 * @param func The function called
26263 * If there is a @p func, then it will be called prior item's memory release.
26264 * That will be called with the following arguments:
26266 * @li item's Evas object;
26269 * This way, a data associated to a diskselector item could be properly
26272 * @ingroup Diskselector
26274 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26277 * Get the data associated to the item.
26279 * @param it The diskselector item
26280 * @return The data associated to @p it
26282 * The return value is a pointer to data associated to @p item when it was
26283 * created, with function elm_diskselector_item_append(). If no data
26284 * was passed as argument, it will return @c NULL.
26286 * @see elm_diskselector_item_append()
26288 * @ingroup Diskselector
26290 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26293 * Set the icon associated to the item.
26295 * @param it The diskselector item
26296 * @param icon The icon object to associate with @p it
26298 * The icon object to use at left side of the item. An
26299 * icon can be any Evas object, but usually it is an icon created
26300 * with elm_icon_add().
26302 * Once the icon object is set, a previously set one will be deleted.
26303 * @warning Setting the same icon for two items will cause the icon to
26304 * dissapear from the first item.
26306 * If an icon was passed as argument on item creation, with function
26307 * elm_diskselector_item_append(), it will be already
26308 * associated to the item.
26310 * @see elm_diskselector_item_append()
26311 * @see elm_diskselector_item_icon_get()
26313 * @ingroup Diskselector
26315 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26318 * Get the icon associated to the item.
26320 * @param it The diskselector item
26321 * @return The icon associated to @p it
26323 * The return value is a pointer to the icon associated to @p item when it was
26324 * created, with function elm_diskselector_item_append(), or later
26325 * with function elm_diskselector_item_icon_set. If no icon
26326 * was passed as argument, it will return @c NULL.
26328 * @see elm_diskselector_item_append()
26329 * @see elm_diskselector_item_icon_set()
26331 * @ingroup Diskselector
26333 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26336 * Set the label of item.
26338 * @param it The item of diskselector.
26339 * @param label The label of item.
26341 * The label to be displayed by the item.
26343 * If no icon is set, label will be centered on item position, otherwise
26344 * the icon will be placed at left of the label, that will be shifted
26347 * An item with label "January" would be displayed on side position as
26348 * "Jan" if max length is set to 3 with function
26349 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26352 * When this @p item is selected, the entire label will be displayed,
26353 * except for width restrictions.
26354 * In this case label will be cropped and "..." will be concatenated,
26355 * but only for display purposes. It will keep the entire string, so
26356 * if diskselector is resized the remaining characters will be displayed.
26358 * If a label was passed as argument on item creation, with function
26359 * elm_diskselector_item_append(), it will be already
26360 * displayed by the item.
26362 * @see elm_diskselector_side_label_lenght_set()
26363 * @see elm_diskselector_item_label_get()
26364 * @see elm_diskselector_item_append()
26366 * @ingroup Diskselector
26368 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26371 * Get the label of item.
26373 * @param it The item of diskselector.
26374 * @return The label of item.
26376 * The return value is a pointer to the label associated to @p item when it was
26377 * created, with function elm_diskselector_item_append(), or later
26378 * with function elm_diskselector_item_label_set. If no label
26379 * was passed as argument, it will return @c NULL.
26381 * @see elm_diskselector_item_label_set() for more details.
26382 * @see elm_diskselector_item_append()
26384 * @ingroup Diskselector
26386 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26389 * Get the selected item.
26391 * @param obj The diskselector object.
26392 * @return The selected diskselector item.
26394 * The selected item can be unselected with function
26395 * elm_diskselector_item_selected_set(), and the first item of
26396 * diskselector will be selected.
26398 * The selected item always will be centered on diskselector, with
26399 * full label displayed, i.e., max lenght set to side labels won't
26400 * apply on the selected item. More details on
26401 * elm_diskselector_side_label_length_set().
26403 * @ingroup Diskselector
26405 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26408 * Set the selected state of an item.
26410 * @param it The diskselector item
26411 * @param selected The selected state
26413 * This sets the selected state of the given item @p it.
26414 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26416 * If a new item is selected the previosly selected will be unselected.
26417 * Previoulsy selected item can be get with function
26418 * elm_diskselector_selected_item_get().
26420 * If the item @p it is unselected, the first item of diskselector will
26423 * Selected items will be visible on center position of diskselector.
26424 * So if it was on another position before selected, or was invisible,
26425 * diskselector will animate items until the selected item reaches center
26428 * @see elm_diskselector_item_selected_get()
26429 * @see elm_diskselector_selected_item_get()
26431 * @ingroup Diskselector
26433 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26436 * Get whether the @p item is selected or not.
26438 * @param it The diskselector item.
26439 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26440 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26442 * @see elm_diskselector_selected_item_set() for details.
26443 * @see elm_diskselector_item_selected_get()
26445 * @ingroup Diskselector
26447 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26450 * Get the first item of the diskselector.
26452 * @param obj The diskselector object.
26453 * @return The first item, or @c NULL if none.
26455 * The list of items follows append order. So it will return the first
26456 * item appended to the widget that wasn't deleted.
26458 * @see elm_diskselector_item_append()
26459 * @see elm_diskselector_items_get()
26461 * @ingroup Diskselector
26463 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26466 * Get the last item of the diskselector.
26468 * @param obj The diskselector object.
26469 * @return The last item, or @c NULL if none.
26471 * The list of items follows append order. So it will return last first
26472 * item appended to the widget that wasn't deleted.
26474 * @see elm_diskselector_item_append()
26475 * @see elm_diskselector_items_get()
26477 * @ingroup Diskselector
26479 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26482 * Get the item before @p item in diskselector.
26484 * @param it The diskselector item.
26485 * @return The item before @p item, or @c NULL if none or on failure.
26487 * The list of items follows append order. So it will return item appended
26488 * just before @p item and that wasn't deleted.
26490 * If it is the first item, @c NULL will be returned.
26491 * First item can be get by elm_diskselector_first_item_get().
26493 * @see elm_diskselector_item_append()
26494 * @see elm_diskselector_items_get()
26496 * @ingroup Diskselector
26498 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26501 * Get the item after @p item in diskselector.
26503 * @param it The diskselector item.
26504 * @return The item after @p item, or @c NULL if none or on failure.
26506 * The list of items follows append order. So it will return item appended
26507 * just after @p item and that wasn't deleted.
26509 * If it is the last item, @c NULL will be returned.
26510 * Last item can be get by elm_diskselector_last_item_get().
26512 * @see elm_diskselector_item_append()
26513 * @see elm_diskselector_items_get()
26515 * @ingroup Diskselector
26517 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26520 * Set the text to be shown in the diskselector item.
26522 * @param item Target item
26523 * @param text The text to set in the content
26525 * Setup the text as tooltip to object. The item can have only one tooltip,
26526 * so any previous tooltip data is removed.
26528 * @see elm_object_tooltip_text_set() for more details.
26530 * @ingroup Diskselector
26532 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26535 * Set the content to be shown in the tooltip item.
26537 * Setup the tooltip to item. The item can have only one tooltip,
26538 * so any previous tooltip data is removed. @p func(with @p data) will
26539 * be called every time that need show the tooltip and it should
26540 * return a valid Evas_Object. This object is then managed fully by
26541 * tooltip system and is deleted when the tooltip is gone.
26543 * @param item the diskselector item being attached a tooltip.
26544 * @param func the function used to create the tooltip contents.
26545 * @param data what to provide to @a func as callback data/context.
26546 * @param del_cb called when data is not needed anymore, either when
26547 * another callback replaces @p func, the tooltip is unset with
26548 * elm_diskselector_item_tooltip_unset() or the owner @a item
26549 * dies. This callback receives as the first parameter the
26550 * given @a data, and @c event_info is the item.
26552 * @see elm_object_tooltip_content_cb_set() for more details.
26554 * @ingroup Diskselector
26556 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);
26559 * Unset tooltip from item.
26561 * @param item diskselector item to remove previously set tooltip.
26563 * Remove tooltip from item. The callback provided as del_cb to
26564 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26565 * it is not used anymore.
26567 * @see elm_object_tooltip_unset() for more details.
26568 * @see elm_diskselector_item_tooltip_content_cb_set()
26570 * @ingroup Diskselector
26572 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26576 * Sets a different style for this item tooltip.
26578 * @note before you set a style you should define a tooltip with
26579 * elm_diskselector_item_tooltip_content_cb_set() or
26580 * elm_diskselector_item_tooltip_text_set()
26582 * @param item diskselector item with tooltip already set.
26583 * @param style the theme style to use (default, transparent, ...)
26585 * @see elm_object_tooltip_style_set() for more details.
26587 * @ingroup Diskselector
26589 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26592 * Get the style for this item tooltip.
26594 * @param item diskselector item with tooltip already set.
26595 * @return style the theme style in use, defaults to "default". If the
26596 * object does not have a tooltip set, then NULL is returned.
26598 * @see elm_object_tooltip_style_get() for more details.
26599 * @see elm_diskselector_item_tooltip_style_set()
26601 * @ingroup Diskselector
26603 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26606 * Set the cursor to be shown when mouse is over the diskselector item
26608 * @param item Target item
26609 * @param cursor the cursor name to be used.
26611 * @see elm_object_cursor_set() for more details.
26613 * @ingroup Diskselector
26615 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26618 * Get the cursor to be shown when mouse is over the diskselector item
26620 * @param item diskselector item with cursor already set.
26621 * @return the cursor name.
26623 * @see elm_object_cursor_get() for more details.
26624 * @see elm_diskselector_cursor_set()
26626 * @ingroup Diskselector
26628 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26632 * Unset the cursor to be shown when mouse is over the diskselector item
26634 * @param item Target item
26636 * @see elm_object_cursor_unset() for more details.
26637 * @see elm_diskselector_cursor_set()
26639 * @ingroup Diskselector
26641 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26644 * Sets a different style for this item cursor.
26646 * @note before you set a style you should define a cursor with
26647 * elm_diskselector_item_cursor_set()
26649 * @param item diskselector item with cursor already set.
26650 * @param style the theme style to use (default, transparent, ...)
26652 * @see elm_object_cursor_style_set() for more details.
26654 * @ingroup Diskselector
26656 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26660 * Get the style for this item cursor.
26662 * @param item diskselector item with cursor already set.
26663 * @return style the theme style in use, defaults to "default". If the
26664 * object does not have a cursor set, then @c NULL is returned.
26666 * @see elm_object_cursor_style_get() for more details.
26667 * @see elm_diskselector_item_cursor_style_set()
26669 * @ingroup Diskselector
26671 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26675 * Set if the cursor set should be searched on the theme or should use
26676 * the provided by the engine, only.
26678 * @note before you set if should look on theme you should define a cursor
26679 * with elm_diskselector_item_cursor_set().
26680 * By default it will only look for cursors provided by the engine.
26682 * @param item widget item with cursor already set.
26683 * @param engine_only boolean to define if cursors set with
26684 * elm_diskselector_item_cursor_set() should be searched only
26685 * between cursors provided by the engine or searched on widget's
26688 * @see elm_object_cursor_engine_only_set() for more details.
26690 * @ingroup Diskselector
26692 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26695 * Get the cursor engine only usage for this item cursor.
26697 * @param item widget item with cursor already set.
26698 * @return engine_only boolean to define it cursors should be looked only
26699 * between the provided by the engine or searched on widget's theme as well.
26700 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26702 * @see elm_object_cursor_engine_only_get() for more details.
26703 * @see elm_diskselector_item_cursor_engine_only_set()
26705 * @ingroup Diskselector
26707 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26714 * @defgroup Colorselector Colorselector
26718 * @image html img/widget/colorselector/preview-00.png
26719 * @image latex img/widget/colorselector/preview-00.eps
26721 * @brief Widget for user to select a color.
26723 * Signals that you can add callbacks for are:
26724 * "changed" - When the color value changes(event_info is NULL).
26726 * See @ref tutorial_colorselector.
26729 * @brief Add a new colorselector to the parent
26731 * @param parent The parent object
26732 * @return The new object or NULL if it cannot be created
26734 * @ingroup Colorselector
26736 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26738 * Set a color for the colorselector
26740 * @param obj Colorselector object
26741 * @param r r-value of color
26742 * @param g g-value of color
26743 * @param b b-value of color
26744 * @param a a-value of color
26746 * @ingroup Colorselector
26748 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26750 * Get a color from the colorselector
26752 * @param obj Colorselector object
26753 * @param r integer pointer for r-value of color
26754 * @param g integer pointer for g-value of color
26755 * @param b integer pointer for b-value of color
26756 * @param a integer pointer for a-value of color
26758 * @ingroup Colorselector
26760 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26766 * @defgroup Ctxpopup Ctxpopup
26768 * @image html img/widget/ctxpopup/preview-00.png
26769 * @image latex img/widget/ctxpopup/preview-00.eps
26771 * @brief Context popup widet.
26773 * A ctxpopup is a widget that, when shown, pops up a list of items.
26774 * It automatically chooses an area inside its parent object's view
26775 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26776 * optimally fit into it. In the default theme, it will also point an
26777 * arrow to it's top left position at the time one shows it. Ctxpopup
26778 * items have a label and/or an icon. It is intended for a small
26779 * number of items (hence the use of list, not genlist).
26781 * @note Ctxpopup is a especialization of @ref Hover.
26783 * Signals that you can add callbacks for are:
26784 * "dismissed" - the ctxpopup was dismissed
26786 * Default contents parts of the ctxpopup widget that you can use for are:
26787 * @li "default" - A content of the ctxpopup
26789 * Default contents parts of the naviframe items that you can use for are:
26790 * @li "icon" - An icon in the title area
26792 * Default text parts of the naviframe items that you can use for are:
26793 * @li "default" - Title label in the title area
26795 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26798 typedef enum _Elm_Ctxpopup_Direction
26800 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26802 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26803 the clicked area */
26804 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26805 the clicked area */
26806 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26808 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26809 } Elm_Ctxpopup_Direction;
26812 * @brief Add a new Ctxpopup object to the parent.
26814 * @param parent Parent object
26815 * @return New object or @c NULL, if it cannot be created
26817 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26819 * @brief Set the Ctxpopup's parent
26821 * @param obj The ctxpopup object
26822 * @param area The parent to use
26824 * Set the parent object.
26826 * @note elm_ctxpopup_add() will automatically call this function
26827 * with its @c parent argument.
26829 * @see elm_ctxpopup_add()
26830 * @see elm_hover_parent_set()
26832 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26834 * @brief Get the Ctxpopup's parent
26836 * @param obj The ctxpopup object
26838 * @see elm_ctxpopup_hover_parent_set() for more information
26840 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26842 * @brief Clear all items in the given ctxpopup object.
26844 * @param obj Ctxpopup object
26846 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26848 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26850 * @param obj Ctxpopup object
26851 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26853 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26855 * @brief Get the value of current ctxpopup object's orientation.
26857 * @param obj Ctxpopup object
26858 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26860 * @see elm_ctxpopup_horizontal_set()
26862 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26864 * @brief Add a new item to a ctxpopup object.
26866 * @param obj Ctxpopup object
26867 * @param icon Icon to be set on new item
26868 * @param label The Label of the new item
26869 * @param func Convenience function called when item selected
26870 * @param data Data passed to @p func
26871 * @return A handle to the item added or @c NULL, on errors
26873 * @warning Ctxpopup can't hold both an item list and a content at the same
26874 * time. When an item is added, any previous content will be removed.
26876 * @see elm_ctxpopup_content_set()
26878 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);
26880 * @brief Delete the given item in a ctxpopup object.
26882 * @param it Ctxpopup item to be deleted
26884 * @see elm_ctxpopup_item_append()
26886 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26888 * @brief Set the ctxpopup item's state as disabled or enabled.
26890 * @param it Ctxpopup item to be enabled/disabled
26891 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26893 * When disabled the item is greyed out to indicate it's state.
26894 * @deprecated use elm_object_item_disabled_set() instead
26896 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26898 * @brief Get the ctxpopup item's disabled/enabled state.
26900 * @param it Ctxpopup item to be enabled/disabled
26901 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26903 * @see elm_ctxpopup_item_disabled_set()
26904 * @deprecated use elm_object_item_disabled_get() instead
26906 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26908 * @brief Get the icon object for the given ctxpopup item.
26910 * @param it Ctxpopup item
26911 * @return icon object or @c NULL, if the item does not have icon or an error
26914 * @see elm_ctxpopup_item_append()
26915 * @see elm_ctxpopup_item_icon_set()
26917 * @deprecated use elm_object_item_part_content_get() instead
26919 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26921 * @brief Sets the side icon associated with the ctxpopup item
26923 * @param it Ctxpopup item
26924 * @param icon Icon object to be set
26926 * Once the icon object is set, a previously set one will be deleted.
26927 * @warning Setting the same icon for two items will cause the icon to
26928 * dissapear from the first item.
26930 * @see elm_ctxpopup_item_append()
26932 * @deprecated use elm_object_item_part_content_set() instead
26935 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26937 * @brief Get the label for the given ctxpopup item.
26939 * @param it Ctxpopup item
26940 * @return label string or @c NULL, if the item does not have label or an
26943 * @see elm_ctxpopup_item_append()
26944 * @see elm_ctxpopup_item_label_set()
26946 * @deprecated use elm_object_item_text_get() instead
26948 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26950 * @brief (Re)set the label on the given ctxpopup item.
26952 * @param it Ctxpopup item
26953 * @param label String to set as label
26955 * @deprecated use elm_object_item_text_set() instead
26957 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26959 * @brief Set an elm widget as the content of the ctxpopup.
26961 * @param obj Ctxpopup object
26962 * @param content Content to be swallowed
26964 * If the content object is already set, a previous one will bedeleted. If
26965 * you want to keep that old content object, use the
26966 * elm_ctxpopup_content_unset() function.
26968 * @warning Ctxpopup can't hold both a item list and a content at the same
26969 * time. When a content is set, any previous items will be removed.
26971 * @deprecated use elm_object_content_set() instead
26974 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26976 * @brief Unset the ctxpopup content
26978 * @param obj Ctxpopup object
26979 * @return The content that was being used
26981 * Unparent and return the content object which was set for this widget.
26983 * @deprecated use elm_object_content_unset()
26985 * @see elm_ctxpopup_content_set()
26987 * @deprecated use elm_object_content_unset() instead
26990 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26992 * @brief Set the direction priority of a ctxpopup.
26994 * @param obj Ctxpopup object
26995 * @param first 1st priority of direction
26996 * @param second 2nd priority of direction
26997 * @param third 3th priority of direction
26998 * @param fourth 4th priority of direction
27000 * This functions gives a chance to user to set the priority of ctxpopup
27001 * showing direction. This doesn't guarantee the ctxpopup will appear in the
27002 * requested direction.
27004 * @see Elm_Ctxpopup_Direction
27006 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);
27008 * @brief Get the direction priority of a ctxpopup.
27010 * @param obj Ctxpopup object
27011 * @param first 1st priority of direction to be returned
27012 * @param second 2nd priority of direction to be returned
27013 * @param third 3th priority of direction to be returned
27014 * @param fourth 4th priority of direction to be returned
27016 * @see elm_ctxpopup_direction_priority_set() for more information.
27018 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);
27021 * @brief Get the current direction of a ctxpopup.
27023 * @param obj Ctxpopup object
27024 * @return current direction of a ctxpopup
27026 * @warning Once the ctxpopup showed up, the direction would be determined
27028 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27037 * @defgroup Transit Transit
27038 * @ingroup Elementary
27040 * Transit is designed to apply various animated transition effects to @c
27041 * Evas_Object, such like translation, rotation, etc. For using these
27042 * effects, create an @ref Elm_Transit and add the desired transition effects.
27044 * Once the effects are added into transit, they will be automatically
27045 * managed (their callback will be called until the duration is ended, and
27046 * they will be deleted on completion).
27050 * Elm_Transit *trans = elm_transit_add();
27051 * elm_transit_object_add(trans, obj);
27052 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27053 * elm_transit_duration_set(transit, 1);
27054 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27055 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27056 * elm_transit_repeat_times_set(transit, 3);
27059 * Some transition effects are used to change the properties of objects. They
27061 * @li @ref elm_transit_effect_translation_add
27062 * @li @ref elm_transit_effect_color_add
27063 * @li @ref elm_transit_effect_rotation_add
27064 * @li @ref elm_transit_effect_wipe_add
27065 * @li @ref elm_transit_effect_zoom_add
27066 * @li @ref elm_transit_effect_resizing_add
27068 * Other transition effects are used to make one object disappear and another
27069 * object appear on its old place. These effects are:
27071 * @li @ref elm_transit_effect_flip_add
27072 * @li @ref elm_transit_effect_resizable_flip_add
27073 * @li @ref elm_transit_effect_fade_add
27074 * @li @ref elm_transit_effect_blend_add
27076 * It's also possible to make a transition chain with @ref
27077 * elm_transit_chain_transit_add.
27079 * @warning We strongly recommend to use elm_transit just when edje can not do
27080 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27081 * animations can be manipulated inside the theme.
27083 * List of examples:
27084 * @li @ref transit_example_01_explained
27085 * @li @ref transit_example_02_explained
27086 * @li @ref transit_example_03_c
27087 * @li @ref transit_example_04_c
27093 * @enum Elm_Transit_Tween_Mode
27095 * The type of acceleration used in the transition.
27099 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27100 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27101 over time, then decrease again
27103 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27105 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27107 } Elm_Transit_Tween_Mode;
27110 * @enum Elm_Transit_Effect_Flip_Axis
27112 * The axis where flip effect should be applied.
27116 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27117 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27118 } Elm_Transit_Effect_Flip_Axis;
27120 * @enum Elm_Transit_Effect_Wipe_Dir
27122 * The direction where the wipe effect should occur.
27126 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27127 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27128 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27129 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27130 } Elm_Transit_Effect_Wipe_Dir;
27131 /** @enum Elm_Transit_Effect_Wipe_Type
27133 * Whether the wipe effect should show or hide the object.
27137 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27139 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27141 } Elm_Transit_Effect_Wipe_Type;
27144 * @typedef Elm_Transit
27146 * The Transit created with elm_transit_add(). This type has the information
27147 * about the objects which the transition will be applied, and the
27148 * transition effects that will be used. It also contains info about
27149 * duration, number of repetitions, auto-reverse, etc.
27151 typedef struct _Elm_Transit Elm_Transit;
27152 typedef void Elm_Transit_Effect;
27154 * @typedef Elm_Transit_Effect_Transition_Cb
27156 * Transition callback called for this effect on each transition iteration.
27158 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27160 * Elm_Transit_Effect_End_Cb
27162 * Transition callback called for this effect when the transition is over.
27164 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27167 * Elm_Transit_Del_Cb
27169 * A callback called when the transit is deleted.
27171 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27176 * @note Is not necessary to delete the transit object, it will be deleted at
27177 * the end of its operation.
27178 * @note The transit will start playing when the program enter in the main loop, is not
27179 * necessary to give a start to the transit.
27181 * @return The transit object.
27185 EAPI Elm_Transit *elm_transit_add(void);
27188 * Stops the animation and delete the @p transit object.
27190 * Call this function if you wants to stop the animation before the duration
27191 * time. Make sure the @p transit object is still alive with
27192 * elm_transit_del_cb_set() function.
27193 * All added effects will be deleted, calling its repective data_free_cb
27194 * functions. The function setted by elm_transit_del_cb_set() will be called.
27196 * @see elm_transit_del_cb_set()
27198 * @param transit The transit object to be deleted.
27201 * @warning Just call this function if you are sure the transit is alive.
27203 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27206 * Add a new effect to the transit.
27208 * @note The cb function and the data are the key to the effect. If you try to
27209 * add an already added effect, nothing is done.
27210 * @note After the first addition of an effect in @p transit, if its
27211 * effect list become empty again, the @p transit will be killed by
27212 * elm_transit_del(transit) function.
27216 * Elm_Transit *transit = elm_transit_add();
27217 * elm_transit_effect_add(transit,
27218 * elm_transit_effect_blend_op,
27219 * elm_transit_effect_blend_context_new(),
27220 * elm_transit_effect_blend_context_free);
27223 * @param transit The transit object.
27224 * @param transition_cb The operation function. It is called when the
27225 * animation begins, it is the function that actually performs the animation.
27226 * It is called with the @p data, @p transit and the time progression of the
27227 * animation (a double value between 0.0 and 1.0).
27228 * @param effect The context data of the effect.
27229 * @param end_cb The function to free the context data, it will be called
27230 * at the end of the effect, it must finalize the animation and free the
27234 * @warning The transit free the context data at the and of the transition with
27235 * the data_free_cb function, do not use the context data in another transit.
27237 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);
27240 * Delete an added effect.
27242 * This function will remove the effect from the @p transit, calling the
27243 * data_free_cb to free the @p data.
27245 * @see elm_transit_effect_add()
27247 * @note If the effect is not found, nothing is done.
27248 * @note If the effect list become empty, this function will call
27249 * elm_transit_del(transit), that is, it will kill the @p transit.
27251 * @param transit The transit object.
27252 * @param transition_cb The operation function.
27253 * @param effect The context data of the effect.
27257 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);
27260 * Add new object to apply the effects.
27262 * @note After the first addition of an object in @p transit, if its
27263 * object list become empty again, the @p transit will be killed by
27264 * elm_transit_del(transit) function.
27265 * @note If the @p obj belongs to another transit, the @p obj will be
27266 * removed from it and it will only belong to the @p transit. If the old
27267 * transit stays without objects, it will die.
27268 * @note When you add an object into the @p transit, its state from
27269 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27270 * transit ends, if you change this state whith evas_object_pass_events_set()
27271 * after add the object, this state will change again when @p transit stops to
27274 * @param transit The transit object.
27275 * @param obj Object to be animated.
27278 * @warning It is not allowed to add a new object after transit begins to go.
27280 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27283 * Removes an added object from the transit.
27285 * @note If the @p obj is not in the @p transit, nothing is done.
27286 * @note If the list become empty, this function will call
27287 * elm_transit_del(transit), that is, it will kill the @p transit.
27289 * @param transit The transit object.
27290 * @param obj Object to be removed from @p transit.
27293 * @warning It is not allowed to remove objects after transit begins to go.
27295 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27298 * Get the objects of the transit.
27300 * @param transit The transit object.
27301 * @return a Eina_List with the objects from the transit.
27305 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27308 * Enable/disable keeping up the objects states.
27309 * If it is not kept, the objects states will be reset when transition ends.
27311 * @note @p transit can not be NULL.
27312 * @note One state includes geometry, color, map data.
27314 * @param transit The transit object.
27315 * @param state_keep Keeping or Non Keeping.
27319 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27322 * Get a value whether the objects states will be reset or not.
27324 * @note @p transit can not be NULL
27326 * @see elm_transit_objects_final_state_keep_set()
27328 * @param transit The transit object.
27329 * @return EINA_TRUE means the states of the objects will be reset.
27330 * If @p transit is NULL, EINA_FALSE is returned
27334 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27337 * Set the event enabled when transit is operating.
27339 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27340 * events from mouse and keyboard during the animation.
27341 * @note When you add an object with elm_transit_object_add(), its state from
27342 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27343 * transit ends, if you change this state with evas_object_pass_events_set()
27344 * after adding the object, this state will change again when @p transit stops
27347 * @param transit The transit object.
27348 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27349 * ignored otherwise.
27353 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27356 * Get the value of event enabled status.
27358 * @see elm_transit_event_enabled_set()
27360 * @param transit The Transit object
27361 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27362 * EINA_FALSE is returned
27366 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27369 * Set the user-callback function when the transit is deleted.
27371 * @note Using this function twice will overwrite the first function setted.
27372 * @note the @p transit object will be deleted after call @p cb function.
27374 * @param transit The transit object.
27375 * @param cb Callback function pointer. This function will be called before
27376 * the deletion of the transit.
27377 * @param data Callback funtion user data. It is the @p op parameter.
27381 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27384 * Set reverse effect automatically.
27386 * If auto reverse is setted, after running the effects with the progress
27387 * parameter from 0 to 1, it will call the effecs again with the progress
27388 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27389 * where the duration was setted with the function elm_transit_add and
27390 * the repeat with the function elm_transit_repeat_times_set().
27392 * @param transit The transit object.
27393 * @param reverse EINA_TRUE means the auto_reverse is on.
27397 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27400 * Get if the auto reverse is on.
27402 * @see elm_transit_auto_reverse_set()
27404 * @param transit The transit object.
27405 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27406 * EINA_FALSE is returned
27410 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27413 * Set the transit repeat count. Effect will be repeated by repeat count.
27415 * This function sets the number of repetition the transit will run after
27416 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27417 * If the @p repeat is a negative number, it will repeat infinite times.
27419 * @note If this function is called during the transit execution, the transit
27420 * will run @p repeat times, ignoring the times it already performed.
27422 * @param transit The transit object
27423 * @param repeat Repeat count
27427 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27430 * Get the transit repeat count.
27432 * @see elm_transit_repeat_times_set()
27434 * @param transit The Transit object.
27435 * @return The repeat count. If @p transit is NULL
27440 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27443 * Set the transit animation acceleration type.
27445 * This function sets the tween mode of the transit that can be:
27446 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27447 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27448 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27449 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27451 * @param transit The transit object.
27452 * @param tween_mode The tween type.
27456 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27459 * Get the transit animation acceleration type.
27461 * @note @p transit can not be NULL
27463 * @param transit The transit object.
27464 * @return The tween type. If @p transit is NULL
27465 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27469 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27472 * Set the transit animation time
27474 * @note @p transit can not be NULL
27476 * @param transit The transit object.
27477 * @param duration The animation time.
27481 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27484 * Get the transit animation time
27486 * @note @p transit can not be NULL
27488 * @param transit The transit object.
27490 * @return The transit animation time.
27494 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27497 * Starts the transition.
27498 * Once this API is called, the transit begins to measure the time.
27500 * @note @p transit can not be NULL
27502 * @param transit The transit object.
27506 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27509 * Pause/Resume the transition.
27511 * If you call elm_transit_go again, the transit will be started from the
27512 * beginning, and will be unpaused.
27514 * @note @p transit can not be NULL
27516 * @param transit The transit object.
27517 * @param paused Whether the transition should be paused or not.
27521 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27524 * Get the value of paused status.
27526 * @see elm_transit_paused_set()
27528 * @note @p transit can not be NULL
27530 * @param transit The transit object.
27531 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27532 * EINA_FALSE is returned
27536 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27539 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27541 * The value returned is a fraction (current time / total time). It
27542 * represents the progression position relative to the total.
27544 * @note @p transit can not be NULL
27546 * @param transit The transit object.
27548 * @return The time progression value. If @p transit is NULL
27553 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27556 * Makes the chain relationship between two transits.
27558 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27559 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27561 * @param transit The transit object.
27562 * @param chain_transit The chain transit object. This transit will be operated
27563 * after transit is done.
27565 * This function adds @p chain_transit transition to a chain after the @p
27566 * transit, and will be started as soon as @p transit ends. See @ref
27567 * transit_example_02_explained for a full example.
27571 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27574 * Cut off the chain relationship between two transits.
27576 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27577 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27579 * @param transit The transit object.
27580 * @param chain_transit The chain transit object.
27582 * This function remove the @p chain_transit transition from the @p transit.
27586 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27589 * Get the current chain transit list.
27591 * @note @p transit can not be NULL.
27593 * @param transit The transit object.
27594 * @return chain transit list.
27598 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27601 * Add the Resizing Effect to Elm_Transit.
27603 * @note This API is one of the facades. It creates resizing effect context
27604 * and add it's required APIs to elm_transit_effect_add.
27606 * @see elm_transit_effect_add()
27608 * @param transit Transit object.
27609 * @param from_w Object width size when effect begins.
27610 * @param from_h Object height size when effect begins.
27611 * @param to_w Object width size when effect ends.
27612 * @param to_h Object height size when effect ends.
27613 * @return Resizing effect context data.
27617 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);
27620 * Add the Translation Effect to Elm_Transit.
27622 * @note This API is one of the facades. It creates translation effect context
27623 * and add it's required APIs to elm_transit_effect_add.
27625 * @see elm_transit_effect_add()
27627 * @param transit Transit object.
27628 * @param from_dx X Position variation when effect begins.
27629 * @param from_dy Y Position variation when effect begins.
27630 * @param to_dx X Position variation when effect ends.
27631 * @param to_dy Y Position variation when effect ends.
27632 * @return Translation effect context data.
27635 * @warning It is highly recommended just create a transit with this effect when
27636 * the window that the objects of the transit belongs has already been created.
27637 * This is because this effect needs the geometry information about the objects,
27638 * and if the window was not created yet, it can get a wrong information.
27640 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);
27643 * Add the Zoom Effect to Elm_Transit.
27645 * @note This API is one of the facades. It creates zoom effect context
27646 * and add it's required APIs to elm_transit_effect_add.
27648 * @see elm_transit_effect_add()
27650 * @param transit Transit object.
27651 * @param from_rate Scale rate when effect begins (1 is current rate).
27652 * @param to_rate Scale rate when effect ends.
27653 * @return Zoom effect context data.
27656 * @warning It is highly recommended just create a transit with this effect when
27657 * the window that the objects of the transit belongs has already been created.
27658 * This is because this effect needs the geometry information about the objects,
27659 * and if the window was not created yet, it can get a wrong information.
27661 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27664 * Add the Flip Effect to Elm_Transit.
27666 * @note This API is one of the facades. It creates flip effect context
27667 * and add it's required APIs to elm_transit_effect_add.
27668 * @note This effect is applied to each pair of objects in the order they are listed
27669 * in the transit list of objects. The first object in the pair will be the
27670 * "front" object and the second will be the "back" object.
27672 * @see elm_transit_effect_add()
27674 * @param transit Transit object.
27675 * @param axis Flipping Axis(X or Y).
27676 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27677 * @return Flip effect context data.
27680 * @warning It is highly recommended just create a transit with this effect when
27681 * the window that the objects of the transit belongs has already been created.
27682 * This is because this effect needs the geometry information about the objects,
27683 * and if the window was not created yet, it can get a wrong information.
27685 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27688 * Add the Resizable Flip Effect to Elm_Transit.
27690 * @note This API is one of the facades. It creates resizable flip effect context
27691 * and add it's required APIs to elm_transit_effect_add.
27692 * @note This effect is applied to each pair of objects in the order they are listed
27693 * in the transit list of objects. The first object in the pair will be the
27694 * "front" object and the second will be the "back" object.
27696 * @see elm_transit_effect_add()
27698 * @param transit Transit object.
27699 * @param axis Flipping Axis(X or Y).
27700 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27701 * @return Resizable flip effect context data.
27704 * @warning It is highly recommended just create a transit with this effect when
27705 * the window that the objects of the transit belongs has already been created.
27706 * This is because this effect needs the geometry information about the objects,
27707 * and if the window was not created yet, it can get a wrong information.
27709 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27712 * Add the Wipe Effect to Elm_Transit.
27714 * @note This API is one of the facades. It creates wipe effect context
27715 * and add it's required APIs to elm_transit_effect_add.
27717 * @see elm_transit_effect_add()
27719 * @param transit Transit object.
27720 * @param type Wipe type. Hide or show.
27721 * @param dir Wipe Direction.
27722 * @return Wipe effect context data.
27725 * @warning It is highly recommended just create a transit with this effect when
27726 * the window that the objects of the transit belongs has already been created.
27727 * This is because this effect needs the geometry information about the objects,
27728 * and if the window was not created yet, it can get a wrong information.
27730 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27733 * Add the Color Effect to Elm_Transit.
27735 * @note This API is one of the facades. It creates color effect context
27736 * and add it's required APIs to elm_transit_effect_add.
27738 * @see elm_transit_effect_add()
27740 * @param transit Transit object.
27741 * @param from_r RGB R when effect begins.
27742 * @param from_g RGB G when effect begins.
27743 * @param from_b RGB B when effect begins.
27744 * @param from_a RGB A when effect begins.
27745 * @param to_r RGB R when effect ends.
27746 * @param to_g RGB G when effect ends.
27747 * @param to_b RGB B when effect ends.
27748 * @param to_a RGB A when effect ends.
27749 * @return Color effect context data.
27753 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);
27756 * Add the Fade Effect to Elm_Transit.
27758 * @note This API is one of the facades. It creates fade effect context
27759 * and add it's required APIs to elm_transit_effect_add.
27760 * @note This effect is applied to each pair of objects in the order they are listed
27761 * in the transit list of objects. The first object in the pair will be the
27762 * "before" object and the second will be the "after" object.
27764 * @see elm_transit_effect_add()
27766 * @param transit Transit object.
27767 * @return Fade effect context data.
27770 * @warning It is highly recommended just create a transit with this effect when
27771 * the window that the objects of the transit belongs has already been created.
27772 * This is because this effect needs the color information about the objects,
27773 * and if the window was not created yet, it can get a wrong information.
27775 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27778 * Add the Blend Effect to Elm_Transit.
27780 * @note This API is one of the facades. It creates blend effect context
27781 * and add it's required APIs to elm_transit_effect_add.
27782 * @note This effect is applied to each pair of objects in the order they are listed
27783 * in the transit list of objects. The first object in the pair will be the
27784 * "before" object and the second will be the "after" object.
27786 * @see elm_transit_effect_add()
27788 * @param transit Transit object.
27789 * @return Blend effect context data.
27792 * @warning It is highly recommended just create a transit with this effect when
27793 * the window that the objects of the transit belongs has already been created.
27794 * This is because this effect needs the color information about the objects,
27795 * and if the window was not created yet, it can get a wrong information.
27797 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27800 * Add the Rotation Effect to Elm_Transit.
27802 * @note This API is one of the facades. It creates rotation effect context
27803 * and add it's required APIs to elm_transit_effect_add.
27805 * @see elm_transit_effect_add()
27807 * @param transit Transit object.
27808 * @param from_degree Degree when effect begins.
27809 * @param to_degree Degree when effect is ends.
27810 * @return Rotation effect context data.
27813 * @warning It is highly recommended just create a transit with this effect when
27814 * the window that the objects of the transit belongs has already been created.
27815 * This is because this effect needs the geometry information about the objects,
27816 * and if the window was not created yet, it can get a wrong information.
27818 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27821 * Add the ImageAnimation Effect to Elm_Transit.
27823 * @note This API is one of the facades. It creates image animation effect context
27824 * and add it's required APIs to elm_transit_effect_add.
27825 * The @p images parameter is a list images paths. This list and
27826 * its contents will be deleted at the end of the effect by
27827 * elm_transit_effect_image_animation_context_free() function.
27831 * char buf[PATH_MAX];
27832 * Eina_List *images = NULL;
27833 * Elm_Transit *transi = elm_transit_add();
27835 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27836 * images = eina_list_append(images, eina_stringshare_add(buf));
27838 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27839 * images = eina_list_append(images, eina_stringshare_add(buf));
27840 * elm_transit_effect_image_animation_add(transi, images);
27844 * @see elm_transit_effect_add()
27846 * @param transit Transit object.
27847 * @param images Eina_List of images file paths. This list and
27848 * its contents will be deleted at the end of the effect by
27849 * elm_transit_effect_image_animation_context_free() function.
27850 * @return Image Animation effect context data.
27854 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27859 typedef struct _Elm_Store Elm_Store;
27860 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27861 typedef struct _Elm_Store_Item Elm_Store_Item;
27862 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27863 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27864 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27865 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27866 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27867 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27868 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27869 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27871 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27872 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27873 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27874 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27878 ELM_STORE_ITEM_MAPPING_NONE = 0,
27879 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27880 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27881 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27882 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27883 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27884 // can add more here as needed by common apps
27885 ELM_STORE_ITEM_MAPPING_LAST
27886 } Elm_Store_Item_Mapping_Type;
27888 struct _Elm_Store_Item_Mapping_Icon
27890 // FIXME: allow edje file icons
27892 Elm_Icon_Lookup_Order lookup_order;
27893 Eina_Bool standard_name : 1;
27894 Eina_Bool no_scale : 1;
27895 Eina_Bool smooth : 1;
27896 Eina_Bool scale_up : 1;
27897 Eina_Bool scale_down : 1;
27900 struct _Elm_Store_Item_Mapping_Empty
27905 struct _Elm_Store_Item_Mapping_Photo
27910 struct _Elm_Store_Item_Mapping_Custom
27912 Elm_Store_Item_Mapping_Cb func;
27915 struct _Elm_Store_Item_Mapping
27917 Elm_Store_Item_Mapping_Type type;
27922 Elm_Store_Item_Mapping_Empty empty;
27923 Elm_Store_Item_Mapping_Icon icon;
27924 Elm_Store_Item_Mapping_Photo photo;
27925 Elm_Store_Item_Mapping_Custom custom;
27926 // add more types here
27930 struct _Elm_Store_Item_Info
27932 Elm_Genlist_Item_Class *item_class;
27933 const Elm_Store_Item_Mapping *mapping;
27938 struct _Elm_Store_Item_Info_Filesystem
27940 Elm_Store_Item_Info base;
27944 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27945 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27947 EAPI void elm_store_free(Elm_Store *st);
27949 EAPI Elm_Store *elm_store_filesystem_new(void);
27950 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27951 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27952 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27954 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27956 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27957 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27958 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27959 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27960 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27961 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27963 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27964 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27965 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27966 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27967 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27968 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27969 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27972 * @defgroup SegmentControl SegmentControl
27973 * @ingroup Elementary
27975 * @image html img/widget/segment_control/preview-00.png
27976 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27978 * @image html img/segment_control.png
27979 * @image latex img/segment_control.eps width=\textwidth
27981 * Segment control widget is a horizontal control made of multiple segment
27982 * items, each segment item functioning similar to discrete two state button.
27983 * A segment control groups the items together and provides compact
27984 * single button with multiple equal size segments.
27986 * Segment item size is determined by base widget
27987 * size and the number of items added.
27988 * Only one segment item can be at selected state. A segment item can display
27989 * combination of Text and any Evas_Object like Images or other widget.
27991 * Smart callbacks one can listen to:
27992 * - "changed" - When the user clicks on a segment item which is not
27993 * previously selected and get selected. The event_info parameter is the
27994 * segment item pointer.
27996 * Available styles for it:
27999 * Here is an example on its usage:
28000 * @li @ref segment_control_example
28004 * @addtogroup SegmentControl
28008 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28011 * Add a new segment control widget to the given parent Elementary
28012 * (container) object.
28014 * @param parent The parent object.
28015 * @return a new segment control widget handle or @c NULL, on errors.
28017 * This function inserts a new segment control widget on the canvas.
28019 * @ingroup SegmentControl
28021 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28024 * Append a new item to the segment control object.
28026 * @param obj The segment control object.
28027 * @param icon The icon object to use for the left side of the item. An
28028 * icon can be any Evas object, but usually it is an icon created
28029 * with elm_icon_add().
28030 * @param label The label of the item.
28031 * Note that, NULL is different from empty string "".
28032 * @return The created item or @c NULL upon failure.
28034 * A new item will be created and appended to the segment control, i.e., will
28035 * be set as @b last item.
28037 * If it should be inserted at another position,
28038 * elm_segment_control_item_insert_at() should be used instead.
28040 * Items created with this function can be deleted with function
28041 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28043 * @note @p label set to @c NULL is different from empty string "".
28045 * only has icon, it will be displayed bigger and centered. If it has
28046 * icon and label, even that an empty string, icon will be smaller and
28047 * positioned at left.
28051 * sc = elm_segment_control_add(win);
28052 * ic = elm_icon_add(win);
28053 * elm_icon_file_set(ic, "path/to/image", NULL);
28054 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28055 * elm_segment_control_item_add(sc, ic, "label");
28056 * evas_object_show(sc);
28059 * @see elm_segment_control_item_insert_at()
28060 * @see elm_segment_control_item_del()
28062 * @ingroup SegmentControl
28064 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28067 * Insert a new item to the segment control object at specified position.
28069 * @param obj The segment control object.
28070 * @param icon The icon object to use for the left side of the item. An
28071 * icon can be any Evas object, but usually it is an icon created
28072 * with elm_icon_add().
28073 * @param label The label of the item.
28074 * @param index Item position. Value should be between 0 and items count.
28075 * @return The created item or @c NULL upon failure.
28077 * Index values must be between @c 0, when item will be prepended to
28078 * segment control, and items count, that can be get with
28079 * elm_segment_control_item_count_get(), case when item will be appended
28080 * to segment control, just like elm_segment_control_item_add().
28082 * Items created with this function can be deleted with function
28083 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28085 * @note @p label set to @c NULL is different from empty string "".
28087 * only has icon, it will be displayed bigger and centered. If it has
28088 * icon and label, even that an empty string, icon will be smaller and
28089 * positioned at left.
28091 * @see elm_segment_control_item_add()
28092 * @see elm_segment_control_item_count_get()
28093 * @see elm_segment_control_item_del()
28095 * @ingroup SegmentControl
28097 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);
28100 * Remove a segment control item from its parent, deleting it.
28102 * @param it The item to be removed.
28104 * Items can be added with elm_segment_control_item_add() or
28105 * elm_segment_control_item_insert_at().
28107 * @ingroup SegmentControl
28109 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28112 * Remove a segment control item at given index from its parent,
28115 * @param obj The segment control object.
28116 * @param index The position of the segment control item to be deleted.
28118 * Items can be added with elm_segment_control_item_add() or
28119 * elm_segment_control_item_insert_at().
28121 * @ingroup SegmentControl
28123 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28126 * Get the Segment items count from segment control.
28128 * @param obj The segment control object.
28129 * @return Segment items count.
28131 * It will just return the number of items added to segment control @p obj.
28133 * @ingroup SegmentControl
28135 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28138 * Get the item placed at specified index.
28140 * @param obj The segment control object.
28141 * @param index The index of the segment item.
28142 * @return The segment control item or @c NULL on failure.
28144 * Index is the position of an item in segment control widget. Its
28145 * range is from @c 0 to <tt> count - 1 </tt>.
28146 * Count is the number of items, that can be get with
28147 * elm_segment_control_item_count_get().
28149 * @ingroup SegmentControl
28151 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28154 * Get the label of item.
28156 * @param obj The segment control object.
28157 * @param index The index of the segment item.
28158 * @return The label of the item at @p index.
28160 * The return value is a pointer to the label associated to the item when
28161 * it was created, with function elm_segment_control_item_add(), or later
28162 * with function elm_segment_control_item_label_set. If no label
28163 * was passed as argument, it will return @c NULL.
28165 * @see elm_segment_control_item_label_set() for more details.
28166 * @see elm_segment_control_item_add()
28168 * @ingroup SegmentControl
28170 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28173 * Set the label of item.
28175 * @param it The item of segment control.
28176 * @param text The label of item.
28178 * The label to be displayed by the item.
28179 * Label will be at right of the icon (if set).
28181 * If a label was passed as argument on item creation, with function
28182 * elm_control_segment_item_add(), it will be already
28183 * displayed by the item.
28185 * @see elm_segment_control_item_label_get()
28186 * @see elm_segment_control_item_add()
28188 * @ingroup SegmentControl
28190 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28193 * Get the icon associated to the item.
28195 * @param obj The segment control object.
28196 * @param index The index of the segment item.
28197 * @return The left side icon associated to the item at @p index.
28199 * The return value is a pointer to the icon associated to the item when
28200 * it was created, with function elm_segment_control_item_add(), or later
28201 * with function elm_segment_control_item_icon_set(). If no icon
28202 * was passed as argument, it will return @c NULL.
28204 * @see elm_segment_control_item_add()
28205 * @see elm_segment_control_item_icon_set()
28207 * @ingroup SegmentControl
28209 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28212 * Set the icon associated to the item.
28214 * @param it The segment control item.
28215 * @param icon The icon object to associate with @p it.
28217 * The icon object to use at left side of the item. An
28218 * icon can be any Evas object, but usually it is an icon created
28219 * with elm_icon_add().
28221 * Once the icon object is set, a previously set one will be deleted.
28222 * @warning Setting the same icon for two items will cause the icon to
28223 * dissapear from the first item.
28225 * If an icon was passed as argument on item creation, with function
28226 * elm_segment_control_item_add(), it will be already
28227 * associated to the item.
28229 * @see elm_segment_control_item_add()
28230 * @see elm_segment_control_item_icon_get()
28232 * @ingroup SegmentControl
28234 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28237 * Get the index of an item.
28239 * @param it The segment control item.
28240 * @return The position of item in segment control widget.
28242 * Index is the position of an item in segment control widget. Its
28243 * range is from @c 0 to <tt> count - 1 </tt>.
28244 * Count is the number of items, that can be get with
28245 * elm_segment_control_item_count_get().
28247 * @ingroup SegmentControl
28249 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28252 * Get the base object of the item.
28254 * @param it The segment control item.
28255 * @return The base object associated with @p it.
28257 * Base object is the @c Evas_Object that represents that item.
28259 * @ingroup SegmentControl
28261 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28264 * Get the selected item.
28266 * @param obj The segment control object.
28267 * @return The selected item or @c NULL if none of segment items is
28270 * The selected item can be unselected with function
28271 * elm_segment_control_item_selected_set().
28273 * The selected item always will be highlighted on segment control.
28275 * @ingroup SegmentControl
28277 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28280 * Set the selected state of an item.
28282 * @param it The segment control item
28283 * @param select The selected state
28285 * This sets the selected state of the given item @p it.
28286 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28288 * If a new item is selected the previosly selected will be unselected.
28289 * Previoulsy selected item can be get with function
28290 * elm_segment_control_item_selected_get().
28292 * The selected item always will be highlighted on segment control.
28294 * @see elm_segment_control_item_selected_get()
28296 * @ingroup SegmentControl
28298 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28305 * @defgroup Grid Grid
28307 * The grid is a grid layout widget that lays out a series of children as a
28308 * fixed "grid" of widgets using a given percentage of the grid width and
28309 * height each using the child object.
28311 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28312 * widgets size itself. The default is 100 x 100, so that means the
28313 * position and sizes of children will effectively be percentages (0 to 100)
28314 * of the width or height of the grid widget
28320 * Add a new grid to the parent
28322 * @param parent The parent object
28323 * @return The new object or NULL if it cannot be created
28327 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28330 * Set the virtual size of the grid
28332 * @param obj The grid object
28333 * @param w The virtual width of the grid
28334 * @param h The virtual height of the grid
28338 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28341 * Get the virtual size of the grid
28343 * @param obj The grid object
28344 * @param w Pointer to integer to store the virtual width of the grid
28345 * @param h Pointer to integer to store the virtual height of the grid
28349 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28352 * Pack child at given position and size
28354 * @param obj The grid object
28355 * @param subobj The child to pack
28356 * @param x The virtual x coord at which to pack it
28357 * @param y The virtual y coord at which to pack it
28358 * @param w The virtual width at which to pack it
28359 * @param h The virtual height at which to pack it
28363 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28366 * Unpack a child from a grid object
28368 * @param obj The grid object
28369 * @param subobj The child to unpack
28373 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28376 * Faster way to remove all child objects from a grid object.
28378 * @param obj The grid object
28379 * @param clear If true, it will delete just removed children
28383 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28386 * Set packing of an existing child at to position and size
28388 * @param subobj The child to set packing of
28389 * @param x The virtual x coord at which to pack it
28390 * @param y The virtual y coord at which to pack it
28391 * @param w The virtual width at which to pack it
28392 * @param h The virtual height at which to pack it
28396 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28399 * get packing of a child
28401 * @param subobj The child to query
28402 * @param x Pointer to integer to store the virtual x coord
28403 * @param y Pointer to integer to store the virtual y coord
28404 * @param w Pointer to integer to store the virtual width
28405 * @param h Pointer to integer to store the virtual height
28409 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28415 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28416 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28417 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28418 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28419 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28420 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28423 * @defgroup Video Video
28425 * @addtogroup Video
28428 * Elementary comes with two object that help design application that need
28429 * to display video. The main one, Elm_Video, display a video by using Emotion.
28430 * It does embedded the video inside an Edje object, so you can do some
28431 * animation depending on the video state change. It does also implement a
28432 * ressource management policy to remove this burden from the application writer.
28434 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28435 * It take care of updating its content according to Emotion event and provide a
28436 * way to theme itself. It also does automatically raise the priority of the
28437 * linked Elm_Video so it will use the video decoder if available. It also does
28438 * activate the remember function on the linked Elm_Video object.
28440 * Signals that you can add callback for are :
28442 * "forward,clicked" - the user clicked the forward button.
28443 * "info,clicked" - the user clicked the info button.
28444 * "next,clicked" - the user clicked the next button.
28445 * "pause,clicked" - the user clicked the pause button.
28446 * "play,clicked" - the user clicked the play button.
28447 * "prev,clicked" - the user clicked the prev button.
28448 * "rewind,clicked" - the user clicked the rewind button.
28449 * "stop,clicked" - the user clicked the stop button.
28451 * Default contents parts of the player widget that you can use for are:
28452 * @li "video" - A video of the player
28457 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28459 * @param parent The parent object
28460 * @return a new player widget handle or @c NULL, on errors.
28462 * This function inserts a new player widget on the canvas.
28464 * @see elm_object_part_content_set()
28468 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28471 * @brief Link a Elm_Payer with an Elm_Video object.
28473 * @param player the Elm_Player object.
28474 * @param video The Elm_Video object.
28476 * This mean that action on the player widget will affect the
28477 * video object and the state of the video will be reflected in
28478 * the player itself.
28480 * @see elm_player_add()
28481 * @see elm_video_add()
28482 * @deprecated use elm_object_part_content_set() instead
28486 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28489 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28491 * @param parent The parent object
28492 * @return a new video widget handle or @c NULL, on errors.
28494 * This function inserts a new video widget on the canvas.
28496 * @seeelm_video_file_set()
28497 * @see elm_video_uri_set()
28501 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28504 * @brief Define the file that will be the video source.
28506 * @param video The video object to define the file for.
28507 * @param filename The file to target.
28509 * This function will explicitly define a filename as a source
28510 * for the video of the Elm_Video object.
28512 * @see elm_video_uri_set()
28513 * @see elm_video_add()
28514 * @see elm_player_add()
28518 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28521 * @brief Define the uri that will be the video source.
28523 * @param video The video object to define the file for.
28524 * @param uri The uri to target.
28526 * This function will define an uri as a source for the video of the
28527 * Elm_Video object. URI could be remote source of video, like http:// or local source
28528 * like for example WebCam who are most of the time v4l2:// (but that depend and
28529 * you should use Emotion API to request and list the available Webcam on your system).
28531 * @see elm_video_file_set()
28532 * @see elm_video_add()
28533 * @see elm_player_add()
28537 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28540 * @brief Get the underlying Emotion object.
28542 * @param video The video object to proceed the request on.
28543 * @return the underlying Emotion object.
28547 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28550 * @brief Start to play the video
28552 * @param video The video object to proceed the request on.
28554 * Start to play the video and cancel all suspend state.
28558 EAPI void elm_video_play(Evas_Object *video);
28561 * @brief Pause the video
28563 * @param video The video object to proceed the request on.
28565 * Pause the video and start a timer to trigger suspend mode.
28569 EAPI void elm_video_pause(Evas_Object *video);
28572 * @brief Stop the video
28574 * @param video The video object to proceed the request on.
28576 * Stop the video and put the emotion in deep sleep mode.
28580 EAPI void elm_video_stop(Evas_Object *video);
28583 * @brief Is the video actually playing.
28585 * @param video The video object to proceed the request on.
28586 * @return EINA_TRUE if the video is actually playing.
28588 * You should consider watching event on the object instead of polling
28589 * the object state.
28593 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28596 * @brief Is it possible to seek inside the video.
28598 * @param video The video object to proceed the request on.
28599 * @return EINA_TRUE if is possible to seek inside the video.
28603 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28606 * @brief Is the audio muted.
28608 * @param video The video object to proceed the request on.
28609 * @return EINA_TRUE if the audio is muted.
28613 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28616 * @brief Change the mute state of the Elm_Video object.
28618 * @param video The video object to proceed the request on.
28619 * @param mute The new mute state.
28623 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28626 * @brief Get the audio level of the current video.
28628 * @param video The video object to proceed the request on.
28629 * @return the current audio level.
28633 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28636 * @brief Set the audio level of anElm_Video object.
28638 * @param video The video object to proceed the request on.
28639 * @param volume The new audio volume.
28643 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28645 EAPI double elm_video_play_position_get(const Evas_Object *video);
28646 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28647 EAPI double elm_video_play_length_get(const Evas_Object *video);
28648 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28649 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28650 EAPI const char *elm_video_title_get(const Evas_Object *video);
28656 * @defgroup Naviframe Naviframe
28657 * @ingroup Elementary
28659 * @brief Naviframe is a kind of view manager for the applications.
28661 * Naviframe provides functions to switch different pages with stack
28662 * mechanism. It means if one page(item) needs to be changed to the new one,
28663 * then naviframe would push the new page to it's internal stack. Of course,
28664 * it can be back to the previous page by popping the top page. Naviframe
28665 * provides some transition effect while the pages are switching (same as
28668 * Since each item could keep the different styles, users could keep the
28669 * same look & feel for the pages or different styles for the items in it's
28672 * Signals that you can add callback for are:
28673 * @li "transition,finished" - When the transition is finished in changing
28675 * @li "title,clicked" - User clicked title area
28677 * Default contents parts of the naviframe items that you can use for are:
28678 * @li "default" - A main content of the page
28679 * @li "icon" - An icon in the title area
28680 * @li "prev_btn" - A button to go to the previous page
28681 * @li "next_btn" - A button to go to the next page
28683 * Default text parts of the naviframe items that you can use for are:
28684 * @li "default" - Title label in the title area
28685 * @li "subtitle" - Sub-title label in the title area
28687 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28691 * @addtogroup Naviframe
28696 * @brief Add a new Naviframe object to the parent.
28698 * @param parent Parent object
28699 * @return New object or @c NULL, if it cannot be created
28701 * @ingroup Naviframe
28703 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28705 * @brief Push a new item to the top of the naviframe stack (and show it).
28707 * @param obj The naviframe object
28708 * @param title_label The label in the title area. The name of the title
28709 * label part is "elm.text.title"
28710 * @param prev_btn The button to go to the previous item. If it is NULL,
28711 * then naviframe will create a back button automatically. The name of
28712 * the prev_btn part is "elm.swallow.prev_btn"
28713 * @param next_btn The button to go to the next item. Or It could be just an
28714 * extra function button. The name of the next_btn part is
28715 * "elm.swallow.next_btn"
28716 * @param content The main content object. The name of content part is
28717 * "elm.swallow.content"
28718 * @param item_style The current item style name. @c NULL would be default.
28719 * @return The created item or @c NULL upon failure.
28721 * The item pushed becomes one page of the naviframe, this item will be
28722 * deleted when it is popped.
28724 * @see also elm_naviframe_item_style_set()
28725 * @see also elm_naviframe_item_insert_before()
28726 * @see also elm_naviframe_item_insert_after()
28728 * The following styles are available for this item:
28731 * @ingroup Naviframe
28733 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);
28735 * @brief Insert a new item into the naviframe before item @p before.
28737 * @param before The naviframe item to insert before.
28738 * @param title_label The label in the title area. The name of the title
28739 * label part is "elm.text.title"
28740 * @param prev_btn The button to go to the previous item. If it is NULL,
28741 * then naviframe will create a back button automatically. The name of
28742 * the prev_btn part is "elm.swallow.prev_btn"
28743 * @param next_btn The button to go to the next item. Or It could be just an
28744 * extra function button. The name of the next_btn part is
28745 * "elm.swallow.next_btn"
28746 * @param content The main content object. The name of content part is
28747 * "elm.swallow.content"
28748 * @param item_style The current item style name. @c NULL would be default.
28749 * @return The created item or @c NULL upon failure.
28751 * The item is inserted into the naviframe straight away without any
28752 * transition operations. This item will be deleted when it is popped.
28754 * @see also elm_naviframe_item_style_set()
28755 * @see also elm_naviframe_item_push()
28756 * @see also elm_naviframe_item_insert_after()
28758 * The following styles are available for this item:
28761 * @ingroup Naviframe
28763 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);
28765 * @brief Insert a new item into the naviframe after item @p after.
28767 * @param after The naviframe item to insert after.
28768 * @param title_label The label in the title area. The name of the title
28769 * label part is "elm.text.title"
28770 * @param prev_btn The button to go to the previous item. If it is NULL,
28771 * then naviframe will create a back button automatically. The name of
28772 * the prev_btn part is "elm.swallow.prev_btn"
28773 * @param next_btn The button to go to the next item. Or It could be just an
28774 * extra function button. The name of the next_btn part is
28775 * "elm.swallow.next_btn"
28776 * @param content The main content object. The name of content part is
28777 * "elm.swallow.content"
28778 * @param item_style The current item style name. @c NULL would be default.
28779 * @return The created item or @c NULL upon failure.
28781 * The item is inserted into the naviframe straight away without any
28782 * transition operations. This item will be deleted when it is popped.
28784 * @see also elm_naviframe_item_style_set()
28785 * @see also elm_naviframe_item_push()
28786 * @see also elm_naviframe_item_insert_before()
28788 * The following styles are available for this item:
28791 * @ingroup Naviframe
28793 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);
28795 * @brief Pop an item that is on top of the stack
28797 * @param obj The naviframe object
28798 * @return @c NULL or the content object(if the
28799 * elm_naviframe_content_preserve_on_pop_get is true).
28801 * This pops an item that is on the top(visible) of the naviframe, makes it
28802 * disappear, then deletes the item. The item that was underneath it on the
28803 * stack will become visible.
28805 * @see also elm_naviframe_content_preserve_on_pop_get()
28807 * @ingroup Naviframe
28809 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28811 * @brief Pop the items between the top and the above one on the given item.
28813 * @param it The naviframe item
28815 * @ingroup Naviframe
28817 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28819 * Promote an item already in the naviframe stack to the top of the stack
28821 * @param it The naviframe item
28823 * This will take the indicated item and promote it to the top of the stack
28824 * as if it had been pushed there. The item must already be inside the
28825 * naviframe stack to work.
28828 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28830 * @brief Delete the given item instantly.
28832 * @param it The naviframe item
28834 * This just deletes the given item from the naviframe item list instantly.
28835 * So this would not emit any signals for view transitions but just change
28836 * the current view if the given item is a top one.
28838 * @ingroup Naviframe
28840 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28842 * @brief preserve the content objects when items are popped.
28844 * @param obj The naviframe object
28845 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28847 * @see also elm_naviframe_content_preserve_on_pop_get()
28849 * @ingroup Naviframe
28851 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28853 * @brief Get a value whether preserve mode is enabled or not.
28855 * @param obj The naviframe object
28856 * @return If @c EINA_TRUE, preserve mode is enabled
28858 * @see also elm_naviframe_content_preserve_on_pop_set()
28860 * @ingroup Naviframe
28862 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28864 * @brief Get a top item on the naviframe stack
28866 * @param obj The naviframe object
28867 * @return The top item on the naviframe stack or @c NULL, if the stack is
28870 * @ingroup Naviframe
28872 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28874 * @brief Get a bottom item on the naviframe stack
28876 * @param obj The naviframe object
28877 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28880 * @ingroup Naviframe
28882 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28884 * @brief Set an item style
28886 * @param obj The naviframe item
28887 * @param item_style The current item style name. @c NULL would be default
28889 * The following styles are available for this item:
28892 * @see also elm_naviframe_item_style_get()
28894 * @ingroup Naviframe
28896 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28898 * @brief Get an item style
28900 * @param obj The naviframe item
28901 * @return The current item style name
28903 * @see also elm_naviframe_item_style_set()
28905 * @ingroup Naviframe
28907 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28909 * @brief Show/Hide the title area
28911 * @param it The naviframe item
28912 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28915 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28917 * @see also elm_naviframe_item_title_visible_get()
28919 * @ingroup Naviframe
28921 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28923 * @brief Get a value whether title area is visible or not.
28925 * @param it The naviframe item
28926 * @return If @c EINA_TRUE, title area is visible
28928 * @see also elm_naviframe_item_title_visible_set()
28930 * @ingroup Naviframe
28932 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28935 * @brief Set creating prev button automatically or not
28937 * @param obj The naviframe object
28938 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28939 * be created internally when you pass the @c NULL to the prev_btn
28940 * parameter in elm_naviframe_item_push
28942 * @see also elm_naviframe_item_push()
28944 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28946 * @brief Get a value whether prev button(back button) will be auto pushed or
28949 * @param obj The naviframe object
28950 * @return If @c EINA_TRUE, prev button will be auto pushed.
28952 * @see also elm_naviframe_item_push()
28953 * elm_naviframe_prev_btn_auto_pushed_set()
28955 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28957 * @brief Get a list of all the naviframe items.
28959 * @param obj The naviframe object
28960 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28961 * or @c NULL on failure.
28963 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28970 * @defgroup Multibuttonentry Multibuttonentry
28972 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
28973 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
28974 * a new button is added to the next row. When a text button is pressed, it will become focused.
28975 * Backspace removes the focus.
28976 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
28978 * Smart callbacks one can register:
28979 * - @c "item,selected" - when item is selected. May be called on backspace key.
28980 * - @c "item,added" - when a new multibuttonentry item is added.
28981 * - @c "item,deleted" - when a multibuttonentry item is deleted.
28982 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
28983 * - @c "clicked" - when multibuttonentry is clicked.
28984 * - @c "focused" - when multibuttonentry is focused.
28985 * - @c "unfocused" - when multibuttonentry is unfocused.
28986 * - @c "expanded" - when multibuttonentry is expanded.
28987 * - @c "shrank" - when multibuttonentry is shrank.
28988 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
28990 * Here is an example on its usage:
28991 * @li @ref multibuttonentry_example
28994 * @addtogroup Multibuttonentry
28998 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28999 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29002 * @brief Add a new multibuttonentry to the parent
29004 * @param parent The parent object
29005 * @return The new object or NULL if it cannot be created
29008 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29012 * @param obj The multibuttonentry object
29013 * @return The label, or NULL if none
29016 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29020 * @param obj The multibuttonentry object
29021 * @param label The text label string
29024 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29026 * Get the entry of the multibuttonentry object
29028 * @param obj The multibuttonentry object
29029 * @return The entry object, or NULL if none
29032 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29034 * Get the guide text
29036 * @param obj The multibuttonentry object
29037 * @return The guide text, or NULL if none
29040 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29042 * Set the guide text
29044 * @param obj The multibuttonentry object
29045 * @param label The guide text string
29048 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
29050 * Get the value of shrink_mode state.
29052 * @param obj The multibuttonentry object
29053 * @param the value of shrink mode state.
29056 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29058 * Set/Unset the multibuttonentry to shrink mode state of single line
29060 * @param obj The multibuttonentry object
29061 * @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.
29064 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
29066 * Prepend a new item to the multibuttonentry
29068 * @param obj The multibuttonentry object
29069 * @param label The label of new item
29070 * @param data The ponter to the data to be attached
29071 * @return A handle to the item added or NULL if not possible
29074 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29076 * Append a new item to the multibuttonentry
29078 * @param obj The multibuttonentry object
29079 * @param label The label of new item
29080 * @param data The ponter to the data to be attached
29081 * @return A handle to the item added or NULL if not possible
29084 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29086 * Add a new item to the multibuttonentry before the indicated object
29089 * @param obj The multibuttonentry object
29090 * @param before The item before which to add it
29091 * @param label The label of new item
29092 * @param data The ponter to the data to be attached
29093 * @return A handle to the item added or NULL if not possible
29096 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);
29098 * Add a new item to the multibuttonentry after the indicated object
29100 * @param obj The multibuttonentry object
29101 * @param after The item after which to add it
29102 * @param label The label of new item
29103 * @param data The ponter to the data to be attached
29104 * @return A handle to the item added or NULL if not possible
29107 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);
29109 * Get a list of items in the multibuttonentry
29111 * @param obj The multibuttonentry object
29112 * @return The list of items, or NULL if none
29115 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29117 * Get the first item in the multibuttonentry
29119 * @param obj The multibuttonentry object
29120 * @return The first item, or NULL if none
29123 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29125 * Get the last item in the multibuttonentry
29127 * @param obj The multibuttonentry object
29128 * @return The last item, or NULL if none
29131 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29133 * Get the selected item in the multibuttonentry
29135 * @param obj The multibuttonentry object
29136 * @return The selected item, or NULL if none
29139 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29141 * Set the selected state of an item
29143 * @param item The item
29144 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29147 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29149 * unselect all items.
29151 * @param obj The multibuttonentry object
29154 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29156 * Delete a given item
29158 * @param item The item
29161 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29163 * Remove all items in the multibuttonentry.
29165 * @param obj The multibuttonentry object
29168 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29170 * Get the label of a given item
29172 * @param item The item
29173 * @return The label of a given item, or NULL if none
29176 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29178 * Set the label of a given item
29180 * @param item The item
29181 * @param label The text label string
29184 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29186 * Get the previous item in the multibuttonentry
29188 * @param item The item
29189 * @return The item before the item @p item
29192 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29194 * Get the next item in the multibuttonentry
29196 * @param item The item
29197 * @return The item after the item @p item
29200 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29202 * Append a item filter function for text inserted in the Multibuttonentry
29204 * Append the given callback to the list. This functions will be called
29205 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29206 * as a parameter. The callback function is free to alter the text in any way
29207 * it wants, but it must remember to free the given pointer and update it.
29208 * If the new text is to be discarded, the function can free it and set it text
29209 * parameter to NULL. This will also prevent any following filters from being
29212 * @param obj The multibuttonentryentry object
29213 * @param func The function to use as item filter
29214 * @param data User data to pass to @p func
29217 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29219 * Prepend a filter function for text inserted in the Multibuttentry
29221 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29222 * for more information
29224 * @param obj The multibuttonentry object
29225 * @param func The function to use as text filter
29226 * @param data User data to pass to @p func
29229 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29231 * Remove a filter from the list
29233 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29234 * for more information.
29236 * @param obj The multibuttonentry object
29237 * @param func The filter function to remove
29238 * @param data The user data passed when adding the function
29241 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);