3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
245 @page authors Authors
246 @author Carsten Haitzler <raster@@rasterman.com>
247 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
248 @author Cedric Bail <cedric.bail@@free.fr>
249 @author Vincent Torri <vtorri@@univ-evry.fr>
250 @author Daniel Kolesa <quaker66@@gmail.com>
251 @author Jaime Thomas <avi.thomas@@gmail.com>
252 @author Swisscom - http://www.swisscom.ch/
253 @author Christopher Michael <devilhorns@@comcast.net>
254 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
255 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
256 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
257 @author Brian Wang <brian.wang.0721@@gmail.com>
258 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
259 @author Samsung Electronics <tbd>
260 @author Samsung SAIT <tbd>
261 @author Brett Nash <nash@@nash.id.au>
262 @author Bruno Dilly <bdilly@@profusion.mobi>
263 @author Rafael Fonseca <rfonseca@@profusion.mobi>
264 @author Chuneon Park <hermet@@hermet.pe.kr>
265 @author Woohyun Jung <wh0705.jung@@samsung.com>
266 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
267 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
268 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
269 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
270 @author Gustavo Lima Chaves <glima@@profusion.mobi>
271 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
272 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
273 @author Otavio Pontes <otavio@@profusion.mobi>
274 @author Viktor Kojouharov <vkojouharov@@gmail.com>
275 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
276 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
277 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
278 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
279 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
280 @author Jihoon Kim <jihoon48.kim@@samsung.com>
281 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
282 @author Tom Hacohen <tom@@stosb.com>
283 @author Aharon Hillel <a.hillel@@partner.samsung.com>
284 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
285 @author Shinwoo Kim <kimcinoo@@gmail.com>
286 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
287 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
288 @author Sung W. Park <sungwoo@@gmail.com>
289 @author Thierry el Borgi <thierry@@substantiel.fr>
290 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
291 @author Chanwook Jung <joey.jung@@samsung.com>
292 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
293 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
294 @author Kim Yunhan <spbear@@gmail.com>
295 @author Bluezery <ohpowel@@gmail.com>
296 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
297 @author Sanjeev BA <iamsanjeev@@gmail.com>
299 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
300 contact with the developers and maintainers.
308 * @brief Elementary's API
313 @ELM_UNIX_DEF@ ELM_UNIX
314 @ELM_WIN32_DEF@ ELM_WIN32
315 @ELM_WINCE_DEF@ ELM_WINCE
316 @ELM_EDBUS_DEF@ ELM_EDBUS
317 @ELM_EFREET_DEF@ ELM_EFREET
318 @ELM_ETHUMB_DEF@ ELM_ETHUMB
319 @ELM_WEB_DEF@ ELM_WEB
320 @ELM_EMAP_DEF@ ELM_EMAP
321 @ELM_DEBUG_DEF@ ELM_DEBUG
322 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
323 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
326 /* Standard headers for standard system calls etc. */
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
348 # ifdef ELM_LIBINTL_H
349 # include <libintl.h>
360 #if defined (ELM_WIN32) || defined (ELM_WINCE)
363 # define alloca _alloca
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
391 # include <Ethumb_Client.h>
403 # ifdef ELEMENTARY_BUILD
405 # define EAPI __declspec(dllexport)
408 # endif /* ! DLL_EXPORT */
410 # define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
415 # define EAPI __attribute__ ((visibility("default")))
422 #endif /* ! _WIN32 */
427 # define EAPI_MAIN EAPI
430 /* allow usage from c++ */
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
438 typedef struct _Elm_Version
446 EAPI extern Elm_Version *elm_version;
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
453 * @defgroup General General
455 * @brief General Elementary API. Functions that don't relate to
456 * Elementary objects specifically.
458 * Here are documented functions which init/shutdown the library,
459 * that apply to generic Elementary objects, that deal with
460 * configuration, et cetera.
462 * @ref general_functions_example_page "This" example contemplates
463 * some of these functions.
467 * @addtogroup General
472 * Defines couple of standard Evas_Object layers to be used
473 * with evas_object_layer_set().
475 * @note whenever extending with new values, try to keep some padding
476 * to siblings so there is room for further extensions.
478 typedef enum _Elm_Object_Layer
480 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488 /**************************************************************************/
489 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492 * Emitted when the application has reconfigured elementary settings due
493 * to an external configuration tool asking it to.
495 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498 * Emitted when any Elementary's policy value is changed.
500 EAPI extern int ELM_EVENT_POLICY_CHANGED;
503 * @typedef Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510 * @struct _Elm_Event_Policy_Changed
512 * Data on the event when an Elementary policy has changed
514 struct _Elm_Event_Policy_Changed
516 unsigned int policy; /**< the policy identifier */
517 int new_value; /**< value the policy had before the change */
518 int old_value; /**< new value the policy got */
522 * Policy identifiers.
524 typedef enum _Elm_Policy
526 ELM_POLICY_QUIT, /**< under which circumstances the application
527 * should quit automatically. @see
531 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
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);
3595 * Free a specific theme
3597 * @param th The theme to free
3599 * This frees a theme created with elm_theme_new().
3601 EAPI void elm_theme_free(Elm_Theme *th);
3604 * Copy the theme fom the source to the destination theme
3606 * @param th The source theme to copy from
3607 * @param thdst The destination theme to copy data to
3609 * This makes a one-time static copy of all the theme config, extensions
3610 * and overlays from @p th to @p thdst. If @p th references a theme, then
3611 * @p thdst is also set to reference it, with all the theme settings,
3612 * overlays and extensions that @p th had.
3614 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3617 * Tell the source theme to reference the ref theme
3619 * @param th The theme that will do the referencing
3620 * @param thref The theme that is the reference source
3622 * This clears @p th to be empty and then sets it to refer to @p thref
3623 * so @p th acts as an override to @p thref, but where its overrides
3624 * don't apply, it will fall through to @p thref for configuration.
3626 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3629 * Return the theme referred to
3631 * @param th The theme to get the reference from
3632 * @return The referenced theme handle
3634 * This gets the theme set as the reference theme by elm_theme_ref_set().
3635 * If no theme is set as a reference, NULL is returned.
3637 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3640 * Return the default theme
3642 * @return The default theme handle
3644 * This returns the internal default theme setup handle that all widgets
3645 * use implicitly unless a specific theme is set. This is also often use
3646 * as a shorthand of NULL.
3648 EAPI Elm_Theme *elm_theme_default_get(void);
3651 * Prepends a theme overlay to the list of overlays
3653 * @param th The theme to add to, or if NULL, the default theme
3654 * @param item The Edje file path to be used
3656 * Use this if your application needs to provide some custom overlay theme
3657 * (An Edje file that replaces some default styles of widgets) where adding
3658 * new styles, or changing system theme configuration is not possible. Do
3659 * NOT use this instead of a proper system theme configuration. Use proper
3660 * configuration files, profiles, environment variables etc. to set a theme
3661 * so that the theme can be altered by simple confiugration by a user. Using
3662 * this call to achieve that effect is abusing the API and will create lots
3665 * @see elm_theme_extension_add()
3667 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3670 * Delete a theme overlay from the list of overlays
3672 * @param th The theme to delete from, or if NULL, the default theme
3673 * @param item The name of the theme overlay
3675 * @see elm_theme_overlay_add()
3677 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3680 * Appends a theme extension to the list of extensions.
3682 * @param th The theme to add to, or if NULL, the default theme
3683 * @param item The Edje file path to be used
3685 * This is intended when an application needs more styles of widgets or new
3686 * widget themes that the default does not provide (or may not provide). The
3687 * application has "extended" usage by coming up with new custom style names
3688 * for widgets for specific uses, but as these are not "standard", they are
3689 * not guaranteed to be provided by a default theme. This means the
3690 * application is required to provide these extra elements itself in specific
3691 * Edje files. This call adds one of those Edje files to the theme search
3692 * path to be search after the default theme. The use of this call is
3693 * encouraged when default styles do not meet the needs of the application.
3694 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3696 * @see elm_object_style_set()
3698 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3701 * Deletes a theme extension from the list of extensions.
3703 * @param th The theme to delete from, or if NULL, the default theme
3704 * @param item The name of the theme extension
3706 * @see elm_theme_extension_add()
3708 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3711 * Set the theme search order for the given theme
3713 * @param th The theme to set the search order, or if NULL, the default theme
3714 * @param theme Theme search string
3716 * This sets the search string for the theme in path-notation from first
3717 * theme to search, to last, delimited by the : character. Example:
3719 * "shiny:/path/to/file.edj:default"
3721 * See the ELM_THEME environment variable for more information.
3723 * @see elm_theme_get()
3724 * @see elm_theme_list_get()
3726 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3729 * Return the theme search order
3731 * @param th The theme to get the search order, or if NULL, the default theme
3732 * @return The internal search order path
3734 * This function returns a colon separated string of theme elements as
3735 * returned by elm_theme_list_get().
3737 * @see elm_theme_set()
3738 * @see elm_theme_list_get()
3740 EAPI const char *elm_theme_get(Elm_Theme *th);
3743 * Return a list of theme elements to be used in a theme.
3745 * @param th Theme to get the list of theme elements from.
3746 * @return The internal list of theme elements
3748 * This returns the internal list of theme elements (will only be valid as
3749 * long as the theme is not modified by elm_theme_set() or theme is not
3750 * freed by elm_theme_free(). This is a list of strings which must not be
3751 * altered as they are also internal. If @p th is NULL, then the default
3752 * theme element list is returned.
3754 * A theme element can consist of a full or relative path to a .edj file,
3755 * or a name, without extension, for a theme to be searched in the known
3756 * theme paths for Elemementary.
3758 * @see elm_theme_set()
3759 * @see elm_theme_get()
3761 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3764 * Return the full patrh for a theme element
3766 * @param f The theme element name
3767 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3768 * @return The full path to the file found.
3770 * This returns a string you should free with free() on success, NULL on
3771 * failure. This will search for the given theme element, and if it is a
3772 * full or relative path element or a simple searchable name. The returned
3773 * path is the full path to the file, if searched, and the file exists, or it
3774 * is simply the full path given in the element or a resolved path if
3775 * relative to home. The @p in_search_path boolean pointed to is set to
3776 * EINA_TRUE if the file was a searchable file andis in the search path,
3777 * and EINA_FALSE otherwise.
3779 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3782 * Flush the current theme.
3784 * @param th Theme to flush
3786 * This flushes caches that let elementary know where to find theme elements
3787 * in the given theme. If @p th is NULL, then the default theme is flushed.
3788 * Call this function if source theme data has changed in such a way as to
3789 * make any caches Elementary kept invalid.
3791 EAPI void elm_theme_flush(Elm_Theme *th);
3794 * This flushes all themes (default and specific ones).
3796 * This will flush all themes in the current application context, by calling
3797 * elm_theme_flush() on each of them.
3799 EAPI void elm_theme_full_flush(void);
3802 * Set the theme for all elementary using applications on the current display
3804 * @param theme The name of the theme to use. Format same as the ELM_THEME
3805 * environment variable.
3807 EAPI void elm_theme_all_set(const char *theme);
3810 * Return a list of theme elements in the theme search path
3812 * @return A list of strings that are the theme element names.
3814 * This lists all available theme files in the standard Elementary search path
3815 * for theme elements, and returns them in alphabetical order as theme
3816 * element names in a list of strings. Free this with
3817 * elm_theme_name_available_list_free() when you are done with the list.
3819 EAPI Eina_List *elm_theme_name_available_list_new(void);
3822 * Free the list returned by elm_theme_name_available_list_new()
3824 * This frees the list of themes returned by
3825 * elm_theme_name_available_list_new(). Once freed the list should no longer
3826 * be used. a new list mys be created.
3828 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3831 * Set a specific theme to be used for this object and its children
3833 * @param obj The object to set the theme on
3834 * @param th The theme to set
3836 * This sets a specific theme that will be used for the given object and any
3837 * child objects it has. If @p th is NULL then the theme to be used is
3838 * cleared and the object will inherit its theme from its parent (which
3839 * ultimately will use the default theme if no specific themes are set).
3841 * Use special themes with great care as this will annoy users and make
3842 * configuration difficult. Avoid any custom themes at all if it can be
3845 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3848 * Get the specific theme to be used
3850 * @param obj The object to get the specific theme from
3851 * @return The specifc theme set.
3853 * This will return a specific theme set, or NULL if no specific theme is
3854 * set on that object. It will not return inherited themes from parents, only
3855 * the specific theme set for that specific object. See elm_object_theme_set()
3856 * for more information.
3858 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3861 * Get a data item from a theme
3863 * @param th The theme, or NULL for default theme
3864 * @param key The data key to search with
3865 * @return The data value, or NULL on failure
3867 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3868 * It works the same way as edje_file_data_get() except that the return is stringshared.
3870 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3877 /** @defgroup Win Win
3879 * @image html img/widget/win/preview-00.png
3880 * @image latex img/widget/win/preview-00.eps
3882 * The window class of Elementary. Contains functions to manipulate
3883 * windows. The Evas engine used to render the window contents is specified
3884 * in the system or user elementary config files (whichever is found last),
3885 * and can be overridden with the ELM_ENGINE environment variable for
3886 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3887 * compilation setup and modules actually installed at runtime) are (listed
3888 * in order of best supported and most likely to be complete and work to
3891 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3892 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3894 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3896 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3898 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3900 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3901 * rendering using SDL as the buffer)
3902 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3903 * GDI with software)
3904 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3905 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3906 * grayscale using dedicated 8bit software engine in X11)
3907 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3908 * X11 using 16bit software engine)
3909 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3910 * (Windows CE rendering via GDI with 16bit software renderer)
3911 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3912 * buffer with 16bit software renderer)
3913 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3914 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3915 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3917 * All engines use a simple string to select the engine to render, EXCEPT
3918 * the "shot" engine. This actually encodes the output of the virtual
3919 * screenshot and how long to delay in the engine string. The engine string
3920 * is encoded in the following way:
3922 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3924 * Where options are separated by a ":" char if more than one option is
3925 * given, with delay, if provided being the first option and file the last
3926 * (order is important). The delay specifies how long to wait after the
3927 * window is shown before doing the virtual "in memory" rendering and then
3928 * save the output to the file specified by the file option (and then exit).
3929 * If no delay is given, the default is 0.5 seconds. If no file is given the
3930 * default output file is "out.png". Repeat option is for continous
3931 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3932 * fixed to "out001.png" Some examples of using the shot engine:
3934 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3935 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3936 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3937 * ELM_ENGINE="shot:delay=2.0" elementary_test
3938 * ELM_ENGINE="shot:" elementary_test
3940 * Signals that you can add callbacks for are:
3942 * @li "delete,request": the user requested to close the window. See
3943 * elm_win_autodel_set().
3944 * @li "focus,in": window got focus
3945 * @li "focus,out": window lost focus
3946 * @li "moved": window that holds the canvas was moved
3949 * @li @ref win_example_01
3954 * Defines the types of window that can be created
3956 * These are hints set on the window so that a running Window Manager knows
3957 * how the window should be handled and/or what kind of decorations it
3960 * Currently, only the X11 backed engines use them.
3962 typedef enum _Elm_Win_Type
3964 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3965 window. Almost every window will be created with this
3967 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3968 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3969 window holding desktop icons. */
3970 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3971 be kept on top of any other window by the Window
3973 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3975 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3976 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3978 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3979 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3980 entry in a menubar is clicked. Typically used
3981 with elm_win_override_set(). This hint exists
3982 for completion only, as the EFL way of
3983 implementing a menu would not normally use a
3984 separate window for its contents. */
3985 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3986 triggered by right-clicking an object. */
3987 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3988 explanatory text that typically appear after the
3989 mouse cursor hovers over an object for a while.
3990 Typically used with elm_win_override_set() and also
3991 not very commonly used in the EFL. */
3992 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3993 battery life or a new E-Mail received. */
3994 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3995 usually used in the EFL. */
3996 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3997 object being dragged across different windows, or even
3998 applications. Typically used with
3999 elm_win_override_set(). */
4000 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
4001 buffer. No actual window is created for this
4002 type, instead the window and all of its
4003 contents will be rendered to an image buffer.
4004 This allows to have children window inside a
4005 parent one just like any other object would
4006 be, and do other things like applying @c
4007 Evas_Map effects to it. This is the only type
4008 of window that requires the @c parent
4009 parameter of elm_win_add() to be a valid @c
4014 * The differents layouts that can be requested for the virtual keyboard.
4016 * When the application window is being managed by Illume, it may request
4017 * any of the following layouts for the virtual keyboard.
4019 typedef enum _Elm_Win_Keyboard_Mode
4021 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4022 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4023 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4024 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4025 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4026 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4027 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4028 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4029 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4030 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4031 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4032 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4033 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4034 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4035 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4036 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4037 } Elm_Win_Keyboard_Mode;
4040 * Available commands that can be sent to the Illume manager.
4042 * When running under an Illume session, a window may send commands to the
4043 * Illume manager to perform different actions.
4045 typedef enum _Elm_Illume_Command
4047 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4049 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4051 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4053 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4054 } Elm_Illume_Command;
4057 * Adds a window object. If this is the first window created, pass NULL as
4060 * @param parent Parent object to add the window to, or NULL
4061 * @param name The name of the window
4062 * @param type The window type, one of #Elm_Win_Type.
4064 * The @p parent paramter can be @c NULL for every window @p type except
4065 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4066 * which the image object will be created.
4068 * @return The created object, or NULL on failure
4070 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4073 * Adds a window object with standard setup
4075 * @param name The name of the window
4076 * @param title The title for the window
4078 * This creates a window like elm_win_add() but also puts in a standard
4079 * background with elm_bg_add(), as well as setting the window title to
4080 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4081 * as the parent widget.
4083 * @return The created object, or NULL on failure
4085 * @see elm_win_add()
4087 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4090 * Add @p subobj as a resize object of window @p obj.
4093 * Setting an object as a resize object of the window means that the
4094 * @p subobj child's size and position will be controlled by the window
4095 * directly. That is, the object will be resized to match the window size
4096 * and should never be moved or resized manually by the developer.
4098 * In addition, resize objects of the window control what the minimum size
4099 * of it will be, as well as whether it can or not be resized by the user.
4101 * For the end user to be able to resize a window by dragging the handles
4102 * or borders provided by the Window Manager, or using any other similar
4103 * mechanism, all of the resize objects in the window should have their
4104 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4106 * Also notice that the window can get resized to the current size of the
4107 * object if the EVAS_HINT_EXPAND is set @b after the call to
4108 * elm_win_resize_object_add(). So if the object should get resized to the
4109 * size of the window, set this hint @b before adding it as a resize object
4110 * (this happens because the size of the window and the object are evaluated
4111 * as soon as the object is added to the window).
4113 * @param obj The window object
4114 * @param subobj The resize object to add
4116 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4119 * Delete @p subobj as a resize object of window @p obj.
4121 * This function removes the object @p subobj from the resize objects of
4122 * the window @p obj. It will not delete the object itself, which will be
4123 * left unmanaged and should be deleted by the developer, manually handled
4124 * or set as child of some other container.
4126 * @param obj The window object
4127 * @param subobj The resize object to add
4129 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4132 * Set the title of the window
4134 * @param obj The window object
4135 * @param title The title to set
4137 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4140 * Get the title of the window
4142 * The returned string is an internal one and should not be freed or
4143 * modified. It will also be rendered invalid if a new title is set or if
4144 * the window is destroyed.
4146 * @param obj The window object
4149 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4152 * Set the window's autodel state.
4154 * When closing the window in any way outside of the program control, like
4155 * pressing the X button in the titlebar or using a command from the
4156 * Window Manager, a "delete,request" signal is emitted to indicate that
4157 * this event occurred and the developer can take any action, which may
4158 * include, or not, destroying the window object.
4160 * When the @p autodel parameter is set, the window will be automatically
4161 * destroyed when this event occurs, after the signal is emitted.
4162 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4163 * and is up to the program to do so when it's required.
4165 * @param obj The window object
4166 * @param autodel If true, the window will automatically delete itself when
4169 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4172 * Get the window's autodel state.
4174 * @param obj The window object
4175 * @return If the window will automatically delete itself when closed
4177 * @see elm_win_autodel_set()
4179 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4182 * Activate a window object.
4184 * This function sends a request to the Window Manager to activate the
4185 * window pointed by @p obj. If honored by the WM, the window will receive
4186 * the keyboard focus.
4188 * @note This is just a request that a Window Manager may ignore, so calling
4189 * this function does not ensure in any way that the window will be the
4190 * active one after it.
4192 * @param obj The window object
4194 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4197 * Lower a window object.
4199 * Places the window pointed by @p obj at the bottom of the stack, so that
4200 * no other window is covered by it.
4202 * If elm_win_override_set() is not set, the Window Manager may ignore this
4205 * @param obj The window object
4207 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4210 * Raise a window object.
4212 * Places the window pointed by @p obj at the top of the stack, so that it's
4213 * not covered by any other window.
4215 * If elm_win_override_set() is not set, the Window Manager may ignore this
4218 * @param obj The window object
4220 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4223 * Center a window on its screen
4225 * This function centers window @p obj horizontally and/or vertically based on the values
4227 * @param obj The window object
4228 * @param h If true, center horizontally. If false, do not change horizontal location.
4229 * @param v If true, center vertically. If false, do not change vertical location.
4231 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
4234 * Set the borderless state of a window.
4236 * This function requests the Window Manager to not draw any decoration
4237 * around the window.
4239 * @param obj The window object
4240 * @param borderless If true, the window is borderless
4242 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4245 * Get the borderless state of a window.
4247 * @param obj The window object
4248 * @return If true, the window is borderless
4250 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4253 * Set the shaped state of a window.
4255 * Shaped windows, when supported, will render the parts of the window that
4256 * has no content, transparent.
4258 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4259 * background object or cover the entire window in any other way, or the
4260 * parts of the canvas that have no data will show framebuffer artifacts.
4262 * @param obj The window object
4263 * @param shaped If true, the window is shaped
4265 * @see elm_win_alpha_set()
4267 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4270 * Get the shaped state of a window.
4272 * @param obj The window object
4273 * @return If true, the window is shaped
4275 * @see elm_win_shaped_set()
4277 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4280 * Set the alpha channel state of a window.
4282 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4283 * possibly making parts of the window completely or partially transparent.
4284 * This is also subject to the underlying system supporting it, like for
4285 * example, running under a compositing manager. If no compositing is
4286 * available, enabling this option will instead fallback to using shaped
4287 * windows, with elm_win_shaped_set().
4289 * @param obj The window object
4290 * @param alpha If true, the window has an alpha channel
4292 * @see elm_win_alpha_set()
4294 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4297 * Get the transparency state of a window.
4299 * @param obj The window object
4300 * @return If true, the window is transparent
4302 * @see elm_win_transparent_set()
4304 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4307 * Set the transparency state of a window.
4309 * Use elm_win_alpha_set() instead.
4311 * @param obj The window object
4312 * @param transparent If true, the window is transparent
4314 * @see elm_win_alpha_set()
4316 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4319 * Get the alpha channel state of a window.
4321 * @param obj The window object
4322 * @return If true, the window has an alpha channel
4324 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4327 * Set the override state of a window.
4329 * A window with @p override set to EINA_TRUE will not be managed by the
4330 * Window Manager. This means that no decorations of any kind will be shown
4331 * for it, moving and resizing must be handled by the application, as well
4332 * as the window visibility.
4334 * This should not be used for normal windows, and even for not so normal
4335 * ones, it should only be used when there's a good reason and with a lot
4336 * of care. Mishandling override windows may result situations that
4337 * disrupt the normal workflow of the end user.
4339 * @param obj The window object
4340 * @param override If true, the window is overridden
4342 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4345 * Get the override state of a window.
4347 * @param obj The window object
4348 * @return If true, the window is overridden
4350 * @see elm_win_override_set()
4352 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4355 * Set the fullscreen state of a window.
4357 * @param obj The window object
4358 * @param fullscreen If true, the window is fullscreen
4360 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4363 * Get the fullscreen state of a window.
4365 * @param obj The window object
4366 * @return If true, the window is fullscreen
4368 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4371 * Set the maximized state of a window.
4373 * @param obj The window object
4374 * @param maximized If true, the window is maximized
4376 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4379 * Get the maximized state of a window.
4381 * @param obj The window object
4382 * @return If true, the window is maximized
4384 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4387 * Set the iconified state of a window.
4389 * @param obj The window object
4390 * @param iconified If true, the window is iconified
4392 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4395 * Get the iconified state of a window.
4397 * @param obj The window object
4398 * @return If true, the window is iconified
4400 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4403 * Set the layer of the window.
4405 * What this means exactly will depend on the underlying engine used.
4407 * In the case of X11 backed engines, the value in @p layer has the
4408 * following meanings:
4409 * @li < 3: The window will be placed below all others.
4410 * @li > 5: The window will be placed above all others.
4411 * @li other: The window will be placed in the default layer.
4413 * @param obj The window object
4414 * @param layer The layer of the window
4416 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4419 * Get the layer of the window.
4421 * @param obj The window object
4422 * @return The layer of the window
4424 * @see elm_win_layer_set()
4426 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4429 * Set the rotation of the window.
4431 * Most engines only work with multiples of 90.
4433 * This function is used to set the orientation of the window @p obj to
4434 * match that of the screen. The window itself will be resized to adjust
4435 * to the new geometry of its contents. If you want to keep the window size,
4436 * see elm_win_rotation_with_resize_set().
4438 * @param obj The window object
4439 * @param rotation The rotation of the window, in degrees (0-360),
4440 * counter-clockwise.
4442 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4445 * Rotates the window and resizes it.
4447 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4448 * that they fit inside the current window geometry.
4450 * @param obj The window object
4451 * @param layer The rotation of the window in degrees (0-360),
4452 * counter-clockwise.
4454 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4457 * Get the rotation of the window.
4459 * @param obj The window object
4460 * @return The rotation of the window in degrees (0-360)
4462 * @see elm_win_rotation_set()
4463 * @see elm_win_rotation_with_resize_set()
4465 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4468 * Set the sticky state of the window.
4470 * Hints the Window Manager that the window in @p obj should be left fixed
4471 * at its position even when the virtual desktop it's on moves or changes.
4473 * @param obj The window object
4474 * @param sticky If true, the window's sticky state is enabled
4476 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4479 * Get the sticky state of the window.
4481 * @param obj The window object
4482 * @return If true, the window's sticky state is enabled
4484 * @see elm_win_sticky_set()
4486 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4489 * Set if this window is an illume conformant window
4491 * @param obj The window object
4492 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4494 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4497 * Get if this window is an illume conformant window
4499 * @param obj The window object
4500 * @return A boolean if this window is illume conformant or not
4502 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4505 * Set a window to be an illume quickpanel window
4507 * By default window objects are not quickpanel windows.
4509 * @param obj The window object
4510 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4512 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4515 * Get if this window is a quickpanel or not
4517 * @param obj The window object
4518 * @return A boolean if this window is a quickpanel or not
4520 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4523 * Set the major priority of a quickpanel window
4525 * @param obj The window object
4526 * @param priority The major priority for this quickpanel
4528 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4531 * Get the major priority of a quickpanel window
4533 * @param obj The window object
4534 * @return The major priority of this quickpanel
4536 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4539 * Set the minor priority of a quickpanel window
4541 * @param obj The window object
4542 * @param priority The minor priority for this quickpanel
4544 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4547 * Get the minor priority of a quickpanel window
4549 * @param obj The window object
4550 * @return The minor priority of this quickpanel
4552 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4555 * Set which zone this quickpanel should appear in
4557 * @param obj The window object
4558 * @param zone The requested zone for this quickpanel
4560 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4563 * Get which zone this quickpanel should appear in
4565 * @param obj The window object
4566 * @return The requested zone for this quickpanel
4568 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4571 * Set the window to be skipped by keyboard focus
4573 * This sets the window to be skipped by normal keyboard input. This means
4574 * a window manager will be asked to not focus this window as well as omit
4575 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4577 * Call this and enable it on a window BEFORE you show it for the first time,
4578 * otherwise it may have no effect.
4580 * Use this for windows that have only output information or might only be
4581 * interacted with by the mouse or fingers, and never for typing input.
4582 * Be careful that this may have side-effects like making the window
4583 * non-accessible in some cases unless the window is specially handled. Use
4586 * @param obj The window object
4587 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4589 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4592 * Send a command to the windowing environment
4594 * This is intended to work in touchscreen or small screen device
4595 * environments where there is a more simplistic window management policy in
4596 * place. This uses the window object indicated to select which part of the
4597 * environment to control (the part that this window lives in), and provides
4598 * a command and an optional parameter structure (use NULL for this if not
4601 * @param obj The window object that lives in the environment to control
4602 * @param command The command to send
4603 * @param params Optional parameters for the command
4605 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4608 * Get the inlined image object handle
4610 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4611 * then the window is in fact an evas image object inlined in the parent
4612 * canvas. You can get this object (be careful to not manipulate it as it
4613 * is under control of elementary), and use it to do things like get pixel
4614 * data, save the image to a file, etc.
4616 * @param obj The window object to get the inlined image from
4617 * @return The inlined image object, or NULL if none exists
4619 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4622 * Determine whether a window has focus
4623 * @param obj The window to query
4624 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4626 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4629 * Constrain the maximum width and height of a window to the width and height of its screen
4631 * When @p constrain is true, @p obj will never resize larger than the screen.
4632 * @param obj The window object
4633 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4635 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
4638 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
4640 * When this function returns true, @p obj will never resize larger than the screen.
4641 * @param obj The window object
4642 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4644 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4647 * Get screen geometry details for the screen that a window is on
4648 * @param obj The window to query
4649 * @param x where to return the horizontal offset value. May be NULL.
4650 * @param y where to return the vertical offset value. May be NULL.
4651 * @param w where to return the width value. May be NULL.
4652 * @param h where to return the height value. May be NULL.
4654 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4657 * Set the enabled status for the focus highlight in a window
4659 * This function will enable or disable the focus highlight only for the
4660 * given window, regardless of the global setting for it
4662 * @param obj The window where to enable the highlight
4663 * @param enabled The enabled value for the highlight
4665 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4668 * Get the enabled value of the focus highlight for this window
4670 * @param obj The window in which to check if the focus highlight is enabled
4672 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4674 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4677 * Set the style for the focus highlight on this window
4679 * Sets the style to use for theming the highlight of focused objects on
4680 * the given window. If @p style is NULL, the default will be used.
4682 * @param obj The window where to set the style
4683 * @param style The style to set
4685 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4688 * Get the style set for the focus highlight object
4690 * Gets the style set for this windows highilght object, or NULL if none
4693 * @param obj The window to retrieve the highlights style from
4695 * @return The style set or NULL if none was. Default is used in that case.
4697 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4700 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4701 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4702 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4703 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4704 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4705 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4706 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4708 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4709 * (blank mouse, private mouse obj, defaultmouse)
4714 * Sets the keyboard mode of the window.
4716 * @param obj The window object
4717 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4719 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4722 * Gets the keyboard mode of the window.
4724 * @param obj The window object
4725 * @return The mode, one of #Elm_Win_Keyboard_Mode
4727 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4730 * Sets whether the window is a keyboard.
4732 * @param obj The window object
4733 * @param is_keyboard If true, the window is a virtual keyboard
4735 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4738 * Gets whether the window is a keyboard.
4740 * @param obj The window object
4741 * @return If the window is a virtual keyboard
4743 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4746 * Get the screen position of a window.
4748 * @param obj The window object
4749 * @param x The int to store the x coordinate to
4750 * @param y The int to store the y coordinate to
4752 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4759 * @defgroup Inwin Inwin
4761 * @image html img/widget/inwin/preview-00.png
4762 * @image latex img/widget/inwin/preview-00.eps
4763 * @image html img/widget/inwin/preview-01.png
4764 * @image latex img/widget/inwin/preview-01.eps
4765 * @image html img/widget/inwin/preview-02.png
4766 * @image latex img/widget/inwin/preview-02.eps
4768 * An inwin is a window inside a window that is useful for a quick popup.
4769 * It does not hover.
4771 * It works by creating an object that will occupy the entire window, so it
4772 * must be created using an @ref Win "elm_win" as parent only. The inwin
4773 * object can be hidden or restacked below every other object if it's
4774 * needed to show what's behind it without destroying it. If this is done,
4775 * the elm_win_inwin_activate() function can be used to bring it back to
4776 * full visibility again.
4778 * There are three styles available in the default theme. These are:
4779 * @li default: The inwin is sized to take over most of the window it's
4781 * @li minimal: The size of the inwin will be the minimum necessary to show
4783 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4784 * possible, but it's sized vertically the most it needs to fit its\
4787 * Some examples of Inwin can be found in the following:
4788 * @li @ref inwin_example_01
4794 * Adds an inwin to the current window
4796 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4797 * Never call this function with anything other than the top-most window
4798 * as its parameter, unless you are fond of undefined behavior.
4800 * After creating the object, the widget will set itself as resize object
4801 * for the window with elm_win_resize_object_add(), so when shown it will
4802 * appear to cover almost the entire window (how much of it depends on its
4803 * content and the style used). It must not be added into other container
4804 * objects and it needs not be moved or resized manually.
4806 * @param parent The parent object
4807 * @return The new object or NULL if it cannot be created
4809 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4812 * Activates an inwin object, ensuring its visibility
4814 * This function will make sure that the inwin @p obj is completely visible
4815 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4816 * to the front. It also sets the keyboard focus to it, which will be passed
4819 * The object's theme will also receive the signal "elm,action,show" with
4822 * @param obj The inwin to activate
4824 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4827 * Set the content of an inwin object.
4829 * Once the content object is set, a previously set one will be deleted.
4830 * If you want to keep that old content object, use the
4831 * elm_win_inwin_content_unset() function.
4833 * @param obj The inwin object
4834 * @param content The object to set as content
4836 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4839 * Get the content of an inwin object.
4841 * Return the content object which is set for this widget.
4843 * The returned object is valid as long as the inwin is still alive and no
4844 * other content is set on it. Deleting the object will notify the inwin
4845 * about it and this one will be left empty.
4847 * If you need to remove an inwin's content to be reused somewhere else,
4848 * see elm_win_inwin_content_unset().
4850 * @param obj The inwin object
4851 * @return The content that is being used
4853 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4856 * Unset the content of an inwin object.
4858 * Unparent and return the content object which was set for this widget.
4860 * @param obj The inwin object
4861 * @return The content that was being used
4863 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4868 /* X specific calls - won't work on non-x engines (return 0) */
4871 * Get the Ecore_X_Window of an Evas_Object
4873 * @param obj The object
4875 * @return The Ecore_X_Window of @p obj
4879 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4881 /* smart callbacks called:
4882 * "delete,request" - the user requested to delete the window
4883 * "focus,in" - window got focus
4884 * "focus,out" - window lost focus
4885 * "moved" - window that holds the canvas was moved
4891 * @image html img/widget/bg/preview-00.png
4892 * @image latex img/widget/bg/preview-00.eps
4894 * @brief Background object, used for setting a solid color, image or Edje
4895 * group as background to a window or any container object.
4897 * The bg object is used for setting a solid background to a window or
4898 * packing into any container object. It works just like an image, but has
4899 * some properties useful to a background, like setting it to tiled,
4900 * centered, scaled or stretched.
4902 * Default contents parts of the bg widget that you can use for are:
4903 * @li "overlay" - overlay of the bg
4905 * Here is some sample code using it:
4906 * @li @ref bg_01_example_page
4907 * @li @ref bg_02_example_page
4908 * @li @ref bg_03_example_page
4912 typedef enum _Elm_Bg_Option
4914 ELM_BG_OPTION_CENTER, /**< center the background */
4915 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4916 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4917 ELM_BG_OPTION_TILE /**< tile background at its original size */
4921 * Add a new background to the parent
4923 * @param parent The parent object
4924 * @return The new object or NULL if it cannot be created
4928 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4931 * Set the file (image or edje) used for the background
4933 * @param obj The bg object
4934 * @param file The file path
4935 * @param group Optional key (group in Edje) within the file
4937 * This sets the image file used in the background object. The image (or edje)
4938 * will be stretched (retaining aspect if its an image file) to completely fill
4939 * the bg object. This may mean some parts are not visible.
4941 * @note Once the image of @p obj is set, a previously set one will be deleted,
4942 * even if @p file is NULL.
4946 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4949 * Get the file (image or edje) used for the background
4951 * @param obj The bg object
4952 * @param file The file path
4953 * @param group Optional key (group in Edje) within the file
4957 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4960 * Set the option used for the background image
4962 * @param obj The bg object
4963 * @param option The desired background option (TILE, SCALE)
4965 * This sets the option used for manipulating the display of the background
4966 * image. The image can be tiled or scaled.
4970 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4973 * Get the option used for the background image
4975 * @param obj The bg object
4976 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4980 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4982 * Set the option used for the background color
4984 * @param obj The bg object
4989 * This sets the color used for the background rectangle. Its range goes
4994 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4996 * Get the option used for the background color
4998 * @param obj The bg object
5005 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
5008 * Set the overlay object used for the background object.
5010 * @param obj The bg object
5011 * @param overlay The overlay object
5013 * This provides a way for elm_bg to have an 'overlay' that will be on top
5014 * of the bg. Once the over object is set, a previously set one will be
5015 * deleted, even if you set the new one to NULL. If you want to keep that
5016 * old content object, use the elm_bg_overlay_unset() function.
5018 * @deprecated use elm_object_part_content_set() instead
5023 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
5026 * Get the overlay object used for the background object.
5028 * @param obj The bg object
5029 * @return The content that is being used
5031 * Return the content object which is set for this widget
5033 * @deprecated use elm_object_part_content_get() instead
5037 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5040 * Get the overlay object used for the background object.
5042 * @param obj The bg object
5043 * @return The content that was being used
5045 * Unparent and return the overlay object which was set for this widget
5047 * @deprecated use elm_object_part_content_unset() instead
5051 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5054 * Set the size of the pixmap representation of the image.
5056 * This option just makes sense if an image is going to be set in the bg.
5058 * @param obj The bg object
5059 * @param w The new width of the image pixmap representation.
5060 * @param h The new height of the image pixmap representation.
5062 * This function sets a new size for pixmap representation of the given bg
5063 * image. It allows the image to be loaded already in the specified size,
5064 * reducing the memory usage and load time when loading a big image with load
5065 * size set to a smaller size.
5067 * NOTE: this is just a hint, the real size of the pixmap may differ
5068 * depending on the type of image being loaded, being bigger than requested.
5072 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5079 * @defgroup Icon Icon
5081 * @image html img/widget/icon/preview-00.png
5082 * @image latex img/widget/icon/preview-00.eps
5084 * An object that provides standard icon images (delete, edit, arrows, etc.)
5085 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
5087 * The icon image requested can be in the elementary theme, or in the
5088 * freedesktop.org paths. It's possible to set the order of preference from
5089 * where the image will be used.
5091 * This API is very similar to @ref Image, but with ready to use images.
5093 * Default images provided by the theme are described below.
5095 * The first list contains icons that were first intended to be used in
5096 * toolbars, but can be used in many other places too:
5112 * Now some icons that were designed to be used in menus (but again, you can
5113 * use them anywhere else):
5118 * @li menu/arrow_down
5119 * @li menu/arrow_left
5120 * @li menu/arrow_right
5129 * And here we have some media player specific icons:
5130 * @li media_player/forward
5131 * @li media_player/info
5132 * @li media_player/next
5133 * @li media_player/pause
5134 * @li media_player/play
5135 * @li media_player/prev
5136 * @li media_player/rewind
5137 * @li media_player/stop
5139 * Signals that you can add callbacks for are:
5141 * "clicked" - This is called when a user has clicked the icon
5143 * An example of usage for this API follows:
5144 * @li @ref tutorial_icon
5152 typedef enum _Elm_Icon_Type
5160 * @enum _Elm_Icon_Lookup_Order
5161 * @typedef Elm_Icon_Lookup_Order
5163 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5164 * theme, FDO paths, or both?
5168 typedef enum _Elm_Icon_Lookup_Order
5170 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5171 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5172 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
5173 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
5174 } Elm_Icon_Lookup_Order;
5177 * Add a new icon object to the parent.
5179 * @param parent The parent object
5180 * @return The new object or NULL if it cannot be created
5182 * @see elm_icon_file_set()
5186 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5189 * Set the file that will be used as icon.
5191 * @param obj The icon object
5192 * @param file The path to file that will be used as icon image
5193 * @param group The group that the icon belongs to an edje file
5195 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5197 * @note The icon image set by this function can be changed by
5198 * elm_icon_standard_set().
5200 * @see elm_icon_file_get()
5204 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5207 * Set a location in memory to be used as an icon
5209 * @param obj The icon object
5210 * @param img The binary data that will be used as an image
5211 * @param size The size of binary data @p img
5212 * @param format Optional format of @p img to pass to the image loader
5213 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5215 * The @p format string should be something like "png", "jpg", "tga",
5216 * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5217 * the loader performance as it tries the "correct" loader first before
5218 * trying a range of other possible loaders until one succeeds.
5220 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5222 * @note The icon image set by this function can be changed by
5223 * elm_icon_standard_set().
5227 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);
5230 * Get the file that will be used as icon.
5232 * @param obj The icon object
5233 * @param file The path to file that will be used as the icon image
5234 * @param group The group that the icon belongs to, in edje file
5236 * @see elm_icon_file_set()
5240 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5243 * Set the file that will be used, but use a generated thumbnail.
5245 * @param obj The icon object
5246 * @param file The path to file that will be used as icon image
5247 * @param group The group that the icon belongs to an edje file
5249 * This functions like elm_icon_file_set() but requires the Ethumb library
5250 * support to be enabled successfully with elm_need_ethumb(). When set
5251 * the file indicated has a thumbnail generated and cached on disk for
5252 * future use or will directly use an existing cached thumbnail if it
5255 * @see elm_icon_file_set()
5259 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5262 * Set the icon by icon standards names.
5264 * @param obj The icon object
5265 * @param name The icon name
5267 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5269 * For example, freedesktop.org defines standard icon names such as "home",
5270 * "network", etc. There can be different icon sets to match those icon
5271 * keys. The @p name given as parameter is one of these "keys", and will be
5272 * used to look in the freedesktop.org paths and elementary theme. One can
5273 * change the lookup order with elm_icon_order_lookup_set().
5275 * If name is not found in any of the expected locations and it is the
5276 * absolute path of an image file, this image will be used.
5278 * @note The icon image set by this function can be changed by
5279 * elm_icon_file_set().
5281 * @see elm_icon_standard_get()
5282 * @see elm_icon_file_set()
5286 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5289 * Get the icon name set by icon standard names.
5291 * @param obj The icon object
5292 * @return The icon name
5294 * If the icon image was set using elm_icon_file_set() instead of
5295 * elm_icon_standard_set(), then this function will return @c NULL.
5297 * @see elm_icon_standard_set()
5301 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5304 * Set the smooth scaling for an icon object.
5306 * @param obj The icon object
5307 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5308 * otherwise. Default is @c EINA_TRUE.
5310 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5311 * scaling provides a better resulting image, but is slower.
5313 * The smooth scaling should be disabled when making animations that change
5314 * the icon size, since they will be faster. Animations that don't require
5315 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5316 * is already scaled, since the scaled icon image will be cached).
5318 * @see elm_icon_smooth_get()
5322 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5325 * Get whether smooth scaling is enabled for an icon object.
5327 * @param obj The icon object
5328 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5330 * @see elm_icon_smooth_set()
5334 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5337 * Disable scaling of this object.
5339 * @param obj The icon object.
5340 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5341 * otherwise. Default is @c EINA_FALSE.
5343 * This function disables scaling of the icon object through the function
5344 * elm_object_scale_set(). However, this does not affect the object
5345 * size/resize in any way. For that effect, take a look at
5346 * elm_icon_scale_set().
5348 * @see elm_icon_no_scale_get()
5349 * @see elm_icon_scale_set()
5350 * @see elm_object_scale_set()
5354 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5357 * Get whether scaling is disabled on the object.
5359 * @param obj The icon object
5360 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5362 * @see elm_icon_no_scale_set()
5366 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5369 * Set if the object is (up/down) resizable.
5371 * @param obj The icon object
5372 * @param scale_up A bool to set if the object is resizable up. Default is
5374 * @param scale_down A bool to set if the object is resizable down. Default
5377 * This function limits the icon object resize ability. If @p scale_up is set to
5378 * @c EINA_FALSE, the object can't have its height or width resized to a value
5379 * higher than the original icon size. Same is valid for @p scale_down.
5381 * @see elm_icon_scale_get()
5385 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5388 * Get if the object is (up/down) resizable.
5390 * @param obj The icon object
5391 * @param scale_up A bool to set if the object is resizable up
5392 * @param scale_down A bool to set if the object is resizable down
5394 * @see elm_icon_scale_set()
5398 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5401 * Get the object's image size
5403 * @param obj The icon object
5404 * @param w A pointer to store the width in
5405 * @param h A pointer to store the height in
5409 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5412 * Set if the icon fill the entire object area.
5414 * @param obj The icon object
5415 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5416 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5418 * When the icon object is resized to a different aspect ratio from the
5419 * original icon image, the icon image will still keep its aspect. This flag
5420 * tells how the image should fill the object's area. They are: keep the
5421 * entire icon inside the limits of height and width of the object (@p
5422 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5423 * of the object, and the icon will fill the entire object (@p fill_outside
5426 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5427 * retain property to false. Thus, the icon image will always keep its
5428 * original aspect ratio.
5430 * @see elm_icon_fill_outside_get()
5431 * @see elm_image_fill_outside_set()
5435 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5438 * Get if the object is filled outside.
5440 * @param obj The icon object
5441 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5443 * @see elm_icon_fill_outside_set()
5447 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5450 * Set the prescale size for the icon.
5452 * @param obj The icon object
5453 * @param size The prescale size. This value is used for both width and
5456 * This function sets a new size for pixmap representation of the given
5457 * icon. It allows the icon to be loaded already in the specified size,
5458 * reducing the memory usage and load time when loading a big icon with load
5459 * size set to a smaller size.
5461 * It's equivalent to the elm_bg_load_size_set() function for bg.
5463 * @note this is just a hint, the real size of the pixmap may differ
5464 * depending on the type of icon being loaded, being bigger than requested.
5466 * @see elm_icon_prescale_get()
5467 * @see elm_bg_load_size_set()
5471 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5474 * Get the prescale size for the icon.
5476 * @param obj The icon object
5477 * @return The prescale size
5479 * @see elm_icon_prescale_set()
5483 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5486 * Gets the image object of the icon. DO NOT MODIFY THIS.
5488 * @param obj The icon object
5489 * @return The internal icon object
5493 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5496 * Sets the icon lookup order used by elm_icon_standard_set().
5498 * @param obj The icon object
5499 * @param order The icon lookup order (can be one of
5500 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5501 * or ELM_ICON_LOOKUP_THEME)
5503 * @see elm_icon_order_lookup_get()
5504 * @see Elm_Icon_Lookup_Order
5508 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5511 * Gets the icon lookup order.
5513 * @param obj The icon object
5514 * @return The icon lookup order
5516 * @see elm_icon_order_lookup_set()
5517 * @see Elm_Icon_Lookup_Order
5521 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5524 * Enable or disable preloading of the icon
5526 * @param obj The icon object
5527 * @param disable If EINA_TRUE, preloading will be disabled
5530 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5533 * Get if the icon supports animation or not.
5535 * @param obj The icon object
5536 * @return @c EINA_TRUE if the icon supports animation,
5537 * @c EINA_FALSE otherwise.
5539 * Return if this elm icon's image can be animated. Currently Evas only
5540 * supports gif animation. If the return value is EINA_FALSE, other
5541 * elm_icon_animated_XXX APIs won't work.
5544 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5547 * Set animation mode of the icon.
5549 * @param obj The icon object
5550 * @param anim @c EINA_TRUE if the object do animation job,
5551 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5553 * Since the default animation mode is set to EINA_FALSE,
5554 * the icon is shown without animation. Files like animated GIF files
5555 * can animate, and this is supported if you enable animated support
5557 * Set it to EINA_TRUE when the icon needs to be animated.
5560 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5563 * Get animation mode of the icon.
5565 * @param obj The icon object
5566 * @return The animation mode of the icon object
5567 * @see elm_icon_animated_set
5570 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5573 * Set animation play mode of the icon.
5575 * @param obj The icon object
5576 * @param play @c EINA_TRUE the object play animation images,
5577 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5579 * To play elm icon's animation, set play to EINA_TURE.
5580 * For example, you make gif player using this set/get API and click event.
5581 * This literally lets you control current play or paused state. To have
5582 * this work with animated GIF files for example, you first, before
5583 * setting the file have to use elm_icon_animated_set() to enable animation
5584 * at all on the icon.
5586 * 1. Click event occurs
5587 * 2. Check play flag using elm_icon_animaged_play_get
5588 * 3. If elm icon was playing, set play to EINA_FALSE.
5589 * Then animation will be stopped and vice versa
5592 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5595 * Get animation play mode of the icon.
5597 * @param obj The icon object
5598 * @return The play mode of the icon object
5600 * @see elm_icon_animated_play_get
5603 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5610 * @defgroup Image Image
5612 * @image html img/widget/image/preview-00.png
5613 * @image latex img/widget/image/preview-00.eps
5616 * An object that allows one to load an image file to it. It can be used
5617 * anywhere like any other elementary widget.
5619 * This widget provides most of the functionality provided from @ref Bg or @ref
5620 * Icon, but with a slightly different API (use the one that fits better your
5623 * The features not provided by those two other image widgets are:
5624 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5625 * @li change the object orientation with elm_image_orient_set();
5626 * @li and turning the image editable with elm_image_editable_set().
5628 * Signals that you can add callbacks for are:
5630 * @li @c "clicked" - This is called when a user has clicked the image
5632 * An example of usage for this API follows:
5633 * @li @ref tutorial_image
5642 * @enum _Elm_Image_Orient
5643 * @typedef Elm_Image_Orient
5645 * Possible orientation options for elm_image_orient_set().
5647 * @image html elm_image_orient_set.png
5648 * @image latex elm_image_orient_set.eps width=\textwidth
5652 typedef enum _Elm_Image_Orient
5654 ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5655 ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5656 ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5657 ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5658 ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5659 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5660 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5661 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5662 ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5663 ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5664 ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5665 ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5669 * Add a new image to the parent.
5671 * @param parent The parent object
5672 * @return The new object or NULL if it cannot be created
5674 * @see elm_image_file_set()
5678 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5681 * Set the file that will be used as image.
5683 * @param obj The image object
5684 * @param file The path to file that will be used as image
5685 * @param group The group that the image belongs in edje file (if it's an
5688 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5690 * @see elm_image_file_get()
5694 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5697 * Get the file that will be used as image.
5699 * @param obj The image object
5700 * @param file The path to file
5701 * @param group The group that the image belongs in edje file
5703 * @see elm_image_file_set()
5707 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5710 * Set the smooth effect for an image.
5712 * @param obj The image object
5713 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5714 * otherwise. Default is @c EINA_TRUE.
5716 * Set the scaling algorithm to be used when scaling the image. Smooth
5717 * scaling provides a better resulting image, but is slower.
5719 * The smooth scaling should be disabled when making animations that change
5720 * the image size, since it will be faster. Animations that don't require
5721 * resizing of the image can keep the smooth scaling enabled (even if the
5722 * image is already scaled, since the scaled image will be cached).
5724 * @see elm_image_smooth_get()
5728 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5731 * Get the smooth effect for an image.
5733 * @param obj The image object
5734 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5736 * @see elm_image_smooth_get()
5740 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5743 * Gets the current size of the image.
5745 * @param obj The image object.
5746 * @param w Pointer to store width, or NULL.
5747 * @param h Pointer to store height, or NULL.
5749 * This is the real size of the image, not the size of the object.
5751 * On error, neither w and h will be fileld with 0.
5755 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5758 * Disable scaling of this object.
5760 * @param obj The image object.
5761 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5762 * otherwise. Default is @c EINA_FALSE.
5764 * This function disables scaling of the elm_image widget through the
5765 * function elm_object_scale_set(). However, this does not affect the widget
5766 * size/resize in any way. For that effect, take a look at
5767 * elm_image_scale_set().
5769 * @see elm_image_no_scale_get()
5770 * @see elm_image_scale_set()
5771 * @see elm_object_scale_set()
5775 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5778 * Get whether scaling is disabled on the object.
5780 * @param obj The image object
5781 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5783 * @see elm_image_no_scale_set()
5787 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5790 * Set if the object is (up/down) resizable.
5792 * @param obj The image object
5793 * @param scale_up A bool to set if the object is resizable up. Default is
5795 * @param scale_down A bool to set if the object is resizable down. Default
5798 * This function limits the image resize ability. If @p scale_up is set to
5799 * @c EINA_FALSE, the object can't have its height or width resized to a value
5800 * higher than the original image size. Same is valid for @p scale_down.
5802 * @see elm_image_scale_get()
5806 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5809 * Get if the object is (up/down) resizable.
5811 * @param obj The image object
5812 * @param scale_up A bool to set if the object is resizable up
5813 * @param scale_down A bool to set if the object is resizable down
5815 * @see elm_image_scale_set()
5819 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5822 * Set if the image fills the entire object area, when keeping the aspect ratio.
5824 * @param obj The image object
5825 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5826 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5828 * When the image should keep its aspect ratio even if resized to another
5829 * aspect ratio, there are two possibilities to resize it: keep the entire
5830 * image inside the limits of height and width of the object (@p fill_outside
5831 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5832 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5834 * @note This option will have no effect if
5835 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5837 * @see elm_image_fill_outside_get()
5838 * @see elm_image_aspect_ratio_retained_set()
5842 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5845 * Get if the object is filled outside
5847 * @param obj The image object
5848 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5850 * @see elm_image_fill_outside_set()
5854 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5857 * Set the prescale size for the image
5859 * @param obj The image object
5860 * @param size The prescale size. This value is used for both width and
5863 * This function sets a new size for pixmap representation of the given
5864 * image. It allows the image to be loaded already in the specified size,
5865 * reducing the memory usage and load time when loading a big image with load
5866 * size set to a smaller size.
5868 * It's equivalent to the elm_bg_load_size_set() function for bg.
5870 * @note this is just a hint, the real size of the pixmap may differ
5871 * depending on the type of image being loaded, being bigger than requested.
5873 * @see elm_image_prescale_get()
5874 * @see elm_bg_load_size_set()
5878 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5881 * Get the prescale size for the image
5883 * @param obj The image object
5884 * @return The prescale size
5886 * @see elm_image_prescale_set()
5890 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5893 * Set the image orientation.
5895 * @param obj The image object
5896 * @param orient The image orientation @ref Elm_Image_Orient
5897 * Default is #ELM_IMAGE_ORIENT_NONE.
5899 * This function allows to rotate or flip the given image.
5901 * @see elm_image_orient_get()
5902 * @see @ref Elm_Image_Orient
5906 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5909 * Get the image orientation.
5911 * @param obj The image object
5912 * @return The image orientation @ref Elm_Image_Orient
5914 * @see elm_image_orient_set()
5915 * @see @ref Elm_Image_Orient
5919 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5922 * Make the image 'editable'.
5924 * @param obj Image object.
5925 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5927 * This means the image is a valid drag target for drag and drop, and can be
5928 * cut or pasted too.
5932 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5935 * Check if the image 'editable'.
5937 * @param obj Image object.
5938 * @return Editability.
5940 * A return value of EINA_TRUE means the image is a valid drag target
5941 * for drag and drop, and can be cut or pasted too.
5945 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5948 * Get the basic Evas_Image object from this object (widget).
5950 * @param obj The image object to get the inlined image from
5951 * @return The inlined image object, or NULL if none exists
5953 * This function allows one to get the underlying @c Evas_Object of type
5954 * Image from this elementary widget. It can be useful to do things like get
5955 * the pixel data, save the image to a file, etc.
5957 * @note Be careful to not manipulate it, as it is under control of
5962 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5965 * Set whether the original aspect ratio of the image should be kept on resize.
5967 * @param obj The image object.
5968 * @param retained @c EINA_TRUE if the image should retain the aspect,
5969 * @c EINA_FALSE otherwise.
5971 * The original aspect ratio (width / height) of the image is usually
5972 * distorted to match the object's size. Enabling this option will retain
5973 * this original aspect, and the way that the image is fit into the object's
5974 * area depends on the option set by elm_image_fill_outside_set().
5976 * @see elm_image_aspect_ratio_retained_get()
5977 * @see elm_image_fill_outside_set()
5981 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5984 * Get if the object retains the original aspect ratio.
5986 * @param obj The image object.
5987 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5992 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5999 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
6001 typedef enum _Elm_GLView_Mode
6003 ELM_GLVIEW_ALPHA = 1,
6004 ELM_GLVIEW_DEPTH = 2,
6005 ELM_GLVIEW_STENCIL = 4
6009 * Defines a policy for the glview resizing.
6011 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
6013 typedef enum _Elm_GLView_Resize_Policy
6015 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
6016 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
6017 } Elm_GLView_Resize_Policy;
6019 typedef enum _Elm_GLView_Render_Policy
6021 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
6022 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
6023 } Elm_GLView_Render_Policy;
6028 * A simple GLView widget that allows GL rendering.
6030 * Signals that you can add callbacks for are:
6036 * Add a new glview to the parent
6038 * @param parent The parent object
6039 * @return The new object or NULL if it cannot be created
6043 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6046 * Sets the size of the glview
6048 * @param obj The glview object
6049 * @param width width of the glview object
6050 * @param height height of the glview object
6054 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6057 * Gets the size of the glview.
6059 * @param obj The glview object
6060 * @param width width of the glview object
6061 * @param height height of the glview object
6063 * Note that this function returns the actual image size of the
6064 * glview. This means that when the scale policy is set to
6065 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
6070 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6073 * Gets the gl api struct for gl rendering
6075 * @param obj The glview object
6076 * @return The api object or NULL if it cannot be created
6080 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6083 * Set the mode of the GLView. Supports Three simple modes.
6085 * @param obj The glview object
6086 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
6087 * @return True if set properly.
6091 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
6094 * Set the resize policy for the glview object.
6096 * @param obj The glview object.
6097 * @param policy The scaling policy.
6099 * By default, the resize policy is set to
6100 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
6101 * destroys the previous surface and recreates the newly specified
6102 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
6103 * however, glview only scales the image object and not the underlying
6108 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
6111 * Set the render policy for the glview object.
6113 * @param obj The glview object.
6114 * @param policy The render policy.
6116 * By default, the render policy is set to
6117 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
6118 * that during the render loop, glview is only redrawn if it needs
6119 * to be redrawn. (i.e. When it is visible) If the policy is set to
6120 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
6121 * whether it is visible/need redrawing or not.
6125 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
6128 * Set the init function that runs once in the main loop.
6130 * @param obj The glview object.
6131 * @param func The init function to be registered.
6133 * The registered init function gets called once during the render loop.
6137 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6140 * Set the render function that runs in the main loop.
6142 * @param obj The glview object.
6143 * @param func The delete function to be registered.
6145 * The registered del function gets called when GLView object is deleted.
6149 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6152 * Set the resize function that gets called when resize happens.
6154 * @param obj The glview object.
6155 * @param func The resize function to be registered.
6159 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6162 * Set the render function that runs in the main loop.
6164 * @param obj The glview object.
6165 * @param func The render function to be registered.
6169 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6172 * Notifies that there has been changes in the GLView.
6174 * @param obj The glview object.
6178 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6188 * @image html img/widget/box/preview-00.png
6189 * @image latex img/widget/box/preview-00.eps width=\textwidth
6191 * @image html img/box.png
6192 * @image latex img/box.eps width=\textwidth
6194 * A box arranges objects in a linear fashion, governed by a layout function
6195 * that defines the details of this arrangement.
6197 * By default, the box will use an internal function to set the layout to
6198 * a single row, either vertical or horizontal. This layout is affected
6199 * by a number of parameters, such as the homogeneous flag set by
6200 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6201 * elm_box_align_set() and the hints set to each object in the box.
6203 * For this default layout, it's possible to change the orientation with
6204 * elm_box_horizontal_set(). The box will start in the vertical orientation,
6205 * placing its elements ordered from top to bottom. When horizontal is set,
6206 * the order will go from left to right. If the box is set to be
6207 * homogeneous, every object in it will be assigned the same space, that
6208 * of the largest object. Padding can be used to set some spacing between
6209 * the cell given to each object. The alignment of the box, set with
6210 * elm_box_align_set(), determines how the bounding box of all the elements
6211 * will be placed within the space given to the box widget itself.
6213 * The size hints of each object also affect how they are placed and sized
6214 * within the box. evas_object_size_hint_min_set() will give the minimum
6215 * size the object can have, and the box will use it as the basis for all
6216 * latter calculations. Elementary widgets set their own minimum size as
6217 * needed, so there's rarely any need to use it manually.
6219 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6220 * used to tell whether the object will be allocated the minimum size it
6221 * needs or if the space given to it should be expanded. It's important
6222 * to realize that expanding the size given to the object is not the same
6223 * thing as resizing the object. It could very well end being a small
6224 * widget floating in a much larger empty space. If not set, the weight
6225 * for objects will normally be 0.0 for both axis, meaning the widget will
6226 * not be expanded. To take as much space possible, set the weight to
6227 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6229 * Besides how much space each object is allocated, it's possible to control
6230 * how the widget will be placed within that space using
6231 * evas_object_size_hint_align_set(). By default, this value will be 0.5
6232 * for both axis, meaning the object will be centered, but any value from
6233 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6234 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6235 * is -1.0, means the object will be resized to fill the entire space it
6238 * In addition, customized functions to define the layout can be set, which
6239 * allow the application developer to organize the objects within the box
6240 * in any number of ways.
6242 * The special elm_box_layout_transition() function can be used
6243 * to switch from one layout to another, animating the motion of the
6244 * children of the box.
6246 * @note Objects should not be added to box objects using _add() calls.
6248 * Some examples on how to use boxes follow:
6249 * @li @ref box_example_01
6250 * @li @ref box_example_02
6255 * @typedef Elm_Box_Transition
6257 * Opaque handler containing the parameters to perform an animated
6258 * transition of the layout the box uses.
6260 * @see elm_box_transition_new()
6261 * @see elm_box_layout_set()
6262 * @see elm_box_layout_transition()
6264 typedef struct _Elm_Box_Transition Elm_Box_Transition;
6267 * Add a new box to the parent
6269 * By default, the box will be in vertical mode and non-homogeneous.
6271 * @param parent The parent object
6272 * @return The new object or NULL if it cannot be created
6274 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6277 * Set the horizontal orientation
6279 * By default, box object arranges their contents vertically from top to
6281 * By calling this function with @p horizontal as EINA_TRUE, the box will
6282 * become horizontal, arranging contents from left to right.
6284 * @note This flag is ignored if a custom layout function is set.
6286 * @param obj The box object
6287 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6288 * EINA_FALSE = vertical)
6290 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6293 * Get the horizontal orientation
6295 * @param obj The box object
6296 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6298 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6301 * Set the box to arrange its children homogeneously
6303 * If enabled, homogeneous layout makes all items the same size, according
6304 * to the size of the largest of its children.
6306 * @note This flag is ignored if a custom layout function is set.
6308 * @param obj The box object
6309 * @param homogeneous The homogeneous flag
6311 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6314 * Get whether the box is using homogeneous mode or not
6316 * @param obj The box object
6317 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6319 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6322 * Add an object to the beginning of the pack list
6324 * Pack @p subobj into the box @p obj, placing it first in the list of
6325 * children objects. The actual position the object will get on screen
6326 * depends on the layout used. If no custom layout is set, it will be at
6327 * the top or left, depending if the box is vertical or horizontal,
6330 * @param obj The box object
6331 * @param subobj The object to add to the box
6333 * @see elm_box_pack_end()
6334 * @see elm_box_pack_before()
6335 * @see elm_box_pack_after()
6336 * @see elm_box_unpack()
6337 * @see elm_box_unpack_all()
6338 * @see elm_box_clear()
6340 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6343 * Add an object at the end of the pack list
6345 * Pack @p subobj into the box @p obj, placing it last in the list of
6346 * children objects. The actual position the object will get on screen
6347 * depends on the layout used. If no custom layout is set, it will be at
6348 * the bottom or right, depending if the box is vertical or horizontal,
6351 * @param obj The box object
6352 * @param subobj The object to add to the box
6354 * @see elm_box_pack_start()
6355 * @see elm_box_pack_before()
6356 * @see elm_box_pack_after()
6357 * @see elm_box_unpack()
6358 * @see elm_box_unpack_all()
6359 * @see elm_box_clear()
6361 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6364 * Adds an object to the box before the indicated object
6366 * This will add the @p subobj to the box indicated before the object
6367 * indicated with @p before. If @p before is not already in the box, results
6368 * are undefined. Before means either to the left of the indicated object or
6369 * above it depending on orientation.
6371 * @param obj The box object
6372 * @param subobj The object to add to the box
6373 * @param before The object before which to add it
6375 * @see elm_box_pack_start()
6376 * @see elm_box_pack_end()
6377 * @see elm_box_pack_after()
6378 * @see elm_box_unpack()
6379 * @see elm_box_unpack_all()
6380 * @see elm_box_clear()
6382 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6385 * Adds an object to the box after the indicated object
6387 * This will add the @p subobj to the box indicated after the object
6388 * indicated with @p after. If @p after is not already in the box, results
6389 * are undefined. After means either to the right of the indicated object or
6390 * below it depending on orientation.
6392 * @param obj The box object
6393 * @param subobj The object to add to the box
6394 * @param after The object after which to add it
6396 * @see elm_box_pack_start()
6397 * @see elm_box_pack_end()
6398 * @see elm_box_pack_before()
6399 * @see elm_box_unpack()
6400 * @see elm_box_unpack_all()
6401 * @see elm_box_clear()
6403 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6406 * Clear the box of all children
6408 * Remove all the elements contained by the box, deleting the respective
6411 * @param obj The box object
6413 * @see elm_box_unpack()
6414 * @see elm_box_unpack_all()
6416 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6421 * Remove the object given by @p subobj from the box @p obj without
6424 * @param obj The box object
6426 * @see elm_box_unpack_all()
6427 * @see elm_box_clear()
6429 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6432 * Remove all items from the box, without deleting them
6434 * Clear the box from all children, but don't delete the respective objects.
6435 * If no other references of the box children exist, the objects will never
6436 * be deleted, and thus the application will leak the memory. Make sure
6437 * when using this function that you hold a reference to all the objects
6438 * in the box @p obj.
6440 * @param obj The box object
6442 * @see elm_box_clear()
6443 * @see elm_box_unpack()
6445 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6448 * Retrieve a list of the objects packed into the box
6450 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6451 * The order of the list corresponds to the packing order the box uses.
6453 * You must free this list with eina_list_free() once you are done with it.
6455 * @param obj The box object
6457 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6460 * Set the space (padding) between the box's elements.
6462 * Extra space in pixels that will be added between a box child and its
6463 * neighbors after its containing cell has been calculated. This padding
6464 * is set for all elements in the box, besides any possible padding that
6465 * individual elements may have through their size hints.
6467 * @param obj The box object
6468 * @param horizontal The horizontal space between elements
6469 * @param vertical The vertical space between elements
6471 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6474 * Get the space (padding) between the box's elements.
6476 * @param obj The box object
6477 * @param horizontal The horizontal space between elements
6478 * @param vertical The vertical space between elements
6480 * @see elm_box_padding_set()
6482 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6485 * Set the alignment of the whole bouding box of contents.
6487 * Sets how the bounding box containing all the elements of the box, after
6488 * their sizes and position has been calculated, will be aligned within
6489 * the space given for the whole box widget.
6491 * @param obj The box object
6492 * @param horizontal The horizontal alignment of elements
6493 * @param vertical The vertical alignment of elements
6495 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6498 * Get the alignment of the whole bouding box of contents.
6500 * @param obj The box object
6501 * @param horizontal The horizontal alignment of elements
6502 * @param vertical The vertical alignment of elements
6504 * @see elm_box_align_set()
6506 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6509 * Force the box to recalculate its children packing.
6511 * If any children was added or removed, box will not calculate the
6512 * values immediately rather leaving it to the next main loop
6513 * iteration. While this is great as it would save lots of
6514 * recalculation, whenever you need to get the position of a just
6515 * added item you must force recalculate before doing so.
6517 * @param obj The box object.
6519 EAPI void elm_box_recalculate(Evas_Object *obj);
6522 * Set the layout defining function to be used by the box
6524 * Whenever anything changes that requires the box in @p obj to recalculate
6525 * the size and position of its elements, the function @p cb will be called
6526 * to determine what the layout of the children will be.
6528 * Once a custom function is set, everything about the children layout
6529 * is defined by it. The flags set by elm_box_horizontal_set() and
6530 * elm_box_homogeneous_set() no longer have any meaning, and the values
6531 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6532 * layout function to decide if they are used and how. These last two
6533 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6534 * passed to @p cb. The @c Evas_Object the function receives is not the
6535 * Elementary widget, but the internal Evas Box it uses, so none of the
6536 * functions described here can be used on it.
6538 * Any of the layout functions in @c Evas can be used here, as well as the
6539 * special elm_box_layout_transition().
6541 * The final @p data argument received by @p cb is the same @p data passed
6542 * here, and the @p free_data function will be called to free it
6543 * whenever the box is destroyed or another layout function is set.
6545 * Setting @p cb to NULL will revert back to the default layout function.
6547 * @param obj The box object
6548 * @param cb The callback function used for layout
6549 * @param data Data that will be passed to layout function
6550 * @param free_data Function called to free @p data
6552 * @see elm_box_layout_transition()
6554 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);
6557 * Special layout function that animates the transition from one layout to another
6559 * Normally, when switching the layout function for a box, this will be
6560 * reflected immediately on screen on the next render, but it's also
6561 * possible to do this through an animated transition.
6563 * This is done by creating an ::Elm_Box_Transition and setting the box
6564 * layout to this function.
6568 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6569 * evas_object_box_layout_vertical, // start
6570 * NULL, // data for initial layout
6571 * NULL, // free function for initial data
6572 * evas_object_box_layout_horizontal, // end
6573 * NULL, // data for final layout
6574 * NULL, // free function for final data
6575 * anim_end, // will be called when animation ends
6576 * NULL); // data for anim_end function\
6577 * elm_box_layout_set(box, elm_box_layout_transition, t,
6578 * elm_box_transition_free);
6581 * @note This function can only be used with elm_box_layout_set(). Calling
6582 * it directly will not have the expected results.
6584 * @see elm_box_transition_new
6585 * @see elm_box_transition_free
6586 * @see elm_box_layout_set
6588 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6591 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6593 * If you want to animate the change from one layout to another, you need
6594 * to set the layout function of the box to elm_box_layout_transition(),
6595 * passing as user data to it an instance of ::Elm_Box_Transition with the
6596 * necessary information to perform this animation. The free function to
6597 * set for the layout is elm_box_transition_free().
6599 * The parameters to create an ::Elm_Box_Transition sum up to how long
6600 * will it be, in seconds, a layout function to describe the initial point,
6601 * another for the final position of the children and one function to be
6602 * called when the whole animation ends. This last function is useful to
6603 * set the definitive layout for the box, usually the same as the end
6604 * layout for the animation, but could be used to start another transition.
6606 * @param start_layout The layout function that will be used to start the animation
6607 * @param start_layout_data The data to be passed the @p start_layout function
6608 * @param start_layout_free_data Function to free @p start_layout_data
6609 * @param end_layout The layout function that will be used to end the animation
6610 * @param end_layout_free_data The data to be passed the @p end_layout function
6611 * @param end_layout_free_data Function to free @p end_layout_data
6612 * @param transition_end_cb Callback function called when animation ends
6613 * @param transition_end_data Data to be passed to @p transition_end_cb
6614 * @return An instance of ::Elm_Box_Transition
6616 * @see elm_box_transition_new
6617 * @see elm_box_layout_transition
6619 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);
6622 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6624 * This function is mostly useful as the @c free_data parameter in
6625 * elm_box_layout_set() when elm_box_layout_transition().
6627 * @param data The Elm_Box_Transition instance to be freed.
6629 * @see elm_box_transition_new
6630 * @see elm_box_layout_transition
6632 EAPI void elm_box_transition_free(void *data);
6640 * @defgroup Button Button
6642 * @image html img/widget/button/preview-00.png
6643 * @image latex img/widget/button/preview-00.eps
6644 * @image html img/widget/button/preview-01.png
6645 * @image latex img/widget/button/preview-01.eps
6646 * @image html img/widget/button/preview-02.png
6647 * @image latex img/widget/button/preview-02.eps
6649 * This is a push-button. Press it and run some function. It can contain
6650 * a simple label and icon object and it also has an autorepeat feature.
6652 * This widgets emits the following signals:
6653 * @li "clicked": the user clicked the button (press/release).
6654 * @li "repeated": the user pressed the button without releasing it.
6655 * @li "pressed": button was pressed.
6656 * @li "unpressed": button was released after being pressed.
6657 * In all three cases, the @c event parameter of the callback will be
6660 * Also, defined in the default theme, the button has the following styles
6662 * @li default: a normal button.
6663 * @li anchor: Like default, but the button fades away when the mouse is not
6664 * over it, leaving only the text or icon.
6665 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6666 * continuous look across its options.
6667 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6669 * Default contents parts of the button widget that you can use for are:
6670 * @li "icon" - An icon of the button
6672 * Default text parts of the button widget that you can use for are:
6673 * @li "default" - Label of the button
6675 * Follow through a complete example @ref button_example_01 "here".
6680 * Add a new button to the parent's canvas
6682 * @param parent The parent object
6683 * @return The new object or NULL if it cannot be created
6685 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6688 * Set the label used in the button
6690 * The passed @p label can be NULL to clean any existing text in it and
6691 * leave the button as an icon only object.
6693 * @param obj The button object
6694 * @param label The text will be written on the button
6695 * @deprecated use elm_object_text_set() instead.
6697 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6700 * Get the label set for the button
6702 * The string returned is an internal pointer and should not be freed or
6703 * altered. It will also become invalid when the button is destroyed.
6704 * The string returned, if not NULL, is a stringshare, so if you need to
6705 * keep it around even after the button is destroyed, you can use
6706 * eina_stringshare_ref().
6708 * @param obj The button object
6709 * @return The text set to the label, or NULL if nothing is set
6710 * @deprecated use elm_object_text_set() instead.
6712 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6715 * Set the icon used for the button
6717 * Setting a new icon will delete any other that was previously set, making
6718 * any reference to them invalid. If you need to maintain the previous
6719 * object alive, unset it first with elm_button_icon_unset().
6721 * @param obj The button object
6722 * @param icon The icon object for the button
6723 * @deprecated use elm_object_part_content_set() instead.
6725 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6728 * Get the icon used for the button
6730 * Return the icon object which is set for this widget. If the button is
6731 * destroyed or another icon is set, the returned object will be deleted
6732 * and any reference to it will be invalid.
6734 * @param obj The button object
6735 * @return The icon object that is being used
6737 * @deprecated use elm_object_part_content_get() instead
6739 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6742 * Remove the icon set without deleting it and return the object
6744 * This function drops the reference the button holds of the icon object
6745 * and returns this last object. It is used in case you want to remove any
6746 * icon, or set another one, without deleting the actual object. The button
6747 * will be left without an icon set.
6749 * @param obj The button object
6750 * @return The icon object that was being used
6751 * @deprecated use elm_object_part_content_unset() instead.
6753 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6756 * Turn on/off the autorepeat event generated when the button is kept pressed
6758 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6759 * signal when they are clicked.
6761 * When on, keeping a button pressed will continuously emit a @c repeated
6762 * signal until the button is released. The time it takes until it starts
6763 * emitting the signal is given by
6764 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6765 * new emission by elm_button_autorepeat_gap_timeout_set().
6767 * @param obj The button object
6768 * @param on A bool to turn on/off the event
6770 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6773 * Get whether the autorepeat feature is enabled
6775 * @param obj The button object
6776 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6778 * @see elm_button_autorepeat_set()
6780 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6783 * Set the initial timeout before the autorepeat event is generated
6785 * Sets the timeout, in seconds, since the button is pressed until the
6786 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6787 * won't be any delay and the even will be fired the moment the button is
6790 * @param obj The button object
6791 * @param t Timeout in seconds
6793 * @see elm_button_autorepeat_set()
6794 * @see elm_button_autorepeat_gap_timeout_set()
6796 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6799 * Get the initial timeout before the autorepeat event is generated
6801 * @param obj The button object
6802 * @return Timeout in seconds
6804 * @see elm_button_autorepeat_initial_timeout_set()
6806 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6809 * Set the interval between each generated autorepeat event
6811 * After the first @c repeated event is fired, all subsequent ones will
6812 * follow after a delay of @p t seconds for each.
6814 * @param obj The button object
6815 * @param t Interval in seconds
6817 * @see elm_button_autorepeat_initial_timeout_set()
6819 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6822 * Get the interval between each generated autorepeat event
6824 * @param obj The button object
6825 * @return Interval in seconds
6827 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6834 * @defgroup File_Selector_Button File Selector Button
6836 * @image html img/widget/fileselector_button/preview-00.png
6837 * @image latex img/widget/fileselector_button/preview-00.eps
6838 * @image html img/widget/fileselector_button/preview-01.png
6839 * @image latex img/widget/fileselector_button/preview-01.eps
6840 * @image html img/widget/fileselector_button/preview-02.png
6841 * @image latex img/widget/fileselector_button/preview-02.eps
6843 * This is a button that, when clicked, creates an Elementary
6844 * window (or inner window) <b> with a @ref Fileselector "file
6845 * selector widget" within</b>. When a file is chosen, the (inner)
6846 * window is closed and the button emits a signal having the
6847 * selected file as it's @c event_info.
6849 * This widget encapsulates operations on its internal file
6850 * selector on its own API. There is less control over its file
6851 * selector than that one would have instatiating one directly.
6853 * The following styles are available for this button:
6856 * @li @c "hoversel_vertical"
6857 * @li @c "hoversel_vertical_entry"
6859 * Smart callbacks one can register to:
6860 * - @c "file,chosen" - the user has selected a path, whose string
6861 * pointer comes as the @c event_info data (a stringshared
6864 * Here is an example on its usage:
6865 * @li @ref fileselector_button_example
6867 * @see @ref File_Selector_Entry for a similar widget.
6872 * Add a new file selector button widget to the given parent
6873 * Elementary (container) object
6875 * @param parent The parent object
6876 * @return a new file selector button widget handle or @c NULL, on
6879 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6882 * Set the label for a given file selector button widget
6884 * @param obj The file selector button widget
6885 * @param label The text label to be displayed on @p obj
6887 * @deprecated use elm_object_text_set() instead.
6889 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6892 * Get the label set for a given file selector button widget
6894 * @param obj The file selector button widget
6895 * @return The button label
6897 * @deprecated use elm_object_text_set() instead.
6899 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6902 * Set the icon on a given file selector button widget
6904 * @param obj The file selector button widget
6905 * @param icon The icon object for the button
6907 * Once the icon object is set, a previously set one will be
6908 * deleted. If you want to keep the latter, use the
6909 * elm_fileselector_button_icon_unset() function.
6911 * @see elm_fileselector_button_icon_get()
6913 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6916 * Get the icon set for a given file selector button widget
6918 * @param obj The file selector button widget
6919 * @return The icon object currently set on @p obj or @c NULL, if
6922 * @see elm_fileselector_button_icon_set()
6924 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6927 * Unset the icon used in a given file selector button widget
6929 * @param obj The file selector button widget
6930 * @return The icon object that was being used on @p obj or @c
6933 * Unparent and return the icon object which was set for this
6936 * @see elm_fileselector_button_icon_set()
6938 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6941 * Set the title for a given file selector button widget's window
6943 * @param obj The file selector button widget
6944 * @param title The title string
6946 * This will change the window's title, when the file selector pops
6947 * out after a click on the button. Those windows have the default
6948 * (unlocalized) value of @c "Select a file" as titles.
6950 * @note It will only take any effect if the file selector
6951 * button widget is @b not under "inwin mode".
6953 * @see elm_fileselector_button_window_title_get()
6955 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6958 * Get the title set for a given file selector button widget's
6961 * @param obj The file selector button widget
6962 * @return Title of the file selector button's window
6964 * @see elm_fileselector_button_window_title_get() for more details
6966 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6969 * Set the size of a given file selector button widget's window,
6970 * holding the file selector itself.
6972 * @param obj The file selector button widget
6973 * @param width The window's width
6974 * @param height The window's height
6976 * @note it will only take any effect if the file selector button
6977 * widget is @b not under "inwin mode". The default size for the
6978 * window (when applicable) is 400x400 pixels.
6980 * @see elm_fileselector_button_window_size_get()
6982 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6985 * Get the size of a given file selector button widget's window,
6986 * holding the file selector itself.
6988 * @param obj The file selector button widget
6989 * @param width Pointer into which to store the width value
6990 * @param height Pointer into which to store the height value
6992 * @note Use @c NULL pointers on the size values you're not
6993 * interested in: they'll be ignored by the function.
6995 * @see elm_fileselector_button_window_size_set(), for more details
6997 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7000 * Set the initial file system path for a given file selector
7003 * @param obj The file selector button widget
7004 * @param path The path string
7006 * It must be a <b>directory</b> path, which will have the contents
7007 * displayed initially in the file selector's view, when invoked
7008 * from @p obj. The default initial path is the @c "HOME"
7009 * environment variable's value.
7011 * @see elm_fileselector_button_path_get()
7013 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7016 * Get the initial file system path set for a given file selector
7019 * @param obj The file selector button widget
7020 * @return path The path string
7022 * @see elm_fileselector_button_path_set() for more details
7024 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7027 * Enable/disable a tree view in the given file selector button
7028 * widget's internal file selector
7030 * @param obj The file selector button widget
7031 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7034 * This has the same effect as elm_fileselector_expandable_set(),
7035 * but now applied to a file selector button's internal file
7038 * @note There's no way to put a file selector button's internal
7039 * file selector in "grid mode", as one may do with "pure" file
7042 * @see elm_fileselector_expandable_get()
7044 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7047 * Get whether tree view is enabled for the given file selector
7048 * button widget's internal file selector
7050 * @param obj The file selector button widget
7051 * @return @c EINA_TRUE if @p obj widget's internal file selector
7052 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7054 * @see elm_fileselector_expandable_set() for more details
7056 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7059 * Set whether a given file selector button widget's internal file
7060 * selector is to display folders only or the directory contents,
7063 * @param obj The file selector button widget
7064 * @param only @c EINA_TRUE to make @p obj widget's internal file
7065 * selector only display directories, @c EINA_FALSE to make files
7066 * to be displayed in it too
7068 * This has the same effect as elm_fileselector_folder_only_set(),
7069 * but now applied to a file selector button's internal file
7072 * @see elm_fileselector_folder_only_get()
7074 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7077 * Get whether a given file selector button widget's internal file
7078 * selector is displaying folders only or the directory contents,
7081 * @param obj The file selector button widget
7082 * @return @c EINA_TRUE if @p obj widget's internal file
7083 * selector is only displaying directories, @c EINA_FALSE if files
7084 * are being displayed in it too (and on errors)
7086 * @see elm_fileselector_button_folder_only_set() for more details
7088 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7091 * Enable/disable the file name entry box where the user can type
7092 * in a name for a file, in a given file selector button widget's
7093 * internal file selector.
7095 * @param obj The file selector button widget
7096 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7097 * file selector a "saving dialog", @c EINA_FALSE otherwise
7099 * This has the same effect as elm_fileselector_is_save_set(),
7100 * but now applied to a file selector button's internal file
7103 * @see elm_fileselector_is_save_get()
7105 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7108 * Get whether the given file selector button widget's internal
7109 * file selector is in "saving dialog" mode
7111 * @param obj The file selector button widget
7112 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7113 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7116 * @see elm_fileselector_button_is_save_set() for more details
7118 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7121 * Set whether a given file selector button widget's internal file
7122 * selector will raise an Elementary "inner window", instead of a
7123 * dedicated Elementary window. By default, it won't.
7125 * @param obj The file selector button widget
7126 * @param value @c EINA_TRUE to make it use an inner window, @c
7127 * EINA_TRUE to make it use a dedicated window
7129 * @see elm_win_inwin_add() for more information on inner windows
7130 * @see elm_fileselector_button_inwin_mode_get()
7132 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7135 * Get whether a given file selector button widget's internal file
7136 * selector will raise an Elementary "inner window", instead of a
7137 * dedicated Elementary window.
7139 * @param obj The file selector button widget
7140 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7141 * if it will use a dedicated window
7143 * @see elm_fileselector_button_inwin_mode_set() for more details
7145 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7152 * @defgroup File_Selector_Entry File Selector Entry
7154 * @image html img/widget/fileselector_entry/preview-00.png
7155 * @image latex img/widget/fileselector_entry/preview-00.eps
7157 * This is an entry made to be filled with or display a <b>file
7158 * system path string</b>. Besides the entry itself, the widget has
7159 * a @ref File_Selector_Button "file selector button" on its side,
7160 * which will raise an internal @ref Fileselector "file selector widget",
7161 * when clicked, for path selection aided by file system
7164 * This file selector may appear in an Elementary window or in an
7165 * inner window. When a file is chosen from it, the (inner) window
7166 * is closed and the selected file's path string is exposed both as
7167 * an smart event and as the new text on the entry.
7169 * This widget encapsulates operations on its internal file
7170 * selector on its own API. There is less control over its file
7171 * selector than that one would have instatiating one directly.
7173 * Smart callbacks one can register to:
7174 * - @c "changed" - The text within the entry was changed
7175 * - @c "activated" - The entry has had editing finished and
7176 * changes are to be "committed"
7177 * - @c "press" - The entry has been clicked
7178 * - @c "longpressed" - The entry has been clicked (and held) for a
7180 * - @c "clicked" - The entry has been clicked
7181 * - @c "clicked,double" - The entry has been double clicked
7182 * - @c "focused" - The entry has received focus
7183 * - @c "unfocused" - The entry has lost focus
7184 * - @c "selection,paste" - A paste action has occurred on the
7186 * - @c "selection,copy" - A copy action has occurred on the entry
7187 * - @c "selection,cut" - A cut action has occurred on the entry
7188 * - @c "unpressed" - The file selector entry's button was released
7189 * after being pressed.
7190 * - @c "file,chosen" - The user has selected a path via the file
7191 * selector entry's internal file selector, whose string pointer
7192 * comes as the @c event_info data (a stringshared string)
7194 * Here is an example on its usage:
7195 * @li @ref fileselector_entry_example
7197 * @see @ref File_Selector_Button for a similar widget.
7202 * Add a new file selector entry widget to the given parent
7203 * Elementary (container) object
7205 * @param parent The parent object
7206 * @return a new file selector entry widget handle or @c NULL, on
7209 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7212 * Set the label for a given file selector entry widget's button
7214 * @param obj The file selector entry widget
7215 * @param label The text label to be displayed on @p obj widget's
7218 * @deprecated use elm_object_text_set() instead.
7220 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7223 * Get the label set for a given file selector entry widget's button
7225 * @param obj The file selector entry widget
7226 * @return The widget button's label
7228 * @deprecated use elm_object_text_set() instead.
7230 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7233 * Set the icon on a given file selector entry widget's button
7235 * @param obj The file selector entry widget
7236 * @param icon The icon object for the entry's button
7238 * Once the icon object is set, a previously set one will be
7239 * deleted. If you want to keep the latter, use the
7240 * elm_fileselector_entry_button_icon_unset() function.
7242 * @see elm_fileselector_entry_button_icon_get()
7244 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7247 * Get the icon set for a given file selector entry widget's button
7249 * @param obj The file selector entry widget
7250 * @return The icon object currently set on @p obj widget's button
7251 * or @c NULL, if none is
7253 * @see elm_fileselector_entry_button_icon_set()
7255 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7258 * Unset the icon used in a given file selector entry widget's
7261 * @param obj The file selector entry widget
7262 * @return The icon object that was being used on @p obj widget's
7263 * button or @c NULL, on errors
7265 * Unparent and return the icon object which was set for this
7268 * @see elm_fileselector_entry_button_icon_set()
7270 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7273 * Set the title for a given file selector entry widget's window
7275 * @param obj The file selector entry widget
7276 * @param title The title string
7278 * This will change the window's title, when the file selector pops
7279 * out after a click on the entry's button. Those windows have the
7280 * default (unlocalized) value of @c "Select a file" as titles.
7282 * @note It will only take any effect if the file selector
7283 * entry widget is @b not under "inwin mode".
7285 * @see elm_fileselector_entry_window_title_get()
7287 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7290 * Get the title set for a given file selector entry widget's
7293 * @param obj The file selector entry widget
7294 * @return Title of the file selector entry's window
7296 * @see elm_fileselector_entry_window_title_get() for more details
7298 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7301 * Set the size of a given file selector entry widget's window,
7302 * holding the file selector itself.
7304 * @param obj The file selector entry widget
7305 * @param width The window's width
7306 * @param height The window's height
7308 * @note it will only take any effect if the file selector entry
7309 * widget is @b not under "inwin mode". The default size for the
7310 * window (when applicable) is 400x400 pixels.
7312 * @see elm_fileselector_entry_window_size_get()
7314 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7317 * Get the size of a given file selector entry widget's window,
7318 * holding the file selector itself.
7320 * @param obj The file selector entry widget
7321 * @param width Pointer into which to store the width value
7322 * @param height Pointer into which to store the height value
7324 * @note Use @c NULL pointers on the size values you're not
7325 * interested in: they'll be ignored by the function.
7327 * @see elm_fileselector_entry_window_size_set(), for more details
7329 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7332 * Set the initial file system path and the entry's path string for
7333 * a given file selector entry widget
7335 * @param obj The file selector entry widget
7336 * @param path The path string
7338 * It must be a <b>directory</b> path, which will have the contents
7339 * displayed initially in the file selector's view, when invoked
7340 * from @p obj. The default initial path is the @c "HOME"
7341 * environment variable's value.
7343 * @see elm_fileselector_entry_path_get()
7345 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7348 * Get the entry's path string for a given file selector entry
7351 * @param obj The file selector entry widget
7352 * @return path The path string
7354 * @see elm_fileselector_entry_path_set() for more details
7356 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7359 * Enable/disable a tree view in the given file selector entry
7360 * widget's internal file selector
7362 * @param obj The file selector entry widget
7363 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7366 * This has the same effect as elm_fileselector_expandable_set(),
7367 * but now applied to a file selector entry's internal file
7370 * @note There's no way to put a file selector entry's internal
7371 * file selector in "grid mode", as one may do with "pure" file
7374 * @see elm_fileselector_expandable_get()
7376 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7379 * Get whether tree view is enabled for the given file selector
7380 * entry widget's internal file selector
7382 * @param obj The file selector entry widget
7383 * @return @c EINA_TRUE if @p obj widget's internal file selector
7384 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7386 * @see elm_fileselector_expandable_set() for more details
7388 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7391 * Set whether a given file selector entry widget's internal file
7392 * selector is to display folders only or the directory contents,
7395 * @param obj The file selector entry widget
7396 * @param only @c EINA_TRUE to make @p obj widget's internal file
7397 * selector only display directories, @c EINA_FALSE to make files
7398 * to be displayed in it too
7400 * This has the same effect as elm_fileselector_folder_only_set(),
7401 * but now applied to a file selector entry's internal file
7404 * @see elm_fileselector_folder_only_get()
7406 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7409 * Get whether a given file selector entry widget's internal file
7410 * selector is displaying folders only or the directory contents,
7413 * @param obj The file selector entry widget
7414 * @return @c EINA_TRUE if @p obj widget's internal file
7415 * selector is only displaying directories, @c EINA_FALSE if files
7416 * are being displayed in it too (and on errors)
7418 * @see elm_fileselector_entry_folder_only_set() for more details
7420 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7423 * Enable/disable the file name entry box where the user can type
7424 * in a name for a file, in a given file selector entry widget's
7425 * internal file selector.
7427 * @param obj The file selector entry widget
7428 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7429 * file selector a "saving dialog", @c EINA_FALSE otherwise
7431 * This has the same effect as elm_fileselector_is_save_set(),
7432 * but now applied to a file selector entry's internal file
7435 * @see elm_fileselector_is_save_get()
7437 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7440 * Get whether the given file selector entry widget's internal
7441 * file selector is in "saving dialog" mode
7443 * @param obj The file selector entry widget
7444 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7445 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7448 * @see elm_fileselector_entry_is_save_set() for more details
7450 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7453 * Set whether a given file selector entry widget's internal file
7454 * selector will raise an Elementary "inner window", instead of a
7455 * dedicated Elementary window. By default, it won't.
7457 * @param obj The file selector entry widget
7458 * @param value @c EINA_TRUE to make it use an inner window, @c
7459 * EINA_TRUE to make it use a dedicated window
7461 * @see elm_win_inwin_add() for more information on inner windows
7462 * @see elm_fileselector_entry_inwin_mode_get()
7464 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7467 * Get whether a given file selector entry widget's internal file
7468 * selector will raise an Elementary "inner window", instead of a
7469 * dedicated Elementary window.
7471 * @param obj The file selector entry widget
7472 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7473 * if it will use a dedicated window
7475 * @see elm_fileselector_entry_inwin_mode_set() for more details
7477 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7480 * Set the initial file system path for a given file selector entry
7483 * @param obj The file selector entry widget
7484 * @param path The path string
7486 * It must be a <b>directory</b> path, which will have the contents
7487 * displayed initially in the file selector's view, when invoked
7488 * from @p obj. The default initial path is the @c "HOME"
7489 * environment variable's value.
7491 * @see elm_fileselector_entry_path_get()
7493 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7496 * Get the parent directory's path to the latest file selection on
7497 * a given filer selector entry widget
7499 * @param obj The file selector object
7500 * @return The (full) path of the directory of the last selection
7501 * on @p obj widget, a @b stringshared string
7503 * @see elm_fileselector_entry_path_set()
7505 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7512 * @defgroup Scroller Scroller
7514 * A scroller holds a single object and "scrolls it around". This means that
7515 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7516 * region around, allowing to move through a much larger object that is
7517 * contained in the scroller. The scroller will always have a small minimum
7518 * size by default as it won't be limited by the contents of the scroller.
7520 * Signals that you can add callbacks for are:
7521 * @li "edge,left" - the left edge of the content has been reached
7522 * @li "edge,right" - the right edge of the content has been reached
7523 * @li "edge,top" - the top edge of the content has been reached
7524 * @li "edge,bottom" - the bottom edge of the content has been reached
7525 * @li "scroll" - the content has been scrolled (moved)
7526 * @li "scroll,anim,start" - scrolling animation has started
7527 * @li "scroll,anim,stop" - scrolling animation has stopped
7528 * @li "scroll,drag,start" - dragging the contents around has started
7529 * @li "scroll,drag,stop" - dragging the contents around has stopped
7530 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7533 * @note When Elemementary is in embedded mode the scrollbars will not be
7534 * dragable, they appear merely as indicators of how much has been scrolled.
7535 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7536 * fingerscroll) won't work.
7538 * Default contents parts of the scroller widget that you can use for are:
7539 * @li "default" - A content of the scroller
7541 * In @ref tutorial_scroller you'll find an example of how to use most of
7547 * @brief Type that controls when scrollbars should appear.
7549 * @see elm_scroller_policy_set()
7551 typedef enum _Elm_Scroller_Policy
7553 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7554 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7555 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7556 ELM_SCROLLER_POLICY_LAST
7557 } Elm_Scroller_Policy;
7560 * @brief Add a new scroller to the parent
7562 * @param parent The parent object
7563 * @return The new object or NULL if it cannot be created
7565 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7568 * @brief Set the content of the scroller widget (the object to be scrolled around).
7570 * @param obj The scroller object
7571 * @param content The new content object
7573 * Once the content object is set, a previously set one will be deleted.
7574 * If you want to keep that old content object, use the
7575 * elm_scroller_content_unset() function.
7576 * @deprecated use elm_object_content_set() instead
7578 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7581 * @brief Get the content of the scroller widget
7583 * @param obj The slider object
7584 * @return The content that is being used
7586 * Return the content object which is set for this widget
7588 * @see elm_scroller_content_set()
7589 * @deprecated use elm_object_content_get() instead.
7591 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7594 * @brief Unset the content of the scroller widget
7596 * @param obj The slider object
7597 * @return The content that was being used
7599 * Unparent and return the content object which was set for this widget
7601 * @see elm_scroller_content_set()
7602 * @deprecated use elm_object_content_unset() instead.
7604 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7607 * @brief Set custom theme elements for the scroller
7609 * @param obj The scroller object
7610 * @param widget The widget name to use (default is "scroller")
7611 * @param base The base name to use (default is "base")
7613 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7616 * @brief Make the scroller minimum size limited to the minimum size of the content
7618 * @param obj The scroller object
7619 * @param w Enable limiting minimum size horizontally
7620 * @param h Enable limiting minimum size vertically
7622 * By default the scroller will be as small as its design allows,
7623 * irrespective of its content. This will make the scroller minimum size the
7624 * right size horizontally and/or vertically to perfectly fit its content in
7627 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7630 * @brief Show a specific virtual region within the scroller content object
7632 * @param obj The scroller object
7633 * @param x X coordinate of the region
7634 * @param y Y coordinate of the region
7635 * @param w Width of the region
7636 * @param h Height of the region
7638 * This will ensure all (or part if it does not fit) of the designated
7639 * region in the virtual content object (0, 0 starting at the top-left of the
7640 * virtual content object) is shown within the scroller.
7642 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);
7645 * @brief Set the scrollbar visibility policy
7647 * @param obj The scroller object
7648 * @param policy_h Horizontal scrollbar policy
7649 * @param policy_v Vertical scrollbar policy
7651 * This sets the scrollbar visibility policy for the given scroller.
7652 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7653 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7654 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7655 * respectively for the horizontal and vertical scrollbars.
7657 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7660 * @brief Gets scrollbar visibility policy
7662 * @param obj The scroller object
7663 * @param policy_h Horizontal scrollbar policy
7664 * @param policy_v Vertical scrollbar policy
7666 * @see elm_scroller_policy_set()
7668 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7671 * @brief Get the currently visible content region
7673 * @param obj The scroller object
7674 * @param x X coordinate of the region
7675 * @param y Y coordinate of the region
7676 * @param w Width of the region
7677 * @param h Height of the region
7679 * This gets the current region in the content object that is visible through
7680 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7681 * w, @p h values pointed to.
7683 * @note All coordinates are relative to the content.
7685 * @see elm_scroller_region_show()
7687 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);
7690 * @brief Get the size of the content object
7692 * @param obj The scroller object
7693 * @param w Width of the content object.
7694 * @param h Height of the content object.
7696 * This gets the size of the content object of the scroller.
7698 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7701 * @brief Set bouncing behavior
7703 * @param obj The scroller object
7704 * @param h_bounce Allow bounce horizontally
7705 * @param v_bounce Allow bounce vertically
7707 * When scrolling, the scroller may "bounce" when reaching an edge of the
7708 * content object. This is a visual way to indicate the end has been reached.
7709 * This is enabled by default for both axis. This API will set if it is enabled
7710 * for the given axis with the boolean parameters for each axis.
7712 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7715 * @brief Get the bounce behaviour
7717 * @param obj The Scroller object
7718 * @param h_bounce Will the scroller bounce horizontally or not
7719 * @param v_bounce Will the scroller bounce vertically or not
7721 * @see elm_scroller_bounce_set()
7723 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7726 * @brief Set scroll page size relative to viewport size.
7728 * @param obj The scroller object
7729 * @param h_pagerel The horizontal page relative size
7730 * @param v_pagerel The vertical page relative size
7732 * The scroller is capable of limiting scrolling by the user to "pages". That
7733 * is to jump by and only show a "whole page" at a time as if the continuous
7734 * area of the scroller content is split into page sized pieces. This sets
7735 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7736 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7737 * axis. This is mutually exclusive with page size
7738 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7739 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7740 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7743 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7746 * @brief Set scroll page size.
7748 * @param obj The scroller object
7749 * @param h_pagesize The horizontal page size
7750 * @param v_pagesize The vertical page size
7752 * This sets the page size to an absolute fixed value, with 0 turning it off
7755 * @see elm_scroller_page_relative_set()
7757 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7760 * @brief Get scroll current page number.
7762 * @param obj The scroller object
7763 * @param h_pagenumber The horizontal page number
7764 * @param v_pagenumber The vertical page number
7766 * The page number starts from 0. 0 is the first page.
7767 * Current page means the page which meets the top-left of the viewport.
7768 * If there are two or more pages in the viewport, it returns the number of the page
7769 * which meets the top-left of the viewport.
7771 * @see elm_scroller_last_page_get()
7772 * @see elm_scroller_page_show()
7773 * @see elm_scroller_page_brint_in()
7775 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7778 * @brief Get scroll last page number.
7780 * @param obj The scroller object
7781 * @param h_pagenumber The horizontal page number
7782 * @param v_pagenumber The vertical page number
7784 * The page number starts from 0. 0 is the first page.
7785 * This returns the last page number among the pages.
7787 * @see elm_scroller_current_page_get()
7788 * @see elm_scroller_page_show()
7789 * @see elm_scroller_page_brint_in()
7791 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7794 * Show a specific virtual region within the scroller content object by page number.
7796 * @param obj The scroller object
7797 * @param h_pagenumber The horizontal page number
7798 * @param v_pagenumber The vertical page number
7800 * 0, 0 of the indicated page is located at the top-left of the viewport.
7801 * This will jump to the page directly without animation.
7806 * sc = elm_scroller_add(win);
7807 * elm_scroller_content_set(sc, content);
7808 * elm_scroller_page_relative_set(sc, 1, 0);
7809 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7810 * elm_scroller_page_show(sc, h_page + 1, v_page);
7813 * @see elm_scroller_page_bring_in()
7815 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7818 * Show a specific virtual region within the scroller content object by page number.
7820 * @param obj The scroller object
7821 * @param h_pagenumber The horizontal page number
7822 * @param v_pagenumber The vertical page number
7824 * 0, 0 of the indicated page is located at the top-left of the viewport.
7825 * This will slide to the page with animation.
7830 * sc = elm_scroller_add(win);
7831 * elm_scroller_content_set(sc, content);
7832 * elm_scroller_page_relative_set(sc, 1, 0);
7833 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7834 * elm_scroller_page_bring_in(sc, h_page, v_page);
7837 * @see elm_scroller_page_show()
7839 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7842 * @brief Show a specific virtual region within the scroller content object.
7844 * @param obj The scroller object
7845 * @param x X coordinate of the region
7846 * @param y Y coordinate of the region
7847 * @param w Width of the region
7848 * @param h Height of the region
7850 * This will ensure all (or part if it does not fit) of the designated
7851 * region in the virtual content object (0, 0 starting at the top-left of the
7852 * virtual content object) is shown within the scroller. Unlike
7853 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7854 * to this location (if configuration in general calls for transitions). It
7855 * may not jump immediately to the new location and make take a while and
7856 * show other content along the way.
7858 * @see elm_scroller_region_show()
7860 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);
7863 * @brief Set event propagation on a scroller
7865 * @param obj The scroller object
7866 * @param propagation If propagation is enabled or not
7868 * This enables or disabled event propagation from the scroller content to
7869 * the scroller and its parent. By default event propagation is disabled.
7871 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7874 * @brief Get event propagation for a scroller
7876 * @param obj The scroller object
7877 * @return The propagation state
7879 * This gets the event propagation for a scroller.
7881 * @see elm_scroller_propagate_events_set()
7883 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7886 * @brief Set scrolling gravity on a scroller
7888 * @param obj The scroller object
7889 * @param x The scrolling horizontal gravity
7890 * @param y The scrolling vertical gravity
7892 * The gravity, defines how the scroller will adjust its view
7893 * when the size of the scroller contents increase.
7895 * The scroller will adjust the view to glue itself as follows.
7897 * x=0.0, for showing the left most region of the content.
7898 * x=1.0, for showing the right most region of the content.
7899 * y=0.0, for showing the bottom most region of the content.
7900 * y=1.0, for showing the top most region of the content.
7902 * Default values for x and y are 0.0
7904 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7907 * @brief Get scrolling gravity values for a scroller
7909 * @param obj The scroller object
7910 * @param x The scrolling horizontal gravity
7911 * @param y The scrolling vertical gravity
7913 * This gets gravity values for a scroller.
7915 * @see elm_scroller_gravity_set()
7918 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7925 * @defgroup Label Label
7927 * @image html img/widget/label/preview-00.png
7928 * @image latex img/widget/label/preview-00.eps
7930 * @brief Widget to display text, with simple html-like markup.
7932 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7933 * text doesn't fit the geometry of the label it will be ellipsized or be
7934 * cut. Elementary provides several styles for this widget:
7935 * @li default - No animation
7936 * @li marker - Centers the text in the label and make it bold by default
7937 * @li slide_long - The entire text appears from the right of the screen and
7938 * slides until it disappears in the left of the screen(reappering on the
7940 * @li slide_short - The text appears in the left of the label and slides to
7941 * the right to show the overflow. When all of the text has been shown the
7942 * position is reset.
7943 * @li slide_bounce - The text appears in the left of the label and slides to
7944 * the right to show the overflow. When all of the text has been shown the
7945 * animation reverses, moving the text to the left.
7947 * Custom themes can of course invent new markup tags and style them any way
7950 * The following signals may be emitted by the label widget:
7951 * @li "language,changed": The program's language changed.
7953 * See @ref tutorial_label for a demonstration of how to use a label widget.
7958 * @brief Add a new label to the parent
7960 * @param parent The parent object
7961 * @return The new object or NULL if it cannot be created
7963 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7966 * @brief Set the label on the label object
7968 * @param obj The label object
7969 * @param label The label will be used on the label object
7970 * @deprecated See elm_object_text_set()
7972 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7975 * @brief Get the label used on the label object
7977 * @param obj The label object
7978 * @return The string inside the label
7979 * @deprecated See elm_object_text_get()
7981 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7984 * @brief Set the wrapping behavior of the label
7986 * @param obj The label object
7987 * @param wrap To wrap text or not
7989 * By default no wrapping is done. Possible values for @p wrap are:
7990 * @li ELM_WRAP_NONE - No wrapping
7991 * @li ELM_WRAP_CHAR - wrap between characters
7992 * @li ELM_WRAP_WORD - wrap between words
7993 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7995 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7998 * @brief Get the wrapping behavior of the label
8000 * @param obj The label object
8003 * @see elm_label_line_wrap_set()
8005 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8008 * @brief Set wrap width of the label
8010 * @param obj The label object
8011 * @param w The wrap width in pixels at a minimum where words need to wrap
8013 * This function sets the maximum width size hint of the label.
8015 * @warning This is only relevant if the label is inside a container.
8017 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
8020 * @brief Get wrap width of the label
8022 * @param obj The label object
8023 * @return The wrap width in pixels at a minimum where words need to wrap
8025 * @see elm_label_wrap_width_set()
8027 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8030 * @brief Set wrap height of the label
8032 * @param obj The label object
8033 * @param h The wrap height in pixels at a minimum where words need to wrap
8035 * This function sets the maximum height size hint of the label.
8037 * @warning This is only relevant if the label is inside a container.
8039 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
8042 * @brief get wrap width of the label
8044 * @param obj The label object
8045 * @return The wrap height in pixels at a minimum where words need to wrap
8047 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8050 * @brief Set the font size on the label object.
8052 * @param obj The label object
8053 * @param size font size
8055 * @warning NEVER use this. It is for hyper-special cases only. use styles
8056 * instead. e.g. "default", "marker", "slide_long" etc.
8058 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
8061 * @brief Set the text color on the label object
8063 * @param obj The label object
8064 * @param r Red property background color of The label object
8065 * @param g Green property background color of The label object
8066 * @param b Blue property background color of The label object
8067 * @param a Alpha property background color of The label object
8069 * @warning NEVER use this. It is for hyper-special cases only. use styles
8070 * instead. e.g. "default", "marker", "slide_long" etc.
8072 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);
8075 * @brief Set the text align on the label object
8077 * @param obj The label object
8078 * @param align align mode ("left", "center", "right")
8080 * @warning NEVER use this. It is for hyper-special cases only. use styles
8081 * instead. e.g. "default", "marker", "slide_long" etc.
8083 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
8086 * @brief Set background color of the label
8088 * @param obj The label object
8089 * @param r Red property background color of The label object
8090 * @param g Green property background color of The label object
8091 * @param b Blue property background color of The label object
8092 * @param a Alpha property background alpha of The label object
8094 * @warning NEVER use this. It is for hyper-special cases only. use styles
8095 * instead. e.g. "default", "marker", "slide_long" etc.
8097 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);
8100 * @brief Set the ellipsis behavior of the label
8102 * @param obj The label object
8103 * @param ellipsis To ellipsis text or not
8105 * If set to true and the text doesn't fit in the label an ellipsis("...")
8106 * will be shown at the end of the widget.
8108 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
8109 * choosen wrap method was ELM_WRAP_WORD.
8111 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
8114 * @brief Set the text slide of the label
8116 * @param obj The label object
8117 * @param slide To start slide or stop
8119 * If set to true, the text of the label will slide/scroll through the length of
8122 * @warning This only works with the themes "slide_short", "slide_long" and
8125 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
8128 * @brief Get the text slide mode of the label
8130 * @param obj The label object
8131 * @return slide slide mode value
8133 * @see elm_label_slide_set()
8135 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8138 * @brief Set the slide duration(speed) of the label
8140 * @param obj The label object
8141 * @return The duration in seconds in moving text from slide begin position
8142 * to slide end position
8144 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
8147 * @brief Get the slide duration(speed) of the label
8149 * @param obj The label object
8150 * @return The duration time in moving text from slide begin position to slide end position
8152 * @see elm_label_slide_duration_set()
8154 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8161 * @defgroup Toggle Toggle
8163 * @image html img/widget/toggle/preview-00.png
8164 * @image latex img/widget/toggle/preview-00.eps
8166 * @brief A toggle is a slider which can be used to toggle between
8167 * two values. It has two states: on and off.
8169 * This widget is deprecated. Please use elm_check_add() instead using the
8170 * toggle style like:
8173 * obj = elm_check_add(parent);
8174 * elm_object_style_set(obj, "toggle");
8175 * elm_object_part_text_set(obj, "on", "ON");
8176 * elm_object_part_text_set(obj, "off", "OFF");
8179 * Signals that you can add callbacks for are:
8180 * @li "changed" - Whenever the toggle value has been changed. Is not called
8181 * until the toggle is released by the cursor (assuming it
8182 * has been triggered by the cursor in the first place).
8184 * Default contents parts of the toggle widget that you can use for are:
8185 * @li "icon" - An icon of the toggle
8187 * Default text parts of the toggle widget that you can use for are:
8188 * @li "elm.text" - Label of the toggle
8190 * @ref tutorial_toggle show how to use a toggle.
8195 * @brief Add a toggle to @p parent.
8197 * @param parent The parent object
8199 * @return The toggle object
8201 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8204 * @brief Sets the label to be displayed with the toggle.
8206 * @param obj The toggle object
8207 * @param label The label to be displayed
8209 * @deprecated use elm_object_text_set() instead.
8211 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8214 * @brief Gets the label of the toggle
8216 * @param obj toggle object
8217 * @return The label of the toggle
8219 * @deprecated use elm_object_text_get() instead.
8221 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8224 * @brief Set the icon used for the toggle
8226 * @param obj The toggle object
8227 * @param icon The icon object for the button
8229 * Once the icon object is set, a previously set one will be deleted
8230 * If you want to keep that old content object, use the
8231 * elm_toggle_icon_unset() function.
8233 * @deprecated use elm_object_part_content_set() instead.
8235 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8238 * @brief Get the icon used for the toggle
8240 * @param obj The toggle object
8241 * @return The icon object that is being used
8243 * Return the icon object which is set for this widget.
8245 * @see elm_toggle_icon_set()
8247 * @deprecated use elm_object_part_content_get() instead.
8249 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8252 * @brief Unset the icon used for the toggle
8254 * @param obj The toggle object
8255 * @return The icon object that was being used
8257 * Unparent and return the icon object which was set for this widget.
8259 * @see elm_toggle_icon_set()
8261 * @deprecated use elm_object_part_content_unset() instead.
8263 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8266 * @brief Sets the labels to be associated with the on and off states of the toggle.
8268 * @param obj The toggle object
8269 * @param onlabel The label displayed when the toggle is in the "on" state
8270 * @param offlabel The label displayed when the toggle is in the "off" state
8272 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8275 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8278 * @brief Gets the labels associated with the on and off states of the
8281 * @param obj The toggle object
8282 * @param onlabel A char** to place the onlabel of @p obj into
8283 * @param offlabel A char** to place the offlabel of @p obj into
8285 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8288 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8291 * @brief Sets the state of the toggle to @p state.
8293 * @param obj The toggle object
8294 * @param state The state of @p obj
8296 * @deprecated use elm_check_state_set() instead.
8298 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8301 * @brief Gets the state of the toggle to @p state.
8303 * @param obj The toggle object
8304 * @return The state of @p obj
8306 * @deprecated use elm_check_state_get() instead.
8308 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8311 * @brief Sets the state pointer of the toggle to @p statep.
8313 * @param obj The toggle object
8314 * @param statep The state pointer of @p obj
8316 * @deprecated use elm_check_state_pointer_set() instead.
8318 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8325 * @defgroup Frame Frame
8327 * @image html img/widget/frame/preview-00.png
8328 * @image latex img/widget/frame/preview-00.eps
8330 * @brief Frame is a widget that holds some content and has a title.
8332 * The default look is a frame with a title, but Frame supports multple
8340 * @li outdent_bottom
8342 * Of all this styles only default shows the title. Frame emits no signals.
8344 * Default contents parts of the frame widget that you can use for are:
8345 * @li "default" - A content of the frame
8347 * Default text parts of the frame widget that you can use for are:
8348 * @li "elm.text" - Label of the frame
8350 * For a detailed example see the @ref tutorial_frame.
8356 * @brief Add a new frame to the parent
8358 * @param parent The parent object
8359 * @return The new object or NULL if it cannot be created
8361 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8364 * @brief Set the frame label
8366 * @param obj The frame object
8367 * @param label The label of this frame object
8369 * @deprecated use elm_object_text_set() instead.
8371 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8374 * @brief Get the frame label
8376 * @param obj The frame object
8378 * @return The label of this frame objet or NULL if unable to get frame
8380 * @deprecated use elm_object_text_get() instead.
8382 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8385 * @brief Set the content of the frame widget
8387 * Once the content object is set, a previously set one will be deleted.
8388 * If you want to keep that old content object, use the
8389 * elm_frame_content_unset() function.
8391 * @param obj The frame object
8392 * @param content The content will be filled in this frame object
8394 * @deprecated use elm_object_content_set() instead.
8396 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8399 * @brief Get the content of the frame widget
8401 * Return the content object which is set for this widget
8403 * @param obj The frame object
8404 * @return The content that is being used
8406 * @deprecated use elm_object_content_get() instead.
8408 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8411 * @brief Unset the content of the frame widget
8413 * Unparent and return the content object which was set for this widget
8415 * @param obj The frame object
8416 * @return The content that was being used
8418 * @deprecated use elm_object_content_unset() instead.
8420 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8427 * @defgroup Table Table
8429 * A container widget to arrange other widgets in a table where items can
8430 * also span multiple columns or rows - even overlap (and then be raised or
8431 * lowered accordingly to adjust stacking if they do overlap).
8433 * For a Table widget the row/column count is not fixed.
8434 * The table widget adjusts itself when subobjects are added to it dynamically.
8436 * The followin are examples of how to use a table:
8437 * @li @ref tutorial_table_01
8438 * @li @ref tutorial_table_02
8444 * @brief Add a new table to the parent
8446 * @param parent The parent object
8447 * @return The new object or NULL if it cannot be created
8449 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8452 * @brief Set the homogeneous layout in the table
8454 * @param obj The layout object
8455 * @param homogeneous A boolean to set if the layout is homogeneous in the
8456 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8458 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8461 * @brief Get the current table homogeneous mode.
8463 * @param obj The table object
8464 * @return A boolean to indicating if the layout is homogeneous in the table
8465 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8467 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8470 * @brief Set padding between cells.
8472 * @param obj The layout object.
8473 * @param horizontal set the horizontal padding.
8474 * @param vertical set the vertical padding.
8476 * Default value is 0.
8478 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8481 * @brief Get padding between cells.
8483 * @param obj The layout object.
8484 * @param horizontal set the horizontal padding.
8485 * @param vertical set the vertical padding.
8487 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8490 * @brief Add a subobject on the table with the coordinates passed
8492 * @param obj The table object
8493 * @param subobj The subobject to be added to the table
8494 * @param x Row number
8495 * @param y Column number
8499 * @note All positioning inside the table is relative to rows and columns, so
8500 * a value of 0 for x and y, means the top left cell of the table, and a
8501 * value of 1 for w and h means @p subobj only takes that 1 cell.
8503 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8506 * @brief Remove child from table.
8508 * @param obj The table object
8509 * @param subobj The subobject
8511 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8514 * @brief Faster way to remove all child objects from a table object.
8516 * @param obj The table object
8517 * @param clear If true, will delete children, else just remove from table.
8519 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8522 * @brief Set the packing location of an existing child of the table
8524 * @param subobj The subobject to be modified in the table
8525 * @param x Row number
8526 * @param y Column number
8530 * Modifies the position of an object already in the table.
8532 * @note All positioning inside the table is relative to rows and columns, so
8533 * a value of 0 for x and y, means the top left cell of the table, and a
8534 * value of 1 for w and h means @p subobj only takes that 1 cell.
8536 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8539 * @brief Get the packing location of an existing child of the table
8541 * @param subobj The subobject to be modified in the table
8542 * @param x Row number
8543 * @param y Column number
8547 * @see elm_table_pack_set()
8549 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8555 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8556 typedef struct Elm_Gen_Item Elm_Gen_Item;
8557 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8558 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8559 typedef char *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8560 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. */
8561 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. */
8562 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8563 struct _Elm_Gen_Item_Class
8565 const char *item_style;
8566 struct _Elm_Gen_Item_Class_Func
8568 Elm_Gen_Item_Text_Get_Cb text_get;
8569 Elm_Gen_Item_Content_Get_Cb content_get;
8570 Elm_Gen_Item_State_Get_Cb state_get;
8571 Elm_Gen_Item_Del_Cb del;
8574 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8575 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8576 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8577 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8578 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8579 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8580 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8581 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8582 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8583 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8584 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8586 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8587 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8588 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8589 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8590 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8591 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8592 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8593 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8594 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8595 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8598 * @defgroup Gengrid Gengrid (Generic grid)
8600 * This widget aims to position objects in a grid layout while
8601 * actually creating and rendering only the visible ones, using the
8602 * same idea as the @ref Genlist "genlist": the user defines a @b
8603 * class for each item, specifying functions that will be called at
8604 * object creation, deletion, etc. When those items are selected by
8605 * the user, a callback function is issued. Users may interact with
8606 * a gengrid via the mouse (by clicking on items to select them and
8607 * clicking on the grid's viewport and swiping to pan the whole
8608 * view) or via the keyboard, navigating through item with the
8611 * @section Gengrid_Layouts Gengrid layouts
8613 * Gengrid may layout its items in one of two possible layouts:
8617 * When in "horizontal mode", items will be placed in @b columns,
8618 * from top to bottom and, when the space for a column is filled,
8619 * another one is started on the right, thus expanding the grid
8620 * horizontally, making for horizontal scrolling. When in "vertical
8621 * mode" , though, items will be placed in @b rows, from left to
8622 * right and, when the space for a row is filled, another one is
8623 * started below, thus expanding the grid vertically (and making
8624 * for vertical scrolling).
8626 * @section Gengrid_Items Gengrid items
8628 * An item in a gengrid can have 0 or more texts (they can be
8629 * regular text or textblock Evas objects - that's up to the style
8630 * to determine), 0 or more contents (which are simply objects
8631 * swallowed into the gengrid item's theming Edje object) and 0 or
8632 * more <b>boolean states</b>, which have the behavior left to the
8633 * user to define. The Edje part names for each of these properties
8634 * will be looked up, in the theme file for the gengrid, under the
8635 * Edje (string) data items named @c "texts", @c "contents" and @c
8636 * "states", respectively. For each of those properties, if more
8637 * than one part is provided, they must have names listed separated
8638 * by spaces in the data fields. For the default gengrid item
8639 * theme, we have @b one text part (@c "elm.text"), @b two content
8640 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8643 * A gengrid item may be at one of several styles. Elementary
8644 * provides one by default - "default", but this can be extended by
8645 * system or application custom themes/overlays/extensions (see
8646 * @ref Theme "themes" for more details).
8648 * @section Gengrid_Item_Class Gengrid item classes
8650 * In order to have the ability to add and delete items on the fly,
8651 * gengrid implements a class (callback) system where the
8652 * application provides a structure with information about that
8653 * type of item (gengrid may contain multiple different items with
8654 * different classes, states and styles). Gengrid will call the
8655 * functions in this struct (methods) when an item is "realized"
8656 * (i.e., created dynamically, while the user is scrolling the
8657 * grid). All objects will simply be deleted when no longer needed
8658 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8659 * contains the following members:
8660 * - @c item_style - This is a constant string and simply defines
8661 * the name of the item style. It @b must be specified and the
8662 * default should be @c "default".
8663 * - @c func.text_get - This function is called when an item
8664 * object is actually created. The @c data parameter will point to
8665 * the same data passed to elm_gengrid_item_append() and related
8666 * item creation functions. The @c obj parameter is the gengrid
8667 * object itself, while the @c part one is the name string of one
8668 * of the existing text parts in the Edje group implementing the
8669 * item's theme. This function @b must return a strdup'()ed string,
8670 * as the caller will free() it when done. See
8671 * #Elm_Gengrid_Item_Text_Get_Cb.
8672 * - @c func.content_get - This function is called when an item object
8673 * is actually created. The @c data parameter will point to the
8674 * same data passed to elm_gengrid_item_append() and related item
8675 * creation functions. The @c obj parameter is the gengrid object
8676 * itself, while the @c part one is the name string of one of the
8677 * existing (content) swallow parts in the Edje group implementing the
8678 * item's theme. It must return @c NULL, when no content is desired,
8679 * or a valid object handle, otherwise. The object will be deleted
8680 * by the gengrid on its deletion or when the item is "unrealized".
8681 * See #Elm_Gengrid_Item_Content_Get_Cb.
8682 * - @c func.state_get - This function is called when an item
8683 * object is actually created. The @c data parameter will point to
8684 * the same data passed to elm_gengrid_item_append() and related
8685 * item creation functions. The @c obj parameter is the gengrid
8686 * object itself, while the @c part one is the name string of one
8687 * of the state parts in the Edje group implementing the item's
8688 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8689 * true/on. Gengrids will emit a signal to its theming Edje object
8690 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8691 * "source" arguments, respectively, when the state is true (the
8692 * default is false), where @c XXX is the name of the (state) part.
8693 * See #Elm_Gengrid_Item_State_Get_Cb.
8694 * - @c func.del - This is called when elm_gengrid_item_del() is
8695 * called on an item or elm_gengrid_clear() is called on the
8696 * gengrid. This is intended for use when gengrid items are
8697 * deleted, so any data attached to the item (e.g. its data
8698 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8700 * @section Gengrid_Usage_Hints Usage hints
8702 * If the user wants to have multiple items selected at the same
8703 * time, elm_gengrid_multi_select_set() will permit it. If the
8704 * gengrid is single-selection only (the default), then
8705 * elm_gengrid_select_item_get() will return the selected item or
8706 * @c NULL, if none is selected. If the gengrid is under
8707 * multi-selection, then elm_gengrid_selected_items_get() will
8708 * return a list (that is only valid as long as no items are
8709 * modified (added, deleted, selected or unselected) of child items
8712 * If an item changes (internal (boolean) state, text or content
8713 * changes), then use elm_gengrid_item_update() to have gengrid
8714 * update the item with the new state. A gengrid will re-"realize"
8715 * the item, thus calling the functions in the
8716 * #Elm_Gengrid_Item_Class set for that item.
8718 * To programmatically (un)select an item, use
8719 * elm_gengrid_item_selected_set(). To get its selected state use
8720 * elm_gengrid_item_selected_get(). To make an item disabled
8721 * (unable to be selected and appear differently) use
8722 * elm_gengrid_item_disabled_set() to set this and
8723 * elm_gengrid_item_disabled_get() to get the disabled state.
8725 * Grid cells will only have their selection smart callbacks called
8726 * when firstly getting selected. Any further clicks will do
8727 * nothing, unless you enable the "always select mode", with
8728 * elm_gengrid_always_select_mode_set(), thus making every click to
8729 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8730 * turn off the ability to select items entirely in the widget and
8731 * they will neither appear selected nor call the selection smart
8734 * Remember that you can create new styles and add your own theme
8735 * augmentation per application with elm_theme_extension_add(). If
8736 * you absolutely must have a specific style that overrides any
8737 * theme the user or system sets up you can use
8738 * elm_theme_overlay_add() to add such a file.
8740 * @section Gengrid_Smart_Events Gengrid smart events
8742 * Smart events that you can add callbacks for are:
8743 * - @c "activated" - The user has double-clicked or pressed
8744 * (enter|return|spacebar) on an item. The @c event_info parameter
8745 * is the gengrid item that was activated.
8746 * - @c "clicked,double" - The user has double-clicked an item.
8747 * The @c event_info parameter is the gengrid item that was double-clicked.
8748 * - @c "longpressed" - This is called when the item is pressed for a certain
8749 * amount of time. By default it's 1 second.
8750 * - @c "selected" - The user has made an item selected. The
8751 * @c event_info parameter is the gengrid item that was selected.
8752 * - @c "unselected" - The user has made an item unselected. The
8753 * @c event_info parameter is the gengrid item that was unselected.
8754 * - @c "realized" - This is called when the item in the gengrid
8755 * has its implementing Evas object instantiated, de facto. @c
8756 * event_info is the gengrid item that was created. The object
8757 * may be deleted at any time, so it is highly advised to the
8758 * caller @b not to use the object pointer returned from
8759 * elm_gengrid_item_object_get(), because it may point to freed
8761 * - @c "unrealized" - This is called when the implementing Evas
8762 * object for this item is deleted. @c event_info is the gengrid
8763 * item that was deleted.
8764 * - @c "changed" - Called when an item is added, removed, resized
8765 * or moved and when the gengrid is resized or gets "horizontal"
8767 * - @c "scroll,anim,start" - This is called when scrolling animation has
8769 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8771 * - @c "drag,start,up" - Called when the item in the gengrid has
8772 * been dragged (not scrolled) up.
8773 * - @c "drag,start,down" - Called when the item in the gengrid has
8774 * been dragged (not scrolled) down.
8775 * - @c "drag,start,left" - Called when the item in the gengrid has
8776 * been dragged (not scrolled) left.
8777 * - @c "drag,start,right" - Called when the item in the gengrid has
8778 * been dragged (not scrolled) right.
8779 * - @c "drag,stop" - Called when the item in the gengrid has
8780 * stopped being dragged.
8781 * - @c "drag" - Called when the item in the gengrid is being
8783 * - @c "scroll" - called when the content has been scrolled
8785 * - @c "scroll,drag,start" - called when dragging the content has
8787 * - @c "scroll,drag,stop" - called when dragging the content has
8789 * - @c "edge,top" - This is called when the gengrid is scrolled until
8791 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8792 * until the bottom edge.
8793 * - @c "edge,left" - This is called when the gengrid is scrolled
8794 * until the left edge.
8795 * - @c "edge,right" - This is called when the gengrid is scrolled
8796 * until the right edge.
8798 * List of gengrid examples:
8799 * @li @ref gengrid_example
8803 * @addtogroup Gengrid
8807 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8808 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8809 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8810 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8811 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8814 * Text fetching class function for Elm_Gen_Item_Class.
8815 * @param data The data passed in the item creation function
8816 * @param obj The base widget object
8817 * @param part The part name of the swallow
8818 * @return The allocated (NOT stringshared) string to set as the text
8820 typedef char *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8823 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8824 * @param data The data passed in the item creation function
8825 * @param obj The base widget object
8826 * @param part The part name of the swallow
8827 * @return The content object to swallow
8829 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8832 * State fetching class function for Elm_Gen_Item_Class.
8833 * @param data The data passed in the item creation function
8834 * @param obj The base widget object
8835 * @param part The part name of the swallow
8836 * @return The hell if I know
8838 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8841 * Deletion class function for Elm_Gen_Item_Class.
8842 * @param data The data passed in the item creation function
8843 * @param obj The base widget object
8845 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8848 * @struct _Elm_Gengrid_Item_Class
8850 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8853 struct _Elm_Gengrid_Item_Class
8855 const char *item_style;
8856 struct _Elm_Gengrid_Item_Class_Func
8858 Elm_Gengrid_Item_Text_Get_Cb text_get; /**< Text fetching class function for gengrid item classes.*/
8859 Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8860 Elm_Gengrid_Item_State_Get_Cb state_get; /**< State fetching class function for gengrid item classes. */
8861 Elm_Gengrid_Item_Del_Cb del; /**< Deletion class function for gengrid item classes. */
8863 }; /**< #Elm_Gengrid_Item_Class member definitions */
8864 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8867 * Add a new gengrid widget to the given parent Elementary
8868 * (container) object
8870 * @param parent The parent object
8871 * @return a new gengrid widget handle or @c NULL, on errors
8873 * This function inserts a new gengrid widget on the canvas.
8875 * @see elm_gengrid_item_size_set()
8876 * @see elm_gengrid_group_item_size_set()
8877 * @see elm_gengrid_horizontal_set()
8878 * @see elm_gengrid_item_append()
8879 * @see elm_gengrid_item_del()
8880 * @see elm_gengrid_clear()
8884 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8887 * Set the size for the items of a given gengrid widget
8889 * @param obj The gengrid object.
8890 * @param w The items' width.
8891 * @param h The items' height;
8893 * A gengrid, after creation, has still no information on the size
8894 * to give to each of its cells. So, you most probably will end up
8895 * with squares one @ref Fingers "finger" wide, the default
8896 * size. Use this function to force a custom size for you items,
8897 * making them as big as you wish.
8899 * @see elm_gengrid_item_size_get()
8903 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8906 * Get the size set for the items of a given gengrid widget
8908 * @param obj The gengrid object.
8909 * @param w Pointer to a variable where to store the items' width.
8910 * @param h Pointer to a variable where to store the items' height.
8912 * @note Use @c NULL pointers on the size values you're not
8913 * interested in: they'll be ignored by the function.
8915 * @see elm_gengrid_item_size_get() for more details
8919 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8922 * Set the size for the group items of a given gengrid widget
8924 * @param obj The gengrid object.
8925 * @param w The group items' width.
8926 * @param h The group items' height;
8928 * A gengrid, after creation, has still no information on the size
8929 * to give to each of its cells. So, you most probably will end up
8930 * with squares one @ref Fingers "finger" wide, the default
8931 * size. Use this function to force a custom size for you group items,
8932 * making them as big as you wish.
8934 * @see elm_gengrid_group_item_size_get()
8938 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8941 * Get the size set for the group items of a given gengrid widget
8943 * @param obj The gengrid object.
8944 * @param w Pointer to a variable where to store the group items' width.
8945 * @param h Pointer to a variable where to store the group items' height.
8947 * @note Use @c NULL pointers on the size values you're not
8948 * interested in: they'll be ignored by the function.
8950 * @see elm_gengrid_group_item_size_get() for more details
8954 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8957 * Set the items grid's alignment within a given gengrid widget
8959 * @param obj The gengrid object.
8960 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8961 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8963 * This sets the alignment of the whole grid of items of a gengrid
8964 * within its given viewport. By default, those values are both
8965 * 0.5, meaning that the gengrid will have its items grid placed
8966 * exactly in the middle of its viewport.
8968 * @note If given alignment values are out of the cited ranges,
8969 * they'll be changed to the nearest boundary values on the valid
8972 * @see elm_gengrid_align_get()
8976 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8979 * Get the items grid's alignment values within a given gengrid
8982 * @param obj The gengrid object.
8983 * @param align_x Pointer to a variable where to store the
8984 * horizontal alignment.
8985 * @param align_y Pointer to a variable where to store the vertical
8988 * @note Use @c NULL pointers on the alignment values you're not
8989 * interested in: they'll be ignored by the function.
8991 * @see elm_gengrid_align_set() for more details
8995 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8998 * Set whether a given gengrid widget is or not able have items
9001 * @param obj The gengrid object
9002 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
9003 * @c EINA_FALSE to turn it off
9005 * If a gengrid is set to allow reordering, a click held for more
9006 * than 0.5 over a given item will highlight it specially,
9007 * signalling the gengrid has entered the reordering state. From
9008 * that time on, the user will be able to, while still holding the
9009 * mouse button down, move the item freely in the gengrid's
9010 * viewport, replacing to said item to the locations it goes to.
9011 * The replacements will be animated and, whenever the user
9012 * releases the mouse button, the item being replaced gets a new
9013 * definitive place in the grid.
9015 * @see elm_gengrid_reorder_mode_get()
9019 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
9022 * Get whether a given gengrid widget is or not able have items
9025 * @param obj The gengrid object
9026 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
9029 * @see elm_gengrid_reorder_mode_set() for more details
9033 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9036 * Append a new item in a given gengrid widget.
9038 * @param obj The gengrid object.
9039 * @param gic The item class for the item.
9040 * @param data The item data.
9041 * @param func Convenience function called when the item is
9043 * @param func_data Data to be passed to @p func.
9044 * @return A handle to the item added or @c NULL, on errors.
9046 * This adds an item to the beginning of the gengrid.
9048 * @see elm_gengrid_item_prepend()
9049 * @see elm_gengrid_item_insert_before()
9050 * @see elm_gengrid_item_insert_after()
9051 * @see elm_gengrid_item_del()
9055 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);
9058 * Prepend a new item in a given gengrid widget.
9060 * @param obj The gengrid object.
9061 * @param gic The item class for the item.
9062 * @param data The item data.
9063 * @param func Convenience function called when the item is
9065 * @param func_data Data to be passed to @p func.
9066 * @return A handle to the item added or @c NULL, on errors.
9068 * This adds an item to the end of the gengrid.
9070 * @see elm_gengrid_item_append()
9071 * @see elm_gengrid_item_insert_before()
9072 * @see elm_gengrid_item_insert_after()
9073 * @see elm_gengrid_item_del()
9077 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);
9080 * Insert an item before another in a gengrid widget
9082 * @param obj The gengrid object.
9083 * @param gic The item class for the item.
9084 * @param data The item data.
9085 * @param relative The item to place this new one before.
9086 * @param func Convenience function called when the item is
9088 * @param func_data Data to be passed to @p func.
9089 * @return A handle to the item added or @c NULL, on errors.
9091 * This inserts an item before another in the gengrid.
9093 * @see elm_gengrid_item_append()
9094 * @see elm_gengrid_item_prepend()
9095 * @see elm_gengrid_item_insert_after()
9096 * @see elm_gengrid_item_del()
9100 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);
9103 * Insert an item after another in a gengrid widget
9105 * @param obj The gengrid object.
9106 * @param gic The item class for the item.
9107 * @param data The item data.
9108 * @param relative The item to place this new one after.
9109 * @param func Convenience function called when the item is
9111 * @param func_data Data to be passed to @p func.
9112 * @return A handle to the item added or @c NULL, on errors.
9114 * This inserts an item after another in the gengrid.
9116 * @see elm_gengrid_item_append()
9117 * @see elm_gengrid_item_prepend()
9118 * @see elm_gengrid_item_insert_after()
9119 * @see elm_gengrid_item_del()
9123 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);
9126 * Insert an item in a gengrid widget using a user-defined sort function.
9128 * @param obj The gengrid object.
9129 * @param gic The item class for the item.
9130 * @param data The item data.
9131 * @param comp User defined comparison function that defines the sort order based on
9132 * Elm_Gen_Item and its data param.
9133 * @param func Convenience function called when the item is selected.
9134 * @param func_data Data to be passed to @p func.
9135 * @return A handle to the item added or @c NULL, on errors.
9137 * This inserts an item in the gengrid based on user defined comparison function.
9139 * @see elm_gengrid_item_append()
9140 * @see elm_gengrid_item_prepend()
9141 * @see elm_gengrid_item_insert_after()
9142 * @see elm_gengrid_item_del()
9143 * @see elm_gengrid_item_direct_sorted_insert()
9147 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);
9150 * Insert an item in a gengrid widget using a user-defined sort function.
9152 * @param obj The gengrid object.
9153 * @param gic The item class for the item.
9154 * @param data The item data.
9155 * @param comp User defined comparison function that defines the sort order based on
9157 * @param func Convenience function called when the item is selected.
9158 * @param func_data Data to be passed to @p func.
9159 * @return A handle to the item added or @c NULL, on errors.
9161 * This inserts an item in the gengrid based on user defined comparison function.
9163 * @see elm_gengrid_item_append()
9164 * @see elm_gengrid_item_prepend()
9165 * @see elm_gengrid_item_insert_after()
9166 * @see elm_gengrid_item_del()
9167 * @see elm_gengrid_item_sorted_insert()
9171 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);
9174 * Set whether items on a given gengrid widget are to get their
9175 * selection callbacks issued for @b every subsequent selection
9176 * click on them or just for the first click.
9178 * @param obj The gengrid object
9179 * @param always_select @c EINA_TRUE to make items "always
9180 * selected", @c EINA_FALSE, otherwise
9182 * By default, grid items will only call their selection callback
9183 * function when firstly getting selected, any subsequent further
9184 * clicks will do nothing. With this call, you make those
9185 * subsequent clicks also to issue the selection callbacks.
9187 * @note <b>Double clicks</b> will @b always be reported on items.
9189 * @see elm_gengrid_always_select_mode_get()
9193 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9196 * Get whether items on a given gengrid widget have their selection
9197 * callbacks issued for @b every subsequent selection click on them
9198 * or just for the first click.
9200 * @param obj The gengrid object.
9201 * @return @c EINA_TRUE if the gengrid items are "always selected",
9202 * @c EINA_FALSE, otherwise
9204 * @see elm_gengrid_always_select_mode_set() for more details
9208 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9211 * Set whether items on a given gengrid widget can be selected or not.
9213 * @param obj The gengrid object
9214 * @param no_select @c EINA_TRUE to make items selectable,
9215 * @c EINA_FALSE otherwise
9217 * This will make items in @p obj selectable or not. In the latter
9218 * case, any user interaction on the gengrid items will neither make
9219 * them appear selected nor them call their selection callback
9222 * @see elm_gengrid_no_select_mode_get()
9226 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9229 * Get whether items on a given gengrid widget can be selected or
9232 * @param obj The gengrid object
9233 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
9236 * @see elm_gengrid_no_select_mode_set() for more details
9240 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9243 * Enable or disable multi-selection in a given gengrid widget
9245 * @param obj The gengrid object.
9246 * @param multi @c EINA_TRUE, to enable multi-selection,
9247 * @c EINA_FALSE to disable it.
9249 * Multi-selection is the ability to have @b more than one
9250 * item selected, on a given gengrid, simultaneously. When it is
9251 * enabled, a sequence of clicks on different items will make them
9252 * all selected, progressively. A click on an already selected item
9253 * will unselect it. If interacting via the keyboard,
9254 * multi-selection is enabled while holding the "Shift" key.
9256 * @note By default, multi-selection is @b disabled on gengrids
9258 * @see elm_gengrid_multi_select_get()
9262 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9265 * Get whether multi-selection is enabled or disabled for a given
9268 * @param obj The gengrid object.
9269 * @return @c EINA_TRUE, if multi-selection is enabled, @c
9270 * EINA_FALSE otherwise
9272 * @see elm_gengrid_multi_select_set() for more details
9276 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9279 * Enable or disable bouncing effect for a given gengrid widget
9281 * @param obj The gengrid object
9282 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9283 * @c EINA_FALSE to disable it
9284 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9285 * @c EINA_FALSE to disable it
9287 * The bouncing effect occurs whenever one reaches the gengrid's
9288 * edge's while panning it -- it will scroll past its limits a
9289 * little bit and return to the edge again, in a animated for,
9292 * @note By default, gengrids have bouncing enabled on both axis
9294 * @see elm_gengrid_bounce_get()
9298 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9301 * Get whether bouncing effects are enabled or disabled, for a
9302 * given gengrid widget, on each axis
9304 * @param obj The gengrid object
9305 * @param h_bounce Pointer to a variable where to store the
9306 * horizontal bouncing flag.
9307 * @param v_bounce Pointer to a variable where to store the
9308 * vertical bouncing flag.
9310 * @see elm_gengrid_bounce_set() for more details
9314 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9317 * Set a given gengrid widget's scrolling page size, relative to
9318 * its viewport size.
9320 * @param obj The gengrid object
9321 * @param h_pagerel The horizontal page (relative) size
9322 * @param v_pagerel The vertical page (relative) size
9324 * The gengrid's scroller is capable of binding scrolling by the
9325 * user to "pages". It means that, while scrolling and, specially
9326 * after releasing the mouse button, the grid will @b snap to the
9327 * nearest displaying page's area. When page sizes are set, the
9328 * grid's continuous content area is split into (equal) page sized
9331 * This function sets the size of a page <b>relatively to the
9332 * viewport dimensions</b> of the gengrid, for each axis. A value
9333 * @c 1.0 means "the exact viewport's size", in that axis, while @c
9334 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9335 * a viewport". Sane usable values are, than, between @c 0.0 and @c
9336 * 1.0. Values beyond those will make it behave behave
9337 * inconsistently. If you only want one axis to snap to pages, use
9338 * the value @c 0.0 for the other one.
9340 * There is a function setting page size values in @b absolute
9341 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9342 * is mutually exclusive to this one.
9344 * @see elm_gengrid_page_relative_get()
9348 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9351 * Get a given gengrid widget's scrolling page size, relative to
9352 * its viewport size.
9354 * @param obj The gengrid object
9355 * @param h_pagerel Pointer to a variable where to store the
9356 * horizontal page (relative) size
9357 * @param v_pagerel Pointer to a variable where to store the
9358 * vertical page (relative) size
9360 * @see elm_gengrid_page_relative_set() for more details
9364 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9367 * Set a given gengrid widget's scrolling page size
9369 * @param obj The gengrid object
9370 * @param h_pagerel The horizontal page size, in pixels
9371 * @param v_pagerel The vertical page size, in pixels
9373 * The gengrid's scroller is capable of binding scrolling by the
9374 * user to "pages". It means that, while scrolling and, specially
9375 * after releasing the mouse button, the grid will @b snap to the
9376 * nearest displaying page's area. When page sizes are set, the
9377 * grid's continuous content area is split into (equal) page sized
9380 * This function sets the size of a page of the gengrid, in pixels,
9381 * for each axis. Sane usable values are, between @c 0 and the
9382 * dimensions of @p obj, for each axis. Values beyond those will
9383 * make it behave behave inconsistently. If you only want one axis
9384 * to snap to pages, use the value @c 0 for the other one.
9386 * There is a function setting page size values in @b relative
9387 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9388 * use is mutually exclusive to this one.
9392 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9395 * @brief Get gengrid current page number.
9397 * @param obj The gengrid object
9398 * @param h_pagenumber The horizontal page number
9399 * @param v_pagenumber The vertical page number
9401 * The page number starts from 0. 0 is the first page.
9402 * Current page means the page which meet the top-left of the viewport.
9403 * If there are two or more pages in the viewport, it returns the number of page
9404 * which meet the top-left of the viewport.
9406 * @see elm_gengrid_last_page_get()
9407 * @see elm_gengrid_page_show()
9408 * @see elm_gengrid_page_brint_in()
9410 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9413 * @brief Get scroll last page number.
9415 * @param obj The gengrid object
9416 * @param h_pagenumber The horizontal page number
9417 * @param v_pagenumber The vertical page number
9419 * The page number starts from 0. 0 is the first page.
9420 * This returns the last page number among the pages.
9422 * @see elm_gengrid_current_page_get()
9423 * @see elm_gengrid_page_show()
9424 * @see elm_gengrid_page_brint_in()
9426 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9429 * Show a specific virtual region within the gengrid content object by page number.
9431 * @param obj The gengrid object
9432 * @param h_pagenumber The horizontal page number
9433 * @param v_pagenumber The vertical page number
9435 * 0, 0 of the indicated page is located at the top-left of the viewport.
9436 * This will jump to the page directly without animation.
9441 * sc = elm_gengrid_add(win);
9442 * elm_gengrid_content_set(sc, content);
9443 * elm_gengrid_page_relative_set(sc, 1, 0);
9444 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9445 * elm_gengrid_page_show(sc, h_page + 1, v_page);
9448 * @see elm_gengrid_page_bring_in()
9450 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9453 * Show a specific virtual region within the gengrid content object by page number.
9455 * @param obj The gengrid object
9456 * @param h_pagenumber The horizontal page number
9457 * @param v_pagenumber The vertical page number
9459 * 0, 0 of the indicated page is located at the top-left of the viewport.
9460 * This will slide to the page with animation.
9465 * sc = elm_gengrid_add(win);
9466 * elm_gengrid_content_set(sc, content);
9467 * elm_gengrid_page_relative_set(sc, 1, 0);
9468 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9469 * elm_gengrid_page_bring_in(sc, h_page, v_page);
9472 * @see elm_gengrid_page_show()
9474 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9477 * Set the direction in which a given gengrid widget will expand while
9478 * placing its items.
9480 * @param obj The gengrid object.
9481 * @param setting @c EINA_TRUE to make the gengrid expand
9482 * horizontally, @c EINA_FALSE to expand vertically.
9484 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9485 * in @b columns, from top to bottom and, when the space for a
9486 * column is filled, another one is started on the right, thus
9487 * expanding the grid horizontally. When in "vertical mode"
9488 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9489 * to right and, when the space for a row is filled, another one is
9490 * started below, thus expanding the grid vertically.
9492 * @see elm_gengrid_horizontal_get()
9496 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9499 * Get for what direction a given gengrid widget will expand while
9500 * placing its items.
9502 * @param obj The gengrid object.
9503 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9504 * @c EINA_FALSE if it's set to expand vertically.
9506 * @see elm_gengrid_horizontal_set() for more detais
9510 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9513 * Get the first item in a given gengrid widget
9515 * @param obj The gengrid object
9516 * @return The first item's handle or @c NULL, if there are no
9517 * items in @p obj (and on errors)
9519 * This returns the first item in the @p obj's internal list of
9522 * @see elm_gengrid_last_item_get()
9526 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9529 * Get the last item in a given gengrid widget
9531 * @param obj The gengrid object
9532 * @return The last item's handle or @c NULL, if there are no
9533 * items in @p obj (and on errors)
9535 * This returns the last item in the @p obj's internal list of
9538 * @see elm_gengrid_first_item_get()
9542 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9545 * Get the @b next item in a gengrid widget's internal list of items,
9546 * given a handle to one of those items.
9548 * @param item The gengrid item to fetch next from
9549 * @return The item after @p item, or @c NULL if there's none (and
9552 * This returns the item placed after the @p item, on the container
9555 * @see elm_gengrid_item_prev_get()
9559 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9562 * Get the @b previous item in a gengrid widget's internal list of items,
9563 * given a handle to one of those items.
9565 * @param item The gengrid item to fetch previous from
9566 * @return The item before @p item, or @c NULL if there's none (and
9569 * This returns the item placed before the @p item, on the container
9572 * @see elm_gengrid_item_next_get()
9576 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9579 * Get the gengrid object's handle which contains a given gengrid
9582 * @param item The item to fetch the container from
9583 * @return The gengrid (parent) object
9585 * This returns the gengrid object itself that an item belongs to.
9589 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9592 * Remove a gengrid item from its parent, deleting it.
9594 * @param item The item to be removed.
9595 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9597 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9602 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9605 * Update the contents of a given gengrid item
9607 * @param item The gengrid item
9609 * This updates an item by calling all the item class functions
9610 * again to get the contents, texts and states. Use this when the
9611 * original item data has changed and you want the changes to be
9616 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9619 * Get the Gengrid Item class for the given Gengrid Item.
9621 * @param item The gengrid item
9623 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9624 * the function pointers and item_style.
9628 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9631 * Get the Gengrid Item class for the given Gengrid Item.
9633 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9634 * the function pointers and item_style.
9636 * @param item The gengrid item
9637 * @param gic The gengrid item class describing the function pointers and the item style.
9641 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9644 * Return the data associated to a given gengrid item
9646 * @param item The gengrid item.
9647 * @return the data associated with this item.
9649 * This returns the @c data value passed on the
9650 * elm_gengrid_item_append() and related item addition calls.
9652 * @see elm_gengrid_item_append()
9653 * @see elm_gengrid_item_data_set()
9657 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9660 * Set the data associated with a given gengrid item
9662 * @param item The gengrid item
9663 * @param data The data pointer to set on it
9665 * This @b overrides the @c data value passed on the
9666 * elm_gengrid_item_append() and related item addition calls. This
9667 * function @b won't call elm_gengrid_item_update() automatically,
9668 * so you'd issue it afterwards if you want to have the item
9669 * updated to reflect the new data.
9671 * @see elm_gengrid_item_data_get()
9672 * @see elm_gengrid_item_update()
9676 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9679 * Get a given gengrid item's position, relative to the whole
9680 * gengrid's grid area.
9682 * @param item The Gengrid item.
9683 * @param x Pointer to variable to store the item's <b>row number</b>.
9684 * @param y Pointer to variable to store the item's <b>column number</b>.
9686 * This returns the "logical" position of the item within the
9687 * gengrid. For example, @c (0, 1) would stand for first row,
9692 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9695 * Set whether a given gengrid item is selected or not
9697 * @param item The gengrid item
9698 * @param selected Use @c EINA_TRUE, to make it selected, @c
9699 * EINA_FALSE to make it unselected
9701 * This sets the selected state of an item. If multi-selection is
9702 * not enabled on the containing gengrid and @p selected is @c
9703 * EINA_TRUE, any other previously selected items will get
9704 * unselected in favor of this new one.
9706 * @see elm_gengrid_item_selected_get()
9710 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9713 * Get whether a given gengrid item is selected or not
9715 * @param item The gengrid item
9716 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9718 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9720 * @see elm_gengrid_item_selected_set() for more details
9724 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9727 * Get the real Evas object created to implement the view of a
9728 * given gengrid item
9730 * @param item The gengrid item.
9731 * @return the Evas object implementing this item's view.
9733 * This returns the actual Evas object used to implement the
9734 * specified gengrid item's view. This may be @c NULL, as it may
9735 * not have been created or may have been deleted, at any time, by
9736 * the gengrid. <b>Do not modify this object</b> (move, resize,
9737 * show, hide, etc.), as the gengrid is controlling it. This
9738 * function is for querying, emitting custom signals or hooking
9739 * lower level callbacks for events on that object. Do not delete
9740 * this object under any circumstances.
9742 * @see elm_gengrid_item_data_get()
9746 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9749 * Show the portion of a gengrid's internal grid containing a given
9750 * item, @b immediately.
9752 * @param item The item to display
9754 * This causes gengrid to @b redraw its viewport's contents to the
9755 * region contining the given @p item item, if it is not fully
9758 * @see elm_gengrid_item_bring_in()
9762 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9765 * Animatedly bring in, to the visible area of a gengrid, a given
9768 * @param item The gengrid item to display
9770 * This causes gengrid to jump to the given @p item and show
9771 * it (by scrolling), if it is not fully visible. This will use
9772 * animation to do so and take a period of time to complete.
9774 * @see elm_gengrid_item_show()
9778 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9781 * Set whether a given gengrid item is disabled or not.
9783 * @param item The gengrid item
9784 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9785 * to enable it back.
9787 * A disabled item cannot be selected or unselected. It will also
9788 * change its appearance, to signal the user it's disabled.
9790 * @see elm_gengrid_item_disabled_get()
9794 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9797 * Get whether a given gengrid item is disabled or not.
9799 * @param item The gengrid item
9800 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9803 * @see elm_gengrid_item_disabled_set() for more details
9807 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9810 * Set the text to be shown in a given gengrid item's tooltips.
9812 * @param item The gengrid item
9813 * @param text The text to set in the content
9815 * This call will setup the text to be used as tooltip to that item
9816 * (analogous to elm_object_tooltip_text_set(), but being item
9817 * tooltips with higher precedence than object tooltips). It can
9818 * have only one tooltip at a time, so any previous tooltip data
9823 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9826 * Set the content to be shown in a given gengrid item's tooltip
9828 * @param item The gengrid item.
9829 * @param func The function returning the tooltip contents.
9830 * @param data What to provide to @a func as callback data/context.
9831 * @param del_cb Called when data is not needed anymore, either when
9832 * another callback replaces @p func, the tooltip is unset with
9833 * elm_gengrid_item_tooltip_unset() or the owner @p item
9834 * dies. This callback receives as its first parameter the
9835 * given @p data, being @c event_info the item handle.
9837 * This call will setup the tooltip's contents to @p item
9838 * (analogous to elm_object_tooltip_content_cb_set(), but being
9839 * item tooltips with higher precedence than object tooltips). It
9840 * can have only one tooltip at a time, so any previous tooltip
9841 * content will get removed. @p func (with @p data) will be called
9842 * every time Elementary needs to show the tooltip and it should
9843 * return a valid Evas object, which will be fully managed by the
9844 * tooltip system, getting deleted when the tooltip is gone.
9848 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);
9851 * Unset a tooltip from a given gengrid item
9853 * @param item gengrid item to remove a previously set tooltip from.
9855 * This call removes any tooltip set on @p item. The callback
9856 * provided as @c del_cb to
9857 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9858 * notify it is not used anymore (and have resources cleaned, if
9861 * @see elm_gengrid_item_tooltip_content_cb_set()
9865 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9868 * Set a different @b style for a given gengrid item's tooltip.
9870 * @param item gengrid item with tooltip set
9871 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9872 * "default", @c "transparent", etc)
9874 * Tooltips can have <b>alternate styles</b> to be displayed on,
9875 * which are defined by the theme set on Elementary. This function
9876 * works analogously as elm_object_tooltip_style_set(), but here
9877 * applied only to gengrid item objects. The default style for
9878 * tooltips is @c "default".
9880 * @note before you set a style you should define a tooltip with
9881 * elm_gengrid_item_tooltip_content_cb_set() or
9882 * elm_gengrid_item_tooltip_text_set()
9884 * @see elm_gengrid_item_tooltip_style_get()
9888 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9891 * Get the style set a given gengrid item's tooltip.
9893 * @param item gengrid item with tooltip already set on.
9894 * @return style the theme style in use, which defaults to
9895 * "default". If the object does not have a tooltip set,
9896 * then @c NULL is returned.
9898 * @see elm_gengrid_item_tooltip_style_set() for more details
9902 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9905 * @brief Disable size restrictions on an object's tooltip
9906 * @param item The tooltip's anchor object
9907 * @param disable If EINA_TRUE, size restrictions are disabled
9908 * @return EINA_FALSE on failure, EINA_TRUE on success
9910 * This function allows a tooltip to expand beyond its parant window's canvas.
9911 * It will instead be limited only by the size of the display.
9913 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Gengrid_Item *item, Eina_Bool disable);
9916 * @brief Retrieve size restriction state of an object's tooltip
9917 * @param item The tooltip's anchor object
9918 * @return If EINA_TRUE, size restrictions are disabled
9920 * This function returns whether a tooltip is allowed to expand beyond
9921 * its parant window's canvas.
9922 * It will instead be limited only by the size of the display.
9924 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_get(const Elm_Gengrid_Item *item);
9927 * Set the type of mouse pointer/cursor decoration to be shown,
9928 * when the mouse pointer is over the given gengrid widget item
9930 * @param item gengrid item to customize cursor on
9931 * @param cursor the cursor type's name
9933 * This function works analogously as elm_object_cursor_set(), but
9934 * here the cursor's changing area is restricted to the item's
9935 * area, and not the whole widget's. Note that that item cursors
9936 * have precedence over widget cursors, so that a mouse over @p
9937 * item will always show cursor @p type.
9939 * If this function is called twice for an object, a previously set
9940 * cursor will be unset on the second call.
9942 * @see elm_object_cursor_set()
9943 * @see elm_gengrid_item_cursor_get()
9944 * @see elm_gengrid_item_cursor_unset()
9948 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9951 * Get the type of mouse pointer/cursor decoration set to be shown,
9952 * when the mouse pointer is over the given gengrid widget item
9954 * @param item gengrid item with custom cursor set
9955 * @return the cursor type's name or @c NULL, if no custom cursors
9956 * were set to @p item (and on errors)
9958 * @see elm_object_cursor_get()
9959 * @see elm_gengrid_item_cursor_set() for more details
9960 * @see elm_gengrid_item_cursor_unset()
9964 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9967 * Unset any custom mouse pointer/cursor decoration set to be
9968 * shown, when the mouse pointer is over the given gengrid widget
9969 * item, thus making it show the @b default cursor again.
9971 * @param item a gengrid item
9973 * Use this call to undo any custom settings on this item's cursor
9974 * decoration, bringing it back to defaults (no custom style set).
9976 * @see elm_object_cursor_unset()
9977 * @see elm_gengrid_item_cursor_set() for more details
9981 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9984 * Set a different @b style for a given custom cursor set for a
9987 * @param item gengrid item with custom cursor set
9988 * @param style the <b>theme style</b> to use (e.g. @c "default",
9989 * @c "transparent", etc)
9991 * This function only makes sense when one is using custom mouse
9992 * cursor decorations <b>defined in a theme file</b> , which can
9993 * have, given a cursor name/type, <b>alternate styles</b> on
9994 * it. It works analogously as elm_object_cursor_style_set(), but
9995 * here applied only to gengrid item objects.
9997 * @warning Before you set a cursor style you should have defined a
9998 * custom cursor previously on the item, with
9999 * elm_gengrid_item_cursor_set()
10001 * @see elm_gengrid_item_cursor_engine_only_set()
10002 * @see elm_gengrid_item_cursor_style_get()
10006 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
10009 * Get the current @b style set for a given gengrid item's custom
10012 * @param item gengrid item with custom cursor set.
10013 * @return style the cursor style in use. If the object does not
10014 * have a cursor set, then @c NULL is returned.
10016 * @see elm_gengrid_item_cursor_style_set() for more details
10020 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10023 * Set if the (custom) cursor for a given gengrid item should be
10024 * searched in its theme, also, or should only rely on the
10025 * rendering engine.
10027 * @param item item with custom (custom) cursor already set on
10028 * @param engine_only Use @c EINA_TRUE to have cursors looked for
10029 * only on those provided by the rendering engine, @c EINA_FALSE to
10030 * have them searched on the widget's theme, as well.
10032 * @note This call is of use only if you've set a custom cursor
10033 * for gengrid items, with elm_gengrid_item_cursor_set().
10035 * @note By default, cursors will only be looked for between those
10036 * provided by the rendering engine.
10040 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10043 * Get if the (custom) cursor for a given gengrid item is being
10044 * searched in its theme, also, or is only relying on the rendering
10047 * @param item a gengrid item
10048 * @return @c EINA_TRUE, if cursors are being looked for only on
10049 * those provided by the rendering engine, @c EINA_FALSE if they
10050 * are being searched on the widget's theme, as well.
10052 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
10056 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10059 * Remove all items from a given gengrid widget
10061 * @param obj The gengrid object.
10063 * This removes (and deletes) all items in @p obj, leaving it
10066 * @see elm_gengrid_item_del(), to remove just one item.
10070 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10073 * Get the selected item in a given gengrid widget
10075 * @param obj The gengrid object.
10076 * @return The selected item's handleor @c NULL, if none is
10077 * selected at the moment (and on errors)
10079 * This returns the selected item in @p obj. If multi selection is
10080 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
10081 * the first item in the list is selected, which might not be very
10082 * useful. For that case, see elm_gengrid_selected_items_get().
10086 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10089 * Get <b>a list</b> of selected items in a given gengrid
10091 * @param obj The gengrid object.
10092 * @return The list of selected items or @c NULL, if none is
10093 * selected at the moment (and on errors)
10095 * This returns a list of the selected items, in the order that
10096 * they appear in the grid. This list is only valid as long as no
10097 * more items are selected or unselected (or unselected implictly
10098 * by deletion). The list contains #Elm_Gengrid_Item pointers as
10101 * @see elm_gengrid_selected_item_get()
10105 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10112 * @defgroup Clock Clock
10114 * @image html img/widget/clock/preview-00.png
10115 * @image latex img/widget/clock/preview-00.eps
10117 * This is a @b digital clock widget. In its default theme, it has a
10118 * vintage "flipping numbers clock" appearance, which will animate
10119 * sheets of individual algarisms individually as time goes by.
10121 * A newly created clock will fetch system's time (already
10122 * considering local time adjustments) to start with, and will tick
10123 * accondingly. It may or may not show seconds.
10125 * Clocks have an @b edition mode. When in it, the sheets will
10126 * display extra arrow indications on the top and bottom and the
10127 * user may click on them to raise or lower the time values. After
10128 * it's told to exit edition mode, it will keep ticking with that
10129 * new time set (it keeps the difference from local time).
10131 * Also, when under edition mode, user clicks on the cited arrows
10132 * which are @b held for some time will make the clock to flip the
10133 * sheet, thus editing the time, continuosly and automatically for
10134 * the user. The interval between sheet flips will keep growing in
10135 * time, so that it helps the user to reach a time which is distant
10136 * from the one set.
10138 * The time display is, by default, in military mode (24h), but an
10139 * am/pm indicator may be optionally shown, too, when it will
10142 * Smart callbacks one can register to:
10143 * - "changed" - the clock's user changed the time
10145 * Here is an example on its usage:
10146 * @li @ref clock_example
10150 * @addtogroup Clock
10155 * Identifiers for which clock digits should be editable, when a
10156 * clock widget is in edition mode. Values may be ORed together to
10157 * make a mask, naturally.
10159 * @see elm_clock_edit_set()
10160 * @see elm_clock_digit_edit_set()
10162 typedef enum _Elm_Clock_Digedit
10164 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
10165 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
10166 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
10167 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
10168 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
10169 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
10170 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
10171 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
10172 } Elm_Clock_Digedit;
10175 * Add a new clock widget to the given parent Elementary
10176 * (container) object
10178 * @param parent The parent object
10179 * @return a new clock widget handle or @c NULL, on errors
10181 * This function inserts a new clock widget on the canvas.
10185 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10188 * Set a clock widget's time, programmatically
10190 * @param obj The clock widget object
10191 * @param hrs The hours to set
10192 * @param min The minutes to set
10193 * @param sec The secondes to set
10195 * This function updates the time that is showed by the clock
10198 * Values @b must be set within the following ranges:
10199 * - 0 - 23, for hours
10200 * - 0 - 59, for minutes
10201 * - 0 - 59, for seconds,
10203 * even if the clock is not in "military" mode.
10205 * @warning The behavior for values set out of those ranges is @b
10210 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
10213 * Get a clock widget's time values
10215 * @param obj The clock object
10216 * @param[out] hrs Pointer to the variable to get the hours value
10217 * @param[out] min Pointer to the variable to get the minutes value
10218 * @param[out] sec Pointer to the variable to get the seconds value
10220 * This function gets the time set for @p obj, returning
10221 * it on the variables passed as the arguments to function
10223 * @note Use @c NULL pointers on the time values you're not
10224 * interested in: they'll be ignored by the function.
10228 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
10231 * Set whether a given clock widget is under <b>edition mode</b> or
10232 * under (default) displaying-only mode.
10234 * @param obj The clock object
10235 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
10236 * put it back to "displaying only" mode
10238 * This function makes a clock's time to be editable or not <b>by
10239 * user interaction</b>. When in edition mode, clocks @b stop
10240 * ticking, until one brings them back to canonical mode. The
10241 * elm_clock_digit_edit_set() function will influence which digits
10242 * of the clock will be editable. By default, all of them will be
10243 * (#ELM_CLOCK_NONE).
10245 * @note am/pm sheets, if being shown, will @b always be editable
10246 * under edition mode.
10248 * @see elm_clock_edit_get()
10252 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10255 * Retrieve whether a given clock widget is under <b>edition
10256 * mode</b> or under (default) displaying-only mode.
10258 * @param obj The clock object
10259 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
10262 * This function retrieves whether the clock's time can be edited
10263 * or not by user interaction.
10265 * @see elm_clock_edit_set() for more details
10269 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10272 * Set what digits of the given clock widget should be editable
10273 * when in edition mode.
10275 * @param obj The clock object
10276 * @param digedit Bit mask indicating the digits to be editable
10277 * (values in #Elm_Clock_Digedit).
10279 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10280 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10283 * @see elm_clock_digit_edit_get()
10287 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10290 * Retrieve what digits of the given clock widget should be
10291 * editable when in edition mode.
10293 * @param obj The clock object
10294 * @return Bit mask indicating the digits to be editable
10295 * (values in #Elm_Clock_Digedit).
10297 * @see elm_clock_digit_edit_set() for more details
10301 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10304 * Set if the given clock widget must show hours in military or
10307 * @param obj The clock object
10308 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10311 * This function sets if the clock must show hours in military or
10312 * am/pm mode. In some countries like Brazil the military mode
10313 * (00-24h-format) is used, in opposition to the USA, where the
10314 * am/pm mode is more commonly used.
10316 * @see elm_clock_show_am_pm_get()
10320 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10323 * Get if the given clock widget shows hours in military or am/pm
10326 * @param obj The clock object
10327 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10330 * This function gets if the clock shows hours in military or am/pm
10333 * @see elm_clock_show_am_pm_set() for more details
10337 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10340 * Set if the given clock widget must show time with seconds or not
10342 * @param obj The clock object
10343 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10345 * This function sets if the given clock must show or not elapsed
10346 * seconds. By default, they are @b not shown.
10348 * @see elm_clock_show_seconds_get()
10352 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10355 * Get whether the given clock widget is showing time with seconds
10358 * @param obj The clock object
10359 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10361 * This function gets whether @p obj is showing or not the elapsed
10364 * @see elm_clock_show_seconds_set()
10368 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10371 * Set the interval on time updates for an user mouse button hold
10372 * on clock widgets' time edition.
10374 * @param obj The clock object
10375 * @param interval The (first) interval value in seconds
10377 * This interval value is @b decreased while the user holds the
10378 * mouse pointer either incrementing or decrementing a given the
10379 * clock digit's value.
10381 * This helps the user to get to a given time distant from the
10382 * current one easier/faster, as it will start to flip quicker and
10383 * quicker on mouse button holds.
10385 * The calculation for the next flip interval value, starting from
10386 * the one set with this call, is the previous interval divided by
10387 * 1.05, so it decreases a little bit.
10389 * The default starting interval value for automatic flips is
10392 * @see elm_clock_interval_get()
10396 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10399 * Get the interval on time updates for an user mouse button hold
10400 * on clock widgets' time edition.
10402 * @param obj The clock object
10403 * @return The (first) interval value, in seconds, set on it
10405 * @see elm_clock_interval_set() for more details
10409 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10416 * @defgroup Layout Layout
10418 * @image html img/widget/layout/preview-00.png
10419 * @image latex img/widget/layout/preview-00.eps width=\textwidth
10421 * @image html img/layout-predefined.png
10422 * @image latex img/layout-predefined.eps width=\textwidth
10424 * This is a container widget that takes a standard Edje design file and
10425 * wraps it very thinly in a widget.
10427 * An Edje design (theme) file has a very wide range of possibilities to
10428 * describe the behavior of elements added to the Layout. Check out the Edje
10429 * documentation and the EDC reference to get more information about what can
10430 * be done with Edje.
10432 * Just like @ref List, @ref Box, and other container widgets, any
10433 * object added to the Layout will become its child, meaning that it will be
10434 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10436 * The Layout widget can contain as many Contents, Boxes or Tables as
10437 * described in its theme file. For instance, objects can be added to
10438 * different Tables by specifying the respective Table part names. The same
10439 * is valid for Content and Box.
10441 * The objects added as child of the Layout will behave as described in the
10442 * part description where they were added. There are 3 possible types of
10443 * parts where a child can be added:
10445 * @section secContent Content (SWALLOW part)
10447 * Only one object can be added to the @c SWALLOW part (but you still can
10448 * have many @c SWALLOW parts and one object on each of them). Use the @c
10449 * elm_object_content_set/get/unset functions to set, retrieve and unset
10450 * objects as content of the @c SWALLOW. After being set to this part, the
10451 * object size, position, visibility, clipping and other description
10452 * properties will be totally controlled by the description of the given part
10453 * (inside the Edje theme file).
10455 * One can use @c evas_object_size_hint_* functions on the child to have some
10456 * kind of control over its behavior, but the resulting behavior will still
10457 * depend heavily on the @c SWALLOW part description.
10459 * The Edje theme also can change the part description, based on signals or
10460 * scripts running inside the theme. This change can also be animated. All of
10461 * this will affect the child object set as content accordingly. The object
10462 * size will be changed if the part size is changed, it will animate move if
10463 * the part is moving, and so on.
10465 * The following picture demonstrates a Layout widget with a child object
10466 * added to its @c SWALLOW:
10468 * @image html layout_swallow.png
10469 * @image latex layout_swallow.eps width=\textwidth
10471 * @section secBox Box (BOX part)
10473 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10474 * allows one to add objects to the box and have them distributed along its
10475 * area, accordingly to the specified @a layout property (now by @a layout we
10476 * mean the chosen layouting design of the Box, not the Layout widget
10479 * A similar effect for having a box with its position, size and other things
10480 * controlled by the Layout theme would be to create an Elementary @ref Box
10481 * widget and add it as a Content in the @c SWALLOW part.
10483 * The main difference of using the Layout Box is that its behavior, the box
10484 * properties like layouting format, padding, align, etc. will be all
10485 * controlled by the theme. This means, for example, that a signal could be
10486 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10487 * handled the signal by changing the box padding, or align, or both. Using
10488 * the Elementary @ref Box widget is not necessarily harder or easier, it
10489 * just depends on the circunstances and requirements.
10491 * The Layout Box can be used through the @c elm_layout_box_* set of
10494 * The following picture demonstrates a Layout widget with many child objects
10495 * added to its @c BOX part:
10497 * @image html layout_box.png
10498 * @image latex layout_box.eps width=\textwidth
10500 * @section secTable Table (TABLE part)
10502 * Just like the @ref secBox, the Layout Table is very similar to the
10503 * Elementary @ref Table widget. It allows one to add objects to the Table
10504 * specifying the row and column where the object should be added, and any
10505 * column or row span if necessary.
10507 * Again, we could have this design by adding a @ref Table widget to the @c
10508 * SWALLOW part using elm_object_part_content_set(). The same difference happens
10509 * here when choosing to use the Layout Table (a @c TABLE part) instead of
10510 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10512 * The Layout Table can be used through the @c elm_layout_table_* set of
10515 * The following picture demonstrates a Layout widget with many child objects
10516 * added to its @c TABLE part:
10518 * @image html layout_table.png
10519 * @image latex layout_table.eps width=\textwidth
10521 * @section secPredef Predefined Layouts
10523 * Another interesting thing about the Layout widget is that it offers some
10524 * predefined themes that come with the default Elementary theme. These
10525 * themes can be set by the call elm_layout_theme_set(), and provide some
10526 * basic functionality depending on the theme used.
10528 * Most of them already send some signals, some already provide a toolbar or
10529 * back and next buttons.
10531 * These are available predefined theme layouts. All of them have class = @c
10532 * layout, group = @c application, and style = one of the following options:
10534 * @li @c toolbar-content - application with toolbar and main content area
10535 * @li @c toolbar-content-back - application with toolbar and main content
10536 * area with a back button and title area
10537 * @li @c toolbar-content-back-next - application with toolbar and main
10538 * content area with a back and next buttons and title area
10539 * @li @c content-back - application with a main content area with a back
10540 * button and title area
10541 * @li @c content-back-next - application with a main content area with a
10542 * back and next buttons and title area
10543 * @li @c toolbar-vbox - application with toolbar and main content area as a
10545 * @li @c toolbar-table - application with toolbar and main content area as a
10548 * @section secExamples Examples
10550 * Some examples of the Layout widget can be found here:
10551 * @li @ref layout_example_01
10552 * @li @ref layout_example_02
10553 * @li @ref layout_example_03
10554 * @li @ref layout_example_edc
10559 * Add a new layout to the parent
10561 * @param parent The parent object
10562 * @return The new object or NULL if it cannot be created
10564 * @see elm_layout_file_set()
10565 * @see elm_layout_theme_set()
10569 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10572 * Set the file that will be used as layout
10574 * @param obj The layout object
10575 * @param file The path to file (edj) that will be used as layout
10576 * @param group The group that the layout belongs in edje file
10578 * @return (1 = success, 0 = error)
10582 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10585 * Set the edje group from the elementary theme that will be used as layout
10587 * @param obj The layout object
10588 * @param clas the clas of the group
10589 * @param group the group
10590 * @param style the style to used
10592 * @return (1 = success, 0 = error)
10596 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10599 * Set the layout content.
10601 * @param obj The layout object
10602 * @param swallow The swallow part name in the edje file
10603 * @param content The child that will be added in this layout object
10605 * Once the content object is set, a previously set one will be deleted.
10606 * If you want to keep that old content object, use the
10607 * elm_object_part_content_unset() function.
10609 * @note In an Edje theme, the part used as a content container is called @c
10610 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10611 * expected to be a part name just like the second parameter of
10612 * elm_layout_box_append().
10614 * @see elm_layout_box_append()
10615 * @see elm_object_part_content_get()
10616 * @see elm_object_part_content_unset()
10618 * @deprecated use elm_object_part_content_set() instead
10622 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10625 * Get the child object in the given content part.
10627 * @param obj The layout object
10628 * @param swallow The SWALLOW part to get its content
10630 * @return The swallowed object or NULL if none or an error occurred
10632 * @deprecated use elm_object_part_content_get() instead
10636 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10639 * Unset the layout content.
10641 * @param obj The layout object
10642 * @param swallow The swallow part name in the edje file
10643 * @return The content that was being used
10645 * Unparent and return the content object which was set for this part.
10647 * @deprecated use elm_object_part_content_unset() instead
10651 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10654 * Set the text of the given part
10656 * @param obj The layout object
10657 * @param part The TEXT part where to set the text
10658 * @param text The text to set
10661 * @deprecated use elm_object_part_text_set() instead.
10663 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10666 * Get the text set in the given part
10668 * @param obj The layout object
10669 * @param part The TEXT part to retrieve the text off
10671 * @return The text set in @p part
10674 * @deprecated use elm_object_part_text_get() instead.
10676 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10679 * Append child to layout box part.
10681 * @param obj the layout object
10682 * @param part the box part to which the object will be appended.
10683 * @param child the child object to append to box.
10685 * Once the object is appended, it will become child of the layout. Its
10686 * lifetime will be bound to the layout, whenever the layout dies the child
10687 * will be deleted automatically. One should use elm_layout_box_remove() to
10688 * make this layout forget about the object.
10690 * @see elm_layout_box_prepend()
10691 * @see elm_layout_box_insert_before()
10692 * @see elm_layout_box_insert_at()
10693 * @see elm_layout_box_remove()
10697 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10700 * Prepend child to layout box part.
10702 * @param obj the layout object
10703 * @param part the box part to prepend.
10704 * @param child the child object to prepend to box.
10706 * Once the object is prepended, it will become child of the layout. Its
10707 * lifetime will be bound to the layout, whenever the layout dies the child
10708 * will be deleted automatically. One should use elm_layout_box_remove() to
10709 * make this layout forget about the object.
10711 * @see elm_layout_box_append()
10712 * @see elm_layout_box_insert_before()
10713 * @see elm_layout_box_insert_at()
10714 * @see elm_layout_box_remove()
10718 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10721 * Insert child to layout box part before a reference object.
10723 * @param obj the layout object
10724 * @param part the box part to insert.
10725 * @param child the child object to insert into box.
10726 * @param reference another reference object to insert before in box.
10728 * Once the object is inserted, it will become child of the layout. Its
10729 * lifetime will be bound to the layout, whenever the layout dies the child
10730 * will be deleted automatically. One should use elm_layout_box_remove() to
10731 * make this layout forget about the object.
10733 * @see elm_layout_box_append()
10734 * @see elm_layout_box_prepend()
10735 * @see elm_layout_box_insert_before()
10736 * @see elm_layout_box_remove()
10740 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10743 * Insert child to layout box part at a given position.
10745 * @param obj the layout object
10746 * @param part the box part to insert.
10747 * @param child the child object to insert into box.
10748 * @param pos the numeric position >=0 to insert the child.
10750 * Once the object is inserted, it will become child of the layout. Its
10751 * lifetime will be bound to the layout, whenever the layout dies the child
10752 * will be deleted automatically. One should use elm_layout_box_remove() to
10753 * make this layout forget about the object.
10755 * @see elm_layout_box_append()
10756 * @see elm_layout_box_prepend()
10757 * @see elm_layout_box_insert_before()
10758 * @see elm_layout_box_remove()
10762 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10765 * Remove a child of the given part box.
10767 * @param obj The layout object
10768 * @param part The box part name to remove child.
10769 * @param child The object to remove from box.
10770 * @return The object that was being used, or NULL if not found.
10772 * The object will be removed from the box part and its lifetime will
10773 * not be handled by the layout anymore. This is equivalent to
10774 * elm_object_part_content_unset() for box.
10776 * @see elm_layout_box_append()
10777 * @see elm_layout_box_remove_all()
10781 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10784 * Remove all children of the given part box.
10786 * @param obj The layout object
10787 * @param part The box part name to remove child.
10788 * @param clear If EINA_TRUE, then all objects will be deleted as
10789 * well, otherwise they will just be removed and will be
10790 * dangling on the canvas.
10792 * The objects will be removed from the box part and their lifetime will
10793 * not be handled by the layout anymore. This is equivalent to
10794 * elm_layout_box_remove() for all box children.
10796 * @see elm_layout_box_append()
10797 * @see elm_layout_box_remove()
10801 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10804 * Insert child to layout table part.
10806 * @param obj the layout object
10807 * @param part the box part to pack child.
10808 * @param child_obj the child object to pack into table.
10809 * @param col the column to which the child should be added. (>= 0)
10810 * @param row the row to which the child should be added. (>= 0)
10811 * @param colspan how many columns should be used to store this object. (>=
10813 * @param rowspan how many rows should be used to store this object. (>= 1)
10815 * Once the object is inserted, it will become child of the table. Its
10816 * lifetime will be bound to the layout, and whenever the layout dies the
10817 * child will be deleted automatically. One should use
10818 * elm_layout_table_remove() to make this layout forget about the object.
10820 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10821 * more space than a single cell. For instance, the following code:
10823 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10826 * Would result in an object being added like the following picture:
10828 * @image html layout_colspan.png
10829 * @image latex layout_colspan.eps width=\textwidth
10831 * @see elm_layout_table_unpack()
10832 * @see elm_layout_table_clear()
10836 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);
10839 * Unpack (remove) a child of the given part table.
10841 * @param obj The layout object
10842 * @param part The table part name to remove child.
10843 * @param child_obj The object to remove from table.
10844 * @return The object that was being used, or NULL if not found.
10846 * The object will be unpacked from the table part and its lifetime
10847 * will not be handled by the layout anymore. This is equivalent to
10848 * elm_object_part_content_unset() for table.
10850 * @see elm_layout_table_pack()
10851 * @see elm_layout_table_clear()
10855 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10858 * Remove all the child objects of the given part table.
10860 * @param obj The layout object
10861 * @param part The table part name to remove child.
10862 * @param clear If EINA_TRUE, then all objects will be deleted as
10863 * well, otherwise they will just be removed and will be
10864 * dangling on the canvas.
10866 * The objects will be removed from the table part and their lifetime will
10867 * not be handled by the layout anymore. This is equivalent to
10868 * elm_layout_table_unpack() for all table children.
10870 * @see elm_layout_table_pack()
10871 * @see elm_layout_table_unpack()
10875 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10878 * Get the edje layout
10880 * @param obj The layout object
10882 * @return A Evas_Object with the edje layout settings loaded
10883 * with function elm_layout_file_set
10885 * This returns the edje object. It is not expected to be used to then
10886 * swallow objects via edje_object_part_swallow() for example. Use
10887 * elm_object_part_content_set() instead so child object handling and sizing is
10890 * @note This function should only be used if you really need to call some
10891 * low level Edje function on this edje object. All the common stuff (setting
10892 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10893 * with proper elementary functions.
10895 * @see elm_object_signal_callback_add()
10896 * @see elm_object_signal_emit()
10897 * @see elm_object_part_text_set()
10898 * @see elm_object_part_content_set()
10899 * @see elm_layout_box_append()
10900 * @see elm_layout_table_pack()
10901 * @see elm_layout_data_get()
10905 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10908 * Get the edje data from the given layout
10910 * @param obj The layout object
10911 * @param key The data key
10913 * @return The edje data string
10915 * This function fetches data specified inside the edje theme of this layout.
10916 * This function return NULL if data is not found.
10918 * In EDC this comes from a data block within the group block that @p
10919 * obj was loaded from. E.g.
10926 * item: "key1" "value1";
10927 * item: "key2" "value2";
10935 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10940 * @param obj The layout object
10942 * Manually forces a sizing re-evaluation. This is useful when the minimum
10943 * size required by the edje theme of this layout has changed. The change on
10944 * the minimum size required by the edje theme is not immediately reported to
10945 * the elementary layout, so one needs to call this function in order to tell
10946 * the widget (layout) that it needs to reevaluate its own size.
10948 * The minimum size of the theme is calculated based on minimum size of
10949 * parts, the size of elements inside containers like box and table, etc. All
10950 * of this can change due to state changes, and that's when this function
10951 * should be called.
10953 * Also note that a standard signal of "size,eval" "elm" emitted from the
10954 * edje object will cause this to happen too.
10958 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10961 * Sets a specific cursor for an edje part.
10963 * @param obj The layout object.
10964 * @param part_name a part from loaded edje group.
10965 * @param cursor cursor name to use, see Elementary_Cursor.h
10967 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10968 * part not exists or it has "mouse_events: 0".
10972 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10975 * Get the cursor to be shown when mouse is over an edje part
10977 * @param obj The layout object.
10978 * @param part_name a part from loaded edje group.
10979 * @return the cursor name.
10983 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10986 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10988 * @param obj The layout object.
10989 * @param part_name a part from loaded edje group, that had a cursor set
10990 * with elm_layout_part_cursor_set().
10994 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10997 * Sets a specific cursor style for an edje part.
10999 * @param obj The layout object.
11000 * @param part_name a part from loaded edje group.
11001 * @param style the theme style to use (default, transparent, ...)
11003 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11004 * part not exists or it did not had a cursor set.
11008 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
11011 * Gets a specific cursor style for an edje part.
11013 * @param obj The layout object.
11014 * @param part_name a part from loaded edje group.
11016 * @return the theme style in use, defaults to "default". If the
11017 * object does not have a cursor set, then NULL is returned.
11021 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11024 * Sets if the cursor set should be searched on the theme or should use
11025 * the provided by the engine, only.
11027 * @note before you set if should look on theme you should define a
11028 * cursor with elm_layout_part_cursor_set(). By default it will only
11029 * look for cursors provided by the engine.
11031 * @param obj The layout object.
11032 * @param part_name a part from loaded edje group.
11033 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
11034 * or should also search on widget's theme as well (EINA_FALSE)
11036 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11037 * part not exists or it did not had a cursor set.
11041 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);
11044 * Gets a specific cursor engine_only for an edje part.
11046 * @param obj The layout object.
11047 * @param part_name a part from loaded edje group.
11049 * @return whenever the cursor is just provided by engine or also from theme.
11053 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11056 * @def elm_layout_icon_set
11057 * Convenience macro to set the icon object in a layout that follows the
11058 * Elementary naming convention for its parts.
11062 #define elm_layout_icon_set(_ly, _obj) \
11065 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
11066 if ((_obj)) sig = "elm,state,icon,visible"; \
11067 else sig = "elm,state,icon,hidden"; \
11068 elm_object_signal_emit((_ly), sig, "elm"); \
11072 * @def elm_layout_icon_get
11073 * Convienience macro to get the icon object from a layout that follows the
11074 * Elementary naming convention for its parts.
11078 #define elm_layout_icon_get(_ly) \
11079 elm_object_part_content_get((_ly), "elm.swallow.icon")
11082 * @def elm_layout_end_set
11083 * Convienience macro to set the end object in a layout that follows the
11084 * Elementary naming convention for its parts.
11088 #define elm_layout_end_set(_ly, _obj) \
11091 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
11092 if ((_obj)) sig = "elm,state,end,visible"; \
11093 else sig = "elm,state,end,hidden"; \
11094 elm_object_signal_emit((_ly), sig, "elm"); \
11098 * @def elm_layout_end_get
11099 * Convienience macro to get the end object in a layout that follows the
11100 * Elementary naming convention for its parts.
11104 #define elm_layout_end_get(_ly) \
11105 elm_object_part_content_get((_ly), "elm.swallow.end")
11108 * @def elm_layout_label_set
11109 * Convienience macro to set the label in a layout that follows the
11110 * Elementary naming convention for its parts.
11113 * @deprecated use elm_object_text_set() instead.
11115 #define elm_layout_label_set(_ly, _txt) \
11116 elm_layout_text_set((_ly), "elm.text", (_txt))
11119 * @def elm_layout_label_get
11120 * Convenience macro to get the label in a layout that follows the
11121 * Elementary naming convention for its parts.
11124 * @deprecated use elm_object_text_set() instead.
11126 #define elm_layout_label_get(_ly) \
11127 elm_layout_text_get((_ly), "elm.text")
11129 /* smart callbacks called:
11130 * "theme,changed" - when elm theme is changed.
11134 * @defgroup Notify Notify
11136 * @image html img/widget/notify/preview-00.png
11137 * @image latex img/widget/notify/preview-00.eps
11139 * Display a container in a particular region of the parent(top, bottom,
11140 * etc). A timeout can be set to automatically hide the notify. This is so
11141 * that, after an evas_object_show() on a notify object, if a timeout was set
11142 * on it, it will @b automatically get hidden after that time.
11144 * Signals that you can add callbacks for are:
11145 * @li "timeout" - when timeout happens on notify and it's hidden
11146 * @li "block,clicked" - when a click outside of the notify happens
11148 * Default contents parts of the notify widget that you can use for are:
11149 * @li "default" - A content of the notify
11151 * @ref tutorial_notify show usage of the API.
11157 * @brief Possible orient values for notify.
11159 * This values should be used in conjunction to elm_notify_orient_set() to
11160 * set the position in which the notify should appear(relative to its parent)
11161 * and in conjunction with elm_notify_orient_get() to know where the notify
11164 typedef enum _Elm_Notify_Orient
11166 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
11167 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
11168 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
11169 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
11170 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
11171 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
11172 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
11173 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
11174 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
11175 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
11176 } Elm_Notify_Orient;
11179 * @brief Add a new notify to the parent
11181 * @param parent The parent object
11182 * @return The new object or NULL if it cannot be created
11184 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11187 * @brief Set the content of the notify widget
11189 * @param obj The notify object
11190 * @param content The content will be filled in this notify object
11192 * Once the content object is set, a previously set one will be deleted. If
11193 * you want to keep that old content object, use the
11194 * elm_notify_content_unset() function.
11196 * @deprecated use elm_object_content_set() instead
11199 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11202 * @brief Unset the content of the notify widget
11204 * @param obj The notify object
11205 * @return The content that was being used
11207 * Unparent and return the content object which was set for this widget
11209 * @see elm_notify_content_set()
11210 * @deprecated use elm_object_content_unset() instead
11213 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11216 * @brief Return the content of the notify widget
11218 * @param obj The notify object
11219 * @return The content that is being used
11221 * @see elm_notify_content_set()
11222 * @deprecated use elm_object_content_get() instead
11225 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11228 * @brief Set the notify parent
11230 * @param obj The notify object
11231 * @param content The new parent
11233 * Once the parent object is set, a previously set one will be disconnected
11236 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11239 * @brief Get the notify parent
11241 * @param obj The notify object
11242 * @return The parent
11244 * @see elm_notify_parent_set()
11246 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11249 * @brief Set the orientation
11251 * @param obj The notify object
11252 * @param orient The new orientation
11254 * Sets the position in which the notify will appear in its parent.
11256 * @see @ref Elm_Notify_Orient for possible values.
11258 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
11261 * @brief Return the orientation
11262 * @param obj The notify object
11263 * @return The orientation of the notification
11265 * @see elm_notify_orient_set()
11266 * @see Elm_Notify_Orient
11268 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11271 * @brief Set the time interval after which the notify window is going to be
11274 * @param obj The notify object
11275 * @param time The timeout in seconds
11277 * This function sets a timeout and starts the timer controlling when the
11278 * notify is hidden. Since calling evas_object_show() on a notify restarts
11279 * the timer controlling when the notify is hidden, setting this before the
11280 * notify is shown will in effect mean starting the timer when the notify is
11283 * @note Set a value <= 0.0 to disable a running timer.
11285 * @note If the value > 0.0 and the notify is previously visible, the
11286 * timer will be started with this value, canceling any running timer.
11288 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11291 * @brief Return the timeout value (in seconds)
11292 * @param obj the notify object
11294 * @see elm_notify_timeout_set()
11296 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11299 * @brief Sets whether events should be passed to by a click outside
11302 * @param obj The notify object
11303 * @param repeats EINA_TRUE Events are repeats, else no
11305 * When true if the user clicks outside the window the events will be caught
11306 * by the others widgets, else the events are blocked.
11308 * @note The default value is EINA_TRUE.
11310 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11313 * @brief Return true if events are repeat below the notify object
11314 * @param obj the notify object
11316 * @see elm_notify_repeat_events_set()
11318 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11325 * @defgroup Hover Hover
11327 * @image html img/widget/hover/preview-00.png
11328 * @image latex img/widget/hover/preview-00.eps
11330 * A Hover object will hover over its @p parent object at the @p target
11331 * location. Anything in the background will be given a darker coloring to
11332 * indicate that the hover object is on top (at the default theme). When the
11333 * hover is clicked it is dismissed(hidden), if the contents of the hover are
11334 * clicked that @b doesn't cause the hover to be dismissed.
11336 * A Hover object has two parents. One parent that owns it during creation
11337 * and the other parent being the one over which the hover object spans.
11340 * @note The hover object will take up the entire space of @p target
11343 * Elementary has the following styles for the hover widget:
11347 * @li hoversel_vertical
11349 * The following are the available position for content:
11361 * Signals that you can add callbacks for are:
11362 * @li "clicked" - the user clicked the empty space in the hover to dismiss
11363 * @li "smart,changed" - a content object placed under the "smart"
11364 * policy was replaced to a new slot direction.
11366 * See @ref tutorial_hover for more information.
11370 typedef enum _Elm_Hover_Axis
11372 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11373 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11374 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11375 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11379 * @brief Adds a hover object to @p parent
11381 * @param parent The parent object
11382 * @return The hover object or NULL if one could not be created
11384 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11387 * @brief Sets the target object for the hover.
11389 * @param obj The hover object
11390 * @param target The object to center the hover onto.
11392 * This function will cause the hover to be centered on the target object.
11394 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11397 * @brief Gets the target object for the hover.
11399 * @param obj The hover object
11400 * @return The target object for the hover.
11402 * @see elm_hover_target_set()
11404 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11407 * @brief Sets the parent object for the hover.
11409 * @param obj The hover object
11410 * @param parent The object to locate the hover over.
11412 * This function will cause the hover to take up the entire space that the
11413 * parent object fills.
11415 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11418 * @brief Gets the parent object for the hover.
11420 * @param obj The hover object
11421 * @return The parent object to locate the hover over.
11423 * @see elm_hover_parent_set()
11425 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11428 * @brief Sets the content of the hover object and the direction in which it
11431 * @param obj The hover object
11432 * @param swallow The direction that the object will be displayed
11433 * at. Accepted values are "left", "top-left", "top", "top-right",
11434 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11436 * @param content The content to place at @p swallow
11438 * Once the content object is set for a given direction, a previously
11439 * set one (on the same direction) will be deleted. If you want to
11440 * keep that old content object, use the elm_hover_content_unset()
11443 * All directions may have contents at the same time, except for
11444 * "smart". This is a special placement hint and its use case
11445 * independs of the calculations coming from
11446 * elm_hover_best_content_location_get(). Its use is for cases when
11447 * one desires only one hover content, but with a dynamic special
11448 * placement within the hover area. The content's geometry, whenever
11449 * it changes, will be used to decide on a best location, not
11450 * extrapolating the hover's parent object view to show it in (still
11451 * being the hover's target determinant of its medium part -- move and
11452 * resize it to simulate finger sizes, for example). If one of the
11453 * directions other than "smart" are used, a previously content set
11454 * using it will be deleted, and vice-versa.
11456 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11459 * @brief Get the content of the hover object, in a given direction.
11461 * Return the content object which was set for this widget in the
11462 * @p swallow direction.
11464 * @param obj The hover object
11465 * @param swallow The direction that the object was display at.
11466 * @return The content that was being used
11468 * @see elm_hover_content_set()
11470 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11473 * @brief Unset the content of the hover object, in a given direction.
11475 * Unparent and return the content object set at @p swallow direction.
11477 * @param obj The hover object
11478 * @param swallow The direction that the object was display at.
11479 * @return The content that was being used.
11481 * @see elm_hover_content_set()
11483 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11486 * @brief Returns the best swallow location for content in the hover.
11488 * @param obj The hover object
11489 * @param pref_axis The preferred orientation axis for the hover object to use
11490 * @return The edje location to place content into the hover or @c
11493 * Best is defined here as the location at which there is the most available
11496 * @p pref_axis may be one of
11497 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11498 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11499 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11500 * - @c ELM_HOVER_AXIS_BOTH -- both
11502 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11503 * nescessarily be along the horizontal axis("left" or "right"). If
11504 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11505 * be along the vertical axis("top" or "bottom"). Chossing
11506 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11507 * returned position may be in either axis.
11509 * @see elm_hover_content_set()
11511 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11519 * @defgroup Entry Entry
11521 * @image html img/widget/entry/preview-00.png
11522 * @image latex img/widget/entry/preview-00.eps width=\textwidth
11523 * @image html img/widget/entry/preview-01.png
11524 * @image latex img/widget/entry/preview-01.eps width=\textwidth
11525 * @image html img/widget/entry/preview-02.png
11526 * @image latex img/widget/entry/preview-02.eps width=\textwidth
11527 * @image html img/widget/entry/preview-03.png
11528 * @image latex img/widget/entry/preview-03.eps width=\textwidth
11530 * An entry is a convenience widget which shows a box that the user can
11531 * enter text into. Entries by default don't scroll, so they grow to
11532 * accomodate the entire text, resizing the parent window as needed. This
11533 * can be changed with the elm_entry_scrollable_set() function.
11535 * They can also be single line or multi line (the default) and when set
11536 * to multi line mode they support text wrapping in any of the modes
11537 * indicated by #Elm_Wrap_Type.
11539 * Other features include password mode, filtering of inserted text with
11540 * elm_entry_text_filter_append() and related functions, inline "items" and
11541 * formatted markup text.
11543 * @section entry-markup Formatted text
11545 * The markup tags supported by the Entry are defined by the theme, but
11546 * even when writing new themes or extensions it's a good idea to stick to
11547 * a sane default, to maintain coherency and avoid application breakages.
11548 * Currently defined by the default theme are the following tags:
11549 * @li \<br\>: Inserts a line break.
11550 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11552 * @li \<tab\>: Inserts a tab.
11553 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11555 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11556 * @li \<link\>...\</link\>: Underlines the enclosed text.
11557 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11559 * @section entry-special Special markups
11561 * Besides those used to format text, entries support two special markup
11562 * tags used to insert clickable portions of text or items inlined within
11565 * @subsection entry-anchors Anchors
11567 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11568 * \</a\> tags and an event will be generated when this text is clicked,
11572 * This text is outside <a href=anc-01>but this one is an anchor</a>
11575 * The @c href attribute in the opening tag gives the name that will be
11576 * used to identify the anchor and it can be any valid utf8 string.
11578 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11579 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11580 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11581 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11584 * @subsection entry-items Items
11586 * Inlined in the text, any other @c Evas_Object can be inserted by using
11587 * \<item\> tags this way:
11590 * <item size=16x16 vsize=full href=emoticon/haha></item>
11593 * Just like with anchors, the @c href identifies each item, but these need,
11594 * in addition, to indicate their size, which is done using any one of
11595 * @c size, @c absize or @c relsize attributes. These attributes take their
11596 * value in the WxH format, where W is the width and H the height of the
11599 * @li absize: Absolute pixel size for the item. Whatever value is set will
11600 * be the item's size regardless of any scale value the object may have
11601 * been set to. The final line height will be adjusted to fit larger items.
11602 * @li size: Similar to @c absize, but it's adjusted to the scale value set
11604 * @li relsize: Size is adjusted for the item to fit within the current
11607 * Besides their size, items are specificed a @c vsize value that affects
11608 * how their final size and position are calculated. The possible values
11610 * @li ascent: Item will be placed within the line's baseline and its
11611 * ascent. That is, the height between the line where all characters are
11612 * positioned and the highest point in the line. For @c size and @c absize
11613 * items, the descent value will be added to the total line height to make
11614 * them fit. @c relsize items will be adjusted to fit within this space.
11615 * @li full: Items will be placed between the descent and ascent, or the
11616 * lowest point in the line and its highest.
11618 * The next image shows different configurations of items and how
11619 * the previously mentioned options affect their sizes. In all cases,
11620 * the green line indicates the ascent, blue for the baseline and red for
11623 * @image html entry_item.png
11624 * @image latex entry_item.eps width=\textwidth
11626 * And another one to show how size differs from absize. In the first one,
11627 * the scale value is set to 1.0, while the second one is using one of 2.0.
11629 * @image html entry_item_scale.png
11630 * @image latex entry_item_scale.eps width=\textwidth
11632 * After the size for an item is calculated, the entry will request an
11633 * object to place in its space. For this, the functions set with
11634 * elm_entry_item_provider_append() and related functions will be called
11635 * in order until one of them returns a @c non-NULL value. If no providers
11636 * are available, or all of them return @c NULL, then the entry falls back
11637 * to one of the internal defaults, provided the name matches with one of
11640 * All of the following are currently supported:
11643 * - emoticon/angry-shout
11644 * - emoticon/crazy-laugh
11645 * - emoticon/evil-laugh
11647 * - emoticon/goggle-smile
11648 * - emoticon/grumpy
11649 * - emoticon/grumpy-smile
11650 * - emoticon/guilty
11651 * - emoticon/guilty-smile
11653 * - emoticon/half-smile
11654 * - emoticon/happy-panting
11656 * - emoticon/indifferent
11658 * - emoticon/knowing-grin
11660 * - emoticon/little-bit-sorry
11661 * - emoticon/love-lots
11663 * - emoticon/minimal-smile
11664 * - emoticon/not-happy
11665 * - emoticon/not-impressed
11667 * - emoticon/opensmile
11670 * - emoticon/squint-laugh
11671 * - emoticon/surprised
11672 * - emoticon/suspicious
11673 * - emoticon/tongue-dangling
11674 * - emoticon/tongue-poke
11676 * - emoticon/unhappy
11677 * - emoticon/very-sorry
11680 * - emoticon/worried
11683 * Alternatively, an item may reference an image by its path, using
11684 * the URI form @c file:///path/to/an/image.png and the entry will then
11685 * use that image for the item.
11687 * @section entry-files Loading and saving files
11689 * Entries have convinience functions to load text from a file and save
11690 * changes back to it after a short delay. The automatic saving is enabled
11691 * by default, but can be disabled with elm_entry_autosave_set() and files
11692 * can be loaded directly as plain text or have any markup in them
11693 * recognized. See elm_entry_file_set() for more details.
11695 * @section entry-signals Emitted signals
11697 * This widget emits the following signals:
11699 * @li "changed": The text within the entry was changed.
11700 * @li "changed,user": The text within the entry was changed because of user interaction.
11701 * @li "activated": The enter key was pressed on a single line entry.
11702 * @li "press": A mouse button has been pressed on the entry.
11703 * @li "longpressed": A mouse button has been pressed and held for a couple
11705 * @li "clicked": The entry has been clicked (mouse press and release).
11706 * @li "clicked,double": The entry has been double clicked.
11707 * @li "clicked,triple": The entry has been triple clicked.
11708 * @li "focused": The entry has received focus.
11709 * @li "unfocused": The entry has lost focus.
11710 * @li "selection,paste": A paste of the clipboard contents was requested.
11711 * @li "selection,copy": A copy of the selected text into the clipboard was
11713 * @li "selection,cut": A cut of the selected text into the clipboard was
11715 * @li "selection,start": A selection has begun and no previous selection
11717 * @li "selection,changed": The current selection has changed.
11718 * @li "selection,cleared": The current selection has been cleared.
11719 * @li "cursor,changed": The cursor has changed position.
11720 * @li "anchor,clicked": An anchor has been clicked. The event_info
11721 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11722 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11723 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11724 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11725 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11726 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11727 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11728 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11729 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11730 * @li "preedit,changed": The preedit string has changed.
11731 * @li "language,changed": Program language changed.
11733 * @section entry-examples
11735 * An overview of the Entry API can be seen in @ref entry_example_01
11741 * @typedef Elm_Entry_Anchor_Info
11743 * The info sent in the callback for the "anchor,clicked" signals emitted
11746 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11749 * @struct _Elm_Entry_Anchor_Info
11751 * The info sent in the callback for the "anchor,clicked" signals emitted
11754 struct _Elm_Entry_Anchor_Info
11756 const char *name; /**< The name of the anchor, as stated in its href */
11757 int button; /**< The mouse button used to click on it */
11758 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11759 y, /**< Anchor geometry, relative to canvas */
11760 w, /**< Anchor geometry, relative to canvas */
11761 h; /**< Anchor geometry, relative to canvas */
11765 * @typedef Elm_Entry_Filter_Cb
11766 * This callback type is used by entry filters to modify text.
11767 * @param data The data specified as the last param when adding the filter
11768 * @param entry The entry object
11769 * @param text A pointer to the location of the text being filtered. This data can be modified,
11770 * but any additional allocations must be managed by the user.
11771 * @see elm_entry_text_filter_append
11772 * @see elm_entry_text_filter_prepend
11774 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11777 * @typedef Elm_Entry_Change_Info
11778 * This corresponds to Edje_Entry_Change_Info. Includes information about
11779 * a change in the entry.
11781 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11785 * This adds an entry to @p parent object.
11787 * By default, entries are:
11791 * @li autosave is enabled
11793 * @param parent The parent object
11794 * @return The new object or NULL if it cannot be created
11796 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11799 * Sets the entry to single line mode.
11801 * In single line mode, entries don't ever wrap when the text reaches the
11802 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11803 * key will generate an @c "activate" event instead of adding a new line.
11805 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11806 * and pressing enter will break the text into a different line
11807 * without generating any events.
11809 * @param obj The entry object
11810 * @param single_line If true, the text in the entry
11811 * will be on a single line.
11813 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11816 * Gets whether the entry is set to be single line.
11818 * @param obj The entry object
11819 * @return single_line If true, the text in the entry is set to display
11820 * on a single line.
11822 * @see elm_entry_single_line_set()
11824 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11827 * Sets the entry to password mode.
11829 * In password mode, entries are implicitly single line and the display of
11830 * any text in them is replaced with asterisks (*).
11832 * @param obj The entry object
11833 * @param password If true, password mode is enabled.
11835 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11838 * Gets whether the entry is set to password mode.
11840 * @param obj The entry object
11841 * @return If true, the entry is set to display all characters
11842 * as asterisks (*).
11844 * @see elm_entry_password_set()
11846 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11849 * This sets the text displayed within the entry to @p entry.
11851 * @param obj The entry object
11852 * @param entry The text to be displayed
11854 * @deprecated Use elm_object_text_set() instead.
11855 * @note Using this function bypasses text filters
11857 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11860 * This returns the text currently shown in object @p entry.
11861 * See also elm_entry_entry_set().
11863 * @param obj The entry object
11864 * @return The currently displayed text or NULL on failure
11866 * @deprecated Use elm_object_text_get() instead.
11868 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11871 * Appends @p entry to the text of the entry.
11873 * Adds the text in @p entry to the end of any text already present in the
11876 * The appended text is subject to any filters set for the widget.
11878 * @param obj The entry object
11879 * @param entry The text to be displayed
11881 * @see elm_entry_text_filter_append()
11883 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11886 * Gets whether the entry is empty.
11888 * Empty means no text at all. If there are any markup tags, like an item
11889 * tag for which no provider finds anything, and no text is displayed, this
11890 * function still returns EINA_FALSE.
11892 * @param obj The entry object
11893 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11895 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11898 * Gets any selected text within the entry.
11900 * If there's any selected text in the entry, this function returns it as
11901 * a string in markup format. NULL is returned if no selection exists or
11902 * if an error occurred.
11904 * The returned value points to an internal string and should not be freed
11905 * or modified in any way. If the @p entry object is deleted or its
11906 * contents are changed, the returned pointer should be considered invalid.
11908 * @param obj The entry object
11909 * @return The selected text within the entry or NULL on failure
11911 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11914 * Returns the actual textblock object of the entry.
11916 * This function exposes the internal textblock object that actually
11917 * contains and draws the text. This should be used for low-level
11918 * manipulations that are otherwise not possible.
11920 * Changing the textblock directly from here will not notify edje/elm to
11921 * recalculate the textblock size automatically, so any modifications
11922 * done to the textblock returned by this function should be followed by
11923 * a call to elm_entry_calc_force().
11925 * The return value is marked as const as an additional warning.
11926 * One should not use the returned object with any of the generic evas
11927 * functions (geometry_get/resize/move and etc), but only with the textblock
11928 * functions; The former will either not work at all, or break the correct
11931 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11932 * the internal textblock object. Do NOT cache the returned object, and try
11933 * not to mix calls on this object with regular elm_entry calls (which may
11934 * change the internal textblock object). This applies to all cursors
11935 * returned from textblock calls, and all the other derivative values.
11937 * @param obj The entry object
11938 * @return The textblock object.
11940 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11943 * Forces calculation of the entry size and text layouting.
11945 * This should be used after modifying the textblock object directly. See
11946 * elm_entry_textblock_get() for more information.
11948 * @param obj The entry object
11950 * @see elm_entry_textblock_get()
11952 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11955 * Inserts the given text into the entry at the current cursor position.
11957 * This inserts text at the cursor position as if it was typed
11958 * by the user (note that this also allows markup which a user
11959 * can't just "type" as it would be converted to escaped text, so this
11960 * call can be used to insert things like emoticon items or bold push/pop
11961 * tags, other font and color change tags etc.)
11963 * If any selection exists, it will be replaced by the inserted text.
11965 * The inserted text is subject to any filters set for the widget.
11967 * @param obj The entry object
11968 * @param entry The text to insert
11970 * @see elm_entry_text_filter_append()
11972 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11975 * Set the line wrap type to use on multi-line entries.
11977 * Sets the wrap type used by the entry to any of the specified in
11978 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11979 * line (without inserting a line break or paragraph separator) when it
11980 * reaches the far edge of the widget.
11982 * Note that this only makes sense for multi-line entries. A widget set
11983 * to be single line will never wrap.
11985 * @param obj The entry object
11986 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11988 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11991 * Gets the wrap mode the entry was set to use.
11993 * @param obj The entry object
11994 * @return Wrap type
11996 * @see also elm_entry_line_wrap_set()
11998 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12001 * Sets if the entry is to be editable or not.
12003 * By default, entries are editable and when focused, any text input by the
12004 * user will be inserted at the current cursor position. But calling this
12005 * function with @p editable as EINA_FALSE will prevent the user from
12006 * inputting text into the entry.
12008 * The only way to change the text of a non-editable entry is to use
12009 * elm_object_text_set(), elm_entry_entry_insert() and other related
12012 * @param obj The entry object
12013 * @param editable If EINA_TRUE, user input will be inserted in the entry,
12014 * if not, the entry is read-only and no user input is allowed.
12016 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12019 * Gets whether the entry is editable or not.
12021 * @param obj The entry object
12022 * @return If true, the entry is editable by the user.
12023 * If false, it is not editable by the user
12025 * @see elm_entry_editable_set()
12027 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12030 * This drops any existing text selection within the entry.
12032 * @param obj The entry object
12034 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12037 * This selects all text within the entry.
12039 * @param obj The entry object
12041 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12044 * This moves the cursor one place to the right within the entry.
12046 * @param obj The entry object
12047 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12049 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12052 * This moves the cursor one place to the left within the entry.
12054 * @param obj The entry object
12055 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12057 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12060 * This moves the cursor one line up within the entry.
12062 * @param obj The entry object
12063 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12065 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12068 * This moves the cursor one line down within the entry.
12070 * @param obj The entry object
12071 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12073 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12076 * This moves the cursor to the beginning of the entry.
12078 * @param obj The entry object
12080 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12083 * This moves the cursor to the end of the entry.
12085 * @param obj The entry object
12087 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12090 * This moves the cursor to the beginning of the current line.
12092 * @param obj The entry object
12094 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12097 * This moves the cursor to the end of the current line.
12099 * @param obj The entry object
12101 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12104 * This begins a selection within the entry as though
12105 * the user were holding down the mouse button to make a selection.
12107 * @param obj The entry object
12109 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12112 * This ends a selection within the entry as though
12113 * the user had just released the mouse button while making a selection.
12115 * @param obj The entry object
12117 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12120 * Gets whether a format node exists at the current cursor position.
12122 * A format node is anything that defines how the text is rendered. It can
12123 * be a visible format node, such as a line break or a paragraph separator,
12124 * or an invisible one, such as bold begin or end tag.
12125 * This function returns whether any format node exists at the current
12128 * @param obj The entry object
12129 * @return EINA_TRUE if the current cursor position contains a format node,
12130 * EINA_FALSE otherwise.
12132 * @see elm_entry_cursor_is_visible_format_get()
12134 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12137 * Gets if the current cursor position holds a visible format node.
12139 * @param obj The entry object
12140 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
12141 * if it's an invisible one or no format exists.
12143 * @see elm_entry_cursor_is_format_get()
12145 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12148 * Gets the character pointed by the cursor at its current position.
12150 * This function returns a string with the utf8 character stored at the
12151 * current cursor position.
12152 * Only the text is returned, any format that may exist will not be part
12153 * of the return value.
12155 * @param obj The entry object
12156 * @return The text pointed by the cursors.
12158 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12161 * This function returns the geometry of the cursor.
12163 * It's useful if you want to draw something on the cursor (or where it is),
12164 * or for example in the case of scrolled entry where you want to show the
12167 * @param obj The entry object
12168 * @param x returned geometry
12169 * @param y returned geometry
12170 * @param w returned geometry
12171 * @param h returned geometry
12172 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12174 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);
12177 * Sets the cursor position in the entry to the given value
12179 * The value in @p pos is the index of the character position within the
12180 * contents of the string as returned by elm_entry_cursor_pos_get().
12182 * @param obj The entry object
12183 * @param pos The position of the cursor
12185 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12188 * Retrieves the current position of the cursor in the entry
12190 * @param obj The entry object
12191 * @return The cursor position
12193 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12196 * This executes a "cut" action on the selected text in the entry.
12198 * @param obj The entry object
12200 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12203 * This executes a "copy" action on the selected text in the entry.
12205 * @param obj The entry object
12207 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12210 * This executes a "paste" action in the entry.
12212 * @param obj The entry object
12214 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12217 * This clears and frees the items in a entry's contextual (longpress)
12220 * @param obj The entry object
12222 * @see elm_entry_context_menu_item_add()
12224 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12227 * This adds an item to the entry's contextual menu.
12229 * A longpress on an entry will make the contextual menu show up, if this
12230 * hasn't been disabled with elm_entry_context_menu_disabled_set().
12231 * By default, this menu provides a few options like enabling selection mode,
12232 * which is useful on embedded devices that need to be explicit about it,
12233 * and when a selection exists it also shows the copy and cut actions.
12235 * With this function, developers can add other options to this menu to
12236 * perform any action they deem necessary.
12238 * @param obj The entry object
12239 * @param label The item's text label
12240 * @param icon_file The item's icon file
12241 * @param icon_type The item's icon type
12242 * @param func The callback to execute when the item is clicked
12243 * @param data The data to associate with the item for related functions
12245 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);
12248 * This disables the entry's contextual (longpress) menu.
12250 * @param obj The entry object
12251 * @param disabled If true, the menu is disabled
12253 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12256 * This returns whether the entry's contextual (longpress) menu is
12259 * @param obj The entry object
12260 * @return If true, the menu is disabled
12262 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12265 * This appends a custom item provider to the list for that entry
12267 * This appends the given callback. The list is walked from beginning to end
12268 * with each function called given the item href string in the text. If the
12269 * function returns an object handle other than NULL (it should create an
12270 * object to do this), then this object is used to replace that item. If
12271 * not the next provider is called until one provides an item object, or the
12272 * default provider in entry does.
12274 * @param obj The entry object
12275 * @param func The function called to provide the item object
12276 * @param data The data passed to @p func
12278 * @see @ref entry-items
12280 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);
12283 * This prepends a custom item provider to the list for that entry
12285 * This prepends the given callback. See elm_entry_item_provider_append() for
12288 * @param obj The entry object
12289 * @param func The function called to provide the item object
12290 * @param data The data passed to @p func
12292 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);
12295 * This removes a custom item provider to the list for that entry
12297 * This removes the given callback. See elm_entry_item_provider_append() for
12300 * @param obj The entry object
12301 * @param func The function called to provide the item object
12302 * @param data The data passed to @p func
12304 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);
12307 * Append a filter function for text inserted in the entry
12309 * Append the given callback to the list. This functions will be called
12310 * whenever any text is inserted into the entry, with the text to be inserted
12311 * as a parameter. The callback function is free to alter the text in any way
12312 * it wants, but it must remember to free the given pointer and update it.
12313 * If the new text is to be discarded, the function can free it and set its
12314 * text parameter to NULL. This will also prevent any following filters from
12317 * @param obj The entry object
12318 * @param func The function to use as text filter
12319 * @param data User data to pass to @p func
12321 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12324 * Prepend a filter function for text insdrted in the entry
12326 * Prepend the given callback to the list. See elm_entry_text_filter_append()
12327 * for more information
12329 * @param obj The entry object
12330 * @param func The function to use as text filter
12331 * @param data User data to pass to @p func
12333 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12336 * Remove a filter from the list
12338 * Removes the given callback from the filter list. See
12339 * elm_entry_text_filter_append() for more information.
12341 * @param obj The entry object
12342 * @param func The filter function to remove
12343 * @param data The user data passed when adding the function
12345 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12348 * This converts a markup (HTML-like) string into UTF-8.
12350 * The returned string is a malloc'ed buffer and it should be freed when
12351 * not needed anymore.
12353 * @param s The string (in markup) to be converted
12354 * @return The converted string (in UTF-8). It should be freed.
12356 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12359 * This converts a UTF-8 string into markup (HTML-like).
12361 * The returned string is a malloc'ed buffer and it should be freed when
12362 * not needed anymore.
12364 * @param s The string (in UTF-8) to be converted
12365 * @return The converted string (in markup). It should be freed.
12367 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12370 * This sets the file (and implicitly loads it) for the text to display and
12371 * then edit. All changes are written back to the file after a short delay if
12372 * the entry object is set to autosave (which is the default).
12374 * If the entry had any other file set previously, any changes made to it
12375 * will be saved if the autosave feature is enabled, otherwise, the file
12376 * will be silently discarded and any non-saved changes will be lost.
12378 * @param obj The entry object
12379 * @param file The path to the file to load and save
12380 * @param format The file format
12382 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12385 * Gets the file being edited by the entry.
12387 * This function can be used to retrieve any file set on the entry for
12388 * edition, along with the format used to load and save it.
12390 * @param obj The entry object
12391 * @param file The path to the file to load and save
12392 * @param format The file format
12394 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12397 * This function writes any changes made to the file set with
12398 * elm_entry_file_set()
12400 * @param obj The entry object
12402 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12405 * This sets the entry object to 'autosave' the loaded text file or not.
12407 * @param obj The entry object
12408 * @param autosave Autosave the loaded file or not
12410 * @see elm_entry_file_set()
12412 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12415 * This gets the entry object's 'autosave' status.
12417 * @param obj The entry object
12418 * @return Autosave the loaded file or not
12420 * @see elm_entry_file_set()
12422 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12425 * Control pasting of text and images for the widget.
12427 * Normally the entry allows both text and images to be pasted. By setting
12428 * textonly to be true, this prevents images from being pasted.
12430 * Note this only changes the behaviour of text.
12432 * @param obj The entry object
12433 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12434 * text+image+other.
12436 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12439 * Getting elm_entry text paste/drop mode.
12441 * In textonly mode, only text may be pasted or dropped into the widget.
12443 * @param obj The entry object
12444 * @return If the widget only accepts text from pastes.
12446 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12449 * Enable or disable scrolling in entry
12451 * Normally the entry is not scrollable unless you enable it with this call.
12453 * @param obj The entry object
12454 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12456 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12459 * Get the scrollable state of the entry
12461 * Normally the entry is not scrollable. This gets the scrollable state
12462 * of the entry. See elm_entry_scrollable_set() for more information.
12464 * @param obj The entry object
12465 * @return The scrollable state
12467 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
12470 * This sets a widget to be displayed to the left of a scrolled entry.
12472 * @param obj The scrolled entry object
12473 * @param icon The widget to display on the left side of the scrolled
12476 * @note A previously set widget will be destroyed.
12477 * @note If the object being set does not have minimum size hints set,
12478 * it won't get properly displayed.
12480 * @see elm_entry_end_set()
12482 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12485 * Gets the leftmost widget of the scrolled entry. This object is
12486 * owned by the scrolled entry and should not be modified.
12488 * @param obj The scrolled entry object
12489 * @return the left widget inside the scroller
12491 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12494 * Unset the leftmost widget of the scrolled entry, unparenting and
12497 * @param obj The scrolled entry object
12498 * @return the previously set icon sub-object of this entry, on
12501 * @see elm_entry_icon_set()
12503 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12506 * Sets the visibility of the left-side widget of the scrolled entry,
12507 * set by elm_entry_icon_set().
12509 * @param obj The scrolled entry object
12510 * @param setting EINA_TRUE if the object should be displayed,
12511 * EINA_FALSE if not.
12513 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12516 * This sets a widget to be displayed to the end of a scrolled entry.
12518 * @param obj The scrolled entry object
12519 * @param end The widget to display on the right side of the scrolled
12522 * @note A previously set widget will be destroyed.
12523 * @note If the object being set does not have minimum size hints set,
12524 * it won't get properly displayed.
12526 * @see elm_entry_icon_set
12528 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12531 * Gets the endmost widget of the scrolled entry. This object is owned
12532 * by the scrolled entry and should not be modified.
12534 * @param obj The scrolled entry object
12535 * @return the right widget inside the scroller
12537 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12540 * Unset the endmost widget of the scrolled entry, unparenting and
12543 * @param obj The scrolled entry object
12544 * @return the previously set icon sub-object of this entry, on
12547 * @see elm_entry_icon_set()
12549 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12552 * Sets the visibility of the end widget of the scrolled entry, set by
12553 * elm_entry_end_set().
12555 * @param obj The scrolled entry object
12556 * @param setting EINA_TRUE if the object should be displayed,
12557 * EINA_FALSE if not.
12559 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12562 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12565 * Setting an entry to single-line mode with elm_entry_single_line_set()
12566 * will automatically disable the display of scrollbars when the entry
12567 * moves inside its scroller.
12569 * @param obj The scrolled entry object
12570 * @param h The horizontal scrollbar policy to apply
12571 * @param v The vertical scrollbar policy to apply
12573 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12576 * This enables/disables bouncing within the entry.
12578 * This function sets whether the entry will bounce when scrolling reaches
12579 * the end of the contained entry.
12581 * @param obj The scrolled entry object
12582 * @param h The horizontal bounce state
12583 * @param v The vertical bounce state
12585 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12588 * Get the bounce mode
12590 * @param obj The Entry object
12591 * @param h_bounce Allow bounce horizontally
12592 * @param v_bounce Allow bounce vertically
12594 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12596 /* pre-made filters for entries */
12598 * @typedef Elm_Entry_Filter_Limit_Size
12600 * Data for the elm_entry_filter_limit_size() entry filter.
12602 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12605 * @struct _Elm_Entry_Filter_Limit_Size
12607 * Data for the elm_entry_filter_limit_size() entry filter.
12609 struct _Elm_Entry_Filter_Limit_Size
12611 int max_char_count; /**< The maximum number of characters allowed. */
12612 int max_byte_count; /**< The maximum number of bytes allowed*/
12616 * Filter inserted text based on user defined character and byte limits
12618 * Add this filter to an entry to limit the characters that it will accept
12619 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12620 * The funtion works on the UTF-8 representation of the string, converting
12621 * it from the set markup, thus not accounting for any format in it.
12623 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12624 * it as data when setting the filter. In it, it's possible to set limits
12625 * by character count or bytes (any of them is disabled if 0), and both can
12626 * be set at the same time. In that case, it first checks for characters,
12629 * The function will cut the inserted text in order to allow only the first
12630 * number of characters that are still allowed. The cut is made in
12631 * characters, even when limiting by bytes, in order to always contain
12632 * valid ones and avoid half unicode characters making it in.
12634 * This filter, like any others, does not apply when setting the entry text
12635 * directly with elm_object_text_set() (or the deprecated
12636 * elm_entry_entry_set()).
12638 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12641 * @typedef Elm_Entry_Filter_Accept_Set
12643 * Data for the elm_entry_filter_accept_set() entry filter.
12645 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12648 * @struct _Elm_Entry_Filter_Accept_Set
12650 * Data for the elm_entry_filter_accept_set() entry filter.
12652 struct _Elm_Entry_Filter_Accept_Set
12654 const char *accepted; /**< Set of characters accepted in the entry. */
12655 const char *rejected; /**< Set of characters rejected from the entry. */
12659 * Filter inserted text based on accepted or rejected sets of characters
12661 * Add this filter to an entry to restrict the set of accepted characters
12662 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12663 * This structure contains both accepted and rejected sets, but they are
12664 * mutually exclusive.
12666 * The @c accepted set takes preference, so if it is set, the filter will
12667 * only work based on the accepted characters, ignoring anything in the
12668 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12670 * In both cases, the function filters by matching utf8 characters to the
12671 * raw markup text, so it can be used to remove formatting tags.
12673 * This filter, like any others, does not apply when setting the entry text
12674 * directly with elm_object_text_set() (or the deprecated
12675 * elm_entry_entry_set()).
12677 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12679 * Set the input panel layout of the entry
12681 * @param obj The entry object
12682 * @param layout layout type
12684 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12687 * Get the input panel layout of the entry
12689 * @param obj The entry object
12690 * @return layout type
12692 * @see elm_entry_input_panel_layout_set
12694 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12697 * Set the autocapitalization type on the immodule.
12699 * @param obj The entry object
12700 * @param autocapital_type The type of autocapitalization
12702 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12705 * Retrieve the autocapitalization type on the immodule.
12707 * @param obj The entry object
12708 * @return autocapitalization type
12710 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12713 * Sets the attribute to show the input panel automatically.
12715 * @param obj The entry object
12716 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12718 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12721 * Retrieve the attribute to show the input panel automatically.
12723 * @param obj The entry object
12724 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12726 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12732 /* composite widgets - these basically put together basic widgets above
12733 * in convenient packages that do more than basic stuff */
12737 * @defgroup Anchorview Anchorview
12739 * @image html img/widget/anchorview/preview-00.png
12740 * @image latex img/widget/anchorview/preview-00.eps
12742 * Anchorview is for displaying text that contains markup with anchors
12743 * like <c>\<a href=1234\>something\</\></c> in it.
12745 * Besides being styled differently, the anchorview widget provides the
12746 * necessary functionality so that clicking on these anchors brings up a
12747 * popup with user defined content such as "call", "add to contacts" or
12748 * "open web page". This popup is provided using the @ref Hover widget.
12750 * This widget is very similar to @ref Anchorblock, so refer to that
12751 * widget for an example. The only difference Anchorview has is that the
12752 * widget is already provided with scrolling functionality, so if the
12753 * text set to it is too large to fit in the given space, it will scroll,
12754 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12755 * text can be displayed.
12757 * This widget emits the following signals:
12758 * @li "anchor,clicked": will be called when an anchor is clicked. The
12759 * @p event_info parameter on the callback will be a pointer of type
12760 * ::Elm_Entry_Anchorview_Info.
12762 * See @ref Anchorblock for an example on how to use both of them.
12772 * @typedef Elm_Entry_Anchorview_Info
12774 * The info sent in the callback for "anchor,clicked" signals emitted by
12775 * the Anchorview widget.
12777 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12780 * @struct _Elm_Entry_Anchorview_Info
12782 * The info sent in the callback for "anchor,clicked" signals emitted by
12783 * the Anchorview widget.
12785 struct _Elm_Entry_Anchorview_Info
12787 const char *name; /**< Name of the anchor, as indicated in its href
12789 int button; /**< The mouse button used to click on it */
12790 Evas_Object *hover; /**< The hover object to use for the popup */
12792 Evas_Coord x, y, w, h;
12793 } anchor, /**< Geometry selection of text used as anchor */
12794 hover_parent; /**< Geometry of the object used as parent by the
12796 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12797 for content on the left side of
12798 the hover. Before calling the
12799 callback, the widget will make the
12800 necessary calculations to check
12801 which sides are fit to be set with
12802 content, based on the position the
12803 hover is activated and its distance
12804 to the edges of its parent object
12806 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12807 the right side of the hover.
12808 See @ref hover_left */
12809 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12810 of the hover. See @ref hover_left */
12811 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12812 below the hover. See @ref
12817 * Add a new Anchorview object
12819 * @param parent The parent object
12820 * @return The new object or NULL if it cannot be created
12822 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12825 * Set the text to show in the anchorview
12827 * Sets the text of the anchorview to @p text. This text can include markup
12828 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12829 * text that will be specially styled and react to click events, ended with
12830 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12831 * "anchor,clicked" signal that you can attach a callback to with
12832 * evas_object_smart_callback_add(). The name of the anchor given in the
12833 * event info struct will be the one set in the href attribute, in this
12834 * case, anchorname.
12836 * Other markup can be used to style the text in different ways, but it's
12837 * up to the style defined in the theme which tags do what.
12838 * @deprecated use elm_object_text_set() instead.
12840 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12843 * Get the markup text set for the anchorview
12845 * Retrieves the text set on the anchorview, with markup tags included.
12847 * @param obj The anchorview object
12848 * @return The markup text set or @c NULL if nothing was set or an error
12850 * @deprecated use elm_object_text_set() instead.
12852 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12855 * Set the parent of the hover popup
12857 * Sets the parent object to use by the hover created by the anchorview
12858 * when an anchor is clicked. See @ref Hover for more details on this.
12859 * If no parent is set, the same anchorview object will be used.
12861 * @param obj The anchorview object
12862 * @param parent The object to use as parent for the hover
12864 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12867 * Get the parent of the hover popup
12869 * Get the object used as parent for the hover created by the anchorview
12870 * widget. See @ref Hover for more details on this.
12872 * @param obj The anchorview object
12873 * @return The object used as parent for the hover, NULL if none is set.
12875 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12878 * Set the style that the hover should use
12880 * When creating the popup hover, anchorview will request that it's
12881 * themed according to @p style.
12883 * @param obj The anchorview object
12884 * @param style The style to use for the underlying hover
12886 * @see elm_object_style_set()
12888 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12891 * Get the style that the hover should use
12893 * Get the style the hover created by anchorview will use.
12895 * @param obj The anchorview object
12896 * @return The style to use by the hover. NULL means the default is used.
12898 * @see elm_object_style_set()
12900 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12903 * Ends the hover popup in the anchorview
12905 * When an anchor is clicked, the anchorview widget will create a hover
12906 * object to use as a popup with user provided content. This function
12907 * terminates this popup, returning the anchorview to its normal state.
12909 * @param obj The anchorview object
12911 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12914 * Set bouncing behaviour when the scrolled content reaches an edge
12916 * Tell the internal scroller object whether it should bounce or not
12917 * when it reaches the respective edges for each axis.
12919 * @param obj The anchorview object
12920 * @param h_bounce Whether to bounce or not in the horizontal axis
12921 * @param v_bounce Whether to bounce or not in the vertical axis
12923 * @see elm_scroller_bounce_set()
12925 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12928 * Get the set bouncing behaviour of the internal scroller
12930 * Get whether the internal scroller should bounce when the edge of each
12931 * axis is reached scrolling.
12933 * @param obj The anchorview object
12934 * @param h_bounce Pointer where to store the bounce state of the horizontal
12936 * @param v_bounce Pointer where to store the bounce state of the vertical
12939 * @see elm_scroller_bounce_get()
12941 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12944 * Appends a custom item provider to the given anchorview
12946 * Appends the given function to the list of items providers. This list is
12947 * called, one function at a time, with the given @p data pointer, the
12948 * anchorview object and, in the @p item parameter, the item name as
12949 * referenced in its href string. Following functions in the list will be
12950 * called in order until one of them returns something different to NULL,
12951 * which should be an Evas_Object which will be used in place of the item
12954 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12955 * href=item/name\>\</item\>
12957 * @param obj The anchorview object
12958 * @param func The function to add to the list of providers
12959 * @param data User data that will be passed to the callback function
12961 * @see elm_entry_item_provider_append()
12963 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);
12966 * Prepend a custom item provider to the given anchorview
12968 * Like elm_anchorview_item_provider_append(), but it adds the function
12969 * @p func to the beginning of the list, instead of the end.
12971 * @param obj The anchorview object
12972 * @param func The function to add to the list of providers
12973 * @param data User data that will be passed to the callback function
12975 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);
12978 * Remove a custom item provider from the list of the given anchorview
12980 * Removes the function and data pairing that matches @p func and @p data.
12981 * That is, unless the same function and same user data are given, the
12982 * function will not be removed from the list. This allows us to add the
12983 * same callback several times, with different @p data pointers and be
12984 * able to remove them later without conflicts.
12986 * @param obj The anchorview object
12987 * @param func The function to remove from the list
12988 * @param data The data matching the function to remove from the list
12990 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);
12998 * @defgroup Anchorblock Anchorblock
13000 * @image html img/widget/anchorblock/preview-00.png
13001 * @image latex img/widget/anchorblock/preview-00.eps
13003 * Anchorblock is for displaying text that contains markup with anchors
13004 * like <c>\<a href=1234\>something\</\></c> in it.
13006 * Besides being styled differently, the anchorblock widget provides the
13007 * necessary functionality so that clicking on these anchors brings up a
13008 * popup with user defined content such as "call", "add to contacts" or
13009 * "open web page". This popup is provided using the @ref Hover widget.
13011 * This widget emits the following signals:
13012 * @li "anchor,clicked": will be called when an anchor is clicked. The
13013 * @p event_info parameter on the callback will be a pointer of type
13014 * ::Elm_Entry_Anchorblock_Info.
13020 * Since examples are usually better than plain words, we might as well
13021 * try @ref tutorial_anchorblock_example "one".
13025 * @addtogroup Anchorblock
13030 * @typedef Elm_Entry_Anchorblock_Info
13032 * The info sent in the callback for "anchor,clicked" signals emitted by
13033 * the Anchorblock widget.
13035 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
13038 * @struct _Elm_Entry_Anchorblock_Info
13040 * The info sent in the callback for "anchor,clicked" signals emitted by
13041 * the Anchorblock widget.
13043 struct _Elm_Entry_Anchorblock_Info
13045 const char *name; /**< Name of the anchor, as indicated in its href
13047 int button; /**< The mouse button used to click on it */
13048 Evas_Object *hover; /**< The hover object to use for the popup */
13050 Evas_Coord x, y, w, h;
13051 } anchor, /**< Geometry selection of text used as anchor */
13052 hover_parent; /**< Geometry of the object used as parent by the
13054 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
13055 for content on the left side of
13056 the hover. Before calling the
13057 callback, the widget will make the
13058 necessary calculations to check
13059 which sides are fit to be set with
13060 content, based on the position the
13061 hover is activated and its distance
13062 to the edges of its parent object
13064 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
13065 the right side of the hover.
13066 See @ref hover_left */
13067 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
13068 of the hover. See @ref hover_left */
13069 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
13070 below the hover. See @ref
13075 * Add a new Anchorblock object
13077 * @param parent The parent object
13078 * @return The new object or NULL if it cannot be created
13080 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13083 * Set the text to show in the anchorblock
13085 * Sets the text of the anchorblock to @p text. This text can include markup
13086 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
13087 * of text that will be specially styled and react to click events, ended
13088 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
13089 * "anchor,clicked" signal that you can attach a callback to with
13090 * evas_object_smart_callback_add(). The name of the anchor given in the
13091 * event info struct will be the one set in the href attribute, in this
13092 * case, anchorname.
13094 * Other markup can be used to style the text in different ways, but it's
13095 * up to the style defined in the theme which tags do what.
13096 * @deprecated use elm_object_text_set() instead.
13098 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
13101 * Get the markup text set for the anchorblock
13103 * Retrieves the text set on the anchorblock, with markup tags included.
13105 * @param obj The anchorblock object
13106 * @return The markup text set or @c NULL if nothing was set or an error
13108 * @deprecated use elm_object_text_set() instead.
13110 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13113 * Set the parent of the hover popup
13115 * Sets the parent object to use by the hover created by the anchorblock
13116 * when an anchor is clicked. See @ref Hover for more details on this.
13118 * @param obj The anchorblock object
13119 * @param parent The object to use as parent for the hover
13121 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13124 * Get the parent of the hover popup
13126 * Get the object used as parent for the hover created by the anchorblock
13127 * widget. See @ref Hover for more details on this.
13128 * If no parent is set, the same anchorblock object will be used.
13130 * @param obj The anchorblock object
13131 * @return The object used as parent for the hover, NULL if none is set.
13133 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13136 * Set the style that the hover should use
13138 * When creating the popup hover, anchorblock will request that it's
13139 * themed according to @p style.
13141 * @param obj The anchorblock object
13142 * @param style The style to use for the underlying hover
13144 * @see elm_object_style_set()
13146 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13149 * Get the style that the hover should use
13151 * Get the style, the hover created by anchorblock will use.
13153 * @param obj The anchorblock object
13154 * @return The style to use by the hover. NULL means the default is used.
13156 * @see elm_object_style_set()
13158 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13161 * Ends the hover popup in the anchorblock
13163 * When an anchor is clicked, the anchorblock widget will create a hover
13164 * object to use as a popup with user provided content. This function
13165 * terminates this popup, returning the anchorblock to its normal state.
13167 * @param obj The anchorblock object
13169 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13172 * Appends a custom item provider to the given anchorblock
13174 * Appends the given function to the list of items providers. This list is
13175 * called, one function at a time, with the given @p data pointer, the
13176 * anchorblock object and, in the @p item parameter, the item name as
13177 * referenced in its href string. Following functions in the list will be
13178 * called in order until one of them returns something different to NULL,
13179 * which should be an Evas_Object which will be used in place of the item
13182 * Items in the markup text take the form \<item relsize=16x16 vsize=full
13183 * href=item/name\>\</item\>
13185 * @param obj The anchorblock object
13186 * @param func The function to add to the list of providers
13187 * @param data User data that will be passed to the callback function
13189 * @see elm_entry_item_provider_append()
13191 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);
13194 * Prepend a custom item provider to the given anchorblock
13196 * Like elm_anchorblock_item_provider_append(), but it adds the function
13197 * @p func to the beginning of the list, instead of the end.
13199 * @param obj The anchorblock object
13200 * @param func The function to add to the list of providers
13201 * @param data User data that will be passed to the callback function
13203 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);
13206 * Remove a custom item provider from the list of the given anchorblock
13208 * Removes the function and data pairing that matches @p func and @p data.
13209 * That is, unless the same function and same user data are given, the
13210 * function will not be removed from the list. This allows us to add the
13211 * same callback several times, with different @p data pointers and be
13212 * able to remove them later without conflicts.
13214 * @param obj The anchorblock object
13215 * @param func The function to remove from the list
13216 * @param data The data matching the function to remove from the list
13218 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);
13225 * @defgroup Bubble Bubble
13227 * @image html img/widget/bubble/preview-00.png
13228 * @image latex img/widget/bubble/preview-00.eps
13229 * @image html img/widget/bubble/preview-01.png
13230 * @image latex img/widget/bubble/preview-01.eps
13231 * @image html img/widget/bubble/preview-02.png
13232 * @image latex img/widget/bubble/preview-02.eps
13234 * @brief The Bubble is a widget to show text similar to how speech is
13235 * represented in comics.
13237 * The bubble widget contains 5 important visual elements:
13238 * @li The frame is a rectangle with rounded edjes and an "arrow".
13239 * @li The @p icon is an image to which the frame's arrow points to.
13240 * @li The @p label is a text which appears to the right of the icon if the
13241 * corner is "top_left" or "bottom_left" and is right aligned to the frame
13243 * @li The @p info is a text which appears to the right of the label. Info's
13244 * font is of a ligther color than label.
13245 * @li The @p content is an evas object that is shown inside the frame.
13247 * The position of the arrow, icon, label and info depends on which corner is
13248 * selected. The four available corners are:
13249 * @li "top_left" - Default
13251 * @li "bottom_left"
13252 * @li "bottom_right"
13254 * Signals that you can add callbacks for are:
13255 * @li "clicked" - This is called when a user has clicked the bubble.
13257 * Default contents parts of the bubble that you can use for are:
13258 * @li "default" - A content of the bubble
13259 * @li "icon" - An icon of the bubble
13261 * Default text parts of the button widget that you can use for are:
13262 * @li NULL - Label of the bubble
13264 * For an example of using a buble see @ref bubble_01_example_page "this".
13270 * Add a new bubble to the parent
13272 * @param parent The parent object
13273 * @return The new object or NULL if it cannot be created
13275 * This function adds a text bubble to the given parent evas object.
13277 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13280 * Set the label of the bubble
13282 * @param obj The bubble object
13283 * @param label The string to set in the label
13285 * This function sets the title of the bubble. Where this appears depends on
13286 * the selected corner.
13287 * @deprecated use elm_object_text_set() instead.
13289 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13292 * Get the label of the bubble
13294 * @param obj The bubble object
13295 * @return The string of set in the label
13297 * This function gets the title of the bubble.
13298 * @deprecated use elm_object_text_get() instead.
13300 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13303 * Set the info of the bubble
13305 * @param obj The bubble object
13306 * @param info The given info about the bubble
13308 * This function sets the info of the bubble. Where this appears depends on
13309 * the selected corner.
13310 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
13312 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
13315 * Get the info of the bubble
13317 * @param obj The bubble object
13319 * @return The "info" string of the bubble
13321 * This function gets the info text.
13322 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
13324 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13327 * Set the content to be shown in the bubble
13329 * Once the content object is set, a previously set one will be deleted.
13330 * If you want to keep the old content object, use the
13331 * elm_bubble_content_unset() function.
13333 * @param obj The bubble object
13334 * @param content The given content of the bubble
13336 * This function sets the content shown on the middle of the bubble.
13338 * @deprecated use elm_object_content_set() instead
13341 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13344 * Get the content shown in the bubble
13346 * Return the content object which is set for this widget.
13348 * @param obj The bubble object
13349 * @return The content that is being used
13351 * @deprecated use elm_object_content_get() instead
13354 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13357 * Unset the content shown in the bubble
13359 * Unparent and return the content object which was set for this widget.
13361 * @param obj The bubble object
13362 * @return The content that was being used
13364 * @deprecated use elm_object_content_unset() instead
13367 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13370 * Set the icon of the bubble
13372 * Once the icon object is set, a previously set one will be deleted.
13373 * If you want to keep the old content object, use the
13374 * elm_icon_content_unset() function.
13376 * @param obj The bubble object
13377 * @param icon The given icon for the bubble
13379 * @deprecated use elm_object_part_content_set() instead
13382 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13385 * Get the icon of the bubble
13387 * @param obj The bubble object
13388 * @return The icon for the bubble
13390 * This function gets the icon shown on the top left of bubble.
13392 * @deprecated use elm_object_part_content_get() instead
13395 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13398 * Unset the icon of the bubble
13400 * Unparent and return the icon object which was set for this widget.
13402 * @param obj The bubble object
13403 * @return The icon that was being used
13405 * @deprecated use elm_object_part_content_unset() instead
13408 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13411 * Set the corner of the bubble
13413 * @param obj The bubble object.
13414 * @param corner The given corner for the bubble.
13416 * This function sets the corner of the bubble. The corner will be used to
13417 * determine where the arrow in the frame points to and where label, icon and
13420 * Possible values for corner are:
13421 * @li "top_left" - Default
13423 * @li "bottom_left"
13424 * @li "bottom_right"
13426 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
13429 * Get the corner of the bubble
13431 * @param obj The bubble object.
13432 * @return The given corner for the bubble.
13434 * This function gets the selected corner of the bubble.
13436 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13443 * @defgroup Photo Photo
13445 * For displaying the photo of a person (contact). Simple, yet
13446 * with a very specific purpose.
13448 * Signals that you can add callbacks for are:
13450 * "clicked" - This is called when a user has clicked the photo
13451 * "drag,start" - Someone started dragging the image out of the object
13452 * "drag,end" - Dragged item was dropped (somewhere)
13458 * Add a new photo to the parent
13460 * @param parent The parent object
13461 * @return The new object or NULL if it cannot be created
13465 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13468 * Set the file that will be used as photo
13470 * @param obj The photo object
13471 * @param file The path to file that will be used as photo
13473 * @return (1 = success, 0 = error)
13477 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13480 * Set the file that will be used as thumbnail in the photo.
13482 * @param obj The photo object.
13483 * @param file The path to file that will be used as thumb.
13484 * @param group The key used in case of an EET file.
13488 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13491 * Set the size that will be used on the photo
13493 * @param obj The photo object
13494 * @param size The size that the photo will be
13498 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13501 * Set if the photo should be completely visible or not.
13503 * @param obj The photo object
13504 * @param fill if true the photo will be completely visible
13508 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13511 * Set editability of the photo.
13513 * An editable photo can be dragged to or from, and can be cut or
13514 * pasted too. Note that pasting an image or dropping an item on
13515 * the image will delete the existing content.
13517 * @param obj The photo object.
13518 * @param set To set of clear editablity.
13520 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13526 /* gesture layer */
13528 * @defgroup Elm_Gesture_Layer Gesture Layer
13529 * Gesture Layer Usage:
13531 * Use Gesture Layer to detect gestures.
13532 * The advantage is that you don't have to implement
13533 * gesture detection, just set callbacks of gesture state.
13534 * By using gesture layer we make standard interface.
13536 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13537 * with a parent object parameter.
13538 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13539 * call. Usually with same object as target (2nd parameter).
13541 * Now you need to tell gesture layer what gestures you follow.
13542 * This is done with @ref elm_gesture_layer_cb_set call.
13543 * By setting the callback you actually saying to gesture layer:
13544 * I would like to know when the gesture @ref Elm_Gesture_Types
13545 * switches to state @ref Elm_Gesture_State.
13547 * Next, you need to implement the actual action that follows the input
13548 * in your callback.
13550 * Note that if you like to stop being reported about a gesture, just set
13551 * all callbacks referring this gesture to NULL.
13552 * (again with @ref elm_gesture_layer_cb_set)
13554 * The information reported by gesture layer to your callback is depending
13555 * on @ref Elm_Gesture_Types:
13556 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13557 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13558 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13560 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13561 * @ref ELM_GESTURE_MOMENTUM.
13563 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13564 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13565 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13566 * Note that we consider a flick as a line-gesture that should be completed
13567 * in flick-time-limit as defined in @ref Config.
13569 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13571 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13574 * Gesture Layer Tweaks:
13576 * Note that line, flick, gestures can start without the need to remove fingers from surface.
13577 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13579 * Setting glayer_continues_enable to false in @ref Config will change this behavior
13580 * so gesture starts when user touches (a *DOWN event) touch-surface
13581 * and ends when no fingers touches surface (a *UP event).
13585 * @enum _Elm_Gesture_Types
13586 * Enum of supported gesture types.
13587 * @ingroup Elm_Gesture_Layer
13589 enum _Elm_Gesture_Types
13591 ELM_GESTURE_FIRST = 0,
13593 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13594 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13595 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13596 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13598 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13600 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13601 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13603 ELM_GESTURE_ZOOM, /**< Zoom */
13604 ELM_GESTURE_ROTATE, /**< Rotate */
13610 * @typedef Elm_Gesture_Types
13611 * gesture types enum
13612 * @ingroup Elm_Gesture_Layer
13614 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13617 * @enum _Elm_Gesture_State
13618 * Enum of gesture states.
13619 * @ingroup Elm_Gesture_Layer
13621 enum _Elm_Gesture_State
13623 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13624 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
13625 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
13626 ELM_GESTURE_STATE_END, /**< Gesture completed */
13627 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
13631 * @typedef Elm_Gesture_State
13632 * gesture states enum
13633 * @ingroup Elm_Gesture_Layer
13635 typedef enum _Elm_Gesture_State Elm_Gesture_State;
13638 * @struct _Elm_Gesture_Taps_Info
13639 * Struct holds taps info for user
13640 * @ingroup Elm_Gesture_Layer
13642 struct _Elm_Gesture_Taps_Info
13644 Evas_Coord x, y; /**< Holds center point between fingers */
13645 unsigned int n; /**< Number of fingers tapped */
13646 unsigned int timestamp; /**< event timestamp */
13650 * @typedef Elm_Gesture_Taps_Info
13651 * holds taps info for user
13652 * @ingroup Elm_Gesture_Layer
13654 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13657 * @struct _Elm_Gesture_Momentum_Info
13658 * Struct holds momentum info for user
13659 * x1 and y1 are not necessarily in sync
13660 * x1 holds x value of x direction starting point
13661 * and same holds for y1.
13662 * This is noticeable when doing V-shape movement
13663 * @ingroup Elm_Gesture_Layer
13665 struct _Elm_Gesture_Momentum_Info
13666 { /* Report line ends, timestamps, and momentum computed */
13667 Evas_Coord x1; /**< Final-swipe direction starting point on X */
13668 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13669 Evas_Coord x2; /**< Final-swipe direction ending point on X */
13670 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
13672 unsigned int tx; /**< Timestamp of start of final x-swipe */
13673 unsigned int ty; /**< Timestamp of start of final y-swipe */
13675 Evas_Coord mx; /**< Momentum on X */
13676 Evas_Coord my; /**< Momentum on Y */
13678 unsigned int n; /**< Number of fingers */
13682 * @typedef Elm_Gesture_Momentum_Info
13683 * holds momentum info for user
13684 * @ingroup Elm_Gesture_Layer
13686 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13689 * @struct _Elm_Gesture_Line_Info
13690 * Struct holds line info for user
13691 * @ingroup Elm_Gesture_Layer
13693 struct _Elm_Gesture_Line_Info
13694 { /* Report line ends, timestamps, and momentum computed */
13695 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13696 double angle; /**< Angle (direction) of lines */
13700 * @typedef Elm_Gesture_Line_Info
13701 * Holds line info for user
13702 * @ingroup Elm_Gesture_Layer
13704 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13707 * @struct _Elm_Gesture_Zoom_Info
13708 * Struct holds zoom info for user
13709 * @ingroup Elm_Gesture_Layer
13711 struct _Elm_Gesture_Zoom_Info
13713 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13714 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13715 double zoom; /**< Zoom value: 1.0 means no zoom */
13716 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13720 * @typedef Elm_Gesture_Zoom_Info
13721 * Holds zoom info for user
13722 * @ingroup Elm_Gesture_Layer
13724 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13727 * @struct _Elm_Gesture_Rotate_Info
13728 * Struct holds rotation info for user
13729 * @ingroup Elm_Gesture_Layer
13731 struct _Elm_Gesture_Rotate_Info
13733 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13734 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13735 double base_angle; /**< Holds start-angle */
13736 double angle; /**< Rotation value: 0.0 means no rotation */
13737 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13741 * @typedef Elm_Gesture_Rotate_Info
13742 * Holds rotation info for user
13743 * @ingroup Elm_Gesture_Layer
13745 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13748 * @typedef Elm_Gesture_Event_Cb
13749 * User callback used to stream gesture info from gesture layer
13750 * @param data user data
13751 * @param event_info gesture report info
13752 * Returns a flag field to be applied on the causing event.
13753 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13754 * upon the event, in an irreversible way.
13756 * @ingroup Elm_Gesture_Layer
13758 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13761 * Use function to set callbacks to be notified about
13762 * change of state of gesture.
13763 * When a user registers a callback with this function
13764 * this means this gesture has to be tested.
13766 * When ALL callbacks for a gesture are set to NULL
13767 * it means user isn't interested in gesture-state
13768 * and it will not be tested.
13770 * @param obj Pointer to gesture-layer.
13771 * @param idx The gesture you would like to track its state.
13772 * @param cb callback function pointer.
13773 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13774 * @param data user info to be sent to callback (usually, Smart Data)
13776 * @ingroup Elm_Gesture_Layer
13778 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);
13781 * Call this function to get repeat-events settings.
13783 * @param obj Pointer to gesture-layer.
13785 * @return repeat events settings.
13786 * @see elm_gesture_layer_hold_events_set()
13787 * @ingroup Elm_Gesture_Layer
13789 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13792 * This function called in order to make gesture-layer repeat events.
13793 * Set this of you like to get the raw events only if gestures were not detected.
13794 * Clear this if you like gesture layer to fwd events as testing gestures.
13796 * @param obj Pointer to gesture-layer.
13797 * @param r Repeat: TRUE/FALSE
13799 * @ingroup Elm_Gesture_Layer
13801 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13804 * This function sets step-value for zoom action.
13805 * Set step to any positive value.
13806 * Cancel step setting by setting to 0.0
13808 * @param obj Pointer to gesture-layer.
13809 * @param s new zoom step value.
13811 * @ingroup Elm_Gesture_Layer
13813 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13816 * This function sets step-value for rotate action.
13817 * Set step to any positive value.
13818 * Cancel step setting by setting to 0.0
13820 * @param obj Pointer to gesture-layer.
13821 * @param s new roatate step value.
13823 * @ingroup Elm_Gesture_Layer
13825 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13828 * This function called to attach gesture-layer to an Evas_Object.
13829 * @param obj Pointer to gesture-layer.
13830 * @param t Pointer to underlying object (AKA Target)
13832 * @return TRUE, FALSE on success, failure.
13834 * @ingroup Elm_Gesture_Layer
13836 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13839 * Call this function to construct a new gesture-layer object.
13840 * This does not activate the gesture layer. You have to
13841 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13843 * @param parent the parent object.
13845 * @return Pointer to new gesture-layer object.
13847 * @ingroup Elm_Gesture_Layer
13849 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13852 * @defgroup Thumb Thumb
13854 * @image html img/widget/thumb/preview-00.png
13855 * @image latex img/widget/thumb/preview-00.eps
13857 * A thumb object is used for displaying the thumbnail of an image or video.
13858 * You must have compiled Elementary with Ethumb_Client support and the DBus
13859 * service must be present and auto-activated in order to have thumbnails to
13862 * Once the thumbnail object becomes visible, it will check if there is a
13863 * previously generated thumbnail image for the file set on it. If not, it
13864 * will start generating this thumbnail.
13866 * Different config settings will cause different thumbnails to be generated
13867 * even on the same file.
13869 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13870 * Ethumb documentation to change this path, and to see other configuration
13873 * Signals that you can add callbacks for are:
13875 * - "clicked" - This is called when a user has clicked the thumb without dragging
13877 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13878 * - "press" - This is called when a user has pressed down the thumb.
13879 * - "generate,start" - The thumbnail generation started.
13880 * - "generate,stop" - The generation process stopped.
13881 * - "generate,error" - The generation failed.
13882 * - "load,error" - The thumbnail image loading failed.
13884 * available styles:
13888 * An example of use of thumbnail:
13890 * - @ref thumb_example_01
13894 * @addtogroup Thumb
13899 * @enum _Elm_Thumb_Animation_Setting
13900 * @typedef Elm_Thumb_Animation_Setting
13902 * Used to set if a video thumbnail is animating or not.
13906 typedef enum _Elm_Thumb_Animation_Setting
13908 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13909 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13910 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13911 ELM_THUMB_ANIMATION_LAST
13912 } Elm_Thumb_Animation_Setting;
13915 * Add a new thumb object to the parent.
13917 * @param parent The parent object.
13918 * @return The new object or NULL if it cannot be created.
13920 * @see elm_thumb_file_set()
13921 * @see elm_thumb_ethumb_client_get()
13925 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13928 * Reload thumbnail if it was generated before.
13930 * @param obj The thumb object to reload
13932 * This is useful if the ethumb client configuration changed, like its
13933 * size, aspect or any other property one set in the handle returned
13934 * by elm_thumb_ethumb_client_get().
13936 * If the options didn't change, the thumbnail won't be generated again, but
13937 * the old one will still be used.
13939 * @see elm_thumb_file_set()
13943 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13946 * Set the file that will be used as thumbnail.
13948 * @param obj The thumb object.
13949 * @param file The path to file that will be used as thumb.
13950 * @param key The key used in case of an EET file.
13952 * The file can be an image or a video (in that case, acceptable extensions are:
13953 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13954 * function elm_thumb_animate().
13956 * @see elm_thumb_file_get()
13957 * @see elm_thumb_reload()
13958 * @see elm_thumb_animate()
13962 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13965 * Get the image or video path and key used to generate the thumbnail.
13967 * @param obj The thumb object.
13968 * @param file Pointer to filename.
13969 * @param key Pointer to key.
13971 * @see elm_thumb_file_set()
13972 * @see elm_thumb_path_get()
13976 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13979 * Get the path and key to the image or video generated by ethumb.
13981 * One just need to make sure that the thumbnail was generated before getting
13982 * its path; otherwise, the path will be NULL. One way to do that is by asking
13983 * for the path when/after the "generate,stop" smart callback is called.
13985 * @param obj The thumb object.
13986 * @param file Pointer to thumb path.
13987 * @param key Pointer to thumb key.
13989 * @see elm_thumb_file_get()
13993 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13996 * Set the animation state for the thumb object. If its content is an animated
13997 * video, you may start/stop the animation or tell it to play continuously and
14000 * @param obj The thumb object.
14001 * @param setting The animation setting.
14003 * @see elm_thumb_file_set()
14007 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
14010 * Get the animation state for the thumb object.
14012 * @param obj The thumb object.
14013 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
14016 * @see elm_thumb_animate_set()
14020 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14023 * Get the ethumb_client handle so custom configuration can be made.
14025 * @return Ethumb_Client instance or NULL.
14027 * This must be called before the objects are created to be sure no object is
14028 * visible and no generation started.
14030 * Example of usage:
14033 * #include <Elementary.h>
14034 * #ifndef ELM_LIB_QUICKLAUNCH
14036 * elm_main(int argc, char **argv)
14038 * Ethumb_Client *client;
14040 * elm_need_ethumb();
14044 * client = elm_thumb_ethumb_client_get();
14047 * ERR("could not get ethumb_client");
14050 * ethumb_client_size_set(client, 100, 100);
14051 * ethumb_client_crop_align_set(client, 0.5, 0.5);
14054 * // Create elm_thumb objects here
14064 * @note There's only one client handle for Ethumb, so once a configuration
14065 * change is done to it, any other request for thumbnails (for any thumbnail
14066 * object) will use that configuration. Thus, this configuration is global.
14070 EAPI void *elm_thumb_ethumb_client_get(void);
14073 * Get the ethumb_client connection state.
14075 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
14078 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
14081 * Make the thumbnail 'editable'.
14083 * @param obj Thumb object.
14084 * @param set Turn on or off editability. Default is @c EINA_FALSE.
14086 * This means the thumbnail is a valid drag target for drag and drop, and can be
14087 * cut or pasted too.
14089 * @see elm_thumb_editable_get()
14093 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
14096 * Make the thumbnail 'editable'.
14098 * @param obj Thumb object.
14099 * @return Editability.
14101 * This means the thumbnail is a valid drag target for drag and drop, and can be
14102 * cut or pasted too.
14104 * @see elm_thumb_editable_set()
14108 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14115 * @defgroup Web Web
14117 * @image html img/widget/web/preview-00.png
14118 * @image latex img/widget/web/preview-00.eps
14120 * A web object is used for displaying web pages (HTML/CSS/JS)
14121 * using WebKit-EFL. You must have compiled Elementary with
14124 * Signals that you can add callbacks for are:
14125 * @li "download,request": A file download has been requested. Event info is
14126 * a pointer to a Elm_Web_Download
14127 * @li "editorclient,contents,changed": Editor client's contents changed
14128 * @li "editorclient,selection,changed": Editor client's selection changed
14129 * @li "frame,created": A new frame was created. Event info is an
14130 * Evas_Object which can be handled with WebKit's ewk_frame API
14131 * @li "icon,received": An icon was received by the main frame
14132 * @li "inputmethod,changed": Input method changed. Event info is an
14133 * Eina_Bool indicating whether it's enabled or not
14134 * @li "js,windowobject,clear": JS window object has been cleared
14135 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
14136 * is a char *link[2], where the first string contains the URL the link
14137 * points to, and the second one the title of the link
14138 * @li "link,hover,out": Mouse cursor left the link
14139 * @li "load,document,finished": Loading of a document finished. Event info
14140 * is the frame that finished loading
14141 * @li "load,error": Load failed. Event info is a pointer to
14142 * Elm_Web_Frame_Load_Error
14143 * @li "load,finished": Load finished. Event info is NULL on success, on
14144 * error it's a pointer to Elm_Web_Frame_Load_Error
14145 * @li "load,newwindow,show": A new window was created and is ready to be
14147 * @li "load,progress": Overall load progress. Event info is a pointer to
14148 * a double containing a value between 0.0 and 1.0
14149 * @li "load,provisional": Started provisional load
14150 * @li "load,started": Loading of a document started
14151 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
14152 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
14153 * the menubar is visible, or EINA_FALSE in case it's not
14154 * @li "menubar,visible,set": Informs menubar visibility. Event info is
14155 * an Eina_Bool indicating the visibility
14156 * @li "popup,created": A dropdown widget was activated, requesting its
14157 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
14158 * @li "popup,willdelete": The web object is ready to destroy the popup
14159 * object created. Event info is a pointer to Elm_Web_Menu
14160 * @li "ready": Page is fully loaded
14161 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
14162 * info is a pointer to Eina_Bool where the visibility state should be set
14163 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
14164 * is an Eina_Bool with the visibility state set
14165 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
14166 * a string with the new text
14167 * @li "statusbar,visible,get": Queries visibility of the status bar.
14168 * Event info is a pointer to Eina_Bool where the visibility state should be
14170 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
14171 * an Eina_Bool with the visibility value
14172 * @li "title,changed": Title of the main frame changed. Event info is a
14173 * string with the new title
14174 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
14175 * is a pointer to Eina_Bool where the visibility state should be set
14176 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
14177 * info is an Eina_Bool with the visibility state
14178 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
14179 * a string with the text to show
14180 * @li "uri,changed": URI of the main frame changed. Event info is a string
14182 * @li "view,resized": The web object internal's view changed sized
14183 * @li "windows,close,request": A JavaScript request to close the current
14184 * window was requested
14185 * @li "zoom,animated,end": Animated zoom finished
14187 * available styles:
14190 * An example of use of web:
14192 * - @ref web_example_01 TBD
14201 * Structure used to report load errors.
14203 * Load errors are reported as signal by elm_web. All the strings are
14204 * temporary references and should @b not be used after the signal
14205 * callback returns. If it's required, make copies with strdup() or
14206 * eina_stringshare_add() (they are not even guaranteed to be
14207 * stringshared, so must use eina_stringshare_add() and not
14208 * eina_stringshare_ref()).
14210 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
14213 * Structure used to report load errors.
14215 * Load errors are reported as signal by elm_web. All the strings are
14216 * temporary references and should @b not be used after the signal
14217 * callback returns. If it's required, make copies with strdup() or
14218 * eina_stringshare_add() (they are not even guaranteed to be
14219 * stringshared, so must use eina_stringshare_add() and not
14220 * eina_stringshare_ref()).
14222 struct _Elm_Web_Frame_Load_Error
14224 int code; /**< Numeric error code */
14225 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
14226 const char *domain; /**< Error domain name */
14227 const char *description; /**< Error description (already localized) */
14228 const char *failing_url; /**< The URL that failed to load */
14229 Evas_Object *frame; /**< Frame object that produced the error */
14233 * The possibles types that the items in a menu can be
14235 typedef enum _Elm_Web_Menu_Item_Type
14237 ELM_WEB_MENU_SEPARATOR,
14238 ELM_WEB_MENU_GROUP,
14239 ELM_WEB_MENU_OPTION
14240 } Elm_Web_Menu_Item_Type;
14243 * Structure describing the items in a menu
14245 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
14248 * Structure describing the items in a menu
14250 struct _Elm_Web_Menu_Item
14252 const char *text; /**< The text for the item */
14253 Elm_Web_Menu_Item_Type type; /**< The type of the item */
14257 * Structure describing the menu of a popup
14259 * This structure will be passed as the @c event_info for the "popup,create"
14260 * signal, which is emitted when a dropdown menu is opened. Users wanting
14261 * to handle these popups by themselves should listen to this signal and
14262 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14263 * property as @c EINA_FALSE means that the user will not handle the popup
14264 * and the default implementation will be used.
14266 * When the popup is ready to be dismissed, a "popup,willdelete" signal
14267 * will be emitted to notify the user that it can destroy any objects and
14268 * free all data related to it.
14270 * @see elm_web_popup_selected_set()
14271 * @see elm_web_popup_destroy()
14273 typedef struct _Elm_Web_Menu Elm_Web_Menu;
14276 * Structure describing the menu of a popup
14278 * This structure will be passed as the @c event_info for the "popup,create"
14279 * signal, which is emitted when a dropdown menu is opened. Users wanting
14280 * to handle these popups by themselves should listen to this signal and
14281 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14282 * property as @c EINA_FALSE means that the user will not handle the popup
14283 * and the default implementation will be used.
14285 * When the popup is ready to be dismissed, a "popup,willdelete" signal
14286 * will be emitted to notify the user that it can destroy any objects and
14287 * free all data related to it.
14289 * @see elm_web_popup_selected_set()
14290 * @see elm_web_popup_destroy()
14292 struct _Elm_Web_Menu
14294 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
14295 int x; /**< The X position of the popup, relative to the elm_web object */
14296 int y; /**< The Y position of the popup, relative to the elm_web object */
14297 int width; /**< Width of the popup menu */
14298 int height; /**< Height of the popup menu */
14300 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. */
14303 typedef struct _Elm_Web_Download Elm_Web_Download;
14304 struct _Elm_Web_Download
14310 * Types of zoom available.
14312 typedef enum _Elm_Web_Zoom_Mode
14314 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
14315 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
14316 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
14317 ELM_WEB_ZOOM_MODE_LAST
14318 } Elm_Web_Zoom_Mode;
14321 * Opaque handler containing the features (such as statusbar, menubar, etc)
14322 * that are to be set on a newly requested window.
14324 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
14327 * Callback type for the create_window hook.
14329 * The function parameters are:
14330 * @li @p data User data pointer set when setting the hook function
14331 * @li @p obj The elm_web object requesting the new window
14332 * @li @p js Set to @c EINA_TRUE if the request was originated from
14333 * JavaScript. @c EINA_FALSE otherwise.
14334 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
14335 * the features requested for the new window.
14337 * The returned value of the function should be the @c elm_web widget where
14338 * the request will be loaded. That is, if a new window or tab is created,
14339 * the elm_web widget in it should be returned, and @b NOT the window
14341 * Returning @c NULL should cancel the request.
14343 * @see elm_web_window_create_hook_set()
14345 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
14348 * Callback type for the JS alert hook.
14350 * The function parameters are:
14351 * @li @p data User data pointer set when setting the hook function
14352 * @li @p obj The elm_web object requesting the new window
14353 * @li @p message The message to show in the alert dialog
14355 * The function should return the object representing the alert dialog.
14356 * Elm_Web will run a second main loop to handle the dialog and normal
14357 * flow of the application will be restored when the object is deleted, so
14358 * the user should handle the popup properly in order to delete the object
14359 * when the action is finished.
14360 * If the function returns @c NULL the popup will be ignored.
14362 * @see elm_web_dialog_alert_hook_set()
14364 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
14367 * Callback type for the JS confirm hook.
14369 * The function parameters are:
14370 * @li @p data User data pointer set when setting the hook function
14371 * @li @p obj The elm_web object requesting the new window
14372 * @li @p message The message to show in the confirm dialog
14373 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14374 * the user selected @c Ok, @c EINA_FALSE otherwise.
14376 * The function should return the object representing the confirm dialog.
14377 * Elm_Web will run a second main loop to handle the dialog and normal
14378 * flow of the application will be restored when the object is deleted, so
14379 * the user should handle the popup properly in order to delete the object
14380 * when the action is finished.
14381 * If the function returns @c NULL the popup will be ignored.
14383 * @see elm_web_dialog_confirm_hook_set()
14385 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
14388 * Callback type for the JS prompt hook.
14390 * The function parameters are:
14391 * @li @p data User data pointer set when setting the hook function
14392 * @li @p obj The elm_web object requesting the new window
14393 * @li @p message The message to show in the prompt dialog
14394 * @li @p def_value The default value to present the user in the entry
14395 * @li @p value Pointer where to store the value given by the user. Must
14396 * be a malloc'ed string or @c NULL if the user cancelled the popup.
14397 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14398 * the user selected @c Ok, @c EINA_FALSE otherwise.
14400 * The function should return the object representing the prompt dialog.
14401 * Elm_Web will run a second main loop to handle the dialog and normal
14402 * flow of the application will be restored when the object is deleted, so
14403 * the user should handle the popup properly in order to delete the object
14404 * when the action is finished.
14405 * If the function returns @c NULL the popup will be ignored.
14407 * @see elm_web_dialog_prompt_hook_set()
14409 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
14412 * Callback type for the JS file selector hook.
14414 * The function parameters are:
14415 * @li @p data User data pointer set when setting the hook function
14416 * @li @p obj The elm_web object requesting the new window
14417 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
14418 * @li @p accept_types Mime types accepted
14419 * @li @p selected Pointer where to store the list of malloc'ed strings
14420 * containing the path to each file selected. Must be @c NULL if the file
14421 * dialog is cancelled
14422 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14423 * the user selected @c Ok, @c EINA_FALSE otherwise.
14425 * The function should return the object representing the file selector
14427 * Elm_Web will run a second main loop to handle the dialog and normal
14428 * flow of the application will be restored when the object is deleted, so
14429 * the user should handle the popup properly in order to delete the object
14430 * when the action is finished.
14431 * If the function returns @c NULL the popup will be ignored.
14433 * @see elm_web_dialog_file selector_hook_set()
14435 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);
14438 * Callback type for the JS console message hook.
14440 * When a console message is added from JavaScript, any set function to the
14441 * console message hook will be called for the user to handle. There is no
14442 * default implementation of this hook.
14444 * The function parameters are:
14445 * @li @p data User data pointer set when setting the hook function
14446 * @li @p obj The elm_web object that originated the message
14447 * @li @p message The message sent
14448 * @li @p line_number The line number
14449 * @li @p source_id Source id
14451 * @see elm_web_console_message_hook_set()
14453 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
14456 * Add a new web object to the parent.
14458 * @param parent The parent object.
14459 * @return The new object or NULL if it cannot be created.
14461 * @see elm_web_uri_set()
14462 * @see elm_web_webkit_view_get()
14464 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14467 * Get internal ewk_view object from web object.
14469 * Elementary may not provide some low level features of EWebKit,
14470 * instead of cluttering the API with proxy methods we opted to
14471 * return the internal reference. Be careful using it as it may
14472 * interfere with elm_web behavior.
14474 * @param obj The web object.
14475 * @return The internal ewk_view object or NULL if it does not
14476 * exist. (Failure to create or Elementary compiled without
14479 * @see elm_web_add()
14481 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14484 * Sets the function to call when a new window is requested
14486 * This hook will be called when a request to create a new window is
14487 * issued from the web page loaded.
14488 * There is no default implementation for this feature, so leaving this
14489 * unset or passing @c NULL in @p func will prevent new windows from
14492 * @param obj The web object where to set the hook function
14493 * @param func The hook function to be called when a window is requested
14494 * @param data User data
14496 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14499 * Sets the function to call when an alert dialog
14501 * This hook will be called when a JavaScript alert dialog is requested.
14502 * If no function is set or @c NULL is passed in @p func, the default
14503 * implementation will take place.
14505 * @param obj The web object where to set the hook function
14506 * @param func The callback function to be used
14507 * @param data User data
14509 * @see elm_web_inwin_mode_set()
14511 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14514 * Sets the function to call when an confirm dialog
14516 * This hook will be called when a JavaScript confirm dialog is requested.
14517 * If no function is set or @c NULL is passed in @p func, the default
14518 * implementation will take place.
14520 * @param obj The web object where to set the hook function
14521 * @param func The callback function to be used
14522 * @param data User data
14524 * @see elm_web_inwin_mode_set()
14526 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14529 * Sets the function to call when an prompt dialog
14531 * This hook will be called when a JavaScript prompt dialog is requested.
14532 * If no function is set or @c NULL is passed in @p func, the default
14533 * implementation will take place.
14535 * @param obj The web object where to set the hook function
14536 * @param func The callback function to be used
14537 * @param data User data
14539 * @see elm_web_inwin_mode_set()
14541 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14544 * Sets the function to call when an file selector dialog
14546 * This hook will be called when a JavaScript file selector dialog is
14548 * If no function is set or @c NULL is passed in @p func, the default
14549 * implementation will take place.
14551 * @param obj The web object where to set the hook function
14552 * @param func The callback function to be used
14553 * @param data User data
14555 * @see elm_web_inwin_mode_set()
14557 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14560 * Sets the function to call when a console message is emitted from JS
14562 * This hook will be called when a console message is emitted from
14563 * JavaScript. There is no default implementation for this feature.
14565 * @param obj The web object where to set the hook function
14566 * @param func The callback function to be used
14567 * @param data User data
14569 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14572 * Gets the status of the tab propagation
14574 * @param obj The web object to query
14575 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14577 * @see elm_web_tab_propagate_set()
14579 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
14582 * Sets whether to use tab propagation
14584 * If tab propagation is enabled, whenever the user presses the Tab key,
14585 * Elementary will handle it and switch focus to the next widget.
14586 * The default value is disabled, where WebKit will handle the Tab key to
14587 * cycle focus though its internal objects, jumping to the next widget
14588 * only when that cycle ends.
14590 * @param obj The web object
14591 * @param propagate Whether to propagate Tab keys to Elementary or not
14593 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14596 * Sets the URI for the web object
14598 * It must be a full URI, with resource included, in the form
14599 * http://www.enlightenment.org or file:///tmp/something.html
14601 * @param obj The web object
14602 * @param uri The URI to set
14603 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14605 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
14608 * Gets the current URI for the object
14610 * The returned string must not be freed and is guaranteed to be
14613 * @param obj The web object
14614 * @return A stringshared internal string with the current URI, or NULL on
14617 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
14620 * Gets the current title
14622 * The returned string must not be freed and is guaranteed to be
14625 * @param obj The web object
14626 * @return A stringshared internal string with the current title, or NULL on
14629 EAPI const char *elm_web_title_get(const Evas_Object *obj);
14632 * Sets the background color to be used by the web object
14634 * This is the color that will be used by default when the loaded page
14635 * does not set it's own. Color values are pre-multiplied.
14637 * @param obj The web object
14638 * @param r Red component
14639 * @param g Green component
14640 * @param b Blue component
14641 * @param a Alpha component
14643 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14646 * Gets the background color to be used by the web object
14648 * This is the color that will be used by default when the loaded page
14649 * does not set it's own. Color values are pre-multiplied.
14651 * @param obj The web object
14652 * @param r Red component
14653 * @param g Green component
14654 * @param b Blue component
14655 * @param a Alpha component
14657 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14660 * Gets a copy of the currently selected text
14662 * The string returned must be freed by the user when it's done with it.
14664 * @param obj The web object
14665 * @return A newly allocated string, or NULL if nothing is selected or an
14668 EAPI char *elm_view_selection_get(const Evas_Object *obj);
14671 * Tells the web object which index in the currently open popup was selected
14673 * When the user handles the popup creation from the "popup,created" signal,
14674 * it needs to tell the web object which item was selected by calling this
14675 * function with the index corresponding to the item.
14677 * @param obj The web object
14678 * @param index The index selected
14680 * @see elm_web_popup_destroy()
14682 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
14685 * Dismisses an open dropdown popup
14687 * When the popup from a dropdown widget is to be dismissed, either after
14688 * selecting an option or to cancel it, this function must be called, which
14689 * will later emit an "popup,willdelete" signal to notify the user that
14690 * any memory and objects related to this popup can be freed.
14692 * @param obj The web object
14693 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14694 * if there was no menu to destroy
14696 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
14699 * Searches the given string in a document.
14701 * @param obj The web object where to search the text
14702 * @param string String to search
14703 * @param case_sensitive If search should be case sensitive or not
14704 * @param forward If search is from cursor and on or backwards
14705 * @param wrap If search should wrap at the end
14707 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14710 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14713 * Marks matches of the given string in a document.
14715 * @param obj The web object where to search text
14716 * @param string String to match
14717 * @param case_sensitive If match should be case sensitive or not
14718 * @param highlight If matches should be highlighted
14719 * @param limit Maximum amount of matches, or zero to unlimited
14721 * @return number of matched @a string
14723 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14726 * Clears all marked matches in the document
14728 * @param obj The web object
14730 * @return EINA_TRUE on success, EINA_FALSE otherwise
14732 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
14735 * Sets whether to highlight the matched marks
14737 * If enabled, marks set with elm_web_text_matches_mark() will be
14740 * @param obj The web object
14741 * @param highlight Whether to highlight the marks or not
14743 * @return EINA_TRUE on success, EINA_FALSE otherwise
14745 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14748 * Gets whether highlighting marks is enabled
14750 * @param The web object
14752 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14755 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
14758 * Gets the overall loading progress of the page
14760 * Returns the estimated loading progress of the page, with a value between
14761 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14762 * included in the page.
14764 * @param The web object
14766 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14769 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
14772 * Stops loading the current page
14774 * Cancels the loading of the current page in the web object. This will
14775 * cause a "load,error" signal to be emitted, with the is_cancellation
14776 * flag set to EINA_TRUE.
14778 * @param obj The web object
14780 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14782 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14785 * Requests a reload of the current document in the object
14787 * @param obj The web object
14789 * @return EINA_TRUE on success, EINA_FALSE otherwise
14791 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14794 * Requests a reload of the current document, avoiding any existing caches
14796 * @param obj The web object
14798 * @return EINA_TRUE on success, EINA_FALSE otherwise
14800 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14803 * Goes back one step in the browsing history
14805 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14807 * @param obj The web object
14809 * @return EINA_TRUE on success, EINA_FALSE otherwise
14811 * @see elm_web_history_enable_set()
14812 * @see elm_web_back_possible()
14813 * @see elm_web_forward()
14814 * @see elm_web_navigate()
14816 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14819 * Goes forward one step in the browsing history
14821 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14823 * @param obj The web object
14825 * @return EINA_TRUE on success, EINA_FALSE otherwise
14827 * @see elm_web_history_enable_set()
14828 * @see elm_web_forward_possible()
14829 * @see elm_web_back()
14830 * @see elm_web_navigate()
14832 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14835 * Jumps the given number of steps in the browsing history
14837 * The @p steps value can be a negative integer to back in history, or a
14838 * positive to move forward.
14840 * @param obj The web object
14841 * @param steps The number of steps to jump
14843 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14844 * history exists to jump the given number of steps
14846 * @see elm_web_history_enable_set()
14847 * @see elm_web_navigate_possible()
14848 * @see elm_web_back()
14849 * @see elm_web_forward()
14851 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14854 * Queries whether it's possible to go back in history
14856 * @param obj The web object
14858 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14861 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14864 * Queries whether it's possible to go forward in history
14866 * @param obj The web object
14868 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14871 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14874 * Queries whether it's possible to jump the given number of steps
14876 * The @p steps value can be a negative integer to back in history, or a
14877 * positive to move forward.
14879 * @param obj The web object
14880 * @param steps The number of steps to check for
14882 * @return EINA_TRUE if enough history exists to perform the given jump,
14883 * EINA_FALSE otherwise
14885 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14888 * Gets whether browsing history is enabled for the given object
14890 * @param obj The web object
14892 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14894 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14897 * Enables or disables the browsing history
14899 * @param obj The web object
14900 * @param enable Whether to enable or disable the browsing history
14902 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14905 * Sets the zoom level of the web object
14907 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14908 * values meaning zoom in and lower meaning zoom out. This function will
14909 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14910 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14912 * @param obj The web object
14913 * @param zoom The zoom level to set
14915 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14918 * Gets the current zoom level set on the web object
14920 * Note that this is the zoom level set on the web object and not that
14921 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14922 * the two zoom levels should match, but for the other two modes the
14923 * Webkit zoom is calculated internally to match the chosen mode without
14924 * changing the zoom level set for the web object.
14926 * @param obj The web object
14928 * @return The zoom level set on the object
14930 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14933 * Sets the zoom mode to use
14935 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14936 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14938 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14939 * with the elm_web_zoom_set() function.
14940 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14941 * make sure the entirety of the web object's contents are shown.
14942 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14943 * fit the contents in the web object's size, without leaving any space
14946 * @param obj The web object
14947 * @param mode The mode to set
14949 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14952 * Gets the currently set zoom mode
14954 * @param obj The web object
14956 * @return The current zoom mode set for the object, or
14957 * ::ELM_WEB_ZOOM_MODE_LAST on error
14959 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14962 * Shows the given region in the web object
14964 * @param obj The web object
14965 * @param x The x coordinate of the region to show
14966 * @param y The y coordinate of the region to show
14967 * @param w The width of the region to show
14968 * @param h The height of the region to show
14970 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14973 * Brings in the region to the visible area
14975 * Like elm_web_region_show(), but it animates the scrolling of the object
14978 * @param obj The web object
14979 * @param x The x coordinate of the region to show
14980 * @param y The y coordinate of the region to show
14981 * @param w The width of the region to show
14982 * @param h The height of the region to show
14984 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14987 * Sets the default dialogs to use an Inwin instead of a normal window
14989 * If set, then the default implementation for the JavaScript dialogs and
14990 * file selector will be opened in an Inwin. Otherwise they will use a
14991 * normal separated window.
14993 * @param obj The web object
14994 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14996 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14999 * Gets whether Inwin mode is set for the current object
15001 * @param obj The web object
15003 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
15005 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
15007 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
15008 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
15009 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);
15010 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
15017 * @defgroup Hoversel Hoversel
15019 * @image html img/widget/hoversel/preview-00.png
15020 * @image latex img/widget/hoversel/preview-00.eps
15022 * A hoversel is a button that pops up a list of items (automatically
15023 * choosing the direction to display) that have a label and, optionally, an
15024 * icon to select from. It is a convenience widget to avoid the need to do
15025 * all the piecing together yourself. It is intended for a small number of
15026 * items in the hoversel menu (no more than 8), though is capable of many
15029 * Signals that you can add callbacks for are:
15030 * "clicked" - the user clicked the hoversel button and popped up the sel
15031 * "selected" - an item in the hoversel list is selected. event_info is the item
15032 * "dismissed" - the hover is dismissed
15034 * See @ref tutorial_hoversel for an example.
15037 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
15040 * @brief Add a new Hoversel object
15042 * @param parent The parent object
15043 * @return The new object or NULL if it cannot be created
15045 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15048 * @brief This sets the hoversel to expand horizontally.
15050 * @param obj The hoversel object
15051 * @param horizontal If true, the hover will expand horizontally to the
15054 * @note The initial button will display horizontally regardless of this
15057 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15060 * @brief This returns whether the hoversel is set to expand horizontally.
15062 * @param obj The hoversel object
15063 * @return If true, the hover will expand horizontally to the right.
15065 * @see elm_hoversel_horizontal_set()
15067 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15070 * @brief Set the Hover parent
15072 * @param obj The hoversel object
15073 * @param parent The parent to use
15075 * Sets the hover parent object, the area that will be darkened when the
15076 * hoversel is clicked. Should probably be the window that the hoversel is
15077 * in. See @ref Hover objects for more information.
15079 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15081 * @brief Get the Hover parent
15083 * @param obj The hoversel object
15084 * @return The used parent
15086 * Gets the hover parent object.
15088 * @see elm_hoversel_hover_parent_set()
15090 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15093 * @brief Set the hoversel button label
15095 * @param obj The hoversel object
15096 * @param label The label text.
15098 * This sets the label of the button that is always visible (before it is
15099 * clicked and expanded).
15101 * @deprecated elm_object_text_set()
15103 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15106 * @brief Get the hoversel button label
15108 * @param obj The hoversel object
15109 * @return The label text.
15111 * @deprecated elm_object_text_get()
15113 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15116 * @brief Set the icon of the hoversel button
15118 * @param obj The hoversel object
15119 * @param icon The icon object
15121 * Sets the icon of the button that is always visible (before it is clicked
15122 * and expanded). Once the icon object is set, a previously set one will be
15123 * deleted, if you want to keep that old content object, use the
15124 * elm_hoversel_icon_unset() function.
15126 * @see elm_object_content_set() for the button widget
15128 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15131 * @brief Get the icon of the hoversel button
15133 * @param obj The hoversel object
15134 * @return The icon object
15136 * Get the icon of the button that is always visible (before it is clicked
15137 * and expanded). Also see elm_object_content_get() for the button widget.
15139 * @see elm_hoversel_icon_set()
15141 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15144 * @brief Get and unparent the icon of the hoversel button
15146 * @param obj The hoversel object
15147 * @return The icon object that was being used
15149 * Unparent and return the icon of the button that is always visible
15150 * (before it is clicked and expanded).
15152 * @see elm_hoversel_icon_set()
15153 * @see elm_object_content_unset() for the button widget
15155 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15158 * @brief This triggers the hoversel popup from code, the same as if the user
15159 * had clicked the button.
15161 * @param obj The hoversel object
15163 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
15166 * @brief This dismisses the hoversel popup as if the user had clicked
15167 * outside the hover.
15169 * @param obj The hoversel object
15171 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
15174 * @brief Returns whether the hoversel is expanded.
15176 * @param obj The hoversel object
15177 * @return This will return EINA_TRUE if the hoversel is expanded or
15178 * EINA_FALSE if it is not expanded.
15180 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15183 * @brief This will remove all the children items from the hoversel.
15185 * @param obj The hoversel object
15187 * @warning Should @b not be called while the hoversel is active; use
15188 * elm_hoversel_expanded_get() to check first.
15190 * @see elm_hoversel_item_del_cb_set()
15191 * @see elm_hoversel_item_del()
15193 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15196 * @brief Get the list of items within the given hoversel.
15198 * @param obj The hoversel object
15199 * @return Returns a list of Elm_Hoversel_Item*
15201 * @see elm_hoversel_item_add()
15203 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15206 * @brief Add an item to the hoversel button
15208 * @param obj The hoversel object
15209 * @param label The text label to use for the item (NULL if not desired)
15210 * @param icon_file An image file path on disk to use for the icon or standard
15211 * icon name (NULL if not desired)
15212 * @param icon_type The icon type if relevant
15213 * @param func Convenience function to call when this item is selected
15214 * @param data Data to pass to item-related functions
15215 * @return A handle to the item added.
15217 * This adds an item to the hoversel to show when it is clicked. Note: if you
15218 * need to use an icon from an edje file then use
15219 * elm_hoversel_item_icon_set() right after the this function, and set
15220 * icon_file to NULL here.
15222 * For more information on what @p icon_file and @p icon_type are see the
15223 * @ref Icon "icon documentation".
15225 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);
15228 * @brief Delete an item from the hoversel
15230 * @param item The item to delete
15232 * This deletes the item from the hoversel (should not be called while the
15233 * hoversel is active; use elm_hoversel_expanded_get() to check first).
15235 * @see elm_hoversel_item_add()
15236 * @see elm_hoversel_item_del_cb_set()
15238 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
15241 * @brief Set the function to be called when an item from the hoversel is
15244 * @param item The item to set the callback on
15245 * @param func The function called
15247 * That function will receive these parameters:
15248 * @li void *item_data
15249 * @li Evas_Object *the_item_object
15250 * @li Elm_Hoversel_Item *the_object_struct
15252 * @see elm_hoversel_item_add()
15254 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15257 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
15258 * that will be passed to associated function callbacks.
15260 * @param item The item to get the data from
15261 * @return The data pointer set with elm_hoversel_item_add()
15263 * @see elm_hoversel_item_add()
15265 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
15268 * @brief This returns the label text of the given hoversel item.
15270 * @param item The item to get the label
15271 * @return The label text of the hoversel item
15273 * @see elm_hoversel_item_add()
15275 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
15278 * @brief This sets the icon for the given hoversel item.
15280 * @param item The item to set the icon
15281 * @param icon_file An image file path on disk to use for the icon or standard
15283 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
15284 * to NULL if the icon is not an edje file
15285 * @param icon_type The icon type
15287 * The icon can be loaded from the standard set, from an image file, or from
15290 * @see elm_hoversel_item_add()
15292 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);
15295 * @brief Get the icon object of the hoversel item
15297 * @param item The item to get the icon from
15298 * @param icon_file The image file path on disk used for the icon or standard
15300 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
15301 * if the icon is not an edje file
15302 * @param icon_type The icon type
15304 * @see elm_hoversel_item_icon_set()
15305 * @see elm_hoversel_item_add()
15307 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);
15314 * @defgroup Toolbar Toolbar
15315 * @ingroup Elementary
15317 * @image html img/widget/toolbar/preview-00.png
15318 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
15320 * @image html img/toolbar.png
15321 * @image latex img/toolbar.eps width=\textwidth
15323 * A toolbar is a widget that displays a list of items inside
15324 * a box. It can be scrollable, show a menu with items that don't fit
15325 * to toolbar size or even crop them.
15327 * Only one item can be selected at a time.
15329 * Items can have multiple states, or show menus when selected by the user.
15331 * Smart callbacks one can listen to:
15332 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
15333 * - "language,changed" - when the program language changes
15335 * Available styles for it:
15337 * - @c "transparent" - no background or shadow, just show the content
15339 * Default text parts of the toolbar items that you can use for are:
15340 * @li "default" - label of the toolbar item
15342 * Supported elm_object_item common APIs.
15343 * @li elm_object_item_disabled_set
15344 * @li elm_object_item_text_set
15345 * @li elm_object_item_part_text_set
15346 * @li elm_object_item_text_get
15347 * @li elm_object_item_part_text_get
15349 * List of examples:
15350 * @li @ref toolbar_example_01
15351 * @li @ref toolbar_example_02
15352 * @li @ref toolbar_example_03
15356 * @addtogroup Toolbar
15361 * @enum _Elm_Toolbar_Shrink_Mode
15362 * @typedef Elm_Toolbar_Shrink_Mode
15364 * Set toolbar's items display behavior, it can be scrollabel,
15365 * show a menu with exceeding items, or simply hide them.
15367 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
15370 * Values <b> don't </b> work as bitmask, only one can be choosen.
15372 * @see elm_toolbar_mode_shrink_set()
15373 * @see elm_toolbar_mode_shrink_get()
15377 typedef enum _Elm_Toolbar_Shrink_Mode
15379 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
15380 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
15381 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
15382 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
15383 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
15384 } Elm_Toolbar_Shrink_Mode;
15386 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(). */
15389 * Add a new toolbar widget to the given parent Elementary
15390 * (container) object.
15392 * @param parent The parent object.
15393 * @return a new toolbar widget handle or @c NULL, on errors.
15395 * This function inserts a new toolbar widget on the canvas.
15399 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15402 * Set the icon size, in pixels, to be used by toolbar items.
15404 * @param obj The toolbar object
15405 * @param icon_size The icon size in pixels
15407 * @note Default value is @c 32. It reads value from elm config.
15409 * @see elm_toolbar_icon_size_get()
15413 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
15416 * Get the icon size, in pixels, to be used by toolbar items.
15418 * @param obj The toolbar object.
15419 * @return The icon size in pixels.
15421 * @see elm_toolbar_icon_size_set() for details.
15425 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15428 * Sets icon lookup order, for toolbar items' icons.
15430 * @param obj The toolbar object.
15431 * @param order The icon lookup order.
15433 * Icons added before calling this function will not be affected.
15434 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
15436 * @see elm_toolbar_icon_order_lookup_get()
15440 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
15443 * Gets the icon lookup order.
15445 * @param obj The toolbar object.
15446 * @return The icon lookup order.
15448 * @see elm_toolbar_icon_order_lookup_set() for details.
15452 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15455 * Set whether the toolbar should always have an item selected.
15457 * @param obj The toolbar object.
15458 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
15461 * This will cause the toolbar to always have an item selected, and clicking
15462 * the selected item will not cause a selected event to be emitted. Enabling this mode
15463 * will immediately select the first toolbar item.
15465 * Always-selected is disabled by default.
15467 * @see elm_toolbar_always_select_mode_get().
15471 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15474 * Get whether the toolbar should always have an item selected.
15476 * @param obj The toolbar object.
15477 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
15478 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
15480 * @see elm_toolbar_always_select_mode_set() for details.
15484 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15487 * Set whether the toolbar items' should be selected by the user or not.
15489 * @param obj The toolbar object.
15490 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
15493 * This will turn off the ability to select items entirely and they will
15494 * neither appear selected nor emit selected signals. The clicked
15495 * callback function will still be called.
15497 * Selection is enabled by default.
15499 * @see elm_toolbar_no_select_mode_get().
15503 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
15506 * Set whether the toolbar items' should be selected by the user or not.
15508 * @param obj The toolbar object.
15509 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
15510 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
15512 * @see elm_toolbar_no_select_mode_set() for details.
15516 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15519 * Append item to the toolbar.
15521 * @param obj The toolbar object.
15522 * @param icon A string with icon name or the absolute path of an image file.
15523 * @param label The label of the item.
15524 * @param func The function to call when the item is clicked.
15525 * @param data The data to associate with the item for related callbacks.
15526 * @return The created item or @c NULL upon failure.
15528 * A new item will be created and appended to the toolbar, i.e., will
15529 * be set as @b last item.
15531 * Items created with this method can be deleted with
15532 * elm_toolbar_item_del().
15534 * Associated @p data can be properly freed when item is deleted if a
15535 * callback function is set with elm_toolbar_item_del_cb_set().
15537 * If a function is passed as argument, it will be called everytime this item
15538 * is selected, i.e., the user clicks over an unselected item.
15539 * If such function isn't needed, just passing
15540 * @c NULL as @p func is enough. The same should be done for @p data.
15542 * Toolbar will load icon image from fdo or current theme.
15543 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15544 * If an absolute path is provided it will load it direct from a file.
15546 * @see elm_toolbar_item_icon_set()
15547 * @see elm_toolbar_item_del()
15548 * @see elm_toolbar_item_del_cb_set()
15552 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);
15555 * Prepend item to the toolbar.
15557 * @param obj The toolbar object.
15558 * @param icon A string with icon name or the absolute path of an image file.
15559 * @param label The label of the item.
15560 * @param func The function to call when the item is clicked.
15561 * @param data The data to associate with the item for related callbacks.
15562 * @return The created item or @c NULL upon failure.
15564 * A new item will be created and prepended to the toolbar, i.e., will
15565 * be set as @b first item.
15567 * Items created with this method can be deleted with
15568 * elm_toolbar_item_del().
15570 * Associated @p data can be properly freed when item is deleted if a
15571 * callback function is set with elm_toolbar_item_del_cb_set().
15573 * If a function is passed as argument, it will be called everytime this item
15574 * is selected, i.e., the user clicks over an unselected item.
15575 * If such function isn't needed, just passing
15576 * @c NULL as @p func is enough. The same should be done for @p data.
15578 * Toolbar will load icon image from fdo or current theme.
15579 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15580 * If an absolute path is provided it will load it direct from a file.
15582 * @see elm_toolbar_item_icon_set()
15583 * @see elm_toolbar_item_del()
15584 * @see elm_toolbar_item_del_cb_set()
15588 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);
15591 * Insert a new item into the toolbar object before item @p before.
15593 * @param obj The toolbar object.
15594 * @param before The toolbar item to insert before.
15595 * @param icon A string with icon name or the absolute path of an image file.
15596 * @param label The label of the item.
15597 * @param func The function to call when the item is clicked.
15598 * @param data The data to associate with the item for related callbacks.
15599 * @return The created item or @c NULL upon failure.
15601 * A new item will be created and added to the toolbar. Its position in
15602 * this toolbar will be just before item @p before.
15604 * Items created with this method can be deleted with
15605 * elm_toolbar_item_del().
15607 * Associated @p data can be properly freed when item is deleted if a
15608 * callback function is set with elm_toolbar_item_del_cb_set().
15610 * If a function is passed as argument, it will be called everytime this item
15611 * is selected, i.e., the user clicks over an unselected item.
15612 * If such function isn't needed, just passing
15613 * @c NULL as @p func is enough. The same should be done for @p data.
15615 * Toolbar will load icon image from fdo or current theme.
15616 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15617 * If an absolute path is provided it will load it direct from a file.
15619 * @see elm_toolbar_item_icon_set()
15620 * @see elm_toolbar_item_del()
15621 * @see elm_toolbar_item_del_cb_set()
15625 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);
15628 * Insert a new item into the toolbar object after item @p after.
15630 * @param obj The toolbar object.
15631 * @param after The toolbar item to insert after.
15632 * @param icon A string with icon name or the absolute path of an image file.
15633 * @param label The label of the item.
15634 * @param func The function to call when the item is clicked.
15635 * @param data The data to associate with the item for related callbacks.
15636 * @return The created item or @c NULL upon failure.
15638 * A new item will be created and added to the toolbar. Its position in
15639 * this toolbar will be just after item @p after.
15641 * Items created with this method can be deleted with
15642 * elm_toolbar_item_del().
15644 * Associated @p data can be properly freed when item is deleted if a
15645 * callback function is set with elm_toolbar_item_del_cb_set().
15647 * If a function is passed as argument, it will be called everytime this item
15648 * is selected, i.e., the user clicks over an unselected item.
15649 * If such function isn't needed, just passing
15650 * @c NULL as @p func is enough. The same should be done for @p data.
15652 * Toolbar will load icon image from fdo or current theme.
15653 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15654 * If an absolute path is provided it will load it direct from a file.
15656 * @see elm_toolbar_item_icon_set()
15657 * @see elm_toolbar_item_del()
15658 * @see elm_toolbar_item_del_cb_set()
15662 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);
15665 * Get the first item in the given toolbar widget's list of
15668 * @param obj The toolbar object
15669 * @return The first item or @c NULL, if it has no items (and on
15672 * @see elm_toolbar_item_append()
15673 * @see elm_toolbar_last_item_get()
15677 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15680 * Get the last item in the given toolbar widget's list of
15683 * @param obj The toolbar object
15684 * @return The last item or @c NULL, if it has no items (and on
15687 * @see elm_toolbar_item_prepend()
15688 * @see elm_toolbar_first_item_get()
15692 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15695 * Get the item after @p item in toolbar.
15697 * @param it The toolbar item.
15698 * @return The item after @p item, or @c NULL if none or on failure.
15700 * @note If it is the last item, @c NULL will be returned.
15702 * @see elm_toolbar_item_append()
15706 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15709 * Get the item before @p item in toolbar.
15711 * @param item The toolbar item.
15712 * @return The item before @p item, or @c NULL if none or on failure.
15714 * @note If it is the first item, @c NULL will be returned.
15716 * @see elm_toolbar_item_prepend()
15720 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15723 * Get the toolbar object from an item.
15725 * @param it The item.
15726 * @return The toolbar object.
15728 * This returns the toolbar object itself that an item belongs to.
15730 * @deprecated use elm_object_item_object_get() instead.
15733 EINA_DEPRECATED EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15736 * Set the priority of a toolbar item.
15738 * @param it The toolbar item.
15739 * @param priority The item priority. The default is zero.
15741 * This is used only when the toolbar shrink mode is set to
15742 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15743 * When space is less than required, items with low priority
15744 * will be removed from the toolbar and added to a dynamically-created menu,
15745 * while items with higher priority will remain on the toolbar,
15746 * with the same order they were added.
15748 * @see elm_toolbar_item_priority_get()
15752 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15755 * Get the priority of a toolbar item.
15757 * @param it The toolbar item.
15758 * @return The @p item priority, or @c 0 on failure.
15760 * @see elm_toolbar_item_priority_set() for details.
15764 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15767 * Get the label of item.
15769 * @param it The item of toolbar.
15770 * @return The label of item.
15772 * The return value is a pointer to the label associated to @p item when
15773 * it was created, with function elm_toolbar_item_append() or similar,
15775 * with function elm_toolbar_item_label_set. If no label
15776 * was passed as argument, it will return @c NULL.
15778 * @see elm_toolbar_item_label_set() for more details.
15779 * @see elm_toolbar_item_append()
15781 * @deprecated use elm_object_item_text_get() instead.
15784 EINA_DEPRECATED EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15787 * Set the label of item.
15789 * @param it The item of toolbar.
15790 * @param text The label of item.
15792 * The label to be displayed by the item.
15793 * Label will be placed at icons bottom (if set).
15795 * If a label was passed as argument on item creation, with function
15796 * elm_toolbar_item_append() or similar, it will be already
15797 * displayed by the item.
15799 * @see elm_toolbar_item_label_get()
15800 * @see elm_toolbar_item_append()
15802 * @deprecated use elm_object_item_text_set() instead
15805 EINA_DEPRECATED EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15808 * Return the data associated with a given toolbar widget item.
15810 * @param it The toolbar widget item handle.
15811 * @return The data associated with @p item.
15813 * @see elm_toolbar_item_data_set()
15815 * @deprecated use elm_object_item_data_get() instead.
15818 EINA_DEPRECATED EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15821 * Set the data associated with a given toolbar widget item.
15823 * @param it The toolbar widget item handle
15824 * @param data The new data pointer to set to @p item.
15826 * This sets new item data on @p item.
15828 * @warning The old data pointer won't be touched by this function, so
15829 * the user had better to free that old data himself/herself.
15831 * @deprecated use elm_object_item_data_set() instead.
15834 EINA_DEPRECATED EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15837 * Returns a pointer to a toolbar item by its label.
15839 * @param obj The toolbar object.
15840 * @param label The label of the item to find.
15842 * @return The pointer to the toolbar item matching @p label or @c NULL
15847 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15850 * Get whether the @p item is selected or not.
15852 * @param it The toolbar item.
15853 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15854 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15856 * @see elm_toolbar_selected_item_set() for details.
15857 * @see elm_toolbar_item_selected_get()
15861 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15864 * Set the selected state of an item.
15866 * @param it The toolbar item
15867 * @param selected The selected state
15869 * This sets the selected state of the given item @p it.
15870 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15872 * If a new item is selected the previosly selected will be unselected.
15873 * Previoulsy selected item can be get with function
15874 * elm_toolbar_selected_item_get().
15876 * Selected items will be highlighted.
15878 * @see elm_toolbar_item_selected_get()
15879 * @see elm_toolbar_selected_item_get()
15883 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15886 * Get the selected item.
15888 * @param obj The toolbar object.
15889 * @return The selected toolbar item.
15891 * The selected item can be unselected with function
15892 * elm_toolbar_item_selected_set().
15894 * The selected item always will be highlighted on toolbar.
15896 * @see elm_toolbar_selected_items_get()
15900 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15903 * Set the icon associated with @p item.
15905 * @param obj The parent of this item.
15906 * @param it The toolbar item.
15907 * @param icon A string with icon name or the absolute path of an image file.
15909 * Toolbar will load icon image from fdo or current theme.
15910 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15911 * If an absolute path is provided it will load it direct from a file.
15913 * @see elm_toolbar_icon_order_lookup_set()
15914 * @see elm_toolbar_icon_order_lookup_get()
15918 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15921 * Get the string used to set the icon of @p item.
15923 * @param it The toolbar item.
15924 * @return The string associated with the icon object.
15926 * @see elm_toolbar_item_icon_set() for details.
15930 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15933 * Get the object of @p item.
15935 * @param it The toolbar item.
15936 * @return The object
15940 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15943 * Get the icon object of @p item.
15945 * @param it The toolbar item.
15946 * @return The icon object
15948 * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15949 * or elm_toolbar_item_icon_memfile_set() for details.
15953 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15956 * Set the icon associated with @p item to an image in a binary buffer.
15958 * @param it The toolbar item.
15959 * @param img The binary data that will be used as an image
15960 * @param size The size of binary data @p img
15961 * @param format Optional format of @p img to pass to the image loader
15962 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15964 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15966 * @note The icon image set by this function can be changed by
15967 * elm_toolbar_item_icon_set().
15971 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);
15974 * Set the icon associated with @p item to an image in a binary buffer.
15976 * @param it The toolbar item.
15977 * @param file The file that contains the image
15978 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15980 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15982 * @note The icon image set by this function can be changed by
15983 * elm_toolbar_item_icon_set().
15987 EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
15990 * Delete them item from the toolbar.
15992 * @param it The item of toolbar to be deleted.
15994 * @see elm_toolbar_item_append()
15995 * @see elm_toolbar_item_del_cb_set()
15999 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16002 * Set the function called when a toolbar item is freed.
16004 * @param it The item to set the callback on.
16005 * @param func The function called.
16007 * If there is a @p func, then it will be called prior item's memory release.
16008 * That will be called with the following arguments:
16010 * @li item's Evas object;
16013 * This way, a data associated to a toolbar item could be properly freed.
16017 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16020 * Get a value whether toolbar item is disabled or not.
16022 * @param it The item.
16023 * @return The disabled state.
16025 * @see elm_toolbar_item_disabled_set() for more details.
16027 * @deprecated use elm_object_item_disabled_get() instead.
16030 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16033 * Sets the disabled/enabled state of a toolbar item.
16035 * @param it The item.
16036 * @param disabled The disabled state.
16038 * A disabled item cannot be selected or unselected. It will also
16039 * change its appearance (generally greyed out). This sets the
16040 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16043 * @deprecated use elm_object_item_disabled_set() instead.
16046 EINA_DEPRECATED EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16049 * Set or unset item as a separator.
16051 * @param it The toolbar item.
16052 * @param setting @c EINA_TRUE to set item @p item as separator or
16053 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16055 * Items aren't set as separator by default.
16057 * If set as separator it will display separator theme, so won't display
16060 * @see elm_toolbar_item_separator_get()
16064 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
16067 * Get a value whether item is a separator or not.
16069 * @param it The toolbar item.
16070 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16071 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16073 * @see elm_toolbar_item_separator_set() for details.
16077 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16080 * Set the shrink state of toolbar @p obj.
16082 * @param obj The toolbar object.
16083 * @param shrink_mode Toolbar's items display behavior.
16085 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
16086 * but will enforce a minimun size so all the items will fit, won't scroll
16087 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
16088 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
16089 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
16093 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
16096 * Get the shrink mode of toolbar @p obj.
16098 * @param obj The toolbar object.
16099 * @return Toolbar's items display behavior.
16101 * @see elm_toolbar_mode_shrink_set() for details.
16105 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16108 * Enable/disable homogeneous mode.
16110 * @param obj The toolbar object
16111 * @param homogeneous Assume the items within the toolbar are of the
16112 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
16114 * This will enable the homogeneous mode where items are of the same size.
16115 * @see elm_toolbar_homogeneous_get()
16119 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16122 * Get whether the homogeneous mode is enabled.
16124 * @param obj The toolbar object.
16125 * @return Assume the items within the toolbar are of the same height
16126 * and width (EINA_TRUE = on, EINA_FALSE = off).
16128 * @see elm_toolbar_homogeneous_set()
16132 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16135 * Set the parent object of the toolbar items' menus.
16137 * @param obj The toolbar object.
16138 * @param parent The parent of the menu objects.
16140 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
16142 * For more details about setting the parent for toolbar menus, see
16143 * elm_menu_parent_set().
16145 * @see elm_menu_parent_set() for details.
16146 * @see elm_toolbar_item_menu_set() for details.
16150 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16153 * Get the parent object of the toolbar items' menus.
16155 * @param obj The toolbar object.
16156 * @return The parent of the menu objects.
16158 * @see elm_toolbar_menu_parent_set() for details.
16162 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16165 * Set the alignment of the items.
16167 * @param obj The toolbar object.
16168 * @param align The new alignment, a float between <tt> 0.0 </tt>
16169 * and <tt> 1.0 </tt>.
16171 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
16172 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
16175 * Centered items by default.
16177 * @see elm_toolbar_align_get()
16181 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
16184 * Get the alignment of the items.
16186 * @param obj The toolbar object.
16187 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
16190 * @see elm_toolbar_align_set() for details.
16194 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16197 * Set whether the toolbar item opens a menu.
16199 * @param it The toolbar item.
16200 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
16202 * A toolbar item can be set to be a menu, using this function.
16204 * Once it is set to be a menu, it can be manipulated through the
16205 * menu-like function elm_toolbar_menu_parent_set() and the other
16206 * elm_menu functions, using the Evas_Object @c menu returned by
16207 * elm_toolbar_item_menu_get().
16209 * So, items to be displayed in this item's menu should be added with
16210 * elm_menu_item_add().
16212 * The following code exemplifies the most basic usage:
16214 * tb = elm_toolbar_add(win)
16215 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
16216 * elm_toolbar_item_menu_set(item, EINA_TRUE);
16217 * elm_toolbar_menu_parent_set(tb, win);
16218 * menu = elm_toolbar_item_menu_get(item);
16219 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
16220 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
16224 * @see elm_toolbar_item_menu_get()
16228 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
16231 * Get toolbar item's menu.
16233 * @param it The toolbar item.
16234 * @return Item's menu object or @c NULL on failure.
16236 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
16237 * this function will set it.
16239 * @see elm_toolbar_item_menu_set() for details.
16243 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16246 * Add a new state to @p item.
16248 * @param it The toolbar item.
16249 * @param icon A string with icon name or the absolute path of an image file.
16250 * @param label The label of the new state.
16251 * @param func The function to call when the item is clicked when this
16252 * state is selected.
16253 * @param data The data to associate with the state.
16254 * @return The toolbar item state, or @c NULL upon failure.
16256 * Toolbar will load icon image from fdo or current theme.
16257 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
16258 * If an absolute path is provided it will load it direct from a file.
16260 * States created with this function can be removed with
16261 * elm_toolbar_item_state_del().
16263 * @see elm_toolbar_item_state_del()
16264 * @see elm_toolbar_item_state_sel()
16265 * @see elm_toolbar_item_state_get()
16269 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);
16272 * Delete a previoulsy added state to @p item.
16274 * @param it The toolbar item.
16275 * @param state The state to be deleted.
16276 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16278 * @see elm_toolbar_item_state_add()
16280 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16283 * Set @p state as the current state of @p it.
16285 * @param it The toolbar item.
16286 * @param state The state to use.
16287 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16289 * If @p state is @c NULL, it won't select any state and the default item's
16290 * icon and label will be used. It's the same behaviour than
16291 * elm_toolbar_item_state_unser().
16293 * @see elm_toolbar_item_state_unset()
16297 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16300 * Unset the state of @p it.
16302 * @param it The toolbar item.
16304 * The default icon and label from this item will be displayed.
16306 * @see elm_toolbar_item_state_set() for more details.
16310 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16313 * Get the current state of @p it.
16315 * @param it The toolbar item.
16316 * @return The selected state or @c NULL if none is selected or on failure.
16318 * @see elm_toolbar_item_state_set() for details.
16319 * @see elm_toolbar_item_state_unset()
16320 * @see elm_toolbar_item_state_add()
16324 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16327 * Get the state after selected state in toolbar's @p item.
16329 * @param it The toolbar item to change state.
16330 * @return The state after current state, or @c NULL on failure.
16332 * If last state is selected, this function will return first state.
16334 * @see elm_toolbar_item_state_set()
16335 * @see elm_toolbar_item_state_add()
16339 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16342 * Get the state before selected state in toolbar's @p item.
16344 * @param it The toolbar item to change state.
16345 * @return The state before current state, or @c NULL on failure.
16347 * If first state is selected, this function will return last state.
16349 * @see elm_toolbar_item_state_set()
16350 * @see elm_toolbar_item_state_add()
16354 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16357 * Set the text to be shown in a given toolbar item's tooltips.
16359 * @param it toolbar item.
16360 * @param text The text to set in the content.
16362 * Setup the text as tooltip to object. The item can have only one tooltip,
16363 * so any previous tooltip data - set with this function or
16364 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
16366 * @see elm_object_tooltip_text_set() for more details.
16370 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
16373 * Set the content to be shown in the tooltip item.
16375 * Setup the tooltip to item. The item can have only one tooltip,
16376 * so any previous tooltip data is removed. @p func(with @p data) will
16377 * be called every time that need show the tooltip and it should
16378 * return a valid Evas_Object. This object is then managed fully by
16379 * tooltip system and is deleted when the tooltip is gone.
16381 * @param it the toolbar item being attached a tooltip.
16382 * @param func the function used to create the tooltip contents.
16383 * @param data what to provide to @a func as callback data/context.
16384 * @param del_cb called when data is not needed anymore, either when
16385 * another callback replaces @a func, the tooltip is unset with
16386 * elm_toolbar_item_tooltip_unset() or the owner @a item
16387 * dies. This callback receives as the first parameter the
16388 * given @a data, and @c event_info is the item.
16390 * @see elm_object_tooltip_content_cb_set() for more details.
16394 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);
16397 * Unset tooltip from item.
16399 * @param it toolbar item to remove previously set tooltip.
16401 * Remove tooltip from item. The callback provided as del_cb to
16402 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
16403 * it is not used anymore.
16405 * @see elm_object_tooltip_unset() for more details.
16406 * @see elm_toolbar_item_tooltip_content_cb_set()
16410 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16413 * Sets a different style for this item tooltip.
16415 * @note before you set a style you should define a tooltip with
16416 * elm_toolbar_item_tooltip_content_cb_set() or
16417 * elm_toolbar_item_tooltip_text_set()
16419 * @param it toolbar item with tooltip already set.
16420 * @param style the theme style to use (default, transparent, ...)
16422 * @see elm_object_tooltip_style_set() for more details.
16426 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16429 * Get the style for this item tooltip.
16431 * @param it toolbar item with tooltip already set.
16432 * @return style the theme style in use, defaults to "default". If the
16433 * object does not have a tooltip set, then NULL is returned.
16435 * @see elm_object_tooltip_style_get() for more details.
16436 * @see elm_toolbar_item_tooltip_style_set()
16440 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16443 * Set the type of mouse pointer/cursor decoration to be shown,
16444 * when the mouse pointer is over the given toolbar widget item
16446 * @param it toolbar item to customize cursor on
16447 * @param cursor the cursor type's name
16449 * This function works analogously as elm_object_cursor_set(), but
16450 * here the cursor's changing area is restricted to the item's
16451 * area, and not the whole widget's. Note that that item cursors
16452 * have precedence over widget cursors, so that a mouse over an
16453 * item with custom cursor set will always show @b that cursor.
16455 * If this function is called twice for an object, a previously set
16456 * cursor will be unset on the second call.
16458 * @see elm_object_cursor_set()
16459 * @see elm_toolbar_item_cursor_get()
16460 * @see elm_toolbar_item_cursor_unset()
16464 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
16467 * Get the type of mouse pointer/cursor decoration set to be shown,
16468 * when the mouse pointer is over the given toolbar widget item
16470 * @param it toolbar item with custom cursor set
16471 * @return the cursor type's name or @c NULL, if no custom cursors
16472 * were set to @p item (and on errors)
16474 * @see elm_object_cursor_get()
16475 * @see elm_toolbar_item_cursor_set()
16476 * @see elm_toolbar_item_cursor_unset()
16480 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16483 * Unset any custom mouse pointer/cursor decoration set to be
16484 * shown, when the mouse pointer is over the given toolbar widget
16485 * item, thus making it show the @b default cursor again.
16487 * @param it a toolbar item
16489 * Use this call to undo any custom settings on this item's cursor
16490 * decoration, bringing it back to defaults (no custom style set).
16492 * @see elm_object_cursor_unset()
16493 * @see elm_toolbar_item_cursor_set()
16497 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16500 * Set a different @b style for a given custom cursor set for a
16503 * @param it toolbar item with custom cursor set
16504 * @param style the <b>theme style</b> to use (e.g. @c "default",
16505 * @c "transparent", etc)
16507 * This function only makes sense when one is using custom mouse
16508 * cursor decorations <b>defined in a theme file</b>, which can have,
16509 * given a cursor name/type, <b>alternate styles</b> on it. It
16510 * works analogously as elm_object_cursor_style_set(), but here
16511 * applyed only to toolbar item objects.
16513 * @warning Before you set a cursor style you should have definen a
16514 * custom cursor previously on the item, with
16515 * elm_toolbar_item_cursor_set()
16517 * @see elm_toolbar_item_cursor_engine_only_set()
16518 * @see elm_toolbar_item_cursor_style_get()
16522 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16525 * Get the current @b style set for a given toolbar item's custom
16528 * @param it toolbar item with custom cursor set.
16529 * @return style the cursor style in use. If the object does not
16530 * have a cursor set, then @c NULL is returned.
16532 * @see elm_toolbar_item_cursor_style_set() for more details
16536 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16539 * Set if the (custom)cursor for a given toolbar item should be
16540 * searched in its theme, also, or should only rely on the
16541 * rendering engine.
16543 * @param it item with custom (custom) cursor already set on
16544 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16545 * only on those provided by the rendering engine, @c EINA_FALSE to
16546 * have them searched on the widget's theme, as well.
16548 * @note This call is of use only if you've set a custom cursor
16549 * for toolbar items, with elm_toolbar_item_cursor_set().
16551 * @note By default, cursors will only be looked for between those
16552 * provided by the rendering engine.
16556 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16559 * Get if the (custom) cursor for a given toolbar item is being
16560 * searched in its theme, also, or is only relying on the rendering
16563 * @param it a toolbar item
16564 * @return @c EINA_TRUE, if cursors are being looked for only on
16565 * those provided by the rendering engine, @c EINA_FALSE if they
16566 * are being searched on the widget's theme, as well.
16568 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
16572 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16575 * Change a toolbar's orientation
16576 * @param obj The toolbar object
16577 * @param vertical If @c EINA_TRUE, the toolbar is vertical
16578 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16580 * @deprecated use elm_toolbar_horizontal_set() instead.
16582 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
16585 * Change a toolbar's orientation
16586 * @param obj The toolbar object
16587 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
16588 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16591 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16594 * Get a toolbar's orientation
16595 * @param obj The toolbar object
16596 * @return If @c EINA_TRUE, the toolbar is vertical
16597 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16599 * @deprecated use elm_toolbar_horizontal_get() instead.
16601 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16604 * Get a toolbar's orientation
16605 * @param obj The toolbar object
16606 * @return If @c EINA_TRUE, the toolbar is horizontal
16607 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16610 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16616 * @defgroup Tooltips Tooltips
16618 * The Tooltip is an (internal, for now) smart object used to show a
16619 * content in a frame on mouse hover of objects(or widgets), with
16620 * tips/information about them.
16625 EAPI double elm_tooltip_delay_get(void);
16626 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
16627 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16628 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16629 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16630 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16631 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16632 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);
16633 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16634 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16635 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16636 EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16637 EAPI Eina_Bool elm_object_tooltip_window_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16644 * @defgroup Cursors Cursors
16646 * The Elementary cursor is an internal smart object used to
16647 * customize the mouse cursor displayed over objects (or
16648 * widgets). In the most common scenario, the cursor decoration
16649 * comes from the graphical @b engine Elementary is running
16650 * on. Those engines may provide different decorations for cursors,
16651 * and Elementary provides functions to choose them (think of X11
16652 * cursors, as an example).
16654 * There's also the possibility of, besides using engine provided
16655 * cursors, also use ones coming from Edje theming files. Both
16656 * globally and per widget, Elementary makes it possible for one to
16657 * make the cursors lookup to be held on engines only or on
16658 * Elementary's theme file, too. To set cursor's hot spot,
16659 * two data items should be added to cursor's theme: "hot_x" and
16660 * "hot_y", that are the offset from upper-left corner of the cursor
16661 * (coordinates 0,0).
16667 * Set the cursor to be shown when mouse is over the object
16669 * Set the cursor that will be displayed when mouse is over the
16670 * object. The object can have only one cursor set to it, so if
16671 * this function is called twice for an object, the previous set
16673 * If using X cursors, a definition of all the valid cursor names
16674 * is listed on Elementary_Cursors.h. If an invalid name is set
16675 * the default cursor will be used.
16677 * @param obj the object being set a cursor.
16678 * @param cursor the cursor name to be used.
16682 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16685 * Get the cursor to be shown when mouse is over the object
16687 * @param obj an object with cursor already set.
16688 * @return the cursor name.
16692 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16695 * Unset cursor for object
16697 * Unset cursor for object, and set the cursor to default if the mouse
16698 * was over this object.
16700 * @param obj Target object
16701 * @see elm_object_cursor_set()
16705 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16708 * Sets a different style for this object cursor.
16710 * @note before you set a style you should define a cursor with
16711 * elm_object_cursor_set()
16713 * @param obj an object with cursor already set.
16714 * @param style the theme style to use (default, transparent, ...)
16718 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16721 * Get the style for this object cursor.
16723 * @param obj an object with cursor already set.
16724 * @return style the theme style in use, defaults to "default". If the
16725 * object does not have a cursor set, then NULL is returned.
16729 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16732 * Set if the cursor set should be searched on the theme or should use
16733 * the provided by the engine, only.
16735 * @note before you set if should look on theme you should define a cursor
16736 * with elm_object_cursor_set(). By default it will only look for cursors
16737 * provided by the engine.
16739 * @param obj an object with cursor already set.
16740 * @param engine_only boolean to define it cursors should be looked only
16741 * between the provided by the engine or searched on widget's theme as well.
16745 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16748 * Get the cursor engine only usage for this object cursor.
16750 * @param obj an object with cursor already set.
16751 * @return engine_only boolean to define it cursors should be
16752 * looked only between the provided by the engine or searched on
16753 * widget's theme as well. If the object does not have a cursor
16754 * set, then EINA_FALSE is returned.
16758 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16761 * Get the configured cursor engine only usage
16763 * This gets the globally configured exclusive usage of engine cursors.
16765 * @return 1 if only engine cursors should be used
16768 EAPI int elm_cursor_engine_only_get(void);
16771 * Set the configured cursor engine only usage
16773 * This sets the globally configured exclusive usage of engine cursors.
16774 * It won't affect cursors set before changing this value.
16776 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16777 * look for them on theme before.
16778 * @return EINA_TRUE if value is valid and setted (0 or 1)
16781 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
16788 * @defgroup Menu Menu
16790 * @image html img/widget/menu/preview-00.png
16791 * @image latex img/widget/menu/preview-00.eps
16793 * A menu is a list of items displayed above its parent. When the menu is
16794 * showing its parent is darkened. Each item can have a sub-menu. The menu
16795 * object can be used to display a menu on a right click event, in a toolbar,
16798 * Signals that you can add callbacks for are:
16799 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16801 * Default contents parts of the menu items that you can use for are:
16802 * @li "default" - A main content of the menu item
16804 * Default text parts of the menu items that you can use for are:
16805 * @li "default" - label in the menu item
16807 * @see @ref tutorial_menu
16812 * @brief Add a new menu to the parent
16814 * @param parent The parent object.
16815 * @return The new object or NULL if it cannot be created.
16817 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16820 * @brief Set the parent for the given menu widget
16822 * @param obj The menu object.
16823 * @param parent The new parent.
16825 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16828 * @brief Get the parent for the given menu widget
16830 * @param obj The menu object.
16831 * @return The parent.
16833 * @see elm_menu_parent_set()
16835 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16838 * @brief Move the menu to a new position
16840 * @param obj The menu object.
16841 * @param x The new position.
16842 * @param y The new position.
16844 * Sets the top-left position of the menu to (@p x,@p y).
16846 * @note @p x and @p y coordinates are relative to parent.
16848 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16851 * @brief Close a opened menu
16853 * @param obj the menu object
16856 * Hides the menu and all it's sub-menus.
16858 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16861 * @brief Returns a list of @p item's items.
16863 * @param obj The menu object
16864 * @return An Eina_List* of @p item's items
16866 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16869 * @brief Get the Evas_Object of an Elm_Object_Item
16871 * @param it The menu item object.
16872 * @return The edje object containing the swallowed content
16874 * @warning Don't manipulate this object!
16877 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16880 * @brief Add an item at the end of the given menu widget
16882 * @param obj The menu object.
16883 * @param parent The parent menu item (optional)
16884 * @param icon An icon display on the item. The icon will be destryed by the menu.
16885 * @param label The label of the item.
16886 * @param func Function called when the user select the item.
16887 * @param data Data sent by the callback.
16888 * @return Returns the new item.
16890 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);
16893 * @brief Add an object swallowed in an item at the end of the given menu
16896 * @param obj The menu object.
16897 * @param parent The parent menu item (optional)
16898 * @param subobj The object to swallow
16899 * @param func Function called when the user select the item.
16900 * @param data Data sent by the callback.
16901 * @return Returns the new item.
16903 * Add an evas object as an item to the menu.
16905 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);
16908 * @brief Set the label of a menu item
16910 * @param it The menu item object.
16911 * @param label The label to set for @p item
16913 * @warning Don't use this funcion on items created with
16914 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16916 * @deprecated Use elm_object_item_text_set() instead
16918 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16921 * @brief Get the label of a menu item
16923 * @param it The menu item object.
16924 * @return The label of @p item
16925 * @deprecated Use elm_object_item_text_get() instead
16927 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16930 * @brief Set the icon of a menu item to the standard icon with name @p icon
16932 * @param it The menu item object.
16933 * @param icon The icon object to set for the content of @p item
16935 * Once this icon is set, any previously set icon will be deleted.
16937 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16940 * @brief Get the string representation from the icon of a menu item
16942 * @param it The menu item object.
16943 * @return The string representation of @p item's icon or NULL
16945 * @see elm_menu_item_object_icon_name_set()
16947 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16950 * @brief Set the content object of a menu item
16952 * @param it The menu item object
16953 * @param The content object or NULL
16954 * @return EINA_TRUE on success, else EINA_FALSE
16956 * Use this function to change the object swallowed by a menu item, deleting
16957 * any previously swallowed object.
16959 * @deprecated Use elm_object_item_content_set() instead
16961 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16964 * @brief Get the content object of a menu item
16966 * @param it The menu item object
16967 * @return The content object or NULL
16968 * @note If @p item was added with elm_menu_item_add_object, this
16969 * function will return the object passed, else it will return the
16972 * @see elm_menu_item_object_content_set()
16974 * @deprecated Use elm_object_item_content_get() instead
16976 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16979 * @brief Set the selected state of @p item.
16981 * @param it The menu item object.
16982 * @param selected The selected/unselected state of the item
16984 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16987 * @brief Get the selected state of @p item.
16989 * @param it The menu item object.
16990 * @return The selected/unselected state of the item
16992 * @see elm_menu_item_selected_set()
16994 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16997 * @brief Set the disabled state of @p item.
16999 * @param it The menu item object.
17000 * @param disabled The enabled/disabled state of the item
17001 * @deprecated Use elm_object_item_disabled_set() instead
17003 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17006 * @brief Get the disabled state of @p item.
17008 * @param it The menu item object.
17009 * @return The enabled/disabled state of the item
17011 * @see elm_menu_item_disabled_set()
17012 * @deprecated Use elm_object_item_disabled_get() instead
17014 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17017 * @brief Add a separator item to menu @p obj under @p parent.
17019 * @param obj The menu object
17020 * @param parent The item to add the separator under
17021 * @return The created item or NULL on failure
17023 * This is item is a @ref Separator.
17025 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
17028 * @brief Returns whether @p item is a separator.
17030 * @param it The item to check
17031 * @return If true, @p item is a separator
17033 * @see elm_menu_item_separator_add()
17035 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17038 * @brief Deletes an item from the menu.
17040 * @param it The item to delete.
17042 * @see elm_menu_item_add()
17044 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17047 * @brief Set the function called when a menu item is deleted.
17049 * @param it The item to set the callback on
17050 * @param func The function called
17052 * @see elm_menu_item_add()
17053 * @see elm_menu_item_del()
17055 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17058 * @brief Returns the data associated with menu item @p item.
17060 * @param it The item
17061 * @return The data associated with @p item or NULL if none was set.
17063 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
17065 * @deprecated Use elm_object_item_data_get() instead
17067 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17070 * @brief Sets the data to be associated with menu item @p item.
17072 * @param it The item
17073 * @param data The data to be associated with @p item
17075 * @deprecated Use elm_object_item_data_set() instead
17077 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
17080 * @brief Returns a list of @p item's subitems.
17082 * @param it The item
17083 * @return An Eina_List* of @p item's subitems
17085 * @see elm_menu_add()
17087 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17090 * @brief Get the position of a menu item
17092 * @param it The menu item
17093 * @return The item's index
17095 * This function returns the index position of a menu item in a menu.
17096 * For a sub-menu, this number is relative to the first item in the sub-menu.
17098 * @note Index values begin with 0
17100 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17103 * @brief @brief Return a menu item's owner menu
17105 * @param it The menu item
17106 * @return The menu object owning @p item, or NULL on failure
17108 * Use this function to get the menu object owning an item.
17110 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17113 * @brief Get the selected item in the menu
17115 * @param obj The menu object
17116 * @return The selected item, or NULL if none
17118 * @see elm_menu_item_selected_get()
17119 * @see elm_menu_item_selected_set()
17121 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17124 * @brief Get the last item in the menu
17126 * @param obj The menu object
17127 * @return The last item, or NULL if none
17129 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17132 * @brief Get the first item in the menu
17134 * @param obj The menu object
17135 * @return The first item, or NULL if none
17137 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17140 * @brief Get the next item in the menu.
17142 * @param it The menu item object.
17143 * @return The item after it, or NULL if none
17145 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17148 * @brief Get the previous item in the menu.
17150 * @param it The menu item object.
17151 * @return The item before it, or NULL if none
17153 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17160 * @defgroup List List
17161 * @ingroup Elementary
17163 * @image html img/widget/list/preview-00.png
17164 * @image latex img/widget/list/preview-00.eps width=\textwidth
17166 * @image html img/list.png
17167 * @image latex img/list.eps width=\textwidth
17169 * A list widget is a container whose children are displayed vertically or
17170 * horizontally, in order, and can be selected.
17171 * The list can accept only one or multiple items selection. Also has many
17172 * modes of items displaying.
17174 * A list is a very simple type of list widget. For more robust
17175 * lists, @ref Genlist should probably be used.
17177 * Smart callbacks one can listen to:
17178 * - @c "activated" - The user has double-clicked or pressed
17179 * (enter|return|spacebar) on an item. The @c event_info parameter
17180 * is the item that was activated.
17181 * - @c "clicked,double" - The user has double-clicked an item.
17182 * The @c event_info parameter is the item that was double-clicked.
17183 * - "selected" - when the user selected an item
17184 * - "unselected" - when the user unselected an item
17185 * - "longpressed" - an item in the list is long-pressed
17186 * - "edge,top" - the list is scrolled until the top edge
17187 * - "edge,bottom" - the list is scrolled until the bottom edge
17188 * - "edge,left" - the list is scrolled until the left edge
17189 * - "edge,right" - the list is scrolled until the right edge
17190 * - "language,changed" - the program's language changed
17192 * Available styles for it:
17195 * List of examples:
17196 * @li @ref list_example_01
17197 * @li @ref list_example_02
17198 * @li @ref list_example_03
17207 * @enum _Elm_List_Mode
17208 * @typedef Elm_List_Mode
17210 * Set list's resize behavior, transverse axis scroll and
17211 * items cropping. See each mode's description for more details.
17213 * @note Default value is #ELM_LIST_SCROLL.
17215 * Values <b> don't </b> work as bitmask, only one can be choosen.
17217 * @see elm_list_mode_set()
17218 * @see elm_list_mode_get()
17222 typedef enum _Elm_List_Mode
17224 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. */
17225 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). */
17226 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. */
17227 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. */
17228 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
17231 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(). */
17234 * Add a new list widget to the given parent Elementary
17235 * (container) object.
17237 * @param parent The parent object.
17238 * @return a new list widget handle or @c NULL, on errors.
17240 * This function inserts a new list widget on the canvas.
17244 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17249 * @param obj The list object
17251 * @note Call before running show() on the list object.
17252 * @warning If not called, it won't display the list properly.
17255 * li = elm_list_add(win);
17256 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
17257 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
17259 * evas_object_show(li);
17264 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
17267 * Enable or disable multiple items selection on the list object.
17269 * @param obj The list object
17270 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
17273 * Disabled by default. If disabled, the user can select a single item of
17274 * the list each time. Selected items are highlighted on list.
17275 * If enabled, many items can be selected.
17277 * If a selected item is selected again, it will be unselected.
17279 * @see elm_list_multi_select_get()
17283 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17286 * Get a value whether multiple items selection is enabled or not.
17288 * @see elm_list_multi_select_set() for details.
17290 * @param obj The list object.
17291 * @return @c EINA_TRUE means multiple items selection is enabled.
17292 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17293 * @c EINA_FALSE is returned.
17297 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17300 * Set which mode to use for the list object.
17302 * @param obj The list object
17303 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17304 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
17306 * Set list's resize behavior, transverse axis scroll and
17307 * items cropping. See each mode's description for more details.
17309 * @note Default value is #ELM_LIST_SCROLL.
17311 * Only one can be set, if a previous one was set, it will be changed
17312 * by the new mode set. Bitmask won't work as well.
17314 * @see elm_list_mode_get()
17318 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17321 * Get the mode the list is at.
17323 * @param obj The list object
17324 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17325 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
17327 * @note see elm_list_mode_set() for more information.
17331 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17334 * Enable or disable horizontal mode on the list object.
17336 * @param obj The list object.
17337 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
17338 * disable it, i.e., to enable vertical mode.
17340 * @note Vertical mode is set by default.
17342 * On horizontal mode items are displayed on list from left to right,
17343 * instead of from top to bottom. Also, the list will scroll horizontally.
17344 * Each item will presents left icon on top and right icon, or end, at
17347 * @see elm_list_horizontal_get()
17351 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17354 * Get a value whether horizontal mode is enabled or not.
17356 * @param obj The list object.
17357 * @return @c EINA_TRUE means horizontal mode selection is enabled.
17358 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17359 * @c EINA_FALSE is returned.
17361 * @see elm_list_horizontal_set() for details.
17365 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17368 * Enable or disable always select mode on the list object.
17370 * @param obj The list object
17371 * @param always_select @c EINA_TRUE to enable always select mode or
17372 * @c EINA_FALSE to disable it.
17374 * @note Always select mode is disabled by default.
17376 * Default behavior of list items is to only call its callback function
17377 * the first time it's pressed, i.e., when it is selected. If a selected
17378 * item is pressed again, and multi-select is disabled, it won't call
17379 * this function (if multi-select is enabled it will unselect the item).
17381 * If always select is enabled, it will call the callback function
17382 * everytime a item is pressed, so it will call when the item is selected,
17383 * and again when a selected item is pressed.
17385 * @see elm_list_always_select_mode_get()
17386 * @see elm_list_multi_select_set()
17390 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17393 * Get a value whether always select mode is enabled or not, meaning that
17394 * an item will always call its callback function, even if already selected.
17396 * @param obj The list object
17397 * @return @c EINA_TRUE means horizontal mode selection is enabled.
17398 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17399 * @c EINA_FALSE is returned.
17401 * @see elm_list_always_select_mode_set() for details.
17405 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17408 * Set bouncing behaviour when the scrolled content reaches an edge.
17410 * Tell the internal scroller object whether it should bounce or not
17411 * when it reaches the respective edges for each axis.
17413 * @param obj The list object
17414 * @param h_bounce Whether to bounce or not in the horizontal axis.
17415 * @param v_bounce Whether to bounce or not in the vertical axis.
17417 * @see elm_scroller_bounce_set()
17421 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17424 * Get the bouncing behaviour of the internal scroller.
17426 * Get whether the internal scroller should bounce when the edge of each
17427 * axis is reached scrolling.
17429 * @param obj The list object.
17430 * @param h_bounce Pointer where to store the bounce state of the horizontal
17432 * @param v_bounce Pointer where to store the bounce state of the vertical
17435 * @see elm_scroller_bounce_get()
17436 * @see elm_list_bounce_set()
17440 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17443 * Set the scrollbar policy.
17445 * @param obj The list object
17446 * @param policy_h Horizontal scrollbar policy.
17447 * @param policy_v Vertical scrollbar policy.
17449 * This sets the scrollbar visibility policy for the given scroller.
17450 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
17451 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
17452 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
17453 * This applies respectively for the horizontal and vertical scrollbars.
17455 * The both are disabled by default, i.e., are set to
17456 * #ELM_SCROLLER_POLICY_OFF.
17460 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17463 * Get the scrollbar policy.
17465 * @see elm_list_scroller_policy_get() for details.
17467 * @param obj The list object.
17468 * @param policy_h Pointer where to store horizontal scrollbar policy.
17469 * @param policy_v Pointer where to store vertical scrollbar policy.
17473 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);
17476 * Append a new item to the list object.
17478 * @param obj The list object.
17479 * @param label The label of the list item.
17480 * @param icon The icon object to use for the left side of the item. An
17481 * icon can be any Evas object, but usually it is an icon created
17482 * with elm_icon_add().
17483 * @param end The icon object to use for the right side of the item. An
17484 * icon can be any Evas object.
17485 * @param func The function to call when the item is clicked.
17486 * @param data The data to associate with the item for related callbacks.
17488 * @return The created item or @c NULL upon failure.
17490 * A new item will be created and appended to the list, i.e., will
17491 * be set as @b last item.
17493 * Items created with this method can be deleted with
17494 * elm_list_item_del().
17496 * Associated @p data can be properly freed when item is deleted if a
17497 * callback function is set with elm_list_item_del_cb_set().
17499 * If a function is passed as argument, it will be called everytime this item
17500 * is selected, i.e., the user clicks over an unselected item.
17501 * If always select is enabled it will call this function every time
17502 * user clicks over an item (already selected or not).
17503 * If such function isn't needed, just passing
17504 * @c NULL as @p func is enough. The same should be done for @p data.
17506 * Simple example (with no function callback or data associated):
17508 * li = elm_list_add(win);
17509 * ic = elm_icon_add(win);
17510 * elm_icon_file_set(ic, "path/to/image", NULL);
17511 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
17512 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
17514 * evas_object_show(li);
17517 * @see elm_list_always_select_mode_set()
17518 * @see elm_list_item_del()
17519 * @see elm_list_item_del_cb_set()
17520 * @see elm_list_clear()
17521 * @see elm_icon_add()
17525 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);
17528 * Prepend a new item to the list object.
17530 * @param obj The list object.
17531 * @param label The label of the list item.
17532 * @param icon The icon object to use for the left side of the item. An
17533 * icon can be any Evas object, but usually it is an icon created
17534 * with elm_icon_add().
17535 * @param end The icon object to use for the right side of the item. An
17536 * icon can be any Evas object.
17537 * @param func The function to call when the item is clicked.
17538 * @param data The data to associate with the item for related callbacks.
17540 * @return The created item or @c NULL upon failure.
17542 * A new item will be created and prepended to the list, i.e., will
17543 * be set as @b first item.
17545 * Items created with this method can be deleted with
17546 * elm_list_item_del().
17548 * Associated @p data can be properly freed when item is deleted if a
17549 * callback function is set with elm_list_item_del_cb_set().
17551 * If a function is passed as argument, it will be called everytime this item
17552 * is selected, i.e., the user clicks over an unselected item.
17553 * If always select is enabled it will call this function every time
17554 * user clicks over an item (already selected or not).
17555 * If such function isn't needed, just passing
17556 * @c NULL as @p func is enough. The same should be done for @p data.
17558 * @see elm_list_item_append() for a simple code example.
17559 * @see elm_list_always_select_mode_set()
17560 * @see elm_list_item_del()
17561 * @see elm_list_item_del_cb_set()
17562 * @see elm_list_clear()
17563 * @see elm_icon_add()
17567 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);
17570 * Insert a new item into the list object before item @p before.
17572 * @param obj The list object.
17573 * @param before The list item to insert before.
17574 * @param label The label of the list item.
17575 * @param icon The icon object to use for the left side of the item. An
17576 * icon can be any Evas object, but usually it is an icon created
17577 * with elm_icon_add().
17578 * @param end The icon object to use for the right side of the item. An
17579 * icon can be any Evas object.
17580 * @param func The function to call when the item is clicked.
17581 * @param data The data to associate with the item for related callbacks.
17583 * @return The created item or @c NULL upon failure.
17585 * A new item will be created and added to the list. Its position in
17586 * this list will be just before item @p before.
17588 * Items created with this method can be deleted with
17589 * elm_list_item_del().
17591 * Associated @p data can be properly freed when item is deleted if a
17592 * callback function is set with elm_list_item_del_cb_set().
17594 * If a function is passed as argument, it will be called everytime this item
17595 * is selected, i.e., the user clicks over an unselected item.
17596 * If always select is enabled it will call this function every time
17597 * user clicks over an item (already selected or not).
17598 * If such function isn't needed, just passing
17599 * @c NULL as @p func is enough. The same should be done for @p data.
17601 * @see elm_list_item_append() for a simple code example.
17602 * @see elm_list_always_select_mode_set()
17603 * @see elm_list_item_del()
17604 * @see elm_list_item_del_cb_set()
17605 * @see elm_list_clear()
17606 * @see elm_icon_add()
17610 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);
17613 * Insert a new item into the list object after item @p after.
17615 * @param obj The list object.
17616 * @param after The list item to insert after.
17617 * @param label The label of the list item.
17618 * @param icon The icon object to use for the left side of the item. An
17619 * icon can be any Evas object, but usually it is an icon created
17620 * with elm_icon_add().
17621 * @param end The icon object to use for the right side of the item. An
17622 * icon can be any Evas object.
17623 * @param func The function to call when the item is clicked.
17624 * @param data The data to associate with the item for related callbacks.
17626 * @return The created item or @c NULL upon failure.
17628 * A new item will be created and added to the list. Its position in
17629 * this list will be just after item @p after.
17631 * Items created with this method can be deleted with
17632 * elm_list_item_del().
17634 * Associated @p data can be properly freed when item is deleted if a
17635 * callback function is set with elm_list_item_del_cb_set().
17637 * If a function is passed as argument, it will be called everytime this item
17638 * is selected, i.e., the user clicks over an unselected item.
17639 * If always select is enabled it will call this function every time
17640 * user clicks over an item (already selected or not).
17641 * If such function isn't needed, just passing
17642 * @c NULL as @p func is enough. The same should be done for @p data.
17644 * @see elm_list_item_append() for a simple code example.
17645 * @see elm_list_always_select_mode_set()
17646 * @see elm_list_item_del()
17647 * @see elm_list_item_del_cb_set()
17648 * @see elm_list_clear()
17649 * @see elm_icon_add()
17653 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);
17656 * Insert a new item into the sorted list object.
17658 * @param obj The list object.
17659 * @param label The label of the list item.
17660 * @param icon The icon object to use for the left side of the item. An
17661 * icon can be any Evas object, but usually it is an icon created
17662 * with elm_icon_add().
17663 * @param end The icon object to use for the right side of the item. An
17664 * icon can be any Evas object.
17665 * @param func The function to call when the item is clicked.
17666 * @param data The data to associate with the item for related callbacks.
17667 * @param cmp_func The comparing function to be used to sort list
17668 * items <b>by #Elm_List_Item item handles</b>. This function will
17669 * receive two items and compare them, returning a non-negative integer
17670 * if the second item should be place after the first, or negative value
17671 * if should be placed before.
17673 * @return The created item or @c NULL upon failure.
17675 * @note This function inserts values into a list object assuming it was
17676 * sorted and the result will be sorted.
17678 * A new item will be created and added to the list. Its position in
17679 * this list will be found comparing the new item with previously inserted
17680 * items using function @p cmp_func.
17682 * Items created with this method can be deleted with
17683 * elm_list_item_del().
17685 * Associated @p data can be properly freed when item is deleted if a
17686 * callback function is set with elm_list_item_del_cb_set().
17688 * If a function is passed as argument, it will be called everytime this item
17689 * is selected, i.e., the user clicks over an unselected item.
17690 * If always select is enabled it will call this function every time
17691 * user clicks over an item (already selected or not).
17692 * If such function isn't needed, just passing
17693 * @c NULL as @p func is enough. The same should be done for @p data.
17695 * @see elm_list_item_append() for a simple code example.
17696 * @see elm_list_always_select_mode_set()
17697 * @see elm_list_item_del()
17698 * @see elm_list_item_del_cb_set()
17699 * @see elm_list_clear()
17700 * @see elm_icon_add()
17704 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);
17707 * Remove all list's items.
17709 * @param obj The list object
17711 * @see elm_list_item_del()
17712 * @see elm_list_item_append()
17716 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17719 * Get a list of all the list items.
17721 * @param obj The list object
17722 * @return An @c Eina_List of list items, #Elm_List_Item,
17723 * or @c NULL on failure.
17725 * @see elm_list_item_append()
17726 * @see elm_list_item_del()
17727 * @see elm_list_clear()
17731 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17734 * Get the selected item.
17736 * @param obj The list object.
17737 * @return The selected list item.
17739 * The selected item can be unselected with function
17740 * elm_list_item_selected_set().
17742 * The selected item always will be highlighted on list.
17744 * @see elm_list_selected_items_get()
17748 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17751 * Return a list of the currently selected list items.
17753 * @param obj The list object.
17754 * @return An @c Eina_List of list items, #Elm_List_Item,
17755 * or @c NULL on failure.
17757 * Multiple items can be selected if multi select is enabled. It can be
17758 * done with elm_list_multi_select_set().
17760 * @see elm_list_selected_item_get()
17761 * @see elm_list_multi_select_set()
17765 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17768 * Set the selected state of an item.
17770 * @param item The list item
17771 * @param selected The selected state
17773 * This sets the selected state of the given item @p it.
17774 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17776 * If a new item is selected the previosly selected will be unselected,
17777 * unless multiple selection is enabled with elm_list_multi_select_set().
17778 * Previoulsy selected item can be get with function
17779 * elm_list_selected_item_get().
17781 * Selected items will be highlighted.
17783 * @see elm_list_item_selected_get()
17784 * @see elm_list_selected_item_get()
17785 * @see elm_list_multi_select_set()
17789 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17792 * Get whether the @p item is selected or not.
17794 * @param item The list item.
17795 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17796 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17798 * @see elm_list_selected_item_set() for details.
17799 * @see elm_list_item_selected_get()
17803 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17806 * Set or unset item as a separator.
17808 * @param it The list item.
17809 * @param setting @c EINA_TRUE to set item @p it as separator or
17810 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17812 * Items aren't set as separator by default.
17814 * If set as separator it will display separator theme, so won't display
17817 * @see elm_list_item_separator_get()
17821 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17824 * Get a value whether item is a separator or not.
17826 * @see elm_list_item_separator_set() for details.
17828 * @param it The list item.
17829 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17830 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17834 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17837 * Show @p item in the list view.
17839 * @param item The list item to be shown.
17841 * It won't animate list until item is visible. If such behavior is wanted,
17842 * use elm_list_bring_in() intead.
17846 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17849 * Bring in the given item to list view.
17851 * @param item The item.
17853 * This causes list to jump to the given item @p item and show it
17854 * (by scrolling), if it is not fully visible.
17856 * This may use animation to do so and take a period of time.
17858 * If animation isn't wanted, elm_list_item_show() can be used.
17862 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17865 * Delete them item from the list.
17867 * @param item The item of list to be deleted.
17869 * If deleting all list items is required, elm_list_clear()
17870 * should be used instead of getting items list and deleting each one.
17872 * @see elm_list_clear()
17873 * @see elm_list_item_append()
17874 * @see elm_list_item_del_cb_set()
17878 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17881 * Set the function called when a list item is freed.
17883 * @param item The item to set the callback on
17884 * @param func The function called
17886 * If there is a @p func, then it will be called prior item's memory release.
17887 * That will be called with the following arguments:
17889 * @li item's Evas object;
17892 * This way, a data associated to a list item could be properly freed.
17896 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17899 * Get the data associated to the item.
17901 * @param item The list item
17902 * @return The data associated to @p item
17904 * The return value is a pointer to data associated to @p item when it was
17905 * created, with function elm_list_item_append() or similar. If no data
17906 * was passed as argument, it will return @c NULL.
17908 * @see elm_list_item_append()
17912 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17915 * Get the left side icon associated to the item.
17917 * @param item The list item
17918 * @return The left side icon associated to @p item
17920 * The return value is a pointer to the icon associated to @p item when
17922 * created, with function elm_list_item_append() or similar, or later
17923 * with function elm_list_item_icon_set(). If no icon
17924 * was passed as argument, it will return @c NULL.
17926 * @see elm_list_item_append()
17927 * @see elm_list_item_icon_set()
17931 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17934 * Set the left side icon associated to the item.
17936 * @param item The list item
17937 * @param icon The left side icon object to associate with @p item
17939 * The icon object to use at left side of the item. An
17940 * icon can be any Evas object, but usually it is an icon created
17941 * with elm_icon_add().
17943 * Once the icon object is set, a previously set one will be deleted.
17944 * @warning Setting the same icon for two items will cause the icon to
17945 * dissapear from the first item.
17947 * If an icon was passed as argument on item creation, with function
17948 * elm_list_item_append() or similar, it will be already
17949 * associated to the item.
17951 * @see elm_list_item_append()
17952 * @see elm_list_item_icon_get()
17956 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17959 * Get the right side icon associated to the item.
17961 * @param item The list item
17962 * @return The right side icon associated to @p item
17964 * The return value is a pointer to the icon associated to @p item when
17966 * created, with function elm_list_item_append() or similar, or later
17967 * with function elm_list_item_icon_set(). If no icon
17968 * was passed as argument, it will return @c NULL.
17970 * @see elm_list_item_append()
17971 * @see elm_list_item_icon_set()
17975 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17978 * Set the right side icon associated to the item.
17980 * @param item The list item
17981 * @param end The right side icon object to associate with @p item
17983 * The icon object to use at right side of the item. An
17984 * icon can be any Evas object, but usually it is an icon created
17985 * with elm_icon_add().
17987 * Once the icon object is set, a previously set one will be deleted.
17988 * @warning Setting the same icon for two items will cause the icon to
17989 * dissapear from the first item.
17991 * If an icon was passed as argument on item creation, with function
17992 * elm_list_item_append() or similar, it will be already
17993 * associated to the item.
17995 * @see elm_list_item_append()
17996 * @see elm_list_item_end_get()
18000 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
18003 * Gets the base object of the item.
18005 * @param item The list item
18006 * @return The base object associated with @p item
18008 * Base object is the @c Evas_Object that represents that item.
18012 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18013 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18016 * Get the label of item.
18018 * @param item The item of list.
18019 * @return The label of item.
18021 * The return value is a pointer to the label associated to @p item when
18022 * it was created, with function elm_list_item_append(), or later
18023 * with function elm_list_item_label_set. If no label
18024 * was passed as argument, it will return @c NULL.
18026 * @see elm_list_item_label_set() for more details.
18027 * @see elm_list_item_append()
18031 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18034 * Set the label of item.
18036 * @param item The item of list.
18037 * @param text The label of item.
18039 * The label to be displayed by the item.
18040 * Label will be placed between left and right side icons (if set).
18042 * If a label was passed as argument on item creation, with function
18043 * elm_list_item_append() or similar, it will be already
18044 * displayed by the item.
18046 * @see elm_list_item_label_get()
18047 * @see elm_list_item_append()
18051 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18054 * Get the item before @p it in list.
18056 * @param it The list item.
18057 * @return The item before @p it, or @c NULL if none or on failure.
18059 * @note If it is the first item, @c NULL will be returned.
18061 * @see elm_list_item_append()
18062 * @see elm_list_items_get()
18066 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18069 * Get the item after @p it in list.
18071 * @param it The list item.
18072 * @return The item after @p it, or @c NULL if none or on failure.
18074 * @note If it is the last item, @c NULL will be returned.
18076 * @see elm_list_item_append()
18077 * @see elm_list_items_get()
18081 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18084 * Sets the disabled/enabled state of a list item.
18086 * @param it The item.
18087 * @param disabled The disabled state.
18089 * A disabled item cannot be selected or unselected. It will also
18090 * change its appearance (generally greyed out). This sets the
18091 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
18096 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18099 * Get a value whether list item is disabled or not.
18101 * @param it The item.
18102 * @return The disabled state.
18104 * @see elm_list_item_disabled_set() for more details.
18108 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18111 * Set the text to be shown in a given list item's tooltips.
18113 * @param item Target item.
18114 * @param text The text to set in the content.
18116 * Setup the text as tooltip to object. The item can have only one tooltip,
18117 * so any previous tooltip data - set with this function or
18118 * elm_list_item_tooltip_content_cb_set() - is removed.
18120 * @see elm_object_tooltip_text_set() for more details.
18124 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18127 * @brief Disable size restrictions on an object's tooltip
18128 * @param item The tooltip's anchor object
18129 * @param disable If EINA_TRUE, size restrictions are disabled
18130 * @return EINA_FALSE on failure, EINA_TRUE on success
18132 * This function allows a tooltip to expand beyond its parant window's canvas.
18133 * It will instead be limited only by the size of the display.
18135 EAPI Eina_Bool elm_list_item_tooltip_window_mode_set(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
18137 * @brief Retrieve size restriction state of an object's tooltip
18138 * @param obj The tooltip's anchor object
18139 * @return If EINA_TRUE, size restrictions are disabled
18141 * This function returns whether a tooltip is allowed to expand beyond
18142 * its parant window's canvas.
18143 * It will instead be limited only by the size of the display.
18145 EAPI Eina_Bool elm_list_item_tooltip_window_mode_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18148 * Set the content to be shown in the tooltip item.
18150 * Setup the tooltip to item. The item can have only one tooltip,
18151 * so any previous tooltip data is removed. @p func(with @p data) will
18152 * be called every time that need show the tooltip and it should
18153 * return a valid Evas_Object. This object is then managed fully by
18154 * tooltip system and is deleted when the tooltip is gone.
18156 * @param item the list item being attached a tooltip.
18157 * @param func the function used to create the tooltip contents.
18158 * @param data what to provide to @a func as callback data/context.
18159 * @param del_cb called when data is not needed anymore, either when
18160 * another callback replaces @a func, the tooltip is unset with
18161 * elm_list_item_tooltip_unset() or the owner @a item
18162 * dies. This callback receives as the first parameter the
18163 * given @a data, and @c event_info is the item.
18165 * @see elm_object_tooltip_content_cb_set() for more details.
18169 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);
18172 * Unset tooltip from item.
18174 * @param item list item to remove previously set tooltip.
18176 * Remove tooltip from item. The callback provided as del_cb to
18177 * elm_list_item_tooltip_content_cb_set() will be called to notify
18178 * it is not used anymore.
18180 * @see elm_object_tooltip_unset() for more details.
18181 * @see elm_list_item_tooltip_content_cb_set()
18185 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18188 * Sets a different style for this item tooltip.
18190 * @note before you set a style you should define a tooltip with
18191 * elm_list_item_tooltip_content_cb_set() or
18192 * elm_list_item_tooltip_text_set()
18194 * @param item list item with tooltip already set.
18195 * @param style the theme style to use (default, transparent, ...)
18197 * @see elm_object_tooltip_style_set() for more details.
18201 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18204 * Get the style for this item tooltip.
18206 * @param item list item with tooltip already set.
18207 * @return style the theme style in use, defaults to "default". If the
18208 * object does not have a tooltip set, then NULL is returned.
18210 * @see elm_object_tooltip_style_get() for more details.
18211 * @see elm_list_item_tooltip_style_set()
18215 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18218 * Set the type of mouse pointer/cursor decoration to be shown,
18219 * when the mouse pointer is over the given list widget item
18221 * @param item list item to customize cursor on
18222 * @param cursor the cursor type's name
18224 * This function works analogously as elm_object_cursor_set(), but
18225 * here the cursor's changing area is restricted to the item's
18226 * area, and not the whole widget's. Note that that item cursors
18227 * have precedence over widget cursors, so that a mouse over an
18228 * item with custom cursor set will always show @b that cursor.
18230 * If this function is called twice for an object, a previously set
18231 * cursor will be unset on the second call.
18233 * @see elm_object_cursor_set()
18234 * @see elm_list_item_cursor_get()
18235 * @see elm_list_item_cursor_unset()
18239 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18242 * Get the type of mouse pointer/cursor decoration set to be shown,
18243 * when the mouse pointer is over the given list widget item
18245 * @param item list item with custom cursor set
18246 * @return the cursor type's name or @c NULL, if no custom cursors
18247 * were set to @p item (and on errors)
18249 * @see elm_object_cursor_get()
18250 * @see elm_list_item_cursor_set()
18251 * @see elm_list_item_cursor_unset()
18255 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18258 * Unset any custom mouse pointer/cursor decoration set to be
18259 * shown, when the mouse pointer is over the given list widget
18260 * item, thus making it show the @b default cursor again.
18262 * @param item a list item
18264 * Use this call to undo any custom settings on this item's cursor
18265 * decoration, bringing it back to defaults (no custom style set).
18267 * @see elm_object_cursor_unset()
18268 * @see elm_list_item_cursor_set()
18272 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18275 * Set a different @b style for a given custom cursor set for a
18278 * @param item list item with custom cursor set
18279 * @param style the <b>theme style</b> to use (e.g. @c "default",
18280 * @c "transparent", etc)
18282 * This function only makes sense when one is using custom mouse
18283 * cursor decorations <b>defined in a theme file</b>, which can have,
18284 * given a cursor name/type, <b>alternate styles</b> on it. It
18285 * works analogously as elm_object_cursor_style_set(), but here
18286 * applyed only to list item objects.
18288 * @warning Before you set a cursor style you should have definen a
18289 * custom cursor previously on the item, with
18290 * elm_list_item_cursor_set()
18292 * @see elm_list_item_cursor_engine_only_set()
18293 * @see elm_list_item_cursor_style_get()
18297 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18300 * Get the current @b style set for a given list item's custom
18303 * @param item list item with custom cursor set.
18304 * @return style the cursor style in use. If the object does not
18305 * have a cursor set, then @c NULL is returned.
18307 * @see elm_list_item_cursor_style_set() for more details
18311 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18314 * Set if the (custom)cursor for a given list item should be
18315 * searched in its theme, also, or should only rely on the
18316 * rendering engine.
18318 * @param item item with custom (custom) cursor already set on
18319 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18320 * only on those provided by the rendering engine, @c EINA_FALSE to
18321 * have them searched on the widget's theme, as well.
18323 * @note This call is of use only if you've set a custom cursor
18324 * for list items, with elm_list_item_cursor_set().
18326 * @note By default, cursors will only be looked for between those
18327 * provided by the rendering engine.
18331 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18334 * Get if the (custom) cursor for a given list item is being
18335 * searched in its theme, also, or is only relying on the rendering
18338 * @param item a list item
18339 * @return @c EINA_TRUE, if cursors are being looked for only on
18340 * those provided by the rendering engine, @c EINA_FALSE if they
18341 * are being searched on the widget's theme, as well.
18343 * @see elm_list_item_cursor_engine_only_set(), for more details
18347 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18354 * @defgroup Slider Slider
18355 * @ingroup Elementary
18357 * @image html img/widget/slider/preview-00.png
18358 * @image latex img/widget/slider/preview-00.eps width=\textwidth
18360 * The slider adds a dragable āsliderā widget for selecting the value of
18361 * something within a range.
18363 * A slider can be horizontal or vertical. It can contain an Icon and has a
18364 * primary label as well as a units label (that is formatted with floating
18365 * point values and thus accepts a printf-style format string, like
18366 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
18367 * else (like on the slider itself) that also accepts a format string like
18368 * units. Label, Icon Unit and Indicator strings/objects are optional.
18370 * A slider may be inverted which means values invert, with high vales being
18371 * on the left or top and low values on the right or bottom (as opposed to
18372 * normally being low on the left or top and high on the bottom and right).
18374 * The slider should have its minimum and maximum values set by the
18375 * application with elm_slider_min_max_set() and value should also be set by
18376 * the application before use with elm_slider_value_set(). The span of the
18377 * slider is its length (horizontally or vertically). This will be scaled by
18378 * the object or applications scaling factor. At any point code can query the
18379 * slider for its value with elm_slider_value_get().
18381 * Smart callbacks one can listen to:
18382 * - "changed" - Whenever the slider value is changed by the user.
18383 * - "slider,drag,start" - dragging the slider indicator around has started.
18384 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
18385 * - "delay,changed" - A short time after the value is changed by the user.
18386 * This will be called only when the user stops dragging for
18387 * a very short period or when they release their
18388 * finger/mouse, so it avoids possibly expensive reactions to
18389 * the value change.
18391 * Available styles for it:
18394 * Default contents parts of the slider widget that you can use for are:
18395 * @li "icon" - An icon of the slider
18396 * @li "end" - A end part content of the slider
18398 * Default text parts of the silder widget that you can use for are:
18399 * @li "default" - Label of the silder
18400 * Here is an example on its usage:
18401 * @li @ref slider_example
18405 * @addtogroup Slider
18410 * Add a new slider widget to the given parent Elementary
18411 * (container) object.
18413 * @param parent The parent object.
18414 * @return a new slider widget handle or @c NULL, on errors.
18416 * This function inserts a new slider widget on the canvas.
18420 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18423 * Set the label of a given slider widget
18425 * @param obj The progress bar object
18426 * @param label The text label string, in UTF-8
18429 * @deprecated use elm_object_text_set() instead.
18431 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18434 * Get the label of a given slider widget
18436 * @param obj The progressbar object
18437 * @return The text label string, in UTF-8
18440 * @deprecated use elm_object_text_get() instead.
18442 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18445 * Set the icon object of the slider object.
18447 * @param obj The slider object.
18448 * @param icon The icon object.
18450 * On horizontal mode, icon is placed at left, and on vertical mode,
18453 * @note Once the icon object is set, a previously set one will be deleted.
18454 * If you want to keep that old content object, use the
18455 * elm_slider_icon_unset() function.
18457 * @warning If the object being set does not have minimum size hints set,
18458 * it won't get properly displayed.
18461 * @deprecated use elm_object_part_content_set() instead.
18463 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18466 * Unset an icon set on a given slider widget.
18468 * @param obj The slider object.
18469 * @return The icon object that was being used, if any was set, or
18470 * @c NULL, otherwise (and on errors).
18472 * On horizontal mode, icon is placed at left, and on vertical mode,
18475 * This call will unparent and return the icon object which was set
18476 * for this widget, previously, on success.
18478 * @see elm_slider_icon_set() for more details
18479 * @see elm_slider_icon_get()
18480 * @deprecated use elm_object_part_content_unset() instead.
18484 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18487 * Retrieve the icon object set for a given slider widget.
18489 * @param obj The slider object.
18490 * @return The icon object's handle, if @p obj had one set, or @c NULL,
18491 * otherwise (and on errors).
18493 * On horizontal mode, icon is placed at left, and on vertical mode,
18496 * @see elm_slider_icon_set() for more details
18497 * @see elm_slider_icon_unset()
18499 * @deprecated use elm_object_part_content_get() instead.
18503 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18506 * Set the end object of the slider object.
18508 * @param obj The slider object.
18509 * @param end The end object.
18511 * On horizontal mode, end is placed at left, and on vertical mode,
18512 * placed at bottom.
18514 * @note Once the icon object is set, a previously set one will be deleted.
18515 * If you want to keep that old content object, use the
18516 * elm_slider_end_unset() function.
18518 * @warning If the object being set does not have minimum size hints set,
18519 * it won't get properly displayed.
18521 * @deprecated use elm_object_part_content_set() instead.
18525 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
18528 * Unset an end object set on a given slider widget.
18530 * @param obj The slider object.
18531 * @return The end object that was being used, if any was set, or
18532 * @c NULL, otherwise (and on errors).
18534 * On horizontal mode, end is placed at left, and on vertical mode,
18535 * placed at bottom.
18537 * This call will unparent and return the icon object which was set
18538 * for this widget, previously, on success.
18540 * @see elm_slider_end_set() for more details.
18541 * @see elm_slider_end_get()
18543 * @deprecated use elm_object_part_content_unset() instead
18548 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18551 * Retrieve the end object set for a given slider widget.
18553 * @param obj The slider object.
18554 * @return The end object's handle, if @p obj had one set, or @c NULL,
18555 * otherwise (and on errors).
18557 * On horizontal mode, icon is placed at right, and on vertical mode,
18558 * placed at bottom.
18560 * @see elm_slider_end_set() for more details.
18561 * @see elm_slider_end_unset()
18564 * @deprecated use elm_object_part_content_get() instead
18569 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18572 * Set the (exact) length of the bar region of a given slider widget.
18574 * @param obj The slider object.
18575 * @param size The length of the slider's bar region.
18577 * This sets the minimum width (when in horizontal mode) or height
18578 * (when in vertical mode) of the actual bar area of the slider
18579 * @p obj. This in turn affects the object's minimum size. Use
18580 * this when you're not setting other size hints expanding on the
18581 * given direction (like weight and alignment hints) and you would
18582 * like it to have a specific size.
18584 * @note Icon, end, label, indicator and unit text around @p obj
18585 * will require their
18586 * own space, which will make @p obj to require more the @p size,
18589 * @see elm_slider_span_size_get()
18593 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
18596 * Get the length set for the bar region of a given slider widget
18598 * @param obj The slider object.
18599 * @return The length of the slider's bar region.
18601 * If that size was not set previously, with
18602 * elm_slider_span_size_set(), this call will return @c 0.
18606 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18609 * Set the format string for the unit label.
18611 * @param obj The slider object.
18612 * @param format The format string for the unit display.
18614 * Unit label is displayed all the time, if set, after slider's bar.
18615 * In horizontal mode, at right and in vertical mode, at bottom.
18617 * If @c NULL, unit label won't be visible. If not it sets the format
18618 * string for the label text. To the label text is provided a floating point
18619 * value, so the label text can display up to 1 floating point value.
18620 * Note that this is optional.
18622 * Use a format string such as "%1.2f meters" for example, and it will
18623 * display values like: "3.14 meters" for a value equal to 3.14159.
18625 * Default is unit label disabled.
18627 * @see elm_slider_indicator_format_get()
18631 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18634 * Get the unit label format of the slider.
18636 * @param obj The slider object.
18637 * @return The unit label format string in UTF-8.
18639 * Unit label is displayed all the time, if set, after slider's bar.
18640 * In horizontal mode, at right and in vertical mode, at bottom.
18642 * @see elm_slider_unit_format_set() for more
18643 * information on how this works.
18647 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18650 * Set the format string for the indicator label.
18652 * @param obj The slider object.
18653 * @param indicator The format string for the indicator display.
18655 * The slider may display its value somewhere else then unit label,
18656 * for example, above the slider knob that is dragged around. This function
18657 * sets the format string used for this.
18659 * If @c NULL, indicator label won't be visible. If not it sets the format
18660 * string for the label text. To the label text is provided a floating point
18661 * value, so the label text can display up to 1 floating point value.
18662 * Note that this is optional.
18664 * Use a format string such as "%1.2f meters" for example, and it will
18665 * display values like: "3.14 meters" for a value equal to 3.14159.
18667 * Default is indicator label disabled.
18669 * @see elm_slider_indicator_format_get()
18673 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18676 * Get the indicator label format of the slider.
18678 * @param obj The slider object.
18679 * @return The indicator label format string in UTF-8.
18681 * The slider may display its value somewhere else then unit label,
18682 * for example, above the slider knob that is dragged around. This function
18683 * gets the format string used for this.
18685 * @see elm_slider_indicator_format_set() for more
18686 * information on how this works.
18690 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18693 * Set the format function pointer for the indicator label
18695 * @param obj The slider object.
18696 * @param func The indicator format function.
18697 * @param free_func The freeing function for the format string.
18699 * Set the callback function to format the indicator string.
18701 * @see elm_slider_indicator_format_set() for more info on how this works.
18705 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);
18708 * Set the format function pointer for the units label
18710 * @param obj The slider object.
18711 * @param func The units format function.
18712 * @param free_func The freeing function for the format string.
18714 * Set the callback function to format the indicator string.
18716 * @see elm_slider_units_format_set() for more info on how this works.
18720 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);
18723 * Set the orientation of a given slider widget.
18725 * @param obj The slider object.
18726 * @param horizontal Use @c EINA_TRUE to make @p obj to be
18727 * @b horizontal, @c EINA_FALSE to make it @b vertical.
18729 * Use this function to change how your slider is to be
18730 * disposed: vertically or horizontally.
18732 * By default it's displayed horizontally.
18734 * @see elm_slider_horizontal_get()
18738 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18741 * Retrieve the orientation of a given slider widget
18743 * @param obj The slider object.
18744 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18745 * @c EINA_FALSE if it's @b vertical (and on errors).
18747 * @see elm_slider_horizontal_set() for more details.
18751 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18754 * Set the minimum and maximum values for the slider.
18756 * @param obj The slider object.
18757 * @param min The minimum value.
18758 * @param max The maximum value.
18760 * Define the allowed range of values to be selected by the user.
18762 * If actual value is less than @p min, it will be updated to @p min. If it
18763 * is bigger then @p max, will be updated to @p max. Actual value can be
18764 * get with elm_slider_value_get().
18766 * By default, min is equal to 0.0, and max is equal to 1.0.
18768 * @warning Maximum must be greater than minimum, otherwise behavior
18771 * @see elm_slider_min_max_get()
18775 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18778 * Get the minimum and maximum values of the slider.
18780 * @param obj The slider object.
18781 * @param min Pointer where to store the minimum value.
18782 * @param max Pointer where to store the maximum value.
18784 * @note If only one value is needed, the other pointer can be passed
18787 * @see elm_slider_min_max_set() for details.
18791 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18794 * Set the value the slider displays.
18796 * @param obj The slider object.
18797 * @param val The value to be displayed.
18799 * Value will be presented on the unit label following format specified with
18800 * elm_slider_unit_format_set() and on indicator with
18801 * elm_slider_indicator_format_set().
18803 * @warning The value must to be between min and max values. This values
18804 * are set by elm_slider_min_max_set().
18806 * @see elm_slider_value_get()
18807 * @see elm_slider_unit_format_set()
18808 * @see elm_slider_indicator_format_set()
18809 * @see elm_slider_min_max_set()
18813 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18816 * Get the value displayed by the spinner.
18818 * @param obj The spinner object.
18819 * @return The value displayed.
18821 * @see elm_spinner_value_set() for details.
18825 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18828 * Invert a given slider widget's displaying values order
18830 * @param obj The slider object.
18831 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18832 * @c EINA_FALSE to bring it back to default, non-inverted values.
18834 * A slider may be @b inverted, in which state it gets its
18835 * values inverted, with high vales being on the left or top and
18836 * low values on the right or bottom, as opposed to normally have
18837 * the low values on the former and high values on the latter,
18838 * respectively, for horizontal and vertical modes.
18840 * @see elm_slider_inverted_get()
18844 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18847 * Get whether a given slider widget's displaying values are
18850 * @param obj The slider object.
18851 * @return @c EINA_TRUE, if @p obj has inverted values,
18852 * @c EINA_FALSE otherwise (and on errors).
18854 * @see elm_slider_inverted_set() for more details.
18858 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18861 * Set whether to enlarge slider indicator (augmented knob) or not.
18863 * @param obj The slider object.
18864 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18865 * let the knob always at default size.
18867 * By default, indicator will be bigger while dragged by the user.
18869 * @warning It won't display values set with
18870 * elm_slider_indicator_format_set() if you disable indicator.
18874 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18877 * Get whether a given slider widget's enlarging indicator or not.
18879 * @param obj The slider object.
18880 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18881 * @c EINA_FALSE otherwise (and on errors).
18883 * @see elm_slider_indicator_show_set() for details.
18887 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18894 * @addtogroup Actionslider Actionslider
18896 * @image html img/widget/actionslider/preview-00.png
18897 * @image latex img/widget/actionslider/preview-00.eps
18899 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18900 * properties. The user drags and releases the indicator, to choose a label.
18902 * Labels occupy the following positions.
18907 * Positions can be enabled or disabled.
18909 * Magnets can be set on the above positions.
18911 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18913 * @note By default all positions are set as enabled.
18915 * Signals that you can add callbacks for are:
18917 * "selected" - when user selects an enabled position (the label is passed
18920 * "pos_changed" - when the indicator reaches any of the positions("left",
18921 * "right" or "center").
18923 * See an example of actionslider usage @ref actionslider_example_page "here"
18926 typedef enum _Elm_Actionslider_Pos
18928 ELM_ACTIONSLIDER_NONE = 0,
18929 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18930 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18931 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18932 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18933 } Elm_Actionslider_Pos;
18936 * Add a new actionslider to the parent.
18938 * @param parent The parent object
18939 * @return The new actionslider object or NULL if it cannot be created
18941 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18944 * Set actionslider labels.
18946 * @param obj The actionslider object
18947 * @param left_label The label to be set on the left.
18948 * @param center_label The label to be set on the center.
18949 * @param right_label The label to be set on the right.
18950 * @deprecated use elm_object_text_set() instead.
18952 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);
18955 * Get actionslider labels.
18957 * @param obj The actionslider object
18958 * @param left_label A char** to place the left_label of @p obj into.
18959 * @param center_label A char** to place the center_label of @p obj into.
18960 * @param right_label A char** to place the right_label of @p obj into.
18961 * @deprecated use elm_object_text_set() instead.
18963 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);
18966 * Get actionslider selected label.
18968 * @param obj The actionslider object
18969 * @return The selected label
18971 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18974 * Set actionslider indicator position.
18976 * @param obj The actionslider object.
18977 * @param pos The position of the indicator.
18979 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18982 * Get actionslider indicator position.
18984 * @param obj The actionslider object.
18985 * @return The position of the indicator.
18987 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18990 * Set actionslider magnet position. To make multiple positions magnets @c or
18991 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18993 * @param obj The actionslider object.
18994 * @param pos Bit mask indicating the magnet positions.
18996 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18999 * Get actionslider magnet position.
19001 * @param obj The actionslider object.
19002 * @return The positions with magnet property.
19004 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19007 * Set actionslider enabled position. To set multiple positions as enabled @c or
19008 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
19010 * @note All the positions are enabled by default.
19012 * @param obj The actionslider object.
19013 * @param pos Bit mask indicating the enabled positions.
19015 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19018 * Get actionslider enabled position.
19020 * @param obj The actionslider object.
19021 * @return The enabled positions.
19023 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19026 * Set the label used on the indicator.
19028 * @param obj The actionslider object
19029 * @param label The label to be set on the indicator.
19030 * @deprecated use elm_object_text_set() instead.
19032 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19035 * Get the label used on the indicator object.
19037 * @param obj The actionslider object
19038 * @return The indicator label
19039 * @deprecated use elm_object_text_get() instead.
19041 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
19048 * @defgroup Genlist Genlist
19050 * @image html img/widget/genlist/preview-00.png
19051 * @image latex img/widget/genlist/preview-00.eps
19052 * @image html img/genlist.png
19053 * @image latex img/genlist.eps
19055 * This widget aims to have more expansive list than the simple list in
19056 * Elementary that could have more flexible items and allow many more entries
19057 * while still being fast and low on memory usage. At the same time it was
19058 * also made to be able to do tree structures. But the price to pay is more
19059 * complexity when it comes to usage. If all you want is a simple list with
19060 * icons and a single text, use the normal @ref List object.
19062 * Genlist has a fairly large API, mostly because it's relatively complex,
19063 * trying to be both expansive, powerful and efficient. First we will begin
19064 * an overview on the theory behind genlist.
19066 * @section Genlist_Item_Class Genlist item classes - creating items
19068 * In order to have the ability to add and delete items on the fly, genlist
19069 * implements a class (callback) system where the application provides a
19070 * structure with information about that type of item (genlist may contain
19071 * multiple different items with different classes, states and styles).
19072 * Genlist will call the functions in this struct (methods) when an item is
19073 * "realized" (i.e., created dynamically, while the user is scrolling the
19074 * grid). All objects will simply be deleted when no longer needed with
19075 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
19076 * following members:
19077 * - @c item_style - This is a constant string and simply defines the name
19078 * of the item style. It @b must be specified and the default should be @c
19081 * - @c func - A struct with pointers to functions that will be called when
19082 * an item is going to be actually created. All of them receive a @c data
19083 * parameter that will point to the same data passed to
19084 * elm_genlist_item_append() and related item creation functions, and a @c
19085 * obj parameter that points to the genlist object itself.
19087 * The function pointers inside @c func are @c text_get, @c content_get, @c
19088 * state_get and @c del. The 3 first functions also receive a @c part
19089 * parameter described below. A brief description of these functions follows:
19091 * - @c text_get - The @c part parameter is the name string of one of the
19092 * existing text parts in the Edje group implementing the item's theme.
19093 * This function @b must return a strdup'()ed string, as the caller will
19094 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
19095 * - @c content_get - The @c part parameter is the name string of one of the
19096 * existing (content) swallow parts in the Edje group implementing the item's
19097 * theme. It must return @c NULL, when no content is desired, or a valid
19098 * object handle, otherwise. The object will be deleted by the genlist on
19099 * its deletion or when the item is "unrealized". See
19100 * #Elm_Genlist_Item_Content_Get_Cb.
19101 * - @c func.state_get - The @c part parameter is the name string of one of
19102 * the state parts in the Edje group implementing the item's theme. Return
19103 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
19104 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
19105 * and @c "elm" as "emission" and "source" arguments, respectively, when
19106 * the state is true (the default is false), where @c XXX is the name of
19107 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
19108 * - @c func.del - This is intended for use when genlist items are deleted,
19109 * so any data attached to the item (e.g. its data parameter on creation)
19110 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
19112 * available item styles:
19114 * - default_style - The text part is a textblock
19116 * @image html img/widget/genlist/preview-04.png
19117 * @image latex img/widget/genlist/preview-04.eps
19121 * @image html img/widget/genlist/preview-01.png
19122 * @image latex img/widget/genlist/preview-01.eps
19124 * - icon_top_text_bottom
19126 * @image html img/widget/genlist/preview-02.png
19127 * @image latex img/widget/genlist/preview-02.eps
19131 * @image html img/widget/genlist/preview-03.png
19132 * @image latex img/widget/genlist/preview-03.eps
19134 * @section Genlist_Items Structure of items
19136 * An item in a genlist can have 0 or more texts (they can be regular
19137 * text or textblock Evas objects - that's up to the style to determine), 0
19138 * or more contents (which are simply objects swallowed into the genlist item's
19139 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
19140 * behavior left to the user to define. The Edje part names for each of
19141 * these properties will be looked up, in the theme file for the genlist,
19142 * under the Edje (string) data items named @c "labels", @c "contents" and @c
19143 * "states", respectively. For each of those properties, if more than one
19144 * part is provided, they must have names listed separated by spaces in the
19145 * data fields. For the default genlist item theme, we have @b one text
19146 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
19147 * "elm.swallow.end") and @b no state parts.
19149 * A genlist item may be at one of several styles. Elementary provides one
19150 * by default - "default", but this can be extended by system or application
19151 * custom themes/overlays/extensions (see @ref Theme "themes" for more
19154 * @section Genlist_Manipulation Editing and Navigating
19156 * Items can be added by several calls. All of them return a @ref
19157 * Elm_Genlist_Item handle that is an internal member inside the genlist.
19158 * They all take a data parameter that is meant to be used for a handle to
19159 * the applications internal data (eg the struct with the original item
19160 * data). The parent parameter is the parent genlist item this belongs to if
19161 * it is a tree or an indexed group, and NULL if there is no parent. The
19162 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
19163 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
19164 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
19165 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
19166 * is set then this item is group index item that is displayed at the top
19167 * until the next group comes. The func parameter is a convenience callback
19168 * that is called when the item is selected and the data parameter will be
19169 * the func_data parameter, obj be the genlist object and event_info will be
19170 * the genlist item.
19172 * elm_genlist_item_append() adds an item to the end of the list, or if
19173 * there is a parent, to the end of all the child items of the parent.
19174 * elm_genlist_item_prepend() is the same but adds to the beginning of
19175 * the list or children list. elm_genlist_item_insert_before() inserts at
19176 * item before another item and elm_genlist_item_insert_after() inserts after
19177 * the indicated item.
19179 * The application can clear the list with elm_genlist_clear() which deletes
19180 * all the items in the list and elm_genlist_item_del() will delete a specific
19181 * item. elm_genlist_item_subitems_clear() will clear all items that are
19182 * children of the indicated parent item.
19184 * To help inspect list items you can jump to the item at the top of the list
19185 * with elm_genlist_first_item_get() which will return the item pointer, and
19186 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
19187 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
19188 * and previous items respectively relative to the indicated item. Using
19189 * these calls you can walk the entire item list/tree. Note that as a tree
19190 * the items are flattened in the list, so elm_genlist_item_parent_get() will
19191 * let you know which item is the parent (and thus know how to skip them if
19194 * @section Genlist_Muti_Selection Multi-selection
19196 * If the application wants multiple items to be able to be selected,
19197 * elm_genlist_multi_select_set() can enable this. If the list is
19198 * single-selection only (the default), then elm_genlist_selected_item_get()
19199 * will return the selected item, if any, or NULL if none is selected. If the
19200 * list is multi-select then elm_genlist_selected_items_get() will return a
19201 * list (that is only valid as long as no items are modified (added, deleted,
19202 * selected or unselected)).
19204 * @section Genlist_Usage_Hints Usage hints
19206 * There are also convenience functions. elm_genlist_item_genlist_get() will
19207 * return the genlist object the item belongs to. elm_genlist_item_show()
19208 * will make the scroller scroll to show that specific item so its visible.
19209 * elm_genlist_item_data_get() returns the data pointer set by the item
19210 * creation functions.
19212 * If an item changes (state of boolean changes, text or contents change),
19213 * then use elm_genlist_item_update() to have genlist update the item with
19214 * the new state. Genlist will re-realize the item thus call the functions
19215 * in the _Elm_Genlist_Item_Class for that item.
19217 * To programmatically (un)select an item use elm_genlist_item_selected_set().
19218 * To get its selected state use elm_genlist_item_selected_get(). Similarly
19219 * to expand/contract an item and get its expanded state, use
19220 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
19221 * again to make an item disabled (unable to be selected and appear
19222 * differently) use elm_genlist_item_disabled_set() to set this and
19223 * elm_genlist_item_disabled_get() to get the disabled state.
19225 * In general to indicate how the genlist should expand items horizontally to
19226 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
19227 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
19228 * mode means that if items are too wide to fit, the scroller will scroll
19229 * horizontally. Otherwise items are expanded to fill the width of the
19230 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
19231 * to the viewport width and limited to that size. This can be combined with
19232 * a different style that uses edjes' ellipsis feature (cutting text off like
19235 * Items will only call their selection func and callback when first becoming
19236 * selected. Any further clicks will do nothing, unless you enable always
19237 * select with elm_genlist_always_select_mode_set(). This means even if
19238 * selected, every click will make the selected callbacks be called.
19239 * elm_genlist_no_select_mode_set() will turn off the ability to select
19240 * items entirely and they will neither appear selected nor call selected
19241 * callback functions.
19243 * Remember that you can create new styles and add your own theme augmentation
19244 * per application with elm_theme_extension_add(). If you absolutely must
19245 * have a specific style that overrides any theme the user or system sets up
19246 * you can use elm_theme_overlay_add() to add such a file.
19248 * @section Genlist_Implementation Implementation
19250 * Evas tracks every object you create. Every time it processes an event
19251 * (mouse move, down, up etc.) it needs to walk through objects and find out
19252 * what event that affects. Even worse every time it renders display updates,
19253 * in order to just calculate what to re-draw, it needs to walk through many
19254 * many many objects. Thus, the more objects you keep active, the more
19255 * overhead Evas has in just doing its work. It is advisable to keep your
19256 * active objects to the minimum working set you need. Also remember that
19257 * object creation and deletion carries an overhead, so there is a
19258 * middle-ground, which is not easily determined. But don't keep massive lists
19259 * of objects you can't see or use. Genlist does this with list objects. It
19260 * creates and destroys them dynamically as you scroll around. It groups them
19261 * into blocks so it can determine the visibility etc. of a whole block at
19262 * once as opposed to having to walk the whole list. This 2-level list allows
19263 * for very large numbers of items to be in the list (tests have used up to
19264 * 2,000,000 items). Also genlist employs a queue for adding items. As items
19265 * may be different sizes, every item added needs to be calculated as to its
19266 * size and thus this presents a lot of overhead on populating the list, this
19267 * genlist employs a queue. Any item added is queued and spooled off over
19268 * time, actually appearing some time later, so if your list has many members
19269 * you may find it takes a while for them to all appear, with your process
19270 * consuming a lot of CPU while it is busy spooling.
19272 * Genlist also implements a tree structure, but it does so with callbacks to
19273 * the application, with the application filling in tree structures when
19274 * requested (allowing for efficient building of a very deep tree that could
19275 * even be used for file-management). See the above smart signal callbacks for
19278 * @section Genlist_Smart_Events Genlist smart events
19280 * Signals that you can add callbacks for are:
19281 * - @c "activated" - The user has double-clicked or pressed
19282 * (enter|return|spacebar) on an item. The @c event_info parameter is the
19283 * item that was activated.
19284 * - @c "clicked,double" - The user has double-clicked an item. The @c
19285 * event_info parameter is the item that was double-clicked.
19286 * - @c "selected" - This is called when a user has made an item selected.
19287 * The event_info parameter is the genlist item that was selected.
19288 * - @c "unselected" - This is called when a user has made an item
19289 * unselected. The event_info parameter is the genlist item that was
19291 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
19292 * called and the item is now meant to be expanded. The event_info
19293 * parameter is the genlist item that was indicated to expand. It is the
19294 * job of this callback to then fill in the child items.
19295 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
19296 * called and the item is now meant to be contracted. The event_info
19297 * parameter is the genlist item that was indicated to contract. It is the
19298 * job of this callback to then delete the child items.
19299 * - @c "expand,request" - This is called when a user has indicated they want
19300 * to expand a tree branch item. The callback should decide if the item can
19301 * expand (has any children) and then call elm_genlist_item_expanded_set()
19302 * appropriately to set the state. The event_info parameter is the genlist
19303 * item that was indicated to expand.
19304 * - @c "contract,request" - This is called when a user has indicated they
19305 * want to contract a tree branch item. The callback should decide if the
19306 * item can contract (has any children) and then call
19307 * elm_genlist_item_expanded_set() appropriately to set the state. The
19308 * event_info parameter is the genlist item that was indicated to contract.
19309 * - @c "realized" - This is called when the item in the list is created as a
19310 * real evas object. event_info parameter is the genlist item that was
19311 * created. The object may be deleted at any time, so it is up to the
19312 * caller to not use the object pointer from elm_genlist_item_object_get()
19313 * in a way where it may point to freed objects.
19314 * - @c "unrealized" - This is called just before an item is unrealized.
19315 * After this call content objects provided will be deleted and the item
19316 * object itself delete or be put into a floating cache.
19317 * - @c "drag,start,up" - This is called when the item in the list has been
19318 * dragged (not scrolled) up.
19319 * - @c "drag,start,down" - This is called when the item in the list has been
19320 * dragged (not scrolled) down.
19321 * - @c "drag,start,left" - This is called when the item in the list has been
19322 * dragged (not scrolled) left.
19323 * - @c "drag,start,right" - This is called when the item in the list has
19324 * been dragged (not scrolled) right.
19325 * - @c "drag,stop" - This is called when the item in the list has stopped
19327 * - @c "drag" - This is called when the item in the list is being dragged.
19328 * - @c "longpressed" - This is called when the item is pressed for a certain
19329 * amount of time. By default it's 1 second.
19330 * - @c "scroll,anim,start" - This is called when scrolling animation has
19332 * - @c "scroll,anim,stop" - This is called when scrolling animation has
19334 * - @c "scroll,drag,start" - This is called when dragging the content has
19336 * - @c "scroll,drag,stop" - This is called when dragging the content has
19338 * - @c "edge,top" - This is called when the genlist is scrolled until
19340 * - @c "edge,bottom" - This is called when the genlist is scrolled
19341 * until the bottom edge.
19342 * - @c "edge,left" - This is called when the genlist is scrolled
19343 * until the left edge.
19344 * - @c "edge,right" - This is called when the genlist is scrolled
19345 * until the right edge.
19346 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
19348 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
19350 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
19352 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
19354 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
19355 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
19356 * multi-touch pinched in.
19357 * - @c "swipe" - This is called when the genlist is swiped.
19358 * - @c "moved" - This is called when a genlist item is moved.
19359 * - @c "language,changed" - This is called when the program's language is
19362 * @section Genlist_Examples Examples
19364 * Here is a list of examples that use the genlist, trying to show some of
19365 * its capabilities:
19366 * - @ref genlist_example_01
19367 * - @ref genlist_example_02
19368 * - @ref genlist_example_03
19369 * - @ref genlist_example_04
19370 * - @ref genlist_example_05
19374 * @addtogroup Genlist
19379 * @enum _Elm_Genlist_Item_Flags
19380 * @typedef Elm_Genlist_Item_Flags
19382 * Defines if the item is of any special type (has subitems or it's the
19383 * index of a group), or is just a simple item.
19387 typedef enum _Elm_Genlist_Item_Flags
19389 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
19390 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
19391 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
19392 } Elm_Genlist_Item_Flags;
19393 typedef enum _Elm_Genlist_Item_Field_Flags
19395 ELM_GENLIST_ITEM_FIELD_ALL = 0,
19396 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
19397 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
19398 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
19399 } Elm_Genlist_Item_Field_Flags;
19400 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
19401 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
19402 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19403 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19404 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
19407 * Text fetching class function for Elm_Gen_Item_Class.
19408 * @param data The data passed in the item creation function
19409 * @param obj The base widget object
19410 * @param part The part name of the swallow
19411 * @return The allocated (NOT stringshared) string to set as the text
19413 typedef char *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19416 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
19417 * @param data The data passed in the item creation function
19418 * @param obj The base widget object
19419 * @param part The part name of the swallow
19420 * @return The content object to swallow
19422 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19425 * State fetching class function for Elm_Gen_Item_Class.
19426 * @param data The data passed in the item creation function
19427 * @param obj The base widget object
19428 * @param part The part name of the swallow
19429 * @return The hell if I know
19431 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19434 * Deletion class function for Elm_Gen_Item_Class.
19435 * @param data The data passed in the item creation function
19436 * @param obj The base widget object
19438 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
19441 * @struct _Elm_Genlist_Item_Class
19443 * Genlist item class definition structs.
19445 * This struct contains the style and fetching functions that will define the
19446 * contents of each item.
19448 * @see @ref Genlist_Item_Class
19450 struct _Elm_Genlist_Item_Class
19452 const char *item_style; /**< style of this class. */
19453 struct Elm_Genlist_Item_Class_Func
19455 Elm_Genlist_Item_Text_Get_Cb text_get; /**< Text fetching class function for genlist item classes.*/
19456 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
19457 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
19458 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
19461 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
19463 * Add a new genlist widget to the given parent Elementary
19464 * (container) object
19466 * @param parent The parent object
19467 * @return a new genlist widget handle or @c NULL, on errors
19469 * This function inserts a new genlist widget on the canvas.
19471 * @see elm_genlist_item_append()
19472 * @see elm_genlist_item_del()
19473 * @see elm_genlist_clear()
19477 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19480 * Remove all items from a given genlist widget.
19482 * @param obj The genlist object
19484 * This removes (and deletes) all items in @p obj, leaving it empty.
19486 * @see elm_genlist_item_del(), to remove just one item.
19490 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19493 * Enable or disable multi-selection in the genlist
19495 * @param obj The genlist object
19496 * @param multi Multi-select enable/disable. Default is disabled.
19498 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
19499 * the list. This allows more than 1 item to be selected. To retrieve the list
19500 * of selected items, use elm_genlist_selected_items_get().
19502 * @see elm_genlist_selected_items_get()
19503 * @see elm_genlist_multi_select_get()
19507 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
19510 * Gets if multi-selection in genlist is enabled or disabled.
19512 * @param obj The genlist object
19513 * @return Multi-select enabled/disabled
19514 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
19516 * @see elm_genlist_multi_select_set()
19520 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19523 * This sets the horizontal stretching mode.
19525 * @param obj The genlist object
19526 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
19528 * This sets the mode used for sizing items horizontally. Valid modes
19529 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
19530 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
19531 * the scroller will scroll horizontally. Otherwise items are expanded
19532 * to fill the width of the viewport of the scroller. If it is
19533 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
19534 * limited to that size.
19536 * @see elm_genlist_horizontal_get()
19540 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19541 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19544 * Gets the horizontal stretching mode.
19546 * @param obj The genlist object
19547 * @return The mode to use
19548 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
19550 * @see elm_genlist_horizontal_set()
19554 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19555 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19558 * Set the always select mode.
19560 * @param obj The genlist object
19561 * @param always_select The always select mode (@c EINA_TRUE = on, @c
19562 * EINA_FALSE = off). Default is @c EINA_FALSE.
19564 * Items will only call their selection func and callback when first
19565 * becoming selected. Any further clicks will do nothing, unless you
19566 * enable always select with elm_genlist_always_select_mode_set().
19567 * This means that, even if selected, every click will make the selected
19568 * callbacks be called.
19570 * @see elm_genlist_always_select_mode_get()
19574 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
19577 * Get the always select mode.
19579 * @param obj The genlist object
19580 * @return The always select mode
19581 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19583 * @see elm_genlist_always_select_mode_set()
19587 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19590 * Enable/disable the no select mode.
19592 * @param obj The genlist object
19593 * @param no_select The no select mode
19594 * (EINA_TRUE = on, EINA_FALSE = off)
19596 * This will turn off the ability to select items entirely and they
19597 * will neither appear selected nor call selected callback functions.
19599 * @see elm_genlist_no_select_mode_get()
19603 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
19606 * Gets whether the no select mode is enabled.
19608 * @param obj The genlist object
19609 * @return The no select mode
19610 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19612 * @see elm_genlist_no_select_mode_set()
19616 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19619 * Enable/disable compress mode.
19621 * @param obj The genlist object
19622 * @param compress The compress mode
19623 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
19625 * This will enable the compress mode where items are "compressed"
19626 * horizontally to fit the genlist scrollable viewport width. This is
19627 * special for genlist. Do not rely on
19628 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
19629 * work as genlist needs to handle it specially.
19631 * @see elm_genlist_compress_mode_get()
19635 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
19638 * Get whether the compress mode is enabled.
19640 * @param obj The genlist object
19641 * @return The compress mode
19642 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19644 * @see elm_genlist_compress_mode_set()
19648 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19651 * Enable/disable height-for-width mode.
19653 * @param obj The genlist object
19654 * @param setting The height-for-width mode (@c EINA_TRUE = on,
19655 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19657 * With height-for-width mode the item width will be fixed (restricted
19658 * to a minimum of) to the list width when calculating its size in
19659 * order to allow the height to be calculated based on it. This allows,
19660 * for instance, text block to wrap lines if the Edje part is
19661 * configured with "text.min: 0 1".
19663 * @note This mode will make list resize slower as it will have to
19664 * recalculate every item height again whenever the list width
19667 * @note When height-for-width mode is enabled, it also enables
19668 * compress mode (see elm_genlist_compress_mode_set()) and
19669 * disables homogeneous (see elm_genlist_homogeneous_set()).
19673 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19676 * Get whether the height-for-width mode is enabled.
19678 * @param obj The genlist object
19679 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19684 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19687 * Enable/disable horizontal and vertical bouncing effect.
19689 * @param obj The genlist object
19690 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19691 * EINA_FALSE = off). Default is @c EINA_FALSE.
19692 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19693 * EINA_FALSE = off). Default is @c EINA_TRUE.
19695 * This will enable or disable the scroller bouncing effect for the
19696 * genlist. See elm_scroller_bounce_set() for details.
19698 * @see elm_scroller_bounce_set()
19699 * @see elm_genlist_bounce_get()
19703 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19706 * Get whether the horizontal and vertical bouncing effect is enabled.
19708 * @param obj The genlist object
19709 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19711 * @param v_bounce Pointer to a bool to receive if the bounce vertically
19714 * @see elm_genlist_bounce_set()
19718 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19721 * Enable/disable homogeneous mode.
19723 * @param obj The genlist object
19724 * @param homogeneous Assume the items within the genlist are of the
19725 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19728 * This will enable the homogeneous mode where items are of the same
19729 * height and width so that genlist may do the lazy-loading at its
19730 * maximum (which increases the performance for scrolling the list). This
19731 * implies 'compressed' mode.
19733 * @see elm_genlist_compress_mode_set()
19734 * @see elm_genlist_homogeneous_get()
19738 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19741 * Get whether the homogeneous mode is enabled.
19743 * @param obj The genlist object
19744 * @return Assume the items within the genlist are of the same height
19745 * and width (EINA_TRUE = on, EINA_FALSE = off)
19747 * @see elm_genlist_homogeneous_set()
19751 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19754 * Set the maximum number of items within an item block
19756 * @param obj The genlist object
19757 * @param n Maximum number of items within an item block. Default is 32.
19759 * This will configure the block count to tune to the target with
19760 * particular performance matrix.
19762 * A block of objects will be used to reduce the number of operations due to
19763 * many objects in the screen. It can determine the visibility, or if the
19764 * object has changed, it theme needs to be updated, etc. doing this kind of
19765 * calculation to the entire block, instead of per object.
19767 * The default value for the block count is enough for most lists, so unless
19768 * you know you will have a lot of objects visible in the screen at the same
19769 * time, don't try to change this.
19771 * @see elm_genlist_block_count_get()
19772 * @see @ref Genlist_Implementation
19776 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19779 * Get the maximum number of items within an item block
19781 * @param obj The genlist object
19782 * @return Maximum number of items within an item block
19784 * @see elm_genlist_block_count_set()
19788 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19791 * Set the timeout in seconds for the longpress event.
19793 * @param obj The genlist object
19794 * @param timeout timeout in seconds. Default is 1.
19796 * This option will change how long it takes to send an event "longpressed"
19797 * after the mouse down signal is sent to the list. If this event occurs, no
19798 * "clicked" event will be sent.
19800 * @see elm_genlist_longpress_timeout_set()
19804 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19807 * Get the timeout in seconds for the longpress event.
19809 * @param obj The genlist object
19810 * @return timeout in seconds
19812 * @see elm_genlist_longpress_timeout_get()
19816 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19819 * Append a new item in a given genlist widget.
19821 * @param obj The genlist object
19822 * @param itc The item class for the item
19823 * @param data The item data
19824 * @param parent The parent item, or NULL if none
19825 * @param flags Item flags
19826 * @param func Convenience function called when the item is selected
19827 * @param func_data Data passed to @p func above.
19828 * @return A handle to the item added or @c NULL if not possible
19830 * This adds the given item to the end of the list or the end of
19831 * the children list if the @p parent is given.
19833 * @see elm_genlist_item_prepend()
19834 * @see elm_genlist_item_insert_before()
19835 * @see elm_genlist_item_insert_after()
19836 * @see elm_genlist_item_del()
19840 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);
19843 * Prepend a new item in a given genlist widget.
19845 * @param obj The genlist object
19846 * @param itc The item class for the item
19847 * @param data The item data
19848 * @param parent The parent item, or NULL if none
19849 * @param flags Item flags
19850 * @param func Convenience function called when the item is selected
19851 * @param func_data Data passed to @p func above.
19852 * @return A handle to the item added or NULL if not possible
19854 * This adds an item to the beginning of the list or beginning of the
19855 * children of the parent if given.
19857 * @see elm_genlist_item_append()
19858 * @see elm_genlist_item_insert_before()
19859 * @see elm_genlist_item_insert_after()
19860 * @see elm_genlist_item_del()
19864 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);
19867 * Insert an item before another in a genlist widget
19869 * @param obj The genlist object
19870 * @param itc The item class for the item
19871 * @param data The item data
19872 * @param before The item to place this new one before.
19873 * @param flags Item flags
19874 * @param func Convenience function called when the item is selected
19875 * @param func_data Data passed to @p func above.
19876 * @return A handle to the item added or @c NULL if not possible
19878 * This inserts an item before another in the list. It will be in the
19879 * same tree level or group as the item it is inserted before.
19881 * @see elm_genlist_item_append()
19882 * @see elm_genlist_item_prepend()
19883 * @see elm_genlist_item_insert_after()
19884 * @see elm_genlist_item_del()
19888 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);
19891 * Insert an item after another in a genlist widget
19893 * @param obj The genlist object
19894 * @param itc The item class for the item
19895 * @param data The item data
19896 * @param after The item to place this new one after.
19897 * @param flags Item flags
19898 * @param func Convenience function called when the item is selected
19899 * @param func_data Data passed to @p func above.
19900 * @return A handle to the item added or @c NULL if not possible
19902 * This inserts an item after another in the list. It will be in the
19903 * same tree level or group as the item it is inserted after.
19905 * @see elm_genlist_item_append()
19906 * @see elm_genlist_item_prepend()
19907 * @see elm_genlist_item_insert_before()
19908 * @see elm_genlist_item_del()
19912 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);
19915 * Insert a new item into the sorted genlist object
19917 * @param obj The genlist object
19918 * @param itc The item class for the item
19919 * @param data The item data
19920 * @param parent The parent item, or NULL if none
19921 * @param flags Item flags
19922 * @param comp The function called for the sort
19923 * @param func Convenience function called when item selected
19924 * @param func_data Data passed to @p func above.
19925 * @return A handle to the item added or NULL if not possible
19929 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);
19930 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);
19932 /* operations to retrieve existing items */
19934 * Get the selectd item in the genlist.
19936 * @param obj The genlist object
19937 * @return The selected item, or NULL if none is selected.
19939 * This gets the selected item in the list (if multi-selection is enabled, only
19940 * the item that was first selected in the list is returned - which is not very
19941 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19944 * If no item is selected, NULL is returned.
19946 * @see elm_genlist_selected_items_get()
19950 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19953 * Get a list of selected items in the genlist.
19955 * @param obj The genlist object
19956 * @return The list of selected items, or NULL if none are selected.
19958 * It returns a list of the selected items. This list pointer is only valid so
19959 * long as the selection doesn't change (no items are selected or unselected, or
19960 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19961 * pointers. The order of the items in this list is the order which they were
19962 * selected, i.e. the first item in this list is the first item that was
19963 * selected, and so on.
19965 * @note If not in multi-select mode, consider using function
19966 * elm_genlist_selected_item_get() instead.
19968 * @see elm_genlist_multi_select_set()
19969 * @see elm_genlist_selected_item_get()
19973 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19976 * Get the mode item style of items in the genlist
19977 * @param obj The genlist object
19978 * @return The mode item style string, or NULL if none is specified
19980 * This is a constant string and simply defines the name of the
19981 * style that will be used for mode animations. It can be
19982 * @c NULL if you don't plan to use Genlist mode. See
19983 * elm_genlist_item_mode_set() for more info.
19987 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19990 * Set the mode item style of items in the genlist
19991 * @param obj The genlist object
19992 * @param style The mode item style string, or NULL if none is desired
19994 * This is a constant string and simply defines the name of the
19995 * style that will be used for mode animations. It can be
19996 * @c NULL if you don't plan to use Genlist mode. See
19997 * elm_genlist_item_mode_set() for more info.
20001 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
20004 * Get a list of realized items in genlist
20006 * @param obj The genlist object
20007 * @return The list of realized items, nor NULL if none are realized.
20009 * This returns a list of the realized items in the genlist. The list
20010 * contains Elm_Genlist_Item pointers. The list must be freed by the
20011 * caller when done with eina_list_free(). The item pointers in the
20012 * list are only valid so long as those items are not deleted or the
20013 * genlist is not deleted.
20015 * @see elm_genlist_realized_items_update()
20019 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20022 * Get the item that is at the x, y canvas coords.
20024 * @param obj The gelinst object.
20025 * @param x The input x coordinate
20026 * @param y The input y coordinate
20027 * @param posret The position relative to the item returned here
20028 * @return The item at the coordinates or NULL if none
20030 * This returns the item at the given coordinates (which are canvas
20031 * relative, not object-relative). If an item is at that coordinate,
20032 * that item handle is returned, and if @p posret is not NULL, the
20033 * integer pointed to is set to a value of -1, 0 or 1, depending if
20034 * the coordinate is on the upper portion of that item (-1), on the
20035 * middle section (0) or on the lower part (1). If NULL is returned as
20036 * an item (no item found there), then posret may indicate -1 or 1
20037 * based if the coordinate is above or below all items respectively in
20042 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);
20045 * Get the first item in the genlist
20047 * This returns the first item in the list.
20049 * @param obj The genlist object
20050 * @return The first item, or NULL if none
20054 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20057 * Get the last item in the genlist
20059 * This returns the last item in the list.
20061 * @return The last item, or NULL if none
20065 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20068 * Set the scrollbar policy
20070 * @param obj The genlist object
20071 * @param policy_h Horizontal scrollbar policy.
20072 * @param policy_v Vertical scrollbar policy.
20074 * This sets the scrollbar visibility policy for the given genlist
20075 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
20076 * made visible if it is needed, and otherwise kept hidden.
20077 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
20078 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
20079 * respectively for the horizontal and vertical scrollbars. Default is
20080 * #ELM_SMART_SCROLLER_POLICY_AUTO
20082 * @see elm_genlist_scroller_policy_get()
20086 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
20089 * Get the scrollbar policy
20091 * @param obj The genlist object
20092 * @param policy_h Pointer to store the horizontal scrollbar policy.
20093 * @param policy_v Pointer to store the vertical scrollbar policy.
20095 * @see elm_genlist_scroller_policy_set()
20099 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);
20102 * Get the @b next item in a genlist widget's internal list of items,
20103 * given a handle to one of those items.
20105 * @param item The genlist item to fetch next from
20106 * @return The item after @p item, or @c NULL if there's none (and
20109 * This returns the item placed after the @p item, on the container
20112 * @see elm_genlist_item_prev_get()
20116 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20119 * Get the @b previous item in a genlist widget's internal list of items,
20120 * given a handle to one of those items.
20122 * @param item The genlist item to fetch previous from
20123 * @return The item before @p item, or @c NULL if there's none (and
20126 * This returns the item placed before the @p item, on the container
20129 * @see elm_genlist_item_next_get()
20133 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20136 * Get the genlist object's handle which contains a given genlist
20139 * @param item The item to fetch the container from
20140 * @return The genlist (parent) object
20142 * This returns the genlist object itself that an item belongs to.
20146 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20149 * Get the parent item of the given item
20151 * @param it The item
20152 * @return The parent of the item or @c NULL if it has no parent.
20154 * This returns the item that was specified as parent of the item @p it on
20155 * elm_genlist_item_append() and insertion related functions.
20159 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20162 * Remove all sub-items (children) of the given item
20164 * @param it The item
20166 * This removes all items that are children (and their descendants) of the
20167 * given item @p it.
20169 * @see elm_genlist_clear()
20170 * @see elm_genlist_item_del()
20174 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20177 * Set whether a given genlist item is selected or not
20179 * @param it The item
20180 * @param selected Use @c EINA_TRUE, to make it selected, @c
20181 * EINA_FALSE to make it unselected
20183 * This sets the selected state of an item. If multi selection is
20184 * not enabled on the containing genlist and @p selected is @c
20185 * EINA_TRUE, any other previously selected items will get
20186 * unselected in favor of this new one.
20188 * @see elm_genlist_item_selected_get()
20192 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20195 * Get whether a given genlist item is selected or not
20197 * @param it The item
20198 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20200 * @see elm_genlist_item_selected_set() for more details
20204 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20207 * Sets the expanded state of an item.
20209 * @param it The item
20210 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
20212 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
20215 * The theme will respond to this change visually, and a signal "expanded" or
20216 * "contracted" will be sent from the genlist with a pointer to the item that
20217 * has been expanded/contracted.
20219 * Calling this function won't show or hide any child of this item (if it is
20220 * a parent). You must manually delete and create them on the callbacks fo
20221 * the "expanded" or "contracted" signals.
20223 * @see elm_genlist_item_expanded_get()
20227 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
20230 * Get the expanded state of an item
20232 * @param it The item
20233 * @return The expanded state
20235 * This gets the expanded state of an item.
20237 * @see elm_genlist_item_expanded_set()
20241 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20244 * Get the depth of expanded item
20246 * @param it The genlist item object
20247 * @return The depth of expanded item
20251 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20254 * Set whether a given genlist item is disabled or not.
20256 * @param it The item
20257 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
20258 * to enable it back.
20260 * A disabled item cannot be selected or unselected. It will also
20261 * change its appearance, to signal the user it's disabled.
20263 * @see elm_genlist_item_disabled_get()
20267 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20270 * Get whether a given genlist item is disabled or not.
20272 * @param it The item
20273 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
20276 * @see elm_genlist_item_disabled_set() for more details
20280 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20283 * Sets the display only state of an item.
20285 * @param it The item
20286 * @param display_only @c EINA_TRUE if the item is display only, @c
20287 * EINA_FALSE otherwise.
20289 * A display only item cannot be selected or unselected. It is for
20290 * display only and not selecting or otherwise clicking, dragging
20291 * etc. by the user, thus finger size rules will not be applied to
20294 * It's good to set group index items to display only state.
20296 * @see elm_genlist_item_display_only_get()
20300 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
20303 * Get the display only state of an item
20305 * @param it The item
20306 * @return @c EINA_TRUE if the item is display only, @c
20307 * EINA_FALSE otherwise.
20309 * @see elm_genlist_item_display_only_set()
20313 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20316 * Show the portion of a genlist's internal list containing a given
20317 * item, immediately.
20319 * @param it The item to display
20321 * This causes genlist to jump to the given item @p it and show it (by
20322 * immediately scrolling to that position), if it is not fully visible.
20324 * @see elm_genlist_item_bring_in()
20325 * @see elm_genlist_item_top_show()
20326 * @see elm_genlist_item_middle_show()
20330 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20333 * Animatedly bring in, to the visible are of a genlist, a given
20336 * @param it The item to display
20338 * This causes genlist to jump to the given item @p it and show it (by
20339 * animatedly scrolling), if it is not fully visible. This may use animation
20340 * to do so and take a period of time
20342 * @see elm_genlist_item_show()
20343 * @see elm_genlist_item_top_bring_in()
20344 * @see elm_genlist_item_middle_bring_in()
20348 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20351 * Show the portion of a genlist's internal list containing a given
20352 * item, immediately.
20354 * @param it The item to display
20356 * This causes genlist to jump to the given item @p it and show it (by
20357 * immediately scrolling to that position), if it is not fully visible.
20359 * The item will be positioned at the top of the genlist viewport.
20361 * @see elm_genlist_item_show()
20362 * @see elm_genlist_item_top_bring_in()
20366 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20369 * Animatedly bring in, to the visible are of a genlist, a given
20372 * @param it The item
20374 * This causes genlist to jump to the given item @p it and show it (by
20375 * animatedly scrolling), if it is not fully visible. This may use animation
20376 * to do so and take a period of time
20378 * The item will be positioned at the top of the genlist viewport.
20380 * @see elm_genlist_item_bring_in()
20381 * @see elm_genlist_item_top_show()
20385 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20388 * Show the portion of a genlist's internal list containing a given
20389 * item, immediately.
20391 * @param it The item to display
20393 * This causes genlist to jump to the given item @p it and show it (by
20394 * immediately scrolling to that position), if it is not fully visible.
20396 * The item will be positioned at the middle of the genlist viewport.
20398 * @see elm_genlist_item_show()
20399 * @see elm_genlist_item_middle_bring_in()
20403 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20406 * Animatedly bring in, to the visible are of a genlist, a given
20409 * @param it The item
20411 * This causes genlist to jump to the given item @p it and show it (by
20412 * animatedly scrolling), if it is not fully visible. This may use animation
20413 * to do so and take a period of time
20415 * The item will be positioned at the middle of the genlist viewport.
20417 * @see elm_genlist_item_bring_in()
20418 * @see elm_genlist_item_middle_show()
20422 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20425 * Remove a genlist item from the its parent, deleting it.
20427 * @param item The item to be removed.
20428 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
20430 * @see elm_genlist_clear(), to remove all items in a genlist at
20435 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20438 * Return the data associated to a given genlist item
20440 * @param item The genlist item.
20441 * @return the data associated to this item.
20443 * This returns the @c data value passed on the
20444 * elm_genlist_item_append() and related item addition calls.
20446 * @see elm_genlist_item_append()
20447 * @see elm_genlist_item_data_set()
20451 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20454 * Set the data associated to a given genlist item
20456 * @param item The genlist item
20457 * @param data The new data pointer to set on it
20459 * This @b overrides the @c data value passed on the
20460 * elm_genlist_item_append() and related item addition calls. This
20461 * function @b won't call elm_genlist_item_update() automatically,
20462 * so you'd issue it afterwards if you want to hove the item
20463 * updated to reflect the that new data.
20465 * @see elm_genlist_item_data_get()
20469 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
20472 * Tells genlist to "orphan" contents fetchs by the item class
20474 * @param it The item
20476 * This instructs genlist to release references to contents in the item,
20477 * meaning that they will no longer be managed by genlist and are
20478 * floating "orphans" that can be re-used elsewhere if the user wants
20483 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20484 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20487 * Get the real Evas object created to implement the view of a
20488 * given genlist item
20490 * @param item The genlist item.
20491 * @return the Evas object implementing this item's view.
20493 * This returns the actual Evas object used to implement the
20494 * specified genlist item's view. This may be @c NULL, as it may
20495 * not have been created or may have been deleted, at any time, by
20496 * the genlist. <b>Do not modify this object</b> (move, resize,
20497 * show, hide, etc.), as the genlist is controlling it. This
20498 * function is for querying, emitting custom signals or hooking
20499 * lower level callbacks for events on that object. Do not delete
20500 * this object under any circumstances.
20502 * @see elm_genlist_item_data_get()
20506 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20509 * Update the contents of an item
20511 * @param it The item
20513 * This updates an item by calling all the item class functions again
20514 * to get the contents, texts and states. Use this when the original
20515 * item data has changed and the changes are desired to be reflected.
20517 * Use elm_genlist_realized_items_update() to update all already realized
20520 * @see elm_genlist_realized_items_update()
20524 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20527 * Promote an item to the top of the list
20529 * @param it The item
20533 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20536 * Demote an item to the end of the list
20538 * @param it The item
20542 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20545 * Update the part of an item
20547 * @param it The item
20548 * @param parts The name of item's part
20549 * @param itf The flags of item's part type
20551 * This updates an item's part by calling item's fetching functions again
20552 * to get the contents, texts and states. Use this when the original
20553 * item data has changed and the changes are desired to be reflected.
20554 * Second parts argument is used for globbing to match '*', '?', and '.'
20555 * It can be used at updating multi fields.
20557 * Use elm_genlist_realized_items_update() to update an item's all
20560 * @see elm_genlist_item_update()
20564 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
20567 * Update the item class of an item
20569 * @param it The item
20570 * @param itc The item class for the item
20572 * This sets another class fo the item, changing the way that it is
20573 * displayed. After changing the item class, elm_genlist_item_update() is
20574 * called on the item @p it.
20578 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
20579 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20582 * Set the text to be shown in a given genlist item's tooltips.
20584 * @param item The genlist item
20585 * @param text The text to set in the content
20587 * This call will setup the text to be used as tooltip to that item
20588 * (analogous to elm_object_tooltip_text_set(), but being item
20589 * tooltips with higher precedence than object tooltips). It can
20590 * have only one tooltip at a time, so any previous tooltip data
20591 * will get removed.
20593 * In order to set a content or something else as a tooltip, look at
20594 * elm_genlist_item_tooltip_content_cb_set().
20598 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
20601 * Set the content to be shown in a given genlist item's tooltips
20603 * @param item The genlist item.
20604 * @param func The function returning the tooltip contents.
20605 * @param data What to provide to @a func as callback data/context.
20606 * @param del_cb Called when data is not needed anymore, either when
20607 * another callback replaces @p func, the tooltip is unset with
20608 * elm_genlist_item_tooltip_unset() or the owner @p item
20609 * dies. This callback receives as its first parameter the
20610 * given @p data, being @c event_info the item handle.
20612 * This call will setup the tooltip's contents to @p item
20613 * (analogous to elm_object_tooltip_content_cb_set(), but being
20614 * item tooltips with higher precedence than object tooltips). It
20615 * can have only one tooltip at a time, so any previous tooltip
20616 * content will get removed. @p func (with @p data) will be called
20617 * every time Elementary needs to show the tooltip and it should
20618 * return a valid Evas object, which will be fully managed by the
20619 * tooltip system, getting deleted when the tooltip is gone.
20621 * In order to set just a text as a tooltip, look at
20622 * elm_genlist_item_tooltip_text_set().
20626 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);
20629 * Unset a tooltip from a given genlist item
20631 * @param item genlist item to remove a previously set tooltip from.
20633 * This call removes any tooltip set on @p item. The callback
20634 * provided as @c del_cb to
20635 * elm_genlist_item_tooltip_content_cb_set() will be called to
20636 * notify it is not used anymore (and have resources cleaned, if
20639 * @see elm_genlist_item_tooltip_content_cb_set()
20643 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20646 * Set a different @b style for a given genlist item's tooltip.
20648 * @param item genlist item with tooltip set
20649 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
20650 * "default", @c "transparent", etc)
20652 * Tooltips can have <b>alternate styles</b> to be displayed on,
20653 * which are defined by the theme set on Elementary. This function
20654 * works analogously as elm_object_tooltip_style_set(), but here
20655 * applied only to genlist item objects. The default style for
20656 * tooltips is @c "default".
20658 * @note before you set a style you should define a tooltip with
20659 * elm_genlist_item_tooltip_content_cb_set() or
20660 * elm_genlist_item_tooltip_text_set()
20662 * @see elm_genlist_item_tooltip_style_get()
20666 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20669 * Get the style set a given genlist item's tooltip.
20671 * @param item genlist item with tooltip already set on.
20672 * @return style the theme style in use, which defaults to
20673 * "default". If the object does not have a tooltip set,
20674 * then @c NULL is returned.
20676 * @see elm_genlist_item_tooltip_style_set() for more details
20680 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20683 * @brief Disable size restrictions on an object's tooltip
20684 * @param item The tooltip's anchor object
20685 * @param disable If EINA_TRUE, size restrictions are disabled
20686 * @return EINA_FALSE on failure, EINA_TRUE on success
20688 * This function allows a tooltip to expand beyond its parant window's canvas.
20689 * It will instead be limited only by the size of the display.
20691 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
20694 * @brief Retrieve size restriction state of an object's tooltip
20695 * @param item The tooltip's anchor object
20696 * @return If EINA_TRUE, size restrictions are disabled
20698 * This function returns whether a tooltip is allowed to expand beyond
20699 * its parant window's canvas.
20700 * It will instead be limited only by the size of the display.
20702 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
20705 * Set the type of mouse pointer/cursor decoration to be shown,
20706 * when the mouse pointer is over the given genlist widget item
20708 * @param item genlist item to customize cursor on
20709 * @param cursor the cursor type's name
20711 * This function works analogously as elm_object_cursor_set(), but
20712 * here the cursor's changing area is restricted to the item's
20713 * area, and not the whole widget's. Note that that item cursors
20714 * have precedence over widget cursors, so that a mouse over @p
20715 * item will always show cursor @p type.
20717 * If this function is called twice for an object, a previously set
20718 * cursor will be unset on the second call.
20720 * @see elm_object_cursor_set()
20721 * @see elm_genlist_item_cursor_get()
20722 * @see elm_genlist_item_cursor_unset()
20726 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20729 * Get the type of mouse pointer/cursor decoration set to be shown,
20730 * when the mouse pointer is over the given genlist widget item
20732 * @param item genlist item with custom cursor set
20733 * @return the cursor type's name or @c NULL, if no custom cursors
20734 * were set to @p item (and on errors)
20736 * @see elm_object_cursor_get()
20737 * @see elm_genlist_item_cursor_set() for more details
20738 * @see elm_genlist_item_cursor_unset()
20742 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20745 * Unset any custom mouse pointer/cursor decoration set to be
20746 * shown, when the mouse pointer is over the given genlist widget
20747 * item, thus making it show the @b default cursor again.
20749 * @param item a genlist item
20751 * Use this call to undo any custom settings on this item's cursor
20752 * decoration, bringing it back to defaults (no custom style set).
20754 * @see elm_object_cursor_unset()
20755 * @see elm_genlist_item_cursor_set() for more details
20759 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20762 * Set a different @b style for a given custom cursor set for a
20765 * @param item genlist item with custom cursor set
20766 * @param style the <b>theme style</b> to use (e.g. @c "default",
20767 * @c "transparent", etc)
20769 * This function only makes sense when one is using custom mouse
20770 * cursor decorations <b>defined in a theme file</b> , which can
20771 * have, given a cursor name/type, <b>alternate styles</b> on
20772 * it. It works analogously as elm_object_cursor_style_set(), but
20773 * here applied only to genlist item objects.
20775 * @warning Before you set a cursor style you should have defined a
20776 * custom cursor previously on the item, with
20777 * elm_genlist_item_cursor_set()
20779 * @see elm_genlist_item_cursor_engine_only_set()
20780 * @see elm_genlist_item_cursor_style_get()
20784 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20787 * Get the current @b style set for a given genlist item's custom
20790 * @param item genlist item with custom cursor set.
20791 * @return style the cursor style in use. If the object does not
20792 * have a cursor set, then @c NULL is returned.
20794 * @see elm_genlist_item_cursor_style_set() for more details
20798 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20801 * Set if the (custom) cursor for a given genlist item should be
20802 * searched in its theme, also, or should only rely on the
20803 * rendering engine.
20805 * @param item item with custom (custom) cursor already set on
20806 * @param engine_only Use @c EINA_TRUE to have cursors looked for
20807 * only on those provided by the rendering engine, @c EINA_FALSE to
20808 * have them searched on the widget's theme, as well.
20810 * @note This call is of use only if you've set a custom cursor
20811 * for genlist items, with elm_genlist_item_cursor_set().
20813 * @note By default, cursors will only be looked for between those
20814 * provided by the rendering engine.
20818 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20821 * Get if the (custom) cursor for a given genlist item is being
20822 * searched in its theme, also, or is only relying on the rendering
20825 * @param item a genlist item
20826 * @return @c EINA_TRUE, if cursors are being looked for only on
20827 * those provided by the rendering engine, @c EINA_FALSE if they
20828 * are being searched on the widget's theme, as well.
20830 * @see elm_genlist_item_cursor_engine_only_set(), for more details
20834 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20837 * Update the contents of all realized items.
20839 * @param obj The genlist object.
20841 * This updates all realized items by calling all the item class functions again
20842 * to get the contents, texts and states. Use this when the original
20843 * item data has changed and the changes are desired to be reflected.
20845 * To update just one item, use elm_genlist_item_update().
20847 * @see elm_genlist_realized_items_get()
20848 * @see elm_genlist_item_update()
20852 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20855 * Activate a genlist mode on an item
20857 * @param item The genlist item
20858 * @param mode Mode name
20859 * @param mode_set Boolean to define set or unset mode.
20861 * A genlist mode is a different way of selecting an item. Once a mode is
20862 * activated on an item, any other selected item is immediately unselected.
20863 * This feature provides an easy way of implementing a new kind of animation
20864 * for selecting an item, without having to entirely rewrite the item style
20865 * theme. However, the elm_genlist_selected_* API can't be used to get what
20866 * item is activate for a mode.
20868 * The current item style will still be used, but applying a genlist mode to
20869 * an item will select it using a different kind of animation.
20871 * The current active item for a mode can be found by
20872 * elm_genlist_mode_item_get().
20874 * The characteristics of genlist mode are:
20875 * - Only one mode can be active at any time, and for only one item.
20876 * - Genlist handles deactivating other items when one item is activated.
20877 * - A mode is defined in the genlist theme (edc), and more modes can easily
20879 * - A mode style and the genlist item style are different things. They
20880 * can be combined to provide a default style to the item, with some kind
20881 * of animation for that item when the mode is activated.
20883 * When a mode is activated on an item, a new view for that item is created.
20884 * The theme of this mode defines the animation that will be used to transit
20885 * the item from the old view to the new view. This second (new) view will be
20886 * active for that item while the mode is active on the item, and will be
20887 * destroyed after the mode is totally deactivated from that item.
20889 * @see elm_genlist_mode_get()
20890 * @see elm_genlist_mode_item_get()
20894 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20897 * Get the last (or current) genlist mode used.
20899 * @param obj The genlist object
20901 * This function just returns the name of the last used genlist mode. It will
20902 * be the current mode if it's still active.
20904 * @see elm_genlist_item_mode_set()
20905 * @see elm_genlist_mode_item_get()
20909 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20912 * Get active genlist mode item
20914 * @param obj The genlist object
20915 * @return The active item for that current mode. Or @c NULL if no item is
20916 * activated with any mode.
20918 * This function returns the item that was activated with a mode, by the
20919 * function elm_genlist_item_mode_set().
20921 * @see elm_genlist_item_mode_set()
20922 * @see elm_genlist_mode_get()
20926 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20931 * @param obj The genlist object
20932 * @param reorder_mode The reorder mode
20933 * (EINA_TRUE = on, EINA_FALSE = off)
20937 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20940 * Get the reorder mode
20942 * @param obj The genlist object
20943 * @return The reorder mode
20944 * (EINA_TRUE = on, EINA_FALSE = off)
20948 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20955 * @defgroup Check Check
20957 * @image html img/widget/check/preview-00.png
20958 * @image latex img/widget/check/preview-00.eps
20959 * @image html img/widget/check/preview-01.png
20960 * @image latex img/widget/check/preview-01.eps
20961 * @image html img/widget/check/preview-02.png
20962 * @image latex img/widget/check/preview-02.eps
20964 * @brief The check widget allows for toggling a value between true and
20967 * Check objects are a lot like radio objects in layout and functionality
20968 * except they do not work as a group, but independently and only toggle the
20969 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20970 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20971 * returns the current state. For convenience, like the radio objects, you
20972 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20973 * for it to modify.
20975 * Signals that you can add callbacks for are:
20976 * "changed" - This is called whenever the user changes the state of one of
20977 * the check object(event_info is NULL).
20979 * Default contents parts of the check widget that you can use for are:
20980 * @li "icon" - An icon of the check
20982 * Default text parts of the check widget that you can use for are:
20983 * @li "elm.text" - Label of the check
20985 * @ref tutorial_check should give you a firm grasp of how to use this widget
20990 * @brief Add a new Check object
20992 * @param parent The parent object
20993 * @return The new object or NULL if it cannot be created
20995 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20998 * @brief Set the text label of the check object
21000 * @param obj The check object
21001 * @param label The text label string in UTF-8
21003 * @deprecated use elm_object_text_set() instead.
21005 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21008 * @brief Get the text label of the check object
21010 * @param obj The check object
21011 * @return The text label string in UTF-8
21013 * @deprecated use elm_object_text_get() instead.
21015 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21018 * @brief Set the icon object of the check object
21020 * @param obj The check object
21021 * @param icon The icon object
21023 * Once the icon object is set, a previously set one will be deleted.
21024 * If you want to keep that old content object, use the
21025 * elm_object_content_unset() function.
21027 * @deprecated use elm_object_part_content_set() instead.
21030 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21033 * @brief Get the icon object of the check object
21035 * @param obj The check object
21036 * @return The icon object
21038 * @deprecated use elm_object_part_content_get() instead.
21041 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21044 * @brief Unset the icon used for the check object
21046 * @param obj The check object
21047 * @return The icon object that was being used
21049 * Unparent and return the icon object which was set for this widget.
21051 * @deprecated use elm_object_part_content_unset() instead.
21054 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21057 * @brief Set the on/off state of the check object
21059 * @param obj The check object
21060 * @param state The state to use (1 == on, 0 == off)
21062 * This sets the state of the check. If set
21063 * with elm_check_state_pointer_set() the state of that variable is also
21064 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
21066 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21069 * @brief Get the state of the check object
21071 * @param obj The check object
21072 * @return The boolean state
21074 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21077 * @brief Set a convenience pointer to a boolean to change
21079 * @param obj The check object
21080 * @param statep Pointer to the boolean to modify
21082 * This sets a pointer to a boolean, that, in addition to the check objects
21083 * state will also be modified directly. To stop setting the object pointed
21084 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
21085 * then when this is called, the check objects state will also be modified to
21086 * reflect the value of the boolean @p statep points to, just like calling
21087 * elm_check_state_set().
21089 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
21090 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
21091 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);
21098 * @defgroup Radio Radio
21100 * @image html img/widget/radio/preview-00.png
21101 * @image latex img/widget/radio/preview-00.eps
21103 * @brief Radio is a widget that allows for 1 or more options to be displayed
21104 * and have the user choose only 1 of them.
21106 * A radio object contains an indicator, an optional Label and an optional
21107 * icon object. While it's possible to have a group of only one radio they,
21108 * are normally used in groups of 2 or more. To add a radio to a group use
21109 * elm_radio_group_add(). The radio object(s) will select from one of a set
21110 * of integer values, so any value they are configuring needs to be mapped to
21111 * a set of integers. To configure what value that radio object represents,
21112 * use elm_radio_state_value_set() to set the integer it represents. To set
21113 * the value the whole group(which one is currently selected) is to indicate
21114 * use elm_radio_value_set() on any group member, and to get the groups value
21115 * use elm_radio_value_get(). For convenience the radio objects are also able
21116 * to directly set an integer(int) to the value that is selected. To specify
21117 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
21118 * The radio objects will modify this directly. That implies the pointer must
21119 * point to valid memory for as long as the radio objects exist.
21121 * Signals that you can add callbacks for are:
21122 * @li changed - This is called whenever the user changes the state of one of
21123 * the radio objects within the group of radio objects that work together.
21125 * Default contents parts of the radio widget that you can use for are:
21126 * @li "icon" - An icon of the radio
21128 * @ref tutorial_radio show most of this API in action.
21133 * @brief Add a new radio to the parent
21135 * @param parent The parent object
21136 * @return The new object or NULL if it cannot be created
21138 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21141 * @brief Set the text label of the radio object
21143 * @param obj The radio object
21144 * @param label The text label string in UTF-8
21146 * @deprecated use elm_object_text_set() instead.
21148 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21151 * @brief Get the text label of the radio object
21153 * @param obj The radio object
21154 * @return The text label string in UTF-8
21156 * @deprecated use elm_object_text_set() instead.
21158 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21161 * @brief Set the icon object of the radio object
21163 * @param obj The radio object
21164 * @param icon The icon object
21166 * Once the icon object is set, a previously set one will be deleted. If you
21167 * want to keep that old content object, use the elm_radio_icon_unset()
21170 * @deprecated use elm_object_part_content_set() instead.
21173 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21176 * @brief Get the icon object of the radio object
21178 * @param obj The radio object
21179 * @return The icon object
21181 * @see elm_radio_icon_set()
21183 * @deprecated use elm_object_part_content_get() instead.
21186 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21189 * @brief Unset the icon used for the radio object
21191 * @param obj The radio object
21192 * @return The icon object that was being used
21194 * Unparent and return the icon object which was set for this widget.
21196 * @see elm_radio_icon_set()
21197 * @deprecated use elm_object_part_content_unset() instead.
21200 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21203 * @brief Add this radio to a group of other radio objects
21205 * @param obj The radio object
21206 * @param group Any object whose group the @p obj is to join.
21208 * Radio objects work in groups. Each member should have a different integer
21209 * value assigned. In order to have them work as a group, they need to know
21210 * about each other. This adds the given radio object to the group of which
21211 * the group object indicated is a member.
21213 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
21216 * @brief Set the integer value that this radio object represents
21218 * @param obj The radio object
21219 * @param value The value to use if this radio object is selected
21221 * This sets the value of the radio.
21223 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21226 * @brief Get the integer value that this radio object represents
21228 * @param obj The radio object
21229 * @return The value used if this radio object is selected
21231 * This gets the value of the radio.
21233 * @see elm_radio_value_set()
21235 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21238 * @brief Set the value of the radio.
21240 * @param obj The radio object
21241 * @param value The value to use for the group
21243 * This sets the value of the radio group and will also set the value if
21244 * pointed to, to the value supplied, but will not call any callbacks.
21246 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21249 * @brief Get the state of the radio object
21251 * @param obj The radio object
21252 * @return The integer state
21254 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21257 * @brief Set a convenience pointer to a integer to change
21259 * @param obj The radio object
21260 * @param valuep Pointer to the integer to modify
21262 * This sets a pointer to a integer, that, in addition to the radio objects
21263 * state will also be modified directly. To stop setting the object pointed
21264 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
21265 * when this is called, the radio objects state will also be modified to
21266 * reflect the value of the integer valuep points to, just like calling
21267 * elm_radio_value_set().
21269 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
21276 * @defgroup Pager Pager
21278 * @image html img/widget/pager/preview-00.png
21279 * @image latex img/widget/pager/preview-00.eps
21281 * @brief Widget that allows flipping between one or more āpagesā
21284 * The flipping between pages of objects is animated. All content
21285 * in the pager is kept in a stack, being the last content added
21286 * (visible one) on the top of that stack.
21288 * Objects can be pushed or popped from the stack or deleted as
21289 * well. Pushes and pops will animate the widget accordingly to its
21290 * style (a pop will also delete the child object once the
21291 * animation is finished). Any object already in the pager can be
21292 * promoted to the top (from its current stacking position) through
21293 * the use of elm_pager_content_promote(). New objects are pushed
21294 * to the top with elm_pager_content_push(). When the top item is
21295 * no longer wanted, simply pop it with elm_pager_content_pop() and
21296 * it will also be deleted. If an object is no longer needed and is
21297 * not the top item, just delete it as normal. You can query which
21298 * objects are the top and bottom with
21299 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
21301 * Signals that you can add callbacks for are:
21302 * - @c "show,finished" - when a new page is actually shown on the top
21303 * - @c "hide,finished" - when a previous page is hidden
21305 * Only after the first of that signals the child object is
21306 * guaranteed to be visible, as in @c evas_object_visible_get().
21308 * This widget has the following styles available:
21311 * - @c "fade_translucide"
21312 * - @c "fade_invisible"
21314 * @note These styles affect only the flipping animations on the
21315 * default theme; the appearance when not animating is unaffected
21318 * @ref tutorial_pager gives a good overview of the usage of the API.
21323 * Add a new pager to the parent
21325 * @param parent The parent object
21326 * @return The new object or NULL if it cannot be created
21330 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21333 * @brief Push an object to the top of the pager stack (and show it).
21335 * @param obj The pager object
21336 * @param content The object to push
21338 * The object pushed becomes a child of the pager, it will be controlled and
21339 * deleted when the pager is deleted.
21341 * @note If the content is already in the stack use
21342 * elm_pager_content_promote().
21343 * @warning Using this function on @p content already in the stack results in
21344 * undefined behavior.
21346 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21349 * @brief Pop the object that is on top of the stack
21351 * @param obj The pager object
21353 * This pops the object that is on the top(visible) of the pager, makes it
21354 * disappear, then deletes the object. The object that was underneath it on
21355 * the stack will become visible.
21357 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
21360 * @brief Moves an object already in the pager stack to the top of the stack.
21362 * @param obj The pager object
21363 * @param content The object to promote
21365 * This will take the @p content and move it to the top of the stack as
21366 * if it had been pushed there.
21368 * @note If the content isn't already in the stack use
21369 * elm_pager_content_push().
21370 * @warning Using this function on @p content not already in the stack
21371 * results in undefined behavior.
21373 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21376 * @brief Return the object at the bottom of the pager stack
21378 * @param obj The pager object
21379 * @return The bottom object or NULL if none
21381 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21384 * @brief Return the object at the top of the pager stack
21386 * @param obj The pager object
21387 * @return The top object or NULL if none
21389 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21396 * @defgroup Slideshow Slideshow
21398 * @image html img/widget/slideshow/preview-00.png
21399 * @image latex img/widget/slideshow/preview-00.eps
21401 * This widget, as the name indicates, is a pre-made image
21402 * slideshow panel, with API functions acting on (child) image
21403 * items presentation. Between those actions, are:
21404 * - advance to next/previous image
21405 * - select the style of image transition animation
21406 * - set the exhibition time for each image
21407 * - start/stop the slideshow
21409 * The transition animations are defined in the widget's theme,
21410 * consequently new animations can be added without having to
21411 * update the widget's code.
21413 * @section Slideshow_Items Slideshow items
21415 * For slideshow items, just like for @ref Genlist "genlist" ones,
21416 * the user defines a @b classes, specifying functions that will be
21417 * called on the item's creation and deletion times.
21419 * The #Elm_Slideshow_Item_Class structure contains the following
21422 * - @c func.get - When an item is displayed, this function is
21423 * called, and it's where one should create the item object, de
21424 * facto. For example, the object can be a pure Evas image object
21425 * or an Elementary @ref Photocam "photocam" widget. See
21426 * #SlideshowItemGetFunc.
21427 * - @c func.del - When an item is no more displayed, this function
21428 * is called, where the user must delete any data associated to
21429 * the item. See #SlideshowItemDelFunc.
21431 * @section Slideshow_Caching Slideshow caching
21433 * The slideshow provides facilities to have items adjacent to the
21434 * one being displayed <b>already "realized"</b> (i.e. loaded) for
21435 * you, so that the system does not have to decode image data
21436 * anymore at the time it has to actually switch images on its
21437 * viewport. The user is able to set the numbers of items to be
21438 * cached @b before and @b after the current item, in the widget's
21441 * Smart events one can add callbacks for are:
21443 * - @c "changed" - when the slideshow switches its view to a new
21444 * item. event_info parameter in callback contains the current visible item
21445 * - @c "transition,end" - when a slide transition ends. event_info parameter
21446 * in callback contains the current visible item
21448 * List of examples for the slideshow widget:
21449 * @li @ref slideshow_example
21453 * @addtogroup Slideshow
21457 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
21458 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
21459 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
21460 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
21463 * @struct _Elm_Slideshow_Item_Class
21465 * Slideshow item class definition. See @ref Slideshow_Items for
21468 struct _Elm_Slideshow_Item_Class
21470 struct _Elm_Slideshow_Item_Class_Func
21472 SlideshowItemGetFunc get;
21473 SlideshowItemDelFunc del;
21475 }; /**< #Elm_Slideshow_Item_Class member definitions */
21478 * Add a new slideshow widget to the given parent Elementary
21479 * (container) object
21481 * @param parent The parent object
21482 * @return A new slideshow widget handle or @c NULL, on errors
21484 * This function inserts a new slideshow widget on the canvas.
21486 * @ingroup Slideshow
21488 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21491 * Add (append) a new item in a given slideshow widget.
21493 * @param obj The slideshow object
21494 * @param itc The item class for the item
21495 * @param data The item's data
21496 * @return A handle to the item added or @c NULL, on errors
21498 * Add a new item to @p obj's internal list of items, appending it.
21499 * The item's class must contain the function really fetching the
21500 * image object to show for this item, which could be an Evas image
21501 * object or an Elementary photo, for example. The @p data
21502 * parameter is going to be passed to both class functions of the
21505 * @see #Elm_Slideshow_Item_Class
21506 * @see elm_slideshow_item_sorted_insert()
21507 * @see elm_object_item_data_set()
21509 * @ingroup Slideshow
21511 EAPI Elm_Object_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
21514 * Insert a new item into the given slideshow widget, using the @p func
21515 * function to sort items (by item handles).
21517 * @param obj The slideshow object
21518 * @param itc The item class for the item
21519 * @param data The item's data
21520 * @param func The comparing function to be used to sort slideshow
21521 * items <b>by #Elm_Slideshow_Item item handles</b>
21522 * @return Returns The slideshow item handle, on success, or
21523 * @c NULL, on errors
21525 * Add a new item to @p obj's internal list of items, in a position
21526 * determined by the @p func comparing function. The item's class
21527 * must contain the function really fetching the image object to
21528 * show for this item, which could be an Evas image object or an
21529 * Elementary photo, for example. The @p data parameter is going to
21530 * be passed to both class functions of the item.
21532 * @see #Elm_Slideshow_Item_Class
21533 * @see elm_slideshow_item_add()
21535 * @ingroup Slideshow
21537 EAPI Elm_Object_Item *elm_slideshow_item_sorted_insert(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) EINA_ARG_NONNULL(1);
21540 * Display a given slideshow widget's item, programmatically.
21542 * @param it The item to display on @p obj's viewport
21544 * The change between the current item and @p item will use the
21545 * transition @p obj is set to use (@see
21546 * elm_slideshow_transition_set()).
21548 * @ingroup Slideshow
21550 EAPI void elm_slideshow_show(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21553 * Slide to the @b next item, in a given slideshow widget
21555 * @param obj The slideshow object
21557 * The sliding animation @p obj is set to use will be the
21558 * transition effect used, after this call is issued.
21560 * @note If the end of the slideshow's internal list of items is
21561 * reached, it'll wrap around to the list's beginning, again.
21563 * @ingroup Slideshow
21565 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21568 * Slide to the @b previous item, in a given slideshow widget
21570 * @param obj The slideshow object
21572 * The sliding animation @p obj is set to use will be the
21573 * transition effect used, after this call is issued.
21575 * @note If the beginning of the slideshow's internal list of items
21576 * is reached, it'll wrap around to the list's end, again.
21578 * @ingroup Slideshow
21580 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
21583 * Returns the list of sliding transition/effect names available, for a
21584 * given slideshow widget.
21586 * @param obj The slideshow object
21587 * @return The list of transitions (list of @b stringshared strings
21590 * The transitions, which come from @p obj's theme, must be an EDC
21591 * data item named @c "transitions" on the theme file, with (prefix)
21592 * names of EDC programs actually implementing them.
21594 * The available transitions for slideshows on the default theme are:
21595 * - @c "fade" - the current item fades out, while the new one
21596 * fades in to the slideshow's viewport.
21597 * - @c "black_fade" - the current item fades to black, and just
21598 * then, the new item will fade in.
21599 * - @c "horizontal" - the current item slides horizontally, until
21600 * it gets out of the slideshow's viewport, while the new item
21601 * comes from the left to take its place.
21602 * - @c "vertical" - the current item slides vertically, until it
21603 * gets out of the slideshow's viewport, while the new item comes
21604 * from the bottom to take its place.
21605 * - @c "square" - the new item starts to appear from the middle of
21606 * the current one, but with a tiny size, growing until its
21607 * target (full) size and covering the old one.
21609 * @warning The stringshared strings get no new references
21610 * exclusive to the user grabbing the list, here, so if you'd like
21611 * to use them out of this call's context, you'd better @c
21612 * eina_stringshare_ref() them.
21614 * @see elm_slideshow_transition_set()
21616 * @ingroup Slideshow
21618 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21621 * Set the current slide transition/effect in use for a given
21624 * @param obj The slideshow object
21625 * @param transition The new transition's name string
21627 * If @p transition is implemented in @p obj's theme (i.e., is
21628 * contained in the list returned by
21629 * elm_slideshow_transitions_get()), this new sliding effect will
21630 * be used on the widget.
21632 * @see elm_slideshow_transitions_get() for more details
21634 * @ingroup Slideshow
21636 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
21639 * Get the current slide transition/effect in use for a given
21642 * @param obj The slideshow object
21643 * @return The current transition's name
21645 * @see elm_slideshow_transition_set() for more details
21647 * @ingroup Slideshow
21649 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21652 * Set the interval between each image transition on a given
21653 * slideshow widget, <b>and start the slideshow, itself</b>
21655 * @param obj The slideshow object
21656 * @param timeout The new displaying timeout for images
21658 * After this call, the slideshow widget will start cycling its
21659 * view, sequentially and automatically, with the images of the
21660 * items it has. The time between each new image displayed is going
21661 * to be @p timeout, in @b seconds. If a different timeout was set
21662 * previously and an slideshow was in progress, it will continue
21663 * with the new time between transitions, after this call.
21665 * @note A value less than or equal to 0 on @p timeout will disable
21666 * the widget's internal timer, thus halting any slideshow which
21667 * could be happening on @p obj.
21669 * @see elm_slideshow_timeout_get()
21671 * @ingroup Slideshow
21673 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
21676 * Get the interval set for image transitions on a given slideshow
21679 * @param obj The slideshow object
21680 * @return Returns the timeout set on it
21682 * @see elm_slideshow_timeout_set() for more details
21684 * @ingroup Slideshow
21686 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21689 * Set if, after a slideshow is started, for a given slideshow
21690 * widget, its items should be displayed cyclically or not.
21692 * @param obj The slideshow object
21693 * @param loop Use @c EINA_TRUE to make it cycle through items or
21694 * @c EINA_FALSE for it to stop at the end of @p obj's internal
21697 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
21698 * ignore what is set by this functions, i.e., they'll @b always
21699 * cycle through items. This affects only the "automatic"
21700 * slideshow, as set by elm_slideshow_timeout_set().
21702 * @see elm_slideshow_loop_get()
21704 * @ingroup Slideshow
21706 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
21709 * Get if, after a slideshow is started, for a given slideshow
21710 * widget, its items are to be displayed cyclically or not.
21712 * @param obj The slideshow object
21713 * @return @c EINA_TRUE, if the items in @p obj will be cycled
21714 * through or @c EINA_FALSE, otherwise
21716 * @see elm_slideshow_loop_set() for more details
21718 * @ingroup Slideshow
21720 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21723 * Remove all items from a given slideshow widget
21725 * @param obj The slideshow object
21727 * This removes (and deletes) all items in @p obj, leaving it
21730 * @see elm_slideshow_item_del(), to remove just one item.
21732 * @ingroup Slideshow
21734 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21737 * Get the internal list of items in a given slideshow widget.
21739 * @param obj The slideshow object
21740 * @return The list of items (#Elm_Object_Item as data) or
21741 * @c NULL on errors.
21743 * This list is @b not to be modified in any way and must not be
21744 * freed. Use the list members with functions like
21745 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
21747 * @warning This list is only valid until @p obj object's internal
21748 * items list is changed. It should be fetched again with another
21749 * call to this function when changes happen.
21751 * @ingroup Slideshow
21753 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21756 * Delete a given item from a slideshow widget.
21758 * @param it The slideshow item
21760 * @ingroup Slideshow
21762 EAPI void elm_slideshow_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21765 * Return the data associated with a given slideshow item
21767 * @param it The slideshow item
21768 * @return Returns the data associated to this item
21770 * @deprecated use elm_object_item_data_get() instead
21771 * @ingroup Slideshow
21773 EINA_DEPRECATED EAPI void *elm_slideshow_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21776 * Returns the currently displayed item, in a given slideshow widget
21778 * @param obj The slideshow object
21779 * @return A handle to the item being displayed in @p obj or
21780 * @c NULL, if none is (and on errors)
21782 * @ingroup Slideshow
21784 EAPI Elm_Object_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21787 * Get the real Evas object created to implement the view of a
21788 * given slideshow item
21790 * @param item The slideshow item.
21791 * @return the Evas object implementing this item's view.
21793 * This returns the actual Evas object used to implement the
21794 * specified slideshow item's view. This may be @c NULL, as it may
21795 * not have been created or may have been deleted, at any time, by
21796 * the slideshow. <b>Do not modify this object</b> (move, resize,
21797 * show, hide, etc.), as the slideshow is controlling it. This
21798 * function is for querying, emitting custom signals or hooking
21799 * lower level callbacks for events on that object. Do not delete
21800 * this object under any circumstances.
21802 * @see elm_slideshow_item_data_get()
21804 * @ingroup Slideshow
21806 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Object_Item* it) EINA_ARG_NONNULL(1);
21809 * Get the the item, in a given slideshow widget, placed at
21810 * position @p nth, in its internal items list
21812 * @param obj The slideshow object
21813 * @param nth The number of the item to grab a handle to (0 being
21815 * @return The item stored in @p obj at position @p nth or @c NULL,
21816 * if there's no item with that index (and on errors)
21818 * @ingroup Slideshow
21820 EAPI Elm_Object_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21823 * Set the current slide layout in use for a given slideshow widget
21825 * @param obj The slideshow object
21826 * @param layout The new layout's name string
21828 * If @p layout is implemented in @p obj's theme (i.e., is contained
21829 * in the list returned by elm_slideshow_layouts_get()), this new
21830 * images layout will be used on the widget.
21832 * @see elm_slideshow_layouts_get() for more details
21834 * @ingroup Slideshow
21836 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21839 * Get the current slide layout in use for a given slideshow widget
21841 * @param obj The slideshow object
21842 * @return The current layout's name
21844 * @see elm_slideshow_layout_set() for more details
21846 * @ingroup Slideshow
21848 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21851 * Returns the list of @b layout names available, for a given
21852 * slideshow widget.
21854 * @param obj The slideshow object
21855 * @return The list of layouts (list of @b stringshared strings
21858 * Slideshow layouts will change how the widget is to dispose each
21859 * image item in its viewport, with regard to cropping, scaling,
21862 * The layouts, which come from @p obj's theme, must be an EDC
21863 * data item name @c "layouts" on the theme file, with (prefix)
21864 * names of EDC programs actually implementing them.
21866 * The available layouts for slideshows on the default theme are:
21867 * - @c "fullscreen" - item images with original aspect, scaled to
21868 * touch top and down slideshow borders or, if the image's heigh
21869 * is not enough, left and right slideshow borders.
21870 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21871 * one, but always leaving 10% of the slideshow's dimensions of
21872 * distance between the item image's borders and the slideshow
21873 * borders, for each axis.
21875 * @warning The stringshared strings get no new references
21876 * exclusive to the user grabbing the list, here, so if you'd like
21877 * to use them out of this call's context, you'd better @c
21878 * eina_stringshare_ref() them.
21880 * @see elm_slideshow_layout_set()
21882 * @ingroup Slideshow
21884 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21887 * Set the number of items to cache, on a given slideshow widget,
21888 * <b>before the current item</b>
21890 * @param obj The slideshow object
21891 * @param count Number of items to cache before the current one
21893 * The default value for this property is @c 2. See
21894 * @ref Slideshow_Caching "slideshow caching" for more details.
21896 * @see elm_slideshow_cache_before_get()
21898 * @ingroup Slideshow
21900 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21903 * Retrieve the number of items to cache, on a given slideshow widget,
21904 * <b>before the current item</b>
21906 * @param obj The slideshow object
21907 * @return The number of items set to be cached before the current one
21909 * @see elm_slideshow_cache_before_set() for more details
21911 * @ingroup Slideshow
21913 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21916 * Set the number of items to cache, on a given slideshow widget,
21917 * <b>after the current item</b>
21919 * @param obj The slideshow object
21920 * @param count Number of items to cache after the current one
21922 * The default value for this property is @c 2. See
21923 * @ref Slideshow_Caching "slideshow caching" for more details.
21925 * @see elm_slideshow_cache_after_get()
21927 * @ingroup Slideshow
21929 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21932 * Retrieve the number of items to cache, on a given slideshow widget,
21933 * <b>after the current item</b>
21935 * @param obj The slideshow object
21936 * @return The number of items set to be cached after the current one
21938 * @see elm_slideshow_cache_after_set() for more details
21940 * @ingroup Slideshow
21942 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21945 * Get the number of items stored in a given slideshow widget
21947 * @param obj The slideshow object
21948 * @return The number of items on @p obj, at the moment of this call
21950 * @ingroup Slideshow
21952 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21959 * @defgroup Fileselector File Selector
21961 * @image html img/widget/fileselector/preview-00.png
21962 * @image latex img/widget/fileselector/preview-00.eps
21964 * A file selector is a widget that allows a user to navigate
21965 * through a file system, reporting file selections back via its
21968 * It contains shortcut buttons for home directory (@c ~) and to
21969 * jump one directory upwards (..), as well as cancel/ok buttons to
21970 * confirm/cancel a given selection. After either one of those two
21971 * former actions, the file selector will issue its @c "done" smart
21974 * There's a text entry on it, too, showing the name of the current
21975 * selection. There's the possibility of making it editable, so it
21976 * is useful on file saving dialogs on applications, where one
21977 * gives a file name to save contents to, in a given directory in
21978 * the system. This custom file name will be reported on the @c
21979 * "done" smart callback (explained in sequence).
21981 * Finally, it has a view to display file system items into in two
21986 * If Elementary is built with support of the Ethumb thumbnailing
21987 * library, the second form of view will display preview thumbnails
21988 * of files which it supports.
21990 * Smart callbacks one can register to:
21992 * - @c "selected" - the user has clicked on a file (when not in
21993 * folders-only mode) or directory (when in folders-only mode)
21994 * - @c "directory,open" - the list has been populated with new
21995 * content (@c event_info is a pointer to the directory's
21996 * path, a @b stringshared string)
21997 * - @c "done" - the user has clicked on the "ok" or "cancel"
21998 * buttons (@c event_info is a pointer to the selection's
21999 * path, a @b stringshared string)
22001 * Here is an example on its usage:
22002 * @li @ref fileselector_example
22006 * @addtogroup Fileselector
22011 * Defines how a file selector widget is to layout its contents
22012 * (file system entries).
22014 typedef enum _Elm_Fileselector_Mode
22016 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
22017 ELM_FILESELECTOR_GRID, /**< layout as a grid */
22018 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
22019 } Elm_Fileselector_Mode;
22022 * Add a new file selector widget to the given parent Elementary
22023 * (container) object
22025 * @param parent The parent object
22026 * @return a new file selector widget handle or @c NULL, on errors
22028 * This function inserts a new file selector widget on the canvas.
22030 * @ingroup Fileselector
22032 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22035 * Enable/disable the file name entry box where the user can type
22036 * in a name for a file, in a given file selector widget
22038 * @param obj The file selector object
22039 * @param is_save @c EINA_TRUE to make the file selector a "saving
22040 * dialog", @c EINA_FALSE otherwise
22042 * Having the entry editable is useful on file saving dialogs on
22043 * applications, where one gives a file name to save contents to,
22044 * in a given directory in the system. This custom file name will
22045 * be reported on the @c "done" smart callback.
22047 * @see elm_fileselector_is_save_get()
22049 * @ingroup Fileselector
22051 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
22054 * Get whether the given file selector is in "saving dialog" mode
22056 * @param obj The file selector object
22057 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
22058 * mode, @c EINA_FALSE otherwise (and on errors)
22060 * @see elm_fileselector_is_save_set() for more details
22062 * @ingroup Fileselector
22064 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22067 * Enable/disable folder-only view for a given file selector widget
22069 * @param obj The file selector object
22070 * @param only @c EINA_TRUE to make @p obj only display
22071 * directories, @c EINA_FALSE to make files to be displayed in it
22074 * If enabled, the widget's view will only display folder items,
22077 * @see elm_fileselector_folder_only_get()
22079 * @ingroup Fileselector
22081 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
22084 * Get whether folder-only view is set for a given file selector
22087 * @param obj The file selector object
22088 * @return only @c EINA_TRUE if @p obj is only displaying
22089 * directories, @c EINA_FALSE if files are being displayed in it
22090 * too (and on errors)
22092 * @see elm_fileselector_folder_only_get()
22094 * @ingroup Fileselector
22096 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22099 * Enable/disable the "ok" and "cancel" buttons on a given file
22102 * @param obj The file selector object
22103 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
22105 * @note A file selector without those buttons will never emit the
22106 * @c "done" smart event, and is only usable if one is just hooking
22107 * to the other two events.
22109 * @see elm_fileselector_buttons_ok_cancel_get()
22111 * @ingroup Fileselector
22113 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
22116 * Get whether the "ok" and "cancel" buttons on a given file
22117 * selector widget are being shown.
22119 * @param obj The file selector object
22120 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
22121 * otherwise (and on errors)
22123 * @see elm_fileselector_buttons_ok_cancel_set() for more details
22125 * @ingroup Fileselector
22127 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22130 * Enable/disable a tree view in the given file selector widget,
22131 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
22133 * @param obj The file selector object
22134 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
22137 * In a tree view, arrows are created on the sides of directories,
22138 * allowing them to expand in place.
22140 * @note If it's in other mode, the changes made by this function
22141 * will only be visible when one switches back to "list" mode.
22143 * @see elm_fileselector_expandable_get()
22145 * @ingroup Fileselector
22147 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
22150 * Get whether tree view is enabled for the given file selector
22153 * @param obj The file selector object
22154 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
22155 * otherwise (and or errors)
22157 * @see elm_fileselector_expandable_set() for more details
22159 * @ingroup Fileselector
22161 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22164 * Set, programmatically, the @b directory that a given file
22165 * selector widget will display contents from
22167 * @param obj The file selector object
22168 * @param path The path to display in @p obj
22170 * This will change the @b directory that @p obj is displaying. It
22171 * will also clear the text entry area on the @p obj object, which
22172 * displays select files' names.
22174 * @see elm_fileselector_path_get()
22176 * @ingroup Fileselector
22178 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22181 * Get the parent directory's path that a given file selector
22182 * widget is displaying
22184 * @param obj The file selector object
22185 * @return The (full) path of the directory the file selector is
22186 * displaying, a @b stringshared string
22188 * @see elm_fileselector_path_set()
22190 * @ingroup Fileselector
22192 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22195 * Set, programmatically, the currently selected file/directory in
22196 * the given file selector widget
22198 * @param obj The file selector object
22199 * @param path The (full) path to a file or directory
22200 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
22201 * latter case occurs if the directory or file pointed to do not
22204 * @see elm_fileselector_selected_get()
22206 * @ingroup Fileselector
22208 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22211 * Get the currently selected item's (full) path, in the given file
22214 * @param obj The file selector object
22215 * @return The absolute path of the selected item, a @b
22216 * stringshared string
22218 * @note Custom editions on @p obj object's text entry, if made,
22219 * will appear on the return string of this function, naturally.
22221 * @see elm_fileselector_selected_set() for more details
22223 * @ingroup Fileselector
22225 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22228 * Set the mode in which a given file selector widget will display
22229 * (layout) file system entries in its view
22231 * @param obj The file selector object
22232 * @param mode The mode of the fileselector, being it one of
22233 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
22234 * first one, naturally, will display the files in a list. The
22235 * latter will make the widget to display its entries in a grid
22238 * @note By using elm_fileselector_expandable_set(), the user may
22239 * trigger a tree view for that list.
22241 * @note If Elementary is built with support of the Ethumb
22242 * thumbnailing library, the second form of view will display
22243 * preview thumbnails of files which it supports. You must have
22244 * elm_need_ethumb() called in your Elementary for thumbnailing to
22247 * @see elm_fileselector_expandable_set().
22248 * @see elm_fileselector_mode_get().
22250 * @ingroup Fileselector
22252 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
22255 * Get the mode in which a given file selector widget is displaying
22256 * (layouting) file system entries in its view
22258 * @param obj The fileselector object
22259 * @return The mode in which the fileselector is at
22261 * @see elm_fileselector_mode_set() for more details
22263 * @ingroup Fileselector
22265 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22272 * @defgroup Progressbar Progress bar
22274 * The progress bar is a widget for visually representing the
22275 * progress status of a given job/task.
22277 * A progress bar may be horizontal or vertical. It may display an
22278 * icon besides it, as well as primary and @b units labels. The
22279 * former is meant to label the widget as a whole, while the
22280 * latter, which is formatted with floating point values (and thus
22281 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
22282 * units"</c>), is meant to label the widget's <b>progress
22283 * value</b>. Label, icon and unit strings/objects are @b optional
22284 * for progress bars.
22286 * A progress bar may be @b inverted, in which state it gets its
22287 * values inverted, with high values being on the left or top and
22288 * low values on the right or bottom, as opposed to normally have
22289 * the low values on the former and high values on the latter,
22290 * respectively, for horizontal and vertical modes.
22292 * The @b span of the progress, as set by
22293 * elm_progressbar_span_size_set(), is its length (horizontally or
22294 * vertically), unless one puts size hints on the widget to expand
22295 * on desired directions, by any container. That length will be
22296 * scaled by the object or applications scaling factor. At any
22297 * point code can query the progress bar for its value with
22298 * elm_progressbar_value_get().
22300 * Available widget styles for progress bars:
22302 * - @c "wheel" (simple style, no text, no progression, only
22303 * "pulse" effect is available)
22305 * Default contents parts of the progressbar widget that you can use for are:
22306 * @li "icon" - An icon of the progressbar
22308 * Here is an example on its usage:
22309 * @li @ref progressbar_example
22313 * Add a new progress bar widget to the given parent Elementary
22314 * (container) object
22316 * @param parent The parent object
22317 * @return a new progress bar widget handle or @c NULL, on errors
22319 * This function inserts a new progress bar widget on the canvas.
22321 * @ingroup Progressbar
22323 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22326 * Set whether a given progress bar widget is at "pulsing mode" or
22329 * @param obj The progress bar object
22330 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
22331 * @c EINA_FALSE to put it back to its default one
22333 * By default, progress bars will display values from the low to
22334 * high value boundaries. There are, though, contexts in which the
22335 * state of progression of a given task is @b unknown. For those,
22336 * one can set a progress bar widget to a "pulsing state", to give
22337 * the user an idea that some computation is being held, but
22338 * without exact progress values. In the default theme it will
22339 * animate its bar with the contents filling in constantly and back
22340 * to non-filled, in a loop. To start and stop this pulsing
22341 * animation, one has to explicitly call elm_progressbar_pulse().
22343 * @see elm_progressbar_pulse_get()
22344 * @see elm_progressbar_pulse()
22346 * @ingroup Progressbar
22348 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
22351 * Get whether a given progress bar widget is at "pulsing mode" or
22354 * @param obj The progress bar object
22355 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
22356 * if it's in the default one (and on errors)
22358 * @ingroup Progressbar
22360 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22363 * Start/stop a given progress bar "pulsing" animation, if its
22366 * @param obj The progress bar object
22367 * @param state @c EINA_TRUE, to @b start the pulsing animation,
22368 * @c EINA_FALSE to @b stop it
22370 * @note This call won't do anything if @p obj is not under "pulsing mode".
22372 * @see elm_progressbar_pulse_set() for more details.
22374 * @ingroup Progressbar
22376 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
22379 * Set the progress value (in percentage) on a given progress bar
22382 * @param obj The progress bar object
22383 * @param val The progress value (@b must be between @c 0.0 and @c
22386 * Use this call to set progress bar levels.
22388 * @note If you passes a value out of the specified range for @p
22389 * val, it will be interpreted as the @b closest of the @b boundary
22390 * values in the range.
22392 * @ingroup Progressbar
22394 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22397 * Get the progress value (in percentage) on a given progress bar
22400 * @param obj The progress bar object
22401 * @return The value of the progressbar
22403 * @see elm_progressbar_value_set() for more details
22405 * @ingroup Progressbar
22407 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22410 * Set the label of a given progress bar widget
22412 * @param obj The progress bar object
22413 * @param label The text label string, in UTF-8
22415 * @ingroup Progressbar
22416 * @deprecated use elm_object_text_set() instead.
22418 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
22421 * Get the label of a given progress bar widget
22423 * @param obj The progressbar object
22424 * @return The text label string, in UTF-8
22426 * @ingroup Progressbar
22427 * @deprecated use elm_object_text_set() instead.
22429 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22432 * Set the icon object of a given progress bar widget
22434 * @param obj The progress bar object
22435 * @param icon The icon object
22437 * Use this call to decorate @p obj with an icon next to it.
22439 * @note Once the icon object is set, a previously set one will be
22440 * deleted. If you want to keep that old content object, use the
22441 * elm_progressbar_icon_unset() function.
22443 * @see elm_progressbar_icon_get()
22444 * @deprecated use elm_object_part_content_set() instead.
22446 * @ingroup Progressbar
22448 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
22451 * Retrieve the icon object set for a given progress bar widget
22453 * @param obj The progress bar object
22454 * @return The icon object's handle, if @p obj had one set, or @c NULL,
22455 * otherwise (and on errors)
22457 * @see elm_progressbar_icon_set() for more details
22458 * @deprecated use elm_object_part_content_get() instead.
22460 * @ingroup Progressbar
22462 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22465 * Unset an icon set on a given progress bar widget
22467 * @param obj The progress bar object
22468 * @return The icon object that was being used, if any was set, or
22469 * @c NULL, otherwise (and on errors)
22471 * This call will unparent and return the icon object which was set
22472 * for this widget, previously, on success.
22474 * @see elm_progressbar_icon_set() for more details
22475 * @deprecated use elm_object_part_content_unset() instead.
22477 * @ingroup Progressbar
22479 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22482 * Set the (exact) length of the bar region of a given progress bar
22485 * @param obj The progress bar object
22486 * @param size The length of the progress bar's bar region
22488 * This sets the minimum width (when in horizontal mode) or height
22489 * (when in vertical mode) of the actual bar area of the progress
22490 * bar @p obj. This in turn affects the object's minimum size. Use
22491 * this when you're not setting other size hints expanding on the
22492 * given direction (like weight and alignment hints) and you would
22493 * like it to have a specific size.
22495 * @note Icon, label and unit text around @p obj will require their
22496 * own space, which will make @p obj to require more the @p size,
22499 * @see elm_progressbar_span_size_get()
22501 * @ingroup Progressbar
22503 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
22506 * Get the length set for the bar region of a given progress bar
22509 * @param obj The progress bar object
22510 * @return The length of the progress bar's bar region
22512 * If that size was not set previously, with
22513 * elm_progressbar_span_size_set(), this call will return @c 0.
22515 * @ingroup Progressbar
22517 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22520 * Set the format string for a given progress bar widget's units
22523 * @param obj The progress bar object
22524 * @param format The format string for @p obj's units label
22526 * If @c NULL is passed on @p format, it will make @p obj's units
22527 * area to be hidden completely. If not, it'll set the <b>format
22528 * string</b> for the units label's @b text. The units label is
22529 * provided a floating point value, so the units text is up display
22530 * at most one floating point falue. Note that the units label is
22531 * optional. Use a format string such as "%1.2f meters" for
22534 * @note The default format string for a progress bar is an integer
22535 * percentage, as in @c "%.0f %%".
22537 * @see elm_progressbar_unit_format_get()
22539 * @ingroup Progressbar
22541 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
22544 * Retrieve the format string set for a given progress bar widget's
22547 * @param obj The progress bar object
22548 * @return The format set string for @p obj's units label or
22549 * @c NULL, if none was set (and on errors)
22551 * @see elm_progressbar_unit_format_set() for more details
22553 * @ingroup Progressbar
22555 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22558 * Set the orientation of a given progress bar widget
22560 * @param obj The progress bar object
22561 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22562 * @b horizontal, @c EINA_FALSE to make it @b vertical
22564 * Use this function to change how your progress bar is to be
22565 * disposed: vertically or horizontally.
22567 * @see elm_progressbar_horizontal_get()
22569 * @ingroup Progressbar
22571 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22574 * Retrieve the orientation of a given progress bar widget
22576 * @param obj The progress bar object
22577 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22578 * @c EINA_FALSE if it's @b vertical (and on errors)
22580 * @see elm_progressbar_horizontal_set() for more details
22582 * @ingroup Progressbar
22584 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22587 * Invert a given progress bar widget's displaying values order
22589 * @param obj The progress bar object
22590 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
22591 * @c EINA_FALSE to bring it back to default, non-inverted values.
22593 * A progress bar may be @b inverted, in which state it gets its
22594 * values inverted, with high values being on the left or top and
22595 * low values on the right or bottom, as opposed to normally have
22596 * the low values on the former and high values on the latter,
22597 * respectively, for horizontal and vertical modes.
22599 * @see elm_progressbar_inverted_get()
22601 * @ingroup Progressbar
22603 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
22606 * Get whether a given progress bar widget's displaying values are
22609 * @param obj The progress bar object
22610 * @return @c EINA_TRUE, if @p obj has inverted values,
22611 * @c EINA_FALSE otherwise (and on errors)
22613 * @see elm_progressbar_inverted_set() for more details
22615 * @ingroup Progressbar
22617 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22620 * @defgroup Separator Separator
22622 * @brief Separator is a very thin object used to separate other objects.
22624 * A separator can be vertical or horizontal.
22626 * @ref tutorial_separator is a good example of how to use a separator.
22630 * @brief Add a separator object to @p parent
22632 * @param parent The parent object
22634 * @return The separator object, or NULL upon failure
22636 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22638 * @brief Set the horizontal mode of a separator object
22640 * @param obj The separator object
22641 * @param horizontal If true, the separator is horizontal
22643 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22645 * @brief Get the horizontal mode of a separator object
22647 * @param obj The separator object
22648 * @return If true, the separator is horizontal
22650 * @see elm_separator_horizontal_set()
22652 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22658 * @defgroup Spinner Spinner
22659 * @ingroup Elementary
22661 * @image html img/widget/spinner/preview-00.png
22662 * @image latex img/widget/spinner/preview-00.eps
22664 * A spinner is a widget which allows the user to increase or decrease
22665 * numeric values using arrow buttons, or edit values directly, clicking
22666 * over it and typing the new value.
22668 * By default the spinner will not wrap and has a label
22669 * of "%.0f" (just showing the integer value of the double).
22671 * A spinner has a label that is formatted with floating
22672 * point values and thus accepts a printf-style format string, like
22673 * ā%1.2f unitsā.
22675 * It also allows specific values to be replaced by pre-defined labels.
22677 * Smart callbacks one can register to:
22679 * - "changed" - Whenever the spinner value is changed.
22680 * - "delay,changed" - A short time after the value is changed by the user.
22681 * This will be called only when the user stops dragging for a very short
22682 * period or when they release their finger/mouse, so it avoids possibly
22683 * expensive reactions to the value change.
22685 * Available styles for it:
22687 * - @c "vertical": up/down buttons at the right side and text left aligned.
22689 * Here is an example on its usage:
22690 * @ref spinner_example
22694 * @addtogroup Spinner
22699 * Add a new spinner widget to the given parent Elementary
22700 * (container) object.
22702 * @param parent The parent object.
22703 * @return a new spinner widget handle or @c NULL, on errors.
22705 * This function inserts a new spinner widget on the canvas.
22710 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22713 * Set the format string of the displayed label.
22715 * @param obj The spinner object.
22716 * @param fmt The format string for the label display.
22718 * If @c NULL, this sets the format to "%.0f". If not it sets the format
22719 * string for the label text. The label text is provided a floating point
22720 * value, so the label text can display up to 1 floating point value.
22721 * Note that this is optional.
22723 * Use a format string such as "%1.2f meters" for example, and it will
22724 * display values like: "3.14 meters" for a value equal to 3.14159.
22726 * Default is "%0.f".
22728 * @see elm_spinner_label_format_get()
22732 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
22735 * Get the label format of the spinner.
22737 * @param obj The spinner object.
22738 * @return The text label format string in UTF-8.
22740 * @see elm_spinner_label_format_set() for details.
22744 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22747 * Set the minimum and maximum values for the spinner.
22749 * @param obj The spinner object.
22750 * @param min The minimum value.
22751 * @param max The maximum value.
22753 * Define the allowed range of values to be selected by the user.
22755 * If actual value is less than @p min, it will be updated to @p min. If it
22756 * is bigger then @p max, will be updated to @p max. Actual value can be
22757 * get with elm_spinner_value_get().
22759 * By default, min is equal to 0, and max is equal to 100.
22761 * @warning Maximum must be greater than minimum.
22763 * @see elm_spinner_min_max_get()
22767 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22770 * Get the minimum and maximum values of the spinner.
22772 * @param obj The spinner object.
22773 * @param min Pointer where to store the minimum value.
22774 * @param max Pointer where to store the maximum value.
22776 * @note If only one value is needed, the other pointer can be passed
22779 * @see elm_spinner_min_max_set() for details.
22783 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22786 * Set the step used to increment or decrement the spinner value.
22788 * @param obj The spinner object.
22789 * @param step The step value.
22791 * This value will be incremented or decremented to the displayed value.
22792 * It will be incremented while the user keep right or top arrow pressed,
22793 * and will be decremented while the user keep left or bottom arrow pressed.
22795 * The interval to increment / decrement can be set with
22796 * elm_spinner_interval_set().
22798 * By default step value is equal to 1.
22800 * @see elm_spinner_step_get()
22804 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22807 * Get the step used to increment or decrement the spinner value.
22809 * @param obj The spinner object.
22810 * @return The step value.
22812 * @see elm_spinner_step_get() for more details.
22816 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22819 * Set the value the spinner displays.
22821 * @param obj The spinner object.
22822 * @param val The value to be displayed.
22824 * Value will be presented on the label following format specified with
22825 * elm_spinner_format_set().
22827 * @warning The value must to be between min and max values. This values
22828 * are set by elm_spinner_min_max_set().
22830 * @see elm_spinner_value_get().
22831 * @see elm_spinner_format_set().
22832 * @see elm_spinner_min_max_set().
22836 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22839 * Get the value displayed by the spinner.
22841 * @param obj The spinner object.
22842 * @return The value displayed.
22844 * @see elm_spinner_value_set() for details.
22848 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22851 * Set whether the spinner should wrap when it reaches its
22852 * minimum or maximum value.
22854 * @param obj The spinner object.
22855 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22858 * Disabled by default. If disabled, when the user tries to increment the
22860 * but displayed value plus step value is bigger than maximum value,
22862 * won't allow it. The same happens when the user tries to decrement it,
22863 * but the value less step is less than minimum value.
22865 * When wrap is enabled, in such situations it will allow these changes,
22866 * but will get the value that would be less than minimum and subtracts
22867 * from maximum. Or add the value that would be more than maximum to
22871 * @li min value = 10
22872 * @li max value = 50
22873 * @li step value = 20
22874 * @li displayed value = 20
22876 * When the user decrement value (using left or bottom arrow), it will
22877 * displays @c 40, because max - (min - (displayed - step)) is
22878 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22880 * @see elm_spinner_wrap_get().
22884 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22887 * Get whether the spinner should wrap when it reaches its
22888 * minimum or maximum value.
22890 * @param obj The spinner object
22891 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22892 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22894 * @see elm_spinner_wrap_set() for details.
22898 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22901 * Set whether the spinner can be directly edited by the user or not.
22903 * @param obj The spinner object.
22904 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
22905 * don't allow users to edit it directly.
22907 * Spinner objects can have edition @b disabled, in which state they will
22908 * be changed only by arrows.
22909 * Useful for contexts
22910 * where you don't want your users to interact with it writting the value.
22912 * when using special values, the user can see real value instead
22913 * of special label on edition.
22915 * It's enabled by default.
22917 * @see elm_spinner_editable_get()
22921 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22924 * Get whether the spinner can be directly edited by the user or not.
22926 * @param obj The spinner object.
22927 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22928 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22930 * @see elm_spinner_editable_set() for details.
22934 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22937 * Set a special string to display in the place of the numerical value.
22939 * @param obj The spinner object.
22940 * @param value The value to be replaced.
22941 * @param label The label to be used.
22943 * It's useful for cases when a user should select an item that is
22944 * better indicated by a label than a value. For example, weekdays or months.
22948 * sp = elm_spinner_add(win);
22949 * elm_spinner_min_max_set(sp, 1, 3);
22950 * elm_spinner_special_value_add(sp, 1, "January");
22951 * elm_spinner_special_value_add(sp, 2, "February");
22952 * elm_spinner_special_value_add(sp, 3, "March");
22953 * evas_object_show(sp);
22958 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22961 * Set the interval on time updates for an user mouse button hold
22962 * on spinner widgets' arrows.
22964 * @param obj The spinner object.
22965 * @param interval The (first) interval value in seconds.
22967 * This interval value is @b decreased while the user holds the
22968 * mouse pointer either incrementing or decrementing spinner's value.
22970 * This helps the user to get to a given value distant from the
22971 * current one easier/faster, as it will start to change quicker and
22972 * quicker on mouse button holds.
22974 * The calculation for the next change interval value, starting from
22975 * the one set with this call, is the previous interval divided by
22976 * @c 1.05, so it decreases a little bit.
22978 * The default starting interval value for automatic changes is
22981 * @see elm_spinner_interval_get()
22985 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22988 * Get the interval on time updates for an user mouse button hold
22989 * on spinner widgets' arrows.
22991 * @param obj The spinner object.
22992 * @return The (first) interval value, in seconds, set on it.
22994 * @see elm_spinner_interval_set() for more details.
22998 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23005 * @defgroup Index Index
23007 * @image html img/widget/index/preview-00.png
23008 * @image latex img/widget/index/preview-00.eps
23010 * An index widget gives you an index for fast access to whichever
23011 * group of other UI items one might have. It's a list of text
23012 * items (usually letters, for alphabetically ordered access).
23014 * Index widgets are by default hidden and just appear when the
23015 * user clicks over it's reserved area in the canvas. In its
23016 * default theme, it's an area one @ref Fingers "finger" wide on
23017 * the right side of the index widget's container.
23019 * When items on the index are selected, smart callbacks get
23020 * called, so that its user can make other container objects to
23021 * show a given area or child object depending on the index item
23022 * selected. You'd probably be using an index together with @ref
23023 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
23026 * Smart events one can add callbacks for are:
23027 * - @c "changed" - When the selected index item changes. @c
23028 * event_info is the selected item's data pointer.
23029 * - @c "delay,changed" - When the selected index item changes, but
23030 * after a small idling period. @c event_info is the selected
23031 * item's data pointer.
23032 * - @c "selected" - When the user releases a mouse button and
23033 * selects an item. @c event_info is the selected item's data
23035 * - @c "level,up" - when the user moves a finger from the first
23036 * level to the second level
23037 * - @c "level,down" - when the user moves a finger from the second
23038 * level to the first level
23040 * The @c "delay,changed" event is so that it'll wait a small time
23041 * before actually reporting those events and, moreover, just the
23042 * last event happening on those time frames will actually be
23045 * Here are some examples on its usage:
23046 * @li @ref index_example_01
23047 * @li @ref index_example_02
23051 * @addtogroup Index
23055 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
23058 * Add a new index widget to the given parent Elementary
23059 * (container) object
23061 * @param parent The parent object
23062 * @return a new index widget handle or @c NULL, on errors
23064 * This function inserts a new index widget on the canvas.
23068 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23071 * Set whether a given index widget is or not visible,
23074 * @param obj The index object
23075 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
23077 * Not to be confused with visible as in @c evas_object_show() --
23078 * visible with regard to the widget's auto hiding feature.
23080 * @see elm_index_active_get()
23084 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
23087 * Get whether a given index widget is currently visible or not.
23089 * @param obj The index object
23090 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
23092 * @see elm_index_active_set() for more details
23096 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23099 * Set the items level for a given index widget.
23101 * @param obj The index object.
23102 * @param level @c 0 or @c 1, the currently implemented levels.
23104 * @see elm_index_item_level_get()
23108 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23111 * Get the items level set for a given index widget.
23113 * @param obj The index object.
23114 * @return @c 0 or @c 1, which are the levels @p obj might be at.
23116 * @see elm_index_item_level_set() for more information
23120 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23123 * Returns the last selected item, for a given index widget.
23125 * @param obj The index object.
23126 * @return The last item @b selected on @p obj (or @c NULL, on errors).
23130 EAPI Elm_Index_Item *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23133 * Append a new item on a given index widget.
23135 * @param obj The index object.
23136 * @param letter Letter under which the item should be indexed
23137 * @param item The item data to set for the index's item
23139 * Despite the most common usage of the @p letter argument is for
23140 * single char strings, one could use arbitrary strings as index
23143 * @c item will be the pointer returned back on @c "changed", @c
23144 * "delay,changed" and @c "selected" smart events.
23148 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23151 * Prepend a new item on a given index widget.
23153 * @param obj The index object.
23154 * @param letter Letter under which the item should be indexed
23155 * @param item The item data to set for the index's item
23157 * Despite the most common usage of the @p letter argument is for
23158 * single char strings, one could use arbitrary strings as index
23161 * @c item will be the pointer returned back on @c "changed", @c
23162 * "delay,changed" and @c "selected" smart events.
23166 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23169 * Append a new item, on a given index widget, <b>after the item
23170 * having @p relative as data</b>.
23172 * @param obj The index object.
23173 * @param letter Letter under which the item should be indexed
23174 * @param item The item data to set for the index's item
23175 * @param relative The index item to be the predecessor of this new one
23177 * Despite the most common usage of the @p letter argument is for
23178 * single char strings, one could use arbitrary strings as index
23181 * @c item will be the pointer returned back on @c "changed", @c
23182 * "delay,changed" and @c "selected" smart events.
23184 * @note If @p relative is @c NULL this function will behave as
23185 * elm_index_item_append().
23189 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23192 * Prepend a new item, on a given index widget, <b>after the item
23193 * having @p relative as data</b>.
23195 * @param obj The index object.
23196 * @param letter Letter under which the item should be indexed
23197 * @param item The item data to set for the index's item
23198 * @param relative The index item to be the successor of this new one
23200 * Despite the most common usage of the @p letter argument is for
23201 * single char strings, one could use arbitrary strings as index
23204 * @c item will be the pointer returned back on @c "changed", @c
23205 * "delay,changed" and @c "selected" smart events.
23207 * @note If @p relative is @c NULL this function will behave as
23208 * elm_index_item_prepend().
23212 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23215 * Insert a new item into the given index widget, using @p cmp_func
23216 * function to sort items (by item handles).
23218 * @param obj The index object.
23219 * @param letter Letter under which the item should be indexed
23220 * @param item The item data to set for the index's item
23221 * @param cmp_func The comparing function to be used to sort index
23222 * items <b>by #Elm_Index_Item item handles</b>
23223 * @param cmp_data_func A @b fallback function to be called for the
23224 * sorting of index items <b>by item data</b>). It will be used
23225 * when @p cmp_func returns @c 0 (equality), which means an index
23226 * item with provided item data already exists. To decide which
23227 * data item should be pointed to by the index item in question, @p
23228 * cmp_data_func will be used. If @p cmp_data_func returns a
23229 * non-negative value, the previous index item data will be
23230 * replaced by the given @p item pointer. If the previous data need
23231 * to be freed, it should be done by the @p cmp_data_func function,
23232 * because all references to it will be lost. If this function is
23233 * not provided (@c NULL is given), index items will be @b
23234 * duplicated, if @p cmp_func returns @c 0.
23236 * Despite the most common usage of the @p letter argument is for
23237 * single char strings, one could use arbitrary strings as index
23240 * @c item will be the pointer returned back on @c "changed", @c
23241 * "delay,changed" and @c "selected" smart events.
23245 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);
23248 * Remove an item from a given index widget, <b>to be referenced by
23249 * it's data value</b>.
23251 * @param obj The index object
23252 * @param item The item to be removed from @p obj
23254 * If a deletion callback is set, via elm_index_item_del_cb_set(),
23255 * that callback function will be called by this one.
23259 EAPI void elm_index_item_del(Evas_Object *obj, Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23262 * Find a given index widget's item, <b>using item data</b>.
23264 * @param obj The index object
23265 * @param item The item data pointed to by the desired index item
23266 * @return The index item handle, if found, or @c NULL otherwise
23270 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
23273 * Removes @b all items from a given index widget.
23275 * @param obj The index object.
23277 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
23278 * that callback function will be called for each item in @p obj.
23282 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23285 * Go to a given items level on a index widget
23287 * @param obj The index object
23288 * @param level The index level (one of @c 0 or @c 1)
23292 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23295 * Return the data associated with a given index widget item
23297 * @param it The index widget item handle
23298 * @return The data associated with @p it
23300 * @see elm_index_item_data_set()
23304 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23307 * Set the data associated with a given index widget item
23309 * @param it The index widget item handle
23310 * @param data The new data pointer to set to @p it
23312 * This sets new item data on @p it.
23314 * @warning The old data pointer won't be touched by this function, so
23315 * the user had better to free that old data himself/herself.
23319 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
23322 * Set the function to be called when a given index widget item is freed.
23324 * @param it The item to set the callback on
23325 * @param func The function to call on the item's deletion
23327 * When called, @p func will have both @c data and @c event_info
23328 * arguments with the @p it item's data value and, naturally, the
23329 * @c obj argument with a handle to the parent index widget.
23333 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23336 * Get the letter (string) set on a given index widget item.
23338 * @param it The index item handle
23339 * @return The letter string set on @p it
23343 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23350 * @defgroup Photocam Photocam
23352 * @image html img/widget/photocam/preview-00.png
23353 * @image latex img/widget/photocam/preview-00.eps
23355 * This is a widget specifically for displaying high-resolution digital
23356 * camera photos giving speedy feedback (fast load), low memory footprint
23357 * and zooming and panning as well as fitting logic. It is entirely focused
23358 * on jpeg images, and takes advantage of properties of the jpeg format (via
23359 * evas loader features in the jpeg loader).
23361 * Signals that you can add callbacks for are:
23362 * @li "clicked" - This is called when a user has clicked the photo without
23364 * @li "press" - This is called when a user has pressed down on the photo.
23365 * @li "longpressed" - This is called when a user has pressed down on the
23366 * photo for a long time without dragging around.
23367 * @li "clicked,double" - This is called when a user has double-clicked the
23369 * @li "load" - Photo load begins.
23370 * @li "loaded" - This is called when the image file load is complete for the
23371 * first view (low resolution blurry version).
23372 * @li "load,detail" - Photo detailed data load begins.
23373 * @li "loaded,detail" - This is called when the image file load is complete
23374 * for the detailed image data (full resolution needed).
23375 * @li "zoom,start" - Zoom animation started.
23376 * @li "zoom,stop" - Zoom animation stopped.
23377 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
23378 * @li "scroll" - the content has been scrolled (moved)
23379 * @li "scroll,anim,start" - scrolling animation has started
23380 * @li "scroll,anim,stop" - scrolling animation has stopped
23381 * @li "scroll,drag,start" - dragging the contents around has started
23382 * @li "scroll,drag,stop" - dragging the contents around has stopped
23384 * @ref tutorial_photocam shows the API in action.
23389 * @brief Types of zoom available.
23391 typedef enum _Elm_Photocam_Zoom_Mode
23393 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
23394 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
23395 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
23396 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Unzoom until photo fits in photocam */
23397 ELM_PHOTOCAM_ZOOM_MODE_LAST
23398 } Elm_Photocam_Zoom_Mode;
23401 * @brief Add a new Photocam object
23403 * @param parent The parent object
23404 * @return The new object or NULL if it cannot be created
23406 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23409 * @brief Set the photo file to be shown
23411 * @param obj The photocam object
23412 * @param file The photo file
23413 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
23415 * This sets (and shows) the specified file (with a relative or absolute
23416 * path) and will return a load error (same error that
23417 * evas_object_image_load_error_get() will return). The image will change and
23418 * adjust its size at this point and begin a background load process for this
23419 * photo that at some time in the future will be displayed at the full
23422 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
23425 * @brief Returns the path of the current image file
23427 * @param obj The photocam object
23428 * @return Returns the path
23430 * @see elm_photocam_file_set()
23432 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23435 * @brief Set the zoom level of the photo
23437 * @param obj The photocam object
23438 * @param zoom The zoom level to set
23440 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
23441 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
23442 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
23443 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
23446 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
23449 * @brief Get the zoom level of the photo
23451 * @param obj The photocam object
23452 * @return The current zoom level
23454 * This returns the current zoom level of the photocam object. Note that if
23455 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
23456 * (which is the default), the zoom level may be changed at any time by the
23457 * photocam object itself to account for photo size and photocam viewpoer
23460 * @see elm_photocam_zoom_set()
23461 * @see elm_photocam_zoom_mode_set()
23463 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23466 * @brief Set the zoom mode
23468 * @param obj The photocam object
23469 * @param mode The desired mode
23471 * This sets the zoom mode to manual or one of several automatic levels.
23472 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
23473 * elm_photocam_zoom_set() and will stay at that level until changed by code
23474 * or until zoom mode is changed. This is the default mode. The Automatic
23475 * modes will allow the photocam object to automatically adjust zoom mode
23476 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
23477 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
23478 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
23479 * pixels within the frame are left unfilled.
23481 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23484 * @brief Get the zoom mode
23486 * @param obj The photocam object
23487 * @return The current zoom mode
23489 * This gets the current zoom mode of the photocam object.
23491 * @see elm_photocam_zoom_mode_set()
23493 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23496 * @brief Get the current image pixel width and height
23498 * @param obj The photocam object
23499 * @param w A pointer to the width return
23500 * @param h A pointer to the height return
23502 * This gets the current photo pixel width and height (for the original).
23503 * The size will be returned in the integers @p w and @p h that are pointed
23506 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
23509 * @brief Get the area of the image that is currently shown
23512 * @param x A pointer to the X-coordinate of region
23513 * @param y A pointer to the Y-coordinate of region
23514 * @param w A pointer to the width
23515 * @param h A pointer to the height
23517 * @see elm_photocam_image_region_show()
23518 * @see elm_photocam_image_region_bring_in()
23520 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
23523 * @brief Set the viewed portion of the image
23525 * @param obj The photocam object
23526 * @param x X-coordinate of region in image original pixels
23527 * @param y Y-coordinate of region in image original pixels
23528 * @param w Width of region in image original pixels
23529 * @param h Height of region in image original pixels
23531 * This shows the region of the image without using animation.
23533 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23536 * @brief Bring in the viewed portion of the image
23538 * @param obj The photocam object
23539 * @param x X-coordinate of region in image original pixels
23540 * @param y Y-coordinate of region in image original pixels
23541 * @param w Width of region in image original pixels
23542 * @param h Height of region in image original pixels
23544 * This shows the region of the image using animation.
23546 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23549 * @brief Set the paused state for photocam
23551 * @param obj The photocam object
23552 * @param paused The pause state to set
23554 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
23555 * photocam. The default is off. This will stop zooming using animation on
23556 * zoom levels changes and change instantly. This will stop any existing
23557 * animations that are running.
23559 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23562 * @brief Get the paused state for photocam
23564 * @param obj The photocam object
23565 * @return The current paused state
23567 * This gets the current paused state for the photocam object.
23569 * @see elm_photocam_paused_set()
23571 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23574 * @brief Get the internal low-res image used for photocam
23576 * @param obj The photocam object
23577 * @return The internal image object handle, or NULL if none exists
23579 * This gets the internal image object inside photocam. Do not modify it. It
23580 * is for inspection only, and hooking callbacks to. Nothing else. It may be
23581 * deleted at any time as well.
23583 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23586 * @brief Set the photocam scrolling bouncing.
23588 * @param obj The photocam object
23589 * @param h_bounce bouncing for horizontal
23590 * @param v_bounce bouncing for vertical
23592 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23595 * @brief Get the photocam scrolling bouncing.
23597 * @param obj The photocam object
23598 * @param h_bounce bouncing for horizontal
23599 * @param v_bounce bouncing for vertical
23601 * @see elm_photocam_bounce_set()
23603 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23610 * @defgroup Map Map
23611 * @ingroup Elementary
23613 * @image html img/widget/map/preview-00.png
23614 * @image latex img/widget/map/preview-00.eps
23616 * This is a widget specifically for displaying a map. It uses basically
23617 * OpenStreetMap provider http://www.openstreetmap.org/,
23618 * but custom providers can be added.
23620 * It supports some basic but yet nice features:
23621 * @li zoom and scroll
23622 * @li markers with content to be displayed when user clicks over it
23623 * @li group of markers
23626 * Smart callbacks one can listen to:
23628 * - "clicked" - This is called when a user has clicked the map without
23630 * - "press" - This is called when a user has pressed down on the map.
23631 * - "longpressed" - This is called when a user has pressed down on the map
23632 * for a long time without dragging around.
23633 * - "clicked,double" - This is called when a user has double-clicked
23635 * - "load,detail" - Map detailed data load begins.
23636 * - "loaded,detail" - This is called when all currently visible parts of
23637 * the map are loaded.
23638 * - "zoom,start" - Zoom animation started.
23639 * - "zoom,stop" - Zoom animation stopped.
23640 * - "zoom,change" - Zoom changed when using an auto zoom mode.
23641 * - "scroll" - the content has been scrolled (moved).
23642 * - "scroll,anim,start" - scrolling animation has started.
23643 * - "scroll,anim,stop" - scrolling animation has stopped.
23644 * - "scroll,drag,start" - dragging the contents around has started.
23645 * - "scroll,drag,stop" - dragging the contents around has stopped.
23646 * - "downloaded" - This is called when all currently required map images
23648 * - "route,load" - This is called when route request begins.
23649 * - "route,loaded" - This is called when route request ends.
23650 * - "name,load" - This is called when name request begins.
23651 * - "name,loaded- This is called when name request ends.
23653 * Available style for map widget:
23656 * Available style for markers:
23661 * Available style for marker bubble:
23664 * List of examples:
23665 * @li @ref map_example_01
23666 * @li @ref map_example_02
23667 * @li @ref map_example_03
23676 * @enum _Elm_Map_Zoom_Mode
23677 * @typedef Elm_Map_Zoom_Mode
23679 * Set map's zoom behavior. It can be set to manual or automatic.
23681 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
23683 * Values <b> don't </b> work as bitmask, only one can be choosen.
23685 * @note Valid sizes are 2^zoom, consequently the map may be smaller
23686 * than the scroller view.
23688 * @see elm_map_zoom_mode_set()
23689 * @see elm_map_zoom_mode_get()
23693 typedef enum _Elm_Map_Zoom_Mode
23695 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
23696 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
23697 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
23698 ELM_MAP_ZOOM_MODE_LAST
23699 } Elm_Map_Zoom_Mode;
23702 * @enum _Elm_Map_Route_Sources
23703 * @typedef Elm_Map_Route_Sources
23705 * Set route service to be used. By default used source is
23706 * #ELM_MAP_ROUTE_SOURCE_YOURS.
23708 * @see elm_map_route_source_set()
23709 * @see elm_map_route_source_get()
23713 typedef enum _Elm_Map_Route_Sources
23715 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
23716 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. */
23717 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
23718 ELM_MAP_ROUTE_SOURCE_LAST
23719 } Elm_Map_Route_Sources;
23721 typedef enum _Elm_Map_Name_Sources
23723 ELM_MAP_NAME_SOURCE_NOMINATIM,
23724 ELM_MAP_NAME_SOURCE_LAST
23725 } Elm_Map_Name_Sources;
23728 * @enum _Elm_Map_Route_Type
23729 * @typedef Elm_Map_Route_Type
23731 * Set type of transport used on route.
23733 * @see elm_map_route_add()
23737 typedef enum _Elm_Map_Route_Type
23739 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
23740 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
23741 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
23742 ELM_MAP_ROUTE_TYPE_LAST
23743 } Elm_Map_Route_Type;
23746 * @enum _Elm_Map_Route_Method
23747 * @typedef Elm_Map_Route_Method
23749 * Set the routing method, what should be priorized, time or distance.
23751 * @see elm_map_route_add()
23755 typedef enum _Elm_Map_Route_Method
23757 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23758 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23759 ELM_MAP_ROUTE_METHOD_LAST
23760 } Elm_Map_Route_Method;
23762 typedef enum _Elm_Map_Name_Method
23764 ELM_MAP_NAME_METHOD_SEARCH,
23765 ELM_MAP_NAME_METHOD_REVERSE,
23766 ELM_MAP_NAME_METHOD_LAST
23767 } Elm_Map_Name_Method;
23769 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(). */
23770 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(). */
23771 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(). */
23772 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(). */
23773 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
23774 typedef struct _Elm_Map_Track Elm_Map_Track;
23776 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. */
23777 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23778 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23779 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23781 typedef char *(*ElmMapModuleSourceFunc) (void);
23782 typedef int (*ElmMapModuleZoomMinFunc) (void);
23783 typedef int (*ElmMapModuleZoomMaxFunc) (void);
23784 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23785 typedef int (*ElmMapModuleRouteSourceFunc) (void);
23786 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23787 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23788 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23789 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23792 * Add a new map widget to the given parent Elementary (container) object.
23794 * @param parent The parent object.
23795 * @return a new map widget handle or @c NULL, on errors.
23797 * This function inserts a new map widget on the canvas.
23801 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23804 * Set the zoom level of the map.
23806 * @param obj The map object.
23807 * @param zoom The zoom level to set.
23809 * This sets the zoom level.
23811 * It will respect limits defined by elm_map_source_zoom_min_set() and
23812 * elm_map_source_zoom_max_set().
23814 * By default these values are 0 (world map) and 18 (maximum zoom).
23816 * This function should be used when zoom mode is set to
23817 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23818 * with elm_map_zoom_mode_set().
23820 * @see elm_map_zoom_mode_set().
23821 * @see elm_map_zoom_get().
23825 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23828 * Get the zoom level of the map.
23830 * @param obj The map object.
23831 * @return The current zoom level.
23833 * This returns the current zoom level of the map object.
23835 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23836 * (which is the default), the zoom level may be changed at any time by the
23837 * map object itself to account for map size and map viewport size.
23839 * @see elm_map_zoom_set() for details.
23843 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23846 * Set the zoom mode used by the map object.
23848 * @param obj The map object.
23849 * @param mode The zoom mode of the map, being it one of
23850 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23851 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23853 * This sets the zoom mode to manual or one of the automatic levels.
23854 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23855 * elm_map_zoom_set() and will stay at that level until changed by code
23856 * or until zoom mode is changed. This is the default mode.
23858 * The Automatic modes will allow the map object to automatically
23859 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23860 * adjust zoom so the map fits inside the scroll frame with no pixels
23861 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23862 * ensure no pixels within the frame are left unfilled. Do not forget that
23863 * the valid sizes are 2^zoom, consequently the map may be smaller than
23864 * the scroller view.
23866 * @see elm_map_zoom_set()
23870 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23873 * Get the zoom mode used by the map object.
23875 * @param obj The map object.
23876 * @return The zoom mode of the map, being it one of
23877 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23878 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23880 * This function returns the current zoom mode used by the map object.
23882 * @see elm_map_zoom_mode_set() for more details.
23886 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23889 * Get the current coordinates of the map.
23891 * @param obj The map object.
23892 * @param lon Pointer where to store longitude.
23893 * @param lat Pointer where to store latitude.
23895 * This gets the current center coordinates of the map object. It can be
23896 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23898 * @see elm_map_geo_region_bring_in()
23899 * @see elm_map_geo_region_show()
23903 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23906 * Animatedly bring in given coordinates to the center of the map.
23908 * @param obj The map object.
23909 * @param lon Longitude to center at.
23910 * @param lat Latitude to center at.
23912 * This causes map to jump to the given @p lat and @p lon coordinates
23913 * and show it (by scrolling) in the center of the viewport, if it is not
23914 * already centered. This will use animation to do so and take a period
23915 * of time to complete.
23917 * @see elm_map_geo_region_show() for a function to avoid animation.
23918 * @see elm_map_geo_region_get()
23922 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23925 * Show the given coordinates at the center of the map, @b immediately.
23927 * @param obj The map object.
23928 * @param lon Longitude to center at.
23929 * @param lat Latitude to center at.
23931 * This causes map to @b redraw its viewport's contents to the
23932 * region contining the given @p lat and @p lon, that will be moved to the
23933 * center of the map.
23935 * @see elm_map_geo_region_bring_in() for a function to move with animation.
23936 * @see elm_map_geo_region_get()
23940 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23943 * Pause or unpause the map.
23945 * @param obj The map object.
23946 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23949 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23952 * The default is off.
23954 * This will stop zooming using animation, changing zoom levels will
23955 * change instantly. This will stop any existing animations that are running.
23957 * @see elm_map_paused_get()
23961 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23964 * Get a value whether map is paused or not.
23966 * @param obj The map object.
23967 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23968 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23970 * This gets the current paused state for the map object.
23972 * @see elm_map_paused_set() for details.
23976 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23979 * Set to show markers during zoom level changes or not.
23981 * @param obj The map object.
23982 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23985 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23988 * The default is off.
23990 * This will stop zooming using animation, changing zoom levels will
23991 * change instantly. This will stop any existing animations that are running.
23993 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23996 * The default is off.
23998 * Enabling it will force the map to stop displaying the markers during
23999 * zoom level changes. Set to on if you have a large number of markers.
24001 * @see elm_map_paused_markers_get()
24005 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24008 * Get a value whether markers will be displayed on zoom level changes or not
24010 * @param obj The map object.
24011 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
24012 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
24014 * This gets the current markers paused state for the map object.
24016 * @see elm_map_paused_markers_set() for details.
24020 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24023 * Get the information of downloading status.
24025 * @param obj The map object.
24026 * @param try_num Pointer where to store number of tiles being downloaded.
24027 * @param finish_num Pointer where to store number of tiles successfully
24030 * This gets the current downloading status for the map object, the number
24031 * of tiles being downloaded and the number of tiles already downloaded.
24035 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
24038 * Convert a pixel coordinate (x,y) into a geographic coordinate
24039 * (longitude, latitude).
24041 * @param obj The map object.
24042 * @param x the coordinate.
24043 * @param y the coordinate.
24044 * @param size the size in pixels of the map.
24045 * The map is a square and generally his size is : pow(2.0, zoom)*256.
24046 * @param lon Pointer where to store the longitude that correspond to x.
24047 * @param lat Pointer where to store the latitude that correspond to y.
24049 * @note Origin pixel point is the top left corner of the viewport.
24050 * Map zoom and size are taken on account.
24052 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
24056 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);
24059 * Convert a geographic coordinate (longitude, latitude) into a pixel
24060 * coordinate (x, y).
24062 * @param obj The map object.
24063 * @param lon the longitude.
24064 * @param lat the latitude.
24065 * @param size the size in pixels of the map. The map is a square
24066 * and generally his size is : pow(2.0, zoom)*256.
24067 * @param x Pointer where to store the horizontal pixel coordinate that
24068 * correspond to the longitude.
24069 * @param y Pointer where to store the vertical pixel coordinate that
24070 * correspond to the latitude.
24072 * @note Origin pixel point is the top left corner of the viewport.
24073 * Map zoom and size are taken on account.
24075 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
24079 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);
24082 * Convert a geographic coordinate (longitude, latitude) into a name
24085 * @param obj The map object.
24086 * @param lon the longitude.
24087 * @param lat the latitude.
24088 * @return name A #Elm_Map_Name handle for this coordinate.
24090 * To get the string for this address, elm_map_name_address_get()
24093 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
24097 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24100 * Convert a name (address) into a geographic coordinate
24101 * (longitude, latitude).
24103 * @param obj The map object.
24104 * @param name The address.
24105 * @return name A #Elm_Map_Name handle for this address.
24107 * To get the longitude and latitude, elm_map_name_region_get()
24110 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
24114 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
24117 * Convert a pixel coordinate into a rotated pixel coordinate.
24119 * @param obj The map object.
24120 * @param x horizontal coordinate of the point to rotate.
24121 * @param y vertical coordinate of the point to rotate.
24122 * @param cx rotation's center horizontal position.
24123 * @param cy rotation's center vertical position.
24124 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
24125 * @param xx Pointer where to store rotated x.
24126 * @param yy Pointer where to store rotated y.
24130 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);
24133 * Add a new marker to the map object.
24135 * @param obj The map object.
24136 * @param lon The longitude of the marker.
24137 * @param lat The latitude of the marker.
24138 * @param clas The class, to use when marker @b isn't grouped to others.
24139 * @param clas_group The class group, to use when marker is grouped to others
24140 * @param data The data passed to the callbacks.
24142 * @return The created marker or @c NULL upon failure.
24144 * A marker will be created and shown in a specific point of the map, defined
24145 * by @p lon and @p lat.
24147 * It will be displayed using style defined by @p class when this marker
24148 * is displayed alone (not grouped). A new class can be created with
24149 * elm_map_marker_class_new().
24151 * If the marker is grouped to other markers, it will be displayed with
24152 * style defined by @p class_group. Markers with the same group are grouped
24153 * if they are close. A new group class can be created with
24154 * elm_map_marker_group_class_new().
24156 * Markers created with this method can be deleted with
24157 * elm_map_marker_remove().
24159 * A marker can have associated content to be displayed by a bubble,
24160 * when a user click over it, as well as an icon. These objects will
24161 * be fetch using class' callback functions.
24163 * @see elm_map_marker_class_new()
24164 * @see elm_map_marker_group_class_new()
24165 * @see elm_map_marker_remove()
24169 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);
24172 * Set the maximum numbers of markers' content to be displayed in a group.
24174 * @param obj The map object.
24175 * @param max The maximum numbers of items displayed in a bubble.
24177 * A bubble will be displayed when the user clicks over the group,
24178 * and will place the content of markers that belong to this group
24181 * A group can have a long list of markers, consequently the creation
24182 * of the content of the bubble can be very slow.
24184 * In order to avoid this, a maximum number of items is displayed
24187 * By default this number is 30.
24189 * Marker with the same group class are grouped if they are close.
24191 * @see elm_map_marker_add()
24195 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
24198 * Remove a marker from the map.
24200 * @param marker The marker to remove.
24202 * @see elm_map_marker_add()
24206 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24209 * Get the current coordinates of the marker.
24211 * @param marker marker.
24212 * @param lat Pointer where to store the marker's latitude.
24213 * @param lon Pointer where to store the marker's longitude.
24215 * These values are set when adding markers, with function
24216 * elm_map_marker_add().
24218 * @see elm_map_marker_add()
24222 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
24225 * Animatedly bring in given marker to the center of the map.
24227 * @param marker The marker to center at.
24229 * This causes map to jump to the given @p marker's coordinates
24230 * and show it (by scrolling) in the center of the viewport, if it is not
24231 * already centered. This will use animation to do so and take a period
24232 * of time to complete.
24234 * @see elm_map_marker_show() for a function to avoid animation.
24235 * @see elm_map_marker_region_get()
24239 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24242 * Show the given marker at the center of the map, @b immediately.
24244 * @param marker The marker to center at.
24246 * This causes map to @b redraw its viewport's contents to the
24247 * region contining the given @p marker's coordinates, that will be
24248 * moved to the center of the map.
24250 * @see elm_map_marker_bring_in() for a function to move with animation.
24251 * @see elm_map_markers_list_show() if more than one marker need to be
24253 * @see elm_map_marker_region_get()
24257 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24260 * Move and zoom the map to display a list of markers.
24262 * @param markers A list of #Elm_Map_Marker handles.
24264 * The map will be centered on the center point of the markers in the list.
24265 * Then the map will be zoomed in order to fit the markers using the maximum
24266 * zoom which allows display of all the markers.
24268 * @warning All the markers should belong to the same map object.
24270 * @see elm_map_marker_show() to show a single marker.
24271 * @see elm_map_marker_bring_in()
24275 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
24278 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
24280 * @param marker The marker wich content should be returned.
24281 * @return Return the evas object if it exists, else @c NULL.
24283 * To set callback function #ElmMapMarkerGetFunc for the marker class,
24284 * elm_map_marker_class_get_cb_set() should be used.
24286 * This content is what will be inside the bubble that will be displayed
24287 * when an user clicks over the marker.
24289 * This returns the actual Evas object used to be placed inside
24290 * the bubble. This may be @c NULL, as it may
24291 * not have been created or may have been deleted, at any time, by
24292 * the map. <b>Do not modify this object</b> (move, resize,
24293 * show, hide, etc.), as the map is controlling it. This
24294 * function is for querying, emitting custom signals or hooking
24295 * lower level callbacks for events on that object. Do not delete
24296 * this object under any circumstances.
24300 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24303 * Update the marker
24305 * @param marker The marker to be updated.
24307 * If a content is set to this marker, it will call function to delete it,
24308 * #ElmMapMarkerDelFunc, and then will fetch the content again with
24309 * #ElmMapMarkerGetFunc.
24311 * These functions are set for the marker class with
24312 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
24316 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24319 * Close all the bubbles opened by the user.
24321 * @param obj The map object.
24323 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
24324 * when the user clicks on a marker.
24326 * This functions is set for the marker class with
24327 * elm_map_marker_class_get_cb_set().
24331 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
24334 * Create a new group class.
24336 * @param obj The map object.
24337 * @return Returns the new group class.
24339 * Each marker must be associated to a group class. Markers in the same
24340 * group are grouped if they are close.
24342 * The group class defines the style of the marker when a marker is grouped
24343 * to others markers. When it is alone, another class will be used.
24345 * A group class will need to be provided when creating a marker with
24346 * elm_map_marker_add().
24348 * Some properties and functions can be set by class, as:
24349 * - style, with elm_map_group_class_style_set()
24350 * - data - to be associated to the group class. It can be set using
24351 * elm_map_group_class_data_set().
24352 * - min zoom to display markers, set with
24353 * elm_map_group_class_zoom_displayed_set().
24354 * - max zoom to group markers, set using
24355 * elm_map_group_class_zoom_grouped_set().
24356 * - visibility - set if markers will be visible or not, set with
24357 * elm_map_group_class_hide_set().
24358 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
24359 * It can be set using elm_map_group_class_icon_cb_set().
24361 * @see elm_map_marker_add()
24362 * @see elm_map_group_class_style_set()
24363 * @see elm_map_group_class_data_set()
24364 * @see elm_map_group_class_zoom_displayed_set()
24365 * @see elm_map_group_class_zoom_grouped_set()
24366 * @see elm_map_group_class_hide_set()
24367 * @see elm_map_group_class_icon_cb_set()
24371 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24374 * Set the marker's style of a group class.
24376 * @param clas The group class.
24377 * @param style The style to be used by markers.
24379 * Each marker must be associated to a group class, and will use the style
24380 * defined by such class when grouped to other markers.
24382 * The following styles are provided by default theme:
24383 * @li @c radio - blue circle
24384 * @li @c radio2 - green circle
24387 * @see elm_map_group_class_new() for more details.
24388 * @see elm_map_marker_add()
24392 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24395 * Set the icon callback function of a group class.
24397 * @param clas The group class.
24398 * @param icon_get The callback function that will return the icon.
24400 * Each marker must be associated to a group class, and it can display a
24401 * custom icon. The function @p icon_get must return this icon.
24403 * @see elm_map_group_class_new() for more details.
24404 * @see elm_map_marker_add()
24408 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24411 * Set the data associated to the group class.
24413 * @param clas The group class.
24414 * @param data The new user data.
24416 * This data will be passed for callback functions, like icon get callback,
24417 * that can be set with elm_map_group_class_icon_cb_set().
24419 * If a data was previously set, the object will lose the pointer for it,
24420 * so if needs to be freed, you must do it yourself.
24422 * @see elm_map_group_class_new() for more details.
24423 * @see elm_map_group_class_icon_cb_set()
24424 * @see elm_map_marker_add()
24428 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
24431 * Set the minimum zoom from where the markers are displayed.
24433 * @param clas The group class.
24434 * @param zoom The minimum zoom.
24436 * Markers only will be displayed when the map is displayed at @p zoom
24439 * @see elm_map_group_class_new() for more details.
24440 * @see elm_map_marker_add()
24444 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24447 * Set the zoom from where the markers are no more grouped.
24449 * @param clas The group class.
24450 * @param zoom The maximum zoom.
24452 * Markers only will be grouped when the map is displayed at
24453 * less than @p zoom.
24455 * @see elm_map_group_class_new() for more details.
24456 * @see elm_map_marker_add()
24460 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24463 * Set if the markers associated to the group class @clas are hidden or not.
24465 * @param clas The group class.
24466 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
24469 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
24474 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
24477 * Create a new marker class.
24479 * @param obj The map object.
24480 * @return Returns the new group class.
24482 * Each marker must be associated to a class.
24484 * The marker class defines the style of the marker when a marker is
24485 * displayed alone, i.e., not grouped to to others markers. When grouped
24486 * it will use group class style.
24488 * A marker class will need to be provided when creating a marker with
24489 * elm_map_marker_add().
24491 * Some properties and functions can be set by class, as:
24492 * - style, with elm_map_marker_class_style_set()
24493 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
24494 * It can be set using elm_map_marker_class_icon_cb_set().
24495 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
24496 * Set using elm_map_marker_class_get_cb_set().
24497 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
24498 * Set using elm_map_marker_class_del_cb_set().
24500 * @see elm_map_marker_add()
24501 * @see elm_map_marker_class_style_set()
24502 * @see elm_map_marker_class_icon_cb_set()
24503 * @see elm_map_marker_class_get_cb_set()
24504 * @see elm_map_marker_class_del_cb_set()
24508 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24511 * Set the marker's style of a marker class.
24513 * @param clas The marker class.
24514 * @param style The style to be used by markers.
24516 * Each marker must be associated to a marker class, and will use the style
24517 * defined by such class when alone, i.e., @b not grouped to other markers.
24519 * The following styles are provided by default theme:
24524 * @see elm_map_marker_class_new() for more details.
24525 * @see elm_map_marker_add()
24529 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24532 * Set the icon callback function of a marker class.
24534 * @param clas The marker class.
24535 * @param icon_get The callback function that will return the icon.
24537 * Each marker must be associated to a marker class, and it can display a
24538 * custom icon. The function @p icon_get must return this icon.
24540 * @see elm_map_marker_class_new() for more details.
24541 * @see elm_map_marker_add()
24545 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24548 * Set the bubble content callback function of a marker class.
24550 * @param clas The marker class.
24551 * @param get The callback function that will return the content.
24553 * Each marker must be associated to a marker class, and it can display a
24554 * a content on a bubble that opens when the user click over the marker.
24555 * The function @p get must return this content object.
24557 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
24560 * @see elm_map_marker_class_new() for more details.
24561 * @see elm_map_marker_class_del_cb_set()
24562 * @see elm_map_marker_add()
24566 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
24569 * Set the callback function used to delete bubble content of a marker class.
24571 * @param clas The marker class.
24572 * @param del The callback function that will delete the content.
24574 * Each marker must be associated to a marker class, and it can display a
24575 * a content on a bubble that opens when the user click over the marker.
24576 * The function to return such content can be set with
24577 * elm_map_marker_class_get_cb_set().
24579 * If this content must be freed, a callback function need to be
24580 * set for that task with this function.
24582 * If this callback is defined it will have to delete (or not) the
24583 * object inside, but if the callback is not defined the object will be
24584 * destroyed with evas_object_del().
24586 * @see elm_map_marker_class_new() for more details.
24587 * @see elm_map_marker_class_get_cb_set()
24588 * @see elm_map_marker_add()
24592 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
24595 * Get the list of available sources.
24597 * @param obj The map object.
24598 * @return The source names list.
24600 * It will provide a list with all available sources, that can be set as
24601 * current source with elm_map_source_name_set(), or get with
24602 * elm_map_source_name_get().
24604 * Available sources:
24610 * @see elm_map_source_name_set() for more details.
24611 * @see elm_map_source_name_get()
24615 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24618 * Set the source of the map.
24620 * @param obj The map object.
24621 * @param source The source to be used.
24623 * Map widget retrieves images that composes the map from a web service.
24624 * This web service can be set with this method.
24626 * A different service can return a different maps with different
24627 * information and it can use different zoom values.
24629 * The @p source_name need to match one of the names provided by
24630 * elm_map_source_names_get().
24632 * The current source can be get using elm_map_source_name_get().
24634 * @see elm_map_source_names_get()
24635 * @see elm_map_source_name_get()
24640 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
24643 * Get the name of currently used source.
24645 * @param obj The map object.
24646 * @return Returns the name of the source in use.
24648 * @see elm_map_source_name_set() for more details.
24652 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24655 * Set the source of the route service to be used by the map.
24657 * @param obj The map object.
24658 * @param source The route service to be used, being it one of
24659 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
24660 * and #ELM_MAP_ROUTE_SOURCE_ORS.
24662 * Each one has its own algorithm, so the route retrieved may
24663 * differ depending on the source route. Now, only the default is working.
24665 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
24666 * http://www.yournavigation.org/.
24668 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
24669 * assumptions. Its routing core is based on Contraction Hierarchies.
24671 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
24673 * @see elm_map_route_source_get().
24677 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
24680 * Get the current route source.
24682 * @param obj The map object.
24683 * @return The source of the route service used by the map.
24685 * @see elm_map_route_source_set() for details.
24689 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24692 * Set the minimum zoom of the source.
24694 * @param obj The map object.
24695 * @param zoom New minimum zoom value to be used.
24697 * By default, it's 0.
24701 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24704 * Get the minimum zoom of the source.
24706 * @param obj The map object.
24707 * @return Returns the minimum zoom of the source.
24709 * @see elm_map_source_zoom_min_set() for details.
24713 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24716 * Set the maximum zoom of the source.
24718 * @param obj The map object.
24719 * @param zoom New maximum zoom value to be used.
24721 * By default, it's 18.
24725 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24728 * Get the maximum zoom of the source.
24730 * @param obj The map object.
24731 * @return Returns the maximum zoom of the source.
24733 * @see elm_map_source_zoom_min_set() for details.
24737 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24740 * Set the user agent used by the map object to access routing services.
24742 * @param obj The map object.
24743 * @param user_agent The user agent to be used by the map.
24745 * User agent is a client application implementing a network protocol used
24746 * in communications within a clientāserver distributed computing system
24748 * The @p user_agent identification string will transmitted in a header
24749 * field @c User-Agent.
24751 * @see elm_map_user_agent_get()
24755 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24758 * Get the user agent used by the map object.
24760 * @param obj The map object.
24761 * @return The user agent identification string used by the map.
24763 * @see elm_map_user_agent_set() for details.
24767 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24770 * Add a new route to the map object.
24772 * @param obj The map object.
24773 * @param type The type of transport to be considered when tracing a route.
24774 * @param method The routing method, what should be priorized.
24775 * @param flon The start longitude.
24776 * @param flat The start latitude.
24777 * @param tlon The destination longitude.
24778 * @param tlat The destination latitude.
24780 * @return The created route or @c NULL upon failure.
24782 * A route will be traced by point on coordinates (@p flat, @p flon)
24783 * to point on coordinates (@p tlat, @p tlon), using the route service
24784 * set with elm_map_route_source_set().
24786 * It will take @p type on consideration to define the route,
24787 * depending if the user will be walking or driving, the route may vary.
24788 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24789 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24791 * Another parameter is what the route should priorize, the minor distance
24792 * or the less time to be spend on the route. So @p method should be one
24793 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24795 * Routes created with this method can be deleted with
24796 * elm_map_route_remove(), colored with elm_map_route_color_set(),
24797 * and distance can be get with elm_map_route_distance_get().
24799 * @see elm_map_route_remove()
24800 * @see elm_map_route_color_set()
24801 * @see elm_map_route_distance_get()
24802 * @see elm_map_route_source_set()
24806 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);
24809 * Remove a route from the map.
24811 * @param route The route to remove.
24813 * @see elm_map_route_add()
24817 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24820 * Set the route color.
24822 * @param route The route object.
24823 * @param r Red channel value, from 0 to 255.
24824 * @param g Green channel value, from 0 to 255.
24825 * @param b Blue channel value, from 0 to 255.
24826 * @param a Alpha channel value, from 0 to 255.
24828 * It uses an additive color model, so each color channel represents
24829 * how much of each primary colors must to be used. 0 represents
24830 * ausence of this color, so if all of the three are set to 0,
24831 * the color will be black.
24833 * These component values should be integers in the range 0 to 255,
24834 * (single 8-bit byte).
24836 * This sets the color used for the route. By default, it is set to
24837 * solid red (r = 255, g = 0, b = 0, a = 255).
24839 * For alpha channel, 0 represents completely transparent, and 255, opaque.
24841 * @see elm_map_route_color_get()
24845 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24848 * Get the route color.
24850 * @param route The route object.
24851 * @param r Pointer where to store the red channel value.
24852 * @param g Pointer where to store the green channel value.
24853 * @param b Pointer where to store the blue channel value.
24854 * @param a Pointer where to store the alpha channel value.
24856 * @see elm_map_route_color_set() for details.
24860 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24863 * Get the route distance in kilometers.
24865 * @param route The route object.
24866 * @return The distance of route (unit : km).
24870 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24873 * Get the information of route nodes.
24875 * @param route The route object.
24876 * @return Returns a string with the nodes of route.
24880 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24883 * Get the information of route waypoint.
24885 * @param route the route object.
24886 * @return Returns a string with information about waypoint of route.
24890 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24893 * Get the address of the name.
24895 * @param name The name handle.
24896 * @return Returns the address string of @p name.
24898 * This gets the coordinates of the @p name, created with one of the
24899 * conversion functions.
24901 * @see elm_map_utils_convert_name_into_coord()
24902 * @see elm_map_utils_convert_coord_into_name()
24906 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24909 * Get the current coordinates of the name.
24911 * @param name The name handle.
24912 * @param lat Pointer where to store the latitude.
24913 * @param lon Pointer where to store The longitude.
24915 * This gets the coordinates of the @p name, created with one of the
24916 * conversion functions.
24918 * @see elm_map_utils_convert_name_into_coord()
24919 * @see elm_map_utils_convert_coord_into_name()
24923 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24926 * Remove a name from the map.
24928 * @param name The name to remove.
24930 * Basically the struct handled by @p name will be freed, so convertions
24931 * between address and coordinates will be lost.
24933 * @see elm_map_utils_convert_name_into_coord()
24934 * @see elm_map_utils_convert_coord_into_name()
24938 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24943 * @param obj The map object.
24944 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
24945 * @param cx Rotation's center horizontal position.
24946 * @param cy Rotation's center vertical position.
24948 * @see elm_map_rotate_get()
24952 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24955 * Get the rotate degree of the map
24957 * @param obj The map object
24958 * @param degree Pointer where to store degrees from 0.0 to 360.0
24959 * to rotate arount Z axis.
24960 * @param cx Pointer where to store rotation's center horizontal position.
24961 * @param cy Pointer where to store rotation's center vertical position.
24963 * @see elm_map_rotate_set() to set map rotation.
24967 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);
24970 * Enable or disable mouse wheel to be used to zoom in / out the map.
24972 * @param obj The map object.
24973 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24976 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24978 * It's disabled by default.
24980 * @see elm_map_wheel_disabled_get()
24984 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24987 * Get a value whether mouse wheel is enabled or not.
24989 * @param obj The map object.
24990 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24991 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24993 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24995 * @see elm_map_wheel_disabled_set() for details.
24999 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25003 * Add a track on the map
25005 * @param obj The map object.
25006 * @param emap The emap route object.
25007 * @return The route object. This is an elm object of type Route.
25009 * @see elm_route_add() for details.
25013 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
25017 * Remove a track from the map
25019 * @param obj The map object.
25020 * @param route The track to remove.
25024 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
25031 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
25033 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
25035 EAPI double elm_route_lon_min_get(Evas_Object *obj);
25036 EAPI double elm_route_lat_min_get(Evas_Object *obj);
25037 EAPI double elm_route_lon_max_get(Evas_Object *obj);
25038 EAPI double elm_route_lat_max_get(Evas_Object *obj);
25042 * @defgroup Panel Panel
25044 * @image html img/widget/panel/preview-00.png
25045 * @image latex img/widget/panel/preview-00.eps
25047 * @brief A panel is a type of animated container that contains subobjects.
25048 * It can be expanded or contracted by clicking the button on it's edge.
25050 * Orientations are as follows:
25051 * @li ELM_PANEL_ORIENT_TOP
25052 * @li ELM_PANEL_ORIENT_LEFT
25053 * @li ELM_PANEL_ORIENT_RIGHT
25055 * Default contents parts of the panel widget that you can use for are:
25056 * @li "default" - A content of the panel
25058 * @ref tutorial_panel shows one way to use this widget.
25061 typedef enum _Elm_Panel_Orient
25063 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
25064 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
25065 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
25066 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
25067 } Elm_Panel_Orient;
25070 * @brief Adds a panel object
25072 * @param parent The parent object
25074 * @return The panel object, or NULL on failure
25076 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25079 * @brief Sets the orientation of the panel
25081 * @param parent The parent object
25082 * @param orient The panel orientation. Can be one of the following:
25083 * @li ELM_PANEL_ORIENT_TOP
25084 * @li ELM_PANEL_ORIENT_LEFT
25085 * @li ELM_PANEL_ORIENT_RIGHT
25087 * Sets from where the panel will (dis)appear.
25089 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
25092 * @brief Get the orientation of the panel.
25094 * @param obj The panel object
25095 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
25097 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25100 * @brief Set the content of the panel.
25102 * @param obj The panel object
25103 * @param content The panel content
25105 * Once the content object is set, a previously set one will be deleted.
25106 * If you want to keep that old content object, use the
25107 * elm_panel_content_unset() function.
25109 * @deprecated use elm_object_content_set() instead
25112 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25115 * @brief Get the content of the panel.
25117 * @param obj The panel object
25118 * @return The content that is being used
25120 * Return the content object which is set for this widget.
25122 * @see elm_panel_content_set()
25124 * @deprecated use elm_object_content_get() instead
25127 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25130 * @brief Unset the content of the panel.
25132 * @param obj The panel object
25133 * @return The content that was being used
25135 * Unparent and return the content object which was set for this widget.
25137 * @see elm_panel_content_set()
25139 * @deprecated use elm_object_content_unset() instead
25142 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25145 * @brief Set the state of the panel.
25147 * @param obj The panel object
25148 * @param hidden If true, the panel will run the animation to contract
25150 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
25153 * @brief Get the state of the panel.
25155 * @param obj The panel object
25156 * @param hidden If true, the panel is in the "hide" state
25158 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25161 * @brief Toggle the hidden state of the panel from code
25163 * @param obj The panel object
25165 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
25172 * @defgroup Panes Panes
25173 * @ingroup Elementary
25175 * @image html img/widget/panes/preview-00.png
25176 * @image latex img/widget/panes/preview-00.eps width=\textwidth
25178 * @image html img/panes.png
25179 * @image latex img/panes.eps width=\textwidth
25181 * The panes adds a dragable bar between two contents. When dragged
25182 * this bar will resize contents size.
25184 * Panes can be displayed vertically or horizontally, and contents
25185 * size proportion can be customized (homogeneous by default).
25187 * Smart callbacks one can listen to:
25188 * - "press" - The panes has been pressed (button wasn't released yet).
25189 * - "unpressed" - The panes was released after being pressed.
25190 * - "clicked" - The panes has been clicked>
25191 * - "clicked,double" - The panes has been double clicked
25193 * Available styles for it:
25196 * Default contents parts of the panes widget that you can use for are:
25197 * @li "left" - A leftside content of the panes
25198 * @li "right" - A rightside content of the panes
25200 * If panes is displayed vertically, left content will be displayed at
25203 * Here is an example on its usage:
25204 * @li @ref panes_example
25208 * @addtogroup Panes
25213 * Add a new panes widget to the given parent Elementary
25214 * (container) object.
25216 * @param parent The parent object.
25217 * @return a new panes widget handle or @c NULL, on errors.
25219 * This function inserts a new panes widget on the canvas.
25223 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25226 * Set the left content of the panes widget.
25228 * @param obj The panes object.
25229 * @param content The new left content object.
25231 * Once the content object is set, a previously set one will be deleted.
25232 * If you want to keep that old content object, use the
25233 * elm_panes_content_left_unset() function.
25235 * If panes is displayed vertically, left content will be displayed at
25238 * @see elm_panes_content_left_get()
25239 * @see elm_panes_content_right_set() to set content on the other side.
25241 * @deprecated use elm_object_part_content_set() instead
25245 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25248 * Set the right content of the panes widget.
25250 * @param obj The panes object.
25251 * @param content The new right content object.
25253 * Once the content object is set, a previously set one will be deleted.
25254 * If you want to keep that old content object, use the
25255 * elm_panes_content_right_unset() function.
25257 * If panes is displayed vertically, left content will be displayed at
25260 * @see elm_panes_content_right_get()
25261 * @see elm_panes_content_left_set() to set content on the other side.
25263 * @deprecated use elm_object_part_content_set() instead
25267 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25270 * Get the left content of the panes.
25272 * @param obj The panes object.
25273 * @return The left content object that is being used.
25275 * Return the left content object which is set for this widget.
25277 * @see elm_panes_content_left_set() for details.
25279 * @deprecated use elm_object_part_content_get() instead
25283 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25286 * Get the right content of the panes.
25288 * @param obj The panes object
25289 * @return The right content object that is being used
25291 * Return the right content object which is set for this widget.
25293 * @see elm_panes_content_right_set() for details.
25295 * @deprecated use elm_object_part_content_get() instead
25299 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25302 * Unset the left content used for the panes.
25304 * @param obj The panes object.
25305 * @return The left content object that was being used.
25307 * Unparent and return the left content object which was set for this widget.
25309 * @see elm_panes_content_left_set() for details.
25310 * @see elm_panes_content_left_get().
25312 * @deprecated use elm_object_part_content_unset() instead
25316 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25319 * Unset the right content used for the panes.
25321 * @param obj The panes object.
25322 * @return The right content object that was being used.
25324 * Unparent and return the right content object which was set for this
25327 * @see elm_panes_content_right_set() for details.
25328 * @see elm_panes_content_right_get().
25330 * @deprecated use elm_object_part_content_unset() instead
25334 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25337 * Get the size proportion of panes widget's left side.
25339 * @param obj The panes object.
25340 * @return float value between 0.0 and 1.0 representing size proportion
25343 * @see elm_panes_content_left_size_set() for more details.
25347 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25350 * Set the size proportion of panes widget's left side.
25352 * @param obj The panes object.
25353 * @param size Value between 0.0 and 1.0 representing size proportion
25356 * By default it's homogeneous, i.e., both sides have the same size.
25358 * If something different is required, it can be set with this function.
25359 * For example, if the left content should be displayed over
25360 * 75% of the panes size, @p size should be passed as @c 0.75.
25361 * This way, right content will be resized to 25% of panes size.
25363 * If displayed vertically, left content is displayed at top, and
25364 * right content at bottom.
25366 * @note This proportion will change when user drags the panes bar.
25368 * @see elm_panes_content_left_size_get()
25372 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
25375 * Set the orientation of a given panes widget.
25377 * @param obj The panes object.
25378 * @param horizontal Use @c EINA_TRUE to make @p obj to be
25379 * @b horizontal, @c EINA_FALSE to make it @b vertical.
25381 * Use this function to change how your panes is to be
25382 * disposed: vertically or horizontally.
25384 * By default it's displayed horizontally.
25386 * @see elm_panes_horizontal_get()
25390 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25393 * Retrieve the orientation of a given panes widget.
25395 * @param obj The panes object.
25396 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
25397 * @c EINA_FALSE if it's @b vertical (and on errors).
25399 * @see elm_panes_horizontal_set() for more details.
25403 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25404 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
25405 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25412 * @defgroup Flip Flip
25414 * @image html img/widget/flip/preview-00.png
25415 * @image latex img/widget/flip/preview-00.eps
25417 * This widget holds 2 content objects(Evas_Object): one on the front and one
25418 * on the back. It allows you to flip from front to back and vice-versa using
25419 * various animations.
25421 * If either the front or back contents are not set the flip will treat that
25422 * as transparent. So if you wore to set the front content but not the back,
25423 * and then call elm_flip_go() you would see whatever is below the flip.
25425 * For a list of supported animations see elm_flip_go().
25427 * Signals that you can add callbacks for are:
25428 * "animate,begin" - when a flip animation was started
25429 * "animate,done" - when a flip animation is finished
25431 * @ref tutorial_flip show how to use most of the API.
25435 typedef enum _Elm_Flip_Mode
25437 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
25438 ELM_FLIP_ROTATE_X_CENTER_AXIS,
25439 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
25440 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
25441 ELM_FLIP_CUBE_LEFT,
25442 ELM_FLIP_CUBE_RIGHT,
25444 ELM_FLIP_CUBE_DOWN,
25445 ELM_FLIP_PAGE_LEFT,
25446 ELM_FLIP_PAGE_RIGHT,
25450 typedef enum _Elm_Flip_Interaction
25452 ELM_FLIP_INTERACTION_NONE,
25453 ELM_FLIP_INTERACTION_ROTATE,
25454 ELM_FLIP_INTERACTION_CUBE,
25455 ELM_FLIP_INTERACTION_PAGE
25456 } Elm_Flip_Interaction;
25457 typedef enum _Elm_Flip_Direction
25459 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
25460 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
25461 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
25462 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
25463 } Elm_Flip_Direction;
25466 * @brief Add a new flip to the parent
25468 * @param parent The parent object
25469 * @return The new object or NULL if it cannot be created
25471 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25474 * @brief Set the front content of the flip widget.
25476 * @param obj The flip object
25477 * @param content The new front content object
25479 * Once the content object is set, a previously set one will be deleted.
25480 * If you want to keep that old content object, use the
25481 * elm_flip_content_front_unset() function.
25483 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25486 * @brief Set the back content of the flip widget.
25488 * @param obj The flip object
25489 * @param content The new back content object
25491 * Once the content object is set, a previously set one will be deleted.
25492 * If you want to keep that old content object, use the
25493 * elm_flip_content_back_unset() function.
25495 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25498 * @brief Get the front content used for the flip
25500 * @param obj The flip object
25501 * @return The front content object that is being used
25503 * Return the front content object which is set for this widget.
25505 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25508 * @brief Get the back content used for the flip
25510 * @param obj The flip object
25511 * @return The back content object that is being used
25513 * Return the back content object which is set for this widget.
25515 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25518 * @brief Unset the front content used for the flip
25520 * @param obj The flip object
25521 * @return The front content object that was being used
25523 * Unparent and return the front content object which was set for this widget.
25525 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25528 * @brief Unset the back content used for the flip
25530 * @param obj The flip object
25531 * @return The back content object that was being used
25533 * Unparent and return the back content object which was set for this widget.
25535 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25538 * @brief Get flip front visibility state
25540 * @param obj The flip objct
25541 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
25544 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25547 * @brief Set flip perspective
25549 * @param obj The flip object
25550 * @param foc The coordinate to set the focus on
25551 * @param x The X coordinate
25552 * @param y The Y coordinate
25554 * @warning This function currently does nothing.
25556 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
25559 * @brief Runs the flip animation
25561 * @param obj The flip object
25562 * @param mode The mode type
25564 * Flips the front and back contents using the @p mode animation. This
25565 * efectively hides the currently visible content and shows the hidden one.
25567 * There a number of possible animations to use for the flipping:
25568 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
25569 * around a horizontal axis in the middle of its height, the other content
25570 * is shown as the other side of the flip.
25571 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
25572 * around a vertical axis in the middle of its width, the other content is
25573 * shown as the other side of the flip.
25574 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
25575 * around a diagonal axis in the middle of its width, the other content is
25576 * shown as the other side of the flip.
25577 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
25578 * around a diagonal axis in the middle of its height, the other content is
25579 * shown as the other side of the flip.
25580 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
25581 * as if the flip was a cube, the other content is show as the right face of
25583 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
25584 * right as if the flip was a cube, the other content is show as the left
25585 * face of the cube.
25586 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
25587 * flip was a cube, the other content is show as the bottom face of the cube.
25588 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
25589 * the flip was a cube, the other content is show as the upper face of the
25591 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
25592 * if the flip was a book, the other content is shown as the page below that.
25593 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
25594 * as if the flip was a book, the other content is shown as the page below
25596 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
25597 * flip was a book, the other content is shown as the page below that.
25598 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
25599 * flip was a book, the other content is shown as the page below that.
25601 * @image html elm_flip.png
25602 * @image latex elm_flip.eps width=\textwidth
25604 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
25607 * @brief Set the interactive flip mode
25609 * @param obj The flip object
25610 * @param mode The interactive flip mode to use
25612 * This sets if the flip should be interactive (allow user to click and
25613 * drag a side of the flip to reveal the back page and cause it to flip).
25614 * By default a flip is not interactive. You may also need to set which
25615 * sides of the flip are "active" for flipping and how much space they use
25616 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
25617 * and elm_flip_interacton_direction_hitsize_set()
25619 * The four avilable mode of interaction are:
25620 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
25621 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
25622 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
25623 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
25625 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
25626 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
25627 * happen, those can only be acheived with elm_flip_go();
25629 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
25632 * @brief Get the interactive flip mode
25634 * @param obj The flip object
25635 * @return The interactive flip mode
25637 * Returns the interactive flip mode set by elm_flip_interaction_set()
25639 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
25642 * @brief Set which directions of the flip respond to interactive flip
25644 * @param obj The flip object
25645 * @param dir The direction to change
25646 * @param enabled If that direction is enabled or not
25648 * By default all directions are disabled, so you may want to enable the
25649 * desired directions for flipping if you need interactive flipping. You must
25650 * call this function once for each direction that should be enabled.
25652 * @see elm_flip_interaction_set()
25654 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
25657 * @brief Get the enabled state of that flip direction
25659 * @param obj The flip object
25660 * @param dir The direction to check
25661 * @return If that direction is enabled or not
25663 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
25665 * @see elm_flip_interaction_set()
25667 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
25670 * @brief Set the amount of the flip that is sensitive to interactive flip
25672 * @param obj The flip object
25673 * @param dir The direction to modify
25674 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
25676 * Set the amount of the flip that is sensitive to interactive flip, with 0
25677 * representing no area in the flip and 1 representing the entire flip. There
25678 * is however a consideration to be made in that the area will never be
25679 * smaller than the finger size set(as set in your Elementary configuration).
25681 * @see elm_flip_interaction_set()
25683 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
25686 * @brief Get the amount of the flip that is sensitive to interactive flip
25688 * @param obj The flip object
25689 * @param dir The direction to check
25690 * @return The size set for that direction
25692 * Returns the amount os sensitive area set by
25693 * elm_flip_interacton_direction_hitsize_set().
25695 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
25701 /* scrolledentry */
25702 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25703 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
25704 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25705 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
25706 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25707 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25708 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25709 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25710 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25711 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25712 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25713 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
25714 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
25715 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25716 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
25717 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
25718 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25719 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25720 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
25721 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
25722 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25723 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25724 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25725 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25726 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
25727 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
25728 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25729 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25730 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25731 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25732 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25733 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
25734 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
25735 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
25736 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25737 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);
25738 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25739 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25740 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);
25741 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25742 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);
25743 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
25744 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25745 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25746 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25747 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
25748 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25749 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25750 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25751 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);
25752 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);
25753 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);
25754 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);
25755 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);
25756 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);
25757 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
25758 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
25759 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
25760 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
25761 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25762 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
25763 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
25766 * @defgroup Conformant Conformant
25767 * @ingroup Elementary
25769 * @image html img/widget/conformant/preview-00.png
25770 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
25772 * @image html img/conformant.png
25773 * @image latex img/conformant.eps width=\textwidth
25775 * The aim is to provide a widget that can be used in elementary apps to
25776 * account for space taken up by the indicator, virtual keypad & softkey
25777 * windows when running the illume2 module of E17.
25779 * So conformant content will be sized and positioned considering the
25780 * space required for such stuff, and when they popup, as a keyboard
25781 * shows when an entry is selected, conformant content won't change.
25783 * Available styles for it:
25786 * Default contents parts of the conformant widget that you can use for are:
25787 * @li "default" - A content of the conformant
25789 * See how to use this widget in this example:
25790 * @ref conformant_example
25794 * @addtogroup Conformant
25799 * Add a new conformant widget to the given parent Elementary
25800 * (container) object.
25802 * @param parent The parent object.
25803 * @return A new conformant widget handle or @c NULL, on errors.
25805 * This function inserts a new conformant widget on the canvas.
25807 * @ingroup Conformant
25809 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25812 * Set the content of the conformant widget.
25814 * @param obj The conformant object.
25815 * @param content The content to be displayed by the conformant.
25817 * Content will be sized and positioned considering the space required
25818 * to display a virtual keyboard. So it won't fill all the conformant
25819 * size. This way is possible to be sure that content won't resize
25820 * or be re-positioned after the keyboard is displayed.
25822 * Once the content object is set, a previously set one will be deleted.
25823 * If you want to keep that old content object, use the
25824 * elm_object_content_unset() function.
25826 * @see elm_object_content_unset()
25827 * @see elm_object_content_get()
25829 * @deprecated use elm_object_content_set() instead
25831 * @ingroup Conformant
25833 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25836 * Get the content of the conformant widget.
25838 * @param obj The conformant object.
25839 * @return The content that is being used.
25841 * Return the content object which is set for this widget.
25842 * It won't be unparent from conformant. For that, use
25843 * elm_object_content_unset().
25845 * @see elm_object_content_set().
25846 * @see elm_object_content_unset()
25848 * @deprecated use elm_object_content_get() instead
25850 * @ingroup Conformant
25852 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25855 * Unset the content of the conformant widget.
25857 * @param obj The conformant object.
25858 * @return The content that was being used.
25860 * Unparent and return the content object which was set for this widget.
25862 * @see elm_object_content_set().
25864 * @deprecated use elm_object_content_unset() instead
25866 * @ingroup Conformant
25868 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25871 * Returns the Evas_Object that represents the content area.
25873 * @param obj The conformant object.
25874 * @return The content area of the widget.
25876 * @ingroup Conformant
25878 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25885 * @defgroup Mapbuf Mapbuf
25886 * @ingroup Elementary
25888 * @image html img/widget/mapbuf/preview-00.png
25889 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25891 * This holds one content object and uses an Evas Map of transformation
25892 * points to be later used with this content. So the content will be
25893 * moved, resized, etc as a single image. So it will improve performance
25894 * when you have a complex interafce, with a lot of elements, and will
25895 * need to resize or move it frequently (the content object and its
25898 * Default contents parts of the mapbuf widget that you can use for are:
25899 * @li "default" - A content of the mapbuf
25901 * To enable map, elm_mapbuf_enabled_set() should be used.
25903 * See how to use this widget in this example:
25904 * @ref mapbuf_example
25908 * @addtogroup Mapbuf
25913 * Add a new mapbuf widget to the given parent Elementary
25914 * (container) object.
25916 * @param parent The parent object.
25917 * @return A new mapbuf widget handle or @c NULL, on errors.
25919 * This function inserts a new mapbuf widget on the canvas.
25923 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25926 * Set the content of the mapbuf.
25928 * @param obj The mapbuf object.
25929 * @param content The content that will be filled in this mapbuf object.
25931 * Once the content object is set, a previously set one will be deleted.
25932 * If you want to keep that old content object, use the
25933 * elm_mapbuf_content_unset() function.
25935 * To enable map, elm_mapbuf_enabled_set() should be used.
25937 * @deprecated use elm_object_content_set() instead
25941 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25944 * Get the content of the mapbuf.
25946 * @param obj The mapbuf object.
25947 * @return The content that is being used.
25949 * Return the content object which is set for this widget.
25951 * @see elm_mapbuf_content_set() for details.
25953 * @deprecated use elm_object_content_get() instead
25957 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25960 * Unset the content of the mapbuf.
25962 * @param obj The mapbuf object.
25963 * @return The content that was being used.
25965 * Unparent and return the content object which was set for this widget.
25967 * @see elm_mapbuf_content_set() for details.
25969 * @deprecated use elm_object_content_unset() instead
25973 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25976 * Enable or disable the map.
25978 * @param obj The mapbuf object.
25979 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25981 * This enables the map that is set or disables it. On enable, the object
25982 * geometry will be saved, and the new geometry will change (position and
25983 * size) to reflect the map geometry set.
25985 * Also, when enabled, alpha and smooth states will be used, so if the
25986 * content isn't solid, alpha should be enabled, for example, otherwise
25987 * a black retangle will fill the content.
25989 * When disabled, the stored map will be freed and geometry prior to
25990 * enabling the map will be restored.
25992 * It's disabled by default.
25994 * @see elm_mapbuf_alpha_set()
25995 * @see elm_mapbuf_smooth_set()
25999 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26002 * Get a value whether map is enabled or not.
26004 * @param obj The mapbuf object.
26005 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
26006 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26008 * @see elm_mapbuf_enabled_set() for details.
26012 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26015 * Enable or disable smooth map rendering.
26017 * @param obj The mapbuf object.
26018 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
26021 * This sets smoothing for map rendering. If the object is a type that has
26022 * its own smoothing settings, then both the smooth settings for this object
26023 * and the map must be turned off.
26025 * By default smooth maps are enabled.
26029 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
26032 * Get a value whether smooth map rendering is enabled or not.
26034 * @param obj The mapbuf object.
26035 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
26036 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26038 * @see elm_mapbuf_smooth_set() for details.
26042 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26045 * Set or unset alpha flag for map rendering.
26047 * @param obj The mapbuf object.
26048 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
26051 * This sets alpha flag for map rendering. If the object is a type that has
26052 * its own alpha settings, then this will take precedence. Only image objects
26053 * have this currently. It stops alpha blending of the map area, and is
26054 * useful if you know the object and/or all sub-objects is 100% solid.
26056 * Alpha is enabled by default.
26060 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
26063 * Get a value whether alpha blending is enabled or not.
26065 * @param obj The mapbuf object.
26066 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
26067 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26069 * @see elm_mapbuf_alpha_set() for details.
26073 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26080 * @defgroup Flipselector Flip Selector
26082 * @image html img/widget/flipselector/preview-00.png
26083 * @image latex img/widget/flipselector/preview-00.eps
26085 * A flip selector is a widget to show a set of @b text items, one
26086 * at a time, with the same sheet switching style as the @ref Clock
26087 * "clock" widget, when one changes the current displaying sheet
26088 * (thus, the "flip" in the name).
26090 * User clicks to flip sheets which are @b held for some time will
26091 * make the flip selector to flip continuosly and automatically for
26092 * the user. The interval between flips will keep growing in time,
26093 * so that it helps the user to reach an item which is distant from
26094 * the current selection.
26096 * Smart callbacks one can register to:
26097 * - @c "selected" - when the widget's selected text item is changed
26098 * - @c "overflowed" - when the widget's current selection is changed
26099 * from the first item in its list to the last
26100 * - @c "underflowed" - when the widget's current selection is changed
26101 * from the last item in its list to the first
26103 * Available styles for it:
26106 * To set/get the label of the flipselector item, you can use
26107 * elm_object_item_text_set/get APIs.
26108 * Once the text is set, a previously set one will be deleted.
26110 * Here is an example on its usage:
26111 * @li @ref flipselector_example
26115 * @addtogroup Flipselector
26120 * Add a new flip selector widget to the given parent Elementary
26121 * (container) widget
26123 * @param parent The parent object
26124 * @return a new flip selector widget handle or @c NULL, on errors
26126 * This function inserts a new flip selector widget on the canvas.
26128 * @ingroup Flipselector
26130 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26133 * Programmatically select the next item of a flip selector widget
26135 * @param obj The flipselector object
26137 * @note The selection will be animated. Also, if it reaches the
26138 * end of its list of member items, it will continue with the first
26141 * @ingroup Flipselector
26143 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
26146 * Programmatically select the previous item of a flip selector
26149 * @param obj The flipselector object
26151 * @note The selection will be animated. Also, if it reaches the
26152 * beginning of its list of member items, it will continue with the
26153 * last one backwards.
26155 * @ingroup Flipselector
26157 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
26160 * Append a (text) item to a flip selector widget
26162 * @param obj The flipselector object
26163 * @param label The (text) label of the new item
26164 * @param func Convenience callback function to take place when
26166 * @param data Data passed to @p func, above
26167 * @return A handle to the item added or @c NULL, on errors
26169 * The widget's list of labels to show will be appended with the
26170 * given value. If the user wishes so, a callback function pointer
26171 * can be passed, which will get called when this same item is
26174 * @note The current selection @b won't be modified by appending an
26175 * element to the list.
26177 * @note The maximum length of the text label is going to be
26178 * determined <b>by the widget's theme</b>. Strings larger than
26179 * that value are going to be @b truncated.
26181 * @ingroup Flipselector
26183 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26186 * Prepend a (text) item to a flip selector widget
26188 * @param obj The flipselector object
26189 * @param label The (text) label of the new item
26190 * @param func Convenience callback function to take place when
26192 * @param data Data passed to @p func, above
26193 * @return A handle to the item added or @c NULL, on errors
26195 * The widget's list of labels to show will be prepended with the
26196 * given value. If the user wishes so, a callback function pointer
26197 * can be passed, which will get called when this same item is
26200 * @note The current selection @b won't be modified by prepending
26201 * an element to the list.
26203 * @note The maximum length of the text label is going to be
26204 * determined <b>by the widget's theme</b>. Strings larger than
26205 * that value are going to be @b truncated.
26207 * @ingroup Flipselector
26209 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26212 * Get the internal list of items in a given flip selector widget.
26214 * @param obj The flipselector object
26215 * @return The list of items (#Elm_Object_Item as data) or
26216 * @c NULL on errors.
26218 * This list is @b not to be modified in any way and must not be
26219 * freed. Use the list members with functions like
26220 * elm_object_item_text_set(),
26221 * elm_object_item_text_get(),
26222 * elm_flipselector_item_del(),
26223 * elm_flipselector_item_selected_get(),
26224 * elm_flipselector_item_selected_set().
26226 * @warning This list is only valid until @p obj object's internal
26227 * items list is changed. It should be fetched again with another
26228 * call to this function when changes happen.
26230 * @ingroup Flipselector
26232 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26235 * Get the first item in the given flip selector widget's list of
26238 * @param obj The flipselector object
26239 * @return The first item or @c NULL, if it has no items (and on
26242 * @see elm_flipselector_item_append()
26243 * @see elm_flipselector_last_item_get()
26245 * @ingroup Flipselector
26247 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26250 * Get the last item in the given flip selector widget's list of
26253 * @param obj The flipselector object
26254 * @return The last item or @c NULL, if it has no items (and on
26257 * @see elm_flipselector_item_prepend()
26258 * @see elm_flipselector_first_item_get()
26260 * @ingroup Flipselector
26262 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26265 * Get the currently selected item in a flip selector widget.
26267 * @param obj The flipselector object
26268 * @return The selected item or @c NULL, if the widget has no items
26271 * @ingroup Flipselector
26273 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26276 * Set whether a given flip selector widget's item should be the
26277 * currently selected one.
26279 * @param it The flip selector item
26280 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
26282 * This sets whether @p item is or not the selected (thus, under
26283 * display) one. If @p item is different than one under display,
26284 * the latter will be unselected. If the @p item is set to be
26285 * unselected, on the other hand, the @b first item in the widget's
26286 * internal members list will be the new selected one.
26288 * @see elm_flipselector_item_selected_get()
26290 * @ingroup Flipselector
26292 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
26295 * Get whether a given flip selector widget's item is the currently
26298 * @param it The flip selector item
26299 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
26302 * @see elm_flipselector_item_selected_set()
26304 * @ingroup Flipselector
26306 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26309 * Delete a given item from a flip selector widget.
26311 * @param it The item to delete
26313 * @ingroup Flipselector
26315 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26318 * Get the label of a given flip selector widget's item.
26320 * @param it The item to get label from
26321 * @return The text label of @p item or @c NULL, on errors
26323 * @see elm_object_item_text_set()
26325 * @deprecated see elm_object_item_text_get() instead
26326 * @ingroup Flipselector
26328 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26331 * Set the label of a given flip selector widget's item.
26333 * @param it The item to set label on
26334 * @param label The text label string, in UTF-8 encoding
26336 * @see elm_object_item_text_get()
26338 * @deprecated see elm_object_item_text_set() instead
26339 * @ingroup Flipselector
26341 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26344 * Gets the item before @p item in a flip selector widget's
26345 * internal list of items.
26347 * @param it The item to fetch previous from
26348 * @return The item before the @p item, in its parent's list. If
26349 * there is no previous item for @p item or there's an
26350 * error, @c NULL is returned.
26352 * @see elm_flipselector_item_next_get()
26354 * @ingroup Flipselector
26356 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26359 * Gets the item after @p item in a flip selector widget's
26360 * internal list of items.
26362 * @param it The item to fetch next from
26363 * @return The item after the @p item, in its parent's list. If
26364 * there is no next item for @p item or there's an
26365 * error, @c NULL is returned.
26367 * @see elm_flipselector_item_next_get()
26369 * @ingroup Flipselector
26371 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26374 * Set the interval on time updates for an user mouse button hold
26375 * on a flip selector widget.
26377 * @param obj The flip selector object
26378 * @param interval The (first) interval value in seconds
26380 * This interval value is @b decreased while the user holds the
26381 * mouse pointer either flipping up or flipping doww a given flip
26384 * This helps the user to get to a given item distant from the
26385 * current one easier/faster, as it will start to flip quicker and
26386 * quicker on mouse button holds.
26388 * The calculation for the next flip interval value, starting from
26389 * the one set with this call, is the previous interval divided by
26390 * 1.05, so it decreases a little bit.
26392 * The default starting interval value for automatic flips is
26395 * @see elm_flipselector_interval_get()
26397 * @ingroup Flipselector
26399 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26402 * Get the interval on time updates for an user mouse button hold
26403 * on a flip selector widget.
26405 * @param obj The flip selector object
26406 * @return The (first) interval value, in seconds, set on it
26408 * @see elm_flipselector_interval_set() for more details
26410 * @ingroup Flipselector
26412 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26418 * @addtogroup Calendar
26423 * @enum _Elm_Calendar_Mark_Repeat
26424 * @typedef Elm_Calendar_Mark_Repeat
26426 * Event periodicity, used to define if a mark should be repeated
26427 * @b beyond event's day. It's set when a mark is added.
26429 * So, for a mark added to 13th May with periodicity set to WEEKLY,
26430 * there will be marks every week after this date. Marks will be displayed
26431 * at 13th, 20th, 27th, 3rd June ...
26433 * Values don't work as bitmask, only one can be choosen.
26435 * @see elm_calendar_mark_add()
26437 * @ingroup Calendar
26439 typedef enum _Elm_Calendar_Mark_Repeat
26441 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
26442 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
26443 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
26444 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*/
26445 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. */
26446 } Elm_Calendar_Mark_Repeat;
26448 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(). */
26451 * Add a new calendar widget to the given parent Elementary
26452 * (container) object.
26454 * @param parent The parent object.
26455 * @return a new calendar widget handle or @c NULL, on errors.
26457 * This function inserts a new calendar widget on the canvas.
26459 * @ref calendar_example_01
26461 * @ingroup Calendar
26463 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26466 * Get weekdays names displayed by the calendar.
26468 * @param obj The calendar object.
26469 * @return Array of seven strings to be used as weekday names.
26471 * By default, weekdays abbreviations get from system are displayed:
26472 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26473 * The first string is related to Sunday, the second to Monday...
26475 * @see elm_calendar_weekdays_name_set()
26477 * @ref calendar_example_05
26479 * @ingroup Calendar
26481 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26484 * Set weekdays names to be displayed by the calendar.
26486 * @param obj The calendar object.
26487 * @param weekdays Array of seven strings to be used as weekday names.
26488 * @warning It must have 7 elements, or it will access invalid memory.
26489 * @warning The strings must be NULL terminated ('@\0').
26491 * By default, weekdays abbreviations get from system are displayed:
26492 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26494 * The first string should be related to Sunday, the second to Monday...
26496 * The usage should be like this:
26498 * const char *weekdays[] =
26500 * "Sunday", "Monday", "Tuesday", "Wednesday",
26501 * "Thursday", "Friday", "Saturday"
26503 * elm_calendar_weekdays_names_set(calendar, weekdays);
26506 * @see elm_calendar_weekdays_name_get()
26508 * @ref calendar_example_02
26510 * @ingroup Calendar
26512 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
26515 * Set the minimum and maximum values for the year
26517 * @param obj The calendar object
26518 * @param min The minimum year, greater than 1901;
26519 * @param max The maximum year;
26521 * Maximum must be greater than minimum, except if you don't wan't to set
26523 * Default values are 1902 and -1.
26525 * If the maximum year is a negative value, it will be limited depending
26526 * on the platform architecture (year 2037 for 32 bits);
26528 * @see elm_calendar_min_max_year_get()
26530 * @ref calendar_example_03
26532 * @ingroup Calendar
26534 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
26537 * Get the minimum and maximum values for the year
26539 * @param obj The calendar object.
26540 * @param min The minimum year.
26541 * @param max The maximum year.
26543 * Default values are 1902 and -1.
26545 * @see elm_calendar_min_max_year_get() for more details.
26547 * @ref calendar_example_05
26549 * @ingroup Calendar
26551 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
26554 * Enable or disable day selection
26556 * @param obj The calendar object.
26557 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
26560 * Enabled by default. If disabled, the user still can select months,
26561 * but not days. Selected days are highlighted on calendar.
26562 * It should be used if you won't need such selection for the widget usage.
26564 * When a day is selected, or month is changed, smart callbacks for
26565 * signal "changed" will be called.
26567 * @see elm_calendar_day_selection_enable_get()
26569 * @ref calendar_example_04
26571 * @ingroup Calendar
26573 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26576 * Get a value whether day selection is enabled or not.
26578 * @see elm_calendar_day_selection_enable_set() for details.
26580 * @param obj The calendar object.
26581 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
26582 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
26584 * @ref calendar_example_05
26586 * @ingroup Calendar
26588 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26592 * Set selected date to be highlighted on calendar.
26594 * @param obj The calendar object.
26595 * @param selected_time A @b tm struct to represent the selected date.
26597 * Set the selected date, changing the displayed month if needed.
26598 * Selected date changes when the user goes to next/previous month or
26599 * select a day pressing over it on calendar.
26601 * @see elm_calendar_selected_time_get()
26603 * @ref calendar_example_04
26605 * @ingroup Calendar
26607 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
26610 * Get selected date.
26612 * @param obj The calendar object
26613 * @param selected_time A @b tm struct to point to selected date
26614 * @return EINA_FALSE means an error ocurred and returned time shouldn't
26617 * Get date selected by the user or set by function
26618 * elm_calendar_selected_time_set().
26619 * Selected date changes when the user goes to next/previous month or
26620 * select a day pressing over it on calendar.
26622 * @see elm_calendar_selected_time_get()
26624 * @ref calendar_example_05
26626 * @ingroup Calendar
26628 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
26631 * Set a function to format the string that will be used to display
26634 * @param obj The calendar object
26635 * @param format_function Function to set the month-year string given
26636 * the selected date
26638 * By default it uses strftime with "%B %Y" format string.
26639 * It should allocate the memory that will be used by the string,
26640 * that will be freed by the widget after usage.
26641 * A pointer to the string and a pointer to the time struct will be provided.
26646 * _format_month_year(struct tm *selected_time)
26649 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
26650 * return strdup(buf);
26653 * elm_calendar_format_function_set(calendar, _format_month_year);
26656 * @ref calendar_example_02
26658 * @ingroup Calendar
26660 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
26663 * Add a new mark to the calendar
26665 * @param obj The calendar object
26666 * @param mark_type A string used to define the type of mark. It will be
26667 * emitted to the theme, that should display a related modification on these
26668 * days representation.
26669 * @param mark_time A time struct to represent the date of inclusion of the
26670 * mark. For marks that repeats it will just be displayed after the inclusion
26671 * date in the calendar.
26672 * @param repeat Repeat the event following this periodicity. Can be a unique
26673 * mark (that don't repeat), daily, weekly, monthly or annually.
26674 * @return The created mark or @p NULL upon failure.
26676 * Add a mark that will be drawn in the calendar respecting the insertion
26677 * time and periodicity. It will emit the type as signal to the widget theme.
26678 * Default theme supports "holiday" and "checked", but it can be extended.
26680 * It won't immediately update the calendar, drawing the marks.
26681 * For this, call elm_calendar_marks_draw(). However, when user selects
26682 * next or previous month calendar forces marks drawn.
26684 * Marks created with this method can be deleted with
26685 * elm_calendar_mark_del().
26689 * struct tm selected_time;
26690 * time_t current_time;
26692 * current_time = time(NULL) + 5 * 84600;
26693 * localtime_r(¤t_time, &selected_time);
26694 * elm_calendar_mark_add(cal, "holiday", selected_time,
26695 * ELM_CALENDAR_ANNUALLY);
26697 * current_time = time(NULL) + 1 * 84600;
26698 * localtime_r(¤t_time, &selected_time);
26699 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
26701 * elm_calendar_marks_draw(cal);
26704 * @see elm_calendar_marks_draw()
26705 * @see elm_calendar_mark_del()
26707 * @ref calendar_example_06
26709 * @ingroup Calendar
26711 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);
26714 * Delete mark from the calendar.
26716 * @param mark The mark to be deleted.
26718 * If deleting all calendar marks is required, elm_calendar_marks_clear()
26719 * should be used instead of getting marks list and deleting each one.
26721 * @see elm_calendar_mark_add()
26723 * @ref calendar_example_06
26725 * @ingroup Calendar
26727 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
26730 * Remove all calendar's marks
26732 * @param obj The calendar object.
26734 * @see elm_calendar_mark_add()
26735 * @see elm_calendar_mark_del()
26737 * @ingroup Calendar
26739 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26742 * Get a list of all the calendar marks.
26744 * @param obj The calendar object.
26745 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
26747 * @see elm_calendar_mark_add()
26748 * @see elm_calendar_mark_del()
26749 * @see elm_calendar_marks_clear()
26751 * @ingroup Calendar
26753 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26756 * Draw calendar marks.
26758 * @param obj The calendar object.
26760 * Should be used after adding, removing or clearing marks.
26761 * It will go through the entire marks list updating the calendar.
26762 * If lots of marks will be added, add all the marks and then call
26765 * When the month is changed, i.e. user selects next or previous month,
26766 * marks will be drawed.
26768 * @see elm_calendar_mark_add()
26769 * @see elm_calendar_mark_del()
26770 * @see elm_calendar_marks_clear()
26772 * @ref calendar_example_06
26774 * @ingroup Calendar
26776 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
26779 * Set a day text color to the same that represents Saturdays.
26781 * @param obj The calendar object.
26782 * @param pos The text position. Position is the cell counter, from left
26783 * to right, up to down. It starts on 0 and ends on 41.
26785 * @deprecated use elm_calendar_mark_add() instead like:
26788 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26789 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26792 * @see elm_calendar_mark_add()
26794 * @ingroup Calendar
26796 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26799 * Set a day text color to the same that represents Sundays.
26801 * @param obj The calendar object.
26802 * @param pos The text position. Position is the cell counter, from left
26803 * to right, up to down. It starts on 0 and ends on 41.
26805 * @deprecated use elm_calendar_mark_add() instead like:
26808 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26809 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26812 * @see elm_calendar_mark_add()
26814 * @ingroup Calendar
26816 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26819 * Set a day text color to the same that represents Weekdays.
26821 * @param obj The calendar object
26822 * @param pos The text position. Position is the cell counter, from left
26823 * to right, up to down. It starts on 0 and ends on 41.
26825 * @deprecated use elm_calendar_mark_add() instead like:
26828 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26830 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26831 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26832 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26833 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26834 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26835 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26836 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26837 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26838 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26841 * @see elm_calendar_mark_add()
26843 * @ingroup Calendar
26845 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26848 * Set the interval on time updates for an user mouse button hold
26849 * on calendar widgets' month selection.
26851 * @param obj The calendar object
26852 * @param interval The (first) interval value in seconds
26854 * This interval value is @b decreased while the user holds the
26855 * mouse pointer either selecting next or previous month.
26857 * This helps the user to get to a given month distant from the
26858 * current one easier/faster, as it will start to change quicker and
26859 * quicker on mouse button holds.
26861 * The calculation for the next change interval value, starting from
26862 * the one set with this call, is the previous interval divided by
26863 * 1.05, so it decreases a little bit.
26865 * The default starting interval value for automatic changes is
26868 * @see elm_calendar_interval_get()
26870 * @ingroup Calendar
26872 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26875 * Get the interval on time updates for an user mouse button hold
26876 * on calendar widgets' month selection.
26878 * @param obj The calendar object
26879 * @return The (first) interval value, in seconds, set on it
26881 * @see elm_calendar_interval_set() for more details
26883 * @ingroup Calendar
26885 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26892 * @defgroup Diskselector Diskselector
26893 * @ingroup Elementary
26895 * @image html img/widget/diskselector/preview-00.png
26896 * @image latex img/widget/diskselector/preview-00.eps
26898 * A diskselector is a kind of list widget. It scrolls horizontally,
26899 * and can contain label and icon objects. Three items are displayed
26900 * with the selected one in the middle.
26902 * It can act like a circular list with round mode and labels can be
26903 * reduced for a defined length for side items.
26905 * Smart callbacks one can listen to:
26906 * - "selected" - when item is selected, i.e. scroller stops.
26908 * Available styles for it:
26911 * List of examples:
26912 * @li @ref diskselector_example_01
26913 * @li @ref diskselector_example_02
26917 * @addtogroup Diskselector
26921 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(). */
26924 * Add a new diskselector widget to the given parent Elementary
26925 * (container) object.
26927 * @param parent The parent object.
26928 * @return a new diskselector widget handle or @c NULL, on errors.
26930 * This function inserts a new diskselector widget on the canvas.
26932 * @ingroup Diskselector
26934 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26937 * Enable or disable round mode.
26939 * @param obj The diskselector object.
26940 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
26943 * Disabled by default. If round mode is enabled the items list will
26944 * work like a circle list, so when the user reaches the last item,
26945 * the first one will popup.
26947 * @see elm_diskselector_round_get()
26949 * @ingroup Diskselector
26951 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
26954 * Get a value whether round mode is enabled or not.
26956 * @see elm_diskselector_round_set() for details.
26958 * @param obj The diskselector object.
26959 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
26960 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26962 * @ingroup Diskselector
26964 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26967 * Get the side labels max length.
26969 * @deprecated use elm_diskselector_side_label_length_get() instead:
26971 * @param obj The diskselector object.
26972 * @return The max length defined for side labels, or 0 if not a valid
26975 * @ingroup Diskselector
26977 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26980 * Set the side labels max length.
26982 * @deprecated use elm_diskselector_side_label_length_set() instead:
26984 * @param obj The diskselector object.
26985 * @param len The max length defined for side labels.
26987 * @ingroup Diskselector
26989 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26992 * Get the side labels max length.
26994 * @see elm_diskselector_side_label_length_set() for details.
26996 * @param obj The diskselector object.
26997 * @return The max length defined for side labels, or 0 if not a valid
27000 * @ingroup Diskselector
27002 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27005 * Set the side labels max length.
27007 * @param obj The diskselector object.
27008 * @param len The max length defined for side labels.
27010 * Length is the number of characters of items' label that will be
27011 * visible when it's set on side positions. It will just crop
27012 * the string after defined size. E.g.:
27014 * An item with label "January" would be displayed on side position as
27015 * "Jan" if max length is set to 3, or "Janu", if this property
27018 * When it's selected, the entire label will be displayed, except for
27019 * width restrictions. In this case label will be cropped and "..."
27020 * will be concatenated.
27022 * Default side label max length is 3.
27024 * This property will be applyed over all items, included before or
27025 * later this function call.
27027 * @ingroup Diskselector
27029 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27032 * Set the number of items to be displayed.
27034 * @param obj The diskselector object.
27035 * @param num The number of items the diskselector will display.
27037 * Default value is 3, and also it's the minimun. If @p num is less
27038 * than 3, it will be set to 3.
27040 * Also, it can be set on theme, using data item @c display_item_num
27041 * on group "elm/diskselector/item/X", where X is style set.
27044 * group { name: "elm/diskselector/item/X";
27046 * item: "display_item_num" "5";
27049 * @ingroup Diskselector
27051 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
27054 * Get the number of items in the diskselector object.
27056 * @param obj The diskselector object.
27058 * @ingroup Diskselector
27060 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27063 * Set bouncing behaviour when the scrolled content reaches an edge.
27065 * Tell the internal scroller object whether it should bounce or not
27066 * when it reaches the respective edges for each axis.
27068 * @param obj The diskselector object.
27069 * @param h_bounce Whether to bounce or not in the horizontal axis.
27070 * @param v_bounce Whether to bounce or not in the vertical axis.
27072 * @see elm_scroller_bounce_set()
27074 * @ingroup Diskselector
27076 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
27079 * Get the bouncing behaviour of the internal scroller.
27081 * Get whether the internal scroller should bounce when the edge of each
27082 * axis is reached scrolling.
27084 * @param obj The diskselector object.
27085 * @param h_bounce Pointer where to store the bounce state of the horizontal
27087 * @param v_bounce Pointer where to store the bounce state of the vertical
27090 * @see elm_scroller_bounce_get()
27091 * @see elm_diskselector_bounce_set()
27093 * @ingroup Diskselector
27095 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
27098 * Get the scrollbar policy.
27100 * @see elm_diskselector_scroller_policy_get() for details.
27102 * @param obj The diskselector object.
27103 * @param policy_h Pointer where to store horizontal scrollbar policy.
27104 * @param policy_v Pointer where to store vertical scrollbar policy.
27106 * @ingroup Diskselector
27108 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);
27111 * Set the scrollbar policy.
27113 * @param obj The diskselector object.
27114 * @param policy_h Horizontal scrollbar policy.
27115 * @param policy_v Vertical scrollbar policy.
27117 * This sets the scrollbar visibility policy for the given scroller.
27118 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
27119 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
27120 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
27121 * This applies respectively for the horizontal and vertical scrollbars.
27123 * The both are disabled by default, i.e., are set to
27124 * #ELM_SCROLLER_POLICY_OFF.
27126 * @ingroup Diskselector
27128 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
27131 * Remove all diskselector's items.
27133 * @param obj The diskselector object.
27135 * @see elm_diskselector_item_del()
27136 * @see elm_diskselector_item_append()
27138 * @ingroup Diskselector
27140 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27143 * Get a list of all the diskselector items.
27145 * @param obj The diskselector object.
27146 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
27147 * or @c NULL on failure.
27149 * @see elm_diskselector_item_append()
27150 * @see elm_diskselector_item_del()
27151 * @see elm_diskselector_clear()
27153 * @ingroup Diskselector
27155 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27158 * Appends a new item to the diskselector object.
27160 * @param obj The diskselector object.
27161 * @param label The label of the diskselector item.
27162 * @param icon The icon object to use at left side of the item. An
27163 * icon can be any Evas object, but usually it is an icon created
27164 * with elm_icon_add().
27165 * @param func The function to call when the item is selected.
27166 * @param data The data to associate with the item for related callbacks.
27168 * @return The created item or @c NULL upon failure.
27170 * A new item will be created and appended to the diskselector, i.e., will
27171 * be set as last item. Also, if there is no selected item, it will
27172 * be selected. This will always happens for the first appended item.
27174 * If no icon is set, label will be centered on item position, otherwise
27175 * the icon will be placed at left of the label, that will be shifted
27178 * Items created with this method can be deleted with
27179 * elm_diskselector_item_del().
27181 * Associated @p data can be properly freed when item is deleted if a
27182 * callback function is set with elm_diskselector_item_del_cb_set().
27184 * If a function is passed as argument, it will be called everytime this item
27185 * is selected, i.e., the user stops the diskselector with this
27186 * item on center position. If such function isn't needed, just passing
27187 * @c NULL as @p func is enough. The same should be done for @p data.
27189 * Simple example (with no function callback or data associated):
27191 * disk = elm_diskselector_add(win);
27192 * ic = elm_icon_add(win);
27193 * elm_icon_file_set(ic, "path/to/image", NULL);
27194 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27195 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
27198 * @see elm_diskselector_item_del()
27199 * @see elm_diskselector_item_del_cb_set()
27200 * @see elm_diskselector_clear()
27201 * @see elm_icon_add()
27203 * @ingroup Diskselector
27205 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);
27209 * Delete them item from the diskselector.
27211 * @param it The item of diskselector to be deleted.
27213 * If deleting all diskselector items is required, elm_diskselector_clear()
27214 * should be used instead of getting items list and deleting each one.
27216 * @see elm_diskselector_clear()
27217 * @see elm_diskselector_item_append()
27218 * @see elm_diskselector_item_del_cb_set()
27220 * @ingroup Diskselector
27222 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27225 * Set the function called when a diskselector item is freed.
27227 * @param it The item to set the callback on
27228 * @param func The function called
27230 * If there is a @p func, then it will be called prior item's memory release.
27231 * That will be called with the following arguments:
27233 * @li item's Evas object;
27236 * This way, a data associated to a diskselector item could be properly
27239 * @ingroup Diskselector
27241 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
27244 * Get the data associated to the item.
27246 * @param it The diskselector item
27247 * @return The data associated to @p it
27249 * The return value is a pointer to data associated to @p item when it was
27250 * created, with function elm_diskselector_item_append(). If no data
27251 * was passed as argument, it will return @c NULL.
27253 * @see elm_diskselector_item_append()
27255 * @ingroup Diskselector
27257 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27260 * Set the icon associated to the item.
27262 * @param it The diskselector item
27263 * @param icon The icon object to associate with @p it
27265 * The icon object to use at left side of the item. An
27266 * icon can be any Evas object, but usually it is an icon created
27267 * with elm_icon_add().
27269 * Once the icon object is set, a previously set one will be deleted.
27270 * @warning Setting the same icon for two items will cause the icon to
27271 * dissapear from the first item.
27273 * If an icon was passed as argument on item creation, with function
27274 * elm_diskselector_item_append(), it will be already
27275 * associated to the item.
27277 * @see elm_diskselector_item_append()
27278 * @see elm_diskselector_item_icon_get()
27280 * @ingroup Diskselector
27282 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
27285 * Get the icon associated to the item.
27287 * @param it The diskselector item
27288 * @return The icon associated to @p it
27290 * The return value is a pointer to the icon associated to @p item when it was
27291 * created, with function elm_diskselector_item_append(), or later
27292 * with function elm_diskselector_item_icon_set. If no icon
27293 * was passed as argument, it will return @c NULL.
27295 * @see elm_diskselector_item_append()
27296 * @see elm_diskselector_item_icon_set()
27298 * @ingroup Diskselector
27300 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27303 * Set the label of item.
27305 * @param it The item of diskselector.
27306 * @param label The label of item.
27308 * The label to be displayed by the item.
27310 * If no icon is set, label will be centered on item position, otherwise
27311 * the icon will be placed at left of the label, that will be shifted
27314 * An item with label "January" would be displayed on side position as
27315 * "Jan" if max length is set to 3 with function
27316 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
27319 * When this @p item is selected, the entire label will be displayed,
27320 * except for width restrictions.
27321 * In this case label will be cropped and "..." will be concatenated,
27322 * but only for display purposes. It will keep the entire string, so
27323 * if diskselector is resized the remaining characters will be displayed.
27325 * If a label was passed as argument on item creation, with function
27326 * elm_diskselector_item_append(), it will be already
27327 * displayed by the item.
27329 * @see elm_diskselector_side_label_lenght_set()
27330 * @see elm_diskselector_item_label_get()
27331 * @see elm_diskselector_item_append()
27333 * @ingroup Diskselector
27335 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
27338 * Get the label of item.
27340 * @param it The item of diskselector.
27341 * @return The label of item.
27343 * The return value is a pointer to the label associated to @p item when it was
27344 * created, with function elm_diskselector_item_append(), or later
27345 * with function elm_diskselector_item_label_set. If no label
27346 * was passed as argument, it will return @c NULL.
27348 * @see elm_diskselector_item_label_set() for more details.
27349 * @see elm_diskselector_item_append()
27351 * @ingroup Diskselector
27353 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27356 * Get the selected item.
27358 * @param obj The diskselector object.
27359 * @return The selected diskselector item.
27361 * The selected item can be unselected with function
27362 * elm_diskselector_item_selected_set(), and the first item of
27363 * diskselector will be selected.
27365 * The selected item always will be centered on diskselector, with
27366 * full label displayed, i.e., max lenght set to side labels won't
27367 * apply on the selected item. More details on
27368 * elm_diskselector_side_label_length_set().
27370 * @ingroup Diskselector
27372 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27375 * Set the selected state of an item.
27377 * @param it The diskselector item
27378 * @param selected The selected state
27380 * This sets the selected state of the given item @p it.
27381 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27383 * If a new item is selected the previosly selected will be unselected.
27384 * Previoulsy selected item can be get with function
27385 * elm_diskselector_selected_item_get().
27387 * If the item @p it is unselected, the first item of diskselector will
27390 * Selected items will be visible on center position of diskselector.
27391 * So if it was on another position before selected, or was invisible,
27392 * diskselector will animate items until the selected item reaches center
27395 * @see elm_diskselector_item_selected_get()
27396 * @see elm_diskselector_selected_item_get()
27398 * @ingroup Diskselector
27400 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
27403 * Get whether the @p item is selected or not.
27405 * @param it The diskselector item.
27406 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
27407 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
27409 * @see elm_diskselector_selected_item_set() for details.
27410 * @see elm_diskselector_item_selected_get()
27412 * @ingroup Diskselector
27414 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27417 * Get the first item of the diskselector.
27419 * @param obj The diskselector object.
27420 * @return The first item, or @c NULL if none.
27422 * The list of items follows append order. So it will return the first
27423 * item appended to the widget that wasn't deleted.
27425 * @see elm_diskselector_item_append()
27426 * @see elm_diskselector_items_get()
27428 * @ingroup Diskselector
27430 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27433 * Get the last item of the diskselector.
27435 * @param obj The diskselector object.
27436 * @return The last item, or @c NULL if none.
27438 * The list of items follows append order. So it will return last first
27439 * item appended to the widget that wasn't deleted.
27441 * @see elm_diskselector_item_append()
27442 * @see elm_diskselector_items_get()
27444 * @ingroup Diskselector
27446 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27449 * Get the item before @p item in diskselector.
27451 * @param it The diskselector item.
27452 * @return The item before @p item, or @c NULL if none or on failure.
27454 * The list of items follows append order. So it will return item appended
27455 * just before @p item and that wasn't deleted.
27457 * If it is the first item, @c NULL will be returned.
27458 * First item can be get by elm_diskselector_first_item_get().
27460 * @see elm_diskselector_item_append()
27461 * @see elm_diskselector_items_get()
27463 * @ingroup Diskselector
27465 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27468 * Get the item after @p item in diskselector.
27470 * @param it The diskselector item.
27471 * @return The item after @p item, or @c NULL if none or on failure.
27473 * The list of items follows append order. So it will return item appended
27474 * just after @p item and that wasn't deleted.
27476 * If it is the last item, @c NULL will be returned.
27477 * Last item can be get by elm_diskselector_last_item_get().
27479 * @see elm_diskselector_item_append()
27480 * @see elm_diskselector_items_get()
27482 * @ingroup Diskselector
27484 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27487 * Set the text to be shown in the diskselector item.
27489 * @param item Target item
27490 * @param text The text to set in the content
27492 * Setup the text as tooltip to object. The item can have only one tooltip,
27493 * so any previous tooltip data is removed.
27495 * @see elm_object_tooltip_text_set() for more details.
27497 * @ingroup Diskselector
27499 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
27502 * Set the content to be shown in the tooltip item.
27504 * Setup the tooltip to item. The item can have only one tooltip,
27505 * so any previous tooltip data is removed. @p func(with @p data) will
27506 * be called every time that need show the tooltip and it should
27507 * return a valid Evas_Object. This object is then managed fully by
27508 * tooltip system and is deleted when the tooltip is gone.
27510 * @param item the diskselector item being attached a tooltip.
27511 * @param func the function used to create the tooltip contents.
27512 * @param data what to provide to @a func as callback data/context.
27513 * @param del_cb called when data is not needed anymore, either when
27514 * another callback replaces @p func, the tooltip is unset with
27515 * elm_diskselector_item_tooltip_unset() or the owner @a item
27516 * dies. This callback receives as the first parameter the
27517 * given @a data, and @c event_info is the item.
27519 * @see elm_object_tooltip_content_cb_set() for more details.
27521 * @ingroup Diskselector
27523 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);
27526 * Unset tooltip from item.
27528 * @param item diskselector item to remove previously set tooltip.
27530 * Remove tooltip from item. The callback provided as del_cb to
27531 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
27532 * it is not used anymore.
27534 * @see elm_object_tooltip_unset() for more details.
27535 * @see elm_diskselector_item_tooltip_content_cb_set()
27537 * @ingroup Diskselector
27539 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27542 * Sets a different style for this item tooltip.
27544 * @note before you set a style you should define a tooltip with
27545 * elm_diskselector_item_tooltip_content_cb_set() or
27546 * elm_diskselector_item_tooltip_text_set()
27548 * @param item diskselector item with tooltip already set.
27549 * @param style the theme style to use (default, transparent, ...)
27551 * @see elm_object_tooltip_style_set() for more details.
27553 * @ingroup Diskselector
27555 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27558 * Get the style for this item tooltip.
27560 * @param item diskselector item with tooltip already set.
27561 * @return style the theme style in use, defaults to "default". If the
27562 * object does not have a tooltip set, then NULL is returned.
27564 * @see elm_object_tooltip_style_get() for more details.
27565 * @see elm_diskselector_item_tooltip_style_set()
27567 * @ingroup Diskselector
27569 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27572 * Set the cursor to be shown when mouse is over the diskselector item
27574 * @param item Target item
27575 * @param cursor the cursor name to be used.
27577 * @see elm_object_cursor_set() for more details.
27579 * @ingroup Diskselector
27581 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
27584 * Get the cursor to be shown when mouse is over the diskselector item
27586 * @param item diskselector item with cursor already set.
27587 * @return the cursor name.
27589 * @see elm_object_cursor_get() for more details.
27590 * @see elm_diskselector_cursor_set()
27592 * @ingroup Diskselector
27594 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27597 * Unset the cursor to be shown when mouse is over the diskselector item
27599 * @param item Target item
27601 * @see elm_object_cursor_unset() for more details.
27602 * @see elm_diskselector_cursor_set()
27604 * @ingroup Diskselector
27606 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27609 * Sets a different style for this item cursor.
27611 * @note before you set a style you should define a cursor with
27612 * elm_diskselector_item_cursor_set()
27614 * @param item diskselector item with cursor already set.
27615 * @param style the theme style to use (default, transparent, ...)
27617 * @see elm_object_cursor_style_set() for more details.
27619 * @ingroup Diskselector
27621 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27624 * Get the style for this item cursor.
27626 * @param item diskselector item with cursor already set.
27627 * @return style the theme style in use, defaults to "default". If the
27628 * object does not have a cursor set, then @c NULL is returned.
27630 * @see elm_object_cursor_style_get() for more details.
27631 * @see elm_diskselector_item_cursor_style_set()
27633 * @ingroup Diskselector
27635 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27639 * Set if the cursor set should be searched on the theme or should use
27640 * the provided by the engine, only.
27642 * @note before you set if should look on theme you should define a cursor
27643 * with elm_diskselector_item_cursor_set().
27644 * By default it will only look for cursors provided by the engine.
27646 * @param item widget item with cursor already set.
27647 * @param engine_only boolean to define if cursors set with
27648 * elm_diskselector_item_cursor_set() should be searched only
27649 * between cursors provided by the engine or searched on widget's
27652 * @see elm_object_cursor_engine_only_set() for more details.
27654 * @ingroup Diskselector
27656 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
27659 * Get the cursor engine only usage for this item cursor.
27661 * @param item widget item with cursor already set.
27662 * @return engine_only boolean to define it cursors should be looked only
27663 * between the provided by the engine or searched on widget's theme as well.
27664 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
27666 * @see elm_object_cursor_engine_only_get() for more details.
27667 * @see elm_diskselector_item_cursor_engine_only_set()
27669 * @ingroup Diskselector
27671 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27678 * @defgroup Colorselector Colorselector
27682 * @image html img/widget/colorselector/preview-00.png
27683 * @image latex img/widget/colorselector/preview-00.eps
27685 * @brief Widget for user to select a color.
27687 * Signals that you can add callbacks for are:
27688 * "changed" - When the color value changes(event_info is NULL).
27690 * See @ref tutorial_colorselector.
27693 * @brief Add a new colorselector to the parent
27695 * @param parent The parent object
27696 * @return The new object or NULL if it cannot be created
27698 * @ingroup Colorselector
27700 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27702 * Set a color for the colorselector
27704 * @param obj Colorselector object
27705 * @param r r-value of color
27706 * @param g g-value of color
27707 * @param b b-value of color
27708 * @param a a-value of color
27710 * @ingroup Colorselector
27712 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
27714 * Get a color from the colorselector
27716 * @param obj Colorselector object
27717 * @param r integer pointer for r-value of color
27718 * @param g integer pointer for g-value of color
27719 * @param b integer pointer for b-value of color
27720 * @param a integer pointer for a-value of color
27722 * @ingroup Colorselector
27724 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
27730 * @defgroup Ctxpopup Ctxpopup
27732 * @image html img/widget/ctxpopup/preview-00.png
27733 * @image latex img/widget/ctxpopup/preview-00.eps
27735 * @brief Context popup widet.
27737 * A ctxpopup is a widget that, when shown, pops up a list of items.
27738 * It automatically chooses an area inside its parent object's view
27739 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
27740 * optimally fit into it. In the default theme, it will also point an
27741 * arrow to it's top left position at the time one shows it. Ctxpopup
27742 * items have a label and/or an icon. It is intended for a small
27743 * number of items (hence the use of list, not genlist).
27745 * @note Ctxpopup is a especialization of @ref Hover.
27747 * Signals that you can add callbacks for are:
27748 * "dismissed" - the ctxpopup was dismissed
27750 * Default contents parts of the ctxpopup widget that you can use for are:
27751 * @li "default" - A content of the ctxpopup
27753 * Default contents parts of the naviframe items that you can use for are:
27754 * @li "icon" - An icon in the title area
27756 * Default text parts of the naviframe items that you can use for are:
27757 * @li "default" - Title label in the title area
27759 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
27764 * @addtogroup Ctxpopup
27768 typedef enum _Elm_Ctxpopup_Direction
27770 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
27772 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
27773 the clicked area */
27774 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
27775 the clicked area */
27776 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
27778 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
27779 } Elm_Ctxpopup_Direction;
27782 * @brief Add a new Ctxpopup object to the parent.
27784 * @param parent Parent object
27785 * @return New object or @c NULL, if it cannot be created
27787 * @ingroup Ctxpopup
27789 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27792 * @brief Set the Ctxpopup's parent
27794 * @param obj The ctxpopup object
27795 * @param area The parent to use
27797 * Set the parent object.
27799 * @note elm_ctxpopup_add() will automatically call this function
27800 * with its @c parent argument.
27802 * @see elm_ctxpopup_add()
27803 * @see elm_hover_parent_set()
27805 * @ingroup Ctxpopup
27807 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27810 * @brief Get the Ctxpopup's parent
27812 * @param obj The ctxpopup object
27814 * @see elm_ctxpopup_hover_parent_set() for more information
27816 * @ingroup Ctxpopup
27818 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27821 * @brief Clear all items in the given ctxpopup object.
27823 * @param obj Ctxpopup object
27825 * @ingroup Ctxpopup
27827 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27830 * @brief Change the ctxpopup's orientation to horizontal or vertical.
27832 * @param obj Ctxpopup object
27833 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27835 * @ingroup Ctxpopup
27837 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27840 * @brief Get the value of current ctxpopup object's orientation.
27842 * @param obj Ctxpopup object
27843 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27845 * @see elm_ctxpopup_horizontal_set()
27847 * @ingroup Ctxpopup
27849 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27852 * @brief Add a new item to a ctxpopup object.
27854 * @param obj Ctxpopup object
27855 * @param icon Icon to be set on new item
27856 * @param label The Label of the new item
27857 * @param func Convenience function called when item selected
27858 * @param data Data passed to @p func
27859 * @return A handle to the item added or @c NULL, on errors
27861 * @warning Ctxpopup can't hold both an item list and a content at the same
27862 * time. When an item is added, any previous content will be removed.
27864 * @see elm_ctxpopup_content_set()
27866 * @ingroup Ctxpopup
27868 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);
27871 * @brief Delete the given item in a ctxpopup object.
27873 * @param it Ctxpopup item to be deleted
27875 * @see elm_ctxpopup_item_append()
27877 * @ingroup Ctxpopup
27879 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27882 * @brief Set the ctxpopup item's state as disabled or enabled.
27884 * @param it Ctxpopup item to be enabled/disabled
27885 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27887 * When disabled the item is greyed out to indicate it's state.
27888 * @deprecated use elm_object_item_disabled_set() instead
27890 * @ingroup Ctxpopup
27892 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27895 * @brief Get the ctxpopup item's disabled/enabled state.
27897 * @param it Ctxpopup item to be enabled/disabled
27898 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27900 * @see elm_ctxpopup_item_disabled_set()
27901 * @deprecated use elm_object_item_disabled_get() instead
27903 * @ingroup Ctxpopup
27905 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27908 * @brief Get the icon object for the given ctxpopup item.
27910 * @param it Ctxpopup item
27911 * @return icon object or @c NULL, if the item does not have icon or an error
27914 * @see elm_ctxpopup_item_append()
27915 * @see elm_ctxpopup_item_icon_set()
27917 * @deprecated use elm_object_item_part_content_get() instead
27919 * @ingroup Ctxpopup
27921 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27924 * @brief Sets the side icon associated with the ctxpopup item
27926 * @param it Ctxpopup item
27927 * @param icon Icon object to be set
27929 * Once the icon object is set, a previously set one will be deleted.
27930 * @warning Setting the same icon for two items will cause the icon to
27931 * dissapear from the first item.
27933 * @see elm_ctxpopup_item_append()
27935 * @deprecated use elm_object_item_part_content_set() instead
27937 * @ingroup Ctxpopup
27939 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27942 * @brief Get the label for the given ctxpopup item.
27944 * @param it Ctxpopup item
27945 * @return label string or @c NULL, if the item does not have label or an
27948 * @see elm_ctxpopup_item_append()
27949 * @see elm_ctxpopup_item_label_set()
27951 * @deprecated use elm_object_item_text_get() instead
27953 * @ingroup Ctxpopup
27955 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27958 * @brief (Re)set the label on the given ctxpopup item.
27960 * @param it Ctxpopup item
27961 * @param label String to set as label
27963 * @deprecated use elm_object_item_text_set() instead
27965 * @ingroup Ctxpopup
27967 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
27970 * @brief Set an elm widget as the content of the ctxpopup.
27972 * @param obj Ctxpopup object
27973 * @param content Content to be swallowed
27975 * If the content object is already set, a previous one will bedeleted. If
27976 * you want to keep that old content object, use the
27977 * elm_ctxpopup_content_unset() function.
27979 * @warning Ctxpopup can't hold both a item list and a content at the same
27980 * time. When a content is set, any previous items will be removed.
27982 * @deprecated use elm_object_content_set() instead
27984 * @ingroup Ctxpopup
27986 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
27989 * @brief Unset the ctxpopup content
27991 * @param obj Ctxpopup object
27992 * @return The content that was being used
27994 * Unparent and return the content object which was set for this widget.
27996 * @deprecated use elm_object_content_unset()
27998 * @see elm_ctxpopup_content_set()
28000 * @deprecated use elm_object_content_unset() instead
28002 * @ingroup Ctxpopup
28004 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
28007 * @brief Set the direction priority of a ctxpopup.
28009 * @param obj Ctxpopup object
28010 * @param first 1st priority of direction
28011 * @param second 2nd priority of direction
28012 * @param third 3th priority of direction
28013 * @param fourth 4th priority of direction
28015 * This functions gives a chance to user to set the priority of ctxpopup
28016 * showing direction. This doesn't guarantee the ctxpopup will appear in the
28017 * requested direction.
28019 * @see Elm_Ctxpopup_Direction
28021 * @ingroup Ctxpopup
28023 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);
28026 * @brief Get the direction priority of a ctxpopup.
28028 * @param obj Ctxpopup object
28029 * @param first 1st priority of direction to be returned
28030 * @param second 2nd priority of direction to be returned
28031 * @param third 3th priority of direction to be returned
28032 * @param fourth 4th priority of direction to be returned
28034 * @see elm_ctxpopup_direction_priority_set() for more information.
28036 * @ingroup Ctxpopup
28038 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);
28041 * @brief Get the current direction of a ctxpopup.
28043 * @param obj Ctxpopup object
28044 * @return current direction of a ctxpopup
28046 * @warning Once the ctxpopup showed up, the direction would be determined
28048 * @ingroup Ctxpopup
28050 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28059 * @defgroup Transit Transit
28060 * @ingroup Elementary
28062 * Transit is designed to apply various animated transition effects to @c
28063 * Evas_Object, such like translation, rotation, etc. For using these
28064 * effects, create an @ref Elm_Transit and add the desired transition effects.
28066 * Once the effects are added into transit, they will be automatically
28067 * managed (their callback will be called until the duration is ended, and
28068 * they will be deleted on completion).
28072 * Elm_Transit *trans = elm_transit_add();
28073 * elm_transit_object_add(trans, obj);
28074 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
28075 * elm_transit_duration_set(transit, 1);
28076 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
28077 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
28078 * elm_transit_repeat_times_set(transit, 3);
28081 * Some transition effects are used to change the properties of objects. They
28083 * @li @ref elm_transit_effect_translation_add
28084 * @li @ref elm_transit_effect_color_add
28085 * @li @ref elm_transit_effect_rotation_add
28086 * @li @ref elm_transit_effect_wipe_add
28087 * @li @ref elm_transit_effect_zoom_add
28088 * @li @ref elm_transit_effect_resizing_add
28090 * Other transition effects are used to make one object disappear and another
28091 * object appear on its old place. These effects are:
28093 * @li @ref elm_transit_effect_flip_add
28094 * @li @ref elm_transit_effect_resizable_flip_add
28095 * @li @ref elm_transit_effect_fade_add
28096 * @li @ref elm_transit_effect_blend_add
28098 * It's also possible to make a transition chain with @ref
28099 * elm_transit_chain_transit_add.
28101 * @warning We strongly recommend to use elm_transit just when edje can not do
28102 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
28103 * animations can be manipulated inside the theme.
28105 * List of examples:
28106 * @li @ref transit_example_01_explained
28107 * @li @ref transit_example_02_explained
28108 * @li @ref transit_example_03_c
28109 * @li @ref transit_example_04_c
28115 * @enum Elm_Transit_Tween_Mode
28117 * The type of acceleration used in the transition.
28121 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
28122 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
28123 over time, then decrease again
28125 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
28127 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
28129 } Elm_Transit_Tween_Mode;
28132 * @enum Elm_Transit_Effect_Flip_Axis
28134 * The axis where flip effect should be applied.
28138 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
28139 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
28140 } Elm_Transit_Effect_Flip_Axis;
28143 * @enum Elm_Transit_Effect_Wipe_Dir
28145 * The direction where the wipe effect should occur.
28149 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
28150 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
28151 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
28152 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
28153 } Elm_Transit_Effect_Wipe_Dir;
28155 /** @enum Elm_Transit_Effect_Wipe_Type
28157 * Whether the wipe effect should show or hide the object.
28161 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
28163 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
28165 } Elm_Transit_Effect_Wipe_Type;
28168 * @typedef Elm_Transit
28170 * The Transit created with elm_transit_add(). This type has the information
28171 * about the objects which the transition will be applied, and the
28172 * transition effects that will be used. It also contains info about
28173 * duration, number of repetitions, auto-reverse, etc.
28175 typedef struct _Elm_Transit Elm_Transit;
28176 typedef void Elm_Transit_Effect;
28179 * @typedef Elm_Transit_Effect_Transition_Cb
28181 * Transition callback called for this effect on each transition iteration.
28183 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
28186 * Elm_Transit_Effect_End_Cb
28188 * Transition callback called for this effect when the transition is over.
28190 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
28193 * Elm_Transit_Del_Cb
28195 * A callback called when the transit is deleted.
28197 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
28202 * @note Is not necessary to delete the transit object, it will be deleted at
28203 * the end of its operation.
28204 * @note The transit will start playing when the program enter in the main loop, is not
28205 * necessary to give a start to the transit.
28207 * @return The transit object.
28211 EAPI Elm_Transit *elm_transit_add(void);
28214 * Stops the animation and delete the @p transit object.
28216 * Call this function if you wants to stop the animation before the duration
28217 * time. Make sure the @p transit object is still alive with
28218 * elm_transit_del_cb_set() function.
28219 * All added effects will be deleted, calling its repective data_free_cb
28220 * functions. The function setted by elm_transit_del_cb_set() will be called.
28222 * @see elm_transit_del_cb_set()
28224 * @param transit The transit object to be deleted.
28227 * @warning Just call this function if you are sure the transit is alive.
28229 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28232 * Add a new effect to the transit.
28234 * @note The cb function and the data are the key to the effect. If you try to
28235 * add an already added effect, nothing is done.
28236 * @note After the first addition of an effect in @p transit, if its
28237 * effect list become empty again, the @p transit will be killed by
28238 * elm_transit_del(transit) function.
28242 * Elm_Transit *transit = elm_transit_add();
28243 * elm_transit_effect_add(transit,
28244 * elm_transit_effect_blend_op,
28245 * elm_transit_effect_blend_context_new(),
28246 * elm_transit_effect_blend_context_free);
28249 * @param transit The transit object.
28250 * @param transition_cb The operation function. It is called when the
28251 * animation begins, it is the function that actually performs the animation.
28252 * It is called with the @p data, @p transit and the time progression of the
28253 * animation (a double value between 0.0 and 1.0).
28254 * @param effect The context data of the effect.
28255 * @param end_cb The function to free the context data, it will be called
28256 * at the end of the effect, it must finalize the animation and free the
28260 * @warning The transit free the context data at the and of the transition with
28261 * the data_free_cb function, do not use the context data in another transit.
28263 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);
28266 * Delete an added effect.
28268 * This function will remove the effect from the @p transit, calling the
28269 * data_free_cb to free the @p data.
28271 * @see elm_transit_effect_add()
28273 * @note If the effect is not found, nothing is done.
28274 * @note If the effect list become empty, this function will call
28275 * elm_transit_del(transit), that is, it will kill the @p transit.
28277 * @param transit The transit object.
28278 * @param transition_cb The operation function.
28279 * @param effect The context data of the effect.
28283 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);
28286 * Add new object to apply the effects.
28288 * @note After the first addition of an object in @p transit, if its
28289 * object list become empty again, the @p transit will be killed by
28290 * elm_transit_del(transit) function.
28291 * @note If the @p obj belongs to another transit, the @p obj will be
28292 * removed from it and it will only belong to the @p transit. If the old
28293 * transit stays without objects, it will die.
28294 * @note When you add an object into the @p transit, its state from
28295 * evas_object_pass_events_get(obj) is saved, and it is applied when the
28296 * transit ends, if you change this state whith evas_object_pass_events_set()
28297 * after add the object, this state will change again when @p transit stops to
28300 * @param transit The transit object.
28301 * @param obj Object to be animated.
28304 * @warning It is not allowed to add a new object after transit begins to go.
28306 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28309 * Removes an added object from the transit.
28311 * @note If the @p obj is not in the @p transit, nothing is done.
28312 * @note If the list become empty, this function will call
28313 * elm_transit_del(transit), that is, it will kill the @p transit.
28315 * @param transit The transit object.
28316 * @param obj Object to be removed from @p transit.
28319 * @warning It is not allowed to remove objects after transit begins to go.
28321 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28324 * Get the objects of the transit.
28326 * @param transit The transit object.
28327 * @return a Eina_List with the objects from the transit.
28331 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28334 * Enable/disable keeping up the objects states.
28335 * If it is not kept, the objects states will be reset when transition ends.
28337 * @note @p transit can not be NULL.
28338 * @note One state includes geometry, color, map data.
28340 * @param transit The transit object.
28341 * @param state_keep Keeping or Non Keeping.
28345 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
28348 * Get a value whether the objects states will be reset or not.
28350 * @note @p transit can not be NULL
28352 * @see elm_transit_objects_final_state_keep_set()
28354 * @param transit The transit object.
28355 * @return EINA_TRUE means the states of the objects will be reset.
28356 * If @p transit is NULL, EINA_FALSE is returned
28360 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28363 * Set the event enabled when transit is operating.
28365 * If @p enabled is EINA_TRUE, the objects of the transit will receives
28366 * events from mouse and keyboard during the animation.
28367 * @note When you add an object with elm_transit_object_add(), its state from
28368 * evas_object_pass_events_get(obj) is saved, and it is applied when the
28369 * transit ends, if you change this state with evas_object_pass_events_set()
28370 * after adding the object, this state will change again when @p transit stops
28373 * @param transit The transit object.
28374 * @param enabled Events are received when enabled is @c EINA_TRUE, and
28375 * ignored otherwise.
28379 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
28382 * Get the value of event enabled status.
28384 * @see elm_transit_event_enabled_set()
28386 * @param transit The Transit object
28387 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
28388 * EINA_FALSE is returned
28392 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28395 * Set the user-callback function when the transit is deleted.
28397 * @note Using this function twice will overwrite the first function setted.
28398 * @note the @p transit object will be deleted after call @p cb function.
28400 * @param transit The transit object.
28401 * @param cb Callback function pointer. This function will be called before
28402 * the deletion of the transit.
28403 * @param data Callback funtion user data. It is the @p op parameter.
28407 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
28410 * Set reverse effect automatically.
28412 * If auto reverse is setted, after running the effects with the progress
28413 * parameter from 0 to 1, it will call the effecs again with the progress
28414 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
28415 * where the duration was setted with the function elm_transit_add and
28416 * the repeat with the function elm_transit_repeat_times_set().
28418 * @param transit The transit object.
28419 * @param reverse EINA_TRUE means the auto_reverse is on.
28423 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
28426 * Get if the auto reverse is on.
28428 * @see elm_transit_auto_reverse_set()
28430 * @param transit The transit object.
28431 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
28432 * EINA_FALSE is returned
28436 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28439 * Set the transit repeat count. Effect will be repeated by repeat count.
28441 * This function sets the number of repetition the transit will run after
28442 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
28443 * If the @p repeat is a negative number, it will repeat infinite times.
28445 * @note If this function is called during the transit execution, the transit
28446 * will run @p repeat times, ignoring the times it already performed.
28448 * @param transit The transit object
28449 * @param repeat Repeat count
28453 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
28456 * Get the transit repeat count.
28458 * @see elm_transit_repeat_times_set()
28460 * @param transit The Transit object.
28461 * @return The repeat count. If @p transit is NULL
28466 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28469 * Set the transit animation acceleration type.
28471 * This function sets the tween mode of the transit that can be:
28472 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
28473 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
28474 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
28475 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
28477 * @param transit The transit object.
28478 * @param tween_mode The tween type.
28482 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
28485 * Get the transit animation acceleration type.
28487 * @note @p transit can not be NULL
28489 * @param transit The transit object.
28490 * @return The tween type. If @p transit is NULL
28491 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
28495 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28498 * Set the transit animation time
28500 * @note @p transit can not be NULL
28502 * @param transit The transit object.
28503 * @param duration The animation time.
28507 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
28510 * Get the transit animation time
28512 * @note @p transit can not be NULL
28514 * @param transit The transit object.
28516 * @return The transit animation time.
28520 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28523 * Starts the transition.
28524 * Once this API is called, the transit begins to measure the time.
28526 * @note @p transit can not be NULL
28528 * @param transit The transit object.
28532 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28535 * Pause/Resume the transition.
28537 * If you call elm_transit_go again, the transit will be started from the
28538 * beginning, and will be unpaused.
28540 * @note @p transit can not be NULL
28542 * @param transit The transit object.
28543 * @param paused Whether the transition should be paused or not.
28547 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
28550 * Get the value of paused status.
28552 * @see elm_transit_paused_set()
28554 * @note @p transit can not be NULL
28556 * @param transit The transit object.
28557 * @return EINA_TRUE means transition is paused. If @p transit is NULL
28558 * EINA_FALSE is returned
28562 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28565 * Get the time progression of the animation (a double value between 0.0 and 1.0).
28567 * The value returned is a fraction (current time / total time). It
28568 * represents the progression position relative to the total.
28570 * @note @p transit can not be NULL
28572 * @param transit The transit object.
28574 * @return The time progression value. If @p transit is NULL
28579 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28582 * Makes the chain relationship between two transits.
28584 * @note @p transit can not be NULL. Transit would have multiple chain transits.
28585 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
28587 * @param transit The transit object.
28588 * @param chain_transit The chain transit object. This transit will be operated
28589 * after transit is done.
28591 * This function adds @p chain_transit transition to a chain after the @p
28592 * transit, and will be started as soon as @p transit ends. See @ref
28593 * transit_example_02_explained for a full example.
28597 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
28600 * Cut off the chain relationship between two transits.
28602 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
28603 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
28605 * @param transit The transit object.
28606 * @param chain_transit The chain transit object.
28608 * This function remove the @p chain_transit transition from the @p transit.
28612 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
28615 * Get the current chain transit list.
28617 * @note @p transit can not be NULL.
28619 * @param transit The transit object.
28620 * @return chain transit list.
28624 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
28627 * Add the Resizing Effect to Elm_Transit.
28629 * @note This API is one of the facades. It creates resizing effect context
28630 * and add it's required APIs to elm_transit_effect_add.
28632 * @see elm_transit_effect_add()
28634 * @param transit Transit object.
28635 * @param from_w Object width size when effect begins.
28636 * @param from_h Object height size when effect begins.
28637 * @param to_w Object width size when effect ends.
28638 * @param to_h Object height size when effect ends.
28639 * @return Resizing effect context data.
28643 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);
28646 * Add the Translation Effect to Elm_Transit.
28648 * @note This API is one of the facades. It creates translation effect context
28649 * and add it's required APIs to elm_transit_effect_add.
28651 * @see elm_transit_effect_add()
28653 * @param transit Transit object.
28654 * @param from_dx X Position variation when effect begins.
28655 * @param from_dy Y Position variation when effect begins.
28656 * @param to_dx X Position variation when effect ends.
28657 * @param to_dy Y Position variation when effect ends.
28658 * @return Translation effect context data.
28661 * @warning It is highly recommended just create a transit with this effect when
28662 * the window that the objects of the transit belongs has already been created.
28663 * This is because this effect needs the geometry information about the objects,
28664 * and if the window was not created yet, it can get a wrong information.
28666 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);
28669 * Add the Zoom Effect to Elm_Transit.
28671 * @note This API is one of the facades. It creates zoom effect context
28672 * and add it's required APIs to elm_transit_effect_add.
28674 * @see elm_transit_effect_add()
28676 * @param transit Transit object.
28677 * @param from_rate Scale rate when effect begins (1 is current rate).
28678 * @param to_rate Scale rate when effect ends.
28679 * @return Zoom effect context data.
28682 * @warning It is highly recommended just create a transit with this effect when
28683 * the window that the objects of the transit belongs has already been created.
28684 * This is because this effect needs the geometry information about the objects,
28685 * and if the window was not created yet, it can get a wrong information.
28687 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
28690 * Add the Flip Effect to Elm_Transit.
28692 * @note This API is one of the facades. It creates flip effect context
28693 * and add it's required APIs to elm_transit_effect_add.
28694 * @note This effect is applied to each pair of objects in the order they are listed
28695 * in the transit list of objects. The first object in the pair will be the
28696 * "front" object and the second will be the "back" object.
28698 * @see elm_transit_effect_add()
28700 * @param transit Transit object.
28701 * @param axis Flipping Axis(X or Y).
28702 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28703 * @return Flip effect context data.
28706 * @warning It is highly recommended just create a transit with this effect when
28707 * the window that the objects of the transit belongs has already been created.
28708 * This is because this effect needs the geometry information about the objects,
28709 * and if the window was not created yet, it can get a wrong information.
28711 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28714 * Add the Resizable Flip Effect to Elm_Transit.
28716 * @note This API is one of the facades. It creates resizable flip effect context
28717 * and add it's required APIs to elm_transit_effect_add.
28718 * @note This effect is applied to each pair of objects in the order they are listed
28719 * in the transit list of objects. The first object in the pair will be the
28720 * "front" object and the second will be the "back" object.
28722 * @see elm_transit_effect_add()
28724 * @param transit Transit object.
28725 * @param axis Flipping Axis(X or Y).
28726 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28727 * @return Resizable flip effect context data.
28730 * @warning It is highly recommended just create a transit with this effect when
28731 * the window that the objects of the transit belongs has already been created.
28732 * This is because this effect needs the geometry information about the objects,
28733 * and if the window was not created yet, it can get a wrong information.
28735 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28738 * Add the Wipe Effect to Elm_Transit.
28740 * @note This API is one of the facades. It creates wipe effect context
28741 * and add it's required APIs to elm_transit_effect_add.
28743 * @see elm_transit_effect_add()
28745 * @param transit Transit object.
28746 * @param type Wipe type. Hide or show.
28747 * @param dir Wipe Direction.
28748 * @return Wipe effect context data.
28751 * @warning It is highly recommended just create a transit with this effect when
28752 * the window that the objects of the transit belongs has already been created.
28753 * This is because this effect needs the geometry information about the objects,
28754 * and if the window was not created yet, it can get a wrong information.
28756 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
28759 * Add the Color Effect to Elm_Transit.
28761 * @note This API is one of the facades. It creates color effect context
28762 * and add it's required APIs to elm_transit_effect_add.
28764 * @see elm_transit_effect_add()
28766 * @param transit Transit object.
28767 * @param from_r RGB R when effect begins.
28768 * @param from_g RGB G when effect begins.
28769 * @param from_b RGB B when effect begins.
28770 * @param from_a RGB A when effect begins.
28771 * @param to_r RGB R when effect ends.
28772 * @param to_g RGB G when effect ends.
28773 * @param to_b RGB B when effect ends.
28774 * @param to_a RGB A when effect ends.
28775 * @return Color effect context data.
28779 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);
28782 * Add the Fade Effect to Elm_Transit.
28784 * @note This API is one of the facades. It creates fade effect context
28785 * and add it's required APIs to elm_transit_effect_add.
28786 * @note This effect is applied to each pair of objects in the order they are listed
28787 * in the transit list of objects. The first object in the pair will be the
28788 * "before" object and the second will be the "after" object.
28790 * @see elm_transit_effect_add()
28792 * @param transit Transit object.
28793 * @return Fade effect context data.
28796 * @warning It is highly recommended just create a transit with this effect when
28797 * the window that the objects of the transit belongs has already been created.
28798 * This is because this effect needs the color information about the objects,
28799 * and if the window was not created yet, it can get a wrong information.
28801 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
28804 * Add the Blend Effect to Elm_Transit.
28806 * @note This API is one of the facades. It creates blend effect context
28807 * and add it's required APIs to elm_transit_effect_add.
28808 * @note This effect is applied to each pair of objects in the order they are listed
28809 * in the transit list of objects. The first object in the pair will be the
28810 * "before" object and the second will be the "after" object.
28812 * @see elm_transit_effect_add()
28814 * @param transit Transit object.
28815 * @return Blend effect context data.
28818 * @warning It is highly recommended just create a transit with this effect when
28819 * the window that the objects of the transit belongs has already been created.
28820 * This is because this effect needs the color information about the objects,
28821 * and if the window was not created yet, it can get a wrong information.
28823 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
28826 * Add the Rotation Effect to Elm_Transit.
28828 * @note This API is one of the facades. It creates rotation effect context
28829 * and add it's required APIs to elm_transit_effect_add.
28831 * @see elm_transit_effect_add()
28833 * @param transit Transit object.
28834 * @param from_degree Degree when effect begins.
28835 * @param to_degree Degree when effect is ends.
28836 * @return Rotation effect context data.
28839 * @warning It is highly recommended just create a transit with this effect when
28840 * the window that the objects of the transit belongs has already been created.
28841 * This is because this effect needs the geometry information about the objects,
28842 * and if the window was not created yet, it can get a wrong information.
28844 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28847 * Add the ImageAnimation Effect to Elm_Transit.
28849 * @note This API is one of the facades. It creates image animation effect context
28850 * and add it's required APIs to elm_transit_effect_add.
28851 * The @p images parameter is a list images paths. This list and
28852 * its contents will be deleted at the end of the effect by
28853 * elm_transit_effect_image_animation_context_free() function.
28857 * char buf[PATH_MAX];
28858 * Eina_List *images = NULL;
28859 * Elm_Transit *transi = elm_transit_add();
28861 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28862 * images = eina_list_append(images, eina_stringshare_add(buf));
28864 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28865 * images = eina_list_append(images, eina_stringshare_add(buf));
28866 * elm_transit_effect_image_animation_add(transi, images);
28870 * @see elm_transit_effect_add()
28872 * @param transit Transit object.
28873 * @param images Eina_List of images file paths. This list and
28874 * its contents will be deleted at the end of the effect by
28875 * elm_transit_effect_image_animation_context_free() function.
28876 * @return Image Animation effect context data.
28880 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28885 typedef struct _Elm_Store Elm_Store;
28886 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
28887 typedef struct _Elm_Store_Item Elm_Store_Item;
28888 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
28889 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
28890 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28891 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
28892 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
28893 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
28894 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
28895 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
28897 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28898 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28899 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28900 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28904 ELM_STORE_ITEM_MAPPING_NONE = 0,
28905 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
28906 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
28907 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
28908 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
28909 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
28910 // can add more here as needed by common apps
28911 ELM_STORE_ITEM_MAPPING_LAST
28912 } Elm_Store_Item_Mapping_Type;
28914 struct _Elm_Store_Item_Mapping_Icon
28916 // FIXME: allow edje file icons
28918 Elm_Icon_Lookup_Order lookup_order;
28919 Eina_Bool standard_name : 1;
28920 Eina_Bool no_scale : 1;
28921 Eina_Bool smooth : 1;
28922 Eina_Bool scale_up : 1;
28923 Eina_Bool scale_down : 1;
28926 struct _Elm_Store_Item_Mapping_Empty
28931 struct _Elm_Store_Item_Mapping_Photo
28936 struct _Elm_Store_Item_Mapping_Custom
28938 Elm_Store_Item_Mapping_Cb func;
28941 struct _Elm_Store_Item_Mapping
28943 Elm_Store_Item_Mapping_Type type;
28948 Elm_Store_Item_Mapping_Empty empty;
28949 Elm_Store_Item_Mapping_Icon icon;
28950 Elm_Store_Item_Mapping_Photo photo;
28951 Elm_Store_Item_Mapping_Custom custom;
28952 // add more types here
28956 struct _Elm_Store_Item_Info
28958 Elm_Genlist_Item_Class *item_class;
28959 const Elm_Store_Item_Mapping *mapping;
28964 struct _Elm_Store_Item_Info_Filesystem
28966 Elm_Store_Item_Info base;
28970 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
28971 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
28973 EAPI void elm_store_free(Elm_Store *st);
28975 EAPI Elm_Store *elm_store_filesystem_new(void);
28976 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
28977 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28978 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28980 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
28982 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
28983 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28984 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28985 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28986 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
28987 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28989 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28990 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
28991 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28992 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
28993 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28994 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28995 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28998 * @defgroup SegmentControl SegmentControl
28999 * @ingroup Elementary
29001 * @image html img/widget/segment_control/preview-00.png
29002 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
29004 * @image html img/segment_control.png
29005 * @image latex img/segment_control.eps width=\textwidth
29007 * Segment control widget is a horizontal control made of multiple segment
29008 * items, each segment item functioning similar to discrete two state button.
29009 * A segment control groups the items together and provides compact
29010 * single button with multiple equal size segments.
29012 * Segment item size is determined by base widget
29013 * size and the number of items added.
29014 * Only one segment item can be at selected state. A segment item can display
29015 * combination of Text and any Evas_Object like Images or other widget.
29017 * Smart callbacks one can listen to:
29018 * - "changed" - When the user clicks on a segment item which is not
29019 * previously selected and get selected. The event_info parameter is the
29020 * segment item pointer.
29022 * Available styles for it:
29025 * Here is an example on its usage:
29026 * @li @ref segment_control_example
29030 * @addtogroup SegmentControl
29034 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
29037 * Add a new segment control widget to the given parent Elementary
29038 * (container) object.
29040 * @param parent The parent object.
29041 * @return a new segment control widget handle or @c NULL, on errors.
29043 * This function inserts a new segment control widget on the canvas.
29045 * @ingroup SegmentControl
29047 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29050 * Append a new item to the segment control object.
29052 * @param obj The segment control object.
29053 * @param icon The icon object to use for the left side of the item. An
29054 * icon can be any Evas object, but usually it is an icon created
29055 * with elm_icon_add().
29056 * @param label The label of the item.
29057 * Note that, NULL is different from empty string "".
29058 * @return The created item or @c NULL upon failure.
29060 * A new item will be created and appended to the segment control, i.e., will
29061 * be set as @b last item.
29063 * If it should be inserted at another position,
29064 * elm_segment_control_item_insert_at() should be used instead.
29066 * Items created with this function can be deleted with function
29067 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29069 * @note @p label set to @c NULL is different from empty string "".
29071 * only has icon, it will be displayed bigger and centered. If it has
29072 * icon and label, even that an empty string, icon will be smaller and
29073 * positioned at left.
29077 * sc = elm_segment_control_add(win);
29078 * ic = elm_icon_add(win);
29079 * elm_icon_file_set(ic, "path/to/image", NULL);
29080 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
29081 * elm_segment_control_item_add(sc, ic, "label");
29082 * evas_object_show(sc);
29085 * @see elm_segment_control_item_insert_at()
29086 * @see elm_segment_control_item_del()
29088 * @ingroup SegmentControl
29090 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
29093 * Insert a new item to the segment control object at specified position.
29095 * @param obj The segment control object.
29096 * @param icon The icon object to use for the left side of the item. An
29097 * icon can be any Evas object, but usually it is an icon created
29098 * with elm_icon_add().
29099 * @param label The label of the item.
29100 * @param index Item position. Value should be between 0 and items count.
29101 * @return The created item or @c NULL upon failure.
29103 * Index values must be between @c 0, when item will be prepended to
29104 * segment control, and items count, that can be get with
29105 * elm_segment_control_item_count_get(), case when item will be appended
29106 * to segment control, just like elm_segment_control_item_add().
29108 * Items created with this function can be deleted with function
29109 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29111 * @note @p label set to @c NULL is different from empty string "".
29113 * only has icon, it will be displayed bigger and centered. If it has
29114 * icon and label, even that an empty string, icon will be smaller and
29115 * positioned at left.
29117 * @see elm_segment_control_item_add()
29118 * @see elm_segment_control_item_count_get()
29119 * @see elm_segment_control_item_del()
29121 * @ingroup SegmentControl
29123 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);
29126 * Remove a segment control item from its parent, deleting it.
29128 * @param it The item to be removed.
29130 * Items can be added with elm_segment_control_item_add() or
29131 * elm_segment_control_item_insert_at().
29133 * @ingroup SegmentControl
29135 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29138 * Remove a segment control item at given index from its parent,
29141 * @param obj The segment control object.
29142 * @param index The position of the segment control item to be deleted.
29144 * Items can be added with elm_segment_control_item_add() or
29145 * elm_segment_control_item_insert_at().
29147 * @ingroup SegmentControl
29149 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29152 * Get the Segment items count from segment control.
29154 * @param obj The segment control object.
29155 * @return Segment items count.
29157 * It will just return the number of items added to segment control @p obj.
29159 * @ingroup SegmentControl
29161 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29164 * Get the item placed at specified index.
29166 * @param obj The segment control object.
29167 * @param index The index of the segment item.
29168 * @return The segment control item or @c NULL on failure.
29170 * Index is the position of an item in segment control widget. Its
29171 * range is from @c 0 to <tt> count - 1 </tt>.
29172 * Count is the number of items, that can be get with
29173 * elm_segment_control_item_count_get().
29175 * @ingroup SegmentControl
29177 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29180 * Get the label of item.
29182 * @param obj The segment control object.
29183 * @param index The index of the segment item.
29184 * @return The label of the item at @p index.
29186 * The return value is a pointer to the label associated to the item when
29187 * it was created, with function elm_segment_control_item_add(), or later
29188 * with function elm_segment_control_item_label_set. If no label
29189 * was passed as argument, it will return @c NULL.
29191 * @see elm_segment_control_item_label_set() for more details.
29192 * @see elm_segment_control_item_add()
29194 * @ingroup SegmentControl
29196 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29199 * Set the label of item.
29201 * @param it The item of segment control.
29202 * @param text The label of item.
29204 * The label to be displayed by the item.
29205 * Label will be at right of the icon (if set).
29207 * If a label was passed as argument on item creation, with function
29208 * elm_control_segment_item_add(), it will be already
29209 * displayed by the item.
29211 * @see elm_segment_control_item_label_get()
29212 * @see elm_segment_control_item_add()
29214 * @ingroup SegmentControl
29216 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
29219 * Get the icon associated to the item.
29221 * @param obj The segment control object.
29222 * @param index The index of the segment item.
29223 * @return The left side icon associated to the item at @p index.
29225 * The return value is a pointer to the icon associated to the item when
29226 * it was created, with function elm_segment_control_item_add(), or later
29227 * with function elm_segment_control_item_icon_set(). If no icon
29228 * was passed as argument, it will return @c NULL.
29230 * @see elm_segment_control_item_add()
29231 * @see elm_segment_control_item_icon_set()
29233 * @ingroup SegmentControl
29235 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29238 * Set the icon associated to the item.
29240 * @param it The segment control item.
29241 * @param icon The icon object to associate with @p it.
29243 * The icon object to use at left side of the item. An
29244 * icon can be any Evas object, but usually it is an icon created
29245 * with elm_icon_add().
29247 * Once the icon object is set, a previously set one will be deleted.
29248 * @warning Setting the same icon for two items will cause the icon to
29249 * dissapear from the first item.
29251 * If an icon was passed as argument on item creation, with function
29252 * elm_segment_control_item_add(), it will be already
29253 * associated to the item.
29255 * @see elm_segment_control_item_add()
29256 * @see elm_segment_control_item_icon_get()
29258 * @ingroup SegmentControl
29260 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
29263 * Get the index of an item.
29265 * @param it The segment control item.
29266 * @return The position of item in segment control widget.
29268 * Index is the position of an item in segment control widget. Its
29269 * range is from @c 0 to <tt> count - 1 </tt>.
29270 * Count is the number of items, that can be get with
29271 * elm_segment_control_item_count_get().
29273 * @ingroup SegmentControl
29275 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29278 * Get the base object of the item.
29280 * @param it The segment control item.
29281 * @return The base object associated with @p it.
29283 * Base object is the @c Evas_Object that represents that item.
29285 * @ingroup SegmentControl
29287 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29290 * Get the selected item.
29292 * @param obj The segment control object.
29293 * @return The selected item or @c NULL if none of segment items is
29296 * The selected item can be unselected with function
29297 * elm_segment_control_item_selected_set().
29299 * The selected item always will be highlighted on segment control.
29301 * @ingroup SegmentControl
29303 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29306 * Set the selected state of an item.
29308 * @param it The segment control item
29309 * @param select The selected state
29311 * This sets the selected state of the given item @p it.
29312 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
29314 * If a new item is selected the previosly selected will be unselected.
29315 * Previoulsy selected item can be get with function
29316 * elm_segment_control_item_selected_get().
29318 * The selected item always will be highlighted on segment control.
29320 * @see elm_segment_control_item_selected_get()
29322 * @ingroup SegmentControl
29324 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
29331 * @defgroup Grid Grid
29333 * The grid is a grid layout widget that lays out a series of children as a
29334 * fixed "grid" of widgets using a given percentage of the grid width and
29335 * height each using the child object.
29337 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
29338 * widgets size itself. The default is 100 x 100, so that means the
29339 * position and sizes of children will effectively be percentages (0 to 100)
29340 * of the width or height of the grid widget
29346 * Add a new grid to the parent
29348 * @param parent The parent object
29349 * @return The new object or NULL if it cannot be created
29353 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
29356 * Set the virtual size of the grid
29358 * @param obj The grid object
29359 * @param w The virtual width of the grid
29360 * @param h The virtual height of the grid
29364 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
29367 * Get the virtual size of the grid
29369 * @param obj The grid object
29370 * @param w Pointer to integer to store the virtual width of the grid
29371 * @param h Pointer to integer to store the virtual height of the grid
29375 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
29378 * Pack child at given position and size
29380 * @param obj The grid object
29381 * @param subobj The child to pack
29382 * @param x The virtual x coord at which to pack it
29383 * @param y The virtual y coord at which to pack it
29384 * @param w The virtual width at which to pack it
29385 * @param h The virtual height at which to pack it
29389 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
29392 * Unpack a child from a grid object
29394 * @param obj The grid object
29395 * @param subobj The child to unpack
29399 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
29402 * Faster way to remove all child objects from a grid object.
29404 * @param obj The grid object
29405 * @param clear If true, it will delete just removed children
29409 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
29412 * Set packing of an existing child at to position and size
29414 * @param subobj The child to set packing of
29415 * @param x The virtual x coord at which to pack it
29416 * @param y The virtual y coord at which to pack it
29417 * @param w The virtual width at which to pack it
29418 * @param h The virtual height at which to pack it
29422 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
29425 * get packing of a child
29427 * @param subobj The child to query
29428 * @param x Pointer to integer to store the virtual x coord
29429 * @param y Pointer to integer to store the virtual y coord
29430 * @param w Pointer to integer to store the virtual width
29431 * @param h Pointer to integer to store the virtual height
29435 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
29441 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
29442 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
29443 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
29444 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
29445 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
29446 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
29449 * @defgroup Video Video
29451 * @addtogroup Video
29454 * Elementary comes with two object that help design application that need
29455 * to display video. The main one, Elm_Video, display a video by using Emotion.
29456 * It does embedded the video inside an Edje object, so you can do some
29457 * animation depending on the video state change. It does also implement a
29458 * ressource management policy to remove this burden from the application writer.
29460 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
29461 * It take care of updating its content according to Emotion event and provide a
29462 * way to theme itself. It also does automatically raise the priority of the
29463 * linked Elm_Video so it will use the video decoder if available. It also does
29464 * activate the remember function on the linked Elm_Video object.
29466 * Signals that you can add callback for are :
29468 * "forward,clicked" - the user clicked the forward button.
29469 * "info,clicked" - the user clicked the info button.
29470 * "next,clicked" - the user clicked the next button.
29471 * "pause,clicked" - the user clicked the pause button.
29472 * "play,clicked" - the user clicked the play button.
29473 * "prev,clicked" - the user clicked the prev button.
29474 * "rewind,clicked" - the user clicked the rewind button.
29475 * "stop,clicked" - the user clicked the stop button.
29477 * Default contents parts of the player widget that you can use for are:
29478 * @li "video" - A video of the player
29483 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
29485 * @param parent The parent object
29486 * @return a new player widget handle or @c NULL, on errors.
29488 * This function inserts a new player widget on the canvas.
29490 * @see elm_object_part_content_set()
29494 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
29497 * @brief Link a Elm_Payer with an Elm_Video object.
29499 * @param player the Elm_Player object.
29500 * @param video The Elm_Video object.
29502 * This mean that action on the player widget will affect the
29503 * video object and the state of the video will be reflected in
29504 * the player itself.
29506 * @see elm_player_add()
29507 * @see elm_video_add()
29508 * @deprecated use elm_object_part_content_set() instead
29512 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
29515 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
29517 * @param parent The parent object
29518 * @return a new video widget handle or @c NULL, on errors.
29520 * This function inserts a new video widget on the canvas.
29522 * @seeelm_video_file_set()
29523 * @see elm_video_uri_set()
29527 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
29530 * @brief Define the file that will be the video source.
29532 * @param video The video object to define the file for.
29533 * @param filename The file to target.
29535 * This function will explicitly define a filename as a source
29536 * for the video of the Elm_Video object.
29538 * @see elm_video_uri_set()
29539 * @see elm_video_add()
29540 * @see elm_player_add()
29544 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
29547 * @brief Define the uri that will be the video source.
29549 * @param video The video object to define the file for.
29550 * @param uri The uri to target.
29552 * This function will define an uri as a source for the video of the
29553 * Elm_Video object. URI could be remote source of video, like http:// or local source
29554 * like for example WebCam who are most of the time v4l2:// (but that depend and
29555 * you should use Emotion API to request and list the available Webcam on your system).
29557 * @see elm_video_file_set()
29558 * @see elm_video_add()
29559 * @see elm_player_add()
29563 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
29566 * @brief Get the underlying Emotion object.
29568 * @param video The video object to proceed the request on.
29569 * @return the underlying Emotion object.
29573 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
29576 * @brief Start to play the video
29578 * @param video The video object to proceed the request on.
29580 * Start to play the video and cancel all suspend state.
29584 EAPI void elm_video_play(Evas_Object *video);
29587 * @brief Pause the video
29589 * @param video The video object to proceed the request on.
29591 * Pause the video and start a timer to trigger suspend mode.
29595 EAPI void elm_video_pause(Evas_Object *video);
29598 * @brief Stop the video
29600 * @param video The video object to proceed the request on.
29602 * Stop the video and put the emotion in deep sleep mode.
29606 EAPI void elm_video_stop(Evas_Object *video);
29609 * @brief Is the video actually playing.
29611 * @param video The video object to proceed the request on.
29612 * @return EINA_TRUE if the video is actually playing.
29614 * You should consider watching event on the object instead of polling
29615 * the object state.
29619 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
29622 * @brief Is it possible to seek inside the video.
29624 * @param video The video object to proceed the request on.
29625 * @return EINA_TRUE if is possible to seek inside the video.
29629 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
29632 * @brief Is the audio muted.
29634 * @param video The video object to proceed the request on.
29635 * @return EINA_TRUE if the audio is muted.
29639 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
29642 * @brief Change the mute state of the Elm_Video object.
29644 * @param video The video object to proceed the request on.
29645 * @param mute The new mute state.
29649 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
29652 * @brief Get the audio level of the current video.
29654 * @param video The video object to proceed the request on.
29655 * @return the current audio level.
29659 EAPI double elm_video_audio_level_get(const Evas_Object *video);
29662 * @brief Set the audio level of anElm_Video object.
29664 * @param video The video object to proceed the request on.
29665 * @param volume The new audio volume.
29669 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
29671 EAPI double elm_video_play_position_get(const Evas_Object *video);
29672 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
29673 EAPI double elm_video_play_length_get(const Evas_Object *video);
29674 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
29675 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
29676 EAPI const char *elm_video_title_get(const Evas_Object *video);
29682 * @defgroup Naviframe Naviframe
29683 * @ingroup Elementary
29685 * @brief Naviframe is a kind of view manager for the applications.
29687 * Naviframe provides functions to switch different pages with stack
29688 * mechanism. It means if one page(item) needs to be changed to the new one,
29689 * then naviframe would push the new page to it's internal stack. Of course,
29690 * it can be back to the previous page by popping the top page. Naviframe
29691 * provides some transition effect while the pages are switching (same as
29694 * Since each item could keep the different styles, users could keep the
29695 * same look & feel for the pages or different styles for the items in it's
29698 * Signals that you can add callback for are:
29699 * @li "transition,finished" - When the transition is finished in changing
29701 * @li "title,clicked" - User clicked title area
29703 * Default contents parts of the naviframe items that you can use for are:
29704 * @li "default" - A main content of the page
29705 * @li "icon" - An icon in the title area
29706 * @li "prev_btn" - A button to go to the previous page
29707 * @li "next_btn" - A button to go to the next page
29709 * Default text parts of the naviframe items that you can use for are:
29710 * @li "default" - Title label in the title area
29711 * @li "subtitle" - Sub-title label in the title area
29713 * Supported elm_object common APIs.
29714 * @li elm_object_signal_emit
29716 * Supported elm_object_item common APIs.
29717 * @li elm_object_item_text_set
29718 * @li elm_object_item_part_text_set
29719 * @li elm_object_item_text_get
29720 * @li elm_object_item_part_text_get
29721 * @li elm_object_item_content_set
29722 * @li elm_object_item_part_content_set
29723 * @li elm_object_item_content_get
29724 * @li elm_object_item_part_content_get
29725 * @li elm_object_item_content_unset
29726 * @li elm_object_item_part_content_unset
29727 * @li elm_object_item_signal_emit
29729 * @ref tutorial_naviframe gives a good overview of the usage of the API.
29733 * @addtogroup Naviframe
29738 * @brief Add a new Naviframe object to the parent.
29740 * @param parent Parent object
29741 * @return New object or @c NULL, if it cannot be created
29743 * @ingroup Naviframe
29745 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29748 * @brief Push a new item to the top of the naviframe stack (and show it).
29750 * @param obj The naviframe object
29751 * @param title_label The label in the title area. The name of the title
29752 * label part is "elm.text.title"
29753 * @param prev_btn The button to go to the previous item. If it is NULL,
29754 * then naviframe will create a back button automatically. The name of
29755 * the prev_btn part is "elm.swallow.prev_btn"
29756 * @param next_btn The button to go to the next item. Or It could be just an
29757 * extra function button. The name of the next_btn part is
29758 * "elm.swallow.next_btn"
29759 * @param content The main content object. The name of content part is
29760 * "elm.swallow.content"
29761 * @param item_style The current item style name. @c NULL would be default.
29762 * @return The created item or @c NULL upon failure.
29764 * The item pushed becomes one page of the naviframe, this item will be
29765 * deleted when it is popped.
29767 * @see also elm_naviframe_item_style_set()
29768 * @see also elm_naviframe_item_insert_before()
29769 * @see also elm_naviframe_item_insert_after()
29771 * The following styles are available for this item:
29774 * @ingroup Naviframe
29776 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);
29779 * @brief Insert a new item into the naviframe before item @p before.
29781 * @param before The naviframe item to insert before.
29782 * @param title_label The label in the title area. The name of the title
29783 * label part is "elm.text.title"
29784 * @param prev_btn The button to go to the previous item. If it is NULL,
29785 * then naviframe will create a back button automatically. The name of
29786 * the prev_btn part is "elm.swallow.prev_btn"
29787 * @param next_btn The button to go to the next item. Or It could be just an
29788 * extra function button. The name of the next_btn part is
29789 * "elm.swallow.next_btn"
29790 * @param content The main content object. The name of content part is
29791 * "elm.swallow.content"
29792 * @param item_style The current item style name. @c NULL would be default.
29793 * @return The created item or @c NULL upon failure.
29795 * The item is inserted into the naviframe straight away without any
29796 * transition operations. This item will be deleted when it is popped.
29798 * @see also elm_naviframe_item_style_set()
29799 * @see also elm_naviframe_item_push()
29800 * @see also elm_naviframe_item_insert_after()
29802 * The following styles are available for this item:
29805 * @ingroup Naviframe
29807 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);
29810 * @brief Insert a new item into the naviframe after item @p after.
29812 * @param after The naviframe item to insert after.
29813 * @param title_label The label in the title area. The name of the title
29814 * label part is "elm.text.title"
29815 * @param prev_btn The button to go to the previous item. If it is NULL,
29816 * then naviframe will create a back button automatically. The name of
29817 * the prev_btn part is "elm.swallow.prev_btn"
29818 * @param next_btn The button to go to the next item. Or It could be just an
29819 * extra function button. The name of the next_btn part is
29820 * "elm.swallow.next_btn"
29821 * @param content The main content object. The name of content part is
29822 * "elm.swallow.content"
29823 * @param item_style The current item style name. @c NULL would be default.
29824 * @return The created item or @c NULL upon failure.
29826 * The item is inserted into the naviframe straight away without any
29827 * transition operations. This item will be deleted when it is popped.
29829 * @see also elm_naviframe_item_style_set()
29830 * @see also elm_naviframe_item_push()
29831 * @see also elm_naviframe_item_insert_before()
29833 * The following styles are available for this item:
29836 * @ingroup Naviframe
29838 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);
29841 * @brief Pop an item that is on top of the stack
29843 * @param obj The naviframe object
29844 * @return @c NULL or the content object(if the
29845 * elm_naviframe_content_preserve_on_pop_get is true).
29847 * This pops an item that is on the top(visible) of the naviframe, makes it
29848 * disappear, then deletes the item. The item that was underneath it on the
29849 * stack will become visible.
29851 * @see also elm_naviframe_content_preserve_on_pop_get()
29853 * @ingroup Naviframe
29855 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29858 * @brief Pop the items between the top and the above one on the given item.
29860 * @param it The naviframe item
29862 * @ingroup Naviframe
29864 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29867 * Promote an item already in the naviframe stack to the top of the stack
29869 * @param it The naviframe item
29871 * This will take the indicated item and promote it to the top of the stack
29872 * as if it had been pushed there. The item must already be inside the
29873 * naviframe stack to work.
29876 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29879 * @brief Delete the given item instantly.
29881 * @param it The naviframe item
29883 * This just deletes the given item from the naviframe item list instantly.
29884 * So this would not emit any signals for view transitions but just change
29885 * the current view if the given item is a top one.
29887 * @ingroup Naviframe
29889 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29892 * @brief preserve the content objects when items are popped.
29894 * @param obj The naviframe object
29895 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29897 * @see also elm_naviframe_content_preserve_on_pop_get()
29899 * @ingroup Naviframe
29901 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29904 * @brief Get a value whether preserve mode is enabled or not.
29906 * @param obj The naviframe object
29907 * @return If @c EINA_TRUE, preserve mode is enabled
29909 * @see also elm_naviframe_content_preserve_on_pop_set()
29911 * @ingroup Naviframe
29913 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29916 * @brief Get a top item on the naviframe stack
29918 * @param obj The naviframe object
29919 * @return The top item on the naviframe stack or @c NULL, if the stack is
29922 * @ingroup Naviframe
29924 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29927 * @brief Get a bottom item on the naviframe stack
29929 * @param obj The naviframe object
29930 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29933 * @ingroup Naviframe
29935 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29938 * @brief Set an item style
29940 * @param obj The naviframe item
29941 * @param item_style The current item style name. @c NULL would be default
29943 * The following styles are available for this item:
29946 * @see also elm_naviframe_item_style_get()
29948 * @ingroup Naviframe
29950 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29953 * @brief Get an item style
29955 * @param obj The naviframe item
29956 * @return The current item style name
29958 * @see also elm_naviframe_item_style_set()
29960 * @ingroup Naviframe
29962 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29965 * @brief Show/Hide the title area
29967 * @param it The naviframe item
29968 * @param visible If @c EINA_TRUE, title area will be visible, hidden
29971 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
29973 * @see also elm_naviframe_item_title_visible_get()
29975 * @ingroup Naviframe
29977 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29980 * @brief Get a value whether title area is visible or not.
29982 * @param it The naviframe item
29983 * @return If @c EINA_TRUE, title area is visible
29985 * @see also elm_naviframe_item_title_visible_set()
29987 * @ingroup Naviframe
29989 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29992 * @brief Set creating prev button automatically or not
29994 * @param obj The naviframe object
29995 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29996 * be created internally when you pass the @c NULL to the prev_btn
29997 * parameter in elm_naviframe_item_push
29999 * @see also elm_naviframe_item_push()
30001 * @ingroup Naviframe
30003 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
30006 * @brief Get a value whether prev button(back button) will be auto pushed or
30009 * @param obj The naviframe object
30010 * @return If @c EINA_TRUE, prev button will be auto pushed.
30012 * @see also elm_naviframe_item_push()
30013 * elm_naviframe_prev_btn_auto_pushed_set()
30015 * @ingroup Naviframe
30017 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30020 * @brief Get a list of all the naviframe items.
30022 * @param obj The naviframe object
30023 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
30024 * or @c NULL on failure.
30026 * @ingroup Naviframe
30028 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30031 * @brief Set the event enabled when pushing/popping items
30033 * If @c enabled is EINA_TRUE, the contents of the naviframe item will
30034 * receives events from mouse and keyboard during view changing such as
30037 * @param obj The naviframe object
30038 * @param enabled Events are received when enabled is @c EINA_TRUE, and
30039 * ignored otherwise.
30041 * @warning Events will be blocked by calling evas_object_freeze_events_set()
30042 * internally. So don't call the API whiling pushing/popping items.
30044 * @see elm_naviframe_event_enabled_get()
30045 * @see evas_object_freeze_events_set()
30047 * @ingroup Naviframe
30049 EAPI void elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
30052 * @brief Get the value of event enabled status.
30054 * @param obj The naviframe object
30055 * @return EINA_TRUE, when event is enabled
30057 * @see elm_naviframe_event_enabled_set()
30059 * @ingroup Naviframe
30061 EAPI Eina_Bool elm_naviframe_event_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30068 * @defgroup Multibuttonentry Multibuttonentry
30070 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
30071 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
30072 * a new button is added to the next row. When a text button is pressed, it will become focused.
30073 * Backspace removes the focus.
30074 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
30076 * Smart callbacks one can register:
30077 * - @c "item,selected" - when item is selected. May be called on backspace key.
30078 * - @c "item,added" - when a new multibuttonentry item is added.
30079 * - @c "item,deleted" - when a multibuttonentry item is deleted.
30080 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
30081 * - @c "clicked" - when multibuttonentry is clicked.
30082 * - @c "focused" - when multibuttonentry is focused.
30083 * - @c "unfocused" - when multibuttonentry is unfocused.
30084 * - @c "expanded" - when multibuttonentry is expanded.
30085 * - @c "shrank" - when multibuttonentry is shrank.
30086 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
30088 * Here is an example on its usage:
30089 * @li @ref multibuttonentry_example
30093 * @addtogroup Multibuttonentry
30097 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30098 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30101 * @brief Add a new multibuttonentry to the parent
30103 * @param parent The parent object
30104 * @return The new object or NULL if it cannot be created
30107 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30112 * @param obj The multibuttonentry object
30113 * @return The label, or NULL if none
30116 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30121 * @param obj The multibuttonentry object
30122 * @param label The text label string
30125 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
30128 * Get the entry of the multibuttonentry object
30130 * @param obj The multibuttonentry object
30131 * @return The entry object, or NULL if none
30134 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30137 * Get the guide text
30139 * @param obj The multibuttonentry object
30140 * @return The guide text, or NULL if none
30143 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30146 * Set the guide text
30148 * @param obj The multibuttonentry object
30149 * @param label The guide text string
30152 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
30155 * Get the value of shrink_mode state.
30157 * @param obj The multibuttonentry object
30158 * @param the value of shrink mode state.
30161 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30164 * Set/Unset the multibuttonentry to shrink mode state of single line
30166 * @param obj The multibuttonentry object
30167 * @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.
30170 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
30173 * Prepend a new item to the multibuttonentry
30175 * @param obj The multibuttonentry object
30176 * @param label The label of new item
30177 * @param data The ponter to the data to be attached
30178 * @return A handle to the item added or NULL if not possible
30181 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30184 * Append a new item to the multibuttonentry
30186 * @param obj The multibuttonentry object
30187 * @param label The label of new item
30188 * @param data The ponter to the data to be attached
30189 * @return A handle to the item added or NULL if not possible
30192 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30195 * Add a new item to the multibuttonentry before the indicated object
30198 * @param obj The multibuttonentry object
30199 * @param before The item before which to add it
30200 * @param label The label of new item
30201 * @param data The ponter to the data to be attached
30202 * @return A handle to the item added or NULL if not possible
30205 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);
30208 * Add a new item to the multibuttonentry after the indicated object
30210 * @param obj The multibuttonentry object
30211 * @param after The item after which to add it
30212 * @param label The label of new item
30213 * @param data The ponter to the data to be attached
30214 * @return A handle to the item added or NULL if not possible
30217 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);
30220 * Get a list of items in the multibuttonentry
30222 * @param obj The multibuttonentry object
30223 * @return The list of items, or NULL if none
30226 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30229 * Get the first item in the multibuttonentry
30231 * @param obj The multibuttonentry object
30232 * @return The first item, or NULL if none
30235 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30238 * Get the last item in the multibuttonentry
30240 * @param obj The multibuttonentry object
30241 * @return The last item, or NULL if none
30244 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30247 * Get the selected item in the multibuttonentry
30249 * @param obj The multibuttonentry object
30250 * @return The selected item, or NULL if none
30253 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30256 * Set the selected state of an item
30258 * @param item The item
30259 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30262 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
30265 * unselect all items.
30267 * @param obj The multibuttonentry object
30270 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
30273 * Delete a given item
30275 * @param item The item
30278 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30281 * Remove all items in the multibuttonentry.
30283 * @param obj The multibuttonentry object
30286 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
30289 * Get the label of a given item
30291 * @param item The item
30292 * @return The label of a given item, or NULL if none
30295 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30298 * Set the label of a given item
30300 * @param item The item
30301 * @param label The text label string
30304 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
30307 * Get the previous item in the multibuttonentry
30309 * @param item The item
30310 * @return The item before the item @p item
30313 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30316 * Get the next item in the multibuttonentry
30318 * @param item The item
30319 * @return The item after the item @p item
30322 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30325 * Append a item filter function for text inserted in the Multibuttonentry
30327 * Append the given callback to the list. This functions will be called
30328 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
30329 * as a parameter. The callback function is free to alter the text in any way
30330 * it wants, but it must remember to free the given pointer and update it.
30331 * If the new text is to be discarded, the function can free it and set it text
30332 * parameter to NULL. This will also prevent any following filters from being
30335 * @param obj The multibuttonentryentry object
30336 * @param func The function to use as item filter
30337 * @param data User data to pass to @p func
30340 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30343 * Prepend a filter function for text inserted in the Multibuttentry
30345 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
30346 * for more information
30348 * @param obj The multibuttonentry object
30349 * @param func The function to use as text filter
30350 * @param data User data to pass to @p func
30353 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30356 * Remove a filter from the list
30358 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
30359 * for more information.
30361 * @param obj The multibuttonentry object
30362 * @param func The filter function to remove
30363 * @param data The user data passed when adding the function
30366 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);