3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
271 @author Tiago Falcão <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 #define WILL_DEPRECATE /* API is deprecated in upstream EFL, will be deprecated in SLP soon */
426 /* allow usage from c++ */
431 #define ELM_VERSION_MAJOR @VMAJ@
432 #define ELM_VERSION_MINOR @VMIN@
434 typedef struct _Elm_Version
442 EAPI extern Elm_Version *elm_version;
445 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
446 #define ELM_PI 3.14159265358979323846
449 * @defgroup General General
451 * @brief General Elementary API. Functions that don't relate to
452 * Elementary objects specifically.
454 * Here are documented functions which init/shutdown the library,
455 * that apply to generic Elementary objects, that deal with
456 * configuration, et cetera.
458 * @ref general_functions_example_page "This" example contemplates
459 * some of these functions.
463 * @addtogroup General
468 * Defines couple of standard Evas_Object layers to be used
469 * with evas_object_layer_set().
471 * @note whenever extending with new values, try to keep some padding
472 * to siblings so there is room for further extensions.
474 typedef enum _Elm_Object_Layer
476 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
477 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
478 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
479 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
480 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
481 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
484 /**************************************************************************/
485 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
488 * Emitted when any Elementary's policy value is changed.
490 EAPI extern int ELM_EVENT_POLICY_CHANGED;
493 * @typedef Elm_Event_Policy_Changed
495 * Data on the event when an Elementary policy has changed
497 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
500 * @struct _Elm_Event_Policy_Changed
502 * Data on the event when an Elementary policy has changed
504 struct _Elm_Event_Policy_Changed
506 unsigned int policy; /**< the policy identifier */
507 int new_value; /**< value the policy had before the change */
508 int old_value; /**< new value the policy got */
512 * Policy identifiers.
514 typedef enum _Elm_Policy
516 ELM_POLICY_QUIT, /**< under which circumstances the application
517 * should quit automatically. @see
521 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
524 typedef enum _Elm_Policy_Quit
526 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
528 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
530 * window is closed */
531 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
533 typedef enum _Elm_Focus_Direction
537 } Elm_Focus_Direction;
539 typedef enum _Elm_Text_Format
541 ELM_TEXT_FORMAT_PLAIN_UTF8,
542 ELM_TEXT_FORMAT_MARKUP_UTF8
546 * Line wrapping types.
548 typedef enum _Elm_Wrap_Type
550 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
551 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
552 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
553 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
559 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
560 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
561 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
562 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
563 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
564 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
565 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
566 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
567 ELM_INPUT_PANEL_LAYOUT_INVALID
568 } Elm_Input_Panel_Layout;
572 ELM_AUTOCAPITAL_TYPE_NONE,
573 ELM_AUTOCAPITAL_TYPE_WORD,
574 ELM_AUTOCAPITAL_TYPE_SENTENCE,
575 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
576 } Elm_Autocapital_Type;
579 * @typedef Elm_Object_Item
580 * An Elementary Object item handle.
583 typedef struct _Elm_Object_Item Elm_Object_Item;
587 * Called back when a widget's tooltip is activated and needs content.
588 * @param data user-data given to elm_object_tooltip_content_cb_set()
589 * @param obj owner widget.
590 * @param tooltip The tooltip object (affix content to this!)
592 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
595 * Called back when a widget's item tooltip is activated and needs content.
596 * @param data user-data given to elm_object_tooltip_content_cb_set()
597 * @param obj owner widget.
598 * @param tooltip The tooltip object (affix content to this!)
599 * @param item context dependent item. As an example, if tooltip was
600 * set on Elm_List_Item, then it is of this type.
602 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
604 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. */
606 #ifndef ELM_LIB_QUICKLAUNCH
607 #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 */
609 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
612 /**************************************************************************/
616 * Initialize Elementary
618 * @param[in] argc System's argument count value
619 * @param[in] argv System's pointer to array of argument strings
620 * @return The init counter value.
622 * This function initializes Elementary and increments a counter of
623 * the number of calls to it. It returns the new counter's value.
625 * @warning This call is exported only for use by the @c ELM_MAIN()
626 * macro. There is no need to use this if you use this macro (which
627 * is highly advisable). An elm_main() should contain the entry
628 * point code for your application, having the same prototype as
629 * elm_init(), and @b not being static (putting the @c EAPI symbol
630 * in front of its type declaration is advisable). The @c
631 * ELM_MAIN() call should be placed just after it.
634 * @dontinclude bg_example_01.c
638 * See the full @ref bg_example_01_c "example".
640 * @see elm_shutdown().
643 EAPI int elm_init(int argc, char **argv);
646 * Shut down Elementary
648 * @return The init counter value.
650 * This should be called at the end of your application, just
651 * before it ceases to do any more processing. This will clean up
652 * any permanent resources your application may have allocated via
653 * Elementary that would otherwise persist.
655 * @see elm_init() for an example
659 EAPI int elm_shutdown(void);
662 * Run Elementary's main loop
664 * This call should be issued just after all initialization is
665 * completed. This function will not return until elm_exit() is
666 * called. It will keep looping, running the main
667 * (event/processing) loop for Elementary.
669 * @see elm_init() for an example
673 EAPI void elm_run(void);
676 * Exit Elementary's main loop
678 * If this call is issued, it will flag the main loop to cease
679 * processing and return back to its parent function (usually your
680 * elm_main() function).
682 * @see elm_init() for an example. There, just after a request to
683 * close the window comes, the main loop will be left.
685 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
686 * applications, you'll be able to get this function called automatically for you.
690 EAPI void elm_exit(void);
693 * Provide information in order to make Elementary determine the @b
694 * run time location of the software in question, so other data files
695 * such as images, sound files, executable utilities, libraries,
696 * modules and locale files can be found.
698 * @param mainfunc This is your application's main function name,
699 * whose binary's location is to be found. Providing @c NULL
700 * will make Elementary not to use it
701 * @param dom This will be used as the application's "domain", in the
702 * form of a prefix to any environment variables that may
703 * override prefix detection and the directory name, inside the
704 * standard share or data directories, where the software's
705 * data files will be looked for.
706 * @param checkfile This is an (optional) magic file's path to check
707 * for existence (and it must be located in the data directory,
708 * under the share directory provided above). Its presence will
709 * help determine the prefix found was correct. Pass @c NULL if
710 * the check is not to be done.
712 * This function allows one to re-locate the application somewhere
713 * else after compilation, if the developer wishes for easier
714 * distribution of pre-compiled binaries.
716 * The prefix system is designed to locate where the given software is
717 * installed (under a common path prefix) at run time and then report
718 * specific locations of this prefix and common directories inside
719 * this prefix like the binary, library, data and locale directories,
720 * through the @c elm_app_*_get() family of functions.
722 * Call elm_app_info_set() early on before you change working
723 * directory or anything about @c argv[0], so it gets accurate
726 * It will then try and trace back which file @p mainfunc comes from,
727 * if provided, to determine the application's prefix directory.
729 * The @p dom parameter provides a string prefix to prepend before
730 * environment variables, allowing a fallback to @b specific
731 * environment variables to locate the software. You would most
732 * probably provide a lowercase string there, because it will also
733 * serve as directory domain, explained next. For environment
734 * variables purposes, this string is made uppercase. For example if
735 * @c "myapp" is provided as the prefix, then the program would expect
736 * @c "MYAPP_PREFIX" as a master environment variable to specify the
737 * exact install prefix for the software, or more specific environment
738 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
739 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
740 * the user or scripts before launching. If not provided (@c NULL),
741 * environment variables will not be used to override compiled-in
742 * defaults or auto detections.
744 * The @p dom string also provides a subdirectory inside the system
745 * shared data directory for data files. For example, if the system
746 * directory is @c /usr/local/share, then this directory name is
747 * appended, creating @c /usr/local/share/myapp, if it @p was @c
748 * "myapp". It is expected that the application installs data files in
751 * The @p checkfile is a file name or path of something inside the
752 * share or data directory to be used to test that the prefix
753 * detection worked. For example, your app will install a wallpaper
754 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
755 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
758 * @see elm_app_compile_bin_dir_set()
759 * @see elm_app_compile_lib_dir_set()
760 * @see elm_app_compile_data_dir_set()
761 * @see elm_app_compile_locale_set()
762 * @see elm_app_prefix_dir_get()
763 * @see elm_app_bin_dir_get()
764 * @see elm_app_lib_dir_get()
765 * @see elm_app_data_dir_get()
766 * @see elm_app_locale_dir_get()
768 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
771 * Provide information on the @b fallback application's binaries
772 * directory, in scenarios where they get overriden by
773 * elm_app_info_set().
775 * @param dir The path to the default binaries directory (compile time
778 * @note Elementary will as well use this path to determine actual
779 * names of binaries' directory paths, maybe changing it to be @c
780 * something/local/bin instead of @c something/bin, only, for
783 * @warning You should call this function @b before
784 * elm_app_info_set().
786 EAPI void elm_app_compile_bin_dir_set(const char *dir);
789 * Provide information on the @b fallback application's libraries
790 * directory, on scenarios where they get overriden by
791 * elm_app_info_set().
793 * @param dir The path to the default libraries directory (compile
796 * @note Elementary will as well use this path to determine actual
797 * names of libraries' directory paths, maybe changing it to be @c
798 * something/lib32 or @c something/lib64 instead of @c something/lib,
801 * @warning You should call this function @b before
802 * elm_app_info_set().
804 EAPI void elm_app_compile_lib_dir_set(const char *dir);
807 * Provide information on the @b fallback application's data
808 * directory, on scenarios where they get overriden by
809 * elm_app_info_set().
811 * @param dir The path to the default data directory (compile time
814 * @note Elementary will as well use this path to determine actual
815 * names of data directory paths, maybe changing it to be @c
816 * something/local/share instead of @c something/share, only, for
819 * @warning You should call this function @b before
820 * elm_app_info_set().
822 EAPI void elm_app_compile_data_dir_set(const char *dir);
825 * Provide information on the @b fallback application's locale
826 * directory, on scenarios where they get overriden by
827 * elm_app_info_set().
829 * @param dir The path to the default locale directory (compile time
832 * @warning You should call this function @b before
833 * elm_app_info_set().
835 EAPI void elm_app_compile_locale_set(const char *dir);
838 * Retrieve the application's run time prefix directory, as set by
839 * elm_app_info_set() and the way (environment) the application was
842 * @return The directory prefix the application is actually using.
844 EAPI const char *elm_app_prefix_dir_get(void);
847 * Retrieve the application's run time binaries prefix directory, as
848 * set by elm_app_info_set() and the way (environment) the application
851 * @return The binaries directory prefix the application is actually
854 EAPI const char *elm_app_bin_dir_get(void);
857 * Retrieve the application's run time libraries prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The libraries directory prefix the application is actually
864 EAPI const char *elm_app_lib_dir_get(void);
867 * Retrieve the application's run time data prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The data directory prefix the application is actually
874 EAPI const char *elm_app_data_dir_get(void);
877 * Retrieve the application's run time locale prefix directory, as
878 * set by elm_app_info_set() and the way (environment) the application
881 * @return The locale directory prefix the application is actually
884 EAPI const char *elm_app_locale_dir_get(void);
886 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
887 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
888 EAPI int elm_quicklaunch_init(int argc, char **argv);
889 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
890 EAPI int elm_quicklaunch_sub_shutdown(void);
891 EAPI int elm_quicklaunch_shutdown(void);
892 EAPI void elm_quicklaunch_seed(void);
893 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
894 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
895 EAPI void elm_quicklaunch_cleanup(void);
896 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
897 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
899 EAPI Eina_Bool elm_need_efreet(void);
900 EAPI Eina_Bool elm_need_e_dbus(void);
903 * This must be called before any other function that deals with
904 * elm_thumb objects or ethumb_client instances.
908 EAPI Eina_Bool elm_need_ethumb(void);
911 * This must be called before any other function that deals with
912 * elm_web objects or ewk_view instances.
916 EAPI Eina_Bool elm_need_web(void);
919 * Set a new policy's value (for a given policy group/identifier).
921 * @param policy policy identifier, as in @ref Elm_Policy.
922 * @param value policy value, which depends on the identifier
924 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
926 * Elementary policies define applications' behavior,
927 * somehow. These behaviors are divided in policy groups (see
928 * #Elm_Policy enumeration). This call will emit the Ecore event
929 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
930 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
933 * @note Currently, we have only one policy identifier/group
934 * (#ELM_POLICY_QUIT), which has two possible values.
938 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
941 * Gets the policy value for given policy identifier.
943 * @param policy policy identifier, as in #Elm_Policy.
944 * @return The currently set policy value, for that
945 * identifier. Will be @c 0 if @p policy passed is invalid.
949 EAPI int elm_policy_get(unsigned int policy);
952 * Change the language of the current application
954 * The @p lang passed must be the full name of the locale to use, for
955 * example "en_US.utf8" or "es_ES@euro".
957 * Changing language with this function will make Elementary run through
958 * all its widgets, translating strings set with
959 * elm_object_domain_translatable_text_part_set(). This way, an entire
960 * UI can have its language changed without having to restart the program.
962 * For more complex cases, like having formatted strings that need
963 * translation, widgets will also emit a "language,changed" signal that
964 * the user can listen to to manually translate the text.
966 * @param lang Language to set, must be the full name of the locale
970 EAPI void elm_language_set(const char *lang);
973 * Set a label of an object
975 * @param obj The Elementary object
976 * @param part The text part name to set (NULL for the default label)
977 * @param label The new text of the label
979 * @note Elementary objects may have many labels (e.g. Action Slider)
980 * @deprecated Use elm_object_part_text_set() instead.
983 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
986 * Set a label of an object
988 * @param obj The Elementary object
989 * @param part The text part name to set (NULL for the default label)
990 * @param label The new text of the label
992 * @note Elementary objects may have many labels (e.g. Action Slider)
996 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
998 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1001 * Get a label of an object
1003 * @param obj The Elementary object
1004 * @param part The text part name to get (NULL for the default label)
1005 * @return text of the label or NULL for any error
1007 * @note Elementary objects may have many labels (e.g. Action Slider)
1008 * @deprecated Use elm_object_part_text_get() instead.
1011 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1014 * Get a label of an object
1016 * @param obj The Elementary object
1017 * @param part The text part name to get (NULL for the default label)
1018 * @return text of the label or NULL for any error
1020 * @note Elementary objects may have many labels (e.g. Action Slider)
1024 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1026 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1029 * Set the text for an objects' part, marking it as translatable.
1031 * The string to set as @p text must be the original one. Do not pass the
1032 * return of @c gettext() here. Elementary will translate the string
1033 * internally and set it on the object using elm_object_part_text_set(),
1034 * also storing the original string so that it can be automatically
1035 * translated when the language is changed with elm_language_set().
1037 * The @p domain will be stored along to find the translation in the
1038 * correct catalog. It can be NULL, in which case it will use whatever
1039 * domain was set by the application with @c textdomain(). This is useful
1040 * in case you are building a library on top of Elementary that will have
1041 * its own translatable strings, that should not be mixed with those of
1042 * programs using the library.
1044 * @param obj The object containing the text part
1045 * @param part The name of the part to set
1046 * @param domain The translation domain to use
1047 * @param text The original, non-translated text to set
1051 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1053 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1055 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1058 * Gets the original string set as translatable for an object
1060 * When setting translated strings, the function elm_object_part_text_get()
1061 * will return the translation returned by @c gettext(). To get the
1062 * original string use this function.
1064 * @param obj The object
1065 * @param part The name of the part that was set
1067 * @return The original, untranslated string
1071 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1073 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1076 * Set a content of an object
1078 * @param obj The Elementary object
1079 * @param part The content part name to set (NULL for the default content)
1080 * @param content The new content of the object
1082 * @note Elementary objects may have many contents
1083 * @deprecated Use elm_object_part_content_set instead.
1086 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1089 * Set a content of an object
1091 * @param obj The Elementary object
1092 * @param part The content part name to set (NULL for the default content)
1093 * @param content The new content of the object
1095 * @note Elementary objects may have many contents
1099 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1101 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1104 * Get a content of an object
1106 * @param obj The Elementary object
1107 * @param item The content part name to get (NULL for the default content)
1108 * @return content of the object or NULL for any error
1110 * @note Elementary objects may have many contents
1111 * @deprecated Use elm_object_part_content_get instead.
1114 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1117 * Get a content of an object
1119 * @param obj The Elementary object
1120 * @param item The content part name to get (NULL for the default content)
1121 * @return content of the object or NULL for any error
1123 * @note Elementary objects may have many contents
1127 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1129 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1132 * Unset a content of an object
1134 * @param obj The Elementary object
1135 * @param item The content part name to unset (NULL for the default content)
1137 * @note Elementary objects may have many contents
1138 * @deprecated Use elm_object_part_content_unset instead.
1141 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1144 * Unset a content of an object
1146 * @param obj The Elementary object
1147 * @param item The content part name to unset (NULL for the default content)
1149 * @note Elementary objects may have many contents
1153 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1155 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1158 * Set the text to read out when in accessibility mode
1160 * @param obj The object which is to be described
1161 * @param txt The text that describes the widget to people with poor or no vision
1165 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1168 * Get the widget object's handle which contains a given item
1170 * @param item The Elementary object item
1171 * @return The widget object
1173 * @note This returns the widget object itself that an item belongs to.
1177 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1180 * Set a content of an object item
1182 * @param it The Elementary object item
1183 * @param part The content part name to set (NULL for the default content)
1184 * @param content The new content of the object item
1186 * @note Elementary object items may have many contents
1187 * @deprecated Use elm_object_item_part_content_set instead.
1190 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1193 * Set a content of an object item
1195 * @param it The Elementary object item
1196 * @param part The content part name to set (NULL for the default content)
1197 * @param content The new content of the object item
1199 * @note Elementary object items may have many contents
1203 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1205 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1208 * Get a content of an object item
1210 * @param it The Elementary object item
1211 * @param part The content part name to unset (NULL for the default content)
1212 * @return content of the object item or NULL for any error
1214 * @note Elementary object items may have many contents
1215 * @deprecated Use elm_object_item_part_content_get instead.
1218 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1221 * Get a content of an object item
1223 * @param it The Elementary object item
1224 * @param part The content part name to unset (NULL for the default content)
1225 * @return content of the object item or NULL for any error
1227 * @note Elementary object items may have many contents
1231 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1233 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1236 * Unset a content of an object item
1238 * @param it The Elementary object item
1239 * @param part The content part name to unset (NULL for the default content)
1241 * @note Elementary object items may have many contents
1242 * @deprecated Use elm_object_item_part_content_unset instead.
1245 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1248 * Unset a content of an object item
1250 * @param it The Elementary object item
1251 * @param part The content part name to unset (NULL for the default content)
1253 * @note Elementary object items may have many contents
1257 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1258 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1261 * Set a label of an object item
1263 * @param it The Elementary object item
1264 * @param part The text part name to set (NULL for the default label)
1265 * @param label The new text of the label
1267 * @note Elementary object items may have many labels
1268 * @deprecated Use elm_object_item_part_text_set instead.
1271 WILL_DEPRECATE EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1274 * Set a label of an object item
1276 * @param it The Elementary object item
1277 * @param part The text part name to set (NULL for the default label)
1278 * @param label The new text of the label
1280 * @note Elementary object items may have many labels
1284 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1286 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1289 * Get a label of an object item
1291 * @param it The Elementary object item
1292 * @param part The text part name to get (NULL for the default label)
1293 * @return text of the label or NULL for any error
1295 * @note Elementary object items may have many labels
1296 * @deprecated Use elm_object_item_part_text_get instead.
1299 WILL_DEPRECATE EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1301 * Get a label of an object item
1303 * @param it The Elementary object item
1304 * @param part The text part name to get (NULL for the default label)
1305 * @return text of the label or NULL for any error
1307 * @note Elementary object items may have many labels
1311 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1314 * Set the text to read out when in accessibility mode
1316 * @param obj The object which is to be described
1317 * @param txt The text that describes the widget to people with poor or no vision
1321 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1324 * Set the text to read out when in accessibility mode
1326 * @param it The object item which is to be described
1327 * @param txt The text that describes the widget to people with poor or no vision
1331 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1333 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1336 * Set the text to read out when in accessibility mode
1338 * @param it The object item which is to be described
1339 * @param txt The text that describes the widget to people with poor or no vision
1343 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1346 * Get the data associated with an object item
1347 * @param it The Elementary object item
1348 * @return The data associated with @p it
1352 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1355 * Set the data associated with an object item
1356 * @param it The Elementary object item
1357 * @param data The data to be associated with @p it
1361 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1364 * Send a signal to the edje object of the widget item.
1366 * This function sends a signal to the edje object of the obj item. An
1367 * edje program can respond to a signal by specifying matching
1368 * 'signal' and 'source' fields.
1370 * @param it The Elementary object item
1371 * @param emission The signal's name.
1372 * @param source The signal's source.
1375 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1378 * Set the disabled state of an widget item.
1380 * @param obj The Elementary object item
1381 * @param disabled The state to put in in: @c EINA_TRUE for
1382 * disabled, @c EINA_FALSE for enabled
1384 * Elementary object item can be @b disabled, in which state they won't
1385 * receive input and, in general, will be themed differently from
1386 * their normal state, usually greyed out. Useful for contexts
1387 * where you don't want your users to interact with some of the
1388 * parts of you interface.
1390 * This sets the state for the widget item, either disabling it or
1395 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1398 * Get the disabled state of an widget item.
1400 * @param obj The Elementary object
1401 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1402 * if it's enabled (or on errors)
1404 * This gets the state of the widget, which might be enabled or disabled.
1408 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1415 * @defgroup Caches Caches
1417 * These are functions which let one fine-tune some cache values for
1418 * Elementary applications, thus allowing for performance adjustments.
1424 * @brief Flush all caches.
1426 * Frees all data that was in cache and is not currently being used to reduce
1427 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1428 * to calling all of the following functions:
1429 * @li edje_file_cache_flush()
1430 * @li edje_collection_cache_flush()
1431 * @li eet_clearcache()
1432 * @li evas_image_cache_flush()
1433 * @li evas_font_cache_flush()
1434 * @li evas_render_dump()
1435 * @note Evas caches are flushed for every canvas associated with a window.
1439 EAPI void elm_all_flush(void);
1442 * Get the configured cache flush interval time
1444 * This gets the globally configured cache flush interval time, in
1447 * @return The cache flush interval time
1450 * @see elm_all_flush()
1452 EAPI int elm_cache_flush_interval_get(void);
1455 * Set the configured cache flush interval time
1457 * This sets the globally configured cache flush interval time, in ticks
1459 * @param size The cache flush interval time
1462 * @see elm_all_flush()
1464 EAPI void elm_cache_flush_interval_set(int size);
1467 * Set the configured cache flush interval time for all applications on the
1470 * This sets the globally configured cache flush interval time -- in ticks
1471 * -- for all applications on the display.
1473 * @param size The cache flush interval time
1476 EAPI void elm_cache_flush_interval_all_set(int size);
1479 * Get the configured cache flush enabled state
1481 * This gets the globally configured cache flush state - if it is enabled
1482 * or not. When cache flushing is enabled, elementary will regularly
1483 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1484 * memory and allow usage to re-seed caches and data in memory where it
1485 * can do so. An idle application will thus minimise its memory usage as
1486 * data will be freed from memory and not be re-loaded as it is idle and
1487 * not rendering or doing anything graphically right now.
1489 * @return The cache flush state
1492 * @see elm_all_flush()
1494 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1497 * Set the configured cache flush enabled state
1499 * This sets the globally configured cache flush enabled state.
1501 * @param size The cache flush enabled state
1504 * @see elm_all_flush()
1506 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1509 * Set the configured cache flush enabled state for all applications on the
1512 * This sets the globally configured cache flush enabled state for all
1513 * applications on the display.
1515 * @param size The cache flush enabled state
1518 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1521 * Get the configured font cache size
1523 * This gets the globally configured font cache size, in bytes.
1525 * @return The font cache size
1528 EAPI int elm_font_cache_get(void);
1531 * Set the configured font cache size
1533 * This sets the globally configured font cache size, in bytes
1535 * @param size The font cache size
1538 EAPI void elm_font_cache_set(int size);
1541 * Set the configured font cache size for all applications on the
1544 * This sets the globally configured font cache size -- in bytes
1545 * -- for all applications on the display.
1547 * @param size The font cache size
1550 EAPI void elm_font_cache_all_set(int size);
1553 * Get the configured image cache size
1555 * This gets the globally configured image cache size, in bytes
1557 * @return The image cache size
1560 EAPI int elm_image_cache_get(void);
1563 * Set the configured image cache size
1565 * This sets the globally configured image cache size, in bytes
1567 * @param size The image cache size
1570 EAPI void elm_image_cache_set(int size);
1573 * Set the configured image cache size for all applications on the
1576 * This sets the globally configured image cache size -- in bytes
1577 * -- for all applications on the display.
1579 * @param size The image cache size
1582 EAPI void elm_image_cache_all_set(int size);
1585 * Get the configured edje file cache size.
1587 * This gets the globally configured edje file cache size, in number
1590 * @return The edje file cache size
1593 EAPI int elm_edje_file_cache_get(void);
1596 * Set the configured edje file cache size
1598 * This sets the globally configured edje file cache size, in number
1601 * @param size The edje file cache size
1604 EAPI void elm_edje_file_cache_set(int size);
1607 * Set the configured edje file cache size for all applications on the
1610 * This sets the globally configured edje file cache size -- in number
1611 * of files -- for all applications on the display.
1613 * @param size The edje file cache size
1616 EAPI void elm_edje_file_cache_all_set(int size);
1619 * Get the configured edje collections (groups) cache size.
1621 * This gets the globally configured edje collections cache size, in
1622 * number of collections.
1624 * @return The edje collections cache size
1627 EAPI int elm_edje_collection_cache_get(void);
1630 * Set the configured edje collections (groups) cache size
1632 * This sets the globally configured edje collections cache size, in
1633 * number of collections.
1635 * @param size The edje collections cache size
1638 EAPI void elm_edje_collection_cache_set(int size);
1641 * Set the configured edje collections (groups) cache size for all
1642 * applications on the display
1644 * This sets the globally configured edje collections cache size -- in
1645 * number of collections -- for all applications on the display.
1647 * @param size The edje collections cache size
1650 EAPI void elm_edje_collection_cache_all_set(int size);
1657 * @defgroup Scaling Widget Scaling
1659 * Different widgets can be scaled independently. These functions
1660 * allow you to manipulate this scaling on a per-widget basis. The
1661 * object and all its children get their scaling factors multiplied
1662 * by the scale factor set. This is multiplicative, in that if a
1663 * child also has a scale size set it is in turn multiplied by its
1664 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1665 * double size, @c 0.5 is half, etc.
1667 * @ref general_functions_example_page "This" example contemplates
1668 * some of these functions.
1672 * Get the global scaling factor
1674 * This gets the globally configured scaling factor that is applied to all
1677 * @return The scaling factor
1680 EAPI double elm_scale_get(void);
1683 * Set the global scaling factor
1685 * This sets the globally configured scaling factor that is applied to all
1688 * @param scale The scaling factor to set
1691 EAPI void elm_scale_set(double scale);
1694 * Set the global scaling factor for all applications on the display
1696 * This sets the globally configured scaling factor that is applied to all
1697 * objects for all applications.
1698 * @param scale The scaling factor to set
1701 EAPI void elm_scale_all_set(double scale);
1704 * Set the scaling factor for a given Elementary object
1706 * @param obj The Elementary to operate on
1707 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1712 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1715 * Get the scaling factor for a given Elementary object
1717 * @param obj The object
1718 * @return The scaling factor set by elm_object_scale_set()
1722 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1725 * @defgroup Password_last_show Password last input show
1727 * Last show feature of password mode enables user to view
1728 * the last input entered for few seconds before masking it.
1729 * These functions allow to set this feature in password mode
1730 * of entry widget and also allow to manipulate the duration
1731 * for which the input has to be visible.
1737 * Get show last setting of password mode.
1739 * This gets the show last input setting of password mode which might be
1740 * enabled or disabled.
1742 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1744 * @ingroup Password_last_show
1746 EAPI Eina_Bool elm_password_show_last_get(void);
1749 * Set show last setting in password mode.
1751 * This enables or disables show last setting of password mode.
1753 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1754 * @see elm_password_show_last_timeout_set()
1755 * @ingroup Password_last_show
1757 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1760 * Get's the timeout value in last show password mode.
1762 * This gets the time out value for which the last input entered in password
1763 * mode will be visible.
1765 * @return The timeout value of last show password mode.
1766 * @ingroup Password_last_show
1768 EAPI double elm_password_show_last_timeout_get(void);
1771 * Set's the timeout value in last show password mode.
1773 * This sets the time out value for which the last input entered in password
1774 * mode will be visible.
1776 * @param password_show_last_timeout The timeout value.
1777 * @see elm_password_show_last_set()
1778 * @ingroup Password_last_show
1780 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1787 * @defgroup UI-Mirroring Selective Widget mirroring
1789 * These functions allow you to set ui-mirroring on specific
1790 * widgets or the whole interface. Widgets can be in one of two
1791 * modes, automatic and manual. Automatic means they'll be changed
1792 * according to the system mirroring mode and manual means only
1793 * explicit changes will matter. You are not supposed to change
1794 * mirroring state of a widget set to automatic, will mostly work,
1795 * but the behavior is not really defined.
1800 EAPI Eina_Bool elm_mirrored_get(void);
1801 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1804 * Get the system mirrored mode. This determines the default mirrored mode
1807 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1809 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1812 * Set the system mirrored mode. This determines the default mirrored mode
1815 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1817 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1820 * Returns the widget's mirrored mode setting.
1822 * @param obj The widget.
1823 * @return mirrored mode setting of the object.
1826 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1829 * Sets the widget's mirrored mode setting.
1830 * When widget in automatic mode, it follows the system mirrored mode set by
1831 * elm_mirrored_set().
1832 * @param obj The widget.
1833 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1835 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1842 * Set the style to use by a widget
1844 * Sets the style name that will define the appearance of a widget. Styles
1845 * vary from widget to widget and may also be defined by other themes
1846 * by means of extensions and overlays.
1848 * @param obj The Elementary widget to style
1849 * @param style The style name to use
1851 * @see elm_theme_extension_add()
1852 * @see elm_theme_extension_del()
1853 * @see elm_theme_overlay_add()
1854 * @see elm_theme_overlay_del()
1858 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1860 * Get the style used by the widget
1862 * This gets the style being used for that widget. Note that the string
1863 * pointer is only valid as longas the object is valid and the style doesn't
1866 * @param obj The Elementary widget to query for its style
1867 * @return The style name used
1869 * @see elm_object_style_set()
1873 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1876 * @defgroup Styles Styles
1878 * Widgets can have different styles of look. These generic API's
1879 * set styles of widgets, if they support them (and if the theme(s)
1882 * @ref general_functions_example_page "This" example contemplates
1883 * some of these functions.
1887 * Set the disabled state of an Elementary object.
1889 * @param obj The Elementary object to operate on
1890 * @param disabled The state to put in in: @c EINA_TRUE for
1891 * disabled, @c EINA_FALSE for enabled
1893 * Elementary objects can be @b disabled, in which state they won't
1894 * receive input and, in general, will be themed differently from
1895 * their normal state, usually greyed out. Useful for contexts
1896 * where you don't want your users to interact with some of the
1897 * parts of you interface.
1899 * This sets the state for the widget, either disabling it or
1904 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1907 * Get the disabled state of an Elementary object.
1909 * @param obj The Elementary object to operate on
1910 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1911 * if it's enabled (or on errors)
1913 * This gets the state of the widget, which might be enabled or disabled.
1917 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1920 * @defgroup WidgetNavigation Widget Tree Navigation.
1922 * How to check if an Evas Object is an Elementary widget? How to
1923 * get the first elementary widget that is parent of the given
1924 * object? These are all covered in widget tree navigation.
1926 * @ref general_functions_example_page "This" example contemplates
1927 * some of these functions.
1931 * Check if the given Evas Object is an Elementary widget.
1933 * @param obj the object to query.
1934 * @return @c EINA_TRUE if it is an elementary widget variant,
1935 * @c EINA_FALSE otherwise
1936 * @ingroup WidgetNavigation
1938 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1941 * Get the first parent of the given object that is an Elementary
1944 * @param obj the Elementary object to query parent from.
1945 * @return the parent object that is an Elementary widget, or @c
1946 * NULL, if it was not found.
1948 * Use this to query for an object's parent widget.
1950 * @note Most of Elementary users wouldn't be mixing non-Elementary
1951 * smart objects in the objects tree of an application, as this is
1952 * an advanced usage of Elementary with Evas. So, except for the
1953 * application's window, which is the root of that tree, all other
1954 * objects would have valid Elementary widget parents.
1956 * @ingroup WidgetNavigation
1958 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1961 * Get the top level parent of an Elementary widget.
1963 * @param obj The object to query.
1964 * @return The top level Elementary widget, or @c NULL if parent cannot be
1966 * @ingroup WidgetNavigation
1968 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1971 * Get the string that represents this Elementary widget.
1973 * @note Elementary is weird and exposes itself as a single
1974 * Evas_Object_Smart_Class of type "elm_widget", so
1975 * evas_object_type_get() always return that, making debug and
1976 * language bindings hard. This function tries to mitigate this
1977 * problem, but the solution is to change Elementary to use
1978 * proper inheritance.
1980 * @param obj the object to query.
1981 * @return Elementary widget name, or @c NULL if not a valid widget.
1982 * @ingroup WidgetNavigation
1984 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1987 * @defgroup Config Elementary Config
1989 * Elementary configuration is formed by a set options bounded to a
1990 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1991 * "finger size", etc. These are functions with which one syncronizes
1992 * changes made to those values to the configuration storing files, de
1993 * facto. You most probably don't want to use the functions in this
1994 * group unlees you're writing an elementary configuration manager.
2000 * Save back Elementary's configuration, so that it will persist on
2003 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2006 * This function will take effect -- thus, do I/O -- immediately. Use
2007 * it when you want to apply all configuration changes at once. The
2008 * current configuration set will get saved onto the current profile
2009 * configuration file.
2012 EAPI Eina_Bool elm_config_save(void);
2015 * Reload Elementary's configuration, bounded to current selected
2018 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2021 * Useful when you want to force reloading of configuration values for
2022 * a profile. If one removes user custom configuration directories,
2023 * for example, it will force a reload with system values instead.
2026 EAPI void elm_config_reload(void);
2033 * @defgroup Profile Elementary Profile
2035 * Profiles are pre-set options that affect the whole look-and-feel of
2036 * Elementary-based applications. There are, for example, profiles
2037 * aimed at desktop computer applications and others aimed at mobile,
2038 * touchscreen-based ones. You most probably don't want to use the
2039 * functions in this group unlees you're writing an elementary
2040 * configuration manager.
2046 * Get Elementary's profile in use.
2048 * This gets the global profile that is applied to all Elementary
2051 * @return The profile's name
2054 EAPI const char *elm_profile_current_get(void);
2057 * Get an Elementary's profile directory path in the filesystem. One
2058 * may want to fetch a system profile's dir or an user one (fetched
2061 * @param profile The profile's name
2062 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2063 * or a system one (@c EINA_FALSE)
2064 * @return The profile's directory path.
2067 * @note You must free it with elm_profile_dir_free().
2069 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2072 * Free an Elementary's profile directory path, as returned by
2073 * elm_profile_dir_get().
2075 * @param p_dir The profile's path
2079 EAPI void elm_profile_dir_free(const char *p_dir);
2082 * Get Elementary's list of available profiles.
2084 * @return The profiles list. List node data are the profile name
2088 * @note One must free this list, after usage, with the function
2089 * elm_profile_list_free().
2091 EAPI Eina_List *elm_profile_list_get(void);
2094 * Free Elementary's list of available profiles.
2096 * @param l The profiles list, as returned by elm_profile_list_get().
2100 EAPI void elm_profile_list_free(Eina_List *l);
2103 * Set Elementary's profile.
2105 * This sets the global profile that is applied to Elementary
2106 * applications. Just the process the call comes from will be
2109 * @param profile The profile's name
2113 EAPI void elm_profile_set(const char *profile);
2116 * Set Elementary's profile.
2118 * This sets the global profile that is applied to all Elementary
2119 * applications. All running Elementary windows will be affected.
2121 * @param profile The profile's name
2125 EAPI void elm_profile_all_set(const char *profile);
2132 * @defgroup Engine Elementary Engine
2134 * These are functions setting and querying which rendering engine
2135 * Elementary will use for drawing its windows' pixels.
2137 * The following are the available engines:
2138 * @li "software_x11"
2141 * @li "software_16_x11"
2142 * @li "software_8_x11"
2145 * @li "software_gdi"
2146 * @li "software_16_wince_gdi"
2148 * @li "software_16_sdl"
2152 * @li "opengl_cocoa"
2159 * @brief Get Elementary's rendering engine in use.
2161 * @return The rendering engine's name
2162 * @note there's no need to free the returned string, here.
2164 * This gets the global rendering engine that is applied to all Elementary
2167 * @see elm_engine_set()
2169 EAPI const char *elm_engine_current_get(void);
2172 * @brief Set Elementary's rendering engine for use.
2174 * @param engine The rendering engine's name
2176 * This sets global rendering engine that is applied to all Elementary
2177 * applications. Note that it will take effect only to Elementary windows
2178 * created after this is called.
2180 * @see elm_win_add()
2182 EAPI void elm_engine_set(const char *engine);
2189 * @defgroup Fonts Elementary Fonts
2191 * These are functions dealing with font rendering, selection and the
2192 * like for Elementary applications. One might fetch which system
2193 * fonts are there to use and set custom fonts for individual classes
2194 * of UI items containing text (text classes).
2199 typedef struct _Elm_Text_Class
2205 typedef struct _Elm_Font_Overlay
2207 const char *text_class;
2209 Evas_Font_Size size;
2212 typedef struct _Elm_Font_Properties
2216 } Elm_Font_Properties;
2219 * Get Elementary's list of supported text classes.
2221 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2224 * Release the list with elm_text_classes_list_free().
2226 EAPI const Eina_List *elm_text_classes_list_get(void);
2229 * Free Elementary's list of supported text classes.
2233 * @see elm_text_classes_list_get().
2235 EAPI void elm_text_classes_list_free(const Eina_List *list);
2238 * Get Elementary's list of font overlays, set with
2239 * elm_font_overlay_set().
2241 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2246 * For each text class, one can set a <b>font overlay</b> for it,
2247 * overriding the default font properties for that class coming from
2248 * the theme in use. There is no need to free this list.
2250 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2252 EAPI const Eina_List *elm_font_overlay_list_get(void);
2255 * Set a font overlay for a given Elementary text class.
2257 * @param text_class Text class name
2258 * @param font Font name and style string
2259 * @param size Font size
2263 * @p font has to be in the format returned by
2264 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2265 * and elm_font_overlay_unset().
2267 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2270 * Unset a font overlay for a given Elementary text class.
2272 * @param text_class Text class name
2276 * This will bring back text elements belonging to text class
2277 * @p text_class back to their default font settings.
2279 EAPI void elm_font_overlay_unset(const char *text_class);
2282 * Apply the changes made with elm_font_overlay_set() and
2283 * elm_font_overlay_unset() on the current Elementary window.
2287 * This applies all font overlays set to all objects in the UI.
2289 EAPI void elm_font_overlay_apply(void);
2292 * Apply the changes made with elm_font_overlay_set() and
2293 * elm_font_overlay_unset() on all Elementary application windows.
2297 * This applies all font overlays set to all objects in the UI.
2299 EAPI void elm_font_overlay_all_apply(void);
2302 * Translate a font (family) name string in fontconfig's font names
2303 * syntax into an @c Elm_Font_Properties struct.
2305 * @param font The font name and styles string
2306 * @return the font properties struct
2310 * @note The reverse translation can be achived with
2311 * elm_font_fontconfig_name_get(), for one style only (single font
2312 * instance, not family).
2314 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2317 * Free font properties return by elm_font_properties_get().
2319 * @param efp the font properties struct
2323 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2326 * Translate a font name, bound to a style, into fontconfig's font names
2329 * @param name The font (family) name
2330 * @param style The given style (may be @c NULL)
2332 * @return the font name and style string
2336 * @note The reverse translation can be achived with
2337 * elm_font_properties_get(), for one style only (single font
2338 * instance, not family).
2340 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2343 * Free the font string return by elm_font_fontconfig_name_get().
2345 * @param efp the font properties struct
2349 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2352 * Create a font hash table of available system fonts.
2354 * One must call it with @p list being the return value of
2355 * evas_font_available_list(). The hash will be indexed by font
2356 * (family) names, being its values @c Elm_Font_Properties blobs.
2358 * @param list The list of available system fonts, as returned by
2359 * evas_font_available_list().
2360 * @return the font hash.
2364 * @note The user is supposed to get it populated at least with 3
2365 * default font families (Sans, Serif, Monospace), which should be
2366 * present on most systems.
2368 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2371 * Free the hash return by elm_font_available_hash_add().
2373 * @param hash the hash to be freed.
2377 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2384 * @defgroup Fingers Fingers
2386 * Elementary is designed to be finger-friendly for touchscreens,
2387 * and so in addition to scaling for display resolution, it can
2388 * also scale based on finger "resolution" (or size). You can then
2389 * customize the granularity of the areas meant to receive clicks
2392 * Different profiles may have pre-set values for finger sizes.
2394 * @ref general_functions_example_page "This" example contemplates
2395 * some of these functions.
2401 * Get the configured "finger size"
2403 * @return The finger size
2405 * This gets the globally configured finger size, <b>in pixels</b>
2409 EAPI Evas_Coord elm_finger_size_get(void);
2412 * Set the configured finger size
2414 * This sets the globally configured finger size in pixels
2416 * @param size The finger size
2419 EAPI void elm_finger_size_set(Evas_Coord size);
2422 * Set the configured finger size for all applications on the display
2424 * This sets the globally configured finger size in pixels for all
2425 * applications on the display
2427 * @param size The finger size
2430 EAPI void elm_finger_size_all_set(Evas_Coord size);
2437 * @defgroup Focus Focus
2439 * An Elementary application has, at all times, one (and only one)
2440 * @b focused object. This is what determines where the input
2441 * events go to within the application's window. Also, focused
2442 * objects can be decorated differently, in order to signal to the
2443 * user where the input is, at a given moment.
2445 * Elementary applications also have the concept of <b>focus
2446 * chain</b>: one can cycle through all the windows' focusable
2447 * objects by input (tab key) or programmatically. The default
2448 * focus chain for an application is the one define by the order in
2449 * which the widgets where added in code. One will cycle through
2450 * top level widgets, and, for each one containg sub-objects, cycle
2451 * through them all, before returning to the level
2452 * above. Elementary also allows one to set @b custom focus chains
2453 * for their applications.
2455 * Besides the focused decoration a widget may exhibit, when it
2456 * gets focus, Elementary has a @b global focus highlight object
2457 * that can be enabled for a window. If one chooses to do so, this
2458 * extra highlight effect will surround the current focused object,
2461 * @note Some Elementary widgets are @b unfocusable, after
2462 * creation, by their very nature: they are not meant to be
2463 * interacted with input events, but are there just for visual
2466 * @ref general_functions_example_page "This" example contemplates
2467 * some of these functions.
2471 * Get the enable status of the focus highlight
2473 * This gets whether the highlight on focused objects is enabled or not
2476 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2479 * Set the enable status of the focus highlight
2481 * Set whether to show or not the highlight on focused objects
2482 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2485 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2488 * Get the enable status of the highlight animation
2490 * Get whether the focus highlight, if enabled, will animate its switch from
2491 * one object to the next
2494 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2497 * Set the enable status of the highlight animation
2499 * Set whether the focus highlight, if enabled, will animate its switch from
2500 * one object to the next
2501 * @param animate Enable animation if EINA_TRUE, disable otherwise
2504 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2507 * Get the whether an Elementary object has the focus or not.
2509 * @param obj The Elementary object to get the information from
2510 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2511 * not (and on errors).
2513 * @see elm_object_focus_set()
2517 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2520 * Set/unset focus to a given Elementary object.
2522 * @param obj The Elementary object to operate on.
2523 * @param enable @c EINA_TRUE Set focus to a given object,
2524 * @c EINA_FALSE Unset focus to a given object.
2526 * @note When you set focus to this object, if it can handle focus, will
2527 * take the focus away from the one who had it previously and will, for
2528 * now on, be the one receiving input events. Unsetting focus will remove
2529 * the focus from @p obj, passing it back to the previous element in the
2532 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2536 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2539 * Make a given Elementary object the focused one.
2541 * @param obj The Elementary object to make focused.
2543 * @note This object, if it can handle focus, will take the focus
2544 * away from the one who had it previously and will, for now on, be
2545 * the one receiving input events.
2547 * @see elm_object_focus_get()
2548 * @deprecated use elm_object_focus_set() instead.
2552 WILL_DEPRECATE EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2555 * Remove the focus from an Elementary object
2557 * @param obj The Elementary to take focus from
2559 * This removes the focus from @p obj, passing it back to the
2560 * previous element in the focus chain list.
2562 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2563 * @deprecated use elm_object_focus_set() instead.
2567 WILL_DEPRECATE EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2570 * Set the ability for an Element object to be focused
2572 * @param obj The Elementary object to operate on
2573 * @param enable @c EINA_TRUE if the object can be focused, @c
2574 * EINA_FALSE if not (and on errors)
2576 * This sets whether the object @p obj is able to take focus or
2577 * not. Unfocusable objects do nothing when programmatically
2578 * focused, being the nearest focusable parent object the one
2579 * really getting focus. Also, when they receive mouse input, they
2580 * will get the event, but not take away the focus from where it
2585 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2588 * Get whether an Elementary object is focusable or not
2590 * @param obj The Elementary object to operate on
2591 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2592 * EINA_FALSE if not (and on errors)
2594 * @note Objects which are meant to be interacted with by input
2595 * events are created able to be focused, by default. All the
2600 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2603 * Set custom focus chain.
2605 * This function overwrites any previous custom focus chain within
2606 * the list of objects. The previous list will be deleted and this list
2607 * will be managed by elementary. After it is set, don't modify it.
2609 * @note On focus cycle, only will be evaluated children of this container.
2611 * @param obj The container object
2612 * @param objs Chain of objects to pass focus
2615 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2618 * Unset a custom focus chain on a given Elementary widget
2620 * @param obj The container object to remove focus chain from
2622 * Any focus chain previously set on @p obj (for its child objects)
2623 * is removed entirely after this call.
2627 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2630 * Get custom focus chain
2632 * @param obj The container object
2635 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2638 * Append object to custom focus chain.
2640 * @note If relative_child equal to NULL or not in custom chain, the object
2641 * will be added in end.
2643 * @note On focus cycle, only will be evaluated children of this container.
2645 * @param obj The container object
2646 * @param child The child to be added in custom chain
2647 * @param relative_child The relative object to position the child
2650 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2653 * Prepend object to custom focus chain.
2655 * @note If relative_child equal to NULL or not in custom chain, the object
2656 * will be added in begin.
2658 * @note On focus cycle, only will be evaluated children of this container.
2660 * @param obj The container object
2661 * @param child The child to be added in custom chain
2662 * @param relative_child The relative object to position the child
2665 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2668 * Give focus to next object in object tree.
2670 * Give focus to next object in focus chain of one object sub-tree.
2671 * If the last object of chain already have focus, the focus will go to the
2672 * first object of chain.
2674 * @param obj The object root of sub-tree
2675 * @param dir Direction to cycle the focus
2679 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2682 * Give focus to near object in one direction.
2684 * Give focus to near object in direction of one object.
2685 * If none focusable object in given direction, the focus will not change.
2687 * @param obj The reference object
2688 * @param x Horizontal component of direction to focus
2689 * @param y Vertical component of direction to focus
2693 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2696 * Make the elementary object and its children to be unfocusable
2699 * @param obj The Elementary object to operate on
2700 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2701 * @c EINA_FALSE for focusable.
2703 * This sets whether the object @p obj and its children objects
2704 * are able to take focus or not. If the tree is set as unfocusable,
2705 * newest focused object which is not in this tree will get focus.
2706 * This API can be helpful for an object to be deleted.
2707 * When an object will be deleted soon, it and its children may not
2708 * want to get focus (by focus reverting or by other focus controls).
2709 * Then, just use this API before deleting.
2711 * @see elm_object_tree_unfocusable_get()
2715 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2718 * Get whether an Elementary object and its children are unfocusable or not.
2720 * @param obj The Elementary object to get the information from
2721 * @return @c EINA_TRUE, if the tree is unfocussable,
2722 * @c EINA_FALSE if not (and on errors).
2724 * @see elm_object_tree_unfocusable_set()
2728 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2731 * @defgroup Scrolling Scrolling
2733 * These are functions setting how scrollable views in Elementary
2734 * widgets should behave on user interaction.
2740 * Get whether scrollers should bounce when they reach their
2741 * viewport's edge during a scroll.
2743 * @return the thumb scroll bouncing state
2745 * This is the default behavior for touch screens, in general.
2746 * @ingroup Scrolling
2748 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2751 * Set whether scrollers should bounce when they reach their
2752 * viewport's edge during a scroll.
2754 * @param enabled the thumb scroll bouncing state
2756 * @see elm_thumbscroll_bounce_enabled_get()
2757 * @ingroup Scrolling
2759 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2762 * Set whether scrollers should bounce when they reach their
2763 * viewport's edge during a scroll, for all Elementary application
2766 * @param enabled the thumb scroll bouncing state
2768 * @see elm_thumbscroll_bounce_enabled_get()
2769 * @ingroup Scrolling
2771 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2774 * Get the amount of inertia a scroller will impose at bounce
2777 * @return the thumb scroll bounce friction
2779 * @ingroup Scrolling
2781 EAPI double elm_scroll_bounce_friction_get(void);
2784 * Set the amount of inertia a scroller will impose at bounce
2787 * @param friction the thumb scroll bounce friction
2789 * @see elm_thumbscroll_bounce_friction_get()
2790 * @ingroup Scrolling
2792 EAPI void elm_scroll_bounce_friction_set(double friction);
2795 * Set the amount of inertia a scroller will impose at bounce
2796 * animations, for all Elementary application windows.
2798 * @param friction the thumb scroll bounce friction
2800 * @see elm_thumbscroll_bounce_friction_get()
2801 * @ingroup Scrolling
2803 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2806 * Get the amount of inertia a <b>paged</b> scroller will impose at
2807 * page fitting animations.
2809 * @return the page scroll friction
2811 * @ingroup Scrolling
2813 EAPI double elm_scroll_page_scroll_friction_get(void);
2816 * Set the amount of inertia a <b>paged</b> scroller will impose at
2817 * page fitting animations.
2819 * @param friction the page scroll friction
2821 * @see elm_thumbscroll_page_scroll_friction_get()
2822 * @ingroup Scrolling
2824 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2827 * Set the amount of inertia a <b>paged</b> scroller will impose at
2828 * page fitting animations, for all Elementary application windows.
2830 * @param friction the page scroll friction
2832 * @see elm_thumbscroll_page_scroll_friction_get()
2833 * @ingroup Scrolling
2835 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2838 * Get the amount of inertia a scroller will impose at region bring
2841 * @return the bring in scroll friction
2843 * @ingroup Scrolling
2845 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2848 * Set the amount of inertia a scroller will impose at region bring
2851 * @param friction the bring in scroll friction
2853 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2854 * @ingroup Scrolling
2856 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2859 * Set the amount of inertia a scroller will impose at region bring
2860 * animations, for all Elementary application windows.
2862 * @param friction the bring in scroll friction
2864 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2865 * @ingroup Scrolling
2867 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2870 * Get the amount of inertia scrollers will impose at animations
2871 * triggered by Elementary widgets' zooming API.
2873 * @return the zoom friction
2875 * @ingroup Scrolling
2877 EAPI double elm_scroll_zoom_friction_get(void);
2880 * Set the amount of inertia scrollers will impose at animations
2881 * triggered by Elementary widgets' zooming API.
2883 * @param friction the zoom friction
2885 * @see elm_thumbscroll_zoom_friction_get()
2886 * @ingroup Scrolling
2888 EAPI void elm_scroll_zoom_friction_set(double friction);
2891 * Set the amount of inertia scrollers will impose at animations
2892 * triggered by Elementary widgets' zooming API, for all Elementary
2893 * application windows.
2895 * @param friction the zoom friction
2897 * @see elm_thumbscroll_zoom_friction_get()
2898 * @ingroup Scrolling
2900 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2903 * Get whether scrollers should be draggable from any point in their
2906 * @return the thumb scroll state
2908 * @note This is the default behavior for touch screens, in general.
2909 * @note All other functions namespaced with "thumbscroll" will only
2910 * have effect if this mode is enabled.
2912 * @ingroup Scrolling
2914 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2917 * Set whether scrollers should be draggable from any point in their
2920 * @param enabled the thumb scroll state
2922 * @see elm_thumbscroll_enabled_get()
2923 * @ingroup Scrolling
2925 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2928 * Set whether scrollers should be draggable from any point in their
2929 * views, for all Elementary application windows.
2931 * @param enabled the thumb scroll state
2933 * @see elm_thumbscroll_enabled_get()
2934 * @ingroup Scrolling
2936 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2939 * Get the number of pixels one should travel while dragging a
2940 * scroller's view to actually trigger scrolling.
2942 * @return the thumb scroll threshould
2944 * One would use higher values for touch screens, in general, because
2945 * of their inherent imprecision.
2946 * @ingroup Scrolling
2948 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2951 * Set the number of pixels one should travel while dragging a
2952 * scroller's view to actually trigger scrolling.
2954 * @param threshold the thumb scroll threshould
2956 * @see elm_thumbscroll_threshould_get()
2957 * @ingroup Scrolling
2959 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2962 * Set the number of pixels one should travel while dragging a
2963 * scroller's view to actually trigger scrolling, for all Elementary
2964 * application windows.
2966 * @param threshold the thumb scroll threshould
2968 * @see elm_thumbscroll_threshould_get()
2969 * @ingroup Scrolling
2971 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2974 * Get the minimum speed of mouse cursor movement which will trigger
2975 * list self scrolling animation after a mouse up event
2978 * @return the thumb scroll momentum threshould
2980 * @ingroup Scrolling
2982 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2985 * Set the minimum speed of mouse cursor movement which will trigger
2986 * list self scrolling animation after a mouse up event
2989 * @param threshold the thumb scroll momentum threshould
2991 * @see elm_thumbscroll_momentum_threshould_get()
2992 * @ingroup Scrolling
2994 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2997 * Set the minimum speed of mouse cursor movement which will trigger
2998 * list self scrolling animation after a mouse up event
2999 * (pixels/second), for all Elementary application windows.
3001 * @param threshold the thumb scroll momentum threshould
3003 * @see elm_thumbscroll_momentum_threshould_get()
3004 * @ingroup Scrolling
3006 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3009 * Get the amount of inertia a scroller will impose at self scrolling
3012 * @return the thumb scroll friction
3014 * @ingroup Scrolling
3016 EAPI double elm_scroll_thumbscroll_friction_get(void);
3019 * Set the amount of inertia a scroller will impose at self scrolling
3022 * @param friction the thumb scroll friction
3024 * @see elm_thumbscroll_friction_get()
3025 * @ingroup Scrolling
3027 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3030 * Set the amount of inertia a scroller will impose at self scrolling
3031 * animations, for all Elementary application windows.
3033 * @param friction the thumb scroll friction
3035 * @see elm_thumbscroll_friction_get()
3036 * @ingroup Scrolling
3038 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3041 * Get the amount of lag between your actual mouse cursor dragging
3042 * movement and a scroller's view movement itself, while pushing it
3043 * into bounce state manually.
3045 * @return the thumb scroll border friction
3047 * @ingroup Scrolling
3049 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3052 * Set the amount of lag between your actual mouse cursor dragging
3053 * movement and a scroller's view movement itself, while pushing it
3054 * into bounce state manually.
3056 * @param friction the thumb scroll border friction. @c 0.0 for
3057 * perfect synchrony between two movements, @c 1.0 for maximum
3060 * @see elm_thumbscroll_border_friction_get()
3061 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3063 * @ingroup Scrolling
3065 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3068 * Set the amount of lag between your actual mouse cursor dragging
3069 * movement and a scroller's view movement itself, while pushing it
3070 * into bounce state manually, for all Elementary application windows.
3072 * @param friction the thumb scroll border friction. @c 0.0 for
3073 * perfect synchrony between two movements, @c 1.0 for maximum
3076 * @see elm_thumbscroll_border_friction_get()
3077 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3079 * @ingroup Scrolling
3081 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3084 * Get the sensitivity amount which is be multiplied by the length of
3087 * @return the thumb scroll sensitivity friction
3089 * @ingroup Scrolling
3091 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3094 * Set the sensitivity amount which is be multiplied by the length of
3097 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3098 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3101 * @see elm_thumbscroll_sensitivity_friction_get()
3102 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3104 * @ingroup Scrolling
3106 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3109 * Set the sensitivity amount which is be multiplied by the length of
3110 * mouse dragging, for all Elementary application windows.
3112 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3113 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3116 * @see elm_thumbscroll_sensitivity_friction_get()
3117 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3119 * @ingroup Scrolling
3121 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3128 * @defgroup Scrollhints Scrollhints
3130 * Objects when inside a scroller can scroll, but this may not always be
3131 * desirable in certain situations. This allows an object to hint to itself
3132 * and parents to "not scroll" in one of 2 ways. If any child object of a
3133 * scroller has pushed a scroll freeze or hold then it affects all parent
3134 * scrollers until all children have released them.
3136 * 1. To hold on scrolling. This means just flicking and dragging may no
3137 * longer scroll, but pressing/dragging near an edge of the scroller will
3138 * still scroll. This is automatically used by the entry object when
3141 * 2. To totally freeze scrolling. This means it stops. until
3148 * Push the scroll hold by 1
3150 * This increments the scroll hold count by one. If it is more than 0 it will
3151 * take effect on the parents of the indicated object.
3153 * @param obj The object
3154 * @ingroup Scrollhints
3156 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3159 * Pop the scroll hold by 1
3161 * This decrements the scroll hold count by one. If it is more than 0 it will
3162 * take effect on the parents of the indicated object.
3164 * @param obj The object
3165 * @ingroup Scrollhints
3167 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3170 * Push the scroll freeze by 1
3172 * This increments the scroll freeze count by one. If it is more
3173 * than 0 it will take effect on the parents of the indicated
3176 * @param obj The object
3177 * @ingroup Scrollhints
3179 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3182 * Pop the scroll freeze by 1
3184 * This decrements the scroll freeze count by one. If it is more
3185 * than 0 it will take effect on the parents of the indicated
3188 * @param obj The object
3189 * @ingroup Scrollhints
3191 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3194 * Lock the scrolling of the given widget (and thus all parents)
3196 * This locks the given object from scrolling in the X axis (and implicitly
3197 * also locks all parent scrollers too from doing the same).
3199 * @param obj The object
3200 * @param lock The lock state (1 == locked, 0 == unlocked)
3201 * @ingroup Scrollhints
3203 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3206 * Lock the scrolling of the given widget (and thus all parents)
3208 * This locks the given object from scrolling in the Y axis (and implicitly
3209 * also locks all parent scrollers too from doing the same).
3211 * @param obj The object
3212 * @param lock The lock state (1 == locked, 0 == unlocked)
3213 * @ingroup Scrollhints
3215 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3218 * Get the scrolling lock of the given widget
3220 * This gets the lock for X axis scrolling.
3222 * @param obj The object
3223 * @ingroup Scrollhints
3225 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3228 * Get the scrolling lock of the given widget
3230 * This gets the lock for X axis scrolling.
3232 * @param obj The object
3233 * @ingroup Scrollhints
3235 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3242 * Send a signal to the widget edje object.
3244 * This function sends a signal to the edje object of the obj. An
3245 * edje program can respond to a signal by specifying matching
3246 * 'signal' and 'source' fields.
3248 * @param obj The object
3249 * @param emission The signal's name.
3250 * @param source The signal's source.
3253 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3256 * Add a callback for a signal emitted by widget edje object.
3258 * This function connects a callback function to a signal emitted by the
3259 * edje object of the obj.
3260 * Globs can occur in either the emission or source name.
3262 * @param obj The object
3263 * @param emission The signal's name.
3264 * @param source The signal's source.
3265 * @param func The callback function to be executed when the signal is
3267 * @param data A pointer to data to pass in to the callback function.
3270 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);
3273 * Remove a signal-triggered callback from a widget edje object.
3275 * This function removes a callback, previoulsy attached to a
3276 * signal emitted by the edje object of the obj. The parameters
3277 * emission, source and func must match exactly those passed to a
3278 * previous call to elm_object_signal_callback_add(). The data
3279 * pointer that was passed to this call will be returned.
3281 * @param obj The object
3282 * @param emission The signal's name.
3283 * @param source The signal's source.
3284 * @param func The callback function to be executed when the signal is
3286 * @return The data pointer
3289 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);
3292 * Add a callback for input events (key up, key down, mouse wheel)
3293 * on a given Elementary widget
3295 * @param obj The widget to add an event callback on
3296 * @param func The callback function to be executed when the event
3298 * @param data Data to pass in to @p func
3300 * Every widget in an Elementary interface set to receive focus,
3301 * with elm_object_focus_allow_set(), will propagate @b all of its
3302 * key up, key down and mouse wheel input events up to its parent
3303 * object, and so on. All of the focusable ones in this chain which
3304 * had an event callback set, with this call, will be able to treat
3305 * those events. There are two ways of making the propagation of
3306 * these event upwards in the tree of widgets to @b cease:
3307 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3308 * the event was @b not processed, so the propagation will go on.
3309 * - The @c event_info pointer passed to @p func will contain the
3310 * event's structure and, if you OR its @c event_flags inner
3311 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3312 * one has already handled it, thus killing the event's
3315 * @note Your event callback will be issued on those events taking
3316 * place only if no other child widget of @obj has consumed the
3319 * @note Not to be confused with @c
3320 * evas_object_event_callback_add(), which will add event callbacks
3321 * per type on general Evas objects (no event propagation
3322 * infrastructure taken in account).
3324 * @note Not to be confused with @c
3325 * elm_object_signal_callback_add(), which will add callbacks to @b
3326 * signals coming from a widget's theme, not input events.
3328 * @note Not to be confused with @c
3329 * edje_object_signal_callback_add(), which does the same as
3330 * elm_object_signal_callback_add(), but directly on an Edje
3333 * @note Not to be confused with @c
3334 * evas_object_smart_callback_add(), which adds callbacks to smart
3335 * objects' <b>smart events</b>, and not input events.
3337 * @see elm_object_event_callback_del()
3341 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3344 * Remove an event callback from a widget.
3346 * This function removes a callback, previoulsy attached to event emission
3348 * The parameters func and data must match exactly those passed to
3349 * a previous call to elm_object_event_callback_add(). The data pointer that
3350 * was passed to this call will be returned.
3352 * @param obj The object
3353 * @param func The callback function to be executed when the event is
3355 * @param data Data to pass in to the callback function.
3356 * @return The data pointer
3359 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3362 * Adjust size of an element for finger usage.
3364 * @param times_w How many fingers should fit horizontally
3365 * @param w Pointer to the width size to adjust
3366 * @param times_h How many fingers should fit vertically
3367 * @param h Pointer to the height size to adjust
3369 * This takes width and height sizes (in pixels) as input and a
3370 * size multiple (which is how many fingers you want to place
3371 * within the area, being "finger" the size set by
3372 * elm_finger_size_set()), and adjusts the size to be large enough
3373 * to accommodate the resulting size -- if it doesn't already
3374 * accommodate it. On return the @p w and @p h sizes pointed to by
3375 * these parameters will be modified, on those conditions.
3377 * @note This is kind of a low level Elementary call, most useful
3378 * on size evaluation times for widgets. An external user wouldn't
3379 * be calling, most of the time.
3383 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3386 * Get the duration for occuring long press event.
3388 * @return Timeout for long press event
3389 * @ingroup Longpress
3391 EAPI double elm_longpress_timeout_get(void);
3394 * Set the duration for occuring long press event.
3396 * @param lonpress_timeout Timeout for long press event
3397 * @ingroup Longpress
3399 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3402 * @defgroup Debug Debug
3403 * don't use it unless you are sure
3409 * Print Tree object hierarchy in stdout
3411 * @param obj The root object
3414 EAPI void elm_object_tree_dump(const Evas_Object *top);
3415 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3417 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3418 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3420 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3422 * @param obj The root object
3423 * @param file The path of output file
3426 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3433 * @defgroup Theme Theme
3435 * Elementary uses Edje to theme its widgets, naturally. But for the most
3436 * part this is hidden behind a simpler interface that lets the user set
3437 * extensions and choose the style of widgets in a much easier way.
3439 * Instead of thinking in terms of paths to Edje files and their groups
3440 * each time you want to change the appearance of a widget, Elementary
3441 * works so you can add any theme file with extensions or replace the
3442 * main theme at one point in the application, and then just set the style
3443 * of widgets with elm_object_style_set() and related functions. Elementary
3444 * will then look in its list of themes for a matching group and apply it,
3445 * and when the theme changes midway through the application, all widgets
3446 * will be updated accordingly.
3448 * There are three concepts you need to know to understand how Elementary
3449 * theming works: default theme, extensions and overlays.
3451 * Default theme, obviously enough, is the one that provides the default
3452 * look of all widgets. End users can change the theme used by Elementary
3453 * by setting the @c ELM_THEME environment variable before running an
3454 * application, or globally for all programs using the @c elementary_config
3455 * utility. Applications can change the default theme using elm_theme_set(),
3456 * but this can go against the user wishes, so it's not an adviced practice.
3458 * Ideally, applications should find everything they need in the already
3459 * provided theme, but there may be occasions when that's not enough and
3460 * custom styles are required to correctly express the idea. For this
3461 * cases, Elementary has extensions.
3463 * Extensions allow the application developer to write styles of its own
3464 * to apply to some widgets. This requires knowledge of how each widget
3465 * is themed, as extensions will always replace the entire group used by
3466 * the widget, so important signals and parts need to be there for the
3467 * object to behave properly (see documentation of Edje for details).
3468 * Once the theme for the extension is done, the application needs to add
3469 * it to the list of themes Elementary will look into, using
3470 * elm_theme_extension_add(), and set the style of the desired widgets as
3471 * he would normally with elm_object_style_set().
3473 * Overlays, on the other hand, can replace the look of all widgets by
3474 * overriding the default style. Like extensions, it's up to the application
3475 * developer to write the theme for the widgets it wants, the difference
3476 * being that when looking for the theme, Elementary will check first the
3477 * list of overlays, then the set theme and lastly the list of extensions,
3478 * so with overlays it's possible to replace the default view and every
3479 * widget will be affected. This is very much alike to setting the whole
3480 * theme for the application and will probably clash with the end user
3481 * options, not to mention the risk of ending up with not matching styles
3482 * across the program. Unless there's a very special reason to use them,
3483 * overlays should be avoided for the resons exposed before.
3485 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3486 * keeps one default internally and every function that receives one of
3487 * these can be called with NULL to refer to this default (except for
3488 * elm_theme_free()). It's possible to create a new instance of a
3489 * ::Elm_Theme to set other theme for a specific widget (and all of its
3490 * children), but this is as discouraged, if not even more so, than using
3491 * overlays. Don't use this unless you really know what you are doing.
3493 * But to be less negative about things, you can look at the following
3495 * @li @ref theme_example_01 "Using extensions"
3496 * @li @ref theme_example_02 "Using overlays"
3501 * @typedef Elm_Theme
3503 * Opaque handler for the list of themes Elementary looks for when
3504 * rendering widgets.
3506 * Stay out of this unless you really know what you are doing. For most
3507 * cases, sticking to the default is all a developer needs.
3509 typedef struct _Elm_Theme Elm_Theme;
3512 * Create a new specific theme
3514 * This creates an empty specific theme that only uses the default theme. A
3515 * specific theme has its own private set of extensions and overlays too
3516 * (which are empty by default). Specific themes do not fall back to themes
3517 * of parent objects. They are not intended for this use. Use styles, overlays
3518 * and extensions when needed, but avoid specific themes unless there is no
3519 * other way (example: you want to have a preview of a new theme you are
3520 * selecting in a "theme selector" window. The preview is inside a scroller
3521 * and should display what the theme you selected will look like, but not
3522 * actually apply it yet. The child of the scroller will have a specific
3523 * theme set to show this preview before the user decides to apply it to all
3526 EAPI Elm_Theme *elm_theme_new(void);
3528 * Free a specific theme
3530 * @param th The theme to free
3532 * This frees a theme created with elm_theme_new().
3534 EAPI void elm_theme_free(Elm_Theme *th);
3536 * Copy the theme fom the source to the destination theme
3538 * @param th The source theme to copy from
3539 * @param thdst The destination theme to copy data to
3541 * This makes a one-time static copy of all the theme config, extensions
3542 * and overlays from @p th to @p thdst. If @p th references a theme, then
3543 * @p thdst is also set to reference it, with all the theme settings,
3544 * overlays and extensions that @p th had.
3546 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3548 * Tell the source theme to reference the ref theme
3550 * @param th The theme that will do the referencing
3551 * @param thref The theme that is the reference source
3553 * This clears @p th to be empty and then sets it to refer to @p thref
3554 * so @p th acts as an override to @p thref, but where its overrides
3555 * don't apply, it will fall through to @p thref for configuration.
3557 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3559 * Return the theme referred to
3561 * @param th The theme to get the reference from
3562 * @return The referenced theme handle
3564 * This gets the theme set as the reference theme by elm_theme_ref_set().
3565 * If no theme is set as a reference, NULL is returned.
3567 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3569 * Return the default theme
3571 * @return The default theme handle
3573 * This returns the internal default theme setup handle that all widgets
3574 * use implicitly unless a specific theme is set. This is also often use
3575 * as a shorthand of NULL.
3577 EAPI Elm_Theme *elm_theme_default_get(void);
3579 * Prepends a theme overlay to the list of overlays
3581 * @param th The theme to add to, or if NULL, the default theme
3582 * @param item The Edje file path to be used
3584 * Use this if your application needs to provide some custom overlay theme
3585 * (An Edje file that replaces some default styles of widgets) where adding
3586 * new styles, or changing system theme configuration is not possible. Do
3587 * NOT use this instead of a proper system theme configuration. Use proper
3588 * configuration files, profiles, environment variables etc. to set a theme
3589 * so that the theme can be altered by simple confiugration by a user. Using
3590 * this call to achieve that effect is abusing the API and will create lots
3593 * @see elm_theme_extension_add()
3595 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3597 * Delete a theme overlay from the list of overlays
3599 * @param th The theme to delete from, or if NULL, the default theme
3600 * @param item The name of the theme overlay
3602 * @see elm_theme_overlay_add()
3604 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3606 * Appends a theme extension to the list of extensions.
3608 * @param th The theme to add to, or if NULL, the default theme
3609 * @param item The Edje file path to be used
3611 * This is intended when an application needs more styles of widgets or new
3612 * widget themes that the default does not provide (or may not provide). The
3613 * application has "extended" usage by coming up with new custom style names
3614 * for widgets for specific uses, but as these are not "standard", they are
3615 * not guaranteed to be provided by a default theme. This means the
3616 * application is required to provide these extra elements itself in specific
3617 * Edje files. This call adds one of those Edje files to the theme search
3618 * path to be search after the default theme. The use of this call is
3619 * encouraged when default styles do not meet the needs of the application.
3620 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3622 * @see elm_object_style_set()
3624 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3626 * Deletes a theme extension from the list of extensions.
3628 * @param th The theme to delete from, or if NULL, the default theme
3629 * @param item The name of the theme extension
3631 * @see elm_theme_extension_add()
3633 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3635 * Set the theme search order for the given theme
3637 * @param th The theme to set the search order, or if NULL, the default theme
3638 * @param theme Theme search string
3640 * This sets the search string for the theme in path-notation from first
3641 * theme to search, to last, delimited by the : character. Example:
3643 * "shiny:/path/to/file.edj:default"
3645 * See the ELM_THEME environment variable for more information.
3647 * @see elm_theme_get()
3648 * @see elm_theme_list_get()
3650 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3652 * Return the theme search order
3654 * @param th The theme to get the search order, or if NULL, the default theme
3655 * @return The internal search order path
3657 * This function returns a colon separated string of theme elements as
3658 * returned by elm_theme_list_get().
3660 * @see elm_theme_set()
3661 * @see elm_theme_list_get()
3663 EAPI const char *elm_theme_get(Elm_Theme *th);
3665 * Return a list of theme elements to be used in a theme.
3667 * @param th Theme to get the list of theme elements from.
3668 * @return The internal list of theme elements
3670 * This returns the internal list of theme elements (will only be valid as
3671 * long as the theme is not modified by elm_theme_set() or theme is not
3672 * freed by elm_theme_free(). This is a list of strings which must not be
3673 * altered as they are also internal. If @p th is NULL, then the default
3674 * theme element list is returned.
3676 * A theme element can consist of a full or relative path to a .edj file,
3677 * or a name, without extension, for a theme to be searched in the known
3678 * theme paths for Elemementary.
3680 * @see elm_theme_set()
3681 * @see elm_theme_get()
3683 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3685 * Return the full patrh for a theme element
3687 * @param f The theme element name
3688 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3689 * @return The full path to the file found.
3691 * This returns a string you should free with free() on success, NULL on
3692 * failure. This will search for the given theme element, and if it is a
3693 * full or relative path element or a simple searchable name. The returned
3694 * path is the full path to the file, if searched, and the file exists, or it
3695 * is simply the full path given in the element or a resolved path if
3696 * relative to home. The @p in_search_path boolean pointed to is set to
3697 * EINA_TRUE if the file was a searchable file andis in the search path,
3698 * and EINA_FALSE otherwise.
3700 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3702 * Flush the current theme.
3704 * @param th Theme to flush
3706 * This flushes caches that let elementary know where to find theme elements
3707 * in the given theme. If @p th is NULL, then the default theme is flushed.
3708 * Call this function if source theme data has changed in such a way as to
3709 * make any caches Elementary kept invalid.
3711 EAPI void elm_theme_flush(Elm_Theme *th);
3713 * This flushes all themes (default and specific ones).
3715 * This will flush all themes in the current application context, by calling
3716 * elm_theme_flush() on each of them.
3718 EAPI void elm_theme_full_flush(void);
3720 * Set the theme for all elementary using applications on the current display
3722 * @param theme The name of the theme to use. Format same as the ELM_THEME
3723 * environment variable.
3725 EAPI void elm_theme_all_set(const char *theme);
3727 * Return a list of theme elements in the theme search path
3729 * @return A list of strings that are the theme element names.
3731 * This lists all available theme files in the standard Elementary search path
3732 * for theme elements, and returns them in alphabetical order as theme
3733 * element names in a list of strings. Free this with
3734 * elm_theme_name_available_list_free() when you are done with the list.
3736 EAPI Eina_List *elm_theme_name_available_list_new(void);
3738 * Free the list returned by elm_theme_name_available_list_new()
3740 * This frees the list of themes returned by
3741 * elm_theme_name_available_list_new(). Once freed the list should no longer
3742 * be used. a new list mys be created.
3744 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3746 * Set a specific theme to be used for this object and its children
3748 * @param obj The object to set the theme on
3749 * @param th The theme to set
3751 * This sets a specific theme that will be used for the given object and any
3752 * child objects it has. If @p th is NULL then the theme to be used is
3753 * cleared and the object will inherit its theme from its parent (which
3754 * ultimately will use the default theme if no specific themes are set).
3756 * Use special themes with great care as this will annoy users and make
3757 * configuration difficult. Avoid any custom themes at all if it can be
3760 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3762 * Get the specific theme to be used
3764 * @param obj The object to get the specific theme from
3765 * @return The specifc theme set.
3767 * This will return a specific theme set, or NULL if no specific theme is
3768 * set on that object. It will not return inherited themes from parents, only
3769 * the specific theme set for that specific object. See elm_object_theme_set()
3770 * for more information.
3772 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3775 * Get a data item from a theme
3777 * @param th The theme, or NULL for default theme
3778 * @param key The data key to search with
3779 * @return The data value, or NULL on failure
3781 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3782 * It works the same way as edje_file_data_get() except that the return is stringshared.
3784 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3790 /** @defgroup Win Win
3792 * @image html img/widget/win/preview-00.png
3793 * @image latex img/widget/win/preview-00.eps
3795 * The window class of Elementary. Contains functions to manipulate
3796 * windows. The Evas engine used to render the window contents is specified
3797 * in the system or user elementary config files (whichever is found last),
3798 * and can be overridden with the ELM_ENGINE environment variable for
3799 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3800 * compilation setup and modules actually installed at runtime) are (listed
3801 * in order of best supported and most likely to be complete and work to
3804 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3805 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3807 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3809 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3811 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3813 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3814 * rendering using SDL as the buffer)
3815 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3816 * GDI with software)
3817 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3818 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3819 * grayscale using dedicated 8bit software engine in X11)
3820 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3821 * X11 using 16bit software engine)
3822 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3823 * (Windows CE rendering via GDI with 16bit software renderer)
3824 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3825 * buffer with 16bit software renderer)
3826 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3827 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3828 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3830 * All engines use a simple string to select the engine to render, EXCEPT
3831 * the "shot" engine. This actually encodes the output of the virtual
3832 * screenshot and how long to delay in the engine string. The engine string
3833 * is encoded in the following way:
3835 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3837 * Where options are separated by a ":" char if more than one option is
3838 * given, with delay, if provided being the first option and file the last
3839 * (order is important). The delay specifies how long to wait after the
3840 * window is shown before doing the virtual "in memory" rendering and then
3841 * save the output to the file specified by the file option (and then exit).
3842 * If no delay is given, the default is 0.5 seconds. If no file is given the
3843 * default output file is "out.png". Repeat option is for continous
3844 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3845 * fixed to "out001.png" Some examples of using the shot engine:
3847 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3848 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3849 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3850 * ELM_ENGINE="shot:delay=2.0" elementary_test
3851 * ELM_ENGINE="shot:" elementary_test
3853 * Signals that you can add callbacks for are:
3855 * @li "delete,request": the user requested to close the window. See
3856 * elm_win_autodel_set().
3857 * @li "focus,in": window got focus
3858 * @li "focus,out": window lost focus
3859 * @li "moved": window that holds the canvas was moved
3862 * @li @ref win_example_01
3867 * Defines the types of window that can be created
3869 * These are hints set on the window so that a running Window Manager knows
3870 * how the window should be handled and/or what kind of decorations it
3873 * Currently, only the X11 backed engines use them.
3875 typedef enum _Elm_Win_Type
3877 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3878 window. Almost every window will be created with this
3880 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3881 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3882 window holding desktop icons. */
3883 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3884 be kept on top of any other window by the Window
3886 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3888 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3889 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3891 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3892 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3893 entry in a menubar is clicked. Typically used
3894 with elm_win_override_set(). This hint exists
3895 for completion only, as the EFL way of
3896 implementing a menu would not normally use a
3897 separate window for its contents. */
3898 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3899 triggered by right-clicking an object. */
3900 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3901 explanatory text that typically appear after the
3902 mouse cursor hovers over an object for a while.
3903 Typically used with elm_win_override_set() and also
3904 not very commonly used in the EFL. */
3905 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3906 battery life or a new E-Mail received. */
3907 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3908 usually used in the EFL. */
3909 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3910 object being dragged across different windows, or even
3911 applications. Typically used with
3912 elm_win_override_set(). */
3913 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3914 buffer. No actual window is created for this
3915 type, instead the window and all of its
3916 contents will be rendered to an image buffer.
3917 This allows to have children window inside a
3918 parent one just like any other object would
3919 be, and do other things like applying @c
3920 Evas_Map effects to it. This is the only type
3921 of window that requires the @c parent
3922 parameter of elm_win_add() to be a valid @c
3927 * The differents layouts that can be requested for the virtual keyboard.
3929 * When the application window is being managed by Illume, it may request
3930 * any of the following layouts for the virtual keyboard.
3932 typedef enum _Elm_Win_Keyboard_Mode
3934 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3935 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3936 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3937 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3938 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3939 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3940 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3941 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3942 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3943 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3944 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3945 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3946 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3947 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3948 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3949 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3950 } Elm_Win_Keyboard_Mode;
3953 * Available commands that can be sent to the Illume manager.
3955 * When running under an Illume session, a window may send commands to the
3956 * Illume manager to perform different actions.
3958 typedef enum _Elm_Illume_Command
3960 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3962 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3964 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3966 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3967 } Elm_Illume_Command;
3970 * Adds a window object. If this is the first window created, pass NULL as
3973 * @param parent Parent object to add the window to, or NULL
3974 * @param name The name of the window
3975 * @param type The window type, one of #Elm_Win_Type.
3977 * The @p parent paramter can be @c NULL for every window @p type except
3978 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3979 * which the image object will be created.
3981 * @return The created object, or NULL on failure
3983 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3985 * Adds a window object with standard setup
3987 * @param name The name of the window
3988 * @param title The title for the window
3990 * This creates a window like elm_win_add() but also puts in a standard
3991 * background with elm_bg_add(), as well as setting the window title to
3992 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3993 * as the parent widget.
3995 * @return The created object, or NULL on failure
3997 * @see elm_win_add()
3999 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4001 * Add @p subobj as a resize object of window @p obj.
4004 * Setting an object as a resize object of the window means that the
4005 * @p subobj child's size and position will be controlled by the window
4006 * directly. That is, the object will be resized to match the window size
4007 * and should never be moved or resized manually by the developer.
4009 * In addition, resize objects of the window control what the minimum size
4010 * of it will be, as well as whether it can or not be resized by the user.
4012 * For the end user to be able to resize a window by dragging the handles
4013 * or borders provided by the Window Manager, or using any other similar
4014 * mechanism, all of the resize objects in the window should have their
4015 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4017 * @param obj The window object
4018 * @param subobj The resize object to add
4020 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4022 * Delete @p subobj as a resize object of window @p obj.
4024 * This function removes the object @p subobj from the resize objects of
4025 * the window @p obj. It will not delete the object itself, which will be
4026 * left unmanaged and should be deleted by the developer, manually handled
4027 * or set as child of some other container.
4029 * @param obj The window object
4030 * @param subobj The resize object to add
4032 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4034 * Set the title of the window
4036 * @param obj The window object
4037 * @param title The title to set
4039 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4041 * Get the title of the window
4043 * The returned string is an internal one and should not be freed or
4044 * modified. It will also be rendered invalid if a new title is set or if
4045 * the window is destroyed.
4047 * @param obj The window object
4050 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4052 * Set the window's autodel state.
4054 * When closing the window in any way outside of the program control, like
4055 * pressing the X button in the titlebar or using a command from the
4056 * Window Manager, a "delete,request" signal is emitted to indicate that
4057 * this event occurred and the developer can take any action, which may
4058 * include, or not, destroying the window object.
4060 * When the @p autodel parameter is set, the window will be automatically
4061 * destroyed when this event occurs, after the signal is emitted.
4062 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4063 * and is up to the program to do so when it's required.
4065 * @param obj The window object
4066 * @param autodel If true, the window will automatically delete itself when
4069 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4071 * Get the window's autodel state.
4073 * @param obj The window object
4074 * @return If the window will automatically delete itself when closed
4076 * @see elm_win_autodel_set()
4078 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4080 * Activate a window object.
4082 * This function sends a request to the Window Manager to activate the
4083 * window pointed by @p obj. If honored by the WM, the window will receive
4084 * the keyboard focus.
4086 * @note This is just a request that a Window Manager may ignore, so calling
4087 * this function does not ensure in any way that the window will be the
4088 * active one after it.
4090 * @param obj The window object
4092 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4094 * Lower a window object.
4096 * Places the window pointed by @p obj at the bottom of the stack, so that
4097 * no other window is covered by it.
4099 * If elm_win_override_set() is not set, the Window Manager may ignore this
4102 * @param obj The window object
4104 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4106 * Raise a window object.
4108 * Places the window pointed by @p obj at the top of the stack, so that it's
4109 * not covered by any other window.
4111 * If elm_win_override_set() is not set, the Window Manager may ignore this
4114 * @param obj The window object
4116 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4118 * Set the borderless state of a window.
4120 * This function requests the Window Manager to not draw any decoration
4121 * around the window.
4123 * @param obj The window object
4124 * @param borderless If true, the window is borderless
4126 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4128 * Get the borderless state of a window.
4130 * @param obj The window object
4131 * @return If true, the window is borderless
4133 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4135 * Set the shaped state of a window.
4137 * Shaped windows, when supported, will render the parts of the window that
4138 * has no content, transparent.
4140 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4141 * background object or cover the entire window in any other way, or the
4142 * parts of the canvas that have no data will show framebuffer artifacts.
4144 * @param obj The window object
4145 * @param shaped If true, the window is shaped
4147 * @see elm_win_alpha_set()
4149 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4151 * Get the shaped state of a window.
4153 * @param obj The window object
4154 * @return If true, the window is shaped
4156 * @see elm_win_shaped_set()
4158 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4160 * Set the alpha channel state of a window.
4162 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4163 * possibly making parts of the window completely or partially transparent.
4164 * This is also subject to the underlying system supporting it, like for
4165 * example, running under a compositing manager. If no compositing is
4166 * available, enabling this option will instead fallback to using shaped
4167 * windows, with elm_win_shaped_set().
4169 * @param obj The window object
4170 * @param alpha If true, the window has an alpha channel
4172 * @see elm_win_alpha_set()
4174 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4176 * Get the transparency state of a window.
4178 * @param obj The window object
4179 * @return If true, the window is transparent
4181 * @see elm_win_transparent_set()
4183 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4185 * Set the transparency state of a window.
4187 * Use elm_win_alpha_set() instead.
4189 * @param obj The window object
4190 * @param transparent If true, the window is transparent
4192 * @see elm_win_alpha_set()
4194 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4196 * Get the alpha channel state of a window.
4198 * @param obj The window object
4199 * @return If true, the window has an alpha channel
4201 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4203 * Set the override state of a window.
4205 * A window with @p override set to EINA_TRUE will not be managed by the
4206 * Window Manager. This means that no decorations of any kind will be shown
4207 * for it, moving and resizing must be handled by the application, as well
4208 * as the window visibility.
4210 * This should not be used for normal windows, and even for not so normal
4211 * ones, it should only be used when there's a good reason and with a lot
4212 * of care. Mishandling override windows may result situations that
4213 * disrupt the normal workflow of the end user.
4215 * @param obj The window object
4216 * @param override If true, the window is overridden
4218 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4220 * Get the override state of a window.
4222 * @param obj The window object
4223 * @return If true, the window is overridden
4225 * @see elm_win_override_set()
4227 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4229 * Set the fullscreen state of a window.
4231 * @param obj The window object
4232 * @param fullscreen If true, the window is fullscreen
4234 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4236 * Get the fullscreen state of a window.
4238 * @param obj The window object
4239 * @return If true, the window is fullscreen
4241 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4243 * Set the maximized state of a window.
4245 * @param obj The window object
4246 * @param maximized If true, the window is maximized
4248 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4250 * Get the maximized state of a window.
4252 * @param obj The window object
4253 * @return If true, the window is maximized
4255 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4257 * Set the iconified state of a window.
4259 * @param obj The window object
4260 * @param iconified If true, the window is iconified
4262 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4264 * Get the iconified state of a window.
4266 * @param obj The window object
4267 * @return If true, the window is iconified
4269 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4271 * Set the layer of the window.
4273 * What this means exactly will depend on the underlying engine used.
4275 * In the case of X11 backed engines, the value in @p layer has the
4276 * following meanings:
4277 * @li < 3: The window will be placed below all others.
4278 * @li > 5: The window will be placed above all others.
4279 * @li other: The window will be placed in the default layer.
4281 * @param obj The window object
4282 * @param layer The layer of the window
4284 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4286 * Get the layer of the window.
4288 * @param obj The window object
4289 * @return The layer of the window
4291 * @see elm_win_layer_set()
4293 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4295 * Set the rotation of the window.
4297 * Most engines only work with multiples of 90.
4299 * This function is used to set the orientation of the window @p obj to
4300 * match that of the screen. The window itself will be resized to adjust
4301 * to the new geometry of its contents. If you want to keep the window size,
4302 * see elm_win_rotation_with_resize_set().
4304 * @param obj The window object
4305 * @param rotation The rotation of the window, in degrees (0-360),
4306 * counter-clockwise.
4308 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4310 * Rotates the window and resizes it.
4312 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4313 * that they fit inside the current window geometry.
4315 * @param obj The window object
4316 * @param layer The rotation of the window in degrees (0-360),
4317 * counter-clockwise.
4319 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4321 * Get the rotation of the window.
4323 * @param obj The window object
4324 * @return The rotation of the window in degrees (0-360)
4326 * @see elm_win_rotation_set()
4327 * @see elm_win_rotation_with_resize_set()
4329 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4331 * Set the sticky state of the window.
4333 * Hints the Window Manager that the window in @p obj should be left fixed
4334 * at its position even when the virtual desktop it's on moves or changes.
4336 * @param obj The window object
4337 * @param sticky If true, the window's sticky state is enabled
4339 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4341 * Get the sticky state of the window.
4343 * @param obj The window object
4344 * @return If true, the window's sticky state is enabled
4346 * @see elm_win_sticky_set()
4348 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4350 * Set if this window is an illume conformant window
4352 * @param obj The window object
4353 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4355 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4357 * Get if this window is an illume conformant window
4359 * @param obj The window object
4360 * @return A boolean if this window is illume conformant or not
4362 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4364 * Set a window to be an illume quickpanel window
4366 * By default window objects are not quickpanel windows.
4368 * @param obj The window object
4369 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4371 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4373 * Get if this window is a quickpanel or not
4375 * @param obj The window object
4376 * @return A boolean if this window is a quickpanel or not
4378 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4380 * Set the major priority of a quickpanel window
4382 * @param obj The window object
4383 * @param priority The major priority for this quickpanel
4385 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4387 * Get the major priority of a quickpanel window
4389 * @param obj The window object
4390 * @return The major priority of this quickpanel
4392 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4394 * Set the minor priority of a quickpanel window
4396 * @param obj The window object
4397 * @param priority The minor priority for this quickpanel
4399 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4401 * Get the minor priority of a quickpanel window
4403 * @param obj The window object
4404 * @return The minor priority of this quickpanel
4406 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4408 * Set which zone this quickpanel should appear in
4410 * @param obj The window object
4411 * @param zone The requested zone for this quickpanel
4413 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4415 * Get which zone this quickpanel should appear in
4417 * @param obj The window object
4418 * @return The requested zone for this quickpanel
4420 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4422 * Set the window to be skipped by keyboard focus
4424 * This sets the window to be skipped by normal keyboard input. This means
4425 * a window manager will be asked to not focus this window as well as omit
4426 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4428 * Call this and enable it on a window BEFORE you show it for the first time,
4429 * otherwise it may have no effect.
4431 * Use this for windows that have only output information or might only be
4432 * interacted with by the mouse or fingers, and never for typing input.
4433 * Be careful that this may have side-effects like making the window
4434 * non-accessible in some cases unless the window is specially handled. Use
4437 * @param obj The window object
4438 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4440 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4442 * Send a command to the windowing environment
4444 * This is intended to work in touchscreen or small screen device
4445 * environments where there is a more simplistic window management policy in
4446 * place. This uses the window object indicated to select which part of the
4447 * environment to control (the part that this window lives in), and provides
4448 * a command and an optional parameter structure (use NULL for this if not
4451 * @param obj The window object that lives in the environment to control
4452 * @param command The command to send
4453 * @param params Optional parameters for the command
4455 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4457 * Get the inlined image object handle
4459 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4460 * then the window is in fact an evas image object inlined in the parent
4461 * canvas. You can get this object (be careful to not manipulate it as it
4462 * is under control of elementary), and use it to do things like get pixel
4463 * data, save the image to a file, etc.
4465 * @param obj The window object to get the inlined image from
4466 * @return The inlined image object, or NULL if none exists
4468 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4470 * Determine whether a window has focus
4471 * @param obj The window to query
4472 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4474 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4476 * Get screen geometry details for the screen that a window is on
4477 * @param obj The window to query
4478 * @param x where to return the horizontal offset value. May be NULL.
4479 * @param y where to return the vertical offset value. May be NULL.
4480 * @param w where to return the width value. May be NULL.
4481 * @param h where to return the height value. May be NULL.
4483 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4485 * Set the enabled status for the focus highlight in a window
4487 * This function will enable or disable the focus highlight only for the
4488 * given window, regardless of the global setting for it
4490 * @param obj The window where to enable the highlight
4491 * @param enabled The enabled value for the highlight
4493 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4495 * Get the enabled value of the focus highlight for this window
4497 * @param obj The window in which to check if the focus highlight is enabled
4499 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4501 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4503 * Set the style for the focus highlight on this window
4505 * Sets the style to use for theming the highlight of focused objects on
4506 * the given window. If @p style is NULL, the default will be used.
4508 * @param obj The window where to set the style
4509 * @param style The style to set
4511 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4513 * Get the style set for the focus highlight object
4515 * Gets the style set for this windows highilght object, or NULL if none
4518 * @param obj The window to retrieve the highlights style from
4520 * @return The style set or NULL if none was. Default is used in that case.
4522 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4523 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4524 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4526 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4527 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4528 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4529 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4530 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4531 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4532 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4534 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4535 * (blank mouse, private mouse obj, defaultmouse)
4539 * Sets the keyboard mode of the window.
4541 * @param obj The window object
4542 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4544 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4546 * Gets the keyboard mode of the window.
4548 * @param obj The window object
4549 * @return The mode, one of #Elm_Win_Keyboard_Mode
4551 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4553 * Sets whether the window is a keyboard.
4555 * @param obj The window object
4556 * @param is_keyboard If true, the window is a virtual keyboard
4558 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4560 * Gets whether the window is a keyboard.
4562 * @param obj The window object
4563 * @return If the window is a virtual keyboard
4565 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4568 * Get the screen position of a window.
4570 * @param obj The window object
4571 * @param x The int to store the x coordinate to
4572 * @param y The int to store the y coordinate to
4574 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4580 * @defgroup Inwin Inwin
4582 * @image html img/widget/inwin/preview-00.png
4583 * @image latex img/widget/inwin/preview-00.eps
4584 * @image html img/widget/inwin/preview-01.png
4585 * @image latex img/widget/inwin/preview-01.eps
4586 * @image html img/widget/inwin/preview-02.png
4587 * @image latex img/widget/inwin/preview-02.eps
4589 * An inwin is a window inside a window that is useful for a quick popup.
4590 * It does not hover.
4592 * It works by creating an object that will occupy the entire window, so it
4593 * must be created using an @ref Win "elm_win" as parent only. The inwin
4594 * object can be hidden or restacked below every other object if it's
4595 * needed to show what's behind it without destroying it. If this is done,
4596 * the elm_win_inwin_activate() function can be used to bring it back to
4597 * full visibility again.
4599 * There are three styles available in the default theme. These are:
4600 * @li default: The inwin is sized to take over most of the window it's
4602 * @li minimal: The size of the inwin will be the minimum necessary to show
4604 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4605 * possible, but it's sized vertically the most it needs to fit its\
4608 * Some examples of Inwin can be found in the following:
4609 * @li @ref inwin_example_01
4614 * Adds an inwin to the current window
4616 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4617 * Never call this function with anything other than the top-most window
4618 * as its parameter, unless you are fond of undefined behavior.
4620 * After creating the object, the widget will set itself as resize object
4621 * for the window with elm_win_resize_object_add(), so when shown it will
4622 * appear to cover almost the entire window (how much of it depends on its
4623 * content and the style used). It must not be added into other container
4624 * objects and it needs not be moved or resized manually.
4626 * @param parent The parent object
4627 * @return The new object or NULL if it cannot be created
4629 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4631 * Activates an inwin object, ensuring its visibility
4633 * This function will make sure that the inwin @p obj is completely visible
4634 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4635 * to the front. It also sets the keyboard focus to it, which will be passed
4638 * The object's theme will also receive the signal "elm,action,show" with
4641 * @param obj The inwin to activate
4643 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4645 * Set the content of an inwin object.
4647 * Once the content object is set, a previously set one will be deleted.
4648 * If you want to keep that old content object, use the
4649 * elm_win_inwin_content_unset() function.
4651 * @param obj The inwin object
4652 * @param content The object to set as content
4654 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4656 * Get the content of an inwin object.
4658 * Return the content object which is set for this widget.
4660 * The returned object is valid as long as the inwin is still alive and no
4661 * other content is set on it. Deleting the object will notify the inwin
4662 * about it and this one will be left empty.
4664 * If you need to remove an inwin's content to be reused somewhere else,
4665 * see elm_win_inwin_content_unset().
4667 * @param obj The inwin object
4668 * @return The content that is being used
4670 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4672 * Unset the content of an inwin object.
4674 * Unparent and return the content object which was set for this widget.
4676 * @param obj The inwin object
4677 * @return The content that was being used
4679 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4683 /* X specific calls - won't work on non-x engines (return 0) */
4686 * Get the Ecore_X_Window of an Evas_Object
4688 * @param obj The object
4690 * @return The Ecore_X_Window of @p obj
4694 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4696 /* smart callbacks called:
4697 * "delete,request" - the user requested to delete the window
4698 * "focus,in" - window got focus
4699 * "focus,out" - window lost focus
4700 * "moved" - window that holds the canvas was moved
4706 * @image html img/widget/bg/preview-00.png
4707 * @image latex img/widget/bg/preview-00.eps
4709 * @brief Background object, used for setting a solid color, image or Edje
4710 * group as background to a window or any container object.
4712 * The bg object is used for setting a solid background to a window or
4713 * packing into any container object. It works just like an image, but has
4714 * some properties useful to a background, like setting it to tiled,
4715 * centered, scaled or stretched.
4717 * Default contents parts of the bg widget that you can use for are:
4718 * @li "overlay" - overlay of the bg
4720 * Here is some sample code using it:
4721 * @li @ref bg_01_example_page
4722 * @li @ref bg_02_example_page
4723 * @li @ref bg_03_example_page
4727 typedef enum _Elm_Bg_Option
4729 ELM_BG_OPTION_CENTER, /**< center the background */
4730 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4731 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4732 ELM_BG_OPTION_TILE /**< tile background at its original size */
4736 * Add a new background to the parent
4738 * @param parent The parent object
4739 * @return The new object or NULL if it cannot be created
4743 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4746 * Set the file (image or edje) used for the background
4748 * @param obj The bg object
4749 * @param file The file path
4750 * @param group Optional key (group in Edje) within the file
4752 * This sets the image file used in the background object. The image (or edje)
4753 * will be stretched (retaining aspect if its an image file) to completely fill
4754 * the bg object. This may mean some parts are not visible.
4756 * @note Once the image of @p obj is set, a previously set one will be deleted,
4757 * even if @p file is NULL.
4761 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4764 * Get the file (image or edje) used for the background
4766 * @param obj The bg object
4767 * @param file The file path
4768 * @param group Optional key (group in Edje) within the file
4772 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4775 * Set the option used for the background image
4777 * @param obj The bg object
4778 * @param option The desired background option (TILE, SCALE)
4780 * This sets the option used for manipulating the display of the background
4781 * image. The image can be tiled or scaled.
4785 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4788 * Get the option used for the background image
4790 * @param obj The bg object
4791 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4795 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4797 * Set the option used for the background color
4799 * @param obj The bg object
4804 * This sets the color used for the background rectangle. Its range goes
4809 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4811 * Get the option used for the background color
4813 * @param obj The bg object
4820 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4823 * Set the overlay object used for the background object.
4825 * @param obj The bg object
4826 * @param overlay The overlay object
4828 * This provides a way for elm_bg to have an 'overlay' that will be on top
4829 * of the bg. Once the over object is set, a previously set one will be
4830 * deleted, even if you set the new one to NULL. If you want to keep that
4831 * old content object, use the elm_bg_overlay_unset() function.
4833 * @deprecated use elm_object_part_content_set() instead
4838 WILL_DEPRECATE EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4841 * Get the overlay object used for the background object.
4843 * @param obj The bg object
4844 * @return The content that is being used
4846 * Return the content object which is set for this widget
4848 * @deprecated use elm_object_part_content_get() instead
4852 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4855 * Get the overlay object used for the background object.
4857 * @param obj The bg object
4858 * @return The content that was being used
4860 * Unparent and return the overlay object which was set for this widget
4862 * @deprecated use elm_object_part_content_unset() instead
4866 WILL_DEPRECATE EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4869 * Set the size of the pixmap representation of the image.
4871 * This option just makes sense if an image is going to be set in the bg.
4873 * @param obj The bg object
4874 * @param w The new width of the image pixmap representation.
4875 * @param h The new height of the image pixmap representation.
4877 * This function sets a new size for pixmap representation of the given bg
4878 * image. It allows the image to be loaded already in the specified size,
4879 * reducing the memory usage and load time when loading a big image with load
4880 * size set to a smaller size.
4882 * NOTE: this is just a hint, the real size of the pixmap may differ
4883 * depending on the type of image being loaded, being bigger than requested.
4887 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4888 /* smart callbacks called:
4892 * @defgroup Icon Icon
4894 * @image html img/widget/icon/preview-00.png
4895 * @image latex img/widget/icon/preview-00.eps
4897 * An object that provides standard icon images (delete, edit, arrows, etc.)
4898 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4900 * The icon image requested can be in the elementary theme, or in the
4901 * freedesktop.org paths. It's possible to set the order of preference from
4902 * where the image will be used.
4904 * This API is very similar to @ref Image, but with ready to use images.
4906 * Default images provided by the theme are described below.
4908 * The first list contains icons that were first intended to be used in
4909 * toolbars, but can be used in many other places too:
4925 * Now some icons that were designed to be used in menus (but again, you can
4926 * use them anywhere else):
4931 * @li menu/arrow_down
4932 * @li menu/arrow_left
4933 * @li menu/arrow_right
4942 * And here we have some media player specific icons:
4943 * @li media_player/forward
4944 * @li media_player/info
4945 * @li media_player/next
4946 * @li media_player/pause
4947 * @li media_player/play
4948 * @li media_player/prev
4949 * @li media_player/rewind
4950 * @li media_player/stop
4952 * Signals that you can add callbacks for are:
4954 * "clicked" - This is called when a user has clicked the icon
4956 * An example of usage for this API follows:
4957 * @li @ref tutorial_icon
4965 typedef enum _Elm_Icon_Type
4972 * @enum _Elm_Icon_Lookup_Order
4973 * @typedef Elm_Icon_Lookup_Order
4975 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4976 * theme, FDO paths, or both?
4980 typedef enum _Elm_Icon_Lookup_Order
4982 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4983 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4984 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4985 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4986 } Elm_Icon_Lookup_Order;
4989 * Add a new icon object to the parent.
4991 * @param parent The parent object
4992 * @return The new object or NULL if it cannot be created
4994 * @see elm_icon_file_set()
4998 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5000 * Set the file that will be used as icon.
5002 * @param obj The icon object
5003 * @param file The path to file that will be used as icon image
5004 * @param group The group that the icon belongs to an edje file
5006 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5008 * @note The icon image set by this function can be changed by
5009 * elm_icon_standard_set().
5011 * @see elm_icon_file_get()
5015 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5017 * Set a location in memory to be used as an icon
5019 * @param obj The icon object
5020 * @param img The binary data that will be used as an image
5021 * @param size The size of binary data @p img
5022 * @param format Optional format of @p img to pass to the image loader
5023 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5025 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5027 * @note The icon image set by this function can be changed by
5028 * elm_icon_standard_set().
5032 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);
5034 * Get the file that will be used as icon.
5036 * @param obj The icon object
5037 * @param file The path to file that will be used as the icon image
5038 * @param group The group that the icon belongs to, in edje file
5040 * @see elm_icon_file_set()
5044 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5045 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5047 * Set the icon by icon standards names.
5049 * @param obj The icon object
5050 * @param name The icon name
5052 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5054 * For example, freedesktop.org defines standard icon names such as "home",
5055 * "network", etc. There can be different icon sets to match those icon
5056 * keys. The @p name given as parameter is one of these "keys", and will be
5057 * used to look in the freedesktop.org paths and elementary theme. One can
5058 * change the lookup order with elm_icon_order_lookup_set().
5060 * If name is not found in any of the expected locations and it is the
5061 * absolute path of an image file, this image will be used.
5063 * @note The icon image set by this function can be changed by
5064 * elm_icon_file_set().
5066 * @see elm_icon_standard_get()
5067 * @see elm_icon_file_set()
5071 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5073 * Get the icon name set by icon standard names.
5075 * @param obj The icon object
5076 * @return The icon name
5078 * If the icon image was set using elm_icon_file_set() instead of
5079 * elm_icon_standard_set(), then this function will return @c NULL.
5081 * @see elm_icon_standard_set()
5085 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5087 * Set the smooth scaling for an icon object.
5089 * @param obj The icon object
5090 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5091 * otherwise. Default is @c EINA_TRUE.
5093 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5094 * scaling provides a better resulting image, but is slower.
5096 * The smooth scaling should be disabled when making animations that change
5097 * the icon size, since they will be faster. Animations that don't require
5098 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5099 * is already scaled, since the scaled icon image will be cached).
5101 * @see elm_icon_smooth_get()
5105 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5107 * Get whether smooth scaling is enabled for an icon object.
5109 * @param obj The icon object
5110 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5112 * @see elm_icon_smooth_set()
5116 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5118 * Disable scaling of this object.
5120 * @param obj The icon object.
5121 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5122 * otherwise. Default is @c EINA_FALSE.
5124 * This function disables scaling of the icon object through the function
5125 * elm_object_scale_set(). However, this does not affect the object
5126 * size/resize in any way. For that effect, take a look at
5127 * elm_icon_scale_set().
5129 * @see elm_icon_no_scale_get()
5130 * @see elm_icon_scale_set()
5131 * @see elm_object_scale_set()
5135 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5137 * Get whether scaling is disabled on the object.
5139 * @param obj The icon object
5140 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5142 * @see elm_icon_no_scale_set()
5146 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5148 * Set if the object is (up/down) resizable.
5150 * @param obj The icon object
5151 * @param scale_up A bool to set if the object is resizable up. Default is
5153 * @param scale_down A bool to set if the object is resizable down. Default
5156 * This function limits the icon object resize ability. If @p scale_up is set to
5157 * @c EINA_FALSE, the object can't have its height or width resized to a value
5158 * higher than the original icon size. Same is valid for @p scale_down.
5160 * @see elm_icon_scale_get()
5164 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5166 * Get if the object is (up/down) resizable.
5168 * @param obj The icon object
5169 * @param scale_up A bool to set if the object is resizable up
5170 * @param scale_down A bool to set if the object is resizable down
5172 * @see elm_icon_scale_set()
5176 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5178 * Get the object's image size
5180 * @param obj The icon object
5181 * @param w A pointer to store the width in
5182 * @param h A pointer to store the height in
5186 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5188 * Set if the icon fill the entire object area.
5190 * @param obj The icon object
5191 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5192 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5194 * When the icon object is resized to a different aspect ratio from the
5195 * original icon image, the icon image will still keep its aspect. This flag
5196 * tells how the image should fill the object's area. They are: keep the
5197 * entire icon inside the limits of height and width of the object (@p
5198 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5199 * of the object, and the icon will fill the entire object (@p fill_outside
5202 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5203 * retain property to false. Thus, the icon image will always keep its
5204 * original aspect ratio.
5206 * @see elm_icon_fill_outside_get()
5207 * @see elm_image_fill_outside_set()
5211 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5213 * Get if the object is filled outside.
5215 * @param obj The icon object
5216 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5218 * @see elm_icon_fill_outside_set()
5222 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224 * Set the prescale size for the icon.
5226 * @param obj The icon object
5227 * @param size The prescale size. This value is used for both width and
5230 * This function sets a new size for pixmap representation of the given
5231 * icon. It allows the icon to be loaded already in the specified size,
5232 * reducing the memory usage and load time when loading a big icon with load
5233 * size set to a smaller size.
5235 * It's equivalent to the elm_bg_load_size_set() function for bg.
5237 * @note this is just a hint, the real size of the pixmap may differ
5238 * depending on the type of icon being loaded, being bigger than requested.
5240 * @see elm_icon_prescale_get()
5241 * @see elm_bg_load_size_set()
5245 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5247 * Get the prescale size for the icon.
5249 * @param obj The icon object
5250 * @return The prescale size
5252 * @see elm_icon_prescale_set()
5256 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5258 * Gets the image object of the icon. DO NOT MODIFY THIS.
5260 * @param obj The icon object
5261 * @return The internal icon object
5265 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5267 * Sets the icon lookup order used by elm_icon_standard_set().
5269 * @param obj The icon object
5270 * @param order The icon lookup order (can be one of
5271 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5272 * or ELM_ICON_LOOKUP_THEME)
5274 * @see elm_icon_order_lookup_get()
5275 * @see Elm_Icon_Lookup_Order
5279 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5281 * Gets the icon lookup order.
5283 * @param obj The icon object
5284 * @return The icon lookup order
5286 * @see elm_icon_order_lookup_set()
5287 * @see Elm_Icon_Lookup_Order
5291 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5293 * Enable or disable preloading of the icon
5295 * @param obj The icon object
5296 * @param disable If EINA_TRUE, preloading will be disabled
5299 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5301 * Get if the icon supports animation or not.
5303 * @param obj The icon object
5304 * @return @c EINA_TRUE if the icon supports animation,
5305 * @c EINA_FALSE otherwise.
5307 * Return if this elm icon's image can be animated. Currently Evas only
5308 * supports gif animation. If the return value is EINA_FALSE, other
5309 * elm_icon_animated_XXX APIs won't work.
5312 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314 * Set animation mode of the icon.
5316 * @param obj The icon object
5317 * @param anim @c EINA_TRUE if the object do animation job,
5318 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5320 * Since the default animation mode is set to EINA_FALSE,
5321 * the icon is shown without animation.
5322 * This might be desirable when the application developer wants to show
5323 * a snapshot of the animated icon.
5324 * Set it to EINA_TRUE when the icon needs to be animated.
5327 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5329 * Get animation mode of the icon.
5331 * @param obj The icon object
5332 * @return The animation mode of the icon object
5333 * @see elm_icon_animated_set
5336 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5338 * Set animation play mode of the icon.
5340 * @param obj The icon object
5341 * @param play @c EINA_TRUE the object play animation images,
5342 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5344 * To play elm icon's animation, set play to EINA_TURE.
5345 * For example, you make gif player using this set/get API and click event.
5347 * 1. Click event occurs
5348 * 2. Check play flag using elm_icon_animaged_play_get
5349 * 3. If elm icon was playing, set play to EINA_FALSE.
5350 * Then animation will be stopped and vice versa
5353 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5355 * Get animation play mode of the icon.
5357 * @param obj The icon object
5358 * @return The play mode of the icon object
5360 * @see elm_icon_animated_play_get
5363 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5365 /* compatibility code to avoid API and ABI breaks */
5366 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5368 elm_icon_animated_set(obj, animated);
5371 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5373 return elm_icon_animated_get(obj);
5376 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5378 elm_icon_animated_play_set(obj, play);
5381 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5383 return elm_icon_animated_play_get(obj);
5391 * @defgroup Image Image
5393 * @image html img/widget/image/preview-00.png
5394 * @image latex img/widget/image/preview-00.eps
5397 * An object that allows one to load an image file to it. It can be used
5398 * anywhere like any other elementary widget.
5400 * This widget provides most of the functionality provided from @ref Bg or @ref
5401 * Icon, but with a slightly different API (use the one that fits better your
5404 * The features not provided by those two other image widgets are:
5405 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5406 * @li change the object orientation with elm_image_orient_set();
5407 * @li and turning the image editable with elm_image_editable_set().
5409 * Signals that you can add callbacks for are:
5411 * @li @c "clicked" - This is called when a user has clicked the image
5413 * An example of usage for this API follows:
5414 * @li @ref tutorial_image
5423 * @enum _Elm_Image_Orient
5424 * @typedef Elm_Image_Orient
5426 * Possible orientation options for elm_image_orient_set().
5428 * @image html elm_image_orient_set.png
5429 * @image latex elm_image_orient_set.eps width=\textwidth
5433 typedef enum _Elm_Image_Orient
5435 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5436 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5437 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5438 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5439 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5440 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5441 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5442 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5446 * Add a new image to the parent.
5448 * @param parent The parent object
5449 * @return The new object or NULL if it cannot be created
5451 * @see elm_image_file_set()
5455 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5457 * Set the file that will be used as image.
5459 * @param obj The image object
5460 * @param file The path to file that will be used as image
5461 * @param group The group that the image belongs in edje file (if it's an
5464 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5466 * @see elm_image_file_get()
5470 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5472 * Get the file that will be used as image.
5474 * @param obj The image object
5475 * @param file The path to file
5476 * @param group The group that the image belongs in edje file
5478 * @see elm_image_file_set()
5482 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5484 * Set the smooth effect for an image.
5486 * @param obj The image object
5487 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5488 * otherwise. Default is @c EINA_TRUE.
5490 * Set the scaling algorithm to be used when scaling the image. Smooth
5491 * scaling provides a better resulting image, but is slower.
5493 * The smooth scaling should be disabled when making animations that change
5494 * the image size, since it will be faster. Animations that don't require
5495 * resizing of the image can keep the smooth scaling enabled (even if the
5496 * image is already scaled, since the scaled image will be cached).
5498 * @see elm_image_smooth_get()
5502 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5504 * Get the smooth effect for an image.
5506 * @param obj The image object
5507 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5509 * @see elm_image_smooth_get()
5513 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5516 * Gets the current size of the image.
5518 * @param obj The image object.
5519 * @param w Pointer to store width, or NULL.
5520 * @param h Pointer to store height, or NULL.
5522 * This is the real size of the image, not the size of the object.
5524 * On error, neither w or h will be written.
5528 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5530 * Disable scaling of this object.
5532 * @param obj The image object.
5533 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5534 * otherwise. Default is @c EINA_FALSE.
5536 * This function disables scaling of the elm_image widget through the
5537 * function elm_object_scale_set(). However, this does not affect the widget
5538 * size/resize in any way. For that effect, take a look at
5539 * elm_image_scale_set().
5541 * @see elm_image_no_scale_get()
5542 * @see elm_image_scale_set()
5543 * @see elm_object_scale_set()
5547 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5549 * Get whether scaling is disabled on the object.
5551 * @param obj The image object
5552 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5554 * @see elm_image_no_scale_set()
5558 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5560 * Set if the object is (up/down) resizable.
5562 * @param obj The image object
5563 * @param scale_up A bool to set if the object is resizable up. Default is
5565 * @param scale_down A bool to set if the object is resizable down. Default
5568 * This function limits the image resize ability. If @p scale_up is set to
5569 * @c EINA_FALSE, the object can't have its height or width resized to a value
5570 * higher than the original image size. Same is valid for @p scale_down.
5572 * @see elm_image_scale_get()
5576 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5578 * Get if the object is (up/down) resizable.
5580 * @param obj The image object
5581 * @param scale_up A bool to set if the object is resizable up
5582 * @param scale_down A bool to set if the object is resizable down
5584 * @see elm_image_scale_set()
5588 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5590 * Set if the image fills the entire object area, when keeping the aspect ratio.
5592 * @param obj The image object
5593 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5594 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5596 * When the image should keep its aspect ratio even if resized to another
5597 * aspect ratio, there are two possibilities to resize it: keep the entire
5598 * image inside the limits of height and width of the object (@p fill_outside
5599 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5600 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5602 * @note This option will have no effect if
5603 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5605 * @see elm_image_fill_outside_get()
5606 * @see elm_image_aspect_ratio_retained_set()
5610 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5612 * Get if the object is filled outside
5614 * @param obj The image object
5615 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5617 * @see elm_image_fill_outside_set()
5621 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5623 * Set the prescale size for the image
5625 * @param obj The image object
5626 * @param size The prescale size. This value is used for both width and
5629 * This function sets a new size for pixmap representation of the given
5630 * image. It allows the image to be loaded already in the specified size,
5631 * reducing the memory usage and load time when loading a big image with load
5632 * size set to a smaller size.
5634 * It's equivalent to the elm_bg_load_size_set() function for bg.
5636 * @note this is just a hint, the real size of the pixmap may differ
5637 * depending on the type of image being loaded, being bigger than requested.
5639 * @see elm_image_prescale_get()
5640 * @see elm_bg_load_size_set()
5644 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5646 * Get the prescale size for the image
5648 * @param obj The image object
5649 * @return The prescale size
5651 * @see elm_image_prescale_set()
5655 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5657 * Set the image orientation.
5659 * @param obj The image object
5660 * @param orient The image orientation @ref Elm_Image_Orient
5661 * Default is #ELM_IMAGE_ORIENT_NONE.
5663 * This function allows to rotate or flip the given image.
5665 * @see elm_image_orient_get()
5666 * @see @ref Elm_Image_Orient
5670 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5672 * Get the image orientation.
5674 * @param obj The image object
5675 * @return The image orientation @ref Elm_Image_Orient
5677 * @see elm_image_orient_set()
5678 * @see @ref Elm_Image_Orient
5682 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5684 * Make the image 'editable'.
5686 * @param obj Image object.
5687 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5689 * This means the image is a valid drag target for drag and drop, and can be
5690 * cut or pasted too.
5694 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5696 * Check if the image 'editable'.
5698 * @param obj Image object.
5699 * @return Editability.
5701 * A return value of EINA_TRUE means the image is a valid drag target
5702 * for drag and drop, and can be cut or pasted too.
5706 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5708 * Get the basic Evas_Image object from this object (widget).
5710 * @param obj The image object to get the inlined image from
5711 * @return The inlined image object, or NULL if none exists
5713 * This function allows one to get the underlying @c Evas_Object of type
5714 * Image from this elementary widget. It can be useful to do things like get
5715 * the pixel data, save the image to a file, etc.
5717 * @note Be careful to not manipulate it, as it is under control of
5722 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5724 * Set whether the original aspect ratio of the image should be kept on resize.
5726 * @param obj The image object.
5727 * @param retained @c EINA_TRUE if the image should retain the aspect,
5728 * @c EINA_FALSE otherwise.
5730 * The original aspect ratio (width / height) of the image is usually
5731 * distorted to match the object's size. Enabling this option will retain
5732 * this original aspect, and the way that the image is fit into the object's
5733 * area depends on the option set by elm_image_fill_outside_set().
5735 * @see elm_image_aspect_ratio_retained_get()
5736 * @see elm_image_fill_outside_set()
5740 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5742 * Get if the object retains the original aspect ratio.
5744 * @param obj The image object.
5745 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5750 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5757 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5759 /* old API compatibility */
5760 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5762 typedef enum _Elm_GLView_Mode
5764 ELM_GLVIEW_ALPHA = 1,
5765 ELM_GLVIEW_DEPTH = 2,
5766 ELM_GLVIEW_STENCIL = 4
5770 * Defines a policy for the glview resizing.
5772 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5774 typedef enum _Elm_GLView_Resize_Policy
5776 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5777 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5778 } Elm_GLView_Resize_Policy;
5780 typedef enum _Elm_GLView_Render_Policy
5782 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5783 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5784 } Elm_GLView_Render_Policy;
5789 * A simple GLView widget that allows GL rendering.
5791 * Signals that you can add callbacks for are:
5797 * Add a new glview to the parent
5799 * @param parent The parent object
5800 * @return The new object or NULL if it cannot be created
5804 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5807 * Sets the size of the glview
5809 * @param obj The glview object
5810 * @param width width of the glview object
5811 * @param height height of the glview object
5815 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5818 * Gets the size of the glview.
5820 * @param obj The glview object
5821 * @param width width of the glview object
5822 * @param height height of the glview object
5824 * Note that this function returns the actual image size of the
5825 * glview. This means that when the scale policy is set to
5826 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5831 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5834 * Gets the gl api struct for gl rendering
5836 * @param obj The glview object
5837 * @return The api object or NULL if it cannot be created
5841 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5844 * Set the mode of the GLView. Supports Three simple modes.
5846 * @param obj The glview object
5847 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5848 * @return True if set properly.
5852 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5855 * Set the resize policy for the glview object.
5857 * @param obj The glview object.
5858 * @param policy The scaling policy.
5860 * By default, the resize policy is set to
5861 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5862 * destroys the previous surface and recreates the newly specified
5863 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5864 * however, glview only scales the image object and not the underlying
5869 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5872 * Set the render policy for the glview object.
5874 * @param obj The glview object.
5875 * @param policy The render policy.
5877 * By default, the render policy is set to
5878 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5879 * that during the render loop, glview is only redrawn if it needs
5880 * to be redrawn. (i.e. When it is visible) If the policy is set to
5881 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5882 * whether it is visible/need redrawing or not.
5886 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5889 * Set the init function that runs once in the main loop.
5891 * @param obj The glview object.
5892 * @param func The init function to be registered.
5894 * The registered init function gets called once during the render loop.
5898 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5901 * Set the render function that runs in the main loop.
5903 * @param obj The glview object.
5904 * @param func The delete function to be registered.
5906 * The registered del function gets called when GLView object is deleted.
5910 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5913 * Set the resize function that gets called when resize happens.
5915 * @param obj The glview object.
5916 * @param func The resize function to be registered.
5920 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5923 * Set the render function that runs in the main loop.
5925 * @param obj The glview object.
5926 * @param func The render function to be registered.
5930 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5933 * Notifies that there has been changes in the GLView.
5935 * @param obj The glview object.
5939 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5949 * @image html img/widget/box/preview-00.png
5950 * @image latex img/widget/box/preview-00.eps width=\textwidth
5952 * @image html img/box.png
5953 * @image latex img/box.eps width=\textwidth
5955 * A box arranges objects in a linear fashion, governed by a layout function
5956 * that defines the details of this arrangement.
5958 * By default, the box will use an internal function to set the layout to
5959 * a single row, either vertical or horizontal. This layout is affected
5960 * by a number of parameters, such as the homogeneous flag set by
5961 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5962 * elm_box_align_set() and the hints set to each object in the box.
5964 * For this default layout, it's possible to change the orientation with
5965 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5966 * placing its elements ordered from top to bottom. When horizontal is set,
5967 * the order will go from left to right. If the box is set to be
5968 * homogeneous, every object in it will be assigned the same space, that
5969 * of the largest object. Padding can be used to set some spacing between
5970 * the cell given to each object. The alignment of the box, set with
5971 * elm_box_align_set(), determines how the bounding box of all the elements
5972 * will be placed within the space given to the box widget itself.
5974 * The size hints of each object also affect how they are placed and sized
5975 * within the box. evas_object_size_hint_min_set() will give the minimum
5976 * size the object can have, and the box will use it as the basis for all
5977 * latter calculations. Elementary widgets set their own minimum size as
5978 * needed, so there's rarely any need to use it manually.
5980 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5981 * used to tell whether the object will be allocated the minimum size it
5982 * needs or if the space given to it should be expanded. It's important
5983 * to realize that expanding the size given to the object is not the same
5984 * thing as resizing the object. It could very well end being a small
5985 * widget floating in a much larger empty space. If not set, the weight
5986 * for objects will normally be 0.0 for both axis, meaning the widget will
5987 * not be expanded. To take as much space possible, set the weight to
5988 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5990 * Besides how much space each object is allocated, it's possible to control
5991 * how the widget will be placed within that space using
5992 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5993 * for both axis, meaning the object will be centered, but any value from
5994 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5995 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5996 * is -1.0, means the object will be resized to fill the entire space it
5999 * In addition, customized functions to define the layout can be set, which
6000 * allow the application developer to organize the objects within the box
6001 * in any number of ways.
6003 * The special elm_box_layout_transition() function can be used
6004 * to switch from one layout to another, animating the motion of the
6005 * children of the box.
6007 * @note Objects should not be added to box objects using _add() calls.
6009 * Some examples on how to use boxes follow:
6010 * @li @ref box_example_01
6011 * @li @ref box_example_02
6016 * @typedef Elm_Box_Transition
6018 * Opaque handler containing the parameters to perform an animated
6019 * transition of the layout the box uses.
6021 * @see elm_box_transition_new()
6022 * @see elm_box_layout_set()
6023 * @see elm_box_layout_transition()
6025 typedef struct _Elm_Box_Transition Elm_Box_Transition;
6028 * Add a new box to the parent
6030 * By default, the box will be in vertical mode and non-homogeneous.
6032 * @param parent The parent object
6033 * @return The new object or NULL if it cannot be created
6035 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6037 * Set the horizontal orientation
6039 * By default, box object arranges their contents vertically from top to
6041 * By calling this function with @p horizontal as EINA_TRUE, the box will
6042 * become horizontal, arranging contents from left to right.
6044 * @note This flag is ignored if a custom layout function is set.
6046 * @param obj The box object
6047 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6048 * EINA_FALSE = vertical)
6050 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6052 * Get the horizontal orientation
6054 * @param obj The box object
6055 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6057 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6059 * Set the box to arrange its children homogeneously
6061 * If enabled, homogeneous layout makes all items the same size, according
6062 * to the size of the largest of its children.
6064 * @note This flag is ignored if a custom layout function is set.
6066 * @param obj The box object
6067 * @param homogeneous The homogeneous flag
6069 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6071 * Get whether the box is using homogeneous mode or not
6073 * @param obj The box object
6074 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6076 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6077 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6078 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6080 * Add an object to the beginning of the pack list
6082 * Pack @p subobj into the box @p obj, placing it first in the list of
6083 * children objects. The actual position the object will get on screen
6084 * depends on the layout used. If no custom layout is set, it will be at
6085 * the top or left, depending if the box is vertical or horizontal,
6088 * @param obj The box object
6089 * @param subobj The object to add to the box
6091 * @see elm_box_pack_end()
6092 * @see elm_box_pack_before()
6093 * @see elm_box_pack_after()
6094 * @see elm_box_unpack()
6095 * @see elm_box_unpack_all()
6096 * @see elm_box_clear()
6098 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6100 * Add an object at the end of the pack list
6102 * Pack @p subobj into the box @p obj, placing it last in the list of
6103 * children objects. The actual position the object will get on screen
6104 * depends on the layout used. If no custom layout is set, it will be at
6105 * the bottom or right, depending if the box is vertical or horizontal,
6108 * @param obj The box object
6109 * @param subobj The object to add to the box
6111 * @see elm_box_pack_start()
6112 * @see elm_box_pack_before()
6113 * @see elm_box_pack_after()
6114 * @see elm_box_unpack()
6115 * @see elm_box_unpack_all()
6116 * @see elm_box_clear()
6118 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6120 * Adds an object to the box before the indicated object
6122 * This will add the @p subobj to the box indicated before the object
6123 * indicated with @p before. If @p before is not already in the box, results
6124 * are undefined. Before means either to the left of the indicated object or
6125 * above it depending on orientation.
6127 * @param obj The box object
6128 * @param subobj The object to add to the box
6129 * @param before The object before which to add it
6131 * @see elm_box_pack_start()
6132 * @see elm_box_pack_end()
6133 * @see elm_box_pack_after()
6134 * @see elm_box_unpack()
6135 * @see elm_box_unpack_all()
6136 * @see elm_box_clear()
6138 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6140 * Adds an object to the box after the indicated object
6142 * This will add the @p subobj to the box indicated after the object
6143 * indicated with @p after. If @p after is not already in the box, results
6144 * are undefined. After means either to the right of the indicated object or
6145 * below it depending on orientation.
6147 * @param obj The box object
6148 * @param subobj The object to add to the box
6149 * @param after The object after which to add it
6151 * @see elm_box_pack_start()
6152 * @see elm_box_pack_end()
6153 * @see elm_box_pack_before()
6154 * @see elm_box_unpack()
6155 * @see elm_box_unpack_all()
6156 * @see elm_box_clear()
6158 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6160 * Clear the box of all children
6162 * Remove all the elements contained by the box, deleting the respective
6165 * @param obj The box object
6167 * @see elm_box_unpack()
6168 * @see elm_box_unpack_all()
6170 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6174 * Remove the object given by @p subobj from the box @p obj without
6177 * @param obj The box object
6179 * @see elm_box_unpack_all()
6180 * @see elm_box_clear()
6182 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6184 * Remove all items from the box, without deleting them
6186 * Clear the box from all children, but don't delete the respective objects.
6187 * If no other references of the box children exist, the objects will never
6188 * be deleted, and thus the application will leak the memory. Make sure
6189 * when using this function that you hold a reference to all the objects
6190 * in the box @p obj.
6192 * @param obj The box object
6194 * @see elm_box_clear()
6195 * @see elm_box_unpack()
6197 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6199 * Retrieve a list of the objects packed into the box
6201 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6202 * The order of the list corresponds to the packing order the box uses.
6204 * You must free this list with eina_list_free() once you are done with it.
6206 * @param obj The box object
6208 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6210 * Set the space (padding) between the box's elements.
6212 * Extra space in pixels that will be added between a box child and its
6213 * neighbors after its containing cell has been calculated. This padding
6214 * is set for all elements in the box, besides any possible padding that
6215 * individual elements may have through their size hints.
6217 * @param obj The box object
6218 * @param horizontal The horizontal space between elements
6219 * @param vertical The vertical space between elements
6221 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6223 * Get the space (padding) between the box's elements.
6225 * @param obj The box object
6226 * @param horizontal The horizontal space between elements
6227 * @param vertical The vertical space between elements
6229 * @see elm_box_padding_set()
6231 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6233 * Set the alignment of the whole bouding box of contents.
6235 * Sets how the bounding box containing all the elements of the box, after
6236 * their sizes and position has been calculated, will be aligned within
6237 * the space given for the whole box widget.
6239 * @param obj The box object
6240 * @param horizontal The horizontal alignment of elements
6241 * @param vertical The vertical alignment of elements
6243 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6245 * Get the alignment of the whole bouding box of contents.
6247 * @param obj The box object
6248 * @param horizontal The horizontal alignment of elements
6249 * @param vertical The vertical alignment of elements
6251 * @see elm_box_align_set()
6253 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6256 * Force the box to recalculate its children packing.
6258 * If any children was added or removed, box will not calculate the
6259 * values immediately rather leaving it to the next main loop
6260 * iteration. While this is great as it would save lots of
6261 * recalculation, whenever you need to get the position of a just
6262 * added item you must force recalculate before doing so.
6264 * @param obj The box object.
6266 EAPI void elm_box_recalculate(Evas_Object *obj);
6269 * Set the layout defining function to be used by the box
6271 * Whenever anything changes that requires the box in @p obj to recalculate
6272 * the size and position of its elements, the function @p cb will be called
6273 * to determine what the layout of the children will be.
6275 * Once a custom function is set, everything about the children layout
6276 * is defined by it. The flags set by elm_box_horizontal_set() and
6277 * elm_box_homogeneous_set() no longer have any meaning, and the values
6278 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6279 * layout function to decide if they are used and how. These last two
6280 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6281 * passed to @p cb. The @c Evas_Object the function receives is not the
6282 * Elementary widget, but the internal Evas Box it uses, so none of the
6283 * functions described here can be used on it.
6285 * Any of the layout functions in @c Evas can be used here, as well as the
6286 * special elm_box_layout_transition().
6288 * The final @p data argument received by @p cb is the same @p data passed
6289 * here, and the @p free_data function will be called to free it
6290 * whenever the box is destroyed or another layout function is set.
6292 * Setting @p cb to NULL will revert back to the default layout function.
6294 * @param obj The box object
6295 * @param cb The callback function used for layout
6296 * @param data Data that will be passed to layout function
6297 * @param free_data Function called to free @p data
6299 * @see elm_box_layout_transition()
6301 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);
6303 * Special layout function that animates the transition from one layout to another
6305 * Normally, when switching the layout function for a box, this will be
6306 * reflected immediately on screen on the next render, but it's also
6307 * possible to do this through an animated transition.
6309 * This is done by creating an ::Elm_Box_Transition and setting the box
6310 * layout to this function.
6314 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6315 * evas_object_box_layout_vertical, // start
6316 * NULL, // data for initial layout
6317 * NULL, // free function for initial data
6318 * evas_object_box_layout_horizontal, // end
6319 * NULL, // data for final layout
6320 * NULL, // free function for final data
6321 * anim_end, // will be called when animation ends
6322 * NULL); // data for anim_end function\
6323 * elm_box_layout_set(box, elm_box_layout_transition, t,
6324 * elm_box_transition_free);
6327 * @note This function can only be used with elm_box_layout_set(). Calling
6328 * it directly will not have the expected results.
6330 * @see elm_box_transition_new
6331 * @see elm_box_transition_free
6332 * @see elm_box_layout_set
6334 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6336 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6338 * If you want to animate the change from one layout to another, you need
6339 * to set the layout function of the box to elm_box_layout_transition(),
6340 * passing as user data to it an instance of ::Elm_Box_Transition with the
6341 * necessary information to perform this animation. The free function to
6342 * set for the layout is elm_box_transition_free().
6344 * The parameters to create an ::Elm_Box_Transition sum up to how long
6345 * will it be, in seconds, a layout function to describe the initial point,
6346 * another for the final position of the children and one function to be
6347 * called when the whole animation ends. This last function is useful to
6348 * set the definitive layout for the box, usually the same as the end
6349 * layout for the animation, but could be used to start another transition.
6351 * @param start_layout The layout function that will be used to start the animation
6352 * @param start_layout_data The data to be passed the @p start_layout function
6353 * @param start_layout_free_data Function to free @p start_layout_data
6354 * @param end_layout The layout function that will be used to end the animation
6355 * @param end_layout_free_data The data to be passed the @p end_layout function
6356 * @param end_layout_free_data Function to free @p end_layout_data
6357 * @param transition_end_cb Callback function called when animation ends
6358 * @param transition_end_data Data to be passed to @p transition_end_cb
6359 * @return An instance of ::Elm_Box_Transition
6361 * @see elm_box_transition_new
6362 * @see elm_box_layout_transition
6364 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);
6366 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6368 * This function is mostly useful as the @c free_data parameter in
6369 * elm_box_layout_set() when elm_box_layout_transition().
6371 * @param data The Elm_Box_Transition instance to be freed.
6373 * @see elm_box_transition_new
6374 * @see elm_box_layout_transition
6376 EAPI void elm_box_transition_free(void *data);
6383 * @defgroup Button Button
6385 * @image html img/widget/button/preview-00.png
6386 * @image latex img/widget/button/preview-00.eps
6387 * @image html img/widget/button/preview-01.png
6388 * @image latex img/widget/button/preview-01.eps
6389 * @image html img/widget/button/preview-02.png
6390 * @image latex img/widget/button/preview-02.eps
6392 * This is a push-button. Press it and run some function. It can contain
6393 * a simple label and icon object and it also has an autorepeat feature.
6395 * This widgets emits the following signals:
6396 * @li "clicked": the user clicked the button (press/release).
6397 * @li "repeated": the user pressed the button without releasing it.
6398 * @li "pressed": button was pressed.
6399 * @li "unpressed": button was released after being pressed.
6400 * In all three cases, the @c event parameter of the callback will be
6403 * Also, defined in the default theme, the button has the following styles
6405 * @li default: a normal button.
6406 * @li anchor: Like default, but the button fades away when the mouse is not
6407 * over it, leaving only the text or icon.
6408 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6409 * continuous look across its options.
6410 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6412 * Default contents parts of the button widget that you can use for are:
6413 * @li "icon" - A icon of the button
6415 * Default text parts of the button widget that you can use for are:
6416 * @li "default" - Label of the button
6418 * Follow through a complete example @ref button_example_01 "here".
6424 UIControlStateDefault,
6425 UIControlStateHighlighted,
6426 UIControlStateDisabled,
6427 UIControlStateFocused,
6428 UIControlStateReserved
6432 * Add a new button to the parent's canvas
6434 * @param parent The parent object
6435 * @return The new object or NULL if it cannot be created
6437 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6439 * Set the label used in the button
6441 * The passed @p label can be NULL to clean any existing text in it and
6442 * leave the button as an icon only object.
6444 * @param obj The button object
6445 * @param label The text will be written on the button
6446 * @deprecated use elm_object_text_set() instead.
6448 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6450 * Get the label set for the button
6452 * The string returned is an internal pointer and should not be freed or
6453 * altered. It will also become invalid when the button is destroyed.
6454 * The string returned, if not NULL, is a stringshare, so if you need to
6455 * keep it around even after the button is destroyed, you can use
6456 * eina_stringshare_ref().
6458 * @param obj The button object
6459 * @return The text set to the label, or NULL if nothing is set
6460 * @deprecated use elm_object_text_set() instead.
6462 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6464 * Set the label for each state of button
6466 * The passed @p label can be NULL to clean any existing text in it and
6467 * leave the button as an icon only object for the state.
6469 * @param obj The button object
6470 * @param label The text will be written on the button
6471 * @param state The state of button
6475 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6477 * Get the label of button for each state
6479 * The string returned is an internal pointer and should not be freed or
6480 * altered. It will also become invalid when the button is destroyed.
6481 * The string returned, if not NULL, is a stringshare, so if you need to
6482 * keep it around even after the button is destroyed, you can use
6483 * eina_stringshare_ref().
6485 * @param obj The button object
6486 * @param state The state of button
6487 * @return The title of button for state
6491 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6493 * Set the icon used for the button
6495 * Setting a new icon will delete any other that was previously set, making
6496 * any reference to them invalid. If you need to maintain the previous
6497 * object alive, unset it first with elm_button_icon_unset().
6499 * @param obj The button object
6500 * @param icon The icon object for the button
6501 * @deprecated use elm_object_part_content_set() instead.
6503 WILL_DEPRECATE EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6505 * Get the icon used for the button
6507 * Return the icon object which is set for this widget. If the button is
6508 * destroyed or another icon is set, the returned object will be deleted
6509 * and any reference to it will be invalid.
6511 * @param obj The button object
6512 * @return The icon object that is being used
6514 * @deprecated use elm_object_part_content_get() instead
6516 WILL_DEPRECATE EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6518 * Remove the icon set without deleting it and return the object
6520 * This function drops the reference the button holds of the icon object
6521 * and returns this last object. It is used in case you want to remove any
6522 * icon, or set another one, without deleting the actual object. The button
6523 * will be left without an icon set.
6525 * @param obj The button object
6526 * @return The icon object that was being used
6527 * @deprecated use elm_object_part_content_unset() instead.
6529 WILL_DEPRECATE EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6531 * Turn on/off the autorepeat event generated when the button is kept pressed
6533 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6534 * signal when they are clicked.
6536 * When on, keeping a button pressed will continuously emit a @c repeated
6537 * signal until the button is released. The time it takes until it starts
6538 * emitting the signal is given by
6539 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6540 * new emission by elm_button_autorepeat_gap_timeout_set().
6542 * @param obj The button object
6543 * @param on A bool to turn on/off the event
6545 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6547 * Get whether the autorepeat feature is enabled
6549 * @param obj The button object
6550 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6552 * @see elm_button_autorepeat_set()
6554 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6556 * Set the initial timeout before the autorepeat event is generated
6558 * Sets the timeout, in seconds, since the button is pressed until the
6559 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6560 * won't be any delay and the even will be fired the moment the button is
6563 * @param obj The button object
6564 * @param t Timeout in seconds
6566 * @see elm_button_autorepeat_set()
6567 * @see elm_button_autorepeat_gap_timeout_set()
6569 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6571 * Get the initial timeout before the autorepeat event is generated
6573 * @param obj The button object
6574 * @return Timeout in seconds
6576 * @see elm_button_autorepeat_initial_timeout_set()
6578 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6580 * Set the interval between each generated autorepeat event
6582 * After the first @c repeated event is fired, all subsequent ones will
6583 * follow after a delay of @p t seconds for each.
6585 * @param obj The button object
6586 * @param t Interval in seconds
6588 * @see elm_button_autorepeat_initial_timeout_set()
6590 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6592 * Get the interval between each generated autorepeat event
6594 * @param obj The button object
6595 * @return Interval in seconds
6597 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6603 * @defgroup File_Selector_Button File Selector Button
6605 * @image html img/widget/fileselector_button/preview-00.png
6606 * @image latex img/widget/fileselector_button/preview-00.eps
6607 * @image html img/widget/fileselector_button/preview-01.png
6608 * @image latex img/widget/fileselector_button/preview-01.eps
6609 * @image html img/widget/fileselector_button/preview-02.png
6610 * @image latex img/widget/fileselector_button/preview-02.eps
6612 * This is a button that, when clicked, creates an Elementary
6613 * window (or inner window) <b> with a @ref Fileselector "file
6614 * selector widget" within</b>. When a file is chosen, the (inner)
6615 * window is closed and the button emits a signal having the
6616 * selected file as it's @c event_info.
6618 * This widget encapsulates operations on its internal file
6619 * selector on its own API. There is less control over its file
6620 * selector than that one would have instatiating one directly.
6622 * The following styles are available for this button:
6625 * @li @c "hoversel_vertical"
6626 * @li @c "hoversel_vertical_entry"
6628 * Smart callbacks one can register to:
6629 * - @c "file,chosen" - the user has selected a path, whose string
6630 * pointer comes as the @c event_info data (a stringshared
6633 * Here is an example on its usage:
6634 * @li @ref fileselector_button_example
6636 * @see @ref File_Selector_Entry for a similar widget.
6641 * Add a new file selector button widget to the given parent
6642 * Elementary (container) object
6644 * @param parent The parent object
6645 * @return a new file selector button widget handle or @c NULL, on
6648 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6651 * Set the label for a given file selector button widget
6653 * @param obj The file selector button widget
6654 * @param label The text label to be displayed on @p obj
6656 * @deprecated use elm_object_text_set() instead.
6658 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6661 * Get the label set for a given file selector button widget
6663 * @param obj The file selector button widget
6664 * @return The button label
6666 * @deprecated use elm_object_text_set() instead.
6668 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6671 * Set the icon on a given file selector button widget
6673 * @param obj The file selector button widget
6674 * @param icon The icon object for the button
6676 * Once the icon object is set, a previously set one will be
6677 * deleted. If you want to keep the latter, use the
6678 * elm_fileselector_button_icon_unset() function.
6680 * @see elm_fileselector_button_icon_get()
6682 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6685 * Get the icon set for a given file selector button widget
6687 * @param obj The file selector button widget
6688 * @return The icon object currently set on @p obj or @c NULL, if
6691 * @see elm_fileselector_button_icon_set()
6693 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6696 * Unset the icon used in a given file selector button widget
6698 * @param obj The file selector button widget
6699 * @return The icon object that was being used on @p obj or @c
6702 * Unparent and return the icon object which was set for this
6705 * @see elm_fileselector_button_icon_set()
6707 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6710 * Set the title for a given file selector button widget's window
6712 * @param obj The file selector button widget
6713 * @param title The title string
6715 * This will change the window's title, when the file selector pops
6716 * out after a click on the button. Those windows have the default
6717 * (unlocalized) value of @c "Select a file" as titles.
6719 * @note It will only take any effect if the file selector
6720 * button widget is @b not under "inwin mode".
6722 * @see elm_fileselector_button_window_title_get()
6724 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6727 * Get the title set for a given file selector button widget's
6730 * @param obj The file selector button widget
6731 * @return Title of the file selector button's window
6733 * @see elm_fileselector_button_window_title_get() for more details
6735 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6738 * Set the size of a given file selector button widget's window,
6739 * holding the file selector itself.
6741 * @param obj The file selector button widget
6742 * @param width The window's width
6743 * @param height The window's height
6745 * @note it will only take any effect if the file selector button
6746 * widget is @b not under "inwin mode". The default size for the
6747 * window (when applicable) is 400x400 pixels.
6749 * @see elm_fileselector_button_window_size_get()
6751 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6754 * Get the size of a given file selector button widget's window,
6755 * holding the file selector itself.
6757 * @param obj The file selector button widget
6758 * @param width Pointer into which to store the width value
6759 * @param height Pointer into which to store the height value
6761 * @note Use @c NULL pointers on the size values you're not
6762 * interested in: they'll be ignored by the function.
6764 * @see elm_fileselector_button_window_size_set(), for more details
6766 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6769 * Set the initial file system path for a given file selector
6772 * @param obj The file selector button widget
6773 * @param path The path string
6775 * It must be a <b>directory</b> path, which will have the contents
6776 * displayed initially in the file selector's view, when invoked
6777 * from @p obj. The default initial path is the @c "HOME"
6778 * environment variable's value.
6780 * @see elm_fileselector_button_path_get()
6782 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6785 * Get the initial file system path set for a given file selector
6788 * @param obj The file selector button widget
6789 * @return path The path string
6791 * @see elm_fileselector_button_path_set() for more details
6793 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6796 * Enable/disable a tree view in the given file selector button
6797 * widget's internal file selector
6799 * @param obj The file selector button widget
6800 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6803 * This has the same effect as elm_fileselector_expandable_set(),
6804 * but now applied to a file selector button's internal file
6807 * @note There's no way to put a file selector button's internal
6808 * file selector in "grid mode", as one may do with "pure" file
6811 * @see elm_fileselector_expandable_get()
6813 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6816 * Get whether tree view is enabled for the given file selector
6817 * button widget's internal file selector
6819 * @param obj The file selector button widget
6820 * @return @c EINA_TRUE if @p obj widget's internal file selector
6821 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6823 * @see elm_fileselector_expandable_set() for more details
6825 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6828 * Set whether a given file selector button widget's internal file
6829 * selector is to display folders only or the directory contents,
6832 * @param obj The file selector button widget
6833 * @param only @c EINA_TRUE to make @p obj widget's internal file
6834 * selector only display directories, @c EINA_FALSE to make files
6835 * to be displayed in it too
6837 * This has the same effect as elm_fileselector_folder_only_set(),
6838 * but now applied to a file selector button's internal file
6841 * @see elm_fileselector_folder_only_get()
6843 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6846 * Get whether a given file selector button widget's internal file
6847 * selector is displaying folders only or the directory contents,
6850 * @param obj The file selector button widget
6851 * @return @c EINA_TRUE if @p obj widget's internal file
6852 * selector is only displaying directories, @c EINA_FALSE if files
6853 * are being displayed in it too (and on errors)
6855 * @see elm_fileselector_button_folder_only_set() for more details
6857 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6860 * Enable/disable the file name entry box where the user can type
6861 * in a name for a file, in a given file selector button widget's
6862 * internal file selector.
6864 * @param obj The file selector button widget
6865 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6866 * file selector a "saving dialog", @c EINA_FALSE otherwise
6868 * This has the same effect as elm_fileselector_is_save_set(),
6869 * but now applied to a file selector button's internal file
6872 * @see elm_fileselector_is_save_get()
6874 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6877 * Get whether the given file selector button widget's internal
6878 * file selector is in "saving dialog" mode
6880 * @param obj The file selector button widget
6881 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6882 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6885 * @see elm_fileselector_button_is_save_set() for more details
6887 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6890 * Set whether a given file selector button widget's internal file
6891 * selector will raise an Elementary "inner window", instead of a
6892 * dedicated Elementary window. By default, it won't.
6894 * @param obj The file selector button widget
6895 * @param value @c EINA_TRUE to make it use an inner window, @c
6896 * EINA_TRUE to make it use a dedicated window
6898 * @see elm_win_inwin_add() for more information on inner windows
6899 * @see elm_fileselector_button_inwin_mode_get()
6901 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6904 * Get whether a given file selector button widget's internal file
6905 * selector will raise an Elementary "inner window", instead of a
6906 * dedicated Elementary window.
6908 * @param obj The file selector button widget
6909 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6910 * if it will use a dedicated window
6912 * @see elm_fileselector_button_inwin_mode_set() for more details
6914 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6921 * @defgroup File_Selector_Entry File Selector Entry
6923 * @image html img/widget/fileselector_entry/preview-00.png
6924 * @image latex img/widget/fileselector_entry/preview-00.eps
6926 * This is an entry made to be filled with or display a <b>file
6927 * system path string</b>. Besides the entry itself, the widget has
6928 * a @ref File_Selector_Button "file selector button" on its side,
6929 * which will raise an internal @ref Fileselector "file selector widget",
6930 * when clicked, for path selection aided by file system
6933 * This file selector may appear in an Elementary window or in an
6934 * inner window. When a file is chosen from it, the (inner) window
6935 * is closed and the selected file's path string is exposed both as
6936 * an smart event and as the new text on the entry.
6938 * This widget encapsulates operations on its internal file
6939 * selector on its own API. There is less control over its file
6940 * selector than that one would have instatiating one directly.
6942 * Smart callbacks one can register to:
6943 * - @c "changed" - The text within the entry was changed
6944 * - @c "activated" - The entry has had editing finished and
6945 * changes are to be "committed"
6946 * - @c "press" - The entry has been clicked
6947 * - @c "longpressed" - The entry has been clicked (and held) for a
6949 * - @c "clicked" - The entry has been clicked
6950 * - @c "clicked,double" - The entry has been double clicked
6951 * - @c "focused" - The entry has received focus
6952 * - @c "unfocused" - The entry has lost focus
6953 * - @c "selection,paste" - A paste action has occurred on the
6955 * - @c "selection,copy" - A copy action has occurred on the entry
6956 * - @c "selection,cut" - A cut action has occurred on the entry
6957 * - @c "unpressed" - The file selector entry's button was released
6958 * after being pressed.
6959 * - @c "file,chosen" - The user has selected a path via the file
6960 * selector entry's internal file selector, whose string pointer
6961 * comes as the @c event_info data (a stringshared string)
6963 * Here is an example on its usage:
6964 * @li @ref fileselector_entry_example
6966 * @see @ref File_Selector_Button for a similar widget.
6971 * Add a new file selector entry widget to the given parent
6972 * Elementary (container) object
6974 * @param parent The parent object
6975 * @return a new file selector entry widget handle or @c NULL, on
6978 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6981 * Set the label for a given file selector entry widget's button
6983 * @param obj The file selector entry widget
6984 * @param label The text label to be displayed on @p obj widget's
6987 * @deprecated use elm_object_text_set() instead.
6989 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6992 * Get the label set for a given file selector entry widget's button
6994 * @param obj The file selector entry widget
6995 * @return The widget button's label
6997 * @deprecated use elm_object_text_set() instead.
6999 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7002 * Set the icon on a given file selector entry widget's button
7004 * @param obj The file selector entry widget
7005 * @param icon The icon object for the entry's button
7007 * Once the icon object is set, a previously set one will be
7008 * deleted. If you want to keep the latter, use the
7009 * elm_fileselector_entry_button_icon_unset() function.
7011 * @see elm_fileselector_entry_button_icon_get()
7013 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7016 * Get the icon set for a given file selector entry widget's button
7018 * @param obj The file selector entry widget
7019 * @return The icon object currently set on @p obj widget's button
7020 * or @c NULL, if none is
7022 * @see elm_fileselector_entry_button_icon_set()
7024 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7027 * Unset the icon used in a given file selector entry widget's
7030 * @param obj The file selector entry widget
7031 * @return The icon object that was being used on @p obj widget's
7032 * button or @c NULL, on errors
7034 * Unparent and return the icon object which was set for this
7037 * @see elm_fileselector_entry_button_icon_set()
7039 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7042 * Set the title for a given file selector entry widget's window
7044 * @param obj The file selector entry widget
7045 * @param title The title string
7047 * This will change the window's title, when the file selector pops
7048 * out after a click on the entry's button. Those windows have the
7049 * default (unlocalized) value of @c "Select a file" as titles.
7051 * @note It will only take any effect if the file selector
7052 * entry widget is @b not under "inwin mode".
7054 * @see elm_fileselector_entry_window_title_get()
7056 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7059 * Get the title set for a given file selector entry widget's
7062 * @param obj The file selector entry widget
7063 * @return Title of the file selector entry's window
7065 * @see elm_fileselector_entry_window_title_get() for more details
7067 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7070 * Set the size of a given file selector entry widget's window,
7071 * holding the file selector itself.
7073 * @param obj The file selector entry widget
7074 * @param width The window's width
7075 * @param height The window's height
7077 * @note it will only take any effect if the file selector entry
7078 * widget is @b not under "inwin mode". The default size for the
7079 * window (when applicable) is 400x400 pixels.
7081 * @see elm_fileselector_entry_window_size_get()
7083 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7086 * Get the size of a given file selector entry widget's window,
7087 * holding the file selector itself.
7089 * @param obj The file selector entry widget
7090 * @param width Pointer into which to store the width value
7091 * @param height Pointer into which to store the height value
7093 * @note Use @c NULL pointers on the size values you're not
7094 * interested in: they'll be ignored by the function.
7096 * @see elm_fileselector_entry_window_size_set(), for more details
7098 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7101 * Set the initial file system path and the entry's path string for
7102 * a given file selector entry widget
7104 * @param obj The file selector entry widget
7105 * @param path The path string
7107 * It must be a <b>directory</b> path, which will have the contents
7108 * displayed initially in the file selector's view, when invoked
7109 * from @p obj. The default initial path is the @c "HOME"
7110 * environment variable's value.
7112 * @see elm_fileselector_entry_path_get()
7114 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7117 * Get the entry's path string for a given file selector entry
7120 * @param obj The file selector entry widget
7121 * @return path The path string
7123 * @see elm_fileselector_entry_path_set() for more details
7125 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7128 * Enable/disable a tree view in the given file selector entry
7129 * widget's internal file selector
7131 * @param obj The file selector entry widget
7132 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7135 * This has the same effect as elm_fileselector_expandable_set(),
7136 * but now applied to a file selector entry's internal file
7139 * @note There's no way to put a file selector entry's internal
7140 * file selector in "grid mode", as one may do with "pure" file
7143 * @see elm_fileselector_expandable_get()
7145 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7148 * Get whether tree view is enabled for the given file selector
7149 * entry widget's internal file selector
7151 * @param obj The file selector entry widget
7152 * @return @c EINA_TRUE if @p obj widget's internal file selector
7153 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7155 * @see elm_fileselector_expandable_set() for more details
7157 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7160 * Set whether a given file selector entry widget's internal file
7161 * selector is to display folders only or the directory contents,
7164 * @param obj The file selector entry widget
7165 * @param only @c EINA_TRUE to make @p obj widget's internal file
7166 * selector only display directories, @c EINA_FALSE to make files
7167 * to be displayed in it too
7169 * This has the same effect as elm_fileselector_folder_only_set(),
7170 * but now applied to a file selector entry's internal file
7173 * @see elm_fileselector_folder_only_get()
7175 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7178 * Get whether a given file selector entry widget's internal file
7179 * selector is displaying folders only or the directory contents,
7182 * @param obj The file selector entry widget
7183 * @return @c EINA_TRUE if @p obj widget's internal file
7184 * selector is only displaying directories, @c EINA_FALSE if files
7185 * are being displayed in it too (and on errors)
7187 * @see elm_fileselector_entry_folder_only_set() for more details
7189 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7192 * Enable/disable the file name entry box where the user can type
7193 * in a name for a file, in a given file selector entry widget's
7194 * internal file selector.
7196 * @param obj The file selector entry widget
7197 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7198 * file selector a "saving dialog", @c EINA_FALSE otherwise
7200 * This has the same effect as elm_fileselector_is_save_set(),
7201 * but now applied to a file selector entry's internal file
7204 * @see elm_fileselector_is_save_get()
7206 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7209 * Get whether the given file selector entry widget's internal
7210 * file selector is in "saving dialog" mode
7212 * @param obj The file selector entry widget
7213 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7214 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7217 * @see elm_fileselector_entry_is_save_set() for more details
7219 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7222 * Set whether a given file selector entry widget's internal file
7223 * selector will raise an Elementary "inner window", instead of a
7224 * dedicated Elementary window. By default, it won't.
7226 * @param obj The file selector entry widget
7227 * @param value @c EINA_TRUE to make it use an inner window, @c
7228 * EINA_TRUE to make it use a dedicated window
7230 * @see elm_win_inwin_add() for more information on inner windows
7231 * @see elm_fileselector_entry_inwin_mode_get()
7233 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7236 * Get whether a given file selector entry widget's internal file
7237 * selector will raise an Elementary "inner window", instead of a
7238 * dedicated Elementary window.
7240 * @param obj The file selector entry widget
7241 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7242 * if it will use a dedicated window
7244 * @see elm_fileselector_entry_inwin_mode_set() for more details
7246 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7249 * Set the initial file system path for a given file selector entry
7252 * @param obj The file selector entry widget
7253 * @param path The path string
7255 * It must be a <b>directory</b> path, which will have the contents
7256 * displayed initially in the file selector's view, when invoked
7257 * from @p obj. The default initial path is the @c "HOME"
7258 * environment variable's value.
7260 * @see elm_fileselector_entry_path_get()
7262 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7265 * Get the parent directory's path to the latest file selection on
7266 * a given filer selector entry widget
7268 * @param obj The file selector object
7269 * @return The (full) path of the directory of the last selection
7270 * on @p obj widget, a @b stringshared string
7272 * @see elm_fileselector_entry_path_set()
7274 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7281 * @defgroup Scroller Scroller
7283 * A scroller holds a single object and "scrolls it around". This means that
7284 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7285 * region around, allowing to move through a much larger object that is
7286 * contained in the scroller. The scroller will always have a small minimum
7287 * size by default as it won't be limited by the contents of the scroller.
7289 * Signals that you can add callbacks for are:
7290 * @li "edge,left" - the left edge of the content has been reached
7291 * @li "edge,right" - the right edge of the content has been reached
7292 * @li "edge,top" - the top edge of the content has been reached
7293 * @li "edge,bottom" - the bottom edge of the content has been reached
7294 * @li "scroll" - the content has been scrolled (moved)
7295 * @li "scroll,anim,start" - scrolling animation has started
7296 * @li "scroll,anim,stop" - scrolling animation has stopped
7297 * @li "scroll,drag,start" - dragging the contents around has started
7298 * @li "scroll,drag,stop" - dragging the contents around has stopped
7299 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7302 * @note When Elemementary is in embedded mode the scrollbars will not be
7303 * dragable, they appear merely as indicators of how much has been scrolled.
7304 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7305 * fingerscroll) won't work.
7307 * Default contents parts of the scroller widget that you can use for are:
7308 * @li "default" - A content of the scroller
7310 * In @ref tutorial_scroller you'll find an example of how to use most of
7315 * @brief Type that controls when scrollbars should appear.
7317 * @see elm_scroller_policy_set()
7319 typedef enum _Elm_Scroller_Policy
7321 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7322 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7323 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7324 ELM_SCROLLER_POLICY_LAST
7325 } Elm_Scroller_Policy;
7327 * @brief Add a new scroller to the parent
7329 * @param parent The parent object
7330 * @return The new object or NULL if it cannot be created
7332 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7334 * @brief Set the content of the scroller widget (the object to be scrolled around).
7336 * @param obj The scroller object
7337 * @param content The new content object
7339 * Once the content object is set, a previously set one will be deleted.
7340 * If you want to keep that old content object, use the
7341 * elm_scroller_content_unset() function.
7342 * @deprecated use elm_object_content_set() instead
7344 WILL_DEPRECATE EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7346 * @brief Get the content of the scroller widget
7348 * @param obj The slider object
7349 * @return The content that is being used
7351 * Return the content object which is set for this widget
7353 * @see elm_scroller_content_set()
7354 * @deprecated use elm_object_content_get() instead.
7356 WILL_DEPRECATE EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7358 * @brief Unset the content of the scroller widget
7360 * @param obj The slider object
7361 * @return The content that was being used
7363 * Unparent and return the content object which was set for this widget
7365 * @see elm_scroller_content_set()
7366 * @deprecated use elm_object_content_unset() instead.
7368 WILL_DEPRECATE EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7370 * @brief Set custom theme elements for the scroller
7372 * @param obj The scroller object
7373 * @param widget The widget name to use (default is "scroller")
7374 * @param base The base name to use (default is "base")
7376 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7378 * @brief Make the scroller minimum size limited to the minimum size of the content
7380 * @param obj The scroller object
7381 * @param w Enable limiting minimum size horizontally
7382 * @param h Enable limiting minimum size vertically
7384 * By default the scroller will be as small as its design allows,
7385 * irrespective of its content. This will make the scroller minimum size the
7386 * right size horizontally and/or vertically to perfectly fit its content in
7389 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7391 * @brief Show a specific virtual region within the scroller content object
7393 * @param obj The scroller object
7394 * @param x X coordinate of the region
7395 * @param y Y coordinate of the region
7396 * @param w Width of the region
7397 * @param h Height of the region
7399 * This will ensure all (or part if it does not fit) of the designated
7400 * region in the virtual content object (0, 0 starting at the top-left of the
7401 * virtual content object) is shown within the scroller.
7403 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);
7405 * @brief Set the scrollbar visibility policy
7407 * @param obj The scroller object
7408 * @param policy_h Horizontal scrollbar policy
7409 * @param policy_v Vertical scrollbar policy
7411 * This sets the scrollbar visibility policy for the given scroller.
7412 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7413 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7414 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7415 * respectively for the horizontal and vertical scrollbars.
7417 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7419 * @brief Gets scrollbar visibility policy
7421 * @param obj The scroller object
7422 * @param policy_h Horizontal scrollbar policy
7423 * @param policy_v Vertical scrollbar policy
7425 * @see elm_scroller_policy_set()
7427 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7429 * @brief Get the currently visible content region
7431 * @param obj The scroller object
7432 * @param x X coordinate of the region
7433 * @param y Y coordinate of the region
7434 * @param w Width of the region
7435 * @param h Height of the region
7437 * This gets the current region in the content object that is visible through
7438 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7439 * w, @p h values pointed to.
7441 * @note All coordinates are relative to the content.
7443 * @see elm_scroller_region_show()
7445 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);
7447 * @brief Get the size of the content object
7449 * @param obj The scroller object
7450 * @param w Width of the content object.
7451 * @param h Height of the content object.
7453 * This gets the size of the content object of the scroller.
7455 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7457 * @brief Set bouncing behavior
7459 * @param obj The scroller object
7460 * @param h_bounce Allow bounce horizontally
7461 * @param v_bounce Allow bounce vertically
7463 * When scrolling, the scroller may "bounce" when reaching an edge of the
7464 * content object. This is a visual way to indicate the end has been reached.
7465 * This is enabled by default for both axis. This API will set if it is enabled
7466 * for the given axis with the boolean parameters for each axis.
7468 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7470 * @brief Get the bounce behaviour
7472 * @param obj The Scroller object
7473 * @param h_bounce Will the scroller bounce horizontally or not
7474 * @param v_bounce Will the scroller bounce vertically or not
7476 * @see elm_scroller_bounce_set()
7478 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7480 * @brief Set scroll page size relative to viewport size.
7482 * @param obj The scroller object
7483 * @param h_pagerel The horizontal page relative size
7484 * @param v_pagerel The vertical page relative size
7486 * The scroller is capable of limiting scrolling by the user to "pages". That
7487 * is to jump by and only show a "whole page" at a time as if the continuous
7488 * area of the scroller content is split into page sized pieces. This sets
7489 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7490 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7491 * axis. This is mutually exclusive with page size
7492 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7493 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7494 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7497 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7499 * @brief Set scroll page size.
7501 * @param obj The scroller object
7502 * @param h_pagesize The horizontal page size
7503 * @param v_pagesize The vertical page size
7505 * This sets the page size to an absolute fixed value, with 0 turning it off
7508 * @see elm_scroller_page_relative_set()
7510 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7512 * @brief Get scroll current page number.
7514 * @param obj The scroller object
7515 * @param h_pagenumber The horizontal page number
7516 * @param v_pagenumber The vertical page number
7518 * The page number starts from 0. 0 is the first page.
7519 * Current page means the page which meets the top-left of the viewport.
7520 * If there are two or more pages in the viewport, it returns the number of the page
7521 * which meets the top-left of the viewport.
7523 * @see elm_scroller_last_page_get()
7524 * @see elm_scroller_page_show()
7525 * @see elm_scroller_page_brint_in()
7527 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7529 * @brief Get scroll last page number.
7531 * @param obj The scroller object
7532 * @param h_pagenumber The horizontal page number
7533 * @param v_pagenumber The vertical page number
7535 * The page number starts from 0. 0 is the first page.
7536 * This returns the last page number among the pages.
7538 * @see elm_scroller_current_page_get()
7539 * @see elm_scroller_page_show()
7540 * @see elm_scroller_page_brint_in()
7542 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7544 * Show a specific virtual region within the scroller content object by page number.
7546 * @param obj The scroller object
7547 * @param h_pagenumber The horizontal page number
7548 * @param v_pagenumber The vertical page number
7550 * 0, 0 of the indicated page is located at the top-left of the viewport.
7551 * This will jump to the page directly without animation.
7556 * sc = elm_scroller_add(win);
7557 * elm_scroller_content_set(sc, content);
7558 * elm_scroller_page_relative_set(sc, 1, 0);
7559 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7560 * elm_scroller_page_show(sc, h_page + 1, v_page);
7563 * @see elm_scroller_page_bring_in()
7565 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7567 * Show a specific virtual region within the scroller content object by page number.
7569 * @param obj The scroller object
7570 * @param h_pagenumber The horizontal page number
7571 * @param v_pagenumber The vertical page number
7573 * 0, 0 of the indicated page is located at the top-left of the viewport.
7574 * This will slide to the page with animation.
7579 * sc = elm_scroller_add(win);
7580 * elm_scroller_content_set(sc, content);
7581 * elm_scroller_page_relative_set(sc, 1, 0);
7582 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7583 * elm_scroller_page_bring_in(sc, h_page, v_page);
7586 * @see elm_scroller_page_show()
7588 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7590 * @brief Show a specific virtual region within the scroller content object.
7592 * @param obj The scroller object
7593 * @param x X coordinate of the region
7594 * @param y Y coordinate of the region
7595 * @param w Width of the region
7596 * @param h Height of the region
7598 * This will ensure all (or part if it does not fit) of the designated
7599 * region in the virtual content object (0, 0 starting at the top-left of the
7600 * virtual content object) is shown within the scroller. Unlike
7601 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7602 * to this location (if configuration in general calls for transitions). It
7603 * may not jump immediately to the new location and make take a while and
7604 * show other content along the way.
7606 * @see elm_scroller_region_show()
7608 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);
7610 * @brief Set event propagation on a scroller
7612 * @param obj The scroller object
7613 * @param propagation If propagation is enabled or not
7615 * This enables or disabled event propagation from the scroller content to
7616 * the scroller and its parent. By default event propagation is disabled.
7618 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7620 * @brief Get event propagation for a scroller
7622 * @param obj The scroller object
7623 * @return The propagation state
7625 * This gets the event propagation for a scroller.
7627 * @see elm_scroller_propagate_events_set()
7629 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7631 * @brief Set scrolling gravity on a scroller
7633 * @param obj The scroller object
7634 * @param x The scrolling horizontal gravity
7635 * @param y The scrolling vertical gravity
7637 * The gravity, defines how the scroller will adjust its view
7638 * when the size of the scroller contents increase.
7640 * The scroller will adjust the view to glue itself as follows.
7642 * x=0.0, for showing the left most region of the content.
7643 * x=1.0, for showing the right most region of the content.
7644 * y=0.0, for showing the bottom most region of the content.
7645 * y=1.0, for showing the top most region of the content.
7647 * Default values for x and y are 0.0
7649 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7651 * @brief Get scrolling gravity values for a scroller
7653 * @param obj The scroller object
7654 * @param x The scrolling horizontal gravity
7655 * @param y The scrolling vertical gravity
7657 * This gets gravity values for a scroller.
7659 * @see elm_scroller_gravity_set()
7662 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7668 * @defgroup Label Label
7670 * @image html img/widget/label/preview-00.png
7671 * @image latex img/widget/label/preview-00.eps
7673 * @brief Widget to display text, with simple html-like markup.
7675 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7676 * text doesn't fit the geometry of the label it will be ellipsized or be
7677 * cut. Elementary provides several styles for this widget:
7678 * @li default - No animation
7679 * @li marker - Centers the text in the label and make it bold by default
7680 * @li slide_long - The entire text appears from the right of the screen and
7681 * slides until it disappears in the left of the screen(reappering on the
7683 * @li slide_short - The text appears in the left of the label and slides to
7684 * the right to show the overflow. When all of the text has been shown the
7685 * position is reset.
7686 * @li slide_bounce - The text appears in the left of the label and slides to
7687 * the right to show the overflow. When all of the text has been shown the
7688 * animation reverses, moving the text to the left.
7690 * Custom themes can of course invent new markup tags and style them any way
7693 * The following signals may be emitted by the label widget:
7694 * @li "language,changed": The program's language changed.
7696 * See @ref tutorial_label for a demonstration of how to use a label widget.
7700 * @brief Add a new label to the parent
7702 * @param parent The parent object
7703 * @return The new object or NULL if it cannot be created
7705 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7707 * @brief Set the label on the label object
7709 * @param obj The label object
7710 * @param label The label will be used on the label object
7711 * @deprecated See elm_object_text_set()
7713 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
7715 * @brief Get the label used on the label object
7717 * @param obj The label object
7718 * @return The string inside the label
7719 * @deprecated See elm_object_text_get()
7721 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7723 * @brief Set the wrapping behavior of the label
7725 * @param obj The label object
7726 * @param wrap To wrap text or not
7728 * By default no wrapping is done. Possible values for @p wrap are:
7729 * @li ELM_WRAP_NONE - No wrapping
7730 * @li ELM_WRAP_CHAR - wrap between characters
7731 * @li ELM_WRAP_WORD - wrap between words
7732 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7734 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7736 * @brief Get the wrapping behavior of the label
7738 * @param obj The label object
7741 * @see elm_label_line_wrap_set()
7743 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7745 * @brief Set wrap width of the label
7747 * @param obj The label object
7748 * @param w The wrap width in pixels at a minimum where words need to wrap
7750 * This function sets the maximum width size hint of the label.
7752 * @warning This is only relevant if the label is inside a container.
7754 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7756 * @brief Get wrap width of the label
7758 * @param obj The label object
7759 * @return The wrap width in pixels at a minimum where words need to wrap
7761 * @see elm_label_wrap_width_set()
7763 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7765 * @brief Set wrap height of the label
7767 * @param obj The label object
7768 * @param h The wrap height in pixels at a minimum where words need to wrap
7770 * This function sets the maximum height size hint of the label.
7772 * @warning This is only relevant if the label is inside a container.
7774 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7776 * @brief get wrap width of the label
7778 * @param obj The label object
7779 * @return The wrap height in pixels at a minimum where words need to wrap
7781 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7783 * @brief Set the font size on the label object.
7785 * @param obj The label object
7786 * @param size font size
7788 * @warning NEVER use this. It is for hyper-special cases only. use styles
7789 * instead. e.g. "default", "marker", "slide_long" etc.
7791 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7793 * @brief Set the text color on the label object
7795 * @param obj The label object
7796 * @param r Red property background color of The label object
7797 * @param g Green property background color of The label object
7798 * @param b Blue property background color of The label object
7799 * @param a Alpha property background color of The label object
7801 * @warning NEVER use this. It is for hyper-special cases only. use styles
7802 * instead. e.g. "default", "marker", "slide_long" etc.
7804 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);
7806 * @brief Set the text align on the label object
7808 * @param obj The label object
7809 * @param align align mode ("left", "center", "right")
7811 * @warning NEVER use this. It is for hyper-special cases only. use styles
7812 * instead. e.g. "default", "marker", "slide_long" etc.
7814 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7816 * @brief Set background color of the label
7818 * @param obj The label object
7819 * @param r Red property background color of The label object
7820 * @param g Green property background color of The label object
7821 * @param b Blue property background color of The label object
7822 * @param a Alpha property background alpha of The label object
7824 * @warning NEVER use this. It is for hyper-special cases only. use styles
7825 * instead. e.g. "default", "marker", "slide_long" etc.
7827 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);
7829 * @brief Set the ellipsis behavior of the label
7831 * @param obj The label object
7832 * @param ellipsis To ellipsis text or not
7834 * If set to true and the text doesn't fit in the label an ellipsis("...")
7835 * will be shown at the end of the widget.
7837 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7838 * choosen wrap method was ELM_WRAP_WORD.
7840 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7841 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7843 * @brief Set the text slide of the label
7845 * @param obj The label object
7846 * @param slide To start slide or stop
7848 * If set to true, the text of the label will slide/scroll through the length of
7851 * @warning This only works with the themes "slide_short", "slide_long" and
7854 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7856 * @brief Get the text slide mode of the label
7858 * @param obj The label object
7859 * @return slide slide mode value
7861 * @see elm_label_slide_set()
7863 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7865 * @brief Set the slide duration(speed) of the label
7867 * @param obj The label object
7868 * @return The duration in seconds in moving text from slide begin position
7869 * to slide end position
7871 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7873 * @brief Get the slide duration(speed) of the label
7875 * @param obj The label object
7876 * @return The duration time in moving text from slide begin position to slide end position
7878 * @see elm_label_slide_duration_set()
7880 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7886 * @defgroup Frame Frame
7888 * @image html img/widget/frame/preview-00.png
7889 * @image latex img/widget/frame/preview-00.eps
7891 * @brief Frame is a widget that holds some content and has a title.
7893 * The default look is a frame with a title, but Frame supports multple
7901 * @li outdent_bottom
7903 * Of all this styles only default shows the title. Frame emits no signals.
7905 * Default contents parts of the frame widget that you can use for are:
7906 * @li "default" - A content of the frame
7908 * Default text parts of the frame widget that you can use for are:
7909 * @li "elm.text" - Label of the frame
7911 * For a detailed example see the @ref tutorial_frame.
7916 * @brief Add a new frame to the parent
7918 * @param parent The parent object
7919 * @return The new object or NULL if it cannot be created
7921 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7923 * @brief Set the frame label
7925 * @param obj The frame object
7926 * @param label The label of this frame object
7928 * @deprecated use elm_object_text_set() instead.
7930 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7932 * @brief Get the frame label
7934 * @param obj The frame object
7936 * @return The label of this frame objet or NULL if unable to get frame
7938 * @deprecated use elm_object_text_get() instead.
7940 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7942 * @brief Set the content of the frame widget
7944 * Once the content object is set, a previously set one will be deleted.
7945 * If you want to keep that old content object, use the
7946 * elm_frame_content_unset() function.
7948 * @param obj The frame object
7949 * @param content The content will be filled in this frame object
7951 * @deprecated use elm_object_content_set() instead.
7953 WILL_DEPRECATE EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7955 * @brief Get the content of the frame widget
7957 * Return the content object which is set for this widget
7959 * @param obj The frame object
7960 * @return The content that is being used
7962 * @deprecated use elm_object_content_get() instead.
7964 WILL_DEPRECATE EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7966 * @brief Unset the content of the frame widget
7968 * Unparent and return the content object which was set for this widget
7970 * @param obj The frame object
7971 * @return The content that was being used
7973 * @deprecated use elm_object_content_unset() instead.
7975 WILL_DEPRECATE EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7981 * @defgroup Table Table
7983 * A container widget to arrange other widgets in a table where items can
7984 * also span multiple columns or rows - even overlap (and then be raised or
7985 * lowered accordingly to adjust stacking if they do overlap).
7987 * For a Table widget the row/column count is not fixed.
7988 * The table widget adjusts itself when subobjects are added to it dynamically.
7990 * The followin are examples of how to use a table:
7991 * @li @ref tutorial_table_01
7992 * @li @ref tutorial_table_02
7997 * @brief Add a new table to the parent
7999 * @param parent The parent object
8000 * @return The new object or NULL if it cannot be created
8002 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8004 * @brief Set the homogeneous layout in the table
8006 * @param obj The layout object
8007 * @param homogeneous A boolean to set if the layout is homogeneous in the
8008 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8010 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8012 * @brief Get the current table homogeneous mode.
8014 * @param obj The table object
8015 * @return A boolean to indicating if the layout is homogeneous in the table
8016 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8018 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8020 * @warning <b>Use elm_table_homogeneous_set() instead</b>
8022 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
8024 * @warning <b>Use elm_table_homogeneous_get() instead</b>
8026 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8028 * @brief Set padding between cells.
8030 * @param obj The layout object.
8031 * @param horizontal set the horizontal padding.
8032 * @param vertical set the vertical padding.
8034 * Default value is 0.
8036 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8038 * @brief Get padding between cells.
8040 * @param obj The layout object.
8041 * @param horizontal set the horizontal padding.
8042 * @param vertical set the vertical padding.
8044 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8046 * @brief Add a subobject on the table with the coordinates passed
8048 * @param obj The table object
8049 * @param subobj The subobject to be added to the table
8050 * @param x Row number
8051 * @param y Column number
8055 * @note All positioning inside the table is relative to rows and columns, so
8056 * a value of 0 for x and y, means the top left cell of the table, and a
8057 * value of 1 for w and h means @p subobj only takes that 1 cell.
8059 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8061 * @brief Remove child from table.
8063 * @param obj The table object
8064 * @param subobj The subobject
8066 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8068 * @brief Faster way to remove all child objects from a table object.
8070 * @param obj The table object
8071 * @param clear If true, will delete children, else just remove from table.
8073 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8075 * @brief Set the packing location of an existing child of the table
8077 * @param subobj The subobject to be modified in the table
8078 * @param x Row number
8079 * @param y Column number
8083 * Modifies the position of an object already in the table.
8085 * @note All positioning inside the table is relative to rows and columns, so
8086 * a value of 0 for x and y, means the top left cell of the table, and a
8087 * value of 1 for w and h means @p subobj only takes that 1 cell.
8089 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8091 * @brief Get the packing location of an existing child of the table
8093 * @param subobj The subobject to be modified in the table
8094 * @param x Row number
8095 * @param y Column number
8099 * @see elm_table_pack_set()
8101 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8107 * @defgroup Gengrid Gengrid (Generic grid)
8109 * This widget aims to position objects in a grid layout while
8110 * actually creating and rendering only the visible ones, using the
8111 * same idea as the @ref Genlist "genlist": the user defines a @b
8112 * class for each item, specifying functions that will be called at
8113 * object creation, deletion, etc. When those items are selected by
8114 * the user, a callback function is issued. Users may interact with
8115 * a gengrid via the mouse (by clicking on items to select them and
8116 * clicking on the grid's viewport and swiping to pan the whole
8117 * view) or via the keyboard, navigating through item with the
8120 * @section Gengrid_Layouts Gengrid layouts
8122 * Gengrid may layout its items in one of two possible layouts:
8126 * When in "horizontal mode", items will be placed in @b columns,
8127 * from top to bottom and, when the space for a column is filled,
8128 * another one is started on the right, thus expanding the grid
8129 * horizontally, making for horizontal scrolling. When in "vertical
8130 * mode" , though, items will be placed in @b rows, from left to
8131 * right and, when the space for a row is filled, another one is
8132 * started below, thus expanding the grid vertically (and making
8133 * for vertical scrolling).
8135 * @section Gengrid_Items Gengrid items
8137 * An item in a gengrid can have 0 or more text labels (they can be
8138 * regular text or textblock Evas objects - that's up to the style
8139 * to determine), 0 or more icons (which are simply objects
8140 * swallowed into the gengrid item's theming Edje object) and 0 or
8141 * more <b>boolean states</b>, which have the behavior left to the
8142 * user to define. The Edje part names for each of these properties
8143 * will be looked up, in the theme file for the gengrid, under the
8144 * Edje (string) data items named @c "labels", @c "icons" and @c
8145 * "states", respectively. For each of those properties, if more
8146 * than one part is provided, they must have names listed separated
8147 * by spaces in the data fields. For the default gengrid item
8148 * theme, we have @b one label part (@c "elm.text"), @b two icon
8149 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8152 * A gengrid item may be at one of several styles. Elementary
8153 * provides one by default - "default", but this can be extended by
8154 * system or application custom themes/overlays/extensions (see
8155 * @ref Theme "themes" for more details).
8157 * @section Gengrid_Item_Class Gengrid item classes
8159 * In order to have the ability to add and delete items on the fly,
8160 * gengrid implements a class (callback) system where the
8161 * application provides a structure with information about that
8162 * type of item (gengrid may contain multiple different items with
8163 * different classes, states and styles). Gengrid will call the
8164 * functions in this struct (methods) when an item is "realized"
8165 * (i.e., created dynamically, while the user is scrolling the
8166 * grid). All objects will simply be deleted when no longer needed
8167 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8168 * contains the following members:
8169 * - @c item_style - This is a constant string and simply defines
8170 * the name of the item style. It @b must be specified and the
8171 * default should be @c "default".
8172 * - @c func.label_get - This function is called when an item
8173 * object is actually created. The @c data parameter will point to
8174 * the same data passed to elm_gengrid_item_append() and related
8175 * item creation functions. The @c obj parameter is the gengrid
8176 * object itself, while the @c part one is the name string of one
8177 * of the existing text parts in the Edje group implementing the
8178 * item's theme. This function @b must return a strdup'()ed string,
8179 * as the caller will free() it when done. See
8180 * #Elm_Gengrid_Item_Label_Get_Cb.
8181 * - @c func.content_get - This function is called when an item object
8182 * is actually created. The @c data parameter will point to the
8183 * same data passed to elm_gengrid_item_append() and related item
8184 * creation functions. The @c obj parameter is the gengrid object
8185 * itself, while the @c part one is the name string of one of the
8186 * existing (content) swallow parts in the Edje group implementing the
8187 * item's theme. It must return @c NULL, when no content is desired,
8188 * or a valid object handle, otherwise. The object will be deleted
8189 * by the gengrid on its deletion or when the item is "unrealized".
8190 * See #Elm_Gengrid_Item_Content_Get_Cb.
8191 * - @c func.state_get - This function is called when an item
8192 * object is actually created. The @c data parameter will point to
8193 * the same data passed to elm_gengrid_item_append() and related
8194 * item creation functions. The @c obj parameter is the gengrid
8195 * object itself, while the @c part one is the name string of one
8196 * of the state parts in the Edje group implementing the item's
8197 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8198 * true/on. Gengrids will emit a signal to its theming Edje object
8199 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8200 * "source" arguments, respectively, when the state is true (the
8201 * default is false), where @c XXX is the name of the (state) part.
8202 * See #Elm_Gengrid_Item_State_Get_Cb.
8203 * - @c func.del - This is called when elm_gengrid_item_del() is
8204 * called on an item or elm_gengrid_clear() is called on the
8205 * gengrid. This is intended for use when gengrid items are
8206 * deleted, so any data attached to the item (e.g. its data
8207 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8209 * @section Gengrid_Usage_Hints Usage hints
8211 * If the user wants to have multiple items selected at the same
8212 * time, elm_gengrid_multi_select_set() will permit it. If the
8213 * gengrid is single-selection only (the default), then
8214 * elm_gengrid_select_item_get() will return the selected item or
8215 * @c NULL, if none is selected. If the gengrid is under
8216 * multi-selection, then elm_gengrid_selected_items_get() will
8217 * return a list (that is only valid as long as no items are
8218 * modified (added, deleted, selected or unselected) of child items
8221 * If an item changes (internal (boolean) state, label or content
8222 * changes), then use elm_gengrid_item_update() to have gengrid
8223 * update the item with the new state. A gengrid will re-"realize"
8224 * the item, thus calling the functions in the
8225 * #Elm_Gengrid_Item_Class set for that item.
8227 * To programmatically (un)select an item, use
8228 * elm_gengrid_item_selected_set(). To get its selected state use
8229 * elm_gengrid_item_selected_get(). To make an item disabled
8230 * (unable to be selected and appear differently) use
8231 * elm_gengrid_item_disabled_set() to set this and
8232 * elm_gengrid_item_disabled_get() to get the disabled state.
8234 * Grid cells will only have their selection smart callbacks called
8235 * when firstly getting selected. Any further clicks will do
8236 * nothing, unless you enable the "always select mode", with
8237 * elm_gengrid_always_select_mode_set(), thus making every click to
8238 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8239 * turn off the ability to select items entirely in the widget and
8240 * they will neither appear selected nor call the selection smart
8243 * Remember that you can create new styles and add your own theme
8244 * augmentation per application with elm_theme_extension_add(). If
8245 * you absolutely must have a specific style that overrides any
8246 * theme the user or system sets up you can use
8247 * elm_theme_overlay_add() to add such a file.
8249 * @section Gengrid_Smart_Events Gengrid smart events
8251 * Smart events that you can add callbacks for are:
8252 * - @c "activated" - The user has double-clicked or pressed
8253 * (enter|return|spacebar) on an item. The @c event_info parameter
8254 * is the gengrid item that was activated.
8255 * - @c "clicked,double" - The user has double-clicked an item.
8256 * The @c event_info parameter is the gengrid item that was double-clicked.
8257 * - @c "longpressed" - This is called when the item is pressed for a certain
8258 * amount of time. By default it's 1 second.
8259 * - @c "selected" - The user has made an item selected. The
8260 * @c event_info parameter is the gengrid item that was selected.
8261 * - @c "unselected" - The user has made an item unselected. The
8262 * @c event_info parameter is the gengrid item that was unselected.
8263 * - @c "realized" - This is called when the item in the gengrid
8264 * has its implementing Evas object instantiated, de facto. @c
8265 * event_info is the gengrid item that was created. The object
8266 * may be deleted at any time, so it is highly advised to the
8267 * caller @b not to use the object pointer returned from
8268 * elm_gengrid_item_object_get(), because it may point to freed
8270 * - @c "unrealized" - This is called when the implementing Evas
8271 * object for this item is deleted. @c event_info is the gengrid
8272 * item that was deleted.
8273 * - @c "changed" - Called when an item is added, removed, resized
8274 * or moved and when the gengrid is resized or gets "horizontal"
8276 * - @c "scroll,anim,start" - This is called when scrolling animation has
8278 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8280 * - @c "drag,start,up" - Called when the item in the gengrid has
8281 * been dragged (not scrolled) up.
8282 * - @c "drag,start,down" - Called when the item in the gengrid has
8283 * been dragged (not scrolled) down.
8284 * - @c "drag,start,left" - Called when the item in the gengrid has
8285 * been dragged (not scrolled) left.
8286 * - @c "drag,start,right" - Called when the item in the gengrid has
8287 * been dragged (not scrolled) right.
8288 * - @c "drag,stop" - Called when the item in the gengrid has
8289 * stopped being dragged.
8290 * - @c "drag" - Called when the item in the gengrid is being
8292 * - @c "scroll" - called when the content has been scrolled
8294 * - @c "scroll,drag,start" - called when dragging the content has
8296 * - @c "scroll,drag,stop" - called when dragging the content has
8298 * - @c "edge,top" - This is called when the gengrid is scrolled until
8300 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8301 * until the bottom edge.
8302 * - @c "edge,left" - This is called when the gengrid is scrolled
8303 * until the left edge.
8304 * - @c "edge,right" - This is called when the gengrid is scrolled
8305 * until the right edge.
8307 * List of gengrid examples:
8308 * @li @ref gengrid_example
8312 * @addtogroup Gengrid
8316 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8317 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8318 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8320 * Label fetching class function for Elm_Gen_Item_Class.
8321 * @param data The data passed in the item creation function
8322 * @param obj The base widget object
8323 * @param part The part name of the swallow
8324 * @return The allocated (NOT stringshared) string to set as the label
8326 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8328 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8329 * @param data The data passed in the item creation function
8330 * @param obj The base widget object
8331 * @param part The part name of the swallow
8332 * @return The content object to swallow
8334 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8336 * State fetching class function for Elm_Gen_Item_Class.
8337 * @param data The data passed in the item creation function
8338 * @param obj The base widget object
8339 * @param part The part name of the swallow
8340 * @return The hell if I know
8342 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8344 * Deletion class function for Elm_Gen_Item_Class.
8345 * @param data The data passed in the item creation function
8346 * @param obj The base widget object
8348 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8350 /* temporary compatibility code */
8351 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8352 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8353 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8354 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8357 * @struct _Elm_Gengrid_Item_Class
8359 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8362 struct _Elm_Gengrid_Item_Class
8364 const char *item_style;
8365 struct _Elm_Gengrid_Item_Class_Func
8367 Elm_Gengrid_Item_Label_Get_Cb label_get;
8368 union { /* temporary compatibility code */
8369 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8370 Elm_Gengrid_Item_Content_Get_Cb content_get;
8372 Elm_Gengrid_Item_State_Get_Cb state_get;
8373 Elm_Gengrid_Item_Del_Cb del;
8375 }; /**< #Elm_Gengrid_Item_Class member definitions */
8377 * Add a new gengrid widget to the given parent Elementary
8378 * (container) object
8380 * @param parent The parent object
8381 * @return a new gengrid widget handle or @c NULL, on errors
8383 * This function inserts a new gengrid widget on the canvas.
8385 * @see elm_gengrid_item_size_set()
8386 * @see elm_gengrid_group_item_size_set()
8387 * @see elm_gengrid_horizontal_set()
8388 * @see elm_gengrid_item_append()
8389 * @see elm_gengrid_item_del()
8390 * @see elm_gengrid_clear()
8394 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8397 * Set the size for the items of a given gengrid widget
8399 * @param obj The gengrid object.
8400 * @param w The items' width.
8401 * @param h The items' height;
8403 * A gengrid, after creation, has still no information on the size
8404 * to give to each of its cells. So, you most probably will end up
8405 * with squares one @ref Fingers "finger" wide, the default
8406 * size. Use this function to force a custom size for you items,
8407 * making them as big as you wish.
8409 * @see elm_gengrid_item_size_get()
8413 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8416 * Get the size set for the items of a given gengrid widget
8418 * @param obj The gengrid object.
8419 * @param w Pointer to a variable where to store the items' width.
8420 * @param h Pointer to a variable where to store the items' height.
8422 * @note Use @c NULL pointers on the size values you're not
8423 * interested in: they'll be ignored by the function.
8425 * @see elm_gengrid_item_size_get() for more details
8429 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8432 * Set the items grid's alignment within a given gengrid widget
8434 * @param obj The gengrid object.
8435 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8436 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8438 * This sets the alignment of the whole grid of items of a gengrid
8439 * within its given viewport. By default, those values are both
8440 * 0.5, meaning that the gengrid will have its items grid placed
8441 * exactly in the middle of its viewport.
8443 * @note If given alignment values are out of the cited ranges,
8444 * they'll be changed to the nearest boundary values on the valid
8447 * @see elm_gengrid_align_get()
8451 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8454 * Get the items grid's alignment values within a given gengrid
8457 * @param obj The gengrid object.
8458 * @param align_x Pointer to a variable where to store the
8459 * horizontal alignment.
8460 * @param align_y Pointer to a variable where to store the vertical
8463 * @note Use @c NULL pointers on the alignment values you're not
8464 * interested in: they'll be ignored by the function.
8466 * @see elm_gengrid_align_set() for more details
8470 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8473 * Set whether a given gengrid widget is or not able have items
8476 * @param obj The gengrid object
8477 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8478 * @c EINA_FALSE to turn it off
8480 * If a gengrid is set to allow reordering, a click held for more
8481 * than 0.5 over a given item will highlight it specially,
8482 * signalling the gengrid has entered the reordering state. From
8483 * that time on, the user will be able to, while still holding the
8484 * mouse button down, move the item freely in the gengrid's
8485 * viewport, replacing to said item to the locations it goes to.
8486 * The replacements will be animated and, whenever the user
8487 * releases the mouse button, the item being replaced gets a new
8488 * definitive place in the grid.
8490 * @see elm_gengrid_reorder_mode_get()
8494 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8497 * Get whether a given gengrid widget is or not able have items
8500 * @param obj The gengrid object
8501 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8504 * @see elm_gengrid_reorder_mode_set() for more details
8508 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8511 * Append a new item in a given gengrid widget.
8513 * @param obj The gengrid object.
8514 * @param gic The item class for the item.
8515 * @param data The item data.
8516 * @param func Convenience function called when the item is
8518 * @param func_data Data to be passed to @p func.
8519 * @return A handle to the item added or @c NULL, on errors.
8521 * This adds an item to the beginning of the gengrid.
8523 * @see elm_gengrid_item_prepend()
8524 * @see elm_gengrid_item_insert_before()
8525 * @see elm_gengrid_item_insert_after()
8526 * @see elm_gengrid_item_del()
8530 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);
8533 * Prepend a new item in a given gengrid widget.
8535 * @param obj The gengrid object.
8536 * @param gic The item class for the item.
8537 * @param data The item data.
8538 * @param func Convenience function called when the item is
8540 * @param func_data Data to be passed to @p func.
8541 * @return A handle to the item added or @c NULL, on errors.
8543 * This adds an item to the end of the gengrid.
8545 * @see elm_gengrid_item_append()
8546 * @see elm_gengrid_item_insert_before()
8547 * @see elm_gengrid_item_insert_after()
8548 * @see elm_gengrid_item_del()
8552 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);
8555 * Insert an item before another in a gengrid widget
8557 * @param obj The gengrid object.
8558 * @param gic The item class for the item.
8559 * @param data The item data.
8560 * @param relative The item to place this new one before.
8561 * @param func Convenience function called when the item is
8563 * @param func_data Data to be passed to @p func.
8564 * @return A handle to the item added or @c NULL, on errors.
8566 * This inserts an item before another in the gengrid.
8568 * @see elm_gengrid_item_append()
8569 * @see elm_gengrid_item_prepend()
8570 * @see elm_gengrid_item_insert_after()
8571 * @see elm_gengrid_item_del()
8575 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);
8578 * Insert an item after another in a gengrid widget
8580 * @param obj The gengrid object.
8581 * @param gic The item class for the item.
8582 * @param data The item data.
8583 * @param relative The item to place this new one after.
8584 * @param func Convenience function called when the item is
8586 * @param func_data Data to be passed to @p func.
8587 * @return A handle to the item added or @c NULL, on errors.
8589 * This inserts an item after another in the gengrid.
8591 * @see elm_gengrid_item_append()
8592 * @see elm_gengrid_item_prepend()
8593 * @see elm_gengrid_item_insert_after()
8594 * @see elm_gengrid_item_del()
8598 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);
8601 * Insert an item in a gengrid widget using a user-defined sort function.
8603 * @param obj The gengrid object.
8604 * @param gic The item class for the item.
8605 * @param data The item data.
8606 * @param comp User defined comparison function that defines the sort order based on
8607 * Elm_Gen_Item and its data param.
8608 * @param func Convenience function called when the item is selected.
8609 * @param func_data Data to be passed to @p func.
8610 * @return A handle to the item added or @c NULL, on errors.
8612 * This inserts an item in the gengrid based on user defined comparison function.
8614 * @see elm_gengrid_item_append()
8615 * @see elm_gengrid_item_prepend()
8616 * @see elm_gengrid_item_insert_after()
8617 * @see elm_gengrid_item_del()
8618 * @see elm_gengrid_item_direct_sorted_insert()
8622 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);
8625 * Insert an item in a gengrid widget using a user-defined sort function.
8627 * @param obj The gengrid object.
8628 * @param gic The item class for the item.
8629 * @param data The item data.
8630 * @param comp User defined comparison function that defines the sort order based on
8632 * @param func Convenience function called when the item is selected.
8633 * @param func_data Data to be passed to @p func.
8634 * @return A handle to the item added or @c NULL, on errors.
8636 * This inserts an item in the gengrid based on user defined comparison function.
8638 * @see elm_gengrid_item_append()
8639 * @see elm_gengrid_item_prepend()
8640 * @see elm_gengrid_item_insert_after()
8641 * @see elm_gengrid_item_del()
8642 * @see elm_gengrid_item_sorted_insert()
8646 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);
8649 * Set whether items on a given gengrid widget are to get their
8650 * selection callbacks issued for @b every subsequent selection
8651 * click on them or just for the first click.
8653 * @param obj The gengrid object
8654 * @param always_select @c EINA_TRUE to make items "always
8655 * selected", @c EINA_FALSE, otherwise
8657 * By default, grid items will only call their selection callback
8658 * function when firstly getting selected, any subsequent further
8659 * clicks will do nothing. With this call, you make those
8660 * subsequent clicks also to issue the selection callbacks.
8662 * @note <b>Double clicks</b> will @b always be reported on items.
8664 * @see elm_gengrid_always_select_mode_get()
8668 WILL_DEPRECATE EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8671 * Get whether items on a given gengrid widget have their selection
8672 * callbacks issued for @b every subsequent selection click on them
8673 * or just for the first click.
8675 * @param obj The gengrid object.
8676 * @return @c EINA_TRUE if the gengrid items are "always selected",
8677 * @c EINA_FALSE, otherwise
8679 * @see elm_gengrid_always_select_mode_set() for more details
8683 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8686 * Set whether items on a given gengrid widget can be selected or not.
8688 * @param obj The gengrid object
8689 * @param no_select @c EINA_TRUE to make items selectable,
8690 * @c EINA_FALSE otherwise
8692 * This will make items in @p obj selectable or not. In the latter
8693 * case, any user interaction on the gengrid items will neither make
8694 * them appear selected nor them call their selection callback
8697 * @see elm_gengrid_no_select_mode_get()
8701 WILL_DEPRECATE EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8704 * Get whether items on a given gengrid widget can be selected or
8707 * @param obj The gengrid object
8708 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8711 * @see elm_gengrid_no_select_mode_set() for more details
8715 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8718 * Enable or disable multi-selection in a given gengrid widget
8720 * @param obj The gengrid object.
8721 * @param multi @c EINA_TRUE, to enable multi-selection,
8722 * @c EINA_FALSE to disable it.
8724 * Multi-selection is the ability to have @b more than one
8725 * item selected, on a given gengrid, simultaneously. When it is
8726 * enabled, a sequence of clicks on different items will make them
8727 * all selected, progressively. A click on an already selected item
8728 * will unselect it. If interacting via the keyboard,
8729 * multi-selection is enabled while holding the "Shift" key.
8731 * @note By default, multi-selection is @b disabled on gengrids
8733 * @see elm_gengrid_multi_select_get()
8737 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8740 * Get whether multi-selection is enabled or disabled for a given
8743 * @param obj The gengrid object.
8744 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8745 * EINA_FALSE otherwise
8747 * @see elm_gengrid_multi_select_set() for more details
8751 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8754 * Enable or disable bouncing effect for a given gengrid widget
8756 * @param obj The gengrid object
8757 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8758 * @c EINA_FALSE to disable it
8759 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8760 * @c EINA_FALSE to disable it
8762 * The bouncing effect occurs whenever one reaches the gengrid's
8763 * edge's while panning it -- it will scroll past its limits a
8764 * little bit and return to the edge again, in a animated for,
8767 * @note By default, gengrids have bouncing enabled on both axis
8769 * @see elm_gengrid_bounce_get()
8773 WILL_DEPRECATE EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8776 * Get whether bouncing effects are enabled or disabled, for a
8777 * given gengrid widget, on each axis
8779 * @param obj The gengrid object
8780 * @param h_bounce Pointer to a variable where to store the
8781 * horizontal bouncing flag.
8782 * @param v_bounce Pointer to a variable where to store the
8783 * vertical bouncing flag.
8785 * @see elm_gengrid_bounce_set() for more details
8789 WILL_DEPRECATE EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8792 * Set a given gengrid widget's scrolling page size, relative to
8793 * its viewport size.
8795 * @param obj The gengrid object
8796 * @param h_pagerel The horizontal page (relative) size
8797 * @param v_pagerel The vertical page (relative) size
8799 * The gengrid's scroller is capable of binding scrolling by the
8800 * user to "pages". It means that, while scrolling and, specially
8801 * after releasing the mouse button, the grid will @b snap to the
8802 * nearest displaying page's area. When page sizes are set, the
8803 * grid's continuous content area is split into (equal) page sized
8806 * This function sets the size of a page <b>relatively to the
8807 * viewport dimensions</b> of the gengrid, for each axis. A value
8808 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8809 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8810 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8811 * 1.0. Values beyond those will make it behave behave
8812 * inconsistently. If you only want one axis to snap to pages, use
8813 * the value @c 0.0 for the other one.
8815 * There is a function setting page size values in @b absolute
8816 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8817 * is mutually exclusive to this one.
8819 * @see elm_gengrid_page_relative_get()
8823 WILL_DEPRECATE EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8826 * Get a given gengrid widget's scrolling page size, relative to
8827 * its viewport size.
8829 * @param obj The gengrid object
8830 * @param h_pagerel Pointer to a variable where to store the
8831 * horizontal page (relative) size
8832 * @param v_pagerel Pointer to a variable where to store the
8833 * vertical page (relative) size
8835 * @see elm_gengrid_page_relative_set() for more details
8839 WILL_DEPRECATE EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8842 * Set a given gengrid widget's scrolling page size
8844 * @param obj The gengrid object
8845 * @param h_pagerel The horizontal page size, in pixels
8846 * @param v_pagerel The vertical page size, in pixels
8848 * The gengrid's scroller is capable of binding scrolling by the
8849 * user to "pages". It means that, while scrolling and, specially
8850 * after releasing the mouse button, the grid will @b snap to the
8851 * nearest displaying page's area. When page sizes are set, the
8852 * grid's continuous content area is split into (equal) page sized
8855 * This function sets the size of a page of the gengrid, in pixels,
8856 * for each axis. Sane usable values are, between @c 0 and the
8857 * dimensions of @p obj, for each axis. Values beyond those will
8858 * make it behave behave inconsistently. If you only want one axis
8859 * to snap to pages, use the value @c 0 for the other one.
8861 * There is a function setting page size values in @b relative
8862 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8863 * use is mutually exclusive to this one.
8867 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8870 * Set the direction in which a given gengrid widget will expand while
8871 * placing its items.
8873 * @param obj The gengrid object.
8874 * @param setting @c EINA_TRUE to make the gengrid expand
8875 * horizontally, @c EINA_FALSE to expand vertically.
8877 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8878 * in @b columns, from top to bottom and, when the space for a
8879 * column is filled, another one is started on the right, thus
8880 * expanding the grid horizontally. When in "vertical mode"
8881 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8882 * to right and, when the space for a row is filled, another one is
8883 * started below, thus expanding the grid vertically.
8885 * @see elm_gengrid_horizontal_get()
8889 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8892 * Get for what direction a given gengrid widget will expand while
8893 * placing its items.
8895 * @param obj The gengrid object.
8896 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8897 * @c EINA_FALSE if it's set to expand vertically.
8899 * @see elm_gengrid_horizontal_set() for more detais
8903 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8906 * Get the first item in a given gengrid widget
8908 * @param obj The gengrid object
8909 * @return The first item's handle or @c NULL, if there are no
8910 * items in @p obj (and on errors)
8912 * This returns the first item in the @p obj's internal list of
8915 * @see elm_gengrid_last_item_get()
8919 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8922 * Get the last item in a given gengrid widget
8924 * @param obj The gengrid object
8925 * @return The last item's handle or @c NULL, if there are no
8926 * items in @p obj (and on errors)
8928 * This returns the last item in the @p obj's internal list of
8931 * @see elm_gengrid_first_item_get()
8935 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8938 * Get the @b next item in a gengrid widget's internal list of items,
8939 * given a handle to one of those items.
8941 * @param item The gengrid item to fetch next from
8942 * @return The item after @p item, or @c NULL if there's none (and
8945 * This returns the item placed after the @p item, on the container
8948 * @see elm_gengrid_item_prev_get()
8952 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8955 * Get the @b previous item in a gengrid widget's internal list of items,
8956 * given a handle to one of those items.
8958 * @param item The gengrid item to fetch previous from
8959 * @return The item before @p item, or @c NULL if there's none (and
8962 * This returns the item placed before the @p item, on the container
8965 * @see elm_gengrid_item_next_get()
8969 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8972 * Get the gengrid object's handle which contains a given gengrid
8975 * @param item The item to fetch the container from
8976 * @return The gengrid (parent) object
8978 * This returns the gengrid object itself that an item belongs to.
8982 WILL_DEPRECATE EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8985 * Remove a gengrid item from its parent, deleting it.
8987 * @param item The item to be removed.
8988 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8990 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8995 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8998 * Update the contents of a given gengrid item
9000 * @param item The gengrid item
9002 * This updates an item by calling all the item class functions
9003 * again to get the contents, labels and states. Use this when the
9004 * original item data has changed and you want the changes to be
9009 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9012 * Get the Gengrid Item class for the given Gengrid Item.
9014 * @param item The gengrid item
9016 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9017 * the function pointers and item_style.
9021 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9024 * Get the Gengrid Item class for the given Gengrid Item.
9026 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9027 * the function pointers and item_style.
9029 * @param item The gengrid item
9030 * @param gic The gengrid item class describing the function pointers and the item style.
9034 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9037 * Return the data associated to a given gengrid item
9039 * @param item The gengrid item.
9040 * @return the data associated with this item.
9042 * This returns the @c data value passed on the
9043 * elm_gengrid_item_append() and related item addition calls.
9045 * @see elm_gengrid_item_append()
9046 * @see elm_gengrid_item_data_set()
9050 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9053 * Set the data associated with a given gengrid item
9055 * @param item The gengrid item
9056 * @param data The data pointer to set on it
9058 * This @b overrides the @c data value passed on the
9059 * elm_gengrid_item_append() and related item addition calls. This
9060 * function @b won't call elm_gengrid_item_update() automatically,
9061 * so you'd issue it afterwards if you want to have the item
9062 * updated to reflect the new data.
9064 * @see elm_gengrid_item_data_get()
9065 * @see elm_gengrid_item_update()
9069 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9072 * Get a given gengrid item's position, relative to the whole
9073 * gengrid's grid area.
9075 * @param item The Gengrid item.
9076 * @param x Pointer to variable to store the item's <b>row number</b>.
9077 * @param y Pointer to variable to store the item's <b>column number</b>.
9079 * This returns the "logical" position of the item within the
9080 * gengrid. For example, @c (0, 1) would stand for first row,
9085 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9088 * Set whether a given gengrid item is selected or not
9090 * @param item The gengrid item
9091 * @param selected Use @c EINA_TRUE, to make it selected, @c
9092 * EINA_FALSE to make it unselected
9094 * This sets the selected state of an item. If multi-selection is
9095 * not enabled on the containing gengrid and @p selected is @c
9096 * EINA_TRUE, any other previously selected items will get
9097 * unselected in favor of this new one.
9099 * @see elm_gengrid_item_selected_get()
9103 WILL_DEPRECATE EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9106 * Get whether a given gengrid item is selected or not
9108 * @param item The gengrid item
9109 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9111 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9113 * @see elm_gengrid_item_selected_set() for more details
9117 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9120 * Get the real Evas object created to implement the view of a
9121 * given gengrid item
9123 * @param item The gengrid item.
9124 * @return the Evas object implementing this item's view.
9126 * This returns the actual Evas object used to implement the
9127 * specified gengrid item's view. This may be @c NULL, as it may
9128 * not have been created or may have been deleted, at any time, by
9129 * the gengrid. <b>Do not modify this object</b> (move, resize,
9130 * show, hide, etc.), as the gengrid is controlling it. This
9131 * function is for querying, emitting custom signals or hooking
9132 * lower level callbacks for events on that object. Do not delete
9133 * this object under any circumstances.
9135 * @see elm_gengrid_item_data_get()
9139 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9142 * Show the portion of a gengrid's internal grid containing a given
9143 * item, @b immediately.
9145 * @param item The item to display
9147 * This causes gengrid to @b redraw its viewport's contents to the
9148 * region contining the given @p item item, if it is not fully
9151 * @see elm_gengrid_item_bring_in()
9155 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9158 * Animatedly bring in, to the visible area of a gengrid, a given
9161 * @param item The gengrid item to display
9163 * This causes gengrid to jump to the given @p item and show
9164 * it (by scrolling), if it is not fully visible. This will use
9165 * animation to do so and take a period of time to complete.
9167 * @see elm_gengrid_item_show()
9171 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9174 * Set whether a given gengrid item is disabled or not.
9176 * @param item The gengrid item
9177 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9178 * to enable it back.
9180 * A disabled item cannot be selected or unselected. It will also
9181 * change its appearance, to signal the user it's disabled.
9183 * @see elm_gengrid_item_disabled_get()
9187 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9190 * Get whether a given gengrid item is disabled or not.
9192 * @param item The gengrid item
9193 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9196 * @see elm_gengrid_item_disabled_set() for more details
9200 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9203 * Set the text to be shown in a given gengrid item's tooltips.
9205 * @param item The gengrid item
9206 * @param text The text to set in the content
9208 * This call will setup the text to be used as tooltip to that item
9209 * (analogous to elm_object_tooltip_text_set(), but being item
9210 * tooltips with higher precedence than object tooltips). It can
9211 * have only one tooltip at a time, so any previous tooltip data
9216 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9219 * Set the content to be shown in a given gengrid item's tooltip
9221 * @param item The gengrid item.
9222 * @param func The function returning the tooltip contents.
9223 * @param data What to provide to @a func as callback data/context.
9224 * @param del_cb Called when data is not needed anymore, either when
9225 * another callback replaces @p func, the tooltip is unset with
9226 * elm_gengrid_item_tooltip_unset() or the owner @p item
9227 * dies. This callback receives as its first parameter the
9228 * given @p data, being @c event_info the item handle.
9230 * This call will setup the tooltip's contents to @p item
9231 * (analogous to elm_object_tooltip_content_cb_set(), but being
9232 * item tooltips with higher precedence than object tooltips). It
9233 * can have only one tooltip at a time, so any previous tooltip
9234 * content will get removed. @p func (with @p data) will be called
9235 * every time Elementary needs to show the tooltip and it should
9236 * return a valid Evas object, which will be fully managed by the
9237 * tooltip system, getting deleted when the tooltip is gone.
9241 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);
9244 * Unset a tooltip from a given gengrid item
9246 * @param item gengrid item to remove a previously set tooltip from.
9248 * This call removes any tooltip set on @p item. The callback
9249 * provided as @c del_cb to
9250 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9251 * notify it is not used anymore (and have resources cleaned, if
9254 * @see elm_gengrid_item_tooltip_content_cb_set()
9258 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9261 * Set a different @b style for a given gengrid item's tooltip.
9263 * @param item gengrid item with tooltip set
9264 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9265 * "default", @c "transparent", etc)
9267 * Tooltips can have <b>alternate styles</b> to be displayed on,
9268 * which are defined by the theme set on Elementary. This function
9269 * works analogously as elm_object_tooltip_style_set(), but here
9270 * applied only to gengrid item objects. The default style for
9271 * tooltips is @c "default".
9273 * @note before you set a style you should define a tooltip with
9274 * elm_gengrid_item_tooltip_content_cb_set() or
9275 * elm_gengrid_item_tooltip_text_set()
9277 * @see elm_gengrid_item_tooltip_style_get()
9281 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9284 * Get the style set a given gengrid item's tooltip.
9286 * @param item gengrid item with tooltip already set on.
9287 * @return style the theme style in use, which defaults to
9288 * "default". If the object does not have a tooltip set,
9289 * then @c NULL is returned.
9291 * @see elm_gengrid_item_tooltip_style_set() for more details
9295 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9297 * @brief Disable size restrictions on an object's tooltip
9298 * @param item The tooltip's anchor object
9299 * @param disable If EINA_TRUE, size restrictions are disabled
9300 * @return EINA_FALSE on failure, EINA_TRUE on success
9302 * This function allows a tooltip to expand beyond its parant window's canvas.
9303 * It will instead be limited only by the size of the display.
9305 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9307 * @brief Retrieve size restriction state of an object's tooltip
9308 * @param item The tooltip's anchor object
9309 * @return If EINA_TRUE, size restrictions are disabled
9311 * This function returns whether a tooltip is allowed to expand beyond
9312 * its parant window's canvas.
9313 * It will instead be limited only by the size of the display.
9315 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9317 * Set the type of mouse pointer/cursor decoration to be shown,
9318 * when the mouse pointer is over the given gengrid widget item
9320 * @param item gengrid item to customize cursor on
9321 * @param cursor the cursor type's name
9323 * This function works analogously as elm_object_cursor_set(), but
9324 * here the cursor's changing area is restricted to the item's
9325 * area, and not the whole widget's. Note that that item cursors
9326 * have precedence over widget cursors, so that a mouse over @p
9327 * item will always show cursor @p type.
9329 * If this function is called twice for an object, a previously set
9330 * cursor will be unset on the second call.
9332 * @see elm_object_cursor_set()
9333 * @see elm_gengrid_item_cursor_get()
9334 * @see elm_gengrid_item_cursor_unset()
9338 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9341 * Get the type of mouse pointer/cursor decoration set to be shown,
9342 * when the mouse pointer is over the given gengrid widget item
9344 * @param item gengrid item with custom cursor set
9345 * @return the cursor type's name or @c NULL, if no custom cursors
9346 * were set to @p item (and on errors)
9348 * @see elm_object_cursor_get()
9349 * @see elm_gengrid_item_cursor_set() for more details
9350 * @see elm_gengrid_item_cursor_unset()
9354 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9357 * Unset any custom mouse pointer/cursor decoration set to be
9358 * shown, when the mouse pointer is over the given gengrid widget
9359 * item, thus making it show the @b default cursor again.
9361 * @param item a gengrid item
9363 * Use this call to undo any custom settings on this item's cursor
9364 * decoration, bringing it back to defaults (no custom style set).
9366 * @see elm_object_cursor_unset()
9367 * @see elm_gengrid_item_cursor_set() for more details
9371 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9374 * Set a different @b style for a given custom cursor set for a
9377 * @param item gengrid item with custom cursor set
9378 * @param style the <b>theme style</b> to use (e.g. @c "default",
9379 * @c "transparent", etc)
9381 * This function only makes sense when one is using custom mouse
9382 * cursor decorations <b>defined in a theme file</b> , which can
9383 * have, given a cursor name/type, <b>alternate styles</b> on
9384 * it. It works analogously as elm_object_cursor_style_set(), but
9385 * here applied only to gengrid item objects.
9387 * @warning Before you set a cursor style you should have defined a
9388 * custom cursor previously on the item, with
9389 * elm_gengrid_item_cursor_set()
9391 * @see elm_gengrid_item_cursor_engine_only_set()
9392 * @see elm_gengrid_item_cursor_style_get()
9396 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9399 * Get the current @b style set for a given gengrid item's custom
9402 * @param item gengrid item with custom cursor set.
9403 * @return style the cursor style in use. If the object does not
9404 * have a cursor set, then @c NULL is returned.
9406 * @see elm_gengrid_item_cursor_style_set() for more details
9410 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9413 * Set if the (custom) cursor for a given gengrid item should be
9414 * searched in its theme, also, or should only rely on the
9417 * @param item item with custom (custom) cursor already set on
9418 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9419 * only on those provided by the rendering engine, @c EINA_FALSE to
9420 * have them searched on the widget's theme, as well.
9422 * @note This call is of use only if you've set a custom cursor
9423 * for gengrid items, with elm_gengrid_item_cursor_set().
9425 * @note By default, cursors will only be looked for between those
9426 * provided by the rendering engine.
9430 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9433 * Get if the (custom) cursor for a given gengrid item is being
9434 * searched in its theme, also, or is only relying on the rendering
9437 * @param item a gengrid item
9438 * @return @c EINA_TRUE, if cursors are being looked for only on
9439 * those provided by the rendering engine, @c EINA_FALSE if they
9440 * are being searched on the widget's theme, as well.
9442 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9446 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9449 * Remove all items from a given gengrid widget
9451 * @param obj The gengrid object.
9453 * This removes (and deletes) all items in @p obj, leaving it
9456 * @see elm_gengrid_item_del(), to remove just one item.
9460 WILL_DEPRECATE EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9463 * Get the selected item in a given gengrid widget
9465 * @param obj The gengrid object.
9466 * @return The selected item's handleor @c NULL, if none is
9467 * selected at the moment (and on errors)
9469 * This returns the selected item in @p obj. If multi selection is
9470 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9471 * the first item in the list is selected, which might not be very
9472 * useful. For that case, see elm_gengrid_selected_items_get().
9476 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9479 * Get <b>a list</b> of selected items in a given gengrid
9481 * @param obj The gengrid object.
9482 * @return The list of selected items or @c NULL, if none is
9483 * selected at the moment (and on errors)
9485 * This returns a list of the selected items, in the order that
9486 * they appear in the grid. This list is only valid as long as no
9487 * more items are selected or unselected (or unselected implictly
9488 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9491 * @see elm_gengrid_selected_item_get()
9495 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9502 * @defgroup Clock Clock
9504 * @image html img/widget/clock/preview-00.png
9505 * @image latex img/widget/clock/preview-00.eps
9507 * This is a @b digital clock widget. In its default theme, it has a
9508 * vintage "flipping numbers clock" appearance, which will animate
9509 * sheets of individual algarisms individually as time goes by.
9511 * A newly created clock will fetch system's time (already
9512 * considering local time adjustments) to start with, and will tick
9513 * accondingly. It may or may not show seconds.
9515 * Clocks have an @b edition mode. When in it, the sheets will
9516 * display extra arrow indications on the top and bottom and the
9517 * user may click on them to raise or lower the time values. After
9518 * it's told to exit edition mode, it will keep ticking with that
9519 * new time set (it keeps the difference from local time).
9521 * Also, when under edition mode, user clicks on the cited arrows
9522 * which are @b held for some time will make the clock to flip the
9523 * sheet, thus editing the time, continuosly and automatically for
9524 * the user. The interval between sheet flips will keep growing in
9525 * time, so that it helps the user to reach a time which is distant
9528 * The time display is, by default, in military mode (24h), but an
9529 * am/pm indicator may be optionally shown, too, when it will
9532 * Smart callbacks one can register to:
9533 * - "changed" - the clock's user changed the time
9535 * Here is an example on its usage:
9536 * @li @ref clock_example
9545 * Identifiers for which clock digits should be editable, when a
9546 * clock widget is in edition mode. Values may be ORed together to
9547 * make a mask, naturally.
9549 * @see elm_clock_edit_set()
9550 * @see elm_clock_digit_edit_set()
9552 typedef enum _Elm_Clock_Digedit
9554 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9555 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9556 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9557 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9558 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9559 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9560 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9561 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9562 } Elm_Clock_Digedit;
9565 * Add a new clock widget to the given parent Elementary
9566 * (container) object
9568 * @param parent The parent object
9569 * @return a new clock widget handle or @c NULL, on errors
9571 * This function inserts a new clock widget on the canvas.
9575 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9578 * Set a clock widget's time, programmatically
9580 * @param obj The clock widget object
9581 * @param hrs The hours to set
9582 * @param min The minutes to set
9583 * @param sec The secondes to set
9585 * This function updates the time that is showed by the clock
9588 * Values @b must be set within the following ranges:
9589 * - 0 - 23, for hours
9590 * - 0 - 59, for minutes
9591 * - 0 - 59, for seconds,
9593 * even if the clock is not in "military" mode.
9595 * @warning The behavior for values set out of those ranges is @b
9600 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9603 * Get a clock widget's time values
9605 * @param obj The clock object
9606 * @param[out] hrs Pointer to the variable to get the hours value
9607 * @param[out] min Pointer to the variable to get the minutes value
9608 * @param[out] sec Pointer to the variable to get the seconds value
9610 * This function gets the time set for @p obj, returning
9611 * it on the variables passed as the arguments to function
9613 * @note Use @c NULL pointers on the time values you're not
9614 * interested in: they'll be ignored by the function.
9618 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9621 * Set whether a given clock widget is under <b>edition mode</b> or
9622 * under (default) displaying-only mode.
9624 * @param obj The clock object
9625 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9626 * put it back to "displaying only" mode
9628 * This function makes a clock's time to be editable or not <b>by
9629 * user interaction</b>. When in edition mode, clocks @b stop
9630 * ticking, until one brings them back to canonical mode. The
9631 * elm_clock_digit_edit_set() function will influence which digits
9632 * of the clock will be editable. By default, all of them will be
9633 * (#ELM_CLOCK_NONE).
9635 * @note am/pm sheets, if being shown, will @b always be editable
9636 * under edition mode.
9638 * @see elm_clock_edit_get()
9642 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9645 * Retrieve whether a given clock widget is under <b>edition
9646 * mode</b> or under (default) displaying-only mode.
9648 * @param obj The clock object
9649 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9652 * This function retrieves whether the clock's time can be edited
9653 * or not by user interaction.
9655 * @see elm_clock_edit_set() for more details
9659 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9662 * Set what digits of the given clock widget should be editable
9663 * when in edition mode.
9665 * @param obj The clock object
9666 * @param digedit Bit mask indicating the digits to be editable
9667 * (values in #Elm_Clock_Digedit).
9669 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9670 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9673 * @see elm_clock_digit_edit_get()
9677 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9680 * Retrieve what digits of the given clock widget should be
9681 * editable when in edition mode.
9683 * @param obj The clock object
9684 * @return Bit mask indicating the digits to be editable
9685 * (values in #Elm_Clock_Digedit).
9687 * @see elm_clock_digit_edit_set() for more details
9691 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9694 * Set if the given clock widget must show hours in military or
9697 * @param obj The clock object
9698 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9701 * This function sets if the clock must show hours in military or
9702 * am/pm mode. In some countries like Brazil the military mode
9703 * (00-24h-format) is used, in opposition to the USA, where the
9704 * am/pm mode is more commonly used.
9706 * @see elm_clock_show_am_pm_get()
9710 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9713 * Get if the given clock widget shows hours in military or am/pm
9716 * @param obj The clock object
9717 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9720 * This function gets if the clock shows hours in military or am/pm
9723 * @see elm_clock_show_am_pm_set() for more details
9727 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9730 * Set if the given clock widget must show time with seconds or not
9732 * @param obj The clock object
9733 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9735 * This function sets if the given clock must show or not elapsed
9736 * seconds. By default, they are @b not shown.
9738 * @see elm_clock_show_seconds_get()
9742 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9745 * Get whether the given clock widget is showing time with seconds
9748 * @param obj The clock object
9749 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9751 * This function gets whether @p obj is showing or not the elapsed
9754 * @see elm_clock_show_seconds_set()
9758 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9761 * Set the interval on time updates for an user mouse button hold
9762 * on clock widgets' time edition.
9764 * @param obj The clock object
9765 * @param interval The (first) interval value in seconds
9767 * This interval value is @b decreased while the user holds the
9768 * mouse pointer either incrementing or decrementing a given the
9769 * clock digit's value.
9771 * This helps the user to get to a given time distant from the
9772 * current one easier/faster, as it will start to flip quicker and
9773 * quicker on mouse button holds.
9775 * The calculation for the next flip interval value, starting from
9776 * the one set with this call, is the previous interval divided by
9777 * 1.05, so it decreases a little bit.
9779 * The default starting interval value for automatic flips is
9782 * @see elm_clock_interval_get()
9786 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9789 * Get the interval on time updates for an user mouse button hold
9790 * on clock widgets' time edition.
9792 * @param obj The clock object
9793 * @return The (first) interval value, in seconds, set on it
9795 * @see elm_clock_interval_set() for more details
9799 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9806 * @defgroup Layout Layout
9808 * @image html img/widget/layout/preview-00.png
9809 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9811 * @image html img/layout-predefined.png
9812 * @image latex img/layout-predefined.eps width=\textwidth
9814 * This is a container widget that takes a standard Edje design file and
9815 * wraps it very thinly in a widget.
9817 * An Edje design (theme) file has a very wide range of possibilities to
9818 * describe the behavior of elements added to the Layout. Check out the Edje
9819 * documentation and the EDC reference to get more information about what can
9820 * be done with Edje.
9822 * Just like @ref List, @ref Box, and other container widgets, any
9823 * object added to the Layout will become its child, meaning that it will be
9824 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9826 * The Layout widget can contain as many Contents, Boxes or Tables as
9827 * described in its theme file. For instance, objects can be added to
9828 * different Tables by specifying the respective Table part names. The same
9829 * is valid for Content and Box.
9831 * The objects added as child of the Layout will behave as described in the
9832 * part description where they were added. There are 3 possible types of
9833 * parts where a child can be added:
9835 * @section secContent Content (SWALLOW part)
9837 * Only one object can be added to the @c SWALLOW part (but you still can
9838 * have many @c SWALLOW parts and one object on each of them). Use the @c
9839 * elm_object_content_set/get/unset functions to set, retrieve and unset
9840 * objects as content of the @c SWALLOW. After being set to this part, the
9841 * object size, position, visibility, clipping and other description
9842 * properties will be totally controled by the description of the given part
9843 * (inside the Edje theme file).
9845 * One can use @c evas_object_size_hint_* functions on the child to have some
9846 * kind of control over its behavior, but the resulting behavior will still
9847 * depend heavily on the @c SWALLOW part description.
9849 * The Edje theme also can change the part description, based on signals or
9850 * scripts running inside the theme. This change can also be animated. All of
9851 * this will affect the child object set as content accordingly. The object
9852 * size will be changed if the part size is changed, it will animate move if
9853 * the part is moving, and so on.
9855 * The following picture demonstrates a Layout widget with a child object
9856 * added to its @c SWALLOW:
9858 * @image html layout_swallow.png
9859 * @image latex layout_swallow.eps width=\textwidth
9861 * @section secBox Box (BOX part)
9863 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9864 * allows one to add objects to the box and have them distributed along its
9865 * area, accordingly to the specified @a layout property (now by @a layout we
9866 * mean the chosen layouting design of the Box, not the Layout widget
9869 * A similar effect for having a box with its position, size and other things
9870 * controled by the Layout theme would be to create an Elementary @ref Box
9871 * widget and add it as a Content in the @c SWALLOW part.
9873 * The main difference of using the Layout Box is that its behavior, the box
9874 * properties like layouting format, padding, align, etc. will be all
9875 * controled by the theme. This means, for example, that a signal could be
9876 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9877 * handled the signal by changing the box padding, or align, or both. Using
9878 * the Elementary @ref Box widget is not necessarily harder or easier, it
9879 * just depends on the circunstances and requirements.
9881 * The Layout Box can be used through the @c elm_layout_box_* set of
9884 * The following picture demonstrates a Layout widget with many child objects
9885 * added to its @c BOX part:
9887 * @image html layout_box.png
9888 * @image latex layout_box.eps width=\textwidth
9890 * @section secTable Table (TABLE part)
9892 * Just like the @ref secBox, the Layout Table is very similar to the
9893 * Elementary @ref Table widget. It allows one to add objects to the Table
9894 * specifying the row and column where the object should be added, and any
9895 * column or row span if necessary.
9897 * Again, we could have this design by adding a @ref Table widget to the @c
9898 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9899 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9900 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9902 * The Layout Table can be used through the @c elm_layout_table_* set of
9905 * The following picture demonstrates a Layout widget with many child objects
9906 * added to its @c TABLE part:
9908 * @image html layout_table.png
9909 * @image latex layout_table.eps width=\textwidth
9911 * @section secPredef Predefined Layouts
9913 * Another interesting thing about the Layout widget is that it offers some
9914 * predefined themes that come with the default Elementary theme. These
9915 * themes can be set by the call elm_layout_theme_set(), and provide some
9916 * basic functionality depending on the theme used.
9918 * Most of them already send some signals, some already provide a toolbar or
9919 * back and next buttons.
9921 * These are available predefined theme layouts. All of them have class = @c
9922 * layout, group = @c application, and style = one of the following options:
9924 * @li @c toolbar-content - application with toolbar and main content area
9925 * @li @c toolbar-content-back - application with toolbar and main content
9926 * area with a back button and title area
9927 * @li @c toolbar-content-back-next - application with toolbar and main
9928 * content area with a back and next buttons and title area
9929 * @li @c content-back - application with a main content area with a back
9930 * button and title area
9931 * @li @c content-back-next - application with a main content area with a
9932 * back and next buttons and title area
9933 * @li @c toolbar-vbox - application with toolbar and main content area as a
9935 * @li @c toolbar-table - application with toolbar and main content area as a
9938 * @section secExamples Examples
9940 * Some examples of the Layout widget can be found here:
9941 * @li @ref layout_example_01
9942 * @li @ref layout_example_02
9943 * @li @ref layout_example_03
9944 * @li @ref layout_example_edc
9949 * Add a new layout to the parent
9951 * @param parent The parent object
9952 * @return The new object or NULL if it cannot be created
9954 * @see elm_layout_file_set()
9955 * @see elm_layout_theme_set()
9959 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9961 * Set the file that will be used as layout
9963 * @param obj The layout object
9964 * @param file The path to file (edj) that will be used as layout
9965 * @param group The group that the layout belongs in edje file
9967 * @return (1 = success, 0 = error)
9971 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9973 * Set the edje group from the elementary theme that will be used as layout
9975 * @param obj The layout object
9976 * @param clas the clas of the group
9977 * @param group the group
9978 * @param style the style to used
9980 * @return (1 = success, 0 = error)
9984 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9986 * Set the layout content.
9988 * @param obj The layout object
9989 * @param swallow The swallow part name in the edje file
9990 * @param content The child that will be added in this layout object
9992 * Once the content object is set, a previously set one will be deleted.
9993 * If you want to keep that old content object, use the
9994 * elm_object_part_content_unset() function.
9996 * @note In an Edje theme, the part used as a content container is called @c
9997 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9998 * expected to be a part name just like the second parameter of
9999 * elm_layout_box_append().
10001 * @see elm_layout_box_append()
10002 * @see elm_object_part_content_get()
10003 * @see elm_object_part_content_unset()
10005 * @deprecated use elm_object_part_content_set() instead
10009 WILL_DEPRECATE EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10011 * Get the child object in the given content part.
10013 * @param obj The layout object
10014 * @param swallow The SWALLOW part to get its content
10016 * @return The swallowed object or NULL if none or an error occurred
10018 * @deprecated use elm_object_part_content_get() instead
10022 WILL_DEPRECATE EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10024 * Unset the layout content.
10026 * @param obj The layout object
10027 * @param swallow The swallow part name in the edje file
10028 * @return The content that was being used
10030 * Unparent and return the content object which was set for this part.
10032 * @deprecated use elm_object_part_content_unset() instead
10036 WILL_DEPRECATE EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10038 * Set the text of the given part
10040 * @param obj The layout object
10041 * @param part The TEXT part where to set the text
10042 * @param text The text to set
10045 * @deprecated use elm_object_part_text_set() instead.
10047 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10049 * Get the text set in the given part
10051 * @param obj The layout object
10052 * @param part The TEXT part to retrieve the text off
10054 * @return The text set in @p part
10057 * @deprecated use elm_object_part_text_get() instead.
10059 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10061 * Append child to layout box part.
10063 * @param obj the layout object
10064 * @param part the box part to which the object will be appended.
10065 * @param child the child object to append to box.
10067 * Once the object is appended, it will become child of the layout. Its
10068 * lifetime will be bound to the layout, whenever the layout dies the child
10069 * will be deleted automatically. One should use elm_layout_box_remove() to
10070 * make this layout forget about the object.
10072 * @see elm_layout_box_prepend()
10073 * @see elm_layout_box_insert_before()
10074 * @see elm_layout_box_insert_at()
10075 * @see elm_layout_box_remove()
10079 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10081 * Prepend child to layout box part.
10083 * @param obj the layout object
10084 * @param part the box part to prepend.
10085 * @param child the child object to prepend to box.
10087 * Once the object is prepended, it will become child of the layout. Its
10088 * lifetime will be bound to the layout, whenever the layout dies the child
10089 * will be deleted automatically. One should use elm_layout_box_remove() to
10090 * make this layout forget about the object.
10092 * @see elm_layout_box_append()
10093 * @see elm_layout_box_insert_before()
10094 * @see elm_layout_box_insert_at()
10095 * @see elm_layout_box_remove()
10099 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10101 * Insert child to layout box part before a reference object.
10103 * @param obj the layout object
10104 * @param part the box part to insert.
10105 * @param child the child object to insert into box.
10106 * @param reference another reference object to insert before in box.
10108 * Once the object is inserted, it will become child of the layout. Its
10109 * lifetime will be bound to the layout, whenever the layout dies the child
10110 * will be deleted automatically. One should use elm_layout_box_remove() to
10111 * make this layout forget about the object.
10113 * @see elm_layout_box_append()
10114 * @see elm_layout_box_prepend()
10115 * @see elm_layout_box_insert_before()
10116 * @see elm_layout_box_remove()
10120 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10122 * Insert child to layout box part at a given position.
10124 * @param obj the layout object
10125 * @param part the box part to insert.
10126 * @param child the child object to insert into box.
10127 * @param pos the numeric position >=0 to insert the child.
10129 * Once the object is inserted, it will become child of the layout. Its
10130 * lifetime will be bound to the layout, whenever the layout dies the child
10131 * will be deleted automatically. One should use elm_layout_box_remove() to
10132 * make this layout forget about the object.
10134 * @see elm_layout_box_append()
10135 * @see elm_layout_box_prepend()
10136 * @see elm_layout_box_insert_before()
10137 * @see elm_layout_box_remove()
10141 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10143 * Remove a child of the given part box.
10145 * @param obj The layout object
10146 * @param part The box part name to remove child.
10147 * @param child The object to remove from box.
10148 * @return The object that was being used, or NULL if not found.
10150 * The object will be removed from the box part and its lifetime will
10151 * not be handled by the layout anymore. This is equivalent to
10152 * elm_object_part_content_unset() for box.
10154 * @see elm_layout_box_append()
10155 * @see elm_layout_box_remove_all()
10159 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10161 * Remove all child of the given part box.
10163 * @param obj The layout object
10164 * @param part The box part name to remove child.
10165 * @param clear If EINA_TRUE, then all objects will be deleted as
10166 * well, otherwise they will just be removed and will be
10167 * dangling on the canvas.
10169 * The objects will be removed from the box part and their lifetime will
10170 * not be handled by the layout anymore. This is equivalent to
10171 * elm_layout_box_remove() for all box children.
10173 * @see elm_layout_box_append()
10174 * @see elm_layout_box_remove()
10178 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10180 * Insert child to layout table part.
10182 * @param obj the layout object
10183 * @param part the box part to pack child.
10184 * @param child_obj the child object to pack into table.
10185 * @param col the column to which the child should be added. (>= 0)
10186 * @param row the row to which the child should be added. (>= 0)
10187 * @param colspan how many columns should be used to store this object. (>=
10189 * @param rowspan how many rows should be used to store this object. (>= 1)
10191 * Once the object is inserted, it will become child of the table. Its
10192 * lifetime will be bound to the layout, and whenever the layout dies the
10193 * child will be deleted automatically. One should use
10194 * elm_layout_table_remove() to make this layout forget about the object.
10196 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10197 * more space than a single cell. For instance, the following code:
10199 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10202 * Would result in an object being added like the following picture:
10204 * @image html layout_colspan.png
10205 * @image latex layout_colspan.eps width=\textwidth
10207 * @see elm_layout_table_unpack()
10208 * @see elm_layout_table_clear()
10212 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);
10214 * Unpack (remove) a child of the given part table.
10216 * @param obj The layout object
10217 * @param part The table part name to remove child.
10218 * @param child_obj The object to remove from table.
10219 * @return The object that was being used, or NULL if not found.
10221 * The object will be unpacked from the table part and its lifetime
10222 * will not be handled by the layout anymore. This is equivalent to
10223 * elm_object_part_content_unset() for table.
10225 * @see elm_layout_table_pack()
10226 * @see elm_layout_table_clear()
10230 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10232 * Remove all child of the given part table.
10234 * @param obj The layout object
10235 * @param part The table part name to remove child.
10236 * @param clear If EINA_TRUE, then all objects will be deleted as
10237 * well, otherwise they will just be removed and will be
10238 * dangling on the canvas.
10240 * The objects will be removed from the table part and their lifetime will
10241 * not be handled by the layout anymore. This is equivalent to
10242 * elm_layout_table_unpack() for all table children.
10244 * @see elm_layout_table_pack()
10245 * @see elm_layout_table_unpack()
10249 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10251 * Get the edje layout
10253 * @param obj The layout object
10255 * @return A Evas_Object with the edje layout settings loaded
10256 * with function elm_layout_file_set
10258 * This returns the edje object. It is not expected to be used to then
10259 * swallow objects via edje_object_part_swallow() for example. Use
10260 * elm_object_part_content_set() instead so child object handling and sizing is
10263 * @note This function should only be used if you really need to call some
10264 * low level Edje function on this edje object. All the common stuff (setting
10265 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10266 * with proper elementary functions.
10268 * @see elm_object_signal_callback_add()
10269 * @see elm_object_signal_emit()
10270 * @see elm_object_part_text_set()
10271 * @see elm_object_part_content_set()
10272 * @see elm_layout_box_append()
10273 * @see elm_layout_table_pack()
10274 * @see elm_layout_data_get()
10278 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10280 * Get the edje data from the given layout
10282 * @param obj The layout object
10283 * @param key The data key
10285 * @return The edje data string
10287 * This function fetches data specified inside the edje theme of this layout.
10288 * This function return NULL if data is not found.
10290 * In EDC this comes from a data block within the group block that @p
10291 * obj was loaded from. E.g.
10298 * item: "key1" "value1";
10299 * item: "key2" "value2";
10307 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10311 * @param obj The layout object
10313 * Manually forces a sizing re-evaluation. This is useful when the minimum
10314 * size required by the edje theme of this layout has changed. The change on
10315 * the minimum size required by the edje theme is not immediately reported to
10316 * the elementary layout, so one needs to call this function in order to tell
10317 * the widget (layout) that it needs to reevaluate its own size.
10319 * The minimum size of the theme is calculated based on minimum size of
10320 * parts, the size of elements inside containers like box and table, etc. All
10321 * of this can change due to state changes, and that's when this function
10322 * should be called.
10324 * Also note that a standard signal of "size,eval" "elm" emitted from the
10325 * edje object will cause this to happen too.
10329 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10332 * Sets a specific cursor for an edje part.
10334 * @param obj The layout object.
10335 * @param part_name a part from loaded edje group.
10336 * @param cursor cursor name to use, see Elementary_Cursor.h
10338 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10339 * part not exists or it has "mouse_events: 0".
10343 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10346 * Get the cursor to be shown when mouse is over an edje part
10348 * @param obj The layout object.
10349 * @param part_name a part from loaded edje group.
10350 * @return the cursor name.
10354 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10357 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10359 * @param obj The layout object.
10360 * @param part_name a part from loaded edje group, that had a cursor set
10361 * with elm_layout_part_cursor_set().
10365 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10368 * Sets a specific cursor style for an edje part.
10370 * @param obj The layout object.
10371 * @param part_name a part from loaded edje group.
10372 * @param style the theme style to use (default, transparent, ...)
10374 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10375 * part not exists or it did not had a cursor set.
10379 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10382 * Gets a specific cursor style for an edje part.
10384 * @param obj The layout object.
10385 * @param part_name a part from loaded edje group.
10387 * @return the theme style in use, defaults to "default". If the
10388 * object does not have a cursor set, then NULL is returned.
10392 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10395 * Sets if the cursor set should be searched on the theme or should use
10396 * the provided by the engine, only.
10398 * @note before you set if should look on theme you should define a
10399 * cursor with elm_layout_part_cursor_set(). By default it will only
10400 * look for cursors provided by the engine.
10402 * @param obj The layout object.
10403 * @param part_name a part from loaded edje group.
10404 * @param engine_only if cursors should be just provided by the engine
10405 * or should also search on widget's theme as well
10407 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10408 * part not exists or it did not had a cursor set.
10412 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);
10415 * Gets a specific cursor engine_only for an edje part.
10417 * @param obj The layout object.
10418 * @param part_name a part from loaded edje group.
10420 * @return whenever the cursor is just provided by engine or also from theme.
10424 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10427 * @def elm_layout_icon_set
10428 * Convienience macro to set the icon object in a layout that follows the
10429 * Elementary naming convention for its parts.
10433 #define elm_layout_icon_set(_ly, _obj) \
10436 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10437 if ((_obj)) sig = "elm,state,icon,visible"; \
10438 else sig = "elm,state,icon,hidden"; \
10439 elm_object_signal_emit((_ly), sig, "elm"); \
10443 * @def elm_layout_icon_get
10444 * Convienience macro to get the icon object from a layout that follows the
10445 * Elementary naming convention for its parts.
10449 #define elm_layout_icon_get(_ly) \
10450 elm_object_part_content_get((_ly), "elm.swallow.icon")
10453 * @def elm_layout_end_set
10454 * Convienience macro to set the end object in a layout that follows the
10455 * Elementary naming convention for its parts.
10459 #define elm_layout_end_set(_ly, _obj) \
10462 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10463 if ((_obj)) sig = "elm,state,end,visible"; \
10464 else sig = "elm,state,end,hidden"; \
10465 elm_object_signal_emit((_ly), sig, "elm"); \
10469 * @def elm_layout_end_get
10470 * Convienience macro to get the end object in a layout that follows the
10471 * Elementary naming convention for its parts.
10475 #define elm_layout_end_get(_ly) \
10476 elm_object_part_content_get((_ly), "elm.swallow.end")
10479 * @def elm_layout_label_set
10480 * Convienience macro to set the label in a layout that follows the
10481 * Elementary naming convention for its parts.
10484 * @deprecated use elm_object_text_set() instead.
10486 #define elm_layout_label_set(_ly, _txt) \
10487 elm_layout_text_set((_ly), "elm.text", (_txt))
10490 * @def elm_layout_label_get
10491 * Convenience macro to get the label in a layout that follows the
10492 * Elementary naming convention for its parts.
10495 * @deprecated use elm_object_text_set() instead.
10497 #define elm_layout_label_get(_ly) \
10498 elm_layout_text_get((_ly), "elm.text")
10500 /* smart callbacks called:
10501 * "theme,changed" - when elm theme is changed.
10505 * @defgroup Notify Notify
10507 * @image html img/widget/notify/preview-00.png
10508 * @image latex img/widget/notify/preview-00.eps
10510 * Display a container in a particular region of the parent(top, bottom,
10511 * etc). A timeout can be set to automatically hide the notify. This is so
10512 * that, after an evas_object_show() on a notify object, if a timeout was set
10513 * on it, it will @b automatically get hidden after that time.
10515 * Signals that you can add callbacks for are:
10516 * @li "timeout" - when timeout happens on notify and it's hidden
10517 * @li "block,clicked" - when a click outside of the notify happens
10519 * Default contents parts of the notify widget that you can use for are:
10520 * @li "default" - A content of the notify
10522 * @ref tutorial_notify show usage of the API.
10527 * @brief Possible orient values for notify.
10529 * This values should be used in conjunction to elm_notify_orient_set() to
10530 * set the position in which the notify should appear(relative to its parent)
10531 * and in conjunction with elm_notify_orient_get() to know where the notify
10534 typedef enum _Elm_Notify_Orient
10536 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10537 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10538 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10539 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10540 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10541 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10542 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10543 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10544 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10545 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10546 } Elm_Notify_Orient;
10548 * @brief Add a new notify to the parent
10550 * @param parent The parent object
10551 * @return The new object or NULL if it cannot be created
10553 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10555 * @brief Set the content of the notify widget
10557 * @param obj The notify object
10558 * @param content The content will be filled in this notify object
10560 * Once the content object is set, a previously set one will be deleted. If
10561 * you want to keep that old content object, use the
10562 * elm_notify_content_unset() function.
10564 * @deprecated use elm_object_content_set() instead
10567 WILL_DEPRECATE EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10569 * @brief Unset the content of the notify widget
10571 * @param obj The notify object
10572 * @return The content that was being used
10574 * Unparent and return the content object which was set for this widget
10576 * @see elm_notify_content_set()
10577 * @deprecated use elm_object_content_unset() instead
10580 WILL_DEPRECATE EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10582 * @brief Return the content of the notify widget
10584 * @param obj The notify object
10585 * @return The content that is being used
10587 * @see elm_notify_content_set()
10588 * @deprecated use elm_object_content_get() instead
10591 WILL_DEPRECATE EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10593 * @brief Set the notify parent
10595 * @param obj The notify object
10596 * @param content The new parent
10598 * Once the parent object is set, a previously set one will be disconnected
10601 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10603 * @brief Get the notify parent
10605 * @param obj The notify object
10606 * @return The parent
10608 * @see elm_notify_parent_set()
10610 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10612 * @brief Set the orientation
10614 * @param obj The notify object
10615 * @param orient The new orientation
10617 * Sets the position in which the notify will appear in its parent.
10619 * @see @ref Elm_Notify_Orient for possible values.
10621 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10623 * @brief Return the orientation
10624 * @param obj The notify object
10625 * @return The orientation of the notification
10627 * @see elm_notify_orient_set()
10628 * @see Elm_Notify_Orient
10630 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10632 * @brief Set the time interval after which the notify window is going to be
10635 * @param obj The notify object
10636 * @param time The timeout in seconds
10638 * This function sets a timeout and starts the timer controlling when the
10639 * notify is hidden. Since calling evas_object_show() on a notify restarts
10640 * the timer controlling when the notify is hidden, setting this before the
10641 * notify is shown will in effect mean starting the timer when the notify is
10644 * @note Set a value <= 0.0 to disable a running timer.
10646 * @note If the value > 0.0 and the notify is previously visible, the
10647 * timer will be started with this value, canceling any running timer.
10649 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10651 * @brief Return the timeout value (in seconds)
10652 * @param obj the notify object
10654 * @see elm_notify_timeout_set()
10656 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10658 * @brief Sets whether events should be passed to by a click outside
10661 * @param obj The notify object
10662 * @param repeats EINA_TRUE Events are repeats, else no
10664 * When true if the user clicks outside the window the events will be caught
10665 * by the others widgets, else the events are blocked.
10667 * @note The default value is EINA_TRUE.
10669 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10671 * @brief Return true if events are repeat below the notify object
10672 * @param obj the notify object
10674 * @see elm_notify_repeat_events_set()
10676 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10682 * @defgroup Hover Hover
10684 * @image html img/widget/hover/preview-00.png
10685 * @image latex img/widget/hover/preview-00.eps
10687 * A Hover object will hover over its @p parent object at the @p target
10688 * location. Anything in the background will be given a darker coloring to
10689 * indicate that the hover object is on top (at the default theme). When the
10690 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10691 * clicked that @b doesn't cause the hover to be dismissed.
10693 * A Hover object has two parents. One parent that owns it during creation
10694 * and the other parent being the one over which the hover object spans.
10697 * @note The hover object will take up the entire space of @p target
10700 * Elementary has the following styles for the hover widget:
10704 * @li hoversel_vertical
10706 * The following are the available position for content:
10718 * Signals that you can add callbacks for are:
10719 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10720 * @li "smart,changed" - a content object placed under the "smart"
10721 * policy was replaced to a new slot direction.
10723 * See @ref tutorial_hover for more information.
10727 typedef enum _Elm_Hover_Axis
10729 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10730 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10731 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10732 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10735 * @brief Adds a hover object to @p parent
10737 * @param parent The parent object
10738 * @return The hover object or NULL if one could not be created
10740 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10742 * @brief Sets the target object for the hover.
10744 * @param obj The hover object
10745 * @param target The object to center the hover onto. The hover
10747 * This function will cause the hover to be centered on the target object.
10749 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10751 * @brief Gets the target object for the hover.
10753 * @param obj The hover object
10754 * @param parent The object to locate the hover over.
10756 * @see elm_hover_target_set()
10758 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10760 * @brief Sets the parent object for the hover.
10762 * @param obj The hover object
10763 * @param parent The object to locate the hover over.
10765 * This function will cause the hover to take up the entire space that the
10766 * parent object fills.
10768 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10770 * @brief Gets the parent object for the hover.
10772 * @param obj The hover object
10773 * @return The parent object to locate the hover over.
10775 * @see elm_hover_parent_set()
10777 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10779 * @brief Sets the content of the hover object and the direction in which it
10782 * @param obj The hover object
10783 * @param swallow The direction that the object will be displayed
10784 * at. Accepted values are "left", "top-left", "top", "top-right",
10785 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10787 * @param content The content to place at @p swallow
10789 * Once the content object is set for a given direction, a previously
10790 * set one (on the same direction) will be deleted. If you want to
10791 * keep that old content object, use the elm_hover_content_unset()
10794 * All directions may have contents at the same time, except for
10795 * "smart". This is a special placement hint and its use case
10796 * independs of the calculations coming from
10797 * elm_hover_best_content_location_get(). Its use is for cases when
10798 * one desires only one hover content, but with a dinamic special
10799 * placement within the hover area. The content's geometry, whenever
10800 * it changes, will be used to decide on a best location not
10801 * extrapolating the hover's parent object view to show it in (still
10802 * being the hover's target determinant of its medium part -- move and
10803 * resize it to simulate finger sizes, for example). If one of the
10804 * directions other than "smart" are used, a previously content set
10805 * using it will be deleted, and vice-versa.
10807 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10809 * @brief Get the content of the hover object, in a given direction.
10811 * Return the content object which was set for this widget in the
10812 * @p swallow direction.
10814 * @param obj The hover object
10815 * @param swallow The direction that the object was display at.
10816 * @return The content that was being used
10818 * @see elm_hover_content_set()
10820 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10822 * @brief Unset the content of the hover object, in a given direction.
10824 * Unparent and return the content object set at @p swallow direction.
10826 * @param obj The hover object
10827 * @param swallow The direction that the object was display at.
10828 * @return The content that was being used.
10830 * @see elm_hover_content_set()
10832 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10834 * @brief Returns the best swallow location for content in the hover.
10836 * @param obj The hover object
10837 * @param pref_axis The preferred orientation axis for the hover object to use
10838 * @return The edje location to place content into the hover or @c
10841 * Best is defined here as the location at which there is the most available
10844 * @p pref_axis may be one of
10845 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10846 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10847 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10848 * - @c ELM_HOVER_AXIS_BOTH -- both
10850 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10851 * nescessarily be along the horizontal axis("left" or "right"). If
10852 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10853 * be along the vertical axis("top" or "bottom"). Chossing
10854 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10855 * returned position may be in either axis.
10857 * @see elm_hover_content_set()
10859 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10866 * @defgroup Entry Entry
10868 * @image html img/widget/entry/preview-00.png
10869 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10870 * @image html img/widget/entry/preview-01.png
10871 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10872 * @image html img/widget/entry/preview-02.png
10873 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10874 * @image html img/widget/entry/preview-03.png
10875 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10877 * An entry is a convenience widget which shows a box that the user can
10878 * enter text into. Entries by default don't scroll, so they grow to
10879 * accomodate the entire text, resizing the parent window as needed. This
10880 * can be changed with the elm_entry_scrollable_set() function.
10882 * They can also be single line or multi line (the default) and when set
10883 * to multi line mode they support text wrapping in any of the modes
10884 * indicated by #Elm_Wrap_Type.
10886 * Other features include password mode, filtering of inserted text with
10887 * elm_entry_text_filter_append() and related functions, inline "items" and
10888 * formatted markup text.
10890 * @section entry-markup Formatted text
10892 * The markup tags supported by the Entry are defined by the theme, but
10893 * even when writing new themes or extensions it's a good idea to stick to
10894 * a sane default, to maintain coherency and avoid application breakages.
10895 * Currently defined by the default theme are the following tags:
10896 * @li \<br\>: Inserts a line break.
10897 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10899 * @li \<tab\>: Inserts a tab.
10900 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10902 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10903 * @li \<link\>...\</link\>: Underlines the enclosed text.
10904 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10906 * @section entry-special Special markups
10908 * Besides those used to format text, entries support two special markup
10909 * tags used to insert clickable portions of text or items inlined within
10912 * @subsection entry-anchors Anchors
10914 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10915 * \</a\> tags and an event will be generated when this text is clicked,
10919 * This text is outside <a href=anc-01>but this one is an anchor</a>
10922 * The @c href attribute in the opening tag gives the name that will be
10923 * used to identify the anchor and it can be any valid utf8 string.
10925 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10926 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10927 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10928 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10931 * @subsection entry-items Items
10933 * Inlined in the text, any other @c Evas_Object can be inserted by using
10934 * \<item\> tags this way:
10937 * <item size=16x16 vsize=full href=emoticon/haha></item>
10940 * Just like with anchors, the @c href identifies each item, but these need,
10941 * in addition, to indicate their size, which is done using any one of
10942 * @c size, @c absize or @c relsize attributes. These attributes take their
10943 * value in the WxH format, where W is the width and H the height of the
10946 * @li absize: Absolute pixel size for the item. Whatever value is set will
10947 * be the item's size regardless of any scale value the object may have
10948 * been set to. The final line height will be adjusted to fit larger items.
10949 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10951 * @li relsize: Size is adjusted for the item to fit within the current
10954 * Besides their size, items are specificed a @c vsize value that affects
10955 * how their final size and position are calculated. The possible values
10957 * @li ascent: Item will be placed within the line's baseline and its
10958 * ascent. That is, the height between the line where all characters are
10959 * positioned and the highest point in the line. For @c size and @c absize
10960 * items, the descent value will be added to the total line height to make
10961 * them fit. @c relsize items will be adjusted to fit within this space.
10962 * @li full: Items will be placed between the descent and ascent, or the
10963 * lowest point in the line and its highest.
10965 * The next image shows different configurations of items and how they
10966 * are the previously mentioned options affect their sizes. In all cases,
10967 * the green line indicates the ascent, blue for the baseline and red for
10970 * @image html entry_item.png
10971 * @image latex entry_item.eps width=\textwidth
10973 * And another one to show how size differs from absize. In the first one,
10974 * the scale value is set to 1.0, while the second one is using one of 2.0.
10976 * @image html entry_item_scale.png
10977 * @image latex entry_item_scale.eps width=\textwidth
10979 * After the size for an item is calculated, the entry will request an
10980 * object to place in its space. For this, the functions set with
10981 * elm_entry_item_provider_append() and related functions will be called
10982 * in order until one of them returns a @c non-NULL value. If no providers
10983 * are available, or all of them return @c NULL, then the entry falls back
10984 * to one of the internal defaults, provided the name matches with one of
10987 * All of the following are currently supported:
10990 * - emoticon/angry-shout
10991 * - emoticon/crazy-laugh
10992 * - emoticon/evil-laugh
10994 * - emoticon/goggle-smile
10995 * - emoticon/grumpy
10996 * - emoticon/grumpy-smile
10997 * - emoticon/guilty
10998 * - emoticon/guilty-smile
11000 * - emoticon/half-smile
11001 * - emoticon/happy-panting
11003 * - emoticon/indifferent
11005 * - emoticon/knowing-grin
11007 * - emoticon/little-bit-sorry
11008 * - emoticon/love-lots
11010 * - emoticon/minimal-smile
11011 * - emoticon/not-happy
11012 * - emoticon/not-impressed
11014 * - emoticon/opensmile
11017 * - emoticon/squint-laugh
11018 * - emoticon/surprised
11019 * - emoticon/suspicious
11020 * - emoticon/tongue-dangling
11021 * - emoticon/tongue-poke
11023 * - emoticon/unhappy
11024 * - emoticon/very-sorry
11027 * - emoticon/worried
11030 * Alternatively, an item may reference an image by its path, using
11031 * the URI form @c file:///path/to/an/image.png and the entry will then
11032 * use that image for the item.
11034 * @section entry-files Loading and saving files
11036 * Entries have convinience functions to load text from a file and save
11037 * changes back to it after a short delay. The automatic saving is enabled
11038 * by default, but can be disabled with elm_entry_autosave_set() and files
11039 * can be loaded directly as plain text or have any markup in them
11040 * recognized. See elm_entry_file_set() for more details.
11042 * @section entry-signals Emitted signals
11044 * This widget emits the following signals:
11046 * @li "changed": The text within the entry was changed.
11047 * @li "changed,user": The text within the entry was changed because of user interaction.
11048 * @li "activated": The enter key was pressed on a single line entry.
11049 * @li "press": A mouse button has been pressed on the entry.
11050 * @li "longpressed": A mouse button has been pressed and held for a couple
11052 * @li "clicked": The entry has been clicked (mouse press and release).
11053 * @li "clicked,double": The entry has been double clicked.
11054 * @li "clicked,triple": The entry has been triple clicked.
11055 * @li "focused": The entry has received focus.
11056 * @li "unfocused": The entry has lost focus.
11057 * @li "selection,paste": A paste of the clipboard contents was requested.
11058 * @li "selection,copy": A copy of the selected text into the clipboard was
11060 * @li "selection,cut": A cut of the selected text into the clipboard was
11062 * @li "selection,start": A selection has begun and no previous selection
11064 * @li "selection,changed": The current selection has changed.
11065 * @li "selection,cleared": The current selection has been cleared.
11066 * @li "cursor,changed": The cursor has changed position.
11067 * @li "anchor,clicked": An anchor has been clicked. The event_info
11068 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11069 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11070 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11071 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11072 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11073 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11074 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11075 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11076 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11077 * @li "preedit,changed": The preedit string has changed.
11078 * @li "language,changed": Program language changed.
11080 * @section entry-examples
11082 * An overview of the Entry API can be seen in @ref entry_example_01
11087 * @typedef Elm_Entry_Anchor_Info
11089 * The info sent in the callback for the "anchor,clicked" signals emitted
11092 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11094 * @struct _Elm_Entry_Anchor_Info
11096 * The info sent in the callback for the "anchor,clicked" signals emitted
11099 struct _Elm_Entry_Anchor_Info
11101 const char *name; /**< The name of the anchor, as stated in its href */
11102 int button; /**< The mouse button used to click on it */
11103 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11104 y, /**< Anchor geometry, relative to canvas */
11105 w, /**< Anchor geometry, relative to canvas */
11106 h; /**< Anchor geometry, relative to canvas */
11109 * @typedef Elm_Entry_Filter_Cb
11110 * This callback type is used by entry filters to modify text.
11111 * @param data The data specified as the last param when adding the filter
11112 * @param entry The entry object
11113 * @param text A pointer to the location of the text being filtered. This data can be modified,
11114 * but any additional allocations must be managed by the user.
11115 * @see elm_entry_text_filter_append
11116 * @see elm_entry_text_filter_prepend
11118 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11121 * This adds an entry to @p parent object.
11123 * By default, entries are:
11127 * @li autosave is enabled
11129 * @param parent The parent object
11130 * @return The new object or NULL if it cannot be created
11132 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11134 * Sets the entry to single line mode.
11136 * In single line mode, entries don't ever wrap when the text reaches the
11137 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11138 * key will generate an @c "activate" event instead of adding a new line.
11140 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11141 * and pressing enter will break the text into a different line
11142 * without generating any events.
11144 * @param obj The entry object
11145 * @param single_line If true, the text in the entry
11146 * will be on a single line.
11148 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11150 * Gets whether the entry is set to be single line.
11152 * @param obj The entry object
11153 * @return single_line If true, the text in the entry is set to display
11154 * on a single line.
11156 * @see elm_entry_single_line_set()
11158 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11160 * Sets the entry to password mode.
11162 * In password mode, entries are implicitly single line and the display of
11163 * any text in them is replaced with asterisks (*).
11165 * @param obj The entry object
11166 * @param password If true, password mode is enabled.
11168 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11170 * Gets whether the entry is set to password mode.
11172 * @param obj The entry object
11173 * @return If true, the entry is set to display all characters
11174 * as asterisks (*).
11176 * @see elm_entry_password_set()
11178 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11180 * This sets the text displayed within the entry to @p entry.
11182 * @param obj The entry object
11183 * @param entry The text to be displayed
11185 * @deprecated Use elm_object_text_set() instead.
11186 * @note Using this function bypasses text filters
11188 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11190 * This returns the text currently shown in object @p entry.
11191 * See also elm_entry_entry_set().
11193 * @param obj The entry object
11194 * @return The currently displayed text or NULL on failure
11196 * @deprecated Use elm_object_text_get() instead.
11198 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11200 * Appends @p entry to the text of the entry.
11202 * Adds the text in @p entry to the end of any text already present in the
11205 * The appended text is subject to any filters set for the widget.
11207 * @param obj The entry object
11208 * @param entry The text to be displayed
11210 * @see elm_entry_text_filter_append()
11212 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11214 * Gets whether the entry is empty.
11216 * Empty means no text at all. If there are any markup tags, like an item
11217 * tag for which no provider finds anything, and no text is displayed, this
11218 * function still returns EINA_FALSE.
11220 * @param obj The entry object
11221 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11223 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11225 * Gets any selected text within the entry.
11227 * If there's any selected text in the entry, this function returns it as
11228 * a string in markup format. NULL is returned if no selection exists or
11229 * if an error occurred.
11231 * The returned value points to an internal string and should not be freed
11232 * or modified in any way. If the @p entry object is deleted or its
11233 * contents are changed, the returned pointer should be considered invalid.
11235 * @param obj The entry object
11236 * @return The selected text within the entry or NULL on failure
11238 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11240 * Returns the actual textblock object of the entry.
11242 * This function exposes the internal textblock object that actually
11243 * contains and draws the text. This should be used for low-level
11244 * manipulations that are otherwise not possible.
11246 * Changing the textblock directly from here will not notify edje/elm to
11247 * recalculate the textblock size automatically, so any modifications
11248 * done to the textblock returned by this function should be followed by
11249 * a call to elm_entry_calc_force().
11251 * The return value is marked as const as an additional warning.
11252 * One should not use the returned object with any of the generic evas
11253 * functions (geometry_get/resize/move and etc), but only with the textblock
11254 * functions; The former will either not work at all, or break the correct
11257 * @param obj The entry object
11258 * @return The textblock object.
11260 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11262 * Forces calculation of the entry size and text layouting.
11264 * This should be used after modifying the textblock object directly. See
11265 * elm_entry_textblock_get() for more information.
11267 * @param obj The entry object
11269 * @see elm_entry_textblock_get()
11271 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11273 * Inserts the given text into the entry at the current cursor position.
11275 * This inserts text at the cursor position as if it was typed
11276 * by the user (note that this also allows markup which a user
11277 * can't just "type" as it would be converted to escaped text, so this
11278 * call can be used to insert things like emoticon items or bold push/pop
11279 * tags, other font and color change tags etc.)
11281 * If any selection exists, it will be replaced by the inserted text.
11283 * The inserted text is subject to any filters set for the widget.
11285 * @param obj The entry object
11286 * @param entry The text to insert
11288 * @see elm_entry_text_filter_append()
11290 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11292 * Set the line wrap type to use on multi-line entries.
11294 * Sets the wrap type used by the entry to any of the specified in
11295 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11296 * line (without inserting a line break or paragraph separator) when it
11297 * reaches the far edge of the widget.
11299 * Note that this only makes sense for multi-line entries. A widget set
11300 * to be single line will never wrap.
11302 * @param obj The entry object
11303 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11305 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11306 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11308 * Gets the wrap mode the entry was set to use.
11310 * @param obj The entry object
11311 * @return Wrap type
11313 * @see also elm_entry_line_wrap_set()
11315 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11317 * Sets if the entry is to be editable or not.
11319 * By default, entries are editable and when focused, any text input by the
11320 * user will be inserted at the current cursor position. But calling this
11321 * function with @p editable as EINA_FALSE will prevent the user from
11322 * inputting text into the entry.
11324 * The only way to change the text of a non-editable entry is to use
11325 * elm_object_text_set(), elm_entry_entry_insert() and other related
11328 * @param obj The entry object
11329 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11330 * if not, the entry is read-only and no user input is allowed.
11332 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11334 * Gets whether the entry is editable or not.
11336 * @param obj The entry object
11337 * @return If true, the entry is editable by the user.
11338 * If false, it is not editable by the user
11340 * @see elm_entry_editable_set()
11342 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11344 * This drops any existing text selection within the entry.
11346 * @param obj The entry object
11348 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11350 * This selects all text within the entry.
11352 * @param obj The entry object
11354 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11356 * This moves the cursor one place to the right within the entry.
11358 * @param obj The entry object
11359 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11361 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11363 * This moves the cursor one place to the left within the entry.
11365 * @param obj The entry object
11366 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11368 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11370 * This moves the cursor one line up within the entry.
11372 * @param obj The entry object
11373 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11375 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11377 * This moves the cursor one line down within the entry.
11379 * @param obj The entry object
11380 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11382 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11384 * This moves the cursor to the beginning of the entry.
11386 * @param obj The entry object
11388 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11390 * This moves the cursor to the end of the entry.
11392 * @param obj The entry object
11394 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11396 * This moves the cursor to the beginning of the current line.
11398 * @param obj The entry object
11400 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11402 * This moves the cursor to the end of the current line.
11404 * @param obj The entry object
11406 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11408 * This begins a selection within the entry as though
11409 * the user were holding down the mouse button to make a selection.
11411 * @param obj The entry object
11413 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11415 * This ends a selection within the entry as though
11416 * the user had just released the mouse button while making a selection.
11418 * @param obj The entry object
11420 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11422 * Gets whether a format node exists at the current cursor position.
11424 * A format node is anything that defines how the text is rendered. It can
11425 * be a visible format node, such as a line break or a paragraph separator,
11426 * or an invisible one, such as bold begin or end tag.
11427 * This function returns whether any format node exists at the current
11430 * @param obj The entry object
11431 * @return EINA_TRUE if the current cursor position contains a format node,
11432 * EINA_FALSE otherwise.
11434 * @see elm_entry_cursor_is_visible_format_get()
11436 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11438 * Gets if the current cursor position holds a visible format node.
11440 * @param obj The entry object
11441 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11442 * if it's an invisible one or no format exists.
11444 * @see elm_entry_cursor_is_format_get()
11446 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11448 * Gets the character pointed by the cursor at its current position.
11450 * This function returns a string with the utf8 character stored at the
11451 * current cursor position.
11452 * Only the text is returned, any format that may exist will not be part
11453 * of the return value.
11455 * @param obj The entry object
11456 * @return The text pointed by the cursors.
11458 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11460 * This function returns the geometry of the cursor.
11462 * It's useful if you want to draw something on the cursor (or where it is),
11463 * or for example in the case of scrolled entry where you want to show the
11466 * @param obj The entry object
11467 * @param x returned geometry
11468 * @param y returned geometry
11469 * @param w returned geometry
11470 * @param h returned geometry
11471 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11473 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);
11475 * Sets the cursor position in the entry to the given value
11477 * The value in @p pos is the index of the character position within the
11478 * contents of the string as returned by elm_entry_cursor_pos_get().
11480 * @param obj The entry object
11481 * @param pos The position of the cursor
11483 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11485 * Retrieves the current position of the cursor in the entry
11487 * @param obj The entry object
11488 * @return The cursor position
11490 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11492 * This executes a "cut" action on the selected text in the entry.
11494 * @param obj The entry object
11496 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11498 * This executes a "copy" action on the selected text in the entry.
11500 * @param obj The entry object
11502 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11504 * This executes a "paste" action in the entry.
11506 * @param obj The entry object
11508 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11510 * This clears and frees the items in a entry's contextual (longpress)
11513 * @param obj The entry object
11515 * @see elm_entry_context_menu_item_add()
11517 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11519 * This adds an item to the entry's contextual menu.
11521 * A longpress on an entry will make the contextual menu show up, if this
11522 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11523 * By default, this menu provides a few options like enabling selection mode,
11524 * which is useful on embedded devices that need to be explicit about it,
11525 * and when a selection exists it also shows the copy and cut actions.
11527 * With this function, developers can add other options to this menu to
11528 * perform any action they deem necessary.
11530 * @param obj The entry object
11531 * @param label The item's text label
11532 * @param icon_file The item's icon file
11533 * @param icon_type The item's icon type
11534 * @param func The callback to execute when the item is clicked
11535 * @param data The data to associate with the item for related functions
11537 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);
11539 * This disables the entry's contextual (longpress) menu.
11541 * @param obj The entry object
11542 * @param disabled If true, the menu is disabled
11544 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11546 * This returns whether the entry's contextual (longpress) menu is
11549 * @param obj The entry object
11550 * @return If true, the menu is disabled
11552 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11554 * This appends a custom item provider to the list for that entry
11556 * This appends the given callback. The list is walked from beginning to end
11557 * with each function called given the item href string in the text. If the
11558 * function returns an object handle other than NULL (it should create an
11559 * object to do this), then this object is used to replace that item. If
11560 * not the next provider is called until one provides an item object, or the
11561 * default provider in entry does.
11563 * @param obj The entry object
11564 * @param func The function called to provide the item object
11565 * @param data The data passed to @p func
11567 * @see @ref entry-items
11569 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);
11571 * This prepends a custom item provider to the list for that entry
11573 * This prepends the given callback. See elm_entry_item_provider_append() for
11576 * @param obj The entry object
11577 * @param func The function called to provide the item object
11578 * @param data The data passed to @p func
11580 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);
11582 * This removes a custom item provider to the list for that entry
11584 * This removes the given callback. See elm_entry_item_provider_append() for
11587 * @param obj The entry object
11588 * @param func The function called to provide the item object
11589 * @param data The data passed to @p func
11591 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);
11593 * Append a filter function for text inserted in the entry
11595 * Append the given callback to the list. This functions will be called
11596 * whenever any text is inserted into the entry, with the text to be inserted
11597 * as a parameter. The callback function is free to alter the text in any way
11598 * it wants, but it must remember to free the given pointer and update it.
11599 * If the new text is to be discarded, the function can free it and set its
11600 * text parameter to NULL. This will also prevent any following filters from
11603 * @param obj The entry object
11604 * @param func The function to use as text filter
11605 * @param data User data to pass to @p func
11607 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11609 * Prepend a filter function for text insdrted in the entry
11611 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11612 * for more information
11614 * @param obj The entry object
11615 * @param func The function to use as text filter
11616 * @param data User data to pass to @p func
11618 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11620 * Remove a filter from the list
11622 * Removes the given callback from the filter list. See
11623 * elm_entry_text_filter_append() for more information.
11625 * @param obj The entry object
11626 * @param func The filter function to remove
11627 * @param data The user data passed when adding the function
11629 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11631 * This converts a markup (HTML-like) string into UTF-8.
11633 * The returned string is a malloc'ed buffer and it should be freed when
11634 * not needed anymore.
11636 * @param s The string (in markup) to be converted
11637 * @return The converted string (in UTF-8). It should be freed.
11639 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11641 * This converts a UTF-8 string into markup (HTML-like).
11643 * The returned string is a malloc'ed buffer and it should be freed when
11644 * not needed anymore.
11646 * @param s The string (in UTF-8) to be converted
11647 * @return The converted string (in markup). It should be freed.
11649 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11651 * This sets the file (and implicitly loads it) for the text to display and
11652 * then edit. All changes are written back to the file after a short delay if
11653 * the entry object is set to autosave (which is the default).
11655 * If the entry had any other file set previously, any changes made to it
11656 * will be saved if the autosave feature is enabled, otherwise, the file
11657 * will be silently discarded and any non-saved changes will be lost.
11659 * @param obj The entry object
11660 * @param file The path to the file to load and save
11661 * @param format The file format
11663 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11665 * Gets the file being edited by the entry.
11667 * This function can be used to retrieve any file set on the entry for
11668 * edition, along with the format used to load and save it.
11670 * @param obj The entry object
11671 * @param file The path to the file to load and save
11672 * @param format The file format
11674 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11676 * This function writes any changes made to the file set with
11677 * elm_entry_file_set()
11679 * @param obj The entry object
11681 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11683 * This sets the entry object to 'autosave' the loaded text file or not.
11685 * @param obj The entry object
11686 * @param autosave Autosave the loaded file or not
11688 * @see elm_entry_file_set()
11690 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11692 * This gets the entry object's 'autosave' status.
11694 * @param obj The entry object
11695 * @return Autosave the loaded file or not
11697 * @see elm_entry_file_set()
11699 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11701 * Control pasting of text and images for the widget.
11703 * Normally the entry allows both text and images to be pasted. By setting
11704 * textonly to be true, this prevents images from being pasted.
11706 * Note this only changes the behaviour of text.
11708 * @param obj The entry object
11709 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11710 * text+image+other.
11712 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11714 * Getting elm_entry text paste/drop mode.
11716 * In textonly mode, only text may be pasted or dropped into the widget.
11718 * @param obj The entry object
11719 * @return If the widget only accepts text from pastes.
11721 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11723 * Enable or disable scrolling in entry
11725 * Normally the entry is not scrollable unless you enable it with this call.
11727 * @param obj The entry object
11728 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11730 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11732 * Get the scrollable state of the entry
11734 * Normally the entry is not scrollable. This gets the scrollable state
11735 * of the entry. See elm_entry_scrollable_set() for more information.
11737 * @param obj The entry object
11738 * @return The scrollable state
11740 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11742 * This sets a widget to be displayed to the left of a scrolled entry.
11744 * @param obj The scrolled entry object
11745 * @param icon The widget to display on the left side of the scrolled
11748 * @note A previously set widget will be destroyed.
11749 * @note If the object being set does not have minimum size hints set,
11750 * it won't get properly displayed.
11752 * @see elm_entry_end_set()
11754 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11756 * Gets the leftmost widget of the scrolled entry. This object is
11757 * owned by the scrolled entry and should not be modified.
11759 * @param obj The scrolled entry object
11760 * @return the left widget inside the scroller
11762 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11764 * Unset the leftmost widget of the scrolled entry, unparenting and
11767 * @param obj The scrolled entry object
11768 * @return the previously set icon sub-object of this entry, on
11771 * @see elm_entry_icon_set()
11773 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11775 * Sets the visibility of the left-side widget of the scrolled entry,
11776 * set by elm_entry_icon_set().
11778 * @param obj The scrolled entry object
11779 * @param setting EINA_TRUE if the object should be displayed,
11780 * EINA_FALSE if not.
11782 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11784 * This sets a widget to be displayed to the end of a scrolled entry.
11786 * @param obj The scrolled entry object
11787 * @param end The widget to display on the right side of the scrolled
11790 * @note A previously set widget will be destroyed.
11791 * @note If the object being set does not have minimum size hints set,
11792 * it won't get properly displayed.
11794 * @see elm_entry_icon_set
11796 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11798 * Gets the endmost widget of the scrolled entry. This object is owned
11799 * by the scrolled entry and should not be modified.
11801 * @param obj The scrolled entry object
11802 * @return the right widget inside the scroller
11804 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11806 * Unset the endmost widget of the scrolled entry, unparenting and
11809 * @param obj The scrolled entry object
11810 * @return the previously set icon sub-object of this entry, on
11813 * @see elm_entry_icon_set()
11815 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11817 * Sets the visibility of the end widget of the scrolled entry, set by
11818 * elm_entry_end_set().
11820 * @param obj The scrolled entry object
11821 * @param setting EINA_TRUE if the object should be displayed,
11822 * EINA_FALSE if not.
11824 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11826 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11829 * Setting an entry to single-line mode with elm_entry_single_line_set()
11830 * will automatically disable the display of scrollbars when the entry
11831 * moves inside its scroller.
11833 * @param obj The scrolled entry object
11834 * @param h The horizontal scrollbar policy to apply
11835 * @param v The vertical scrollbar policy to apply
11837 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11839 * This enables/disables bouncing within the entry.
11841 * This function sets whether the entry will bounce when scrolling reaches
11842 * the end of the contained entry.
11844 * @param obj The scrolled entry object
11845 * @param h The horizontal bounce state
11846 * @param v The vertical bounce state
11848 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11850 * Get the bounce mode
11852 * @param obj The Entry object
11853 * @param h_bounce Allow bounce horizontally
11854 * @param v_bounce Allow bounce vertically
11856 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11858 /* pre-made filters for entries */
11860 * @typedef Elm_Entry_Filter_Limit_Size
11862 * Data for the elm_entry_filter_limit_size() entry filter.
11864 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11866 * @struct _Elm_Entry_Filter_Limit_Size
11868 * Data for the elm_entry_filter_limit_size() entry filter.
11870 struct _Elm_Entry_Filter_Limit_Size
11872 int max_char_count; /**< The maximum number of characters allowed. */
11873 int max_byte_count; /**< The maximum number of bytes allowed*/
11876 * Filter inserted text based on user defined character and byte limits
11878 * Add this filter to an entry to limit the characters that it will accept
11879 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11880 * The funtion works on the UTF-8 representation of the string, converting
11881 * it from the set markup, thus not accounting for any format in it.
11883 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11884 * it as data when setting the filter. In it, it's possible to set limits
11885 * by character count or bytes (any of them is disabled if 0), and both can
11886 * be set at the same time. In that case, it first checks for characters,
11889 * The function will cut the inserted text in order to allow only the first
11890 * number of characters that are still allowed. The cut is made in
11891 * characters, even when limiting by bytes, in order to always contain
11892 * valid ones and avoid half unicode characters making it in.
11894 * This filter, like any others, does not apply when setting the entry text
11895 * directly with elm_object_text_set() (or the deprecated
11896 * elm_entry_entry_set()).
11898 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11900 * @typedef Elm_Entry_Filter_Accept_Set
11902 * Data for the elm_entry_filter_accept_set() entry filter.
11904 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11906 * @struct _Elm_Entry_Filter_Accept_Set
11908 * Data for the elm_entry_filter_accept_set() entry filter.
11910 struct _Elm_Entry_Filter_Accept_Set
11912 const char *accepted; /**< Set of characters accepted in the entry. */
11913 const char *rejected; /**< Set of characters rejected from the entry. */
11916 * Filter inserted text based on accepted or rejected sets of characters
11918 * Add this filter to an entry to restrict the set of accepted characters
11919 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11920 * This structure contains both accepted and rejected sets, but they are
11921 * mutually exclusive.
11923 * The @c accepted set takes preference, so if it is set, the filter will
11924 * only work based on the accepted characters, ignoring anything in the
11925 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11927 * In both cases, the function filters by matching utf8 characters to the
11928 * raw markup text, so it can be used to remove formatting tags.
11930 * This filter, like any others, does not apply when setting the entry text
11931 * directly with elm_object_text_set() (or the deprecated
11932 * elm_entry_entry_set()).
11934 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11936 * Set the input panel layout of the entry
11938 * @param obj The entry object
11939 * @param layout layout type
11941 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11943 * Get the input panel layout of the entry
11945 * @param obj The entry object
11946 * @return layout type
11948 * @see elm_entry_input_panel_layout_set
11950 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11952 * Set the autocapitalization type on the immodule.
11954 * @param obj The entry object
11955 * @param autocapital_type The type of autocapitalization
11957 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11959 * Retrieve the autocapitalization type on the immodule.
11961 * @param obj The entry object
11962 * @return autocapitalization type
11964 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11966 * Sets the attribute to show the input panel automatically.
11968 * @param obj The entry object
11969 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11971 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11973 * Retrieve the attribute to show the input panel automatically.
11975 * @param obj The entry object
11976 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11978 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11980 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11981 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11982 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11983 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11984 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11985 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11986 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11988 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11989 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11990 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11991 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11992 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11998 /* composite widgets - these basically put together basic widgets above
11999 * in convenient packages that do more than basic stuff */
12003 * @defgroup Anchorview Anchorview
12005 * @image html img/widget/anchorview/preview-00.png
12006 * @image latex img/widget/anchorview/preview-00.eps
12008 * Anchorview is for displaying text that contains markup with anchors
12009 * like <c>\<a href=1234\>something\</\></c> in it.
12011 * Besides being styled differently, the anchorview widget provides the
12012 * necessary functionality so that clicking on these anchors brings up a
12013 * popup with user defined content such as "call", "add to contacts" or
12014 * "open web page". This popup is provided using the @ref Hover widget.
12016 * This widget is very similar to @ref Anchorblock, so refer to that
12017 * widget for an example. The only difference Anchorview has is that the
12018 * widget is already provided with scrolling functionality, so if the
12019 * text set to it is too large to fit in the given space, it will scroll,
12020 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12021 * text can be displayed.
12023 * This widget emits the following signals:
12024 * @li "anchor,clicked": will be called when an anchor is clicked. The
12025 * @p event_info parameter on the callback will be a pointer of type
12026 * ::Elm_Entry_Anchorview_Info.
12028 * See @ref Anchorblock for an example on how to use both of them.
12037 * @typedef Elm_Entry_Anchorview_Info
12039 * The info sent in the callback for "anchor,clicked" signals emitted by
12040 * the Anchorview widget.
12042 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12044 * @struct _Elm_Entry_Anchorview_Info
12046 * The info sent in the callback for "anchor,clicked" signals emitted by
12047 * the Anchorview widget.
12049 struct _Elm_Entry_Anchorview_Info
12051 const char *name; /**< Name of the anchor, as indicated in its href
12053 int button; /**< The mouse button used to click on it */
12054 Evas_Object *hover; /**< The hover object to use for the popup */
12056 Evas_Coord x, y, w, h;
12057 } anchor, /**< Geometry selection of text used as anchor */
12058 hover_parent; /**< Geometry of the object used as parent by the
12060 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12061 for content on the left side of
12062 the hover. Before calling the
12063 callback, the widget will make the
12064 necessary calculations to check
12065 which sides are fit to be set with
12066 content, based on the position the
12067 hover is activated and its distance
12068 to the edges of its parent object
12070 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12071 the right side of the hover.
12072 See @ref hover_left */
12073 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12074 of the hover. See @ref hover_left */
12075 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12076 below the hover. See @ref
12080 * Add a new Anchorview object
12082 * @param parent The parent object
12083 * @return The new object or NULL if it cannot be created
12085 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12087 * Set the text to show in the anchorview
12089 * Sets the text of the anchorview to @p text. This text can include markup
12090 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12091 * text that will be specially styled and react to click events, ended with
12092 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12093 * "anchor,clicked" signal that you can attach a callback to with
12094 * evas_object_smart_callback_add(). The name of the anchor given in the
12095 * event info struct will be the one set in the href attribute, in this
12096 * case, anchorname.
12098 * Other markup can be used to style the text in different ways, but it's
12099 * up to the style defined in the theme which tags do what.
12100 * @deprecated use elm_object_text_set() instead.
12102 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12104 * Get the markup text set for the anchorview
12106 * Retrieves the text set on the anchorview, with markup tags included.
12108 * @param obj The anchorview object
12109 * @return The markup text set or @c NULL if nothing was set or an error
12111 * @deprecated use elm_object_text_set() instead.
12113 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12115 * Set the parent of the hover popup
12117 * Sets the parent object to use by the hover created by the anchorview
12118 * when an anchor is clicked. See @ref Hover for more details on this.
12119 * If no parent is set, the same anchorview object will be used.
12121 * @param obj The anchorview object
12122 * @param parent The object to use as parent for the hover
12124 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12126 * Get the parent of the hover popup
12128 * Get the object used as parent for the hover created by the anchorview
12129 * widget. See @ref Hover for more details on this.
12131 * @param obj The anchorview object
12132 * @return The object used as parent for the hover, NULL if none is set.
12134 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12136 * Set the style that the hover should use
12138 * When creating the popup hover, anchorview will request that it's
12139 * themed according to @p style.
12141 * @param obj The anchorview object
12142 * @param style The style to use for the underlying hover
12144 * @see elm_object_style_set()
12146 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12148 * Get the style that the hover should use
12150 * Get the style the hover created by anchorview will use.
12152 * @param obj The anchorview object
12153 * @return The style to use by the hover. NULL means the default is used.
12155 * @see elm_object_style_set()
12157 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12159 * Ends the hover popup in the anchorview
12161 * When an anchor is clicked, the anchorview widget will create a hover
12162 * object to use as a popup with user provided content. This function
12163 * terminates this popup, returning the anchorview to its normal state.
12165 * @param obj The anchorview object
12167 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12169 * Set bouncing behaviour when the scrolled content reaches an edge
12171 * Tell the internal scroller object whether it should bounce or not
12172 * when it reaches the respective edges for each axis.
12174 * @param obj The anchorview object
12175 * @param h_bounce Whether to bounce or not in the horizontal axis
12176 * @param v_bounce Whether to bounce or not in the vertical axis
12178 * @see elm_scroller_bounce_set()
12180 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12182 * Get the set bouncing behaviour of the internal scroller
12184 * Get whether the internal scroller should bounce when the edge of each
12185 * axis is reached scrolling.
12187 * @param obj The anchorview object
12188 * @param h_bounce Pointer where to store the bounce state of the horizontal
12190 * @param v_bounce Pointer where to store the bounce state of the vertical
12193 * @see elm_scroller_bounce_get()
12195 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12197 * Appends a custom item provider to the given anchorview
12199 * Appends the given function to the list of items providers. This list is
12200 * called, one function at a time, with the given @p data pointer, the
12201 * anchorview object and, in the @p item parameter, the item name as
12202 * referenced in its href string. Following functions in the list will be
12203 * called in order until one of them returns something different to NULL,
12204 * which should be an Evas_Object which will be used in place of the item
12207 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12208 * href=item/name\>\</item\>
12210 * @param obj The anchorview object
12211 * @param func The function to add to the list of providers
12212 * @param data User data that will be passed to the callback function
12214 * @see elm_entry_item_provider_append()
12216 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);
12218 * Prepend a custom item provider to the given anchorview
12220 * Like elm_anchorview_item_provider_append(), but it adds the function
12221 * @p func to the beginning of the list, instead of the end.
12223 * @param obj The anchorview object
12224 * @param func The function to add to the list of providers
12225 * @param data User data that will be passed to the callback function
12227 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);
12229 * Remove a custom item provider from the list of the given anchorview
12231 * Removes the function and data pairing that matches @p func and @p data.
12232 * That is, unless the same function and same user data are given, the
12233 * function will not be removed from the list. This allows us to add the
12234 * same callback several times, with different @p data pointers and be
12235 * able to remove them later without conflicts.
12237 * @param obj The anchorview object
12238 * @param func The function to remove from the list
12239 * @param data The data matching the function to remove from the list
12241 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);
12248 * @defgroup Anchorblock Anchorblock
12250 * @image html img/widget/anchorblock/preview-00.png
12251 * @image latex img/widget/anchorblock/preview-00.eps
12253 * Anchorblock is for displaying text that contains markup with anchors
12254 * like <c>\<a href=1234\>something\</\></c> in it.
12256 * Besides being styled differently, the anchorblock widget provides the
12257 * necessary functionality so that clicking on these anchors brings up a
12258 * popup with user defined content such as "call", "add to contacts" or
12259 * "open web page". This popup is provided using the @ref Hover widget.
12261 * This widget emits the following signals:
12262 * @li "anchor,clicked": will be called when an anchor is clicked. The
12263 * @p event_info parameter on the callback will be a pointer of type
12264 * ::Elm_Entry_Anchorblock_Info.
12270 * Since examples are usually better than plain words, we might as well
12271 * try @ref tutorial_anchorblock_example "one".
12274 * @addtogroup Anchorblock
12278 * @typedef Elm_Entry_Anchorblock_Info
12280 * The info sent in the callback for "anchor,clicked" signals emitted by
12281 * the Anchorblock widget.
12283 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12285 * @struct _Elm_Entry_Anchorblock_Info
12287 * The info sent in the callback for "anchor,clicked" signals emitted by
12288 * the Anchorblock widget.
12290 struct _Elm_Entry_Anchorblock_Info
12292 const char *name; /**< Name of the anchor, as indicated in its href
12294 int button; /**< The mouse button used to click on it */
12295 Evas_Object *hover; /**< The hover object to use for the popup */
12297 Evas_Coord x, y, w, h;
12298 } anchor, /**< Geometry selection of text used as anchor */
12299 hover_parent; /**< Geometry of the object used as parent by the
12301 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12302 for content on the left side of
12303 the hover. Before calling the
12304 callback, the widget will make the
12305 necessary calculations to check
12306 which sides are fit to be set with
12307 content, based on the position the
12308 hover is activated and its distance
12309 to the edges of its parent object
12311 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12312 the right side of the hover.
12313 See @ref hover_left */
12314 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12315 of the hover. See @ref hover_left */
12316 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12317 below the hover. See @ref
12321 * Add a new Anchorblock object
12323 * @param parent The parent object
12324 * @return The new object or NULL if it cannot be created
12326 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12328 * Set the text to show in the anchorblock
12330 * Sets the text of the anchorblock to @p text. This text can include markup
12331 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12332 * of text that will be specially styled and react to click events, ended
12333 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12334 * "anchor,clicked" signal that you can attach a callback to with
12335 * evas_object_smart_callback_add(). The name of the anchor given in the
12336 * event info struct will be the one set in the href attribute, in this
12337 * case, anchorname.
12339 * Other markup can be used to style the text in different ways, but it's
12340 * up to the style defined in the theme which tags do what.
12341 * @deprecated use elm_object_text_set() instead.
12343 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12345 * Get the markup text set for the anchorblock
12347 * Retrieves the text set on the anchorblock, with markup tags included.
12349 * @param obj The anchorblock object
12350 * @return The markup text set or @c NULL if nothing was set or an error
12352 * @deprecated use elm_object_text_set() instead.
12354 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12356 * Set the parent of the hover popup
12358 * Sets the parent object to use by the hover created by the anchorblock
12359 * when an anchor is clicked. See @ref Hover for more details on this.
12361 * @param obj The anchorblock object
12362 * @param parent The object to use as parent for the hover
12364 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12366 * Get the parent of the hover popup
12368 * Get the object used as parent for the hover created by the anchorblock
12369 * widget. See @ref Hover for more details on this.
12370 * If no parent is set, the same anchorblock object will be used.
12372 * @param obj The anchorblock object
12373 * @return The object used as parent for the hover, NULL if none is set.
12375 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12377 * Set the style that the hover should use
12379 * When creating the popup hover, anchorblock will request that it's
12380 * themed according to @p style.
12382 * @param obj The anchorblock object
12383 * @param style The style to use for the underlying hover
12385 * @see elm_object_style_set()
12387 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12389 * Get the style that the hover should use
12391 * Get the style, the hover created by anchorblock will use.
12393 * @param obj The anchorblock object
12394 * @return The style to use by the hover. NULL means the default is used.
12396 * @see elm_object_style_set()
12398 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12400 * Ends the hover popup in the anchorblock
12402 * When an anchor is clicked, the anchorblock widget will create a hover
12403 * object to use as a popup with user provided content. This function
12404 * terminates this popup, returning the anchorblock to its normal state.
12406 * @param obj The anchorblock object
12408 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12410 * Appends a custom item provider to the given anchorblock
12412 * Appends the given function to the list of items providers. This list is
12413 * called, one function at a time, with the given @p data pointer, the
12414 * anchorblock object and, in the @p item parameter, the item name as
12415 * referenced in its href string. Following functions in the list will be
12416 * called in order until one of them returns something different to NULL,
12417 * which should be an Evas_Object which will be used in place of the item
12420 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12421 * href=item/name\>\</item\>
12423 * @param obj The anchorblock object
12424 * @param func The function to add to the list of providers
12425 * @param data User data that will be passed to the callback function
12427 * @see elm_entry_item_provider_append()
12429 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);
12431 * Prepend a custom item provider to the given anchorblock
12433 * Like elm_anchorblock_item_provider_append(), but it adds the function
12434 * @p func to the beginning of the list, instead of the end.
12436 * @param obj The anchorblock object
12437 * @param func The function to add to the list of providers
12438 * @param data User data that will be passed to the callback function
12440 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);
12442 * Remove a custom item provider from the list of the given anchorblock
12444 * Removes the function and data pairing that matches @p func and @p data.
12445 * That is, unless the same function and same user data are given, the
12446 * function will not be removed from the list. This allows us to add the
12447 * same callback several times, with different @p data pointers and be
12448 * able to remove them later without conflicts.
12450 * @param obj The anchorblock object
12451 * @param func The function to remove from the list
12452 * @param data The data matching the function to remove from the list
12454 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);
12460 * @defgroup Bubble Bubble
12462 * @image html img/widget/bubble/preview-00.png
12463 * @image latex img/widget/bubble/preview-00.eps
12464 * @image html img/widget/bubble/preview-01.png
12465 * @image latex img/widget/bubble/preview-01.eps
12466 * @image html img/widget/bubble/preview-02.png
12467 * @image latex img/widget/bubble/preview-02.eps
12469 * @brief The Bubble is a widget to show text similar to how speech is
12470 * represented in comics.
12472 * The bubble widget contains 5 important visual elements:
12473 * @li The frame is a rectangle with rounded edjes and an "arrow".
12474 * @li The @p icon is an image to which the frame's arrow points to.
12475 * @li The @p label is a text which appears to the right of the icon if the
12476 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12478 * @li The @p info is a text which appears to the right of the label. Info's
12479 * font is of a ligther color than label.
12480 * @li The @p content is an evas object that is shown inside the frame.
12482 * The position of the arrow, icon, label and info depends on which corner is
12483 * selected. The four available corners are:
12484 * @li "top_left" - Default
12486 * @li "bottom_left"
12487 * @li "bottom_right"
12489 * Signals that you can add callbacks for are:
12490 * @li "clicked" - This is called when a user has clicked the bubble.
12492 * Default contents parts of the bubble that you can use for are:
12493 * @li "default" - A content of the bubble
12494 * @li "icon" - An icon of the bubble
12496 * Default text parts of the button widget that you can use for are:
12497 * @li NULL - Label of the bubble
12499 * For an example of using a buble see @ref bubble_01_example_page "this".
12505 * Add a new bubble to the parent
12507 * @param parent The parent object
12508 * @return The new object or NULL if it cannot be created
12510 * This function adds a text bubble to the given parent evas object.
12512 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12514 * Set the label of the bubble
12516 * @param obj The bubble object
12517 * @param label The string to set in the label
12519 * This function sets the title of the bubble. Where this appears depends on
12520 * the selected corner.
12521 * @deprecated use elm_object_text_set() instead.
12523 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12525 * Get the label of the bubble
12527 * @param obj The bubble object
12528 * @return The string of set in the label
12530 * This function gets the title of the bubble.
12531 * @deprecated use elm_object_text_get() instead.
12533 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12535 * Set the info of the bubble
12537 * @param obj The bubble object
12538 * @param info The given info about the bubble
12540 * This function sets the info of the bubble. Where this appears depends on
12541 * the selected corner.
12542 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12544 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12546 * Get the info of the bubble
12548 * @param obj The bubble object
12550 * @return The "info" string of the bubble
12552 * This function gets the info text.
12553 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12555 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12557 * Set the content to be shown in the bubble
12559 * Once the content object is set, a previously set one will be deleted.
12560 * If you want to keep the old content object, use the
12561 * elm_bubble_content_unset() function.
12563 * @param obj The bubble object
12564 * @param content The given content of the bubble
12566 * This function sets the content shown on the middle of the bubble.
12568 * @deprecated use elm_object_content_set() instead
12571 WILL_DEPRECATE EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12573 * Get the content shown in the bubble
12575 * Return the content object which is set for this widget.
12577 * @param obj The bubble object
12578 * @return The content that is being used
12580 * @deprecated use elm_object_content_get() instead
12583 WILL_DEPRECATE EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12585 * Unset the content shown in the bubble
12587 * Unparent and return the content object which was set for this widget.
12589 * @param obj The bubble object
12590 * @return The content that was being used
12592 * @deprecated use elm_object_content_unset() instead
12595 WILL_DEPRECATE EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12597 * Set the icon of the bubble
12599 * Once the icon object is set, a previously set one will be deleted.
12600 * If you want to keep the old content object, use the
12601 * elm_icon_content_unset() function.
12603 * @param obj The bubble object
12604 * @param icon The given icon for the bubble
12606 * @deprecated use elm_object_part_content_set() instead
12609 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12611 * Get the icon of the bubble
12613 * @param obj The bubble object
12614 * @return The icon for the bubble
12616 * This function gets the icon shown on the top left of bubble.
12618 * @deprecated use elm_object_part_content_get() instead
12621 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12623 * Unset the icon of the bubble
12625 * Unparent and return the icon object which was set for this widget.
12627 * @param obj The bubble object
12628 * @return The icon that was being used
12630 * @deprecated use elm_object_part_content_unset() instead
12633 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12635 * Set the corner of the bubble
12637 * @param obj The bubble object.
12638 * @param corner The given corner for the bubble.
12640 * This function sets the corner of the bubble. The corner will be used to
12641 * determine where the arrow in the frame points to and where label, icon and
12644 * Possible values for corner are:
12645 * @li "top_left" - Default
12647 * @li "bottom_left"
12648 * @li "bottom_right"
12650 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12652 * Get the corner of the bubble
12654 * @param obj The bubble object.
12655 * @return The given corner for the bubble.
12657 * This function gets the selected corner of the bubble.
12659 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12661 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12662 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12669 * @defgroup Photo Photo
12671 * For displaying the photo of a person (contact). Simple, yet
12672 * with a very specific purpose.
12674 * Signals that you can add callbacks for are:
12676 * "clicked" - This is called when a user has clicked the photo
12677 * "drag,start" - Someone started dragging the image out of the object
12678 * "drag,end" - Dragged item was dropped (somewhere)
12684 * Add a new photo to the parent
12686 * @param parent The parent object
12687 * @return The new object or NULL if it cannot be created
12691 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12694 * Set the file that will be used as photo
12696 * @param obj The photo object
12697 * @param file The path to file that will be used as photo
12699 * @return (1 = success, 0 = error)
12703 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12706 * Set the file that will be used as thumbnail in the photo.
12708 * @param obj The photo object.
12709 * @param file The path to file that will be used as thumb.
12710 * @param group The key used in case of an EET file.
12714 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12717 * Set the size that will be used on the photo
12719 * @param obj The photo object
12720 * @param size The size that the photo will be
12724 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12727 * Set if the photo should be completely visible or not.
12729 * @param obj The photo object
12730 * @param fill if true the photo will be completely visible
12734 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12737 * Set editability of the photo.
12739 * An editable photo can be dragged to or from, and can be cut or
12740 * pasted too. Note that pasting an image or dropping an item on
12741 * the image will delete the existing content.
12743 * @param obj The photo object.
12744 * @param set To set of clear editablity.
12746 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12752 /* gesture layer */
12754 * @defgroup Elm_Gesture_Layer Gesture Layer
12755 * Gesture Layer Usage:
12757 * Use Gesture Layer to detect gestures.
12758 * The advantage is that you don't have to implement
12759 * gesture detection, just set callbacks of gesture state.
12760 * By using gesture layer we make standard interface.
12762 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12763 * with a parent object parameter.
12764 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12765 * call. Usually with same object as target (2nd parameter).
12767 * Now you need to tell gesture layer what gestures you follow.
12768 * This is done with @ref elm_gesture_layer_cb_set call.
12769 * By setting the callback you actually saying to gesture layer:
12770 * I would like to know when the gesture @ref Elm_Gesture_Types
12771 * switches to state @ref Elm_Gesture_State.
12773 * Next, you need to implement the actual action that follows the input
12774 * in your callback.
12776 * Note that if you like to stop being reported about a gesture, just set
12777 * all callbacks referring this gesture to NULL.
12778 * (again with @ref elm_gesture_layer_cb_set)
12780 * The information reported by gesture layer to your callback is depending
12781 * on @ref Elm_Gesture_Types:
12782 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12783 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12784 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12786 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12787 * @ref ELM_GESTURE_MOMENTUM.
12789 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12790 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12791 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12792 * Note that we consider a flick as a line-gesture that should be completed
12793 * in flick-time-limit as defined in @ref Config.
12795 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12797 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12800 * Gesture Layer Tweaks:
12802 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12803 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12805 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12806 * so gesture starts when user touches (a *DOWN event) touch-surface
12807 * and ends when no fingers touches surface (a *UP event).
12811 * @enum _Elm_Gesture_Types
12812 * Enum of supported gesture types.
12813 * @ingroup Elm_Gesture_Layer
12815 enum _Elm_Gesture_Types
12817 ELM_GESTURE_FIRST = 0,
12819 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12820 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12821 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12822 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12824 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12826 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12827 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12829 ELM_GESTURE_ZOOM, /**< Zoom */
12830 ELM_GESTURE_ROTATE, /**< Rotate */
12836 * @typedef Elm_Gesture_Types
12837 * gesture types enum
12838 * @ingroup Elm_Gesture_Layer
12840 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12843 * @enum _Elm_Gesture_State
12844 * Enum of gesture states.
12845 * @ingroup Elm_Gesture_Layer
12847 enum _Elm_Gesture_State
12849 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12850 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12851 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12852 ELM_GESTURE_STATE_END, /**< Gesture completed */
12853 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12857 * @typedef Elm_Gesture_State
12858 * gesture states enum
12859 * @ingroup Elm_Gesture_Layer
12861 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12864 * @struct _Elm_Gesture_Taps_Info
12865 * Struct holds taps info for user
12866 * @ingroup Elm_Gesture_Layer
12868 struct _Elm_Gesture_Taps_Info
12870 Evas_Coord x, y; /**< Holds center point between fingers */
12871 unsigned int n; /**< Number of fingers tapped */
12872 unsigned int timestamp; /**< event timestamp */
12876 * @typedef Elm_Gesture_Taps_Info
12877 * holds taps info for user
12878 * @ingroup Elm_Gesture_Layer
12880 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12883 * @struct _Elm_Gesture_Momentum_Info
12884 * Struct holds momentum info for user
12885 * x1 and y1 are not necessarily in sync
12886 * x1 holds x value of x direction starting point
12887 * and same holds for y1.
12888 * This is noticeable when doing V-shape movement
12889 * @ingroup Elm_Gesture_Layer
12891 struct _Elm_Gesture_Momentum_Info
12892 { /* Report line ends, timestamps, and momentum computed */
12893 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12894 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12895 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12896 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12898 unsigned int tx; /**< Timestamp of start of final x-swipe */
12899 unsigned int ty; /**< Timestamp of start of final y-swipe */
12901 Evas_Coord mx; /**< Momentum on X */
12902 Evas_Coord my; /**< Momentum on Y */
12904 unsigned int n; /**< Number of fingers */
12908 * @typedef Elm_Gesture_Momentum_Info
12909 * holds momentum info for user
12910 * @ingroup Elm_Gesture_Layer
12912 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12915 * @struct _Elm_Gesture_Line_Info
12916 * Struct holds line info for user
12917 * @ingroup Elm_Gesture_Layer
12919 struct _Elm_Gesture_Line_Info
12920 { /* Report line ends, timestamps, and momentum computed */
12921 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12922 double angle; /**< Angle (direction) of lines */
12926 * @typedef Elm_Gesture_Line_Info
12927 * Holds line info for user
12928 * @ingroup Elm_Gesture_Layer
12930 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12933 * @struct _Elm_Gesture_Zoom_Info
12934 * Struct holds zoom info for user
12935 * @ingroup Elm_Gesture_Layer
12937 struct _Elm_Gesture_Zoom_Info
12939 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12940 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12941 double zoom; /**< Zoom value: 1.0 means no zoom */
12942 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12946 * @typedef Elm_Gesture_Zoom_Info
12947 * Holds zoom info for user
12948 * @ingroup Elm_Gesture_Layer
12950 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12953 * @struct _Elm_Gesture_Rotate_Info
12954 * Struct holds rotation info for user
12955 * @ingroup Elm_Gesture_Layer
12957 struct _Elm_Gesture_Rotate_Info
12959 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12960 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12961 double base_angle; /**< Holds start-angle */
12962 double angle; /**< Rotation value: 0.0 means no rotation */
12963 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12967 * @typedef Elm_Gesture_Rotate_Info
12968 * Holds rotation info for user
12969 * @ingroup Elm_Gesture_Layer
12971 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12974 * @typedef Elm_Gesture_Event_Cb
12975 * User callback used to stream gesture info from gesture layer
12976 * @param data user data
12977 * @param event_info gesture report info
12978 * Returns a flag field to be applied on the causing event.
12979 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12980 * upon the event, in an irreversible way.
12982 * @ingroup Elm_Gesture_Layer
12984 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12987 * Use function to set callbacks to be notified about
12988 * change of state of gesture.
12989 * When a user registers a callback with this function
12990 * this means this gesture has to be tested.
12992 * When ALL callbacks for a gesture are set to NULL
12993 * it means user isn't interested in gesture-state
12994 * and it will not be tested.
12996 * @param obj Pointer to gesture-layer.
12997 * @param idx The gesture you would like to track its state.
12998 * @param cb callback function pointer.
12999 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13000 * @param data user info to be sent to callback (usually, Smart Data)
13002 * @ingroup Elm_Gesture_Layer
13004 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);
13007 * Call this function to get repeat-events settings.
13009 * @param obj Pointer to gesture-layer.
13011 * @return repeat events settings.
13012 * @see elm_gesture_layer_hold_events_set()
13013 * @ingroup Elm_Gesture_Layer
13015 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13018 * This function called in order to make gesture-layer repeat events.
13019 * Set this of you like to get the raw events only if gestures were not detected.
13020 * Clear this if you like gesture layer to fwd events as testing gestures.
13022 * @param obj Pointer to gesture-layer.
13023 * @param r Repeat: TRUE/FALSE
13025 * @ingroup Elm_Gesture_Layer
13027 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13030 * This function sets step-value for zoom action.
13031 * Set step to any positive value.
13032 * Cancel step setting by setting to 0.0
13034 * @param obj Pointer to gesture-layer.
13035 * @param s new zoom step value.
13037 * @ingroup Elm_Gesture_Layer
13039 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13042 * This function sets step-value for rotate action.
13043 * Set step to any positive value.
13044 * Cancel step setting by setting to 0.0
13046 * @param obj Pointer to gesture-layer.
13047 * @param s new roatate step value.
13049 * @ingroup Elm_Gesture_Layer
13051 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13054 * This function called to attach gesture-layer to an Evas_Object.
13055 * @param obj Pointer to gesture-layer.
13056 * @param t Pointer to underlying object (AKA Target)
13058 * @return TRUE, FALSE on success, failure.
13060 * @ingroup Elm_Gesture_Layer
13062 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13065 * Call this function to construct a new gesture-layer object.
13066 * This does not activate the gesture layer. You have to
13067 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13069 * @param parent the parent object.
13071 * @return Pointer to new gesture-layer object.
13073 * @ingroup Elm_Gesture_Layer
13075 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13078 * @defgroup Thumb Thumb
13080 * @image html img/widget/thumb/preview-00.png
13081 * @image latex img/widget/thumb/preview-00.eps
13083 * A thumb object is used for displaying the thumbnail of an image or video.
13084 * You must have compiled Elementary with Ethumb_Client support and the DBus
13085 * service must be present and auto-activated in order to have thumbnails to
13088 * Once the thumbnail object becomes visible, it will check if there is a
13089 * previously generated thumbnail image for the file set on it. If not, it
13090 * will start generating this thumbnail.
13092 * Different config settings will cause different thumbnails to be generated
13093 * even on the same file.
13095 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13096 * Ethumb documentation to change this path, and to see other configuration
13099 * Signals that you can add callbacks for are:
13101 * - "clicked" - This is called when a user has clicked the thumb without dragging
13103 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13104 * - "press" - This is called when a user has pressed down the thumb.
13105 * - "generate,start" - The thumbnail generation started.
13106 * - "generate,stop" - The generation process stopped.
13107 * - "generate,error" - The generation failed.
13108 * - "load,error" - The thumbnail image loading failed.
13110 * available styles:
13114 * An example of use of thumbnail:
13116 * - @ref thumb_example_01
13120 * @addtogroup Thumb
13125 * @enum _Elm_Thumb_Animation_Setting
13126 * @typedef Elm_Thumb_Animation_Setting
13128 * Used to set if a video thumbnail is animating or not.
13132 typedef enum _Elm_Thumb_Animation_Setting
13134 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13135 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13136 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13137 ELM_THUMB_ANIMATION_LAST
13138 } Elm_Thumb_Animation_Setting;
13141 * Add a new thumb object to the parent.
13143 * @param parent The parent object.
13144 * @return The new object or NULL if it cannot be created.
13146 * @see elm_thumb_file_set()
13147 * @see elm_thumb_ethumb_client_get()
13151 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13153 * Reload thumbnail if it was generated before.
13155 * @param obj The thumb object to reload
13157 * This is useful if the ethumb client configuration changed, like its
13158 * size, aspect or any other property one set in the handle returned
13159 * by elm_thumb_ethumb_client_get().
13161 * If the options didn't change, the thumbnail won't be generated again, but
13162 * the old one will still be used.
13164 * @see elm_thumb_file_set()
13168 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13170 * Set the file that will be used as thumbnail.
13172 * @param obj The thumb object.
13173 * @param file The path to file that will be used as thumb.
13174 * @param key The key used in case of an EET file.
13176 * The file can be an image or a video (in that case, acceptable extensions are:
13177 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13178 * function elm_thumb_animate().
13180 * @see elm_thumb_file_get()
13181 * @see elm_thumb_reload()
13182 * @see elm_thumb_animate()
13186 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13188 * Get the image or video path and key used to generate the thumbnail.
13190 * @param obj The thumb object.
13191 * @param file Pointer to filename.
13192 * @param key Pointer to key.
13194 * @see elm_thumb_file_set()
13195 * @see elm_thumb_path_get()
13199 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13201 * Get the path and key to the image or video generated by ethumb.
13203 * One just need to make sure that the thumbnail was generated before getting
13204 * its path; otherwise, the path will be NULL. One way to do that is by asking
13205 * for the path when/after the "generate,stop" smart callback is called.
13207 * @param obj The thumb object.
13208 * @param file Pointer to thumb path.
13209 * @param key Pointer to thumb key.
13211 * @see elm_thumb_file_get()
13215 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13217 * Set the animation state for the thumb object. If its content is an animated
13218 * video, you may start/stop the animation or tell it to play continuously and
13221 * @param obj The thumb object.
13222 * @param setting The animation setting.
13224 * @see elm_thumb_file_set()
13228 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13230 * Get the animation state for the thumb object.
13232 * @param obj The thumb object.
13233 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13236 * @see elm_thumb_animate_set()
13240 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13242 * Get the ethumb_client handle so custom configuration can be made.
13244 * @return Ethumb_Client instance or NULL.
13246 * This must be called before the objects are created to be sure no object is
13247 * visible and no generation started.
13249 * Example of usage:
13252 * #include <Elementary.h>
13253 * #ifndef ELM_LIB_QUICKLAUNCH
13255 * elm_main(int argc, char **argv)
13257 * Ethumb_Client *client;
13259 * elm_need_ethumb();
13263 * client = elm_thumb_ethumb_client_get();
13266 * ERR("could not get ethumb_client");
13269 * ethumb_client_size_set(client, 100, 100);
13270 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13273 * // Create elm_thumb objects here
13283 * @note There's only one client handle for Ethumb, so once a configuration
13284 * change is done to it, any other request for thumbnails (for any thumbnail
13285 * object) will use that configuration. Thus, this configuration is global.
13289 EAPI void *elm_thumb_ethumb_client_get(void);
13291 * Get the ethumb_client connection state.
13293 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13296 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13298 * Make the thumbnail 'editable'.
13300 * @param obj Thumb object.
13301 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13303 * This means the thumbnail is a valid drag target for drag and drop, and can be
13304 * cut or pasted too.
13306 * @see elm_thumb_editable_get()
13310 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13311 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13313 * Make the thumbnail 'editable'.
13315 * @param obj Thumb object.
13316 * @return Editability.
13318 * This means the thumbnail is a valid drag target for drag and drop, and can be
13319 * cut or pasted too.
13321 * @see elm_thumb_editable_set()
13325 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13332 * @defgroup Web Web
13334 * @image html img/widget/web/preview-00.png
13335 * @image latex img/widget/web/preview-00.eps
13337 * A web object is used for displaying web pages (HTML/CSS/JS)
13338 * using WebKit-EFL. You must have compiled Elementary with
13341 * Signals that you can add callbacks for are:
13342 * @li "download,request": A file download has been requested. Event info is
13343 * a pointer to a Elm_Web_Download
13344 * @li "editorclient,contents,changed": Editor client's contents changed
13345 * @li "editorclient,selection,changed": Editor client's selection changed
13346 * @li "frame,created": A new frame was created. Event info is an
13347 * Evas_Object which can be handled with WebKit's ewk_frame API
13348 * @li "icon,received": An icon was received by the main frame
13349 * @li "inputmethod,changed": Input method changed. Event info is an
13350 * Eina_Bool indicating whether it's enabled or not
13351 * @li "js,windowobject,clear": JS window object has been cleared
13352 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13353 * is a char *link[2], where the first string contains the URL the link
13354 * points to, and the second one the title of the link
13355 * @li "link,hover,out": Mouse cursor left the link
13356 * @li "load,document,finished": Loading of a document finished. Event info
13357 * is the frame that finished loading
13358 * @li "load,error": Load failed. Event info is a pointer to
13359 * Elm_Web_Frame_Load_Error
13360 * @li "load,finished": Load finished. Event info is NULL on success, on
13361 * error it's a pointer to Elm_Web_Frame_Load_Error
13362 * @li "load,newwindow,show": A new window was created and is ready to be
13364 * @li "load,progress": Overall load progress. Event info is a pointer to
13365 * a double containing a value between 0.0 and 1.0
13366 * @li "load,provisional": Started provisional load
13367 * @li "load,started": Loading of a document started
13368 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13369 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13370 * the menubar is visible, or EINA_FALSE in case it's not
13371 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13372 * an Eina_Bool indicating the visibility
13373 * @li "popup,created": A dropdown widget was activated, requesting its
13374 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13375 * @li "popup,willdelete": The web object is ready to destroy the popup
13376 * object created. Event info is a pointer to Elm_Web_Menu
13377 * @li "ready": Page is fully loaded
13378 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13379 * info is a pointer to Eina_Bool where the visibility state should be set
13380 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13381 * is an Eina_Bool with the visibility state set
13382 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13383 * a string with the new text
13384 * @li "statusbar,visible,get": Queries visibility of the status bar.
13385 * Event info is a pointer to Eina_Bool where the visibility state should be
13387 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13388 * an Eina_Bool with the visibility value
13389 * @li "title,changed": Title of the main frame changed. Event info is a
13390 * string with the new title
13391 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13392 * is a pointer to Eina_Bool where the visibility state should be set
13393 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13394 * info is an Eina_Bool with the visibility state
13395 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13396 * a string with the text to show
13397 * @li "uri,changed": URI of the main frame changed. Event info is a string
13399 * @li "view,resized": The web object internal's view changed sized
13400 * @li "windows,close,request": A JavaScript request to close the current
13401 * window was requested
13402 * @li "zoom,animated,end": Animated zoom finished
13404 * available styles:
13407 * An example of use of web:
13409 * - @ref web_example_01 TBD
13418 * Structure used to report load errors.
13420 * Load errors are reported as signal by elm_web. All the strings are
13421 * temporary references and should @b not be used after the signal
13422 * callback returns. If it's required, make copies with strdup() or
13423 * eina_stringshare_add() (they are not even guaranteed to be
13424 * stringshared, so must use eina_stringshare_add() and not
13425 * eina_stringshare_ref()).
13427 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13429 * Structure used to report load errors.
13431 * Load errors are reported as signal by elm_web. All the strings are
13432 * temporary references and should @b not be used after the signal
13433 * callback returns. If it's required, make copies with strdup() or
13434 * eina_stringshare_add() (they are not even guaranteed to be
13435 * stringshared, so must use eina_stringshare_add() and not
13436 * eina_stringshare_ref()).
13438 struct _Elm_Web_Frame_Load_Error
13440 int code; /**< Numeric error code */
13441 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13442 const char *domain; /**< Error domain name */
13443 const char *description; /**< Error description (already localized) */
13444 const char *failing_url; /**< The URL that failed to load */
13445 Evas_Object *frame; /**< Frame object that produced the error */
13449 * The possibles types that the items in a menu can be
13451 typedef enum _Elm_Web_Menu_Item_Type
13453 ELM_WEB_MENU_SEPARATOR,
13454 ELM_WEB_MENU_GROUP,
13455 ELM_WEB_MENU_OPTION
13456 } Elm_Web_Menu_Item_Type;
13459 * Structure describing the items in a menu
13461 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13463 * Structure describing the items in a menu
13465 struct _Elm_Web_Menu_Item
13467 const char *text; /**< The text for the item */
13468 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13472 * Structure describing the menu of a popup
13474 * This structure will be passed as the @c event_info for the "popup,create"
13475 * signal, which is emitted when a dropdown menu is opened. Users wanting
13476 * to handle these popups by themselves should listen to this signal and
13477 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13478 * property as @c EINA_FALSE means that the user will not handle the popup
13479 * and the default implementation will be used.
13481 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13482 * will be emitted to notify the user that it can destroy any objects and
13483 * free all data related to it.
13485 * @see elm_web_popup_selected_set()
13486 * @see elm_web_popup_destroy()
13488 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13490 * Structure describing the menu of a popup
13492 * This structure will be passed as the @c event_info for the "popup,create"
13493 * signal, which is emitted when a dropdown menu is opened. Users wanting
13494 * to handle these popups by themselves should listen to this signal and
13495 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13496 * property as @c EINA_FALSE means that the user will not handle the popup
13497 * and the default implementation will be used.
13499 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13500 * will be emitted to notify the user that it can destroy any objects and
13501 * free all data related to it.
13503 * @see elm_web_popup_selected_set()
13504 * @see elm_web_popup_destroy()
13506 struct _Elm_Web_Menu
13508 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13509 int x; /**< The X position of the popup, relative to the elm_web object */
13510 int y; /**< The Y position of the popup, relative to the elm_web object */
13511 int width; /**< Width of the popup menu */
13512 int height; /**< Height of the popup menu */
13514 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. */
13517 typedef struct _Elm_Web_Download Elm_Web_Download;
13518 struct _Elm_Web_Download
13524 * Types of zoom available.
13526 typedef enum _Elm_Web_Zoom_Mode
13528 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13529 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13530 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13531 ELM_WEB_ZOOM_MODE_LAST
13532 } Elm_Web_Zoom_Mode;
13534 * Opaque handler containing the features (such as statusbar, menubar, etc)
13535 * that are to be set on a newly requested window.
13537 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13539 * Callback type for the create_window hook.
13541 * The function parameters are:
13542 * @li @p data User data pointer set when setting the hook function
13543 * @li @p obj The elm_web object requesting the new window
13544 * @li @p js Set to @c EINA_TRUE if the request was originated from
13545 * JavaScript. @c EINA_FALSE otherwise.
13546 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13547 * the features requested for the new window.
13549 * The returned value of the function should be the @c elm_web widget where
13550 * the request will be loaded. That is, if a new window or tab is created,
13551 * the elm_web widget in it should be returned, and @b NOT the window
13553 * Returning @c NULL should cancel the request.
13555 * @see elm_web_window_create_hook_set()
13557 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13559 * Callback type for the JS alert hook.
13561 * The function parameters are:
13562 * @li @p data User data pointer set when setting the hook function
13563 * @li @p obj The elm_web object requesting the new window
13564 * @li @p message The message to show in the alert dialog
13566 * The function should return the object representing the alert dialog.
13567 * Elm_Web will run a second main loop to handle the dialog and normal
13568 * flow of the application will be restored when the object is deleted, so
13569 * the user should handle the popup properly in order to delete the object
13570 * when the action is finished.
13571 * If the function returns @c NULL the popup will be ignored.
13573 * @see elm_web_dialog_alert_hook_set()
13575 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13577 * Callback type for the JS confirm hook.
13579 * The function parameters are:
13580 * @li @p data User data pointer set when setting the hook function
13581 * @li @p obj The elm_web object requesting the new window
13582 * @li @p message The message to show in the confirm dialog
13583 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13584 * the user selected @c Ok, @c EINA_FALSE otherwise.
13586 * The function should return the object representing the confirm dialog.
13587 * Elm_Web will run a second main loop to handle the dialog and normal
13588 * flow of the application will be restored when the object is deleted, so
13589 * the user should handle the popup properly in order to delete the object
13590 * when the action is finished.
13591 * If the function returns @c NULL the popup will be ignored.
13593 * @see elm_web_dialog_confirm_hook_set()
13595 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13597 * Callback type for the JS prompt hook.
13599 * The function parameters are:
13600 * @li @p data User data pointer set when setting the hook function
13601 * @li @p obj The elm_web object requesting the new window
13602 * @li @p message The message to show in the prompt dialog
13603 * @li @p def_value The default value to present the user in the entry
13604 * @li @p value Pointer where to store the value given by the user. Must
13605 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13606 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13607 * the user selected @c Ok, @c EINA_FALSE otherwise.
13609 * The function should return the object representing the prompt dialog.
13610 * Elm_Web will run a second main loop to handle the dialog and normal
13611 * flow of the application will be restored when the object is deleted, so
13612 * the user should handle the popup properly in order to delete the object
13613 * when the action is finished.
13614 * If the function returns @c NULL the popup will be ignored.
13616 * @see elm_web_dialog_prompt_hook_set()
13618 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13620 * Callback type for the JS file selector hook.
13622 * The function parameters are:
13623 * @li @p data User data pointer set when setting the hook function
13624 * @li @p obj The elm_web object requesting the new window
13625 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13626 * @li @p accept_types Mime types accepted
13627 * @li @p selected Pointer where to store the list of malloc'ed strings
13628 * containing the path to each file selected. Must be @c NULL if the file
13629 * dialog is cancelled
13630 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13631 * the user selected @c Ok, @c EINA_FALSE otherwise.
13633 * The function should return the object representing the file selector
13635 * Elm_Web will run a second main loop to handle the dialog and normal
13636 * flow of the application will be restored when the object is deleted, so
13637 * the user should handle the popup properly in order to delete the object
13638 * when the action is finished.
13639 * If the function returns @c NULL the popup will be ignored.
13641 * @see elm_web_dialog_file selector_hook_set()
13643 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);
13645 * Callback type for the JS console message hook.
13647 * When a console message is added from JavaScript, any set function to the
13648 * console message hook will be called for the user to handle. There is no
13649 * default implementation of this hook.
13651 * The function parameters are:
13652 * @li @p data User data pointer set when setting the hook function
13653 * @li @p obj The elm_web object that originated the message
13654 * @li @p message The message sent
13655 * @li @p line_number The line number
13656 * @li @p source_id Source id
13658 * @see elm_web_console_message_hook_set()
13660 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13662 * Add a new web object to the parent.
13664 * @param parent The parent object.
13665 * @return The new object or NULL if it cannot be created.
13667 * @see elm_web_uri_set()
13668 * @see elm_web_webkit_view_get()
13670 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13673 * Get internal ewk_view object from web object.
13675 * Elementary may not provide some low level features of EWebKit,
13676 * instead of cluttering the API with proxy methods we opted to
13677 * return the internal reference. Be careful using it as it may
13678 * interfere with elm_web behavior.
13680 * @param obj The web object.
13681 * @return The internal ewk_view object or NULL if it does not
13682 * exist. (Failure to create or Elementary compiled without
13685 * @see elm_web_add()
13687 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13690 * Sets the function to call when a new window is requested
13692 * This hook will be called when a request to create a new window is
13693 * issued from the web page loaded.
13694 * There is no default implementation for this feature, so leaving this
13695 * unset or passing @c NULL in @p func will prevent new windows from
13698 * @param obj The web object where to set the hook function
13699 * @param func The hook function to be called when a window is requested
13700 * @param data User data
13702 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13704 * Sets the function to call when an alert dialog
13706 * This hook will be called when a JavaScript alert dialog is requested.
13707 * If no function is set or @c NULL is passed in @p func, the default
13708 * implementation will take place.
13710 * @param obj The web object where to set the hook function
13711 * @param func The callback function to be used
13712 * @param data User data
13714 * @see elm_web_inwin_mode_set()
13716 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13718 * Sets the function to call when an confirm dialog
13720 * This hook will be called when a JavaScript confirm dialog is requested.
13721 * If no function is set or @c NULL is passed in @p func, the default
13722 * implementation will take place.
13724 * @param obj The web object where to set the hook function
13725 * @param func The callback function to be used
13726 * @param data User data
13728 * @see elm_web_inwin_mode_set()
13730 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13732 * Sets the function to call when an prompt dialog
13734 * This hook will be called when a JavaScript prompt dialog is requested.
13735 * If no function is set or @c NULL is passed in @p func, the default
13736 * implementation will take place.
13738 * @param obj The web object where to set the hook function
13739 * @param func The callback function to be used
13740 * @param data User data
13742 * @see elm_web_inwin_mode_set()
13744 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13746 * Sets the function to call when an file selector dialog
13748 * This hook will be called when a JavaScript file selector dialog is
13750 * If no function is set or @c NULL is passed in @p func, the default
13751 * implementation will take place.
13753 * @param obj The web object where to set the hook function
13754 * @param func The callback function to be used
13755 * @param data User data
13757 * @see elm_web_inwin_mode_set()
13759 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13761 * Sets the function to call when a console message is emitted from JS
13763 * This hook will be called when a console message is emitted from
13764 * JavaScript. There is no default implementation for this feature.
13766 * @param obj The web object where to set the hook function
13767 * @param func The callback function to be used
13768 * @param data User data
13770 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13772 * Gets the status of the tab propagation
13774 * @param obj The web object to query
13775 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13777 * @see elm_web_tab_propagate_set()
13779 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13781 * Sets whether to use tab propagation
13783 * If tab propagation is enabled, whenever the user presses the Tab key,
13784 * Elementary will handle it and switch focus to the next widget.
13785 * The default value is disabled, where WebKit will handle the Tab key to
13786 * cycle focus though its internal objects, jumping to the next widget
13787 * only when that cycle ends.
13789 * @param obj The web object
13790 * @param propagate Whether to propagate Tab keys to Elementary or not
13792 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13794 * Sets the URI for the web object
13796 * It must be a full URI, with resource included, in the form
13797 * http://www.enlightenment.org or file:///tmp/something.html
13799 * @param obj The web object
13800 * @param uri The URI to set
13801 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13803 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13805 * Gets the current URI for the object
13807 * The returned string must not be freed and is guaranteed to be
13810 * @param obj The web object
13811 * @return A stringshared internal string with the current URI, or NULL on
13814 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13816 * Gets the current title
13818 * The returned string must not be freed and is guaranteed to be
13821 * @param obj The web object
13822 * @return A stringshared internal string with the current title, or NULL on
13825 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13827 * Sets the background color to be used by the web object
13829 * This is the color that will be used by default when the loaded page
13830 * does not set it's own. Color values are pre-multiplied.
13832 * @param obj The web object
13833 * @param r Red component
13834 * @param g Green component
13835 * @param b Blue component
13836 * @param a Alpha component
13838 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13840 * Gets the background color to be used by the web object
13842 * This is the color that will be used by default when the loaded page
13843 * does not set it's own. Color values are pre-multiplied.
13845 * @param obj The web object
13846 * @param r Red component
13847 * @param g Green component
13848 * @param b Blue component
13849 * @param a Alpha component
13851 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13853 * Gets a copy of the currently selected text
13855 * The string returned must be freed by the user when it's done with it.
13857 * @param obj The web object
13858 * @return A newly allocated string, or NULL if nothing is selected or an
13861 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13863 * Tells the web object which index in the currently open popup was selected
13865 * When the user handles the popup creation from the "popup,created" signal,
13866 * it needs to tell the web object which item was selected by calling this
13867 * function with the index corresponding to the item.
13869 * @param obj The web object
13870 * @param index The index selected
13872 * @see elm_web_popup_destroy()
13874 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13876 * Dismisses an open dropdown popup
13878 * When the popup from a dropdown widget is to be dismissed, either after
13879 * selecting an option or to cancel it, this function must be called, which
13880 * will later emit an "popup,willdelete" signal to notify the user that
13881 * any memory and objects related to this popup can be freed.
13883 * @param obj The web object
13884 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13885 * if there was no menu to destroy
13887 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13889 * Searches the given string in a document.
13891 * @param obj The web object where to search the text
13892 * @param string String to search
13893 * @param case_sensitive If search should be case sensitive or not
13894 * @param forward If search is from cursor and on or backwards
13895 * @param wrap If search should wrap at the end
13897 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13900 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13902 * Marks matches of the given string in a document.
13904 * @param obj The web object where to search text
13905 * @param string String to match
13906 * @param case_sensitive If match should be case sensitive or not
13907 * @param highlight If matches should be highlighted
13908 * @param limit Maximum amount of matches, or zero to unlimited
13910 * @return number of matched @a string
13912 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13914 * Clears all marked matches in the document
13916 * @param obj The web object
13918 * @return EINA_TRUE on success, EINA_FALSE otherwise
13920 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13922 * Sets whether to highlight the matched marks
13924 * If enabled, marks set with elm_web_text_matches_mark() will be
13927 * @param obj The web object
13928 * @param highlight Whether to highlight the marks or not
13930 * @return EINA_TRUE on success, EINA_FALSE otherwise
13932 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13934 * Gets whether highlighting marks is enabled
13936 * @param The web object
13938 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13941 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13943 * Gets the overall loading progress of the page
13945 * Returns the estimated loading progress of the page, with a value between
13946 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13947 * included in the page.
13949 * @param The web object
13951 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13954 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13956 * Stops loading the current page
13958 * Cancels the loading of the current page in the web object. This will
13959 * cause a "load,error" signal to be emitted, with the is_cancellation
13960 * flag set to EINA_TRUE.
13962 * @param obj The web object
13964 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13966 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13968 * Requests a reload of the current document in the object
13970 * @param obj The web object
13972 * @return EINA_TRUE on success, EINA_FALSE otherwise
13974 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13976 * Requests a reload of the current document, avoiding any existing caches
13978 * @param obj The web object
13980 * @return EINA_TRUE on success, EINA_FALSE otherwise
13982 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13984 * Goes back one step in the browsing history
13986 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13988 * @param obj The web object
13990 * @return EINA_TRUE on success, EINA_FALSE otherwise
13992 * @see elm_web_history_enable_set()
13993 * @see elm_web_back_possible()
13994 * @see elm_web_forward()
13995 * @see elm_web_navigate()
13997 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13999 * Goes forward one step in the browsing history
14001 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14003 * @param obj The web object
14005 * @return EINA_TRUE on success, EINA_FALSE otherwise
14007 * @see elm_web_history_enable_set()
14008 * @see elm_web_forward_possible()
14009 * @see elm_web_back()
14010 * @see elm_web_navigate()
14012 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14014 * Jumps the given number of steps in the browsing history
14016 * The @p steps value can be a negative integer to back in history, or a
14017 * positive to move forward.
14019 * @param obj The web object
14020 * @param steps The number of steps to jump
14022 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14023 * history exists to jump the given number of steps
14025 * @see elm_web_history_enable_set()
14026 * @see elm_web_navigate_possible()
14027 * @see elm_web_back()
14028 * @see elm_web_forward()
14030 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14032 * Queries whether it's possible to go back in history
14034 * @param obj The web object
14036 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14039 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14041 * Queries whether it's possible to go forward in history
14043 * @param obj The web object
14045 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14048 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14050 * Queries whether it's possible to jump the given number of steps
14052 * The @p steps value can be a negative integer to back in history, or a
14053 * positive to move forward.
14055 * @param obj The web object
14056 * @param steps The number of steps to check for
14058 * @return EINA_TRUE if enough history exists to perform the given jump,
14059 * EINA_FALSE otherwise
14061 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14063 * Gets whether browsing history is enabled for the given object
14065 * @param obj The web object
14067 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14069 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14071 * Enables or disables the browsing history
14073 * @param obj The web object
14074 * @param enable Whether to enable or disable the browsing history
14076 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14078 * Sets the zoom level of the web object
14080 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14081 * values meaning zoom in and lower meaning zoom out. This function will
14082 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14083 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14085 * @param obj The web object
14086 * @param zoom The zoom level to set
14088 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14090 * Gets the current zoom level set on the web object
14092 * Note that this is the zoom level set on the web object and not that
14093 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14094 * the two zoom levels should match, but for the other two modes the
14095 * Webkit zoom is calculated internally to match the chosen mode without
14096 * changing the zoom level set for the web object.
14098 * @param obj The web object
14100 * @return The zoom level set on the object
14102 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14104 * Sets the zoom mode to use
14106 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14107 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14109 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14110 * with the elm_web_zoom_set() function.
14111 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14112 * make sure the entirety of the web object's contents are shown.
14113 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14114 * fit the contents in the web object's size, without leaving any space
14117 * @param obj The web object
14118 * @param mode The mode to set
14120 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14122 * Gets the currently set zoom mode
14124 * @param obj The web object
14126 * @return The current zoom mode set for the object, or
14127 * ::ELM_WEB_ZOOM_MODE_LAST on error
14129 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14131 * Shows the given region in the web object
14133 * @param obj The web object
14134 * @param x The x coordinate of the region to show
14135 * @param y The y coordinate of the region to show
14136 * @param w The width of the region to show
14137 * @param h The height of the region to show
14139 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14141 * Brings in the region to the visible area
14143 * Like elm_web_region_show(), but it animates the scrolling of the object
14146 * @param obj The web object
14147 * @param x The x coordinate of the region to show
14148 * @param y The y coordinate of the region to show
14149 * @param w The width of the region to show
14150 * @param h The height of the region to show
14152 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14154 * Sets the default dialogs to use an Inwin instead of a normal window
14156 * If set, then the default implementation for the JavaScript dialogs and
14157 * file selector will be opened in an Inwin. Otherwise they will use a
14158 * normal separated window.
14160 * @param obj The web object
14161 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14163 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14165 * Gets whether Inwin mode is set for the current object
14167 * @param obj The web object
14169 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14171 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14173 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14174 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14175 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);
14176 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14183 * @defgroup Hoversel Hoversel
14185 * @image html img/widget/hoversel/preview-00.png
14186 * @image latex img/widget/hoversel/preview-00.eps
14188 * A hoversel is a button that pops up a list of items (automatically
14189 * choosing the direction to display) that have a label and, optionally, an
14190 * icon to select from. It is a convenience widget to avoid the need to do
14191 * all the piecing together yourself. It is intended for a small number of
14192 * items in the hoversel menu (no more than 8), though is capable of many
14195 * Signals that you can add callbacks for are:
14196 * "clicked" - the user clicked the hoversel button and popped up the sel
14197 * "selected" - an item in the hoversel list is selected. event_info is the item
14198 * "dismissed" - the hover is dismissed
14200 * See @ref tutorial_hoversel for an example.
14203 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14205 * @brief Add a new Hoversel object
14207 * @param parent The parent object
14208 * @return The new object or NULL if it cannot be created
14210 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14212 * @brief This sets the hoversel to expand horizontally.
14214 * @param obj The hoversel object
14215 * @param horizontal If true, the hover will expand horizontally to the
14218 * @note The initial button will display horizontally regardless of this
14221 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14223 * @brief This returns whether the hoversel is set to expand horizontally.
14225 * @param obj The hoversel object
14226 * @return If true, the hover will expand horizontally to the right.
14228 * @see elm_hoversel_horizontal_set()
14230 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14232 * @brief Set the Hover parent
14234 * @param obj The hoversel object
14235 * @param parent The parent to use
14237 * Sets the hover parent object, the area that will be darkened when the
14238 * hoversel is clicked. Should probably be the window that the hoversel is
14239 * in. See @ref Hover objects for more information.
14241 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14243 * @brief Get the Hover parent
14245 * @param obj The hoversel object
14246 * @return The used parent
14248 * Gets the hover parent object.
14250 * @see elm_hoversel_hover_parent_set()
14252 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14254 * @brief Set the hoversel button label
14256 * @param obj The hoversel object
14257 * @param label The label text.
14259 * This sets the label of the button that is always visible (before it is
14260 * clicked and expanded).
14262 * @deprecated elm_object_text_set()
14264 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14266 * @brief Get the hoversel button label
14268 * @param obj The hoversel object
14269 * @return The label text.
14271 * @deprecated elm_object_text_get()
14273 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14275 * @brief Set the icon of the hoversel button
14277 * @param obj The hoversel object
14278 * @param icon The icon object
14280 * Sets the icon of the button that is always visible (before it is clicked
14281 * and expanded). Once the icon object is set, a previously set one will be
14282 * deleted, if you want to keep that old content object, use the
14283 * elm_hoversel_icon_unset() function.
14285 * @see elm_object_content_set() for the button widget
14287 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14289 * @brief Get the icon of the hoversel button
14291 * @param obj The hoversel object
14292 * @return The icon object
14294 * Get the icon of the button that is always visible (before it is clicked
14295 * and expanded). Also see elm_object_content_get() for the button widget.
14297 * @see elm_hoversel_icon_set()
14299 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14301 * @brief Get and unparent the icon of the hoversel button
14303 * @param obj The hoversel object
14304 * @return The icon object that was being used
14306 * Unparent and return the icon of the button that is always visible
14307 * (before it is clicked and expanded).
14309 * @see elm_hoversel_icon_set()
14310 * @see elm_object_content_unset() for the button widget
14312 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14314 * @brief This triggers the hoversel popup from code, the same as if the user
14315 * had clicked the button.
14317 * @param obj The hoversel object
14319 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14321 * @brief This dismisses the hoversel popup as if the user had clicked
14322 * outside the hover.
14324 * @param obj The hoversel object
14326 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14328 * @brief Returns whether the hoversel is expanded.
14330 * @param obj The hoversel object
14331 * @return This will return EINA_TRUE if the hoversel is expanded or
14332 * EINA_FALSE if it is not expanded.
14334 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14336 * @brief This will remove all the children items from the hoversel.
14338 * @param obj The hoversel object
14340 * @warning Should @b not be called while the hoversel is active; use
14341 * elm_hoversel_expanded_get() to check first.
14343 * @see elm_hoversel_item_del_cb_set()
14344 * @see elm_hoversel_item_del()
14346 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14348 * @brief Get the list of items within the given hoversel.
14350 * @param obj The hoversel object
14351 * @return Returns a list of Elm_Hoversel_Item*
14353 * @see elm_hoversel_item_add()
14355 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14357 * @brief Add an item to the hoversel button
14359 * @param obj The hoversel object
14360 * @param label The text label to use for the item (NULL if not desired)
14361 * @param icon_file An image file path on disk to use for the icon or standard
14362 * icon name (NULL if not desired)
14363 * @param icon_type The icon type if relevant
14364 * @param func Convenience function to call when this item is selected
14365 * @param data Data to pass to item-related functions
14366 * @return A handle to the item added.
14368 * This adds an item to the hoversel to show when it is clicked. Note: if you
14369 * need to use an icon from an edje file then use
14370 * elm_hoversel_item_icon_set() right after the this function, and set
14371 * icon_file to NULL here.
14373 * For more information on what @p icon_file and @p icon_type are see the
14374 * @ref Icon "icon documentation".
14376 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);
14378 * @brief Delete an item from the hoversel
14380 * @param item The item to delete
14382 * This deletes the item from the hoversel (should not be called while the
14383 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14385 * @see elm_hoversel_item_add()
14386 * @see elm_hoversel_item_del_cb_set()
14388 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14390 * @brief Set the function to be called when an item from the hoversel is
14393 * @param item The item to set the callback on
14394 * @param func The function called
14396 * That function will receive these parameters:
14397 * @li void *item_data
14398 * @li Evas_Object *the_item_object
14399 * @li Elm_Hoversel_Item *the_object_struct
14401 * @see elm_hoversel_item_add()
14403 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14405 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14406 * that will be passed to associated function callbacks.
14408 * @param item The item to get the data from
14409 * @return The data pointer set with elm_hoversel_item_add()
14411 * @see elm_hoversel_item_add()
14413 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14415 * @brief This returns the label text of the given hoversel item.
14417 * @param item The item to get the label
14418 * @return The label text of the hoversel item
14420 * @see elm_hoversel_item_add()
14422 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14424 * @brief This sets the icon for the given hoversel item.
14426 * @param item The item to set the icon
14427 * @param icon_file An image file path on disk to use for the icon or standard
14429 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14430 * to NULL if the icon is not an edje file
14431 * @param icon_type The icon type
14433 * The icon can be loaded from the standard set, from an image file, or from
14436 * @see elm_hoversel_item_add()
14438 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);
14440 * @brief Get the icon object of the hoversel item
14442 * @param item The item to get the icon from
14443 * @param icon_file The image file path on disk used for the icon or standard
14445 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14446 * if the icon is not an edje file
14447 * @param icon_type The icon type
14449 * @see elm_hoversel_item_icon_set()
14450 * @see elm_hoversel_item_add()
14452 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);
14458 * @defgroup Toolbar Toolbar
14459 * @ingroup Elementary
14461 * @image html img/widget/toolbar/preview-00.png
14462 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14464 * @image html img/toolbar.png
14465 * @image latex img/toolbar.eps width=\textwidth
14467 * A toolbar is a widget that displays a list of items inside
14468 * a box. It can be scrollable, show a menu with items that don't fit
14469 * to toolbar size or even crop them.
14471 * Only one item can be selected at a time.
14473 * Items can have multiple states, or show menus when selected by the user.
14475 * Smart callbacks one can listen to:
14476 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14477 * - "language,changed" - when the program language changes
14479 * Available styles for it:
14481 * - @c "transparent" - no background or shadow, just show the content
14483 * List of examples:
14484 * @li @ref toolbar_example_01
14485 * @li @ref toolbar_example_02
14486 * @li @ref toolbar_example_03
14490 * @addtogroup Toolbar
14495 * @enum _Elm_Toolbar_Shrink_Mode
14496 * @typedef Elm_Toolbar_Shrink_Mode
14498 * Set toolbar's items display behavior, it can be scrollabel,
14499 * show a menu with exceeding items, or simply hide them.
14501 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14504 * Values <b> don't </b> work as bitmask, only one can be choosen.
14506 * @see elm_toolbar_mode_shrink_set()
14507 * @see elm_toolbar_mode_shrink_get()
14511 typedef enum _Elm_Toolbar_Shrink_Mode
14513 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14514 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14515 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14516 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14517 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14518 } Elm_Toolbar_Shrink_Mode;
14520 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
14522 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(). */
14525 * Add a new toolbar widget to the given parent Elementary
14526 * (container) object.
14528 * @param parent The parent object.
14529 * @return a new toolbar widget handle or @c NULL, on errors.
14531 * This function inserts a new toolbar widget on the canvas.
14535 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14538 * Set the icon size, in pixels, to be used by toolbar items.
14540 * @param obj The toolbar object
14541 * @param icon_size The icon size in pixels
14543 * @note Default value is @c 32. It reads value from elm config.
14545 * @see elm_toolbar_icon_size_get()
14549 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14552 * Get the icon size, in pixels, to be used by toolbar items.
14554 * @param obj The toolbar object.
14555 * @return The icon size in pixels.
14557 * @see elm_toolbar_icon_size_set() for details.
14561 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14564 * Sets icon lookup order, for toolbar items' icons.
14566 * @param obj The toolbar object.
14567 * @param order The icon lookup order.
14569 * Icons added before calling this function will not be affected.
14570 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14572 * @see elm_toolbar_icon_order_lookup_get()
14576 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14579 * Gets the icon lookup order.
14581 * @param obj The toolbar object.
14582 * @return The icon lookup order.
14584 * @see elm_toolbar_icon_order_lookup_set() for details.
14588 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14591 * Set whether the toolbar should always have an item selected.
14593 * @param obj The toolbar object.
14594 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14597 * This will cause the toolbar to always have an item selected, and clicking
14598 * the selected item will not cause a selected event to be emitted. Enabling this mode
14599 * will immediately select the first toolbar item.
14601 * Always-selected is disabled by default.
14603 * @see elm_toolbar_always_select_mode_get().
14607 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14610 * Get whether the toolbar should always have an item selected.
14612 * @param obj The toolbar object.
14613 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14614 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14616 * @see elm_toolbar_always_select_mode_set() for details.
14620 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14623 * Set whether the toolbar items' should be selected by the user or not.
14625 * @param obj The toolbar object.
14626 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14629 * This will turn off the ability to select items entirely and they will
14630 * neither appear selected nor emit selected signals. The clicked
14631 * callback function will still be called.
14633 * Selection is enabled by default.
14635 * @see elm_toolbar_no_select_mode_get().
14639 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14642 * Set whether the toolbar items' should be selected by the user or not.
14644 * @param obj The toolbar object.
14645 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14646 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14648 * @see elm_toolbar_no_select_mode_set() for details.
14652 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14655 * Append item to the toolbar.
14657 * @param obj The toolbar object.
14658 * @param icon A string with icon name or the absolute path of an image file.
14659 * @param label The label of the item.
14660 * @param func The function to call when the item is clicked.
14661 * @param data The data to associate with the item for related callbacks.
14662 * @return The created item or @c NULL upon failure.
14664 * A new item will be created and appended to the toolbar, i.e., will
14665 * be set as @b last item.
14667 * Items created with this method can be deleted with
14668 * elm_toolbar_item_del().
14670 * Associated @p data can be properly freed when item is deleted if a
14671 * callback function is set with elm_toolbar_item_del_cb_set().
14673 * If a function is passed as argument, it will be called everytime this item
14674 * is selected, i.e., the user clicks over an unselected item.
14675 * If such function isn't needed, just passing
14676 * @c NULL as @p func is enough. The same should be done for @p data.
14678 * Toolbar will load icon image from fdo or current theme.
14679 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14680 * If an absolute path is provided it will load it direct from a file.
14682 * @see elm_toolbar_item_icon_set()
14683 * @see elm_toolbar_item_del()
14684 * @see elm_toolbar_item_del_cb_set()
14688 EAPI Elm_Toolbar_Item *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14691 * Prepend item to the toolbar.
14693 * @param obj The toolbar object.
14694 * @param icon A string with icon name or the absolute path of an image file.
14695 * @param label The label of the item.
14696 * @param func The function to call when the item is clicked.
14697 * @param data The data to associate with the item for related callbacks.
14698 * @return The created item or @c NULL upon failure.
14700 * A new item will be created and prepended to the toolbar, i.e., will
14701 * be set as @b first item.
14703 * Items created with this method can be deleted with
14704 * elm_toolbar_item_del().
14706 * Associated @p data can be properly freed when item is deleted if a
14707 * callback function is set with elm_toolbar_item_del_cb_set().
14709 * If a function is passed as argument, it will be called everytime this item
14710 * is selected, i.e., the user clicks over an unselected item.
14711 * If such function isn't needed, just passing
14712 * @c NULL as @p func is enough. The same should be done for @p data.
14714 * Toolbar will load icon image from fdo or current theme.
14715 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14716 * If an absolute path is provided it will load it direct from a file.
14718 * @see elm_toolbar_item_icon_set()
14719 * @see elm_toolbar_item_del()
14720 * @see elm_toolbar_item_del_cb_set()
14724 EAPI Elm_Toolbar_Item *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14727 * Insert a new item into the toolbar object before item @p before.
14729 * @param obj The toolbar object.
14730 * @param before The toolbar item to insert before.
14731 * @param icon A string with icon name or the absolute path of an image file.
14732 * @param label The label of the item.
14733 * @param func The function to call when the item is clicked.
14734 * @param data The data to associate with the item for related callbacks.
14735 * @return The created item or @c NULL upon failure.
14737 * A new item will be created and added to the toolbar. Its position in
14738 * this toolbar will be just before item @p before.
14740 * Items created with this method can be deleted with
14741 * elm_toolbar_item_del().
14743 * Associated @p data can be properly freed when item is deleted if a
14744 * callback function is set with elm_toolbar_item_del_cb_set().
14746 * If a function is passed as argument, it will be called everytime this item
14747 * is selected, i.e., the user clicks over an unselected item.
14748 * If such function isn't needed, just passing
14749 * @c NULL as @p func is enough. The same should be done for @p data.
14751 * Toolbar will load icon image from fdo or current theme.
14752 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14753 * If an absolute path is provided it will load it direct from a file.
14755 * @see elm_toolbar_item_icon_set()
14756 * @see elm_toolbar_item_del()
14757 * @see elm_toolbar_item_del_cb_set()
14761 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Toolbar_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14764 * Insert a new item into the toolbar object after item @p after.
14766 * @param obj The toolbar object.
14767 * @param after The toolbar item to insert after.
14768 * @param icon A string with icon name or the absolute path of an image file.
14769 * @param label The label of the item.
14770 * @param func The function to call when the item is clicked.
14771 * @param data The data to associate with the item for related callbacks.
14772 * @return The created item or @c NULL upon failure.
14774 * A new item will be created and added to the toolbar. Its position in
14775 * this toolbar will be just after item @p after.
14777 * Items created with this method can be deleted with
14778 * elm_toolbar_item_del().
14780 * Associated @p data can be properly freed when item is deleted if a
14781 * callback function is set with elm_toolbar_item_del_cb_set().
14783 * If a function is passed as argument, it will be called everytime this item
14784 * is selected, i.e., the user clicks over an unselected item.
14785 * If such function isn't needed, just passing
14786 * @c NULL as @p func is enough. The same should be done for @p data.
14788 * Toolbar will load icon image from fdo or current theme.
14789 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14790 * If an absolute path is provided it will load it direct from a file.
14792 * @see elm_toolbar_item_icon_set()
14793 * @see elm_toolbar_item_del()
14794 * @see elm_toolbar_item_del_cb_set()
14798 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Toolbar_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14801 * Get the first item in the given toolbar widget's list of
14804 * @param obj The toolbar object
14805 * @return The first item or @c NULL, if it has no items (and on
14808 * @see elm_toolbar_item_append()
14809 * @see elm_toolbar_last_item_get()
14813 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14816 * Get the last item in the given toolbar widget's list of
14819 * @param obj The toolbar object
14820 * @return The last item or @c NULL, if it has no items (and on
14823 * @see elm_toolbar_item_prepend()
14824 * @see elm_toolbar_first_item_get()
14828 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14831 * Get the item after @p item in toolbar.
14833 * @param item The toolbar item.
14834 * @return The item after @p item, or @c NULL if none or on failure.
14836 * @note If it is the last item, @c NULL will be returned.
14838 * @see elm_toolbar_item_append()
14842 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14845 * Get the item before @p item in toolbar.
14847 * @param item The toolbar item.
14848 * @return The item before @p item, or @c NULL if none or on failure.
14850 * @note If it is the first item, @c NULL will be returned.
14852 * @see elm_toolbar_item_prepend()
14856 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14859 * Get the toolbar object from an item.
14861 * @param item The item.
14862 * @return The toolbar object.
14864 * This returns the toolbar object itself that an item belongs to.
14868 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14871 * Set the priority of a toolbar item.
14873 * @param item The toolbar item.
14874 * @param priority The item priority. The default is zero.
14876 * This is used only when the toolbar shrink mode is set to
14877 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14878 * When space is less than required, items with low priority
14879 * will be removed from the toolbar and added to a dynamically-created menu,
14880 * while items with higher priority will remain on the toolbar,
14881 * with the same order they were added.
14883 * @see elm_toolbar_item_priority_get()
14887 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14890 * Get the priority of a toolbar item.
14892 * @param item The toolbar item.
14893 * @return The @p item priority, or @c 0 on failure.
14895 * @see elm_toolbar_item_priority_set() for details.
14899 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14902 * Get the label of item.
14904 * @param item The item of toolbar.
14905 * @return The label of item.
14907 * The return value is a pointer to the label associated to @p item when
14908 * it was created, with function elm_toolbar_item_append() or similar,
14910 * with function elm_toolbar_item_label_set. If no label
14911 * was passed as argument, it will return @c NULL.
14913 * @see elm_toolbar_item_label_set() for more details.
14914 * @see elm_toolbar_item_append()
14918 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14921 * Set the label of item.
14923 * @param item The item of toolbar.
14924 * @param text The label of item.
14926 * The label to be displayed by the item.
14927 * Label will be placed at icons bottom (if set).
14929 * If a label was passed as argument on item creation, with function
14930 * elm_toolbar_item_append() or similar, it will be already
14931 * displayed by the item.
14933 * @see elm_toolbar_item_label_get()
14934 * @see elm_toolbar_item_append()
14938 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14941 * Return the data associated with a given toolbar widget item.
14943 * @param item The toolbar widget item handle.
14944 * @return The data associated with @p item.
14946 * @see elm_toolbar_item_data_set()
14950 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14953 * Set the data associated with a given toolbar widget item.
14955 * @param item The toolbar widget item handle.
14956 * @param data The new data pointer to set to @p item.
14958 * This sets new item data on @p item.
14960 * @warning The old data pointer won't be touched by this function, so
14961 * the user had better to free that old data himself/herself.
14965 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14968 * Returns a pointer to a toolbar item by its label.
14970 * @param obj The toolbar object.
14971 * @param label The label of the item to find.
14973 * @return The pointer to the toolbar item matching @p label or @c NULL
14978 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14981 * Get whether the @p item is selected or not.
14983 * @param item The toolbar item.
14984 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14985 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14987 * @see elm_toolbar_selected_item_set() for details.
14988 * @see elm_toolbar_item_selected_get()
14992 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14995 * Set the selected state of an item.
14997 * @param item The toolbar item
14998 * @param selected The selected state
15000 * This sets the selected state of the given item @p it.
15001 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15003 * If a new item is selected the previosly selected will be unselected.
15004 * Previoulsy selected item can be get with function
15005 * elm_toolbar_selected_item_get().
15007 * Selected items will be highlighted.
15009 * @see elm_toolbar_item_selected_get()
15010 * @see elm_toolbar_selected_item_get()
15014 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15017 * Get the selected item.
15019 * @param obj The toolbar object.
15020 * @return The selected toolbar item.
15022 * The selected item can be unselected with function
15023 * elm_toolbar_item_selected_set().
15025 * The selected item always will be highlighted on toolbar.
15027 * @see elm_toolbar_selected_items_get()
15031 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15034 * Set the icon associated with @p item.
15036 * @param obj The parent of this item.
15037 * @param item The toolbar item.
15038 * @param icon A string with icon name or the absolute path of an image file.
15040 * Toolbar will load icon image from fdo or current theme.
15041 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15042 * If an absolute path is provided it will load it direct from a file.
15044 * @see elm_toolbar_icon_order_lookup_set()
15045 * @see elm_toolbar_icon_order_lookup_get()
15049 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15052 * Get the string used to set the icon of @p item.
15054 * @param item The toolbar item.
15055 * @return The string associated with the icon object.
15057 * @see elm_toolbar_item_icon_set() for details.
15061 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15064 * Get the object of @p item.
15066 * @param item The toolbar item.
15067 * @return The object
15071 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15074 * Get the icon object of @p item.
15076 * @param item The toolbar item.
15077 * @return The icon object
15079 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15083 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15086 * Set the icon associated with @p item to an image in a binary buffer.
15088 * @param item The toolbar item.
15089 * @param img The binary data that will be used as an image
15090 * @param size The size of binary data @p img
15091 * @param format Optional format of @p img to pass to the image loader
15092 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15094 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15096 * @note The icon image set by this function can be changed by
15097 * elm_toolbar_item_icon_set().
15101 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15104 * Delete them item from the toolbar.
15106 * @param item The item of toolbar to be deleted.
15108 * @see elm_toolbar_item_append()
15109 * @see elm_toolbar_item_del_cb_set()
15113 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15116 * Set the function called when a toolbar item is freed.
15118 * @param item The item to set the callback on.
15119 * @param func The function called.
15121 * If there is a @p func, then it will be called prior item's memory release.
15122 * That will be called with the following arguments:
15124 * @li item's Evas object;
15127 * This way, a data associated to a toolbar item could be properly freed.
15131 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15134 * Get a value whether toolbar item is disabled or not.
15136 * @param item The item.
15137 * @return The disabled state.
15139 * @see elm_toolbar_item_disabled_set() for more details.
15143 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15146 * Sets the disabled/enabled state of a toolbar item.
15148 * @param item The item.
15149 * @param disabled The disabled state.
15151 * A disabled item cannot be selected or unselected. It will also
15152 * change its appearance (generally greyed out). This sets the
15153 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15158 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15161 * Set or unset item as a separator.
15163 * @param item The toolbar item.
15164 * @param setting @c EINA_TRUE to set item @p item as separator or
15165 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15167 * Items aren't set as separator by default.
15169 * If set as separator it will display separator theme, so won't display
15172 * @see elm_toolbar_item_separator_get()
15176 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15179 * Get a value whether item is a separator or not.
15181 * @param item The toolbar item.
15182 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15183 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15185 * @see elm_toolbar_item_separator_set() for details.
15189 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15192 * Set the shrink state of toolbar @p obj.
15194 * @param obj The toolbar object.
15195 * @param shrink_mode Toolbar's items display behavior.
15197 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15198 * but will enforce a minimun size so all the items will fit, won't scroll
15199 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15200 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15201 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15205 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15208 * Get the shrink mode of toolbar @p obj.
15210 * @param obj The toolbar object.
15211 * @return Toolbar's items display behavior.
15213 * @see elm_toolbar_mode_shrink_set() for details.
15217 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15220 * Enable/disable homogenous mode.
15222 * @param obj The toolbar object
15223 * @param homogeneous Assume the items within the toolbar are of the
15224 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15226 * This will enable the homogeneous mode where items are of the same size.
15227 * @see elm_toolbar_homogeneous_get()
15231 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15234 * Get whether the homogenous mode is enabled.
15236 * @param obj The toolbar object.
15237 * @return Assume the items within the toolbar are of the same height
15238 * and width (EINA_TRUE = on, EINA_FALSE = off).
15240 * @see elm_toolbar_homogeneous_set()
15244 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15247 * Enable/disable homogenous mode.
15249 * @param obj The toolbar object
15250 * @param homogeneous Assume the items within the toolbar are of the
15251 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15253 * This will enable the homogeneous mode where items are of the same size.
15254 * @see elm_toolbar_homogeneous_get()
15256 * @deprecated use elm_toolbar_homogeneous_set() instead.
15260 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15263 * Get whether the homogenous mode is enabled.
15265 * @param obj The toolbar object.
15266 * @return Assume the items within the toolbar are of the same height
15267 * and width (EINA_TRUE = on, EINA_FALSE = off).
15269 * @see elm_toolbar_homogeneous_set()
15270 * @deprecated use elm_toolbar_homogeneous_get() instead.
15274 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15277 * Set the parent object of the toolbar items' menus.
15279 * @param obj The toolbar object.
15280 * @param parent The parent of the menu objects.
15282 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15284 * For more details about setting the parent for toolbar menus, see
15285 * elm_menu_parent_set().
15287 * @see elm_menu_parent_set() for details.
15288 * @see elm_toolbar_item_menu_set() for details.
15292 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15295 * Get the parent object of the toolbar items' menus.
15297 * @param obj The toolbar object.
15298 * @return The parent of the menu objects.
15300 * @see elm_toolbar_menu_parent_set() for details.
15304 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15307 * Set the alignment of the items.
15309 * @param obj The toolbar object.
15310 * @param align The new alignment, a float between <tt> 0.0 </tt>
15311 * and <tt> 1.0 </tt>.
15313 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15314 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15317 * Centered items by default.
15319 * @see elm_toolbar_align_get()
15323 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15326 * Get the alignment of the items.
15328 * @param obj The toolbar object.
15329 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15332 * @see elm_toolbar_align_set() for details.
15336 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15339 * Set whether the toolbar item opens a menu.
15341 * @param item The toolbar item.
15342 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15344 * A toolbar item can be set to be a menu, using this function.
15346 * Once it is set to be a menu, it can be manipulated through the
15347 * menu-like function elm_toolbar_menu_parent_set() and the other
15348 * elm_menu functions, using the Evas_Object @c menu returned by
15349 * elm_toolbar_item_menu_get().
15351 * So, items to be displayed in this item's menu should be added with
15352 * elm_menu_item_add().
15354 * The following code exemplifies the most basic usage:
15356 * tb = elm_toolbar_add(win)
15357 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15358 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15359 * elm_toolbar_menu_parent_set(tb, win);
15360 * menu = elm_toolbar_item_menu_get(item);
15361 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15362 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15366 * @see elm_toolbar_item_menu_get()
15370 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15373 * Get toolbar item's menu.
15375 * @param item The toolbar item.
15376 * @return Item's menu object or @c NULL on failure.
15378 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15379 * this function will set it.
15381 * @see elm_toolbar_item_menu_set() for details.
15385 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15388 * Add a new state to @p item.
15390 * @param item The item.
15391 * @param icon A string with icon name or the absolute path of an image file.
15392 * @param label The label of the new state.
15393 * @param func The function to call when the item is clicked when this
15394 * state is selected.
15395 * @param data The data to associate with the state.
15396 * @return The toolbar item state, or @c NULL upon failure.
15398 * Toolbar will load icon image from fdo or current theme.
15399 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15400 * If an absolute path is provided it will load it direct from a file.
15402 * States created with this function can be removed with
15403 * elm_toolbar_item_state_del().
15405 * @see elm_toolbar_item_state_del()
15406 * @see elm_toolbar_item_state_sel()
15407 * @see elm_toolbar_item_state_get()
15411 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Toolbar_Item *item, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15414 * Delete a previoulsy added state to @p item.
15416 * @param item The toolbar item.
15417 * @param state The state to be deleted.
15418 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15420 * @see elm_toolbar_item_state_add()
15422 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15425 * Set @p state as the current state of @p it.
15427 * @param it The item.
15428 * @param state The state to use.
15429 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15431 * If @p state is @c NULL, it won't select any state and the default item's
15432 * icon and label will be used. It's the same behaviour than
15433 * elm_toolbar_item_state_unser().
15435 * @see elm_toolbar_item_state_unset()
15439 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15442 * Unset the state of @p it.
15444 * @param it The item.
15446 * The default icon and label from this item will be displayed.
15448 * @see elm_toolbar_item_state_set() for more details.
15452 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15455 * Get the current state of @p it.
15457 * @param item The item.
15458 * @return The selected state or @c NULL if none is selected or on failure.
15460 * @see elm_toolbar_item_state_set() for details.
15461 * @see elm_toolbar_item_state_unset()
15462 * @see elm_toolbar_item_state_add()
15466 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15469 * Get the state after selected state in toolbar's @p item.
15471 * @param it The toolbar item to change state.
15472 * @return The state after current state, or @c NULL on failure.
15474 * If last state is selected, this function will return first state.
15476 * @see elm_toolbar_item_state_set()
15477 * @see elm_toolbar_item_state_add()
15481 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15484 * Get the state before selected state in toolbar's @p item.
15486 * @param it The toolbar item to change state.
15487 * @return The state before current state, or @c NULL on failure.
15489 * If first state is selected, this function will return last state.
15491 * @see elm_toolbar_item_state_set()
15492 * @see elm_toolbar_item_state_add()
15496 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15499 * Set the text to be shown in a given toolbar item's tooltips.
15501 * @param item Target item.
15502 * @param text The text to set in the content.
15504 * Setup the text as tooltip to object. The item can have only one tooltip,
15505 * so any previous tooltip data - set with this function or
15506 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15508 * @see elm_object_tooltip_text_set() for more details.
15512 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15515 * Set the content to be shown in the tooltip item.
15517 * Setup the tooltip to item. The item can have only one tooltip,
15518 * so any previous tooltip data is removed. @p func(with @p data) will
15519 * be called every time that need show the tooltip and it should
15520 * return a valid Evas_Object. This object is then managed fully by
15521 * tooltip system and is deleted when the tooltip is gone.
15523 * @param item the toolbar item being attached a tooltip.
15524 * @param func the function used to create the tooltip contents.
15525 * @param data what to provide to @a func as callback data/context.
15526 * @param del_cb called when data is not needed anymore, either when
15527 * another callback replaces @a func, the tooltip is unset with
15528 * elm_toolbar_item_tooltip_unset() or the owner @a item
15529 * dies. This callback receives as the first parameter the
15530 * given @a data, and @c event_info is the item.
15532 * @see elm_object_tooltip_content_cb_set() for more details.
15536 EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Toolbar_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
15539 * Unset tooltip from item.
15541 * @param item toolbar item to remove previously set tooltip.
15543 * Remove tooltip from item. The callback provided as del_cb to
15544 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15545 * it is not used anymore.
15547 * @see elm_object_tooltip_unset() for more details.
15548 * @see elm_toolbar_item_tooltip_content_cb_set()
15552 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15555 * Sets a different style for this item tooltip.
15557 * @note before you set a style you should define a tooltip with
15558 * elm_toolbar_item_tooltip_content_cb_set() or
15559 * elm_toolbar_item_tooltip_text_set()
15561 * @param item toolbar item with tooltip already set.
15562 * @param style the theme style to use (default, transparent, ...)
15564 * @see elm_object_tooltip_style_set() for more details.
15568 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15571 * Get the style for this item tooltip.
15573 * @param item toolbar item with tooltip already set.
15574 * @return style the theme style in use, defaults to "default". If the
15575 * object does not have a tooltip set, then NULL is returned.
15577 * @see elm_object_tooltip_style_get() for more details.
15578 * @see elm_toolbar_item_tooltip_style_set()
15582 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15585 * Set the type of mouse pointer/cursor decoration to be shown,
15586 * when the mouse pointer is over the given toolbar widget item
15588 * @param item toolbar item to customize cursor on
15589 * @param cursor the cursor type's name
15591 * This function works analogously as elm_object_cursor_set(), but
15592 * here the cursor's changing area is restricted to the item's
15593 * area, and not the whole widget's. Note that that item cursors
15594 * have precedence over widget cursors, so that a mouse over an
15595 * item with custom cursor set will always show @b that cursor.
15597 * If this function is called twice for an object, a previously set
15598 * cursor will be unset on the second call.
15600 * @see elm_object_cursor_set()
15601 * @see elm_toolbar_item_cursor_get()
15602 * @see elm_toolbar_item_cursor_unset()
15606 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15609 * Get the type of mouse pointer/cursor decoration set to be shown,
15610 * when the mouse pointer is over the given toolbar widget item
15612 * @param item toolbar item with custom cursor set
15613 * @return the cursor type's name or @c NULL, if no custom cursors
15614 * were set to @p item (and on errors)
15616 * @see elm_object_cursor_get()
15617 * @see elm_toolbar_item_cursor_set()
15618 * @see elm_toolbar_item_cursor_unset()
15622 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15625 * Unset any custom mouse pointer/cursor decoration set to be
15626 * shown, when the mouse pointer is over the given toolbar widget
15627 * item, thus making it show the @b default cursor again.
15629 * @param item a toolbar item
15631 * Use this call to undo any custom settings on this item's cursor
15632 * decoration, bringing it back to defaults (no custom style set).
15634 * @see elm_object_cursor_unset()
15635 * @see elm_toolbar_item_cursor_set()
15639 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15642 * Set a different @b style for a given custom cursor set for a
15645 * @param item toolbar item with custom cursor set
15646 * @param style the <b>theme style</b> to use (e.g. @c "default",
15647 * @c "transparent", etc)
15649 * This function only makes sense when one is using custom mouse
15650 * cursor decorations <b>defined in a theme file</b>, which can have,
15651 * given a cursor name/type, <b>alternate styles</b> on it. It
15652 * works analogously as elm_object_cursor_style_set(), but here
15653 * applyed only to toolbar item objects.
15655 * @warning Before you set a cursor style you should have definen a
15656 * custom cursor previously on the item, with
15657 * elm_toolbar_item_cursor_set()
15659 * @see elm_toolbar_item_cursor_engine_only_set()
15660 * @see elm_toolbar_item_cursor_style_get()
15664 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15667 * Get the current @b style set for a given toolbar item's custom
15670 * @param item toolbar item with custom cursor set.
15671 * @return style the cursor style in use. If the object does not
15672 * have a cursor set, then @c NULL is returned.
15674 * @see elm_toolbar_item_cursor_style_set() for more details
15678 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15681 * Set if the (custom)cursor for a given toolbar item should be
15682 * searched in its theme, also, or should only rely on the
15683 * rendering engine.
15685 * @param item item with custom (custom) cursor already set on
15686 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15687 * only on those provided by the rendering engine, @c EINA_FALSE to
15688 * have them searched on the widget's theme, as well.
15690 * @note This call is of use only if you've set a custom cursor
15691 * for toolbar items, with elm_toolbar_item_cursor_set().
15693 * @note By default, cursors will only be looked for between those
15694 * provided by the rendering engine.
15698 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15701 * Get if the (custom) cursor for a given toolbar item is being
15702 * searched in its theme, also, or is only relying on the rendering
15705 * @param item a toolbar item
15706 * @return @c EINA_TRUE, if cursors are being looked for only on
15707 * those provided by the rendering engine, @c EINA_FALSE if they
15708 * are being searched on the widget's theme, as well.
15710 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15714 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15717 * Change a toolbar's orientation
15718 * @param obj The toolbar object
15719 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15720 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15722 * @deprecated use elm_toolbar_horizontal_set() instead.
15724 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15727 * Change a toolbar's orientation
15728 * @param obj The toolbar object
15729 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15730 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15733 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15736 * Get a toolbar's orientation
15737 * @param obj The toolbar object
15738 * @return If @c EINA_TRUE, the toolbar is vertical
15739 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15741 * @deprecated use elm_toolbar_horizontal_get() instead.
15743 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15746 * Get a toolbar's orientation
15747 * @param obj The toolbar object
15748 * @return If @c EINA_TRUE, the toolbar is horizontal
15749 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15752 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15758 * @defgroup Tooltips Tooltips
15760 * The Tooltip is an (internal, for now) smart object used to show a
15761 * content in a frame on mouse hover of objects(or widgets), with
15762 * tips/information about them.
15767 EAPI double elm_tooltip_delay_get(void);
15768 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15769 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15770 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15771 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15772 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15773 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15774 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);
15775 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15776 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15777 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15778 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15779 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15786 * @defgroup Cursors Cursors
15788 * The Elementary cursor is an internal smart object used to
15789 * customize the mouse cursor displayed over objects (or
15790 * widgets). In the most common scenario, the cursor decoration
15791 * comes from the graphical @b engine Elementary is running
15792 * on. Those engines may provide different decorations for cursors,
15793 * and Elementary provides functions to choose them (think of X11
15794 * cursors, as an example).
15796 * There's also the possibility of, besides using engine provided
15797 * cursors, also use ones coming from Edje theming files. Both
15798 * globally and per widget, Elementary makes it possible for one to
15799 * make the cursors lookup to be held on engines only or on
15800 * Elementary's theme file, too. To set cursor's hot spot,
15801 * two data items should be added to cursor's theme: "hot_x" and
15802 * "hot_y", that are the offset from upper-left corner of the cursor
15803 * (coordinates 0,0).
15809 * Set the cursor to be shown when mouse is over the object
15811 * Set the cursor that will be displayed when mouse is over the
15812 * object. The object can have only one cursor set to it, so if
15813 * this function is called twice for an object, the previous set
15815 * If using X cursors, a definition of all the valid cursor names
15816 * is listed on Elementary_Cursors.h. If an invalid name is set
15817 * the default cursor will be used.
15819 * @param obj the object being set a cursor.
15820 * @param cursor the cursor name to be used.
15824 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15827 * Get the cursor to be shown when mouse is over the object
15829 * @param obj an object with cursor already set.
15830 * @return the cursor name.
15834 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15837 * Unset cursor for object
15839 * Unset cursor for object, and set the cursor to default if the mouse
15840 * was over this object.
15842 * @param obj Target object
15843 * @see elm_object_cursor_set()
15847 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15850 * Sets a different style for this object cursor.
15852 * @note before you set a style you should define a cursor with
15853 * elm_object_cursor_set()
15855 * @param obj an object with cursor already set.
15856 * @param style the theme style to use (default, transparent, ...)
15860 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15863 * Get the style for this object cursor.
15865 * @param obj an object with cursor already set.
15866 * @return style the theme style in use, defaults to "default". If the
15867 * object does not have a cursor set, then NULL is returned.
15871 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15874 * Set if the cursor set should be searched on the theme or should use
15875 * the provided by the engine, only.
15877 * @note before you set if should look on theme you should define a cursor
15878 * with elm_object_cursor_set(). By default it will only look for cursors
15879 * provided by the engine.
15881 * @param obj an object with cursor already set.
15882 * @param engine_only boolean to define it cursors should be looked only
15883 * between the provided by the engine or searched on widget's theme as well.
15887 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15890 * Get the cursor engine only usage for this object cursor.
15892 * @param obj an object with cursor already set.
15893 * @return engine_only boolean to define it cursors should be
15894 * looked only between the provided by the engine or searched on
15895 * widget's theme as well. If the object does not have a cursor
15896 * set, then EINA_FALSE is returned.
15900 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15903 * Get the configured cursor engine only usage
15905 * This gets the globally configured exclusive usage of engine cursors.
15907 * @return 1 if only engine cursors should be used
15910 EAPI int elm_cursor_engine_only_get(void);
15913 * Set the configured cursor engine only usage
15915 * This sets the globally configured exclusive usage of engine cursors.
15916 * It won't affect cursors set before changing this value.
15918 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15919 * look for them on theme before.
15920 * @return EINA_TRUE if value is valid and setted (0 or 1)
15923 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15930 * @defgroup Menu Menu
15932 * @image html img/widget/menu/preview-00.png
15933 * @image latex img/widget/menu/preview-00.eps
15935 * A menu is a list of items displayed above its parent. When the menu is
15936 * showing its parent is darkened. Each item can have a sub-menu. The menu
15937 * object can be used to display a menu on a right click event, in a toolbar,
15940 * Signals that you can add callbacks for are:
15941 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15942 * event_info is NULL.
15944 * @see @ref tutorial_menu
15947 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15949 * @brief Add a new menu to the parent
15951 * @param parent The parent object.
15952 * @return The new object or NULL if it cannot be created.
15954 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15956 * @brief Set the parent for the given menu widget
15958 * @param obj The menu object.
15959 * @param parent The new parent.
15961 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15963 * @brief Get the parent for the given menu widget
15965 * @param obj The menu object.
15966 * @return The parent.
15968 * @see elm_menu_parent_set()
15970 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15972 * @brief Move the menu to a new position
15974 * @param obj The menu object.
15975 * @param x The new position.
15976 * @param y The new position.
15978 * Sets the top-left position of the menu to (@p x,@p y).
15980 * @note @p x and @p y coordinates are relative to parent.
15982 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15984 * @brief Close a opened menu
15986 * @param obj the menu object
15989 * Hides the menu and all it's sub-menus.
15991 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15993 * @brief Returns a list of @p item's items.
15995 * @param obj The menu object
15996 * @return An Eina_List* of @p item's items
15998 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16000 * @brief Get the Evas_Object of an Elm_Menu_Item
16002 * @param item The menu item object.
16003 * @return The edje object containing the swallowed content
16005 * @warning Don't manipulate this object!
16007 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16009 * @brief Add an item at the end of the given menu widget
16011 * @param obj The menu object.
16012 * @param parent The parent menu item (optional)
16013 * @param icon A icon display on the item. The icon will be destryed by the menu.
16014 * @param label The label of the item.
16015 * @param func Function called when the user select the item.
16016 * @param data Data sent by the callback.
16017 * @return Returns the new item.
16019 EAPI Elm_Menu_Item *elm_menu_item_add(Evas_Object *obj, Elm_Menu_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16021 * @brief Add an object swallowed in an item at the end of the given menu
16024 * @param obj The menu object.
16025 * @param parent The parent menu item (optional)
16026 * @param subobj The object to swallow
16027 * @param func Function called when the user select the item.
16028 * @param data Data sent by the callback.
16029 * @return Returns the new item.
16031 * Add an evas object as an item to the menu.
16033 EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16035 * @brief Set the label of a menu item
16037 * @param item The menu item object.
16038 * @param label The label to set for @p item
16040 * @warning Don't use this funcion on items created with
16041 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16043 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16045 * @brief Get the label of a menu item
16047 * @param item The menu item object.
16048 * @return The label of @p item
16050 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16052 * @brief Set the icon of a menu item to the standard icon with name @p icon
16054 * @param item The menu item object.
16055 * @param icon The icon object to set for the content of @p item
16057 * Once this icon is set, any previously set icon will be deleted.
16059 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16061 * @brief Get the string representation from the icon of a menu item
16063 * @param item The menu item object.
16064 * @return The string representation of @p item's icon or NULL
16066 * @see elm_menu_item_object_icon_name_set()
16068 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16070 * @brief Set the content object of a menu item
16072 * @param item The menu item object
16073 * @param The content object or NULL
16074 * @return EINA_TRUE on success, else EINA_FALSE
16076 * Use this function to change the object swallowed by a menu item, deleting
16077 * any previously swallowed object.
16079 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16081 * @brief Get the content object of a menu item
16083 * @param item The menu item object
16084 * @return The content object or NULL
16085 * @note If @p item was added with elm_menu_item_add_object, this
16086 * function will return the object passed, else it will return the
16089 * @see elm_menu_item_object_content_set()
16091 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16093 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
16095 elm_menu_item_object_icon_name_set(item, icon);
16098 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16100 return elm_menu_item_object_content_get(item);
16103 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16105 return elm_menu_item_object_icon_name_get(item);
16109 * @brief Set the selected state of @p item.
16111 * @param item The menu item object.
16112 * @param selected The selected/unselected state of the item
16114 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16116 * @brief Get the selected state of @p item.
16118 * @param item The menu item object.
16119 * @return The selected/unselected state of the item
16121 * @see elm_menu_item_selected_set()
16123 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16125 * @brief Set the disabled state of @p item.
16127 * @param item The menu item object.
16128 * @param disabled The enabled/disabled state of the item
16130 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16132 * @brief Get the disabled state of @p item.
16134 * @param item The menu item object.
16135 * @return The enabled/disabled state of the item
16137 * @see elm_menu_item_disabled_set()
16139 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16141 * @brief Add a separator item to menu @p obj under @p parent.
16143 * @param obj The menu object
16144 * @param parent The item to add the separator under
16145 * @return The created item or NULL on failure
16147 * This is item is a @ref Separator.
16149 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16151 * @brief Returns whether @p item is a separator.
16153 * @param item The item to check
16154 * @return If true, @p item is a separator
16156 * @see elm_menu_item_separator_add()
16158 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16160 * @brief Deletes an item from the menu.
16162 * @param item The item to delete.
16164 * @see elm_menu_item_add()
16166 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16168 * @brief Set the function called when a menu item is deleted.
16170 * @param item The item to set the callback on
16171 * @param func The function called
16173 * @see elm_menu_item_add()
16174 * @see elm_menu_item_del()
16176 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16178 * @brief Returns the data associated with menu item @p item.
16180 * @param item The item
16181 * @return The data associated with @p item or NULL if none was set.
16183 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16185 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16187 * @brief Sets the data to be associated with menu item @p item.
16189 * @param item The item
16190 * @param data The data to be associated with @p item
16192 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16194 * @brief Returns a list of @p item's subitems.
16196 * @param item The item
16197 * @return An Eina_List* of @p item's subitems
16199 * @see elm_menu_add()
16201 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16203 * @brief Get the position of a menu item
16205 * @param item The menu item
16206 * @return The item's index
16208 * This function returns the index position of a menu item in a menu.
16209 * For a sub-menu, this number is relative to the first item in the sub-menu.
16211 * @note Index values begin with 0
16213 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16215 * @brief @brief Return a menu item's owner menu
16217 * @param item The menu item
16218 * @return The menu object owning @p item, or NULL on failure
16220 * Use this function to get the menu object owning an item.
16222 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16224 * @brief Get the selected item in the menu
16226 * @param obj The menu object
16227 * @return The selected item, or NULL if none
16229 * @see elm_menu_item_selected_get()
16230 * @see elm_menu_item_selected_set()
16232 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16234 * @brief Get the last item in the menu
16236 * @param obj The menu object
16237 * @return The last item, or NULL if none
16239 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16241 * @brief Get the first item in the menu
16243 * @param obj The menu object
16244 * @return The first item, or NULL if none
16246 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16248 * @brief Get the next item in the menu.
16250 * @param item The menu item object.
16251 * @return The item after it, or NULL if none
16253 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16255 * @brief Get the previous item in the menu.
16257 * @param item The menu item object.
16258 * @return The item before it, or NULL if none
16260 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16266 * @defgroup List List
16267 * @ingroup Elementary
16269 * @image html img/widget/list/preview-00.png
16270 * @image latex img/widget/list/preview-00.eps width=\textwidth
16272 * @image html img/list.png
16273 * @image latex img/list.eps width=\textwidth
16275 * A list widget is a container whose children are displayed vertically or
16276 * horizontally, in order, and can be selected.
16277 * The list can accept only one or multiple items selection. Also has many
16278 * modes of items displaying.
16280 * A list is a very simple type of list widget. For more robust
16281 * lists, @ref Genlist should probably be used.
16283 * Smart callbacks one can listen to:
16284 * - @c "activated" - The user has double-clicked or pressed
16285 * (enter|return|spacebar) on an item. The @c event_info parameter
16286 * is the item that was activated.
16287 * - @c "clicked,double" - The user has double-clicked an item.
16288 * The @c event_info parameter is the item that was double-clicked.
16289 * - "selected" - when the user selected an item
16290 * - "unselected" - when the user unselected an item
16291 * - "longpressed" - an item in the list is long-pressed
16292 * - "edge,top" - the list is scrolled until the top edge
16293 * - "edge,bottom" - the list is scrolled until the bottom edge
16294 * - "edge,left" - the list is scrolled until the left edge
16295 * - "edge,right" - the list is scrolled until the right edge
16296 * - "language,changed" - the program's language changed
16298 * Available styles for it:
16301 * List of examples:
16302 * @li @ref list_example_01
16303 * @li @ref list_example_02
16304 * @li @ref list_example_03
16313 * @enum _Elm_List_Mode
16314 * @typedef Elm_List_Mode
16316 * Set list's resize behavior, transverse axis scroll and
16317 * items cropping. See each mode's description for more details.
16319 * @note Default value is #ELM_LIST_SCROLL.
16321 * Values <b> don't </b> work as bitmask, only one can be choosen.
16323 * @see elm_list_mode_set()
16324 * @see elm_list_mode_get()
16328 typedef enum _Elm_List_Mode
16330 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. */
16331 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). */
16332 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. */
16333 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. */
16334 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16337 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(). */
16340 * Add a new list widget to the given parent Elementary
16341 * (container) object.
16343 * @param parent The parent object.
16344 * @return a new list widget handle or @c NULL, on errors.
16346 * This function inserts a new list widget on the canvas.
16350 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16355 * @param obj The list object
16357 * @note Call before running show() on the list object.
16358 * @warning If not called, it won't display the list properly.
16361 * li = elm_list_add(win);
16362 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16363 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16365 * evas_object_show(li);
16370 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16373 * Enable or disable multiple items selection on the list object.
16375 * @param obj The list object
16376 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16379 * Disabled by default. If disabled, the user can select a single item of
16380 * the list each time. Selected items are highlighted on list.
16381 * If enabled, many items can be selected.
16383 * If a selected item is selected again, it will be unselected.
16385 * @see elm_list_multi_select_get()
16389 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16392 * Get a value whether multiple items selection is enabled or not.
16394 * @see elm_list_multi_select_set() for details.
16396 * @param obj The list object.
16397 * @return @c EINA_TRUE means multiple items selection is enabled.
16398 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16399 * @c EINA_FALSE is returned.
16403 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16406 * Set which mode to use for the list object.
16408 * @param obj The list object
16409 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16410 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16412 * Set list's resize behavior, transverse axis scroll and
16413 * items cropping. See each mode's description for more details.
16415 * @note Default value is #ELM_LIST_SCROLL.
16417 * Only one can be set, if a previous one was set, it will be changed
16418 * by the new mode set. Bitmask won't work as well.
16420 * @see elm_list_mode_get()
16424 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16427 * Get the mode the list is at.
16429 * @param obj The list object
16430 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16431 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16433 * @note see elm_list_mode_set() for more information.
16437 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16440 * Enable or disable horizontal mode on the list object.
16442 * @param obj The list object.
16443 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16444 * disable it, i.e., to enable vertical mode.
16446 * @note Vertical mode is set by default.
16448 * On horizontal mode items are displayed on list from left to right,
16449 * instead of from top to bottom. Also, the list will scroll horizontally.
16450 * Each item will presents left icon on top and right icon, or end, at
16453 * @see elm_list_horizontal_get()
16457 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16460 * Get a value whether horizontal mode is enabled or not.
16462 * @param obj The list object.
16463 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16464 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16465 * @c EINA_FALSE is returned.
16467 * @see elm_list_horizontal_set() for details.
16471 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16474 * Enable or disable always select mode on the list object.
16476 * @param obj The list object
16477 * @param always_select @c EINA_TRUE to enable always select mode or
16478 * @c EINA_FALSE to disable it.
16480 * @note Always select mode is disabled by default.
16482 * Default behavior of list items is to only call its callback function
16483 * the first time it's pressed, i.e., when it is selected. If a selected
16484 * item is pressed again, and multi-select is disabled, it won't call
16485 * this function (if multi-select is enabled it will unselect the item).
16487 * If always select is enabled, it will call the callback function
16488 * everytime a item is pressed, so it will call when the item is selected,
16489 * and again when a selected item is pressed.
16491 * @see elm_list_always_select_mode_get()
16492 * @see elm_list_multi_select_set()
16496 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16499 * Get a value whether always select mode is enabled or not, meaning that
16500 * an item will always call its callback function, even if already selected.
16502 * @param obj The list object
16503 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16504 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16505 * @c EINA_FALSE is returned.
16507 * @see elm_list_always_select_mode_set() for details.
16511 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16514 * Set bouncing behaviour when the scrolled content reaches an edge.
16516 * Tell the internal scroller object whether it should bounce or not
16517 * when it reaches the respective edges for each axis.
16519 * @param obj The list object
16520 * @param h_bounce Whether to bounce or not in the horizontal axis.
16521 * @param v_bounce Whether to bounce or not in the vertical axis.
16523 * @see elm_scroller_bounce_set()
16527 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16530 * Get the bouncing behaviour of the internal scroller.
16532 * Get whether the internal scroller should bounce when the edge of each
16533 * axis is reached scrolling.
16535 * @param obj The list object.
16536 * @param h_bounce Pointer where to store the bounce state of the horizontal
16538 * @param v_bounce Pointer where to store the bounce state of the vertical
16541 * @see elm_scroller_bounce_get()
16542 * @see elm_list_bounce_set()
16546 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16549 * Set the scrollbar policy.
16551 * @param obj The list object
16552 * @param policy_h Horizontal scrollbar policy.
16553 * @param policy_v Vertical scrollbar policy.
16555 * This sets the scrollbar visibility policy for the given scroller.
16556 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16557 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16558 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16559 * This applies respectively for the horizontal and vertical scrollbars.
16561 * The both are disabled by default, i.e., are set to
16562 * #ELM_SCROLLER_POLICY_OFF.
16566 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16569 * Get the scrollbar policy.
16571 * @see elm_list_scroller_policy_get() for details.
16573 * @param obj The list object.
16574 * @param policy_h Pointer where to store horizontal scrollbar policy.
16575 * @param policy_v Pointer where to store vertical scrollbar policy.
16579 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);
16582 * Append a new item to the list object.
16584 * @param obj The list object.
16585 * @param label The label of the list item.
16586 * @param icon The icon object to use for the left side of the item. An
16587 * icon can be any Evas object, but usually it is an icon created
16588 * with elm_icon_add().
16589 * @param end The icon object to use for the right side of the item. An
16590 * icon can be any Evas object.
16591 * @param func The function to call when the item is clicked.
16592 * @param data The data to associate with the item for related callbacks.
16594 * @return The created item or @c NULL upon failure.
16596 * A new item will be created and appended to the list, i.e., will
16597 * be set as @b last item.
16599 * Items created with this method can be deleted with
16600 * elm_list_item_del().
16602 * Associated @p data can be properly freed when item is deleted if a
16603 * callback function is set with elm_list_item_del_cb_set().
16605 * If a function is passed as argument, it will be called everytime this item
16606 * is selected, i.e., the user clicks over an unselected item.
16607 * If always select is enabled it will call this function every time
16608 * user clicks over an item (already selected or not).
16609 * If such function isn't needed, just passing
16610 * @c NULL as @p func is enough. The same should be done for @p data.
16612 * Simple example (with no function callback or data associated):
16614 * li = elm_list_add(win);
16615 * ic = elm_icon_add(win);
16616 * elm_icon_file_set(ic, "path/to/image", NULL);
16617 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16618 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16620 * evas_object_show(li);
16623 * @see elm_list_always_select_mode_set()
16624 * @see elm_list_item_del()
16625 * @see elm_list_item_del_cb_set()
16626 * @see elm_list_clear()
16627 * @see elm_icon_add()
16631 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);
16634 * Prepend a new item to the list object.
16636 * @param obj The list object.
16637 * @param label The label of the list item.
16638 * @param icon The icon object to use for the left side of the item. An
16639 * icon can be any Evas object, but usually it is an icon created
16640 * with elm_icon_add().
16641 * @param end The icon object to use for the right side of the item. An
16642 * icon can be any Evas object.
16643 * @param func The function to call when the item is clicked.
16644 * @param data The data to associate with the item for related callbacks.
16646 * @return The created item or @c NULL upon failure.
16648 * A new item will be created and prepended to the list, i.e., will
16649 * be set as @b first item.
16651 * Items created with this method can be deleted with
16652 * elm_list_item_del().
16654 * Associated @p data can be properly freed when item is deleted if a
16655 * callback function is set with elm_list_item_del_cb_set().
16657 * If a function is passed as argument, it will be called everytime this item
16658 * is selected, i.e., the user clicks over an unselected item.
16659 * If always select is enabled it will call this function every time
16660 * user clicks over an item (already selected or not).
16661 * If such function isn't needed, just passing
16662 * @c NULL as @p func is enough. The same should be done for @p data.
16664 * @see elm_list_item_append() for a simple code example.
16665 * @see elm_list_always_select_mode_set()
16666 * @see elm_list_item_del()
16667 * @see elm_list_item_del_cb_set()
16668 * @see elm_list_clear()
16669 * @see elm_icon_add()
16673 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);
16676 * Insert a new item into the list object before item @p before.
16678 * @param obj The list object.
16679 * @param before The list item to insert before.
16680 * @param label The label of the list item.
16681 * @param icon The icon object to use for the left side of the item. An
16682 * icon can be any Evas object, but usually it is an icon created
16683 * with elm_icon_add().
16684 * @param end The icon object to use for the right side of the item. An
16685 * icon can be any Evas object.
16686 * @param func The function to call when the item is clicked.
16687 * @param data The data to associate with the item for related callbacks.
16689 * @return The created item or @c NULL upon failure.
16691 * A new item will be created and added to the list. Its position in
16692 * this list will be just before item @p before.
16694 * Items created with this method can be deleted with
16695 * elm_list_item_del().
16697 * Associated @p data can be properly freed when item is deleted if a
16698 * callback function is set with elm_list_item_del_cb_set().
16700 * If a function is passed as argument, it will be called everytime this item
16701 * is selected, i.e., the user clicks over an unselected item.
16702 * If always select is enabled it will call this function every time
16703 * user clicks over an item (already selected or not).
16704 * If such function isn't needed, just passing
16705 * @c NULL as @p func is enough. The same should be done for @p data.
16707 * @see elm_list_item_append() for a simple code example.
16708 * @see elm_list_always_select_mode_set()
16709 * @see elm_list_item_del()
16710 * @see elm_list_item_del_cb_set()
16711 * @see elm_list_clear()
16712 * @see elm_icon_add()
16716 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);
16719 * Insert a new item into the list object after item @p after.
16721 * @param obj The list object.
16722 * @param after The list item to insert after.
16723 * @param label The label of the list item.
16724 * @param icon The icon object to use for the left side of the item. An
16725 * icon can be any Evas object, but usually it is an icon created
16726 * with elm_icon_add().
16727 * @param end The icon object to use for the right side of the item. An
16728 * icon can be any Evas object.
16729 * @param func The function to call when the item is clicked.
16730 * @param data The data to associate with the item for related callbacks.
16732 * @return The created item or @c NULL upon failure.
16734 * A new item will be created and added to the list. Its position in
16735 * this list will be just after item @p after.
16737 * Items created with this method can be deleted with
16738 * elm_list_item_del().
16740 * Associated @p data can be properly freed when item is deleted if a
16741 * callback function is set with elm_list_item_del_cb_set().
16743 * If a function is passed as argument, it will be called everytime this item
16744 * is selected, i.e., the user clicks over an unselected item.
16745 * If always select is enabled it will call this function every time
16746 * user clicks over an item (already selected or not).
16747 * If such function isn't needed, just passing
16748 * @c NULL as @p func is enough. The same should be done for @p data.
16750 * @see elm_list_item_append() for a simple code example.
16751 * @see elm_list_always_select_mode_set()
16752 * @see elm_list_item_del()
16753 * @see elm_list_item_del_cb_set()
16754 * @see elm_list_clear()
16755 * @see elm_icon_add()
16759 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);
16762 * Insert a new item into the sorted list object.
16764 * @param obj The list object.
16765 * @param label The label of the list item.
16766 * @param icon The icon object to use for the left side of the item. An
16767 * icon can be any Evas object, but usually it is an icon created
16768 * with elm_icon_add().
16769 * @param end The icon object to use for the right side of the item. An
16770 * icon can be any Evas object.
16771 * @param func The function to call when the item is clicked.
16772 * @param data The data to associate with the item for related callbacks.
16773 * @param cmp_func The comparing function to be used to sort list
16774 * items <b>by #Elm_List_Item item handles</b>. This function will
16775 * receive two items and compare them, returning a non-negative integer
16776 * if the second item should be place after the first, or negative value
16777 * if should be placed before.
16779 * @return The created item or @c NULL upon failure.
16781 * @note This function inserts values into a list object assuming it was
16782 * sorted and the result will be sorted.
16784 * A new item will be created and added to the list. Its position in
16785 * this list will be found comparing the new item with previously inserted
16786 * items using function @p cmp_func.
16788 * Items created with this method can be deleted with
16789 * elm_list_item_del().
16791 * Associated @p data can be properly freed when item is deleted if a
16792 * callback function is set with elm_list_item_del_cb_set().
16794 * If a function is passed as argument, it will be called everytime this item
16795 * is selected, i.e., the user clicks over an unselected item.
16796 * If always select is enabled it will call this function every time
16797 * user clicks over an item (already selected or not).
16798 * If such function isn't needed, just passing
16799 * @c NULL as @p func is enough. The same should be done for @p data.
16801 * @see elm_list_item_append() for a simple code example.
16802 * @see elm_list_always_select_mode_set()
16803 * @see elm_list_item_del()
16804 * @see elm_list_item_del_cb_set()
16805 * @see elm_list_clear()
16806 * @see elm_icon_add()
16810 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);
16813 * Remove all list's items.
16815 * @param obj The list object
16817 * @see elm_list_item_del()
16818 * @see elm_list_item_append()
16822 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16825 * Get a list of all the list items.
16827 * @param obj The list object
16828 * @return An @c Eina_List of list items, #Elm_List_Item,
16829 * or @c NULL on failure.
16831 * @see elm_list_item_append()
16832 * @see elm_list_item_del()
16833 * @see elm_list_clear()
16837 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16840 * Get the selected item.
16842 * @param obj The list object.
16843 * @return The selected list item.
16845 * The selected item can be unselected with function
16846 * elm_list_item_selected_set().
16848 * The selected item always will be highlighted on list.
16850 * @see elm_list_selected_items_get()
16854 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16857 * Return a list of the currently selected list items.
16859 * @param obj The list object.
16860 * @return An @c Eina_List of list items, #Elm_List_Item,
16861 * or @c NULL on failure.
16863 * Multiple items can be selected if multi select is enabled. It can be
16864 * done with elm_list_multi_select_set().
16866 * @see elm_list_selected_item_get()
16867 * @see elm_list_multi_select_set()
16871 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16874 * Set the selected state of an item.
16876 * @param item The list item
16877 * @param selected The selected state
16879 * This sets the selected state of the given item @p it.
16880 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16882 * If a new item is selected the previosly selected will be unselected,
16883 * unless multiple selection is enabled with elm_list_multi_select_set().
16884 * Previoulsy selected item can be get with function
16885 * elm_list_selected_item_get().
16887 * Selected items will be highlighted.
16889 * @see elm_list_item_selected_get()
16890 * @see elm_list_selected_item_get()
16891 * @see elm_list_multi_select_set()
16895 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16898 * Get whether the @p item is selected or not.
16900 * @param item The list item.
16901 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16902 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16904 * @see elm_list_selected_item_set() for details.
16905 * @see elm_list_item_selected_get()
16909 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16912 * Set or unset item as a separator.
16914 * @param it The list item.
16915 * @param setting @c EINA_TRUE to set item @p it as separator or
16916 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16918 * Items aren't set as separator by default.
16920 * If set as separator it will display separator theme, so won't display
16923 * @see elm_list_item_separator_get()
16927 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16930 * Get a value whether item is a separator or not.
16932 * @see elm_list_item_separator_set() for details.
16934 * @param it The list item.
16935 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16936 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16940 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16943 * Show @p item in the list view.
16945 * @param item The list item to be shown.
16947 * It won't animate list until item is visible. If such behavior is wanted,
16948 * use elm_list_bring_in() intead.
16952 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16955 * Bring in the given item to list view.
16957 * @param item The item.
16959 * This causes list to jump to the given item @p item and show it
16960 * (by scrolling), if it is not fully visible.
16962 * This may use animation to do so and take a period of time.
16964 * If animation isn't wanted, elm_list_item_show() can be used.
16968 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16971 * Delete them item from the list.
16973 * @param item The item of list to be deleted.
16975 * If deleting all list items is required, elm_list_clear()
16976 * should be used instead of getting items list and deleting each one.
16978 * @see elm_list_clear()
16979 * @see elm_list_item_append()
16980 * @see elm_list_item_del_cb_set()
16984 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16987 * Set the function called when a list item is freed.
16989 * @param item The item to set the callback on
16990 * @param func The function called
16992 * If there is a @p func, then it will be called prior item's memory release.
16993 * That will be called with the following arguments:
16995 * @li item's Evas object;
16998 * This way, a data associated to a list item could be properly freed.
17002 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17005 * Get the data associated to the item.
17007 * @param item The list item
17008 * @return The data associated to @p item
17010 * The return value is a pointer to data associated to @p item when it was
17011 * created, with function elm_list_item_append() or similar. If no data
17012 * was passed as argument, it will return @c NULL.
17014 * @see elm_list_item_append()
17018 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17021 * Get the left side icon associated to the item.
17023 * @param item The list item
17024 * @return The left side icon associated to @p item
17026 * The return value is a pointer to the icon associated to @p item when
17028 * created, with function elm_list_item_append() or similar, or later
17029 * with function elm_list_item_icon_set(). If no icon
17030 * was passed as argument, it will return @c NULL.
17032 * @see elm_list_item_append()
17033 * @see elm_list_item_icon_set()
17037 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17040 * Set the left side icon associated to the item.
17042 * @param item The list item
17043 * @param icon The left side icon object to associate with @p item
17045 * The icon object to use at left side of the item. An
17046 * icon can be any Evas object, but usually it is an icon created
17047 * with elm_icon_add().
17049 * Once the icon object is set, a previously set one will be deleted.
17050 * @warning Setting the same icon for two items will cause the icon to
17051 * dissapear from the first item.
17053 * If an icon was passed as argument on item creation, with function
17054 * elm_list_item_append() or similar, it will be already
17055 * associated to the item.
17057 * @see elm_list_item_append()
17058 * @see elm_list_item_icon_get()
17062 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17065 * Get the right side icon associated to the item.
17067 * @param item The list item
17068 * @return The right side icon associated to @p item
17070 * The return value is a pointer to the icon associated to @p item when
17072 * created, with function elm_list_item_append() or similar, or later
17073 * with function elm_list_item_icon_set(). If no icon
17074 * was passed as argument, it will return @c NULL.
17076 * @see elm_list_item_append()
17077 * @see elm_list_item_icon_set()
17081 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17084 * Set the right side icon associated to the item.
17086 * @param item The list item
17087 * @param end The right side icon object to associate with @p item
17089 * The icon object to use at right side of the item. An
17090 * icon can be any Evas object, but usually it is an icon created
17091 * with elm_icon_add().
17093 * Once the icon object is set, a previously set one will be deleted.
17094 * @warning Setting the same icon for two items will cause the icon to
17095 * dissapear from the first item.
17097 * If an icon was passed as argument on item creation, with function
17098 * elm_list_item_append() or similar, it will be already
17099 * associated to the item.
17101 * @see elm_list_item_append()
17102 * @see elm_list_item_end_get()
17106 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17107 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17110 * Gets the base object of the item.
17112 * @param item The list item
17113 * @return The base object associated with @p item
17115 * Base object is the @c Evas_Object that represents that item.
17119 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17122 * Get the label of item.
17124 * @param item The item of list.
17125 * @return The label of item.
17127 * The return value is a pointer to the label associated to @p item when
17128 * it was created, with function elm_list_item_append(), or later
17129 * with function elm_list_item_label_set. If no label
17130 * was passed as argument, it will return @c NULL.
17132 * @see elm_list_item_label_set() for more details.
17133 * @see elm_list_item_append()
17137 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17140 * Set the label of item.
17142 * @param item The item of list.
17143 * @param text The label of item.
17145 * The label to be displayed by the item.
17146 * Label will be placed between left and right side icons (if set).
17148 * If a label was passed as argument on item creation, with function
17149 * elm_list_item_append() or similar, it will be already
17150 * displayed by the item.
17152 * @see elm_list_item_label_get()
17153 * @see elm_list_item_append()
17157 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17161 * Get the item before @p it in list.
17163 * @param it The list item.
17164 * @return The item before @p it, or @c NULL if none or on failure.
17166 * @note If it is the first item, @c NULL will be returned.
17168 * @see elm_list_item_append()
17169 * @see elm_list_items_get()
17173 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17176 * Get the item after @p it in list.
17178 * @param it The list item.
17179 * @return The item after @p it, or @c NULL if none or on failure.
17181 * @note If it is the last item, @c NULL will be returned.
17183 * @see elm_list_item_append()
17184 * @see elm_list_items_get()
17188 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17191 * Sets the disabled/enabled state of a list item.
17193 * @param it The item.
17194 * @param disabled The disabled state.
17196 * A disabled item cannot be selected or unselected. It will also
17197 * change its appearance (generally greyed out). This sets the
17198 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17203 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17206 * Get a value whether list item is disabled or not.
17208 * @param it The item.
17209 * @return The disabled state.
17211 * @see elm_list_item_disabled_set() for more details.
17215 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17218 * Set the text to be shown in a given list item's tooltips.
17220 * @param item Target item.
17221 * @param text The text to set in the content.
17223 * Setup the text as tooltip to object. The item can have only one tooltip,
17224 * so any previous tooltip data - set with this function or
17225 * elm_list_item_tooltip_content_cb_set() - is removed.
17227 * @see elm_object_tooltip_text_set() for more details.
17231 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17235 * @brief Disable size restrictions on an object's tooltip
17236 * @param item The tooltip's anchor object
17237 * @param disable If EINA_TRUE, size restrictions are disabled
17238 * @return EINA_FALSE on failure, EINA_TRUE on success
17240 * This function allows a tooltip to expand beyond its parant window's canvas.
17241 * It will instead be limited only by the size of the display.
17243 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17245 * @brief Retrieve size restriction state of an object's tooltip
17246 * @param obj The tooltip's anchor object
17247 * @return If EINA_TRUE, size restrictions are disabled
17249 * This function returns whether a tooltip is allowed to expand beyond
17250 * its parant window's canvas.
17251 * It will instead be limited only by the size of the display.
17253 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17256 * Set the content to be shown in the tooltip item.
17258 * Setup the tooltip to item. The item can have only one tooltip,
17259 * so any previous tooltip data is removed. @p func(with @p data) will
17260 * be called every time that need show the tooltip and it should
17261 * return a valid Evas_Object. This object is then managed fully by
17262 * tooltip system and is deleted when the tooltip is gone.
17264 * @param item the list item being attached a tooltip.
17265 * @param func the function used to create the tooltip contents.
17266 * @param data what to provide to @a func as callback data/context.
17267 * @param del_cb called when data is not needed anymore, either when
17268 * another callback replaces @a func, the tooltip is unset with
17269 * elm_list_item_tooltip_unset() or the owner @a item
17270 * dies. This callback receives as the first parameter the
17271 * given @a data, and @c event_info is the item.
17273 * @see elm_object_tooltip_content_cb_set() for more details.
17277 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);
17280 * Unset tooltip from item.
17282 * @param item list item to remove previously set tooltip.
17284 * Remove tooltip from item. The callback provided as del_cb to
17285 * elm_list_item_tooltip_content_cb_set() will be called to notify
17286 * it is not used anymore.
17288 * @see elm_object_tooltip_unset() for more details.
17289 * @see elm_list_item_tooltip_content_cb_set()
17293 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17296 * Sets a different style for this item tooltip.
17298 * @note before you set a style you should define a tooltip with
17299 * elm_list_item_tooltip_content_cb_set() or
17300 * elm_list_item_tooltip_text_set()
17302 * @param item list item with tooltip already set.
17303 * @param style the theme style to use (default, transparent, ...)
17305 * @see elm_object_tooltip_style_set() for more details.
17309 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17312 * Get the style for this item tooltip.
17314 * @param item list item with tooltip already set.
17315 * @return style the theme style in use, defaults to "default". If the
17316 * object does not have a tooltip set, then NULL is returned.
17318 * @see elm_object_tooltip_style_get() for more details.
17319 * @see elm_list_item_tooltip_style_set()
17323 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17326 * Set the type of mouse pointer/cursor decoration to be shown,
17327 * when the mouse pointer is over the given list widget item
17329 * @param item list item to customize cursor on
17330 * @param cursor the cursor type's name
17332 * This function works analogously as elm_object_cursor_set(), but
17333 * here the cursor's changing area is restricted to the item's
17334 * area, and not the whole widget's. Note that that item cursors
17335 * have precedence over widget cursors, so that a mouse over an
17336 * item with custom cursor set will always show @b that cursor.
17338 * If this function is called twice for an object, a previously set
17339 * cursor will be unset on the second call.
17341 * @see elm_object_cursor_set()
17342 * @see elm_list_item_cursor_get()
17343 * @see elm_list_item_cursor_unset()
17347 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17350 * Get the type of mouse pointer/cursor decoration set to be shown,
17351 * when the mouse pointer is over the given list widget item
17353 * @param item list item with custom cursor set
17354 * @return the cursor type's name or @c NULL, if no custom cursors
17355 * were set to @p item (and on errors)
17357 * @see elm_object_cursor_get()
17358 * @see elm_list_item_cursor_set()
17359 * @see elm_list_item_cursor_unset()
17363 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17366 * Unset any custom mouse pointer/cursor decoration set to be
17367 * shown, when the mouse pointer is over the given list widget
17368 * item, thus making it show the @b default cursor again.
17370 * @param item a list item
17372 * Use this call to undo any custom settings on this item's cursor
17373 * decoration, bringing it back to defaults (no custom style set).
17375 * @see elm_object_cursor_unset()
17376 * @see elm_list_item_cursor_set()
17380 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17383 * Set a different @b style for a given custom cursor set for a
17386 * @param item list item with custom cursor set
17387 * @param style the <b>theme style</b> to use (e.g. @c "default",
17388 * @c "transparent", etc)
17390 * This function only makes sense when one is using custom mouse
17391 * cursor decorations <b>defined in a theme file</b>, which can have,
17392 * given a cursor name/type, <b>alternate styles</b> on it. It
17393 * works analogously as elm_object_cursor_style_set(), but here
17394 * applyed only to list item objects.
17396 * @warning Before you set a cursor style you should have definen a
17397 * custom cursor previously on the item, with
17398 * elm_list_item_cursor_set()
17400 * @see elm_list_item_cursor_engine_only_set()
17401 * @see elm_list_item_cursor_style_get()
17405 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17408 * Get the current @b style set for a given list item's custom
17411 * @param item list item with custom cursor set.
17412 * @return style the cursor style in use. If the object does not
17413 * have a cursor set, then @c NULL is returned.
17415 * @see elm_list_item_cursor_style_set() for more details
17419 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17422 * Set if the (custom)cursor for a given list item should be
17423 * searched in its theme, also, or should only rely on the
17424 * rendering engine.
17426 * @param item item with custom (custom) cursor already set on
17427 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17428 * only on those provided by the rendering engine, @c EINA_FALSE to
17429 * have them searched on the widget's theme, as well.
17431 * @note This call is of use only if you've set a custom cursor
17432 * for list items, with elm_list_item_cursor_set().
17434 * @note By default, cursors will only be looked for between those
17435 * provided by the rendering engine.
17439 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17442 * Get if the (custom) cursor for a given list item is being
17443 * searched in its theme, also, or is only relying on the rendering
17446 * @param item a list item
17447 * @return @c EINA_TRUE, if cursors are being looked for only on
17448 * those provided by the rendering engine, @c EINA_FALSE if they
17449 * are being searched on the widget's theme, as well.
17451 * @see elm_list_item_cursor_engine_only_set(), for more details
17455 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17462 * @defgroup Slider Slider
17463 * @ingroup Elementary
17465 * @image html img/widget/slider/preview-00.png
17466 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17468 * The slider adds a dragable “slider” widget for selecting the value of
17469 * something within a range.
17471 * A slider can be horizontal or vertical. It can contain an Icon and has a
17472 * primary label as well as a units label (that is formatted with floating
17473 * point values and thus accepts a printf-style format string, like
17474 * “%1.2f units”. There is also an indicator string that may be somewhere
17475 * else (like on the slider itself) that also accepts a format string like
17476 * units. Label, Icon Unit and Indicator strings/objects are optional.
17478 * A slider may be inverted which means values invert, with high vales being
17479 * on the left or top and low values on the right or bottom (as opposed to
17480 * normally being low on the left or top and high on the bottom and right).
17482 * The slider should have its minimum and maximum values set by the
17483 * application with elm_slider_min_max_set() and value should also be set by
17484 * the application before use with elm_slider_value_set(). The span of the
17485 * slider is its length (horizontally or vertically). This will be scaled by
17486 * the object or applications scaling factor. At any point code can query the
17487 * slider for its value with elm_slider_value_get().
17489 * Smart callbacks one can listen to:
17490 * - "changed" - Whenever the slider value is changed by the user.
17491 * - "slider,drag,start" - dragging the slider indicator around has started.
17492 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17493 * - "delay,changed" - A short time after the value is changed by the user.
17494 * This will be called only when the user stops dragging for
17495 * a very short period or when they release their
17496 * finger/mouse, so it avoids possibly expensive reactions to
17497 * the value change.
17499 * Available styles for it:
17502 * Default contents parts of the slider widget that you can use for are:
17503 * @li "icon" - A icon of the slider
17504 * @li "end" - A end part content of the slider
17506 * Default text parts of the silder widget that you can use for are:
17507 * @li "default" - Label of the silder
17508 * Here is an example on its usage:
17509 * @li @ref slider_example
17513 * @addtogroup Slider
17518 * Add a new slider widget to the given parent Elementary
17519 * (container) object.
17521 * @param parent The parent object.
17522 * @return a new slider widget handle or @c NULL, on errors.
17524 * This function inserts a new slider widget on the canvas.
17528 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17531 * Set the label of a given slider widget
17533 * @param obj The progress bar object
17534 * @param label The text label string, in UTF-8
17537 * @deprecated use elm_object_text_set() instead.
17539 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17542 * Get the label of a given slider widget
17544 * @param obj The progressbar object
17545 * @return The text label string, in UTF-8
17548 * @deprecated use elm_object_text_get() instead.
17550 WILL_DEPRECATE EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17553 * Set the icon object of the slider object.
17555 * @param obj The slider object.
17556 * @param icon The icon object.
17558 * On horizontal mode, icon is placed at left, and on vertical mode,
17561 * @note Once the icon object is set, a previously set one will be deleted.
17562 * If you want to keep that old content object, use the
17563 * elm_slider_icon_unset() function.
17565 * @warning If the object being set does not have minimum size hints set,
17566 * it won't get properly displayed.
17569 * @deprecated use elm_object_part_content_set() instead.
17571 WILL_DEPRECATE EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17574 * Unset an icon set on a given slider widget.
17576 * @param obj The slider object.
17577 * @return The icon object that was being used, if any was set, or
17578 * @c NULL, otherwise (and on errors).
17580 * On horizontal mode, icon is placed at left, and on vertical mode,
17583 * This call will unparent and return the icon object which was set
17584 * for this widget, previously, on success.
17586 * @see elm_slider_icon_set() for more details
17587 * @see elm_slider_icon_get()
17588 * @deprecated use elm_object_part_content_unset() instead.
17592 WILL_DEPRECATE EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17595 * Retrieve the icon object set for a given slider widget.
17597 * @param obj The slider object.
17598 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17599 * otherwise (and on errors).
17601 * On horizontal mode, icon is placed at left, and on vertical mode,
17604 * @see elm_slider_icon_set() for more details
17605 * @see elm_slider_icon_unset()
17607 * @deprecated use elm_object_part_content_get() instead.
17611 WILL_DEPRECATE EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17614 * Set the end object of the slider object.
17616 * @param obj The slider object.
17617 * @param end The end object.
17619 * On horizontal mode, end is placed at left, and on vertical mode,
17620 * placed at bottom.
17622 * @note Once the icon object is set, a previously set one will be deleted.
17623 * If you want to keep that old content object, use the
17624 * elm_slider_end_unset() function.
17626 * @warning If the object being set does not have minimum size hints set,
17627 * it won't get properly displayed.
17629 * @deprecated use elm_object_part_content_set() instead.
17633 WILL_DEPRECATE EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17636 * Unset an end object set on a given slider widget.
17638 * @param obj The slider object.
17639 * @return The end object that was being used, if any was set, or
17640 * @c NULL, otherwise (and on errors).
17642 * On horizontal mode, end is placed at left, and on vertical mode,
17643 * placed at bottom.
17645 * This call will unparent and return the icon object which was set
17646 * for this widget, previously, on success.
17648 * @see elm_slider_end_set() for more details.
17649 * @see elm_slider_end_get()
17651 * @deprecated use elm_object_part_content_unset() instead
17656 WILL_DEPRECATE EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17659 * Retrieve the end object set for a given slider widget.
17661 * @param obj The slider object.
17662 * @return The end object's handle, if @p obj had one set, or @c NULL,
17663 * otherwise (and on errors).
17665 * On horizontal mode, icon is placed at right, and on vertical mode,
17666 * placed at bottom.
17668 * @see elm_slider_end_set() for more details.
17669 * @see elm_slider_end_unset()
17672 * @deprecated use elm_object_part_content_get() instead
17677 WILL_DEPRECATE EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17680 * Set the (exact) length of the bar region of a given slider widget.
17682 * @param obj The slider object.
17683 * @param size The length of the slider's bar region.
17685 * This sets the minimum width (when in horizontal mode) or height
17686 * (when in vertical mode) of the actual bar area of the slider
17687 * @p obj. This in turn affects the object's minimum size. Use
17688 * this when you're not setting other size hints expanding on the
17689 * given direction (like weight and alignment hints) and you would
17690 * like it to have a specific size.
17692 * @note Icon, end, label, indicator and unit text around @p obj
17693 * will require their
17694 * own space, which will make @p obj to require more the @p size,
17697 * @see elm_slider_span_size_get()
17701 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17704 * Get the length set for the bar region of a given slider widget
17706 * @param obj The slider object.
17707 * @return The length of the slider's bar region.
17709 * If that size was not set previously, with
17710 * elm_slider_span_size_set(), this call will return @c 0.
17714 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17717 * Set the format string for the unit label.
17719 * @param obj The slider object.
17720 * @param format The format string for the unit display.
17722 * Unit label is displayed all the time, if set, after slider's bar.
17723 * In horizontal mode, at right and in vertical mode, at bottom.
17725 * If @c NULL, unit label won't be visible. If not it sets the format
17726 * string for the label text. To the label text is provided a floating point
17727 * value, so the label text can display up to 1 floating point value.
17728 * Note that this is optional.
17730 * Use a format string such as "%1.2f meters" for example, and it will
17731 * display values like: "3.14 meters" for a value equal to 3.14159.
17733 * Default is unit label disabled.
17735 * @see elm_slider_indicator_format_get()
17739 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17742 * Get the unit label format of the slider.
17744 * @param obj The slider object.
17745 * @return The unit label format string in UTF-8.
17747 * Unit label is displayed all the time, if set, after slider's bar.
17748 * In horizontal mode, at right and in vertical mode, at bottom.
17750 * @see elm_slider_unit_format_set() for more
17751 * information on how this works.
17755 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17758 * Set the format string for the indicator label.
17760 * @param obj The slider object.
17761 * @param indicator The format string for the indicator display.
17763 * The slider may display its value somewhere else then unit label,
17764 * for example, above the slider knob that is dragged around. This function
17765 * sets the format string used for this.
17767 * If @c NULL, indicator label won't be visible. If not it sets the format
17768 * string for the label text. To the label text is provided a floating point
17769 * value, so the label text can display up to 1 floating point value.
17770 * Note that this is optional.
17772 * Use a format string such as "%1.2f meters" for example, and it will
17773 * display values like: "3.14 meters" for a value equal to 3.14159.
17775 * Default is indicator label disabled.
17777 * @see elm_slider_indicator_format_get()
17781 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17784 * Get the indicator label format of the slider.
17786 * @param obj The slider object.
17787 * @return The indicator label format string in UTF-8.
17789 * The slider may display its value somewhere else then unit label,
17790 * for example, above the slider knob that is dragged around. This function
17791 * gets the format string used for this.
17793 * @see elm_slider_indicator_format_set() for more
17794 * information on how this works.
17798 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17801 * Set the format function pointer for the indicator label
17803 * @param obj The slider object.
17804 * @param func The indicator format function.
17805 * @param free_func The freeing function for the format string.
17807 * Set the callback function to format the indicator string.
17809 * @see elm_slider_indicator_format_set() for more info on how this works.
17813 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);
17816 * Set the format function pointer for the units label
17818 * @param obj The slider object.
17819 * @param func The units format function.
17820 * @param free_func The freeing function for the format string.
17822 * Set the callback function to format the indicator string.
17824 * @see elm_slider_units_format_set() for more info on how this works.
17828 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);
17831 * Set the orientation of a given slider widget.
17833 * @param obj The slider object.
17834 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17835 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17837 * Use this function to change how your slider is to be
17838 * disposed: vertically or horizontally.
17840 * By default it's displayed horizontally.
17842 * @see elm_slider_horizontal_get()
17846 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17849 * Retrieve the orientation of a given slider widget
17851 * @param obj The slider object.
17852 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17853 * @c EINA_FALSE if it's @b vertical (and on errors).
17855 * @see elm_slider_horizontal_set() for more details.
17859 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17862 * Set the minimum and maximum values for the slider.
17864 * @param obj The slider object.
17865 * @param min The minimum value.
17866 * @param max The maximum value.
17868 * Define the allowed range of values to be selected by the user.
17870 * If actual value is less than @p min, it will be updated to @p min. If it
17871 * is bigger then @p max, will be updated to @p max. Actual value can be
17872 * get with elm_slider_value_get().
17874 * By default, min is equal to 0.0, and max is equal to 1.0.
17876 * @warning Maximum must be greater than minimum, otherwise behavior
17879 * @see elm_slider_min_max_get()
17883 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17886 * Get the minimum and maximum values of the slider.
17888 * @param obj The slider object.
17889 * @param min Pointer where to store the minimum value.
17890 * @param max Pointer where to store the maximum value.
17892 * @note If only one value is needed, the other pointer can be passed
17895 * @see elm_slider_min_max_set() for details.
17899 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17902 * Set the value the slider displays.
17904 * @param obj The slider object.
17905 * @param val The value to be displayed.
17907 * Value will be presented on the unit label following format specified with
17908 * elm_slider_unit_format_set() and on indicator with
17909 * elm_slider_indicator_format_set().
17911 * @warning The value must to be between min and max values. This values
17912 * are set by elm_slider_min_max_set().
17914 * @see elm_slider_value_get()
17915 * @see elm_slider_unit_format_set()
17916 * @see elm_slider_indicator_format_set()
17917 * @see elm_slider_min_max_set()
17921 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17924 * Get the value displayed by the spinner.
17926 * @param obj The spinner object.
17927 * @return The value displayed.
17929 * @see elm_spinner_value_set() for details.
17933 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17936 * Invert a given slider widget's displaying values order
17938 * @param obj The slider object.
17939 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17940 * @c EINA_FALSE to bring it back to default, non-inverted values.
17942 * A slider may be @b inverted, in which state it gets its
17943 * values inverted, with high vales being on the left or top and
17944 * low values on the right or bottom, as opposed to normally have
17945 * the low values on the former and high values on the latter,
17946 * respectively, for horizontal and vertical modes.
17948 * @see elm_slider_inverted_get()
17952 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17955 * Get whether a given slider widget's displaying values are
17958 * @param obj The slider object.
17959 * @return @c EINA_TRUE, if @p obj has inverted values,
17960 * @c EINA_FALSE otherwise (and on errors).
17962 * @see elm_slider_inverted_set() for more details.
17966 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17969 * Set whether to enlarge slider indicator (augmented knob) or not.
17971 * @param obj The slider object.
17972 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17973 * let the knob always at default size.
17975 * By default, indicator will be bigger while dragged by the user.
17977 * @warning It won't display values set with
17978 * elm_slider_indicator_format_set() if you disable indicator.
17982 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17985 * Get whether a given slider widget's enlarging indicator or not.
17987 * @param obj The slider object.
17988 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17989 * @c EINA_FALSE otherwise (and on errors).
17991 * @see elm_slider_indicator_show_set() for details.
17995 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18002 * @addtogroup Actionslider Actionslider
18004 * @image html img/widget/actionslider/preview-00.png
18005 * @image latex img/widget/actionslider/preview-00.eps
18007 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18008 * properties. The user drags and releases the indicator, to choose a label.
18010 * Labels occupy the following positions.
18015 * Positions can be enabled or disabled.
18017 * Magnets can be set on the above positions.
18019 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18021 * @note By default all positions are set as enabled.
18023 * Signals that you can add callbacks for are:
18025 * "selected" - when user selects an enabled position (the label is passed
18028 * "pos_changed" - when the indicator reaches any of the positions("left",
18029 * "right" or "center").
18031 * See an example of actionslider usage @ref actionslider_example_page "here"
18035 typedef enum _Elm_Actionslider_Indicator_Pos
18037 ELM_ACTIONSLIDER_INDICATOR_NONE,
18038 ELM_ACTIONSLIDER_INDICATOR_LEFT,
18039 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
18040 ELM_ACTIONSLIDER_INDICATOR_CENTER
18041 } Elm_Actionslider_Indicator_Pos;
18043 typedef enum _Elm_Actionslider_Magnet_Pos
18045 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
18046 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
18047 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
18048 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
18049 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
18050 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
18051 } Elm_Actionslider_Magnet_Pos;
18053 typedef enum _Elm_Actionslider_Label_Pos
18055 ELM_ACTIONSLIDER_LABEL_LEFT,
18056 ELM_ACTIONSLIDER_LABEL_RIGHT,
18057 ELM_ACTIONSLIDER_LABEL_CENTER,
18058 ELM_ACTIONSLIDER_LABEL_BUTTON
18059 } Elm_Actionslider_Label_Pos;
18061 /* smart callbacks called:
18062 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
18066 * Add a new actionslider to the parent.
18068 * @param parent The parent object
18069 * @return The new actionslider object or NULL if it cannot be created
18071 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18074 * Set actionslider label.
18076 * @param[in] obj The actionslider object
18077 * @param[in] pos The position of the label.
18078 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
18079 * @param label The label which is going to be set.
18081 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
18083 * Get actionslider labels.
18085 * @param obj The actionslider object
18086 * @param left_label A char** to place the left_label of @p obj into.
18087 * @param center_label A char** to place the center_label of @p obj into.
18088 * @param right_label A char** to place the right_label of @p obj into.
18090 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);
18092 * Get actionslider selected label.
18094 * @param obj The actionslider object
18095 * @return The selected label
18097 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18099 * Set actionslider indicator position.
18101 * @param obj The actionslider object.
18102 * @param pos The position of the indicator.
18104 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
18106 * Get actionslider indicator position.
18108 * @param obj The actionslider object.
18109 * @return The position of the indicator.
18111 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18113 * Set actionslider magnet position. To make multiple positions magnets @c or
18114 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18116 * @param obj The actionslider object.
18117 * @param pos Bit mask indicating the magnet positions.
18119 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18121 * Get actionslider magnet position.
18123 * @param obj The actionslider object.
18124 * @return The positions with magnet property.
18126 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18128 * Set actionslider enabled position. To set multiple positions as enabled @c or
18129 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18131 * @note All the positions are enabled by default.
18133 * @param obj The actionslider object.
18134 * @param pos Bit mask indicating the enabled positions.
18136 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18138 * Get actionslider enabled position.
18140 * @param obj The actionslider object.
18141 * @return The enabled positions.
18143 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18145 * Set the label used on the indicator.
18147 * @param obj The actionslider object
18148 * @param label The label to be set on the indicator.
18149 * @deprecated use elm_object_text_set() instead.
18151 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18153 * Get the label used on the indicator object.
18155 * @param obj The actionslider object
18156 * @return The indicator label
18157 * @deprecated use elm_object_text_get() instead.
18159 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18162 * Hold actionslider object movement.
18164 * @param[in] obj The actionslider object
18165 * @param[in] flag Actionslider hold/release
18166 * (EINA_TURE = hold/EIN_FALSE = release)
18168 * @ingroup Actionslider
18170 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18178 * @defgroup Genlist Genlist
18180 * @image html img/widget/genlist/preview-00.png
18181 * @image latex img/widget/genlist/preview-00.eps
18182 * @image html img/genlist.png
18183 * @image latex img/genlist.eps
18185 * This widget aims to have more expansive list than the simple list in
18186 * Elementary that could have more flexible items and allow many more entries
18187 * while still being fast and low on memory usage. At the same time it was
18188 * also made to be able to do tree structures. But the price to pay is more
18189 * complexity when it comes to usage. If all you want is a simple list with
18190 * icons and a single label, use the normal @ref List object.
18192 * Genlist has a fairly large API, mostly because it's relatively complex,
18193 * trying to be both expansive, powerful and efficient. First we will begin
18194 * an overview on the theory behind genlist.
18196 * @section Genlist_Item_Class Genlist item classes - creating items
18198 * In order to have the ability to add and delete items on the fly, genlist
18199 * implements a class (callback) system where the application provides a
18200 * structure with information about that type of item (genlist may contain
18201 * multiple different items with different classes, states and styles).
18202 * Genlist will call the functions in this struct (methods) when an item is
18203 * "realized" (i.e., created dynamically, while the user is scrolling the
18204 * grid). All objects will simply be deleted when no longer needed with
18205 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18206 * following members:
18207 * - @c item_style - This is a constant string and simply defines the name
18208 * of the item style. It @b must be specified and the default should be @c
18211 * - @c func - A struct with pointers to functions that will be called when
18212 * an item is going to be actually created. All of them receive a @c data
18213 * parameter that will point to the same data passed to
18214 * elm_genlist_item_append() and related item creation functions, and a @c
18215 * obj parameter that points to the genlist object itself.
18217 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18218 * state_get and @c del. The 3 first functions also receive a @c part
18219 * parameter described below. A brief description of these functions follows:
18221 * - @c label_get - The @c part parameter is the name string of one of the
18222 * existing text parts in the Edje group implementing the item's theme.
18223 * This function @b must return a strdup'()ed string, as the caller will
18224 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18225 * - @c content_get - The @c part parameter is the name string of one of the
18226 * existing (content) swallow parts in the Edje group implementing the item's
18227 * theme. It must return @c NULL, when no content is desired, or a valid
18228 * object handle, otherwise. The object will be deleted by the genlist on
18229 * its deletion or when the item is "unrealized". See
18230 * #Elm_Genlist_Item_Content_Get_Cb.
18231 * - @c func.state_get - The @c part parameter is the name string of one of
18232 * the state parts in the Edje group implementing the item's theme. Return
18233 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18234 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18235 * and @c "elm" as "emission" and "source" arguments, respectively, when
18236 * the state is true (the default is false), where @c XXX is the name of
18237 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18238 * - @c func.del - This is intended for use when genlist items are deleted,
18239 * so any data attached to the item (e.g. its data parameter on creation)
18240 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18242 * available item styles:
18244 * - default_style - The text part is a textblock
18246 * @image html img/widget/genlist/preview-04.png
18247 * @image latex img/widget/genlist/preview-04.eps
18251 * @image html img/widget/genlist/preview-01.png
18252 * @image latex img/widget/genlist/preview-01.eps
18254 * - icon_top_text_bottom
18256 * @image html img/widget/genlist/preview-02.png
18257 * @image latex img/widget/genlist/preview-02.eps
18261 * @image html img/widget/genlist/preview-03.png
18262 * @image latex img/widget/genlist/preview-03.eps
18264 * @section Genlist_Items Structure of items
18266 * An item in a genlist can have 0 or more text labels (they can be regular
18267 * text or textblock Evas objects - that's up to the style to determine), 0
18268 * or more contents (which are simply objects swallowed into the genlist item's
18269 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18270 * behavior left to the user to define. The Edje part names for each of
18271 * these properties will be looked up, in the theme file for the genlist,
18272 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18273 * "states", respectively. For each of those properties, if more than one
18274 * part is provided, they must have names listed separated by spaces in the
18275 * data fields. For the default genlist item theme, we have @b one label
18276 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18277 * "elm.swallow.end") and @b no state parts.
18279 * A genlist item may be at one of several styles. Elementary provides one
18280 * by default - "default", but this can be extended by system or application
18281 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18284 * @section Genlist_Manipulation Editing and Navigating
18286 * Items can be added by several calls. All of them return a @ref
18287 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18288 * They all take a data parameter that is meant to be used for a handle to
18289 * the applications internal data (eg the struct with the original item
18290 * data). The parent parameter is the parent genlist item this belongs to if
18291 * it is a tree or an indexed group, and NULL if there is no parent. The
18292 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18293 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18294 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18295 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18296 * is set then this item is group index item that is displayed at the top
18297 * until the next group comes. The func parameter is a convenience callback
18298 * that is called when the item is selected and the data parameter will be
18299 * the func_data parameter, obj be the genlist object and event_info will be
18300 * the genlist item.
18302 * elm_genlist_item_append() adds an item to the end of the list, or if
18303 * there is a parent, to the end of all the child items of the parent.
18304 * elm_genlist_item_prepend() is the same but adds to the beginning of
18305 * the list or children list. elm_genlist_item_insert_before() inserts at
18306 * item before another item and elm_genlist_item_insert_after() inserts after
18307 * the indicated item.
18309 * The application can clear the list with elm_gen_clear() which deletes
18310 * all the items in the list and elm_genlist_item_del() will delete a specific
18311 * item. elm_genlist_item_subitems_clear() will clear all items that are
18312 * children of the indicated parent item.
18314 * To help inspect list items you can jump to the item at the top of the list
18315 * with elm_genlist_first_item_get() which will return the item pointer, and
18316 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18317 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18318 * and previous items respectively relative to the indicated item. Using
18319 * these calls you can walk the entire item list/tree. Note that as a tree
18320 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18321 * let you know which item is the parent (and thus know how to skip them if
18324 * @section Genlist_Muti_Selection Multi-selection
18326 * If the application wants multiple items to be able to be selected,
18327 * elm_genlist_multi_select_set() can enable this. If the list is
18328 * single-selection only (the default), then elm_genlist_selected_item_get()
18329 * will return the selected item, if any, or NULL if none is selected. If the
18330 * list is multi-select then elm_genlist_selected_items_get() will return a
18331 * list (that is only valid as long as no items are modified (added, deleted,
18332 * selected or unselected)).
18334 * @section Genlist_Usage_Hints Usage hints
18336 * There are also convenience functions. elm_gen_item_genlist_get() will
18337 * return the genlist object the item belongs to. elm_genlist_item_show()
18338 * will make the scroller scroll to show that specific item so its visible.
18339 * elm_genlist_item_data_get() returns the data pointer set by the item
18340 * creation functions.
18342 * If an item changes (state of boolean changes, label or contents change),
18343 * then use elm_genlist_item_update() to have genlist update the item with
18344 * the new state. Genlist will re-realize the item thus call the functions
18345 * in the _Elm_Genlist_Item_Class for that item.
18347 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18348 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18349 * to expand/contract an item and get its expanded state, use
18350 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18351 * again to make an item disabled (unable to be selected and appear
18352 * differently) use elm_genlist_item_disabled_set() to set this and
18353 * elm_genlist_item_disabled_get() to get the disabled state.
18355 * In general to indicate how the genlist should expand items horizontally to
18356 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18357 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18358 * mode means that if items are too wide to fit, the scroller will scroll
18359 * horizontally. Otherwise items are expanded to fill the width of the
18360 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18361 * to the viewport width and limited to that size. This can be combined with
18362 * a different style that uses edjes' ellipsis feature (cutting text off like
18365 * Items will only call their selection func and callback when first becoming
18366 * selected. Any further clicks will do nothing, unless you enable always
18367 * select with elm_gen_always_select_mode_set(). This means even if
18368 * selected, every click will make the selected callbacks be called.
18369 * elm_genlist_no_select_mode_set() will turn off the ability to select
18370 * items entirely and they will neither appear selected nor call selected
18371 * callback functions.
18373 * Remember that you can create new styles and add your own theme augmentation
18374 * per application with elm_theme_extension_add(). If you absolutely must
18375 * have a specific style that overrides any theme the user or system sets up
18376 * you can use elm_theme_overlay_add() to add such a file.
18378 * @section Genlist_Implementation Implementation
18380 * Evas tracks every object you create. Every time it processes an event
18381 * (mouse move, down, up etc.) it needs to walk through objects and find out
18382 * what event that affects. Even worse every time it renders display updates,
18383 * in order to just calculate what to re-draw, it needs to walk through many
18384 * many many objects. Thus, the more objects you keep active, the more
18385 * overhead Evas has in just doing its work. It is advisable to keep your
18386 * active objects to the minimum working set you need. Also remember that
18387 * object creation and deletion carries an overhead, so there is a
18388 * middle-ground, which is not easily determined. But don't keep massive lists
18389 * of objects you can't see or use. Genlist does this with list objects. It
18390 * creates and destroys them dynamically as you scroll around. It groups them
18391 * into blocks so it can determine the visibility etc. of a whole block at
18392 * once as opposed to having to walk the whole list. This 2-level list allows
18393 * for very large numbers of items to be in the list (tests have used up to
18394 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18395 * may be different sizes, every item added needs to be calculated as to its
18396 * size and thus this presents a lot of overhead on populating the list, this
18397 * genlist employs a queue. Any item added is queued and spooled off over
18398 * time, actually appearing some time later, so if your list has many members
18399 * you may find it takes a while for them to all appear, with your process
18400 * consuming a lot of CPU while it is busy spooling.
18402 * Genlist also implements a tree structure, but it does so with callbacks to
18403 * the application, with the application filling in tree structures when
18404 * requested (allowing for efficient building of a very deep tree that could
18405 * even be used for file-management). See the above smart signal callbacks for
18408 * @section Genlist_Smart_Events Genlist smart events
18410 * Signals that you can add callbacks for are:
18411 * - @c "activated" - The user has double-clicked or pressed
18412 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18413 * item that was activated.
18414 * - @c "clicked,double" - The user has double-clicked an item. The @c
18415 * event_info parameter is the item that was double-clicked.
18416 * - @c "selected" - This is called when a user has made an item selected.
18417 * The event_info parameter is the genlist item that was selected.
18418 * - @c "unselected" - This is called when a user has made an item
18419 * unselected. The event_info parameter is the genlist item that was
18421 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18422 * called and the item is now meant to be expanded. The event_info
18423 * parameter is the genlist item that was indicated to expand. It is the
18424 * job of this callback to then fill in the child items.
18425 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18426 * called and the item is now meant to be contracted. The event_info
18427 * parameter is the genlist item that was indicated to contract. It is the
18428 * job of this callback to then delete the child items.
18429 * - @c "expand,request" - This is called when a user has indicated they want
18430 * to expand a tree branch item. The callback should decide if the item can
18431 * expand (has any children) and then call elm_genlist_item_expanded_set()
18432 * appropriately to set the state. The event_info parameter is the genlist
18433 * item that was indicated to expand.
18434 * - @c "contract,request" - This is called when a user has indicated they
18435 * want to contract a tree branch item. The callback should decide if the
18436 * item can contract (has any children) and then call
18437 * elm_genlist_item_expanded_set() appropriately to set the state. The
18438 * event_info parameter is the genlist item that was indicated to contract.
18439 * - @c "realized" - This is called when the item in the list is created as a
18440 * real evas object. event_info parameter is the genlist item that was
18441 * created. The object may be deleted at any time, so it is up to the
18442 * caller to not use the object pointer from elm_genlist_item_object_get()
18443 * in a way where it may point to freed objects.
18444 * - @c "unrealized" - This is called just before an item is unrealized.
18445 * After this call content objects provided will be deleted and the item
18446 * object itself delete or be put into a floating cache.
18447 * - @c "drag,start,up" - This is called when the item in the list has been
18448 * dragged (not scrolled) up.
18449 * - @c "drag,start,down" - This is called when the item in the list has been
18450 * dragged (not scrolled) down.
18451 * - @c "drag,start,left" - This is called when the item in the list has been
18452 * dragged (not scrolled) left.
18453 * - @c "drag,start,right" - This is called when the item in the list has
18454 * been dragged (not scrolled) right.
18455 * - @c "drag,stop" - This is called when the item in the list has stopped
18457 * - @c "drag" - This is called when the item in the list is being dragged.
18458 * - @c "longpressed" - This is called when the item is pressed for a certain
18459 * amount of time. By default it's 1 second.
18460 * - @c "scroll,anim,start" - This is called when scrolling animation has
18462 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18464 * - @c "scroll,drag,start" - This is called when dragging the content has
18466 * - @c "scroll,drag,stop" - This is called when dragging the content has
18468 * - @c "edge,top" - This is called when the genlist is scrolled until
18470 * - @c "edge,bottom" - This is called when the genlist is scrolled
18471 * until the bottom edge.
18472 * - @c "edge,left" - This is called when the genlist is scrolled
18473 * until the left edge.
18474 * - @c "edge,right" - This is called when the genlist is scrolled
18475 * until the right edge.
18476 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18478 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18480 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18482 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18484 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18485 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18486 * multi-touch pinched in.
18487 * - @c "swipe" - This is called when the genlist is swiped.
18488 * - @c "moved" - This is called when a genlist item is moved.
18489 * - @c "language,changed" - This is called when the program's language is
18492 * @section Genlist_Examples Examples
18494 * Here is a list of examples that use the genlist, trying to show some of
18495 * its capabilities:
18496 * - @ref genlist_example_01
18497 * - @ref genlist_example_02
18498 * - @ref genlist_example_03
18499 * - @ref genlist_example_04
18500 * - @ref genlist_example_05
18504 * @addtogroup Genlist
18509 * @enum _Elm_Genlist_Item_Flags
18510 * @typedef Elm_Genlist_Item_Flags
18512 * Defines if the item is of any special type (has subitems or it's the
18513 * index of a group), or is just a simple item.
18517 typedef enum _Elm_Genlist_Item_Flags
18519 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18520 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18521 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18522 } Elm_Genlist_Item_Flags;
18523 typedef enum _Elm_Genlist_Item_Field_Flags
18525 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18526 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18527 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18528 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18529 } Elm_Genlist_Item_Field_Flags;
18530 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18531 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18532 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18533 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18534 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18535 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18536 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18537 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18540 * @struct _Elm_Genlist_Item_Class
18542 * Genlist item class definition structs.
18544 * This struct contains the style and fetching functions that will define the
18545 * contents of each item.
18547 * @see @ref Genlist_Item_Class
18549 struct _Elm_Genlist_Item_Class
18551 const char *item_style;
18553 GenlistItemLabelGetFunc label_get;
18554 GenlistItemIconGetFunc icon_get;
18555 GenlistItemStateGetFunc state_get;
18556 GenlistItemDelFunc del;
18557 GenlistItemMovedFunc moved;
18559 const char *edit_item_style;
18560 const char *mode_item_style;
18562 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18564 * Add a new genlist widget to the given parent Elementary
18565 * (container) object
18567 * @param parent The parent object
18568 * @return a new genlist widget handle or @c NULL, on errors
18570 * This function inserts a new genlist widget on the canvas.
18572 * @see elm_genlist_item_append()
18573 * @see elm_genlist_item_del()
18574 * @see elm_gen_clear()
18578 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18580 * Remove all items from a given genlist widget.
18582 * @param obj The genlist object
18584 * This removes (and deletes) all items in @p obj, leaving it empty.
18586 * This is deprecated. Please use elm_gen_clear() instead.
18588 * @see elm_genlist_item_del(), to remove just one item.
18592 WILL_DEPRECATE EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18594 * Enable or disable multi-selection in the genlist
18596 * @param obj The genlist object
18597 * @param multi Multi-select enable/disable. Default is disabled.
18599 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18600 * the list. This allows more than 1 item to be selected. To retrieve the list
18601 * of selected items, use elm_genlist_selected_items_get().
18603 * @see elm_genlist_selected_items_get()
18604 * @see elm_genlist_multi_select_get()
18608 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18610 * Gets if multi-selection in genlist is enabled or disabled.
18612 * @param obj The genlist object
18613 * @return Multi-select enabled/disabled
18614 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18616 * @see elm_genlist_multi_select_set()
18620 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18622 * This sets the horizontal stretching mode.
18624 * @param obj The genlist object
18625 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18627 * This sets the mode used for sizing items horizontally. Valid modes
18628 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18629 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18630 * the scroller will scroll horizontally. Otherwise items are expanded
18631 * to fill the width of the viewport of the scroller. If it is
18632 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18633 * limited to that size.
18635 * @see elm_genlist_horizontal_get()
18639 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18641 * Gets the horizontal stretching mode.
18643 * @param obj The genlist object
18644 * @return The mode to use
18645 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18647 * @see elm_genlist_horizontal_set()
18651 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18653 * Set the always select mode.
18655 * @param obj The genlist object
18656 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18657 * EINA_FALSE = off). Default is @c EINA_FALSE.
18659 * Items will only call their selection func and callback when first
18660 * becoming selected. Any further clicks will do nothing, unless you
18661 * enable always select with elm_gen_always_select_mode_set().
18662 * This means that, even if selected, every click will make the selected
18663 * callbacks be called.
18665 * This function is deprecated. please see elm_gen_always_select_mode_set()
18667 * @see elm_genlist_always_select_mode_get()
18671 WILL_DEPRECATE EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18673 * Get the always select mode.
18675 * @param obj The genlist object
18676 * @return The always select mode
18677 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18679 * @see elm_genlist_always_select_mode_set()
18683 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18685 * Enable/disable the no select mode.
18687 * @param obj The genlist object
18688 * @param no_select The no select mode
18689 * (EINA_TRUE = on, EINA_FALSE = off)
18691 * This will turn off the ability to select items entirely and they
18692 * will neither appear selected nor call selected callback functions.
18694 * @see elm_genlist_no_select_mode_get()
18698 WILL_DEPRECATE EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18700 * Gets whether the no select mode is enabled.
18702 * @param obj The genlist object
18703 * @return The no select mode
18704 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18706 * @see elm_genlist_no_select_mode_set()
18710 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18712 * Enable/disable compress mode.
18714 * @param obj The genlist object
18715 * @param compress The compress mode
18716 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18718 * This will enable the compress mode where items are "compressed"
18719 * horizontally to fit the genlist scrollable viewport width. This is
18720 * special for genlist. Do not rely on
18721 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18722 * work as genlist needs to handle it specially.
18724 * @see elm_genlist_compress_mode_get()
18728 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18730 * Get whether the compress mode is enabled.
18732 * @param obj The genlist object
18733 * @return The compress mode
18734 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18736 * @see elm_genlist_compress_mode_set()
18740 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18742 * Enable/disable height-for-width mode.
18744 * @param obj The genlist object
18745 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18746 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18748 * With height-for-width mode the item width will be fixed (restricted
18749 * to a minimum of) to the list width when calculating its size in
18750 * order to allow the height to be calculated based on it. This allows,
18751 * for instance, text block to wrap lines if the Edje part is
18752 * configured with "text.min: 0 1".
18754 * @note This mode will make list resize slower as it will have to
18755 * recalculate every item height again whenever the list width
18758 * @note When height-for-width mode is enabled, it also enables
18759 * compress mode (see elm_genlist_compress_mode_set()) and
18760 * disables homogeneous (see elm_genlist_homogeneous_set()).
18764 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18766 * Get whether the height-for-width mode is enabled.
18768 * @param obj The genlist object
18769 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18774 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18776 * Enable/disable horizontal and vertical bouncing effect.
18778 * @param obj The genlist object
18779 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18780 * EINA_FALSE = off). Default is @c EINA_FALSE.
18781 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18782 * EINA_FALSE = off). Default is @c EINA_TRUE.
18784 * This will enable or disable the scroller bouncing effect for the
18785 * genlist. See elm_scroller_bounce_set() for details.
18787 * @see elm_scroller_bounce_set()
18788 * @see elm_genlist_bounce_get()
18792 WILL_DEPRECATE EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18794 * Get whether the horizontal and vertical bouncing effect is enabled.
18796 * @param obj The genlist object
18797 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18799 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18802 * @see elm_genlist_bounce_set()
18806 WILL_DEPRECATE EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18808 * Enable/disable homogenous mode.
18810 * @param obj The genlist object
18811 * @param homogeneous Assume the items within the genlist are of the
18812 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18815 * This will enable the homogeneous mode where items are of the same
18816 * height and width so that genlist may do the lazy-loading at its
18817 * maximum (which increases the performance for scrolling the list). This
18818 * implies 'compressed' mode.
18820 * @see elm_genlist_compress_mode_set()
18821 * @see elm_genlist_homogeneous_get()
18825 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18827 * Get whether the homogenous mode is enabled.
18829 * @param obj The genlist object
18830 * @return Assume the items within the genlist are of the same height
18831 * and width (EINA_TRUE = on, EINA_FALSE = off)
18833 * @see elm_genlist_homogeneous_set()
18837 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18839 * Set the maximum number of items within an item block
18841 * @param obj The genlist object
18842 * @param n Maximum number of items within an item block. Default is 32.
18844 * This will configure the block count to tune to the target with
18845 * particular performance matrix.
18847 * A block of objects will be used to reduce the number of operations due to
18848 * many objects in the screen. It can determine the visibility, or if the
18849 * object has changed, it theme needs to be updated, etc. doing this kind of
18850 * calculation to the entire block, instead of per object.
18852 * The default value for the block count is enough for most lists, so unless
18853 * you know you will have a lot of objects visible in the screen at the same
18854 * time, don't try to change this.
18856 * @see elm_genlist_block_count_get()
18857 * @see @ref Genlist_Implementation
18861 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18863 * Get the maximum number of items within an item block
18865 * @param obj The genlist object
18866 * @return Maximum number of items within an item block
18868 * @see elm_genlist_block_count_set()
18872 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18874 * Set the timeout in seconds for the longpress event.
18876 * @param obj The genlist object
18877 * @param timeout timeout in seconds. Default is 1.
18879 * This option will change how long it takes to send an event "longpressed"
18880 * after the mouse down signal is sent to the list. If this event occurs, no
18881 * "clicked" event will be sent.
18883 * @see elm_genlist_longpress_timeout_set()
18887 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18889 * Get the timeout in seconds for the longpress event.
18891 * @param obj The genlist object
18892 * @return timeout in seconds
18894 * @see elm_genlist_longpress_timeout_get()
18898 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18900 * Append a new item in a given genlist widget.
18902 * @param obj The genlist object
18903 * @param itc The item class for the item
18904 * @param data The item data
18905 * @param parent The parent item, or NULL if none
18906 * @param flags Item flags
18907 * @param func Convenience function called when the item is selected
18908 * @param func_data Data passed to @p func above.
18909 * @return A handle to the item added or @c NULL if not possible
18911 * This adds the given item to the end of the list or the end of
18912 * the children list if the @p parent is given.
18914 * @see elm_genlist_item_prepend()
18915 * @see elm_genlist_item_insert_before()
18916 * @see elm_genlist_item_insert_after()
18917 * @see elm_genlist_item_del()
18921 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);
18923 * Prepend a new item in a given genlist widget.
18925 * @param obj The genlist object
18926 * @param itc The item class for the item
18927 * @param data The item data
18928 * @param parent The parent item, or NULL if none
18929 * @param flags Item flags
18930 * @param func Convenience function called when the item is selected
18931 * @param func_data Data passed to @p func above.
18932 * @return A handle to the item added or NULL if not possible
18934 * This adds an item to the beginning of the list or beginning of the
18935 * children of the parent if given.
18937 * @see elm_genlist_item_append()
18938 * @see elm_genlist_item_insert_before()
18939 * @see elm_genlist_item_insert_after()
18940 * @see elm_genlist_item_del()
18944 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);
18946 * Insert an item before another in a genlist widget
18948 * @param obj The genlist object
18949 * @param itc The item class for the item
18950 * @param data The item data
18951 * @param before The item to place this new one before.
18952 * @param flags Item flags
18953 * @param func Convenience function called when the item is selected
18954 * @param func_data Data passed to @p func above.
18955 * @return A handle to the item added or @c NULL if not possible
18957 * This inserts an item before another in the list. It will be in the
18958 * same tree level or group as the item it is inserted before.
18960 * @see elm_genlist_item_append()
18961 * @see elm_genlist_item_prepend()
18962 * @see elm_genlist_item_insert_after()
18963 * @see elm_genlist_item_del()
18967 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);
18969 * Insert an item after another in a genlist widget
18971 * @param obj The genlist object
18972 * @param itc The item class for the item
18973 * @param data The item data
18974 * @param after The item to place this new one after.
18975 * @param flags Item flags
18976 * @param func Convenience function called when the item is selected
18977 * @param func_data Data passed to @p func above.
18978 * @return A handle to the item added or @c NULL if not possible
18980 * This inserts an item after another in the list. It will be in the
18981 * same tree level or group as the item it is inserted after.
18983 * @see elm_genlist_item_append()
18984 * @see elm_genlist_item_prepend()
18985 * @see elm_genlist_item_insert_before()
18986 * @see elm_genlist_item_del()
18990 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);
18992 * Insert a new item into the sorted genlist object
18994 * @param obj The genlist object
18995 * @param itc The item class for the item
18996 * @param data The item data
18997 * @param parent The parent item, or NULL if none
18998 * @param flags Item flags
18999 * @param comp The function called for the sort
19000 * @param func Convenience function called when item selected
19001 * @param func_data Data passed to @p func above.
19002 * @return A handle to the item added or NULL if not possible
19006 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);
19007 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);
19008 /* operations to retrieve existing items */
19010 * Get the selectd item in the genlist.
19012 * @param obj The genlist object
19013 * @return The selected item, or NULL if none is selected.
19015 * This gets the selected item in the list (if multi-selection is enabled, only
19016 * the item that was first selected in the list is returned - which is not very
19017 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19020 * If no item is selected, NULL is returned.
19022 * @see elm_genlist_selected_items_get()
19026 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19028 * Get a list of selected items in the genlist.
19030 * @param obj The genlist object
19031 * @return The list of selected items, or NULL if none are selected.
19033 * It returns a list of the selected items. This list pointer is only valid so
19034 * long as the selection doesn't change (no items are selected or unselected, or
19035 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19036 * pointers. The order of the items in this list is the order which they were
19037 * selected, i.e. the first item in this list is the first item that was
19038 * selected, and so on.
19040 * @note If not in multi-select mode, consider using function
19041 * elm_genlist_selected_item_get() instead.
19043 * @see elm_genlist_multi_select_set()
19044 * @see elm_genlist_selected_item_get()
19048 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19050 * Get the mode item style of items in the genlist
19051 * @param obj The genlist object
19052 * @return The mode item style string, or NULL if none is specified
19054 * This is a constant string and simply defines the name of the
19055 * style that will be used for mode animations. It can be
19056 * @c NULL if you don't plan to use Genlist mode. See
19057 * elm_genlist_item_mode_set() for more info.
19061 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19063 * Set the mode item style of items in the genlist
19064 * @param obj The genlist object
19065 * @param style The mode item style string, or NULL if none is desired
19067 * This is a constant string and simply defines the name of the
19068 * style that will be used for mode animations. It can be
19069 * @c NULL if you don't plan to use Genlist mode. See
19070 * elm_genlist_item_mode_set() for more info.
19074 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19076 * Get a list of realized items in genlist
19078 * @param obj The genlist object
19079 * @return The list of realized items, nor NULL if none are realized.
19081 * This returns a list of the realized items in the genlist. The list
19082 * contains Elm_Genlist_Item pointers. The list must be freed by the
19083 * caller when done with eina_list_free(). The item pointers in the
19084 * list are only valid so long as those items are not deleted or the
19085 * genlist is not deleted.
19087 * @see elm_genlist_realized_items_update()
19091 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19093 * Get the item that is at the x, y canvas coords.
19095 * @param obj The gelinst object.
19096 * @param x The input x coordinate
19097 * @param y The input y coordinate
19098 * @param posret The position relative to the item returned here
19099 * @return The item at the coordinates or NULL if none
19101 * This returns the item at the given coordinates (which are canvas
19102 * relative, not object-relative). If an item is at that coordinate,
19103 * that item handle is returned, and if @p posret is not NULL, the
19104 * integer pointed to is set to a value of -1, 0 or 1, depending if
19105 * the coordinate is on the upper portion of that item (-1), on the
19106 * middle section (0) or on the lower part (1). If NULL is returned as
19107 * an item (no item found there), then posret may indicate -1 or 1
19108 * based if the coordinate is above or below all items respectively in
19113 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);
19115 * Get the first item in the genlist
19117 * This returns the first item in the list.
19119 * @param obj The genlist object
19120 * @return The first item, or NULL if none
19124 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19126 * Get the last item in the genlist
19128 * This returns the last item in the list.
19130 * @return The last item, or NULL if none
19134 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19136 * Set the scrollbar policy
19138 * @param obj The genlist object
19139 * @param policy_h Horizontal scrollbar policy.
19140 * @param policy_v Vertical scrollbar policy.
19142 * This sets the scrollbar visibility policy for the given genlist
19143 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19144 * made visible if it is needed, and otherwise kept hidden.
19145 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19146 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19147 * respectively for the horizontal and vertical scrollbars. Default is
19148 * #ELM_SMART_SCROLLER_POLICY_AUTO
19150 * @see elm_genlist_scroller_policy_get()
19154 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19156 * Get the scrollbar policy
19158 * @param obj The genlist object
19159 * @param policy_h Pointer to store the horizontal scrollbar policy.
19160 * @param policy_v Pointer to store the vertical scrollbar policy.
19162 * @see elm_genlist_scroller_policy_set()
19166 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);
19168 * Get the @b next item in a genlist widget's internal list of items,
19169 * given a handle to one of those items.
19171 * @param item The genlist item to fetch next from
19172 * @return The item after @p item, or @c NULL if there's none (and
19175 * This returns the item placed after the @p item, on the container
19178 * @see elm_genlist_item_prev_get()
19182 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19184 * Get the @b previous item in a genlist widget's internal list of items,
19185 * given a handle to one of those items.
19187 * @param item The genlist item to fetch previous from
19188 * @return The item before @p item, or @c NULL if there's none (and
19191 * This returns the item placed before the @p item, on the container
19194 * @see elm_genlist_item_next_get()
19198 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19200 * Get the genlist object's handle which contains a given genlist
19203 * @param item The item to fetch the container from
19204 * @return The genlist (parent) object
19206 * This returns the genlist object itself that an item belongs to.
19208 * This function is deprecated. Please use elm_gen_item_widget_get()
19212 WILL_DEPRECATE EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19214 * Get the parent item of the given item
19216 * @param it The item
19217 * @return The parent of the item or @c NULL if it has no parent.
19219 * This returns the item that was specified as parent of the item @p it on
19220 * elm_genlist_item_append() and insertion related functions.
19224 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19226 * Remove all sub-items (children) of the given item
19228 * @param it The item
19230 * This removes all items that are children (and their descendants) of the
19231 * given item @p it.
19233 * @see elm_genlist_clear()
19234 * @see elm_genlist_item_del()
19238 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19240 * Set whether a given genlist item is selected or not
19242 * @param it The item
19243 * @param selected Use @c EINA_TRUE, to make it selected, @c
19244 * EINA_FALSE to make it unselected
19246 * This sets the selected state of an item. If multi selection is
19247 * not enabled on the containing genlist and @p selected is @c
19248 * EINA_TRUE, any other previously selected items will get
19249 * unselected in favor of this new one.
19251 * @see elm_genlist_item_selected_get()
19255 WILL_DEPRECATE EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19257 * Get whether a given genlist item is selected or not
19259 * @param it The item
19260 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19262 * @see elm_genlist_item_selected_set() for more details
19266 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19268 * Sets the expanded state of an item.
19270 * @param it The item
19271 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19273 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19276 * The theme will respond to this change visually, and a signal "expanded" or
19277 * "contracted" will be sent from the genlist with a pointer to the item that
19278 * has been expanded/contracted.
19280 * Calling this function won't show or hide any child of this item (if it is
19281 * a parent). You must manually delete and create them on the callbacks fo
19282 * the "expanded" or "contracted" signals.
19284 * @see elm_genlist_item_expanded_get()
19288 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19290 * Get the expanded state of an item
19292 * @param it The item
19293 * @return The expanded state
19295 * This gets the expanded state of an item.
19297 * @see elm_genlist_item_expanded_set()
19301 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19303 * Get the depth of expanded item
19305 * @param it The genlist item object
19306 * @return The depth of expanded item
19310 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19312 * Set whether a given genlist item is disabled or not.
19314 * @param it The item
19315 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19316 * to enable it back.
19318 * A disabled item cannot be selected or unselected. It will also
19319 * change its appearance, to signal the user it's disabled.
19321 * @see elm_genlist_item_disabled_get()
19325 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19327 * Get whether a given genlist item is disabled or not.
19329 * @param it The item
19330 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19333 * @see elm_genlist_item_disabled_set() for more details
19337 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19339 * Sets the display only state of an item.
19341 * @param it The item
19342 * @param display_only @c EINA_TRUE if the item is display only, @c
19343 * EINA_FALSE otherwise.
19345 * A display only item cannot be selected or unselected. It is for
19346 * display only and not selecting or otherwise clicking, dragging
19347 * etc. by the user, thus finger size rules will not be applied to
19350 * It's good to set group index items to display only state.
19352 * @see elm_genlist_item_display_only_get()
19356 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19358 * Get the display only state of an item
19360 * @param it The item
19361 * @return @c EINA_TRUE if the item is display only, @c
19362 * EINA_FALSE otherwise.
19364 * @see elm_genlist_item_display_only_set()
19368 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19370 * Show the portion of a genlist's internal list containing a given
19371 * item, immediately.
19373 * @param it The item to display
19375 * This causes genlist to jump to the given item @p it and show it (by
19376 * immediately scrolling to that position), if it is not fully visible.
19378 * @see elm_genlist_item_bring_in()
19379 * @see elm_genlist_item_top_show()
19380 * @see elm_genlist_item_middle_show()
19384 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19386 * Animatedly bring in, to the visible are of a genlist, a given
19389 * @param it The item to display
19391 * This causes genlist to jump to the given item @p it and show it (by
19392 * animatedly scrolling), if it is not fully visible. This may use animation
19393 * to do so and take a period of time
19395 * @see elm_genlist_item_show()
19396 * @see elm_genlist_item_top_bring_in()
19397 * @see elm_genlist_item_middle_bring_in()
19401 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19403 * Show the portion of a genlist's internal list containing a given
19404 * item, immediately.
19406 * @param it The item to display
19408 * This causes genlist to jump to the given item @p it and show it (by
19409 * immediately scrolling to that position), if it is not fully visible.
19411 * The item will be positioned at the top of the genlist viewport.
19413 * @see elm_genlist_item_show()
19414 * @see elm_genlist_item_top_bring_in()
19418 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19420 * Animatedly bring in, to the visible are of a genlist, a given
19423 * @param it The item
19425 * This causes genlist to jump to the given item @p it and show it (by
19426 * animatedly scrolling), if it is not fully visible. This may use animation
19427 * to do so and take a period of time
19429 * The item will be positioned at the top of the genlist viewport.
19431 * @see elm_genlist_item_bring_in()
19432 * @see elm_genlist_item_top_show()
19436 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19438 * Show the portion of a genlist's internal list containing a given
19439 * item, immediately.
19441 * @param it The item to display
19443 * This causes genlist to jump to the given item @p it and show it (by
19444 * immediately scrolling to that position), if it is not fully visible.
19446 * The item will be positioned at the middle of the genlist viewport.
19448 * @see elm_genlist_item_show()
19449 * @see elm_genlist_item_middle_bring_in()
19453 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19455 * Animatedly bring in, to the visible are of a genlist, a given
19458 * @param it The item
19460 * This causes genlist to jump to the given item @p it and show it (by
19461 * animatedly scrolling), if it is not fully visible. This may use animation
19462 * to do so and take a period of time
19464 * The item will be positioned at the middle of the genlist viewport.
19466 * @see elm_genlist_item_bring_in()
19467 * @see elm_genlist_item_middle_show()
19471 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19473 * Remove a genlist item from the its parent, deleting it.
19475 * @param item The item to be removed.
19476 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19478 * @see elm_genlist_clear(), to remove all items in a genlist at
19483 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19485 * Return the data associated to a given genlist item
19487 * @param item The genlist item.
19488 * @return the data associated to this item.
19490 * This returns the @c data value passed on the
19491 * elm_genlist_item_append() and related item addition calls.
19493 * @see elm_genlist_item_append()
19494 * @see elm_genlist_item_data_set()
19498 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19500 * Set the data associated to a given genlist item
19502 * @param item The genlist item
19503 * @param data The new data pointer to set on it
19505 * This @b overrides the @c data value passed on the
19506 * elm_genlist_item_append() and related item addition calls. This
19507 * function @b won't call elm_genlist_item_update() automatically,
19508 * so you'd issue it afterwards if you want to hove the item
19509 * updated to reflect the that new data.
19511 * @see elm_genlist_item_data_get()
19515 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19517 * Tells genlist to "orphan" icons fetchs by the item class
19519 * @param it The item
19521 * This instructs genlist to release references to icons in the item,
19522 * meaning that they will no longer be managed by genlist and are
19523 * floating "orphans" that can be re-used elsewhere if the user wants
19528 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19529 WILL_DEPRECATE EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19531 * Get the real Evas object created to implement the view of a
19532 * given genlist item
19534 * @param item The genlist item.
19535 * @return the Evas object implementing this item's view.
19537 * This returns the actual Evas object used to implement the
19538 * specified genlist item's view. This may be @c NULL, as it may
19539 * not have been created or may have been deleted, at any time, by
19540 * the genlist. <b>Do not modify this object</b> (move, resize,
19541 * show, hide, etc.), as the genlist is controlling it. This
19542 * function is for querying, emitting custom signals or hooking
19543 * lower level callbacks for events on that object. Do not delete
19544 * this object under any circumstances.
19546 * @see elm_genlist_item_data_get()
19550 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19552 * Update the contents of an item
19554 * @param it The item
19556 * This updates an item by calling all the item class functions again
19557 * to get the icons, labels and states. Use this when the original
19558 * item data has changed and the changes are desired to be reflected.
19560 * Use elm_genlist_realized_items_update() to update all already realized
19563 * @see elm_genlist_realized_items_update()
19567 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19568 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19570 * Update the item class of an item
19572 * @param it The item
19573 * @param itc The item class for the item
19575 * This sets another class fo the item, changing the way that it is
19576 * displayed. After changing the item class, elm_genlist_item_update() is
19577 * called on the item @p it.
19581 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19582 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19584 * Set the text to be shown in a given genlist item's tooltips.
19586 * @param item The genlist item
19587 * @param text The text to set in the content
19589 * This call will setup the text to be used as tooltip to that item
19590 * (analogous to elm_object_tooltip_text_set(), but being item
19591 * tooltips with higher precedence than object tooltips). It can
19592 * have only one tooltip at a time, so any previous tooltip data
19593 * will get removed.
19595 * In order to set an icon or something else as a tooltip, look at
19596 * elm_genlist_item_tooltip_content_cb_set().
19600 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19602 * Set the content to be shown in a given genlist item's tooltips
19604 * @param item The genlist item.
19605 * @param func The function returning the tooltip contents.
19606 * @param data What to provide to @a func as callback data/context.
19607 * @param del_cb Called when data is not needed anymore, either when
19608 * another callback replaces @p func, the tooltip is unset with
19609 * elm_genlist_item_tooltip_unset() or the owner @p item
19610 * dies. This callback receives as its first parameter the
19611 * given @p data, being @c event_info the item handle.
19613 * This call will setup the tooltip's contents to @p item
19614 * (analogous to elm_object_tooltip_content_cb_set(), but being
19615 * item tooltips with higher precedence than object tooltips). It
19616 * can have only one tooltip at a time, so any previous tooltip
19617 * content will get removed. @p func (with @p data) will be called
19618 * every time Elementary needs to show the tooltip and it should
19619 * return a valid Evas object, which will be fully managed by the
19620 * tooltip system, getting deleted when the tooltip is gone.
19622 * In order to set just a text as a tooltip, look at
19623 * elm_genlist_item_tooltip_text_set().
19627 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);
19629 * Unset a tooltip from a given genlist item
19631 * @param item genlist item to remove a previously set tooltip from.
19633 * This call removes any tooltip set on @p item. The callback
19634 * provided as @c del_cb to
19635 * elm_genlist_item_tooltip_content_cb_set() will be called to
19636 * notify it is not used anymore (and have resources cleaned, if
19639 * @see elm_genlist_item_tooltip_content_cb_set()
19643 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19645 * Set a different @b style for a given genlist item's tooltip.
19647 * @param item genlist item with tooltip set
19648 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19649 * "default", @c "transparent", etc)
19651 * Tooltips can have <b>alternate styles</b> to be displayed on,
19652 * which are defined by the theme set on Elementary. This function
19653 * works analogously as elm_object_tooltip_style_set(), but here
19654 * applied only to genlist item objects. The default style for
19655 * tooltips is @c "default".
19657 * @note before you set a style you should define a tooltip with
19658 * elm_genlist_item_tooltip_content_cb_set() or
19659 * elm_genlist_item_tooltip_text_set()
19661 * @see elm_genlist_item_tooltip_style_get()
19665 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19667 * Get the style set a given genlist item's tooltip.
19669 * @param item genlist item with tooltip already set on.
19670 * @return style the theme style in use, which defaults to
19671 * "default". If the object does not have a tooltip set,
19672 * then @c NULL is returned.
19674 * @see elm_genlist_item_tooltip_style_set() for more details
19678 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19680 * @brief Disable size restrictions on an object's tooltip
19681 * @param item The tooltip's anchor object
19682 * @param disable If EINA_TRUE, size restrictions are disabled
19683 * @return EINA_FALSE on failure, EINA_TRUE on success
19685 * This function allows a tooltip to expand beyond its parant window's canvas.
19686 * It will instead be limited only by the size of the display.
19688 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19690 * @brief Retrieve size restriction state of an object's tooltip
19691 * @param item The tooltip's anchor object
19692 * @return If EINA_TRUE, size restrictions are disabled
19694 * This function returns whether a tooltip is allowed to expand beyond
19695 * its parant window's canvas.
19696 * It will instead be limited only by the size of the display.
19698 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19700 * Set the type of mouse pointer/cursor decoration to be shown,
19701 * when the mouse pointer is over the given genlist widget item
19703 * @param item genlist item to customize cursor on
19704 * @param cursor the cursor type's name
19706 * This function works analogously as elm_object_cursor_set(), but
19707 * here the cursor's changing area is restricted to the item's
19708 * area, and not the whole widget's. Note that that item cursors
19709 * have precedence over widget cursors, so that a mouse over @p
19710 * item will always show cursor @p type.
19712 * If this function is called twice for an object, a previously set
19713 * cursor will be unset on the second call.
19715 * @see elm_object_cursor_set()
19716 * @see elm_genlist_item_cursor_get()
19717 * @see elm_genlist_item_cursor_unset()
19721 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19723 * Get the type of mouse pointer/cursor decoration set to be shown,
19724 * when the mouse pointer is over the given genlist widget item
19726 * @param item genlist item with custom cursor set
19727 * @return the cursor type's name or @c NULL, if no custom cursors
19728 * were set to @p item (and on errors)
19730 * @see elm_object_cursor_get()
19731 * @see elm_genlist_item_cursor_set() for more details
19732 * @see elm_genlist_item_cursor_unset()
19736 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19738 * Unset any custom mouse pointer/cursor decoration set to be
19739 * shown, when the mouse pointer is over the given genlist widget
19740 * item, thus making it show the @b default cursor again.
19742 * @param item a genlist item
19744 * Use this call to undo any custom settings on this item's cursor
19745 * decoration, bringing it back to defaults (no custom style set).
19747 * @see elm_object_cursor_unset()
19748 * @see elm_genlist_item_cursor_set() for more details
19752 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19754 * Set a different @b style for a given custom cursor set for a
19757 * @param item genlist item with custom cursor set
19758 * @param style the <b>theme style</b> to use (e.g. @c "default",
19759 * @c "transparent", etc)
19761 * This function only makes sense when one is using custom mouse
19762 * cursor decorations <b>defined in a theme file</b> , which can
19763 * have, given a cursor name/type, <b>alternate styles</b> on
19764 * it. It works analogously as elm_object_cursor_style_set(), but
19765 * here applied only to genlist item objects.
19767 * @warning Before you set a cursor style you should have defined a
19768 * custom cursor previously on the item, with
19769 * elm_genlist_item_cursor_set()
19771 * @see elm_genlist_item_cursor_engine_only_set()
19772 * @see elm_genlist_item_cursor_style_get()
19776 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19778 * Get the current @b style set for a given genlist item's custom
19781 * @param item genlist item with custom cursor set.
19782 * @return style the cursor style in use. If the object does not
19783 * have a cursor set, then @c NULL is returned.
19785 * @see elm_genlist_item_cursor_style_set() for more details
19789 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19791 * Set if the (custom) cursor for a given genlist item should be
19792 * searched in its theme, also, or should only rely on the
19793 * rendering engine.
19795 * @param item item with custom (custom) cursor already set on
19796 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19797 * only on those provided by the rendering engine, @c EINA_FALSE to
19798 * have them searched on the widget's theme, as well.
19800 * @note This call is of use only if you've set a custom cursor
19801 * for genlist items, with elm_genlist_item_cursor_set().
19803 * @note By default, cursors will only be looked for between those
19804 * provided by the rendering engine.
19808 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19810 * Get if the (custom) cursor for a given genlist item is being
19811 * searched in its theme, also, or is only relying on the rendering
19814 * @param item a genlist item
19815 * @return @c EINA_TRUE, if cursors are being looked for only on
19816 * those provided by the rendering engine, @c EINA_FALSE if they
19817 * are being searched on the widget's theme, as well.
19819 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19823 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19825 * Update the contents of all realized items.
19827 * @param obj The genlist object.
19829 * This updates all realized items by calling all the item class functions again
19830 * to get the icons, labels and states. Use this when the original
19831 * item data has changed and the changes are desired to be reflected.
19833 * To update just one item, use elm_genlist_item_update().
19835 * @see elm_genlist_realized_items_get()
19836 * @see elm_genlist_item_update()
19840 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19842 * Activate a genlist mode on an item
19844 * @param item The genlist item
19845 * @param mode Mode name
19846 * @param mode_set Boolean to define set or unset mode.
19848 * A genlist mode is a different way of selecting an item. Once a mode is
19849 * activated on an item, any other selected item is immediately unselected.
19850 * This feature provides an easy way of implementing a new kind of animation
19851 * for selecting an item, without having to entirely rewrite the item style
19852 * theme. However, the elm_genlist_selected_* API can't be used to get what
19853 * item is activate for a mode.
19855 * The current item style will still be used, but applying a genlist mode to
19856 * an item will select it using a different kind of animation.
19858 * The current active item for a mode can be found by
19859 * elm_genlist_mode_item_get().
19861 * The characteristics of genlist mode are:
19862 * - Only one mode can be active at any time, and for only one item.
19863 * - Genlist handles deactivating other items when one item is activated.
19864 * - A mode is defined in the genlist theme (edc), and more modes can easily
19866 * - A mode style and the genlist item style are different things. They
19867 * can be combined to provide a default style to the item, with some kind
19868 * of animation for that item when the mode is activated.
19870 * When a mode is activated on an item, a new view for that item is created.
19871 * The theme of this mode defines the animation that will be used to transit
19872 * the item from the old view to the new view. This second (new) view will be
19873 * active for that item while the mode is active on the item, and will be
19874 * destroyed after the mode is totally deactivated from that item.
19876 * @see elm_genlist_mode_get()
19877 * @see elm_genlist_mode_item_get()
19881 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19883 * Get the last (or current) genlist mode used.
19885 * @param obj The genlist object
19887 * This function just returns the name of the last used genlist mode. It will
19888 * be the current mode if it's still active.
19890 * @see elm_genlist_item_mode_set()
19891 * @see elm_genlist_mode_item_get()
19895 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19897 * Get active genlist mode item
19899 * @param obj The genlist object
19900 * @return The active item for that current mode. Or @c NULL if no item is
19901 * activated with any mode.
19903 * This function returns the item that was activated with a mode, by the
19904 * function elm_genlist_item_mode_set().
19906 * @see elm_genlist_item_mode_set()
19907 * @see elm_genlist_mode_get()
19911 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19916 * @param obj The genlist object
19917 * @param reorder_mode The reorder mode
19918 * (EINA_TRUE = on, EINA_FALSE = off)
19922 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19925 * Get the reorder mode
19927 * @param obj The genlist object
19928 * @return The reorder mode
19929 * (EINA_TRUE = on, EINA_FALSE = off)
19933 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19935 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19936 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19937 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19938 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19939 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19940 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19941 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19942 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19943 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19944 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19951 * @defgroup Check Check
19953 * @image html img/widget/check/preview-00.png
19954 * @image latex img/widget/check/preview-00.eps
19955 * @image html img/widget/check/preview-01.png
19956 * @image latex img/widget/check/preview-01.eps
19957 * @image html img/widget/check/preview-02.png
19958 * @image latex img/widget/check/preview-02.eps
19960 * @brief The check widget allows for toggling a value between true and
19963 * Check objects are a lot like radio objects in layout and functionality
19964 * except they do not work as a group, but independently and only toggle the
19965 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19966 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19967 * returns the current state. For convenience, like the radio objects, you
19968 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19969 * for it to modify.
19971 * Signals that you can add callbacks for are:
19972 * "changed" - This is called whenever the user changes the state of one of
19973 * the check object(event_info is NULL).
19975 * Default contents parts of the check widget that you can use for are:
19976 * @li "icon" - A icon of the check
19978 * Default text parts of the check widget that you can use for are:
19979 * @li "elm.text" - Label of the check
19981 * @ref tutorial_check should give you a firm grasp of how to use this widget
19986 * @brief Add a new Check object
19988 * @param parent The parent object
19989 * @return The new object or NULL if it cannot be created
19991 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19993 * @brief Set the text label of the check object
19995 * @param obj The check object
19996 * @param label The text label string in UTF-8
19998 * @deprecated use elm_object_text_set() instead.
20000 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20002 * @brief Get the text label of the check object
20004 * @param obj The check object
20005 * @return The text label string in UTF-8
20007 * @deprecated use elm_object_text_get() instead.
20009 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20011 * @brief Set the icon object of the check object
20013 * @param obj The check object
20014 * @param icon The icon object
20016 * Once the icon object is set, a previously set one will be deleted.
20017 * If you want to keep that old content object, use the
20018 * elm_object_content_unset() function.
20020 * @deprecated use elm_object_part_content_set() instead.
20023 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20025 * @brief Get the icon object of the check object
20027 * @param obj The check object
20028 * @return The icon object
20030 * @deprecated use elm_object_part_content_get() instead.
20033 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20035 * @brief Unset the icon used for the check object
20037 * @param obj The check object
20038 * @return The icon object that was being used
20040 * Unparent and return the icon object which was set for this widget.
20042 * @deprecated use elm_object_part_content_unset() instead.
20045 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20047 * @brief Set the on/off state of the check object
20049 * @param obj The check object
20050 * @param state The state to use (1 == on, 0 == off)
20052 * This sets the state of the check. If set
20053 * with elm_check_state_pointer_set() the state of that variable is also
20054 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20056 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20058 * @brief Get the state of the check object
20060 * @param obj The check object
20061 * @return The boolean state
20063 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20065 * @brief Set a convenience pointer to a boolean to change
20067 * @param obj The check object
20068 * @param statep Pointer to the boolean to modify
20070 * This sets a pointer to a boolean, that, in addition to the check objects
20071 * state will also be modified directly. To stop setting the object pointed
20072 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20073 * then when this is called, the check objects state will also be modified to
20074 * reflect the value of the boolean @p statep points to, just like calling
20075 * elm_check_state_set().
20077 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20082 /* compatibility code for toggle controls */
20084 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
20088 obj = elm_check_add(parent);
20089 elm_object_style_set(obj, "toggle");
20090 elm_object_part_text_set(obj, "on", "ON");
20091 elm_object_part_text_set(obj, "off", "OFF");
20095 EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
20097 elm_object_text_set(obj, label);
20100 EINA_DEPRECATED EAPI extern inline const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20102 return elm_object_text_get(obj);
20105 EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
20107 elm_object_content_set(obj, icon);
20110 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20112 return elm_object_content_get(obj);
20115 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
20117 return elm_object_content_unset(obj);
20120 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
20122 elm_object_part_text_set(obj, "on", onlabel);
20123 elm_object_part_text_set(obj, "off", offlabel);
20126 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1)
20128 if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
20129 if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20132 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20134 elm_check_state_set(obj, state);
20137 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20139 return elm_check_state_get(obj);
20142 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20144 elm_check_state_pointer_set(obj, statep);
20148 * @defgroup Radio Radio
20150 * @image html img/widget/radio/preview-00.png
20151 * @image latex img/widget/radio/preview-00.eps
20153 * @brief Radio is a widget that allows for 1 or more options to be displayed
20154 * and have the user choose only 1 of them.
20156 * A radio object contains an indicator, an optional Label and an optional
20157 * icon object. While it's possible to have a group of only one radio they,
20158 * are normally used in groups of 2 or more. To add a radio to a group use
20159 * elm_radio_group_add(). The radio object(s) will select from one of a set
20160 * of integer values, so any value they are configuring needs to be mapped to
20161 * a set of integers. To configure what value that radio object represents,
20162 * use elm_radio_state_value_set() to set the integer it represents. To set
20163 * the value the whole group(which one is currently selected) is to indicate
20164 * use elm_radio_value_set() on any group member, and to get the groups value
20165 * use elm_radio_value_get(). For convenience the radio objects are also able
20166 * to directly set an integer(int) to the value that is selected. To specify
20167 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20168 * The radio objects will modify this directly. That implies the pointer must
20169 * point to valid memory for as long as the radio objects exist.
20171 * Signals that you can add callbacks for are:
20172 * @li changed - This is called whenever the user changes the state of one of
20173 * the radio objects within the group of radio objects that work together.
20175 * Default contents parts of the radio widget that you can use for are:
20176 * @li "icon" - A icon of the radio
20178 * @ref tutorial_radio show most of this API in action.
20182 * @brief Add a new radio to the parent
20184 * @param parent The parent object
20185 * @return The new object or NULL if it cannot be created
20187 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20189 * @brief Set the text label of the radio object
20191 * @param obj The radio object
20192 * @param label The text label string in UTF-8
20194 * @deprecated use elm_object_text_set() instead.
20196 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20198 * @brief Get the text label of the radio object
20200 * @param obj The radio object
20201 * @return The text label string in UTF-8
20203 * @deprecated use elm_object_text_set() instead.
20205 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20207 * @brief Set the icon object of the radio object
20209 * @param obj The radio object
20210 * @param icon The icon object
20212 * Once the icon object is set, a previously set one will be deleted. If you
20213 * want to keep that old content object, use the elm_radio_icon_unset()
20216 * @deprecated use elm_object_part_content_set() instead.
20219 WILL_DEPRECATE EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20221 * @brief Get the icon object of the radio object
20223 * @param obj The radio object
20224 * @return The icon object
20226 * @see elm_radio_icon_set()
20228 * @deprecated use elm_object_part_content_get() instead.
20231 WILL_DEPRECATE EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20233 * @brief Unset the icon used for the radio object
20235 * @param obj The radio object
20236 * @return The icon object that was being used
20238 * Unparent and return the icon object which was set for this widget.
20240 * @see elm_radio_icon_set()
20241 * @deprecated use elm_object_part_content_unset() instead.
20244 WILL_DEPRECATE EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20246 * @brief Add this radio to a group of other radio objects
20248 * @param obj The radio object
20249 * @param group Any object whose group the @p obj is to join.
20251 * Radio objects work in groups. Each member should have a different integer
20252 * value assigned. In order to have them work as a group, they need to know
20253 * about each other. This adds the given radio object to the group of which
20254 * the group object indicated is a member.
20256 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20258 * @brief Set the integer value that this radio object represents
20260 * @param obj The radio object
20261 * @param value The value to use if this radio object is selected
20263 * This sets the value of the radio.
20265 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20267 * @brief Get the integer value that this radio object represents
20269 * @param obj The radio object
20270 * @return The value used if this radio object is selected
20272 * This gets the value of the radio.
20274 * @see elm_radio_value_set()
20276 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20278 * @brief Set the value of the radio.
20280 * @param obj The radio object
20281 * @param value The value to use for the group
20283 * This sets the value of the radio group and will also set the value if
20284 * pointed to, to the value supplied, but will not call any callbacks.
20286 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20288 * @brief Get the state of the radio object
20290 * @param obj The radio object
20291 * @return The integer state
20293 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20295 * @brief Set a convenience pointer to a integer to change
20297 * @param obj The radio object
20298 * @param valuep Pointer to the integer to modify
20300 * This sets a pointer to a integer, that, in addition to the radio objects
20301 * state will also be modified directly. To stop setting the object pointed
20302 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20303 * when this is called, the radio objects state will also be modified to
20304 * reflect the value of the integer valuep points to, just like calling
20305 * elm_radio_value_set().
20307 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20313 * @defgroup Pager Pager
20315 * @image html img/widget/pager/preview-00.png
20316 * @image latex img/widget/pager/preview-00.eps
20318 * @brief Widget that allows flipping between one or more “pages”
20321 * The flipping between pages of objects is animated. All content
20322 * in the pager is kept in a stack, being the last content added
20323 * (visible one) on the top of that stack.
20325 * Objects can be pushed or popped from the stack or deleted as
20326 * well. Pushes and pops will animate the widget accordingly to its
20327 * style (a pop will also delete the child object once the
20328 * animation is finished). Any object already in the pager can be
20329 * promoted to the top (from its current stacking position) through
20330 * the use of elm_pager_content_promote(). New objects are pushed
20331 * to the top with elm_pager_content_push(). When the top item is
20332 * no longer wanted, simply pop it with elm_pager_content_pop() and
20333 * it will also be deleted. If an object is no longer needed and is
20334 * not the top item, just delete it as normal. You can query which
20335 * objects are the top and bottom with
20336 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20338 * Signals that you can add callbacks for are:
20339 * - @c "show,finished" - when a new page is actually shown on the top
20340 * - @c "hide,finished" - when a previous page is hidden
20342 * Only after the first of that signals the child object is
20343 * guaranteed to be visible, as in @c evas_object_visible_get().
20345 * This widget has the following styles available:
20348 * - @c "fade_translucide"
20349 * - @c "fade_invisible"
20351 * @note These styles affect only the flipping animations on the
20352 * default theme; the appearance when not animating is unaffected
20355 * @ref tutorial_pager gives a good overview of the usage of the API.
20360 * Add a new pager to the parent
20362 * @param parent The parent object
20363 * @return The new object or NULL if it cannot be created
20367 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20370 * @brief Push an object to the top of the pager stack (and show it).
20372 * @param obj The pager object
20373 * @param content The object to push
20375 * The object pushed becomes a child of the pager, it will be controlled and
20376 * deleted when the pager is deleted.
20378 * @note If the content is already in the stack use
20379 * elm_pager_content_promote().
20380 * @warning Using this function on @p content already in the stack results in
20381 * undefined behavior.
20383 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20386 * @brief Pop the object that is on top of the stack
20388 * @param obj The pager object
20390 * This pops the object that is on the top(visible) of the pager, makes it
20391 * disappear, then deletes the object. The object that was underneath it on
20392 * the stack will become visible.
20394 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20397 * @brief Moves an object already in the pager stack to the top of the stack.
20399 * @param obj The pager object
20400 * @param content The object to promote
20402 * This will take the @p content and move it to the top of the stack as
20403 * if it had been pushed there.
20405 * @note If the content isn't already in the stack use
20406 * elm_pager_content_push().
20407 * @warning Using this function on @p content not already in the stack
20408 * results in undefined behavior.
20410 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20413 * @brief Return the object at the bottom of the pager stack
20415 * @param obj The pager object
20416 * @return The bottom object or NULL if none
20418 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20421 * @brief Return the object at the top of the pager stack
20423 * @param obj The pager object
20424 * @return The top object or NULL if none
20426 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20428 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20429 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20436 * @defgroup Slideshow Slideshow
20438 * @image html img/widget/slideshow/preview-00.png
20439 * @image latex img/widget/slideshow/preview-00.eps
20441 * This widget, as the name indicates, is a pre-made image
20442 * slideshow panel, with API functions acting on (child) image
20443 * items presentation. Between those actions, are:
20444 * - advance to next/previous image
20445 * - select the style of image transition animation
20446 * - set the exhibition time for each image
20447 * - start/stop the slideshow
20449 * The transition animations are defined in the widget's theme,
20450 * consequently new animations can be added without having to
20451 * update the widget's code.
20453 * @section Slideshow_Items Slideshow items
20455 * For slideshow items, just like for @ref Genlist "genlist" ones,
20456 * the user defines a @b classes, specifying functions that will be
20457 * called on the item's creation and deletion times.
20459 * The #Elm_Slideshow_Item_Class structure contains the following
20462 * - @c func.get - When an item is displayed, this function is
20463 * called, and it's where one should create the item object, de
20464 * facto. For example, the object can be a pure Evas image object
20465 * or an Elementary @ref Photocam "photocam" widget. See
20466 * #SlideshowItemGetFunc.
20467 * - @c func.del - When an item is no more displayed, this function
20468 * is called, where the user must delete any data associated to
20469 * the item. See #SlideshowItemDelFunc.
20471 * @section Slideshow_Caching Slideshow caching
20473 * The slideshow provides facilities to have items adjacent to the
20474 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20475 * you, so that the system does not have to decode image data
20476 * anymore at the time it has to actually switch images on its
20477 * viewport. The user is able to set the numbers of items to be
20478 * cached @b before and @b after the current item, in the widget's
20481 * Smart events one can add callbacks for are:
20483 * - @c "changed" - when the slideshow switches its view to a new
20486 * List of examples for the slideshow widget:
20487 * @li @ref slideshow_example
20491 * @addtogroup Slideshow
20495 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20496 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20497 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20498 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20499 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20502 * @struct _Elm_Slideshow_Item_Class
20504 * Slideshow item class definition. See @ref Slideshow_Items for
20507 struct _Elm_Slideshow_Item_Class
20509 struct _Elm_Slideshow_Item_Class_Func
20511 SlideshowItemGetFunc get;
20512 SlideshowItemDelFunc del;
20514 }; /**< #Elm_Slideshow_Item_Class member definitions */
20517 * Add a new slideshow widget to the given parent Elementary
20518 * (container) object
20520 * @param parent The parent object
20521 * @return A new slideshow widget handle or @c NULL, on errors
20523 * This function inserts a new slideshow widget on the canvas.
20525 * @ingroup Slideshow
20527 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20530 * Add (append) a new item in a given slideshow widget.
20532 * @param obj The slideshow object
20533 * @param itc The item class for the item
20534 * @param data The item's data
20535 * @return A handle to the item added or @c NULL, on errors
20537 * Add a new item to @p obj's internal list of items, appending it.
20538 * The item's class must contain the function really fetching the
20539 * image object to show for this item, which could be an Evas image
20540 * object or an Elementary photo, for example. The @p data
20541 * parameter is going to be passed to both class functions of the
20544 * @see #Elm_Slideshow_Item_Class
20545 * @see elm_slideshow_item_sorted_insert()
20547 * @ingroup Slideshow
20549 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20552 * Insert a new item into the given slideshow widget, using the @p func
20553 * function to sort items (by item handles).
20555 * @param obj The slideshow object
20556 * @param itc The item class for the item
20557 * @param data The item's data
20558 * @param func The comparing function to be used to sort slideshow
20559 * items <b>by #Elm_Slideshow_Item item handles</b>
20560 * @return Returns The slideshow item handle, on success, or
20561 * @c NULL, on errors
20563 * Add a new item to @p obj's internal list of items, in a position
20564 * determined by the @p func comparing function. The item's class
20565 * must contain the function really fetching the image object to
20566 * show for this item, which could be an Evas image object or an
20567 * Elementary photo, for example. The @p data parameter is going to
20568 * be passed to both class functions of the item.
20570 * @see #Elm_Slideshow_Item_Class
20571 * @see elm_slideshow_item_add()
20573 * @ingroup Slideshow
20575 EAPI Elm_Slideshow_Item *elm_slideshow_item_sorted_insert(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) EINA_ARG_NONNULL(1);
20578 * Display a given slideshow widget's item, programmatically.
20580 * @param obj The slideshow object
20581 * @param item The item to display on @p obj's viewport
20583 * The change between the current item and @p item will use the
20584 * transition @p obj is set to use (@see
20585 * elm_slideshow_transition_set()).
20587 * @ingroup Slideshow
20589 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20592 * Slide to the @b next item, in a given slideshow widget
20594 * @param obj The slideshow object
20596 * The sliding animation @p obj is set to use will be the
20597 * transition effect used, after this call is issued.
20599 * @note If the end of the slideshow's internal list of items is
20600 * reached, it'll wrap around to the list's beginning, again.
20602 * @ingroup Slideshow
20604 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20607 * Slide to the @b previous item, in a given slideshow widget
20609 * @param obj The slideshow object
20611 * The sliding animation @p obj is set to use will be the
20612 * transition effect used, after this call is issued.
20614 * @note If the beginning of the slideshow's internal list of items
20615 * is reached, it'll wrap around to the list's end, again.
20617 * @ingroup Slideshow
20619 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20622 * Returns the list of sliding transition/effect names available, for a
20623 * given slideshow widget.
20625 * @param obj The slideshow object
20626 * @return The list of transitions (list of @b stringshared strings
20629 * The transitions, which come from @p obj's theme, must be an EDC
20630 * data item named @c "transitions" on the theme file, with (prefix)
20631 * names of EDC programs actually implementing them.
20633 * The available transitions for slideshows on the default theme are:
20634 * - @c "fade" - the current item fades out, while the new one
20635 * fades in to the slideshow's viewport.
20636 * - @c "black_fade" - the current item fades to black, and just
20637 * then, the new item will fade in.
20638 * - @c "horizontal" - the current item slides horizontally, until
20639 * it gets out of the slideshow's viewport, while the new item
20640 * comes from the left to take its place.
20641 * - @c "vertical" - the current item slides vertically, until it
20642 * gets out of the slideshow's viewport, while the new item comes
20643 * from the bottom to take its place.
20644 * - @c "square" - the new item starts to appear from the middle of
20645 * the current one, but with a tiny size, growing until its
20646 * target (full) size and covering the old one.
20648 * @warning The stringshared strings get no new references
20649 * exclusive to the user grabbing the list, here, so if you'd like
20650 * to use them out of this call's context, you'd better @c
20651 * eina_stringshare_ref() them.
20653 * @see elm_slideshow_transition_set()
20655 * @ingroup Slideshow
20657 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20660 * Set the current slide transition/effect in use for a given
20663 * @param obj The slideshow object
20664 * @param transition The new transition's name string
20666 * If @p transition is implemented in @p obj's theme (i.e., is
20667 * contained in the list returned by
20668 * elm_slideshow_transitions_get()), this new sliding effect will
20669 * be used on the widget.
20671 * @see elm_slideshow_transitions_get() for more details
20673 * @ingroup Slideshow
20675 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20678 * Get the current slide transition/effect in use for a given
20681 * @param obj The slideshow object
20682 * @return The current transition's name
20684 * @see elm_slideshow_transition_set() for more details
20686 * @ingroup Slideshow
20688 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20691 * Set the interval between each image transition on a given
20692 * slideshow widget, <b>and start the slideshow, itself</b>
20694 * @param obj The slideshow object
20695 * @param timeout The new displaying timeout for images
20697 * After this call, the slideshow widget will start cycling its
20698 * view, sequentially and automatically, with the images of the
20699 * items it has. The time between each new image displayed is going
20700 * to be @p timeout, in @b seconds. If a different timeout was set
20701 * previously and an slideshow was in progress, it will continue
20702 * with the new time between transitions, after this call.
20704 * @note A value less than or equal to 0 on @p timeout will disable
20705 * the widget's internal timer, thus halting any slideshow which
20706 * could be happening on @p obj.
20708 * @see elm_slideshow_timeout_get()
20710 * @ingroup Slideshow
20712 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20715 * Get the interval set for image transitions on a given slideshow
20718 * @param obj The slideshow object
20719 * @return Returns the timeout set on it
20721 * @see elm_slideshow_timeout_set() for more details
20723 * @ingroup Slideshow
20725 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20728 * Set if, after a slideshow is started, for a given slideshow
20729 * widget, its items should be displayed cyclically or not.
20731 * @param obj The slideshow object
20732 * @param loop Use @c EINA_TRUE to make it cycle through items or
20733 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20736 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20737 * ignore what is set by this functions, i.e., they'll @b always
20738 * cycle through items. This affects only the "automatic"
20739 * slideshow, as set by elm_slideshow_timeout_set().
20741 * @see elm_slideshow_loop_get()
20743 * @ingroup Slideshow
20745 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20748 * Get if, after a slideshow is started, for a given slideshow
20749 * widget, its items are to be displayed cyclically or not.
20751 * @param obj The slideshow object
20752 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20753 * through or @c EINA_FALSE, otherwise
20755 * @see elm_slideshow_loop_set() for more details
20757 * @ingroup Slideshow
20759 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20762 * Remove all items from a given slideshow widget
20764 * @param obj The slideshow object
20766 * This removes (and deletes) all items in @p obj, leaving it
20769 * @see elm_slideshow_item_del(), to remove just one item.
20771 * @ingroup Slideshow
20773 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20776 * Get the internal list of items in a given slideshow widget.
20778 * @param obj The slideshow object
20779 * @return The list of items (#Elm_Slideshow_Item as data) or
20780 * @c NULL on errors.
20782 * This list is @b not to be modified in any way and must not be
20783 * freed. Use the list members with functions like
20784 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20786 * @warning This list is only valid until @p obj object's internal
20787 * items list is changed. It should be fetched again with another
20788 * call to this function when changes happen.
20790 * @ingroup Slideshow
20792 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20795 * Delete a given item from a slideshow widget.
20797 * @param item The slideshow item
20799 * @ingroup Slideshow
20801 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20804 * Return the data associated with a given slideshow item
20806 * @param item The slideshow item
20807 * @return Returns the data associated to this item
20809 * @ingroup Slideshow
20811 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20814 * Returns the currently displayed item, in a given slideshow widget
20816 * @param obj The slideshow object
20817 * @return A handle to the item being displayed in @p obj or
20818 * @c NULL, if none is (and on errors)
20820 * @ingroup Slideshow
20822 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20825 * Get the real Evas object created to implement the view of a
20826 * given slideshow item
20828 * @param item The slideshow item.
20829 * @return the Evas object implementing this item's view.
20831 * This returns the actual Evas object used to implement the
20832 * specified slideshow item's view. This may be @c NULL, as it may
20833 * not have been created or may have been deleted, at any time, by
20834 * the slideshow. <b>Do not modify this object</b> (move, resize,
20835 * show, hide, etc.), as the slideshow is controlling it. This
20836 * function is for querying, emitting custom signals or hooking
20837 * lower level callbacks for events on that object. Do not delete
20838 * this object under any circumstances.
20840 * @see elm_slideshow_item_data_get()
20842 * @ingroup Slideshow
20844 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20847 * Get the the item, in a given slideshow widget, placed at
20848 * position @p nth, in its internal items list
20850 * @param obj The slideshow object
20851 * @param nth The number of the item to grab a handle to (0 being
20853 * @return The item stored in @p obj at position @p nth or @c NULL,
20854 * if there's no item with that index (and on errors)
20856 * @ingroup Slideshow
20858 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20861 * Set the current slide layout in use for a given slideshow widget
20863 * @param obj The slideshow object
20864 * @param layout The new layout's name string
20866 * If @p layout is implemented in @p obj's theme (i.e., is contained
20867 * in the list returned by elm_slideshow_layouts_get()), this new
20868 * images layout will be used on the widget.
20870 * @see elm_slideshow_layouts_get() for more details
20872 * @ingroup Slideshow
20874 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20877 * Get the current slide layout in use for a given slideshow widget
20879 * @param obj The slideshow object
20880 * @return The current layout's name
20882 * @see elm_slideshow_layout_set() for more details
20884 * @ingroup Slideshow
20886 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20889 * Returns the list of @b layout names available, for a given
20890 * slideshow widget.
20892 * @param obj The slideshow object
20893 * @return The list of layouts (list of @b stringshared strings
20896 * Slideshow layouts will change how the widget is to dispose each
20897 * image item in its viewport, with regard to cropping, scaling,
20900 * The layouts, which come from @p obj's theme, must be an EDC
20901 * data item name @c "layouts" on the theme file, with (prefix)
20902 * names of EDC programs actually implementing them.
20904 * The available layouts for slideshows on the default theme are:
20905 * - @c "fullscreen" - item images with original aspect, scaled to
20906 * touch top and down slideshow borders or, if the image's heigh
20907 * is not enough, left and right slideshow borders.
20908 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20909 * one, but always leaving 10% of the slideshow's dimensions of
20910 * distance between the item image's borders and the slideshow
20911 * borders, for each axis.
20913 * @warning The stringshared strings get no new references
20914 * exclusive to the user grabbing the list, here, so if you'd like
20915 * to use them out of this call's context, you'd better @c
20916 * eina_stringshare_ref() them.
20918 * @see elm_slideshow_layout_set()
20920 * @ingroup Slideshow
20922 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20925 * Set the number of items to cache, on a given slideshow widget,
20926 * <b>before the current item</b>
20928 * @param obj The slideshow object
20929 * @param count Number of items to cache before the current one
20931 * The default value for this property is @c 2. See
20932 * @ref Slideshow_Caching "slideshow caching" for more details.
20934 * @see elm_slideshow_cache_before_get()
20936 * @ingroup Slideshow
20938 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20941 * Retrieve the number of items to cache, on a given slideshow widget,
20942 * <b>before the current item</b>
20944 * @param obj The slideshow object
20945 * @return The number of items set to be cached before the current one
20947 * @see elm_slideshow_cache_before_set() for more details
20949 * @ingroup Slideshow
20951 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20954 * Set the number of items to cache, on a given slideshow widget,
20955 * <b>after the current item</b>
20957 * @param obj The slideshow object
20958 * @param count Number of items to cache after the current one
20960 * The default value for this property is @c 2. See
20961 * @ref Slideshow_Caching "slideshow caching" for more details.
20963 * @see elm_slideshow_cache_after_get()
20965 * @ingroup Slideshow
20967 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20970 * Retrieve the number of items to cache, on a given slideshow widget,
20971 * <b>after the current item</b>
20973 * @param obj The slideshow object
20974 * @return The number of items set to be cached after the current one
20976 * @see elm_slideshow_cache_after_set() for more details
20978 * @ingroup Slideshow
20980 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20983 * Get the number of items stored in a given slideshow widget
20985 * @param obj The slideshow object
20986 * @return The number of items on @p obj, at the moment of this call
20988 * @ingroup Slideshow
20990 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20997 * @defgroup Fileselector File Selector
20999 * @image html img/widget/fileselector/preview-00.png
21000 * @image latex img/widget/fileselector/preview-00.eps
21002 * A file selector is a widget that allows a user to navigate
21003 * through a file system, reporting file selections back via its
21006 * It contains shortcut buttons for home directory (@c ~) and to
21007 * jump one directory upwards (..), as well as cancel/ok buttons to
21008 * confirm/cancel a given selection. After either one of those two
21009 * former actions, the file selector will issue its @c "done" smart
21012 * There's a text entry on it, too, showing the name of the current
21013 * selection. There's the possibility of making it editable, so it
21014 * is useful on file saving dialogs on applications, where one
21015 * gives a file name to save contents to, in a given directory in
21016 * the system. This custom file name will be reported on the @c
21017 * "done" smart callback (explained in sequence).
21019 * Finally, it has a view to display file system items into in two
21024 * If Elementary is built with support of the Ethumb thumbnailing
21025 * library, the second form of view will display preview thumbnails
21026 * of files which it supports.
21028 * Smart callbacks one can register to:
21030 * - @c "selected" - the user has clicked on a file (when not in
21031 * folders-only mode) or directory (when in folders-only mode)
21032 * - @c "directory,open" - the list has been populated with new
21033 * content (@c event_info is a pointer to the directory's
21034 * path, a @b stringshared string)
21035 * - @c "done" - the user has clicked on the "ok" or "cancel"
21036 * buttons (@c event_info is a pointer to the selection's
21037 * path, a @b stringshared string)
21039 * Here is an example on its usage:
21040 * @li @ref fileselector_example
21044 * @addtogroup Fileselector
21049 * Defines how a file selector widget is to layout its contents
21050 * (file system entries).
21052 typedef enum _Elm_Fileselector_Mode
21054 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21055 ELM_FILESELECTOR_GRID, /**< layout as a grid */
21056 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21057 } Elm_Fileselector_Mode;
21060 * Add a new file selector widget to the given parent Elementary
21061 * (container) object
21063 * @param parent The parent object
21064 * @return a new file selector widget handle or @c NULL, on errors
21066 * This function inserts a new file selector widget on the canvas.
21068 * @ingroup Fileselector
21070 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21073 * Enable/disable the file name entry box where the user can type
21074 * in a name for a file, in a given file selector widget
21076 * @param obj The file selector object
21077 * @param is_save @c EINA_TRUE to make the file selector a "saving
21078 * dialog", @c EINA_FALSE otherwise
21080 * Having the entry editable is useful on file saving dialogs on
21081 * applications, where one gives a file name to save contents to,
21082 * in a given directory in the system. This custom file name will
21083 * be reported on the @c "done" smart callback.
21085 * @see elm_fileselector_is_save_get()
21087 * @ingroup Fileselector
21089 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21092 * Get whether the given file selector is in "saving dialog" mode
21094 * @param obj The file selector object
21095 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21096 * mode, @c EINA_FALSE otherwise (and on errors)
21098 * @see elm_fileselector_is_save_set() for more details
21100 * @ingroup Fileselector
21102 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21105 * Enable/disable folder-only view for a given file selector widget
21107 * @param obj The file selector object
21108 * @param only @c EINA_TRUE to make @p obj only display
21109 * directories, @c EINA_FALSE to make files to be displayed in it
21112 * If enabled, the widget's view will only display folder items,
21115 * @see elm_fileselector_folder_only_get()
21117 * @ingroup Fileselector
21119 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21122 * Get whether folder-only view is set for a given file selector
21125 * @param obj The file selector object
21126 * @return only @c EINA_TRUE if @p obj is only displaying
21127 * directories, @c EINA_FALSE if files are being displayed in it
21128 * too (and on errors)
21130 * @see elm_fileselector_folder_only_get()
21132 * @ingroup Fileselector
21134 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21137 * Enable/disable the "ok" and "cancel" buttons on a given file
21140 * @param obj The file selector object
21141 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21143 * @note A file selector without those buttons will never emit the
21144 * @c "done" smart event, and is only usable if one is just hooking
21145 * to the other two events.
21147 * @see elm_fileselector_buttons_ok_cancel_get()
21149 * @ingroup Fileselector
21151 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21154 * Get whether the "ok" and "cancel" buttons on a given file
21155 * selector widget are being shown.
21157 * @param obj The file selector object
21158 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21159 * otherwise (and on errors)
21161 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21163 * @ingroup Fileselector
21165 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21168 * Enable/disable a tree view in the given file selector widget,
21169 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21171 * @param obj The file selector object
21172 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21175 * In a tree view, arrows are created on the sides of directories,
21176 * allowing them to expand in place.
21178 * @note If it's in other mode, the changes made by this function
21179 * will only be visible when one switches back to "list" mode.
21181 * @see elm_fileselector_expandable_get()
21183 * @ingroup Fileselector
21185 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21188 * Get whether tree view is enabled for the given file selector
21191 * @param obj The file selector object
21192 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21193 * otherwise (and or errors)
21195 * @see elm_fileselector_expandable_set() for more details
21197 * @ingroup Fileselector
21199 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21202 * Set, programmatically, the @b directory that a given file
21203 * selector widget will display contents from
21205 * @param obj The file selector object
21206 * @param path The path to display in @p obj
21208 * This will change the @b directory that @p obj is displaying. It
21209 * will also clear the text entry area on the @p obj object, which
21210 * displays select files' names.
21212 * @see elm_fileselector_path_get()
21214 * @ingroup Fileselector
21216 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21219 * Get the parent directory's path that a given file selector
21220 * widget is displaying
21222 * @param obj The file selector object
21223 * @return The (full) path of the directory the file selector is
21224 * displaying, a @b stringshared string
21226 * @see elm_fileselector_path_set()
21228 * @ingroup Fileselector
21230 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21233 * Set, programmatically, the currently selected file/directory in
21234 * the given file selector widget
21236 * @param obj The file selector object
21237 * @param path The (full) path to a file or directory
21238 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21239 * latter case occurs if the directory or file pointed to do not
21242 * @see elm_fileselector_selected_get()
21244 * @ingroup Fileselector
21246 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21249 * Get the currently selected item's (full) path, in the given file
21252 * @param obj The file selector object
21253 * @return The absolute path of the selected item, a @b
21254 * stringshared string
21256 * @note Custom editions on @p obj object's text entry, if made,
21257 * will appear on the return string of this function, naturally.
21259 * @see elm_fileselector_selected_set() for more details
21261 * @ingroup Fileselector
21263 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21266 * Set the mode in which a given file selector widget will display
21267 * (layout) file system entries in its view
21269 * @param obj The file selector object
21270 * @param mode The mode of the fileselector, being it one of
21271 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21272 * first one, naturally, will display the files in a list. The
21273 * latter will make the widget to display its entries in a grid
21276 * @note By using elm_fileselector_expandable_set(), the user may
21277 * trigger a tree view for that list.
21279 * @note If Elementary is built with support of the Ethumb
21280 * thumbnailing library, the second form of view will display
21281 * preview thumbnails of files which it supports. You must have
21282 * elm_need_ethumb() called in your Elementary for thumbnailing to
21285 * @see elm_fileselector_expandable_set().
21286 * @see elm_fileselector_mode_get().
21288 * @ingroup Fileselector
21290 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21293 * Get the mode in which a given file selector widget is displaying
21294 * (layouting) file system entries in its view
21296 * @param obj The fileselector object
21297 * @return The mode in which the fileselector is at
21299 * @see elm_fileselector_mode_set() for more details
21301 * @ingroup Fileselector
21303 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21310 * @defgroup Progressbar Progress bar
21312 * The progress bar is a widget for visually representing the
21313 * progress status of a given job/task.
21315 * A progress bar may be horizontal or vertical. It may display an
21316 * icon besides it, as well as primary and @b units labels. The
21317 * former is meant to label the widget as a whole, while the
21318 * latter, which is formatted with floating point values (and thus
21319 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21320 * units"</c>), is meant to label the widget's <b>progress
21321 * value</b>. Label, icon and unit strings/objects are @b optional
21322 * for progress bars.
21324 * A progress bar may be @b inverted, in which state it gets its
21325 * values inverted, with high values being on the left or top and
21326 * low values on the right or bottom, as opposed to normally have
21327 * the low values on the former and high values on the latter,
21328 * respectively, for horizontal and vertical modes.
21330 * The @b span of the progress, as set by
21331 * elm_progressbar_span_size_set(), is its length (horizontally or
21332 * vertically), unless one puts size hints on the widget to expand
21333 * on desired directions, by any container. That length will be
21334 * scaled by the object or applications scaling factor. At any
21335 * point code can query the progress bar for its value with
21336 * elm_progressbar_value_get().
21338 * Available widget styles for progress bars:
21340 * - @c "wheel" (simple style, no text, no progression, only
21341 * "pulse" effect is available)
21343 * Default contents parts of the progressbar widget that you can use for are:
21344 * @li "icon" - A icon of the progressbar
21346 * Here is an example on its usage:
21347 * @li @ref progressbar_example
21351 * Add a new progress bar widget to the given parent Elementary
21352 * (container) object
21354 * @param parent The parent object
21355 * @return a new progress bar widget handle or @c NULL, on errors
21357 * This function inserts a new progress bar widget on the canvas.
21359 * @ingroup Progressbar
21361 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21364 * Set whether a given progress bar widget is at "pulsing mode" or
21367 * @param obj The progress bar object
21368 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21369 * @c EINA_FALSE to put it back to its default one
21371 * By default, progress bars will display values from the low to
21372 * high value boundaries. There are, though, contexts in which the
21373 * state of progression of a given task is @b unknown. For those,
21374 * one can set a progress bar widget to a "pulsing state", to give
21375 * the user an idea that some computation is being held, but
21376 * without exact progress values. In the default theme it will
21377 * animate its bar with the contents filling in constantly and back
21378 * to non-filled, in a loop. To start and stop this pulsing
21379 * animation, one has to explicitly call elm_progressbar_pulse().
21381 * @see elm_progressbar_pulse_get()
21382 * @see elm_progressbar_pulse()
21384 * @ingroup Progressbar
21386 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21389 * Get whether a given progress bar widget is at "pulsing mode" or
21392 * @param obj The progress bar object
21393 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21394 * if it's in the default one (and on errors)
21396 * @ingroup Progressbar
21398 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21401 * Start/stop a given progress bar "pulsing" animation, if its
21404 * @param obj The progress bar object
21405 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21406 * @c EINA_FALSE to @b stop it
21408 * @note This call won't do anything if @p obj is not under "pulsing mode".
21410 * @see elm_progressbar_pulse_set() for more details.
21412 * @ingroup Progressbar
21414 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21417 * Set the progress value (in percentage) on a given progress bar
21420 * @param obj The progress bar object
21421 * @param val The progress value (@b must be between @c 0.0 and @c
21424 * Use this call to set progress bar levels.
21426 * @note If you passes a value out of the specified range for @p
21427 * val, it will be interpreted as the @b closest of the @b boundary
21428 * values in the range.
21430 * @ingroup Progressbar
21432 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21435 * Get the progress value (in percentage) on a given progress bar
21438 * @param obj The progress bar object
21439 * @return The value of the progressbar
21441 * @see elm_progressbar_value_set() for more details
21443 * @ingroup Progressbar
21445 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21448 * Set the label of a given progress bar widget
21450 * @param obj The progress bar object
21451 * @param label The text label string, in UTF-8
21453 * @ingroup Progressbar
21454 * @deprecated use elm_object_text_set() instead.
21456 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21459 * Get the label of a given progress bar widget
21461 * @param obj The progressbar object
21462 * @return The text label string, in UTF-8
21464 * @ingroup Progressbar
21465 * @deprecated use elm_object_text_set() instead.
21467 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21470 * Set the icon object of a given progress bar widget
21472 * @param obj The progress bar object
21473 * @param icon The icon object
21475 * Use this call to decorate @p obj with an icon next to it.
21477 * @note Once the icon object is set, a previously set one will be
21478 * deleted. If you want to keep that old content object, use the
21479 * elm_progressbar_icon_unset() function.
21481 * @see elm_progressbar_icon_get()
21482 * @deprecated use elm_object_part_content_set() instead.
21484 * @ingroup Progressbar
21486 WILL_DEPRECATE EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21489 * Retrieve the icon object set for a given progress bar widget
21491 * @param obj The progress bar object
21492 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21493 * otherwise (and on errors)
21495 * @see elm_progressbar_icon_set() for more details
21496 * @deprecated use elm_object_part_content_get() instead.
21498 * @ingroup Progressbar
21500 WILL_DEPRECATE EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21503 * Unset an icon set on a given progress bar widget
21505 * @param obj The progress bar object
21506 * @return The icon object that was being used, if any was set, or
21507 * @c NULL, otherwise (and on errors)
21509 * This call will unparent and return the icon object which was set
21510 * for this widget, previously, on success.
21512 * @see elm_progressbar_icon_set() for more details
21513 * @deprecated use elm_object_part_content_unset() instead.
21515 * @ingroup Progressbar
21517 WILL_DEPRECATE EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21520 * Set the (exact) length of the bar region of a given progress bar
21523 * @param obj The progress bar object
21524 * @param size The length of the progress bar's bar region
21526 * This sets the minimum width (when in horizontal mode) or height
21527 * (when in vertical mode) of the actual bar area of the progress
21528 * bar @p obj. This in turn affects the object's minimum size. Use
21529 * this when you're not setting other size hints expanding on the
21530 * given direction (like weight and alignment hints) and you would
21531 * like it to have a specific size.
21533 * @note Icon, label and unit text around @p obj will require their
21534 * own space, which will make @p obj to require more the @p size,
21537 * @see elm_progressbar_span_size_get()
21539 * @ingroup Progressbar
21541 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21544 * Get the length set for the bar region of a given progress bar
21547 * @param obj The progress bar object
21548 * @return The length of the progress bar's bar region
21550 * If that size was not set previously, with
21551 * elm_progressbar_span_size_set(), this call will return @c 0.
21553 * @ingroup Progressbar
21555 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21558 * Set the format string for a given progress bar widget's units
21561 * @param obj The progress bar object
21562 * @param format The format string for @p obj's units label
21564 * If @c NULL is passed on @p format, it will make @p obj's units
21565 * area to be hidden completely. If not, it'll set the <b>format
21566 * string</b> for the units label's @b text. The units label is
21567 * provided a floating point value, so the units text is up display
21568 * at most one floating point falue. Note that the units label is
21569 * optional. Use a format string such as "%1.2f meters" for
21572 * @note The default format string for a progress bar is an integer
21573 * percentage, as in @c "%.0f %%".
21575 * @see elm_progressbar_unit_format_get()
21577 * @ingroup Progressbar
21579 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21582 * Retrieve the format string set for a given progress bar widget's
21585 * @param obj The progress bar object
21586 * @return The format set string for @p obj's units label or
21587 * @c NULL, if none was set (and on errors)
21589 * @see elm_progressbar_unit_format_set() for more details
21591 * @ingroup Progressbar
21593 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21596 * Set the orientation of a given progress bar widget
21598 * @param obj The progress bar object
21599 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21600 * @b horizontal, @c EINA_FALSE to make it @b vertical
21602 * Use this function to change how your progress bar is to be
21603 * disposed: vertically or horizontally.
21605 * @see elm_progressbar_horizontal_get()
21607 * @ingroup Progressbar
21609 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21612 * Retrieve the orientation of a given progress bar widget
21614 * @param obj The progress bar object
21615 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21616 * @c EINA_FALSE if it's @b vertical (and on errors)
21618 * @see elm_progressbar_horizontal_set() for more details
21620 * @ingroup Progressbar
21622 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21625 * Invert a given progress bar widget's displaying values order
21627 * @param obj The progress bar object
21628 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21629 * @c EINA_FALSE to bring it back to default, non-inverted values.
21631 * A progress bar may be @b inverted, in which state it gets its
21632 * values inverted, with high values being on the left or top and
21633 * low values on the right or bottom, as opposed to normally have
21634 * the low values on the former and high values on the latter,
21635 * respectively, for horizontal and vertical modes.
21637 * @see elm_progressbar_inverted_get()
21639 * @ingroup Progressbar
21641 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21644 * Get whether a given progress bar widget's displaying values are
21647 * @param obj The progress bar object
21648 * @return @c EINA_TRUE, if @p obj has inverted values,
21649 * @c EINA_FALSE otherwise (and on errors)
21651 * @see elm_progressbar_inverted_set() for more details
21653 * @ingroup Progressbar
21655 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21658 * @defgroup Separator Separator
21660 * @brief Separator is a very thin object used to separate other objects.
21662 * A separator can be vertical or horizontal.
21664 * @ref tutorial_separator is a good example of how to use a separator.
21668 * @brief Add a separator object to @p parent
21670 * @param parent The parent object
21672 * @return The separator object, or NULL upon failure
21674 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21676 * @brief Set the horizontal mode of a separator object
21678 * @param obj The separator object
21679 * @param horizontal If true, the separator is horizontal
21681 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21683 * @brief Get the horizontal mode of a separator object
21685 * @param obj The separator object
21686 * @return If true, the separator is horizontal
21688 * @see elm_separator_horizontal_set()
21690 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21696 * @defgroup Spinner Spinner
21697 * @ingroup Elementary
21699 * @image html img/widget/spinner/preview-00.png
21700 * @image latex img/widget/spinner/preview-00.eps
21702 * A spinner is a widget which allows the user to increase or decrease
21703 * numeric values using arrow buttons, or edit values directly, clicking
21704 * over it and typing the new value.
21706 * By default the spinner will not wrap and has a label
21707 * of "%.0f" (just showing the integer value of the double).
21709 * A spinner has a label that is formatted with floating
21710 * point values and thus accepts a printf-style format string, like
21713 * It also allows specific values to be replaced by pre-defined labels.
21715 * Smart callbacks one can register to:
21717 * - "changed" - Whenever the spinner value is changed.
21718 * - "delay,changed" - A short time after the value is changed by the user.
21719 * This will be called only when the user stops dragging for a very short
21720 * period or when they release their finger/mouse, so it avoids possibly
21721 * expensive reactions to the value change.
21723 * Available styles for it:
21725 * - @c "vertical": up/down buttons at the right side and text left aligned.
21727 * Here is an example on its usage:
21728 * @ref spinner_example
21732 * @addtogroup Spinner
21737 * Add a new spinner widget to the given parent Elementary
21738 * (container) object.
21740 * @param parent The parent object.
21741 * @return a new spinner widget handle or @c NULL, on errors.
21743 * This function inserts a new spinner widget on the canvas.
21748 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21751 * Set the format string of the displayed label.
21753 * @param obj The spinner object.
21754 * @param fmt The format string for the label display.
21756 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21757 * string for the label text. The label text is provided a floating point
21758 * value, so the label text can display up to 1 floating point value.
21759 * Note that this is optional.
21761 * Use a format string such as "%1.2f meters" for example, and it will
21762 * display values like: "3.14 meters" for a value equal to 3.14159.
21764 * Default is "%0.f".
21766 * @see elm_spinner_label_format_get()
21770 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21773 * Get the label format of the spinner.
21775 * @param obj The spinner object.
21776 * @return The text label format string in UTF-8.
21778 * @see elm_spinner_label_format_set() for details.
21782 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21785 * Set the minimum and maximum values for the spinner.
21787 * @param obj The spinner object.
21788 * @param min The minimum value.
21789 * @param max The maximum value.
21791 * Define the allowed range of values to be selected by the user.
21793 * If actual value is less than @p min, it will be updated to @p min. If it
21794 * is bigger then @p max, will be updated to @p max. Actual value can be
21795 * get with elm_spinner_value_get().
21797 * By default, min is equal to 0, and max is equal to 100.
21799 * @warning Maximum must be greater than minimum.
21801 * @see elm_spinner_min_max_get()
21805 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21808 * Get the minimum and maximum values of the spinner.
21810 * @param obj The spinner object.
21811 * @param min Pointer where to store the minimum value.
21812 * @param max Pointer where to store the maximum value.
21814 * @note If only one value is needed, the other pointer can be passed
21817 * @see elm_spinner_min_max_set() for details.
21821 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21824 * Set the step used to increment or decrement the spinner value.
21826 * @param obj The spinner object.
21827 * @param step The step value.
21829 * This value will be incremented or decremented to the displayed value.
21830 * It will be incremented while the user keep right or top arrow pressed,
21831 * and will be decremented while the user keep left or bottom arrow pressed.
21833 * The interval to increment / decrement can be set with
21834 * elm_spinner_interval_set().
21836 * By default step value is equal to 1.
21838 * @see elm_spinner_step_get()
21842 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21845 * Get the step used to increment or decrement the spinner value.
21847 * @param obj The spinner object.
21848 * @return The step value.
21850 * @see elm_spinner_step_get() for more details.
21854 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21857 * Set the value the spinner displays.
21859 * @param obj The spinner object.
21860 * @param val The value to be displayed.
21862 * Value will be presented on the label following format specified with
21863 * elm_spinner_format_set().
21865 * @warning The value must to be between min and max values. This values
21866 * are set by elm_spinner_min_max_set().
21868 * @see elm_spinner_value_get().
21869 * @see elm_spinner_format_set().
21870 * @see elm_spinner_min_max_set().
21874 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21877 * Get the value displayed by the spinner.
21879 * @param obj The spinner object.
21880 * @return The value displayed.
21882 * @see elm_spinner_value_set() for details.
21886 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21889 * Set whether the spinner should wrap when it reaches its
21890 * minimum or maximum value.
21892 * @param obj The spinner object.
21893 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21896 * Disabled by default. If disabled, when the user tries to increment the
21898 * but displayed value plus step value is bigger than maximum value,
21900 * won't allow it. The same happens when the user tries to decrement it,
21901 * but the value less step is less than minimum value.
21903 * When wrap is enabled, in such situations it will allow these changes,
21904 * but will get the value that would be less than minimum and subtracts
21905 * from maximum. Or add the value that would be more than maximum to
21909 * @li min value = 10
21910 * @li max value = 50
21911 * @li step value = 20
21912 * @li displayed value = 20
21914 * When the user decrement value (using left or bottom arrow), it will
21915 * displays @c 40, because max - (min - (displayed - step)) is
21916 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21918 * @see elm_spinner_wrap_get().
21922 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21925 * Get whether the spinner should wrap when it reaches its
21926 * minimum or maximum value.
21928 * @param obj The spinner object
21929 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21930 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21932 * @see elm_spinner_wrap_set() for details.
21936 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21939 * Set whether the spinner can be directly edited by the user or not.
21941 * @param obj The spinner object.
21942 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21943 * don't allow users to edit it directly.
21945 * Spinner objects can have edition @b disabled, in which state they will
21946 * be changed only by arrows.
21947 * Useful for contexts
21948 * where you don't want your users to interact with it writting the value.
21950 * when using special values, the user can see real value instead
21951 * of special label on edition.
21953 * It's enabled by default.
21955 * @see elm_spinner_editable_get()
21959 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21962 * Get whether the spinner can be directly edited by the user or not.
21964 * @param obj The spinner object.
21965 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21966 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21968 * @see elm_spinner_editable_set() for details.
21972 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21975 * Set a special string to display in the place of the numerical value.
21977 * @param obj The spinner object.
21978 * @param value The value to be replaced.
21979 * @param label The label to be used.
21981 * It's useful for cases when a user should select an item that is
21982 * better indicated by a label than a value. For example, weekdays or months.
21986 * sp = elm_spinner_add(win);
21987 * elm_spinner_min_max_set(sp, 1, 3);
21988 * elm_spinner_special_value_add(sp, 1, "January");
21989 * elm_spinner_special_value_add(sp, 2, "February");
21990 * elm_spinner_special_value_add(sp, 3, "March");
21991 * evas_object_show(sp);
21996 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21999 * Set the interval on time updates for an user mouse button hold
22000 * on spinner widgets' arrows.
22002 * @param obj The spinner object.
22003 * @param interval The (first) interval value in seconds.
22005 * This interval value is @b decreased while the user holds the
22006 * mouse pointer either incrementing or decrementing spinner's value.
22008 * This helps the user to get to a given value distant from the
22009 * current one easier/faster, as it will start to change quicker and
22010 * quicker on mouse button holds.
22012 * The calculation for the next change interval value, starting from
22013 * the one set with this call, is the previous interval divided by
22014 * @c 1.05, so it decreases a little bit.
22016 * The default starting interval value for automatic changes is
22019 * @see elm_spinner_interval_get()
22023 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22026 * Get the interval on time updates for an user mouse button hold
22027 * on spinner widgets' arrows.
22029 * @param obj The spinner object.
22030 * @return The (first) interval value, in seconds, set on it.
22032 * @see elm_spinner_interval_set() for more details.
22036 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22043 * @defgroup Index Index
22045 * @image html img/widget/index/preview-00.png
22046 * @image latex img/widget/index/preview-00.eps
22048 * An index widget gives you an index for fast access to whichever
22049 * group of other UI items one might have. It's a list of text
22050 * items (usually letters, for alphabetically ordered access).
22052 * Index widgets are by default hidden and just appear when the
22053 * user clicks over it's reserved area in the canvas. In its
22054 * default theme, it's an area one @ref Fingers "finger" wide on
22055 * the right side of the index widget's container.
22057 * When items on the index are selected, smart callbacks get
22058 * called, so that its user can make other container objects to
22059 * show a given area or child object depending on the index item
22060 * selected. You'd probably be using an index together with @ref
22061 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22064 * Smart events one can add callbacks for are:
22065 * - @c "changed" - When the selected index item changes. @c
22066 * event_info is the selected item's data pointer.
22067 * - @c "delay,changed" - When the selected index item changes, but
22068 * after a small idling period. @c event_info is the selected
22069 * item's data pointer.
22070 * - @c "selected" - When the user releases a mouse button and
22071 * selects an item. @c event_info is the selected item's data
22073 * - @c "level,up" - when the user moves a finger from the first
22074 * level to the second level
22075 * - @c "level,down" - when the user moves a finger from the second
22076 * level to the first level
22078 * The @c "delay,changed" event is so that it'll wait a small time
22079 * before actually reporting those events and, moreover, just the
22080 * last event happening on those time frames will actually be
22083 * Here are some examples on its usage:
22084 * @li @ref index_example_01
22085 * @li @ref index_example_02
22089 * @addtogroup Index
22093 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22096 * Add a new index widget to the given parent Elementary
22097 * (container) object
22099 * @param parent The parent object
22100 * @return a new index widget handle or @c NULL, on errors
22102 * This function inserts a new index widget on the canvas.
22106 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22109 * Set whether a given index widget is or not visible,
22112 * @param obj The index object
22113 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22115 * Not to be confused with visible as in @c evas_object_show() --
22116 * visible with regard to the widget's auto hiding feature.
22118 * @see elm_index_active_get()
22122 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22125 * Get whether a given index widget is currently visible or not.
22127 * @param obj The index object
22128 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22130 * @see elm_index_active_set() for more details
22134 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22137 * Set the items level for a given index widget.
22139 * @param obj The index object.
22140 * @param level @c 0 or @c 1, the currently implemented levels.
22142 * @see elm_index_item_level_get()
22146 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22149 * Get the items level set for a given index widget.
22151 * @param obj The index object.
22152 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22154 * @see elm_index_item_level_set() for more information
22158 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22161 * Returns the last selected item's data, for a given index widget.
22163 * @param obj The index object.
22164 * @return The item @b data associated to the last selected item on
22165 * @p obj (or @c NULL, on errors).
22167 * @warning The returned value is @b not an #Elm_Index_Item item
22168 * handle, but the data associated to it (see the @c item parameter
22169 * in elm_index_item_append(), as an example).
22173 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22176 * Append a new item on a given index widget.
22178 * @param obj The index object.
22179 * @param letter Letter under which the item should be indexed
22180 * @param item The item data to set for the index's item
22182 * Despite the most common usage of the @p letter argument is for
22183 * single char strings, one could use arbitrary strings as index
22186 * @c item will be the pointer returned back on @c "changed", @c
22187 * "delay,changed" and @c "selected" smart events.
22191 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22194 * Prepend a new item on a given index widget.
22196 * @param obj The index object.
22197 * @param letter Letter under which the item should be indexed
22198 * @param item The item data to set for the index's item
22200 * Despite the most common usage of the @p letter argument is for
22201 * single char strings, one could use arbitrary strings as index
22204 * @c item will be the pointer returned back on @c "changed", @c
22205 * "delay,changed" and @c "selected" smart events.
22209 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22212 * Append a new item, on a given index widget, <b>after the item
22213 * having @p relative as data</b>.
22215 * @param obj The index object.
22216 * @param letter Letter under which the item should be indexed
22217 * @param item The item data to set for the index's item
22218 * @param relative The item data of the index item to be the
22219 * predecessor of this new one
22221 * Despite the most common usage of the @p letter argument is for
22222 * single char strings, one could use arbitrary strings as index
22225 * @c item will be the pointer returned back on @c "changed", @c
22226 * "delay,changed" and @c "selected" smart events.
22228 * @note If @p relative is @c NULL or if it's not found to be data
22229 * set on any previous item on @p obj, this function will behave as
22230 * elm_index_item_append().
22234 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22237 * Prepend a new item, on a given index widget, <b>after the item
22238 * having @p relative as data</b>.
22240 * @param obj The index object.
22241 * @param letter Letter under which the item should be indexed
22242 * @param item The item data to set for the index's item
22243 * @param relative The item data of the index item to be the
22244 * successor of this new one
22246 * Despite the most common usage of the @p letter argument is for
22247 * single char strings, one could use arbitrary strings as index
22250 * @c item will be the pointer returned back on @c "changed", @c
22251 * "delay,changed" and @c "selected" smart events.
22253 * @note If @p relative is @c NULL or if it's not found to be data
22254 * set on any previous item on @p obj, this function will behave as
22255 * elm_index_item_prepend().
22259 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22262 * Insert a new item into the given index widget, using @p cmp_func
22263 * function to sort items (by item handles).
22265 * @param obj The index object.
22266 * @param letter Letter under which the item should be indexed
22267 * @param item The item data to set for the index's item
22268 * @param cmp_func The comparing function to be used to sort index
22269 * items <b>by #Elm_Index_Item item handles</b>
22270 * @param cmp_data_func A @b fallback function to be called for the
22271 * sorting of index items <b>by item data</b>). It will be used
22272 * when @p cmp_func returns @c 0 (equality), which means an index
22273 * item with provided item data already exists. To decide which
22274 * data item should be pointed to by the index item in question, @p
22275 * cmp_data_func will be used. If @p cmp_data_func returns a
22276 * non-negative value, the previous index item data will be
22277 * replaced by the given @p item pointer. If the previous data need
22278 * to be freed, it should be done by the @p cmp_data_func function,
22279 * because all references to it will be lost. If this function is
22280 * not provided (@c NULL is given), index items will be @b
22281 * duplicated, if @p cmp_func returns @c 0.
22283 * Despite the most common usage of the @p letter argument is for
22284 * single char strings, one could use arbitrary strings as index
22287 * @c item will be the pointer returned back on @c "changed", @c
22288 * "delay,changed" and @c "selected" smart events.
22292 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);
22295 * Remove an item from a given index widget, <b>to be referenced by
22296 * it's data value</b>.
22298 * @param obj The index object
22299 * @param item The item's data pointer for the item to be removed
22302 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22303 * that callback function will be called by this one.
22305 * @warning The item to be removed from @p obj will be found via
22306 * its item data pointer, and not by an #Elm_Index_Item handle.
22310 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22313 * Find a given index widget's item, <b>using item data</b>.
22315 * @param obj The index object
22316 * @param item The item data pointed to by the desired index item
22317 * @return The index item handle, if found, or @c NULL otherwise
22321 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22324 * Removes @b all items from a given index widget.
22326 * @param obj The index object.
22328 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22329 * that callback function will be called for each item in @p obj.
22333 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22336 * Go to a given items level on a index widget
22338 * @param obj The index object
22339 * @param level The index level (one of @c 0 or @c 1)
22343 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22346 * Return the data associated with a given index widget item
22348 * @param it The index widget item handle
22349 * @return The data associated with @p it
22351 * @see elm_index_item_data_set()
22355 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22358 * Set the data associated with a given index widget item
22360 * @param it The index widget item handle
22361 * @param data The new data pointer to set to @p it
22363 * This sets new item data on @p it.
22365 * @warning The old data pointer won't be touched by this function, so
22366 * the user had better to free that old data himself/herself.
22370 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22373 * Set the function to be called when a given index widget item is freed.
22375 * @param it The item to set the callback on
22376 * @param func The function to call on the item's deletion
22378 * When called, @p func will have both @c data and @c event_info
22379 * arguments with the @p it item's data value and, naturally, the
22380 * @c obj argument with a handle to the parent index widget.
22384 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22387 * Get the letter (string) set on a given index widget item.
22389 * @param it The index item handle
22390 * @return The letter string set on @p it
22394 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22398 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22405 * @defgroup Photocam Photocam
22407 * @image html img/widget/photocam/preview-00.png
22408 * @image latex img/widget/photocam/preview-00.eps
22410 * This is a widget specifically for displaying high-resolution digital
22411 * camera photos giving speedy feedback (fast load), low memory footprint
22412 * and zooming and panning as well as fitting logic. It is entirely focused
22413 * on jpeg images, and takes advantage of properties of the jpeg format (via
22414 * evas loader features in the jpeg loader).
22416 * Signals that you can add callbacks for are:
22417 * @li "clicked" - This is called when a user has clicked the photo without
22419 * @li "press" - This is called when a user has pressed down on the photo.
22420 * @li "longpressed" - This is called when a user has pressed down on the
22421 * photo for a long time without dragging around.
22422 * @li "clicked,double" - This is called when a user has double-clicked the
22424 * @li "load" - Photo load begins.
22425 * @li "loaded" - This is called when the image file load is complete for the
22426 * first view (low resolution blurry version).
22427 * @li "load,detail" - Photo detailed data load begins.
22428 * @li "loaded,detail" - This is called when the image file load is complete
22429 * for the detailed image data (full resolution needed).
22430 * @li "zoom,start" - Zoom animation started.
22431 * @li "zoom,stop" - Zoom animation stopped.
22432 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22433 * @li "scroll" - the content has been scrolled (moved)
22434 * @li "scroll,anim,start" - scrolling animation has started
22435 * @li "scroll,anim,stop" - scrolling animation has stopped
22436 * @li "scroll,drag,start" - dragging the contents around has started
22437 * @li "scroll,drag,stop" - dragging the contents around has stopped
22439 * @ref tutorial_photocam shows the API in action.
22443 * @brief Types of zoom available.
22445 typedef enum _Elm_Photocam_Zoom_Mode
22447 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22448 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22449 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22450 ELM_PHOTOCAM_ZOOM_MODE_LAST
22451 } Elm_Photocam_Zoom_Mode;
22453 * @brief Add a new Photocam object
22455 * @param parent The parent object
22456 * @return The new object or NULL if it cannot be created
22458 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22460 * @brief Set the photo file to be shown
22462 * @param obj The photocam object
22463 * @param file The photo file
22464 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22466 * This sets (and shows) the specified file (with a relative or absolute
22467 * path) and will return a load error (same error that
22468 * evas_object_image_load_error_get() will return). The image will change and
22469 * adjust its size at this point and begin a background load process for this
22470 * photo that at some time in the future will be displayed at the full
22473 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22475 * @brief Returns the path of the current image file
22477 * @param obj The photocam object
22478 * @return Returns the path
22480 * @see elm_photocam_file_set()
22482 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22484 * @brief Set the zoom level of the photo
22486 * @param obj The photocam object
22487 * @param zoom The zoom level to set
22489 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22490 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22491 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22492 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22495 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22497 * @brief Get the zoom level of the photo
22499 * @param obj The photocam object
22500 * @return The current zoom level
22502 * This returns the current zoom level of the photocam object. Note that if
22503 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22504 * (which is the default), the zoom level may be changed at any time by the
22505 * photocam object itself to account for photo size and photocam viewpoer
22508 * @see elm_photocam_zoom_set()
22509 * @see elm_photocam_zoom_mode_set()
22511 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22513 * @brief Set the zoom mode
22515 * @param obj The photocam object
22516 * @param mode The desired mode
22518 * This sets the zoom mode to manual or one of several automatic levels.
22519 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22520 * elm_photocam_zoom_set() and will stay at that level until changed by code
22521 * or until zoom mode is changed. This is the default mode. The Automatic
22522 * modes will allow the photocam object to automatically adjust zoom mode
22523 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22524 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22525 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22526 * pixels within the frame are left unfilled.
22528 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22530 * @brief Get the zoom mode
22532 * @param obj The photocam object
22533 * @return The current zoom mode
22535 * This gets the current zoom mode of the photocam object.
22537 * @see elm_photocam_zoom_mode_set()
22539 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22541 * @brief Get the current image pixel width and height
22543 * @param obj The photocam object
22544 * @param w A pointer to the width return
22545 * @param h A pointer to the height return
22547 * This gets the current photo pixel width and height (for the original).
22548 * The size will be returned in the integers @p w and @p h that are pointed
22551 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22553 * @brief Get the area of the image that is currently shown
22556 * @param x A pointer to the X-coordinate of region
22557 * @param y A pointer to the Y-coordinate of region
22558 * @param w A pointer to the width
22559 * @param h A pointer to the height
22561 * @see elm_photocam_image_region_show()
22562 * @see elm_photocam_image_region_bring_in()
22564 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22566 * @brief Set the viewed portion of the image
22568 * @param obj The photocam object
22569 * @param x X-coordinate of region in image original pixels
22570 * @param y Y-coordinate of region in image original pixels
22571 * @param w Width of region in image original pixels
22572 * @param h Height of region in image original pixels
22574 * This shows the region of the image without using animation.
22576 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22578 * @brief Bring in the viewed portion of the image
22580 * @param obj The photocam object
22581 * @param x X-coordinate of region in image original pixels
22582 * @param y Y-coordinate of region in image original pixels
22583 * @param w Width of region in image original pixels
22584 * @param h Height of region in image original pixels
22586 * This shows the region of the image using animation.
22588 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22590 * @brief Set the paused state for photocam
22592 * @param obj The photocam object
22593 * @param paused The pause state to set
22595 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22596 * photocam. The default is off. This will stop zooming using animation on
22597 * zoom levels changes and change instantly. This will stop any existing
22598 * animations that are running.
22600 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22602 * @brief Get the paused state for photocam
22604 * @param obj The photocam object
22605 * @return The current paused state
22607 * This gets the current paused state for the photocam object.
22609 * @see elm_photocam_paused_set()
22611 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22613 * @brief Get the internal low-res image used for photocam
22615 * @param obj The photocam object
22616 * @return The internal image object handle, or NULL if none exists
22618 * This gets the internal image object inside photocam. Do not modify it. It
22619 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22620 * deleted at any time as well.
22622 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22624 * @brief Set the photocam scrolling bouncing.
22626 * @param obj The photocam object
22627 * @param h_bounce bouncing for horizontal
22628 * @param v_bounce bouncing for vertical
22630 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22632 * @brief Get the photocam scrolling bouncing.
22634 * @param obj The photocam object
22635 * @param h_bounce bouncing for horizontal
22636 * @param v_bounce bouncing for vertical
22638 * @see elm_photocam_bounce_set()
22640 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22646 * @defgroup Map Map
22647 * @ingroup Elementary
22649 * @image html img/widget/map/preview-00.png
22650 * @image latex img/widget/map/preview-00.eps
22652 * This is a widget specifically for displaying a map. It uses basically
22653 * OpenStreetMap provider http://www.openstreetmap.org/,
22654 * but custom providers can be added.
22656 * It supports some basic but yet nice features:
22657 * @li zoom and scroll
22658 * @li markers with content to be displayed when user clicks over it
22659 * @li group of markers
22662 * Smart callbacks one can listen to:
22664 * - "clicked" - This is called when a user has clicked the map without
22666 * - "press" - This is called when a user has pressed down on the map.
22667 * - "longpressed" - This is called when a user has pressed down on the map
22668 * for a long time without dragging around.
22669 * - "clicked,double" - This is called when a user has double-clicked
22671 * - "load,detail" - Map detailed data load begins.
22672 * - "loaded,detail" - This is called when all currently visible parts of
22673 * the map are loaded.
22674 * - "zoom,start" - Zoom animation started.
22675 * - "zoom,stop" - Zoom animation stopped.
22676 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22677 * - "scroll" - the content has been scrolled (moved).
22678 * - "scroll,anim,start" - scrolling animation has started.
22679 * - "scroll,anim,stop" - scrolling animation has stopped.
22680 * - "scroll,drag,start" - dragging the contents around has started.
22681 * - "scroll,drag,stop" - dragging the contents around has stopped.
22682 * - "downloaded" - This is called when all currently required map images
22684 * - "route,load" - This is called when route request begins.
22685 * - "route,loaded" - This is called when route request ends.
22686 * - "name,load" - This is called when name request begins.
22687 * - "name,loaded- This is called when name request ends.
22689 * Available style for map widget:
22692 * Available style for markers:
22697 * Available style for marker bubble:
22700 * List of examples:
22701 * @li @ref map_example_01
22702 * @li @ref map_example_02
22703 * @li @ref map_example_03
22712 * @enum _Elm_Map_Zoom_Mode
22713 * @typedef Elm_Map_Zoom_Mode
22715 * Set map's zoom behavior. It can be set to manual or automatic.
22717 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22719 * Values <b> don't </b> work as bitmask, only one can be choosen.
22721 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22722 * than the scroller view.
22724 * @see elm_map_zoom_mode_set()
22725 * @see elm_map_zoom_mode_get()
22729 typedef enum _Elm_Map_Zoom_Mode
22731 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22732 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22733 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22734 ELM_MAP_ZOOM_MODE_LAST
22735 } Elm_Map_Zoom_Mode;
22738 * @enum _Elm_Map_Route_Sources
22739 * @typedef Elm_Map_Route_Sources
22741 * Set route service to be used. By default used source is
22742 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22744 * @see elm_map_route_source_set()
22745 * @see elm_map_route_source_get()
22749 typedef enum _Elm_Map_Route_Sources
22751 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22752 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. */
22753 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22754 ELM_MAP_ROUTE_SOURCE_LAST
22755 } Elm_Map_Route_Sources;
22757 typedef enum _Elm_Map_Name_Sources
22759 ELM_MAP_NAME_SOURCE_NOMINATIM,
22760 ELM_MAP_NAME_SOURCE_LAST
22761 } Elm_Map_Name_Sources;
22764 * @enum _Elm_Map_Route_Type
22765 * @typedef Elm_Map_Route_Type
22767 * Set type of transport used on route.
22769 * @see elm_map_route_add()
22773 typedef enum _Elm_Map_Route_Type
22775 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22776 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22777 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22778 ELM_MAP_ROUTE_TYPE_LAST
22779 } Elm_Map_Route_Type;
22782 * @enum _Elm_Map_Route_Method
22783 * @typedef Elm_Map_Route_Method
22785 * Set the routing method, what should be priorized, time or distance.
22787 * @see elm_map_route_add()
22791 typedef enum _Elm_Map_Route_Method
22793 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22794 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22795 ELM_MAP_ROUTE_METHOD_LAST
22796 } Elm_Map_Route_Method;
22798 typedef enum _Elm_Map_Name_Method
22800 ELM_MAP_NAME_METHOD_SEARCH,
22801 ELM_MAP_NAME_METHOD_REVERSE,
22802 ELM_MAP_NAME_METHOD_LAST
22803 } Elm_Map_Name_Method;
22805 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(). */
22806 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(). */
22807 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(). */
22808 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(). */
22809 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22810 typedef struct _Elm_Map_Track Elm_Map_Track;
22812 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. */
22813 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22814 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22815 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22817 typedef char *(*ElmMapModuleSourceFunc) (void);
22818 typedef int (*ElmMapModuleZoomMinFunc) (void);
22819 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22820 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22821 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22822 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22823 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22824 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22825 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22828 * Add a new map widget to the given parent Elementary (container) object.
22830 * @param parent The parent object.
22831 * @return a new map widget handle or @c NULL, on errors.
22833 * This function inserts a new map widget on the canvas.
22837 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22840 * Set the zoom level of the map.
22842 * @param obj The map object.
22843 * @param zoom The zoom level to set.
22845 * This sets the zoom level.
22847 * It will respect limits defined by elm_map_source_zoom_min_set() and
22848 * elm_map_source_zoom_max_set().
22850 * By default these values are 0 (world map) and 18 (maximum zoom).
22852 * This function should be used when zoom mode is set to
22853 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22854 * with elm_map_zoom_mode_set().
22856 * @see elm_map_zoom_mode_set().
22857 * @see elm_map_zoom_get().
22861 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22864 * Get the zoom level of the map.
22866 * @param obj The map object.
22867 * @return The current zoom level.
22869 * This returns the current zoom level of the map object.
22871 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22872 * (which is the default), the zoom level may be changed at any time by the
22873 * map object itself to account for map size and map viewport size.
22875 * @see elm_map_zoom_set() for details.
22879 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22882 * Set the zoom mode used by the map object.
22884 * @param obj The map object.
22885 * @param mode The zoom mode of the map, being it one of
22886 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22887 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22889 * This sets the zoom mode to manual or one of the automatic levels.
22890 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22891 * elm_map_zoom_set() and will stay at that level until changed by code
22892 * or until zoom mode is changed. This is the default mode.
22894 * The Automatic modes will allow the map object to automatically
22895 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22896 * adjust zoom so the map fits inside the scroll frame with no pixels
22897 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22898 * ensure no pixels within the frame are left unfilled. Do not forget that
22899 * the valid sizes are 2^zoom, consequently the map may be smaller than
22900 * the scroller view.
22902 * @see elm_map_zoom_set()
22906 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22909 * Get the zoom mode used by the map object.
22911 * @param obj The map object.
22912 * @return The zoom mode of the map, being it one of
22913 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22914 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22916 * This function returns the current zoom mode used by the map object.
22918 * @see elm_map_zoom_mode_set() for more details.
22922 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22925 * Get the current coordinates of the map.
22927 * @param obj The map object.
22928 * @param lon Pointer where to store longitude.
22929 * @param lat Pointer where to store latitude.
22931 * This gets the current center coordinates of the map object. It can be
22932 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22934 * @see elm_map_geo_region_bring_in()
22935 * @see elm_map_geo_region_show()
22939 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22942 * Animatedly bring in given coordinates to the center of the map.
22944 * @param obj The map object.
22945 * @param lon Longitude to center at.
22946 * @param lat Latitude to center at.
22948 * This causes map to jump to the given @p lat and @p lon coordinates
22949 * and show it (by scrolling) in the center of the viewport, if it is not
22950 * already centered. This will use animation to do so and take a period
22951 * of time to complete.
22953 * @see elm_map_geo_region_show() for a function to avoid animation.
22954 * @see elm_map_geo_region_get()
22958 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22961 * Show the given coordinates at the center of the map, @b immediately.
22963 * @param obj The map object.
22964 * @param lon Longitude to center at.
22965 * @param lat Latitude to center at.
22967 * This causes map to @b redraw its viewport's contents to the
22968 * region contining the given @p lat and @p lon, that will be moved to the
22969 * center of the map.
22971 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22972 * @see elm_map_geo_region_get()
22976 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22979 * Pause or unpause the map.
22981 * @param obj The map object.
22982 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22985 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22988 * The default is off.
22990 * This will stop zooming using animation, changing zoom levels will
22991 * change instantly. This will stop any existing animations that are running.
22993 * @see elm_map_paused_get()
22997 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23000 * Get a value whether map is paused or not.
23002 * @param obj The map object.
23003 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23004 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23006 * This gets the current paused state for the map object.
23008 * @see elm_map_paused_set() for details.
23012 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23015 * Set to show markers during zoom level changes or not.
23017 * @param obj The map object.
23018 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23021 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23024 * The default is off.
23026 * This will stop zooming using animation, changing zoom levels will
23027 * change instantly. This will stop any existing animations that are running.
23029 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23032 * The default is off.
23034 * Enabling it will force the map to stop displaying the markers during
23035 * zoom level changes. Set to on if you have a large number of markers.
23037 * @see elm_map_paused_markers_get()
23041 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23044 * Get a value whether markers will be displayed on zoom level changes or not
23046 * @param obj The map object.
23047 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23048 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23050 * This gets the current markers paused state for the map object.
23052 * @see elm_map_paused_markers_set() for details.
23056 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23059 * Get the information of downloading status.
23061 * @param obj The map object.
23062 * @param try_num Pointer where to store number of tiles being downloaded.
23063 * @param finish_num Pointer where to store number of tiles successfully
23066 * This gets the current downloading status for the map object, the number
23067 * of tiles being downloaded and the number of tiles already downloaded.
23071 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23074 * Convert a pixel coordinate (x,y) into a geographic coordinate
23075 * (longitude, latitude).
23077 * @param obj The map object.
23078 * @param x the coordinate.
23079 * @param y the coordinate.
23080 * @param size the size in pixels of the map.
23081 * The map is a square and generally his size is : pow(2.0, zoom)*256.
23082 * @param lon Pointer where to store the longitude that correspond to x.
23083 * @param lat Pointer where to store the latitude that correspond to y.
23085 * @note Origin pixel point is the top left corner of the viewport.
23086 * Map zoom and size are taken on account.
23088 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23092 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);
23095 * Convert a geographic coordinate (longitude, latitude) into a pixel
23096 * coordinate (x, y).
23098 * @param obj The map object.
23099 * @param lon the longitude.
23100 * @param lat the latitude.
23101 * @param size the size in pixels of the map. The map is a square
23102 * and generally his size is : pow(2.0, zoom)*256.
23103 * @param x Pointer where to store the horizontal pixel coordinate that
23104 * correspond to the longitude.
23105 * @param y Pointer where to store the vertical pixel coordinate that
23106 * correspond to the latitude.
23108 * @note Origin pixel point is the top left corner of the viewport.
23109 * Map zoom and size are taken on account.
23111 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23115 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);
23118 * Convert a geographic coordinate (longitude, latitude) into a name
23121 * @param obj The map object.
23122 * @param lon the longitude.
23123 * @param lat the latitude.
23124 * @return name A #Elm_Map_Name handle for this coordinate.
23126 * To get the string for this address, elm_map_name_address_get()
23129 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23133 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23136 * Convert a name (address) into a geographic coordinate
23137 * (longitude, latitude).
23139 * @param obj The map object.
23140 * @param name The address.
23141 * @return name A #Elm_Map_Name handle for this address.
23143 * To get the longitude and latitude, elm_map_name_region_get()
23146 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23150 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23153 * Convert a pixel coordinate into a rotated pixel coordinate.
23155 * @param obj The map object.
23156 * @param x horizontal coordinate of the point to rotate.
23157 * @param y vertical coordinate of the point to rotate.
23158 * @param cx rotation's center horizontal position.
23159 * @param cy rotation's center vertical position.
23160 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23161 * @param xx Pointer where to store rotated x.
23162 * @param yy Pointer where to store rotated y.
23166 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);
23169 * Add a new marker to the map object.
23171 * @param obj The map object.
23172 * @param lon The longitude of the marker.
23173 * @param lat The latitude of the marker.
23174 * @param clas The class, to use when marker @b isn't grouped to others.
23175 * @param clas_group The class group, to use when marker is grouped to others
23176 * @param data The data passed to the callbacks.
23178 * @return The created marker or @c NULL upon failure.
23180 * A marker will be created and shown in a specific point of the map, defined
23181 * by @p lon and @p lat.
23183 * It will be displayed using style defined by @p class when this marker
23184 * is displayed alone (not grouped). A new class can be created with
23185 * elm_map_marker_class_new().
23187 * If the marker is grouped to other markers, it will be displayed with
23188 * style defined by @p class_group. Markers with the same group are grouped
23189 * if they are close. A new group class can be created with
23190 * elm_map_marker_group_class_new().
23192 * Markers created with this method can be deleted with
23193 * elm_map_marker_remove().
23195 * A marker can have associated content to be displayed by a bubble,
23196 * when a user click over it, as well as an icon. These objects will
23197 * be fetch using class' callback functions.
23199 * @see elm_map_marker_class_new()
23200 * @see elm_map_marker_group_class_new()
23201 * @see elm_map_marker_remove()
23205 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);
23208 * Set the maximum numbers of markers' content to be displayed in a group.
23210 * @param obj The map object.
23211 * @param max The maximum numbers of items displayed in a bubble.
23213 * A bubble will be displayed when the user clicks over the group,
23214 * and will place the content of markers that belong to this group
23217 * A group can have a long list of markers, consequently the creation
23218 * of the content of the bubble can be very slow.
23220 * In order to avoid this, a maximum number of items is displayed
23223 * By default this number is 30.
23225 * Marker with the same group class are grouped if they are close.
23227 * @see elm_map_marker_add()
23231 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23234 * Remove a marker from the map.
23236 * @param marker The marker to remove.
23238 * @see elm_map_marker_add()
23242 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23245 * Get the current coordinates of the marker.
23247 * @param marker marker.
23248 * @param lat Pointer where to store the marker's latitude.
23249 * @param lon Pointer where to store the marker's longitude.
23251 * These values are set when adding markers, with function
23252 * elm_map_marker_add().
23254 * @see elm_map_marker_add()
23258 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23261 * Animatedly bring in given marker to the center of the map.
23263 * @param marker The marker to center at.
23265 * This causes map to jump to the given @p marker's coordinates
23266 * and show it (by scrolling) in the center of the viewport, if it is not
23267 * already centered. This will use animation to do so and take a period
23268 * of time to complete.
23270 * @see elm_map_marker_show() for a function to avoid animation.
23271 * @see elm_map_marker_region_get()
23275 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23278 * Show the given marker at the center of the map, @b immediately.
23280 * @param marker The marker to center at.
23282 * This causes map to @b redraw its viewport's contents to the
23283 * region contining the given @p marker's coordinates, that will be
23284 * moved to the center of the map.
23286 * @see elm_map_marker_bring_in() for a function to move with animation.
23287 * @see elm_map_markers_list_show() if more than one marker need to be
23289 * @see elm_map_marker_region_get()
23293 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23296 * Move and zoom the map to display a list of markers.
23298 * @param markers A list of #Elm_Map_Marker handles.
23300 * The map will be centered on the center point of the markers in the list.
23301 * Then the map will be zoomed in order to fit the markers using the maximum
23302 * zoom which allows display of all the markers.
23304 * @warning All the markers should belong to the same map object.
23306 * @see elm_map_marker_show() to show a single marker.
23307 * @see elm_map_marker_bring_in()
23311 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23314 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23316 * @param marker The marker wich content should be returned.
23317 * @return Return the evas object if it exists, else @c NULL.
23319 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23320 * elm_map_marker_class_get_cb_set() should be used.
23322 * This content is what will be inside the bubble that will be displayed
23323 * when an user clicks over the marker.
23325 * This returns the actual Evas object used to be placed inside
23326 * the bubble. This may be @c NULL, as it may
23327 * not have been created or may have been deleted, at any time, by
23328 * the map. <b>Do not modify this object</b> (move, resize,
23329 * show, hide, etc.), as the map is controlling it. This
23330 * function is for querying, emitting custom signals or hooking
23331 * lower level callbacks for events on that object. Do not delete
23332 * this object under any circumstances.
23336 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23339 * Update the marker
23341 * @param marker The marker to be updated.
23343 * If a content is set to this marker, it will call function to delete it,
23344 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23345 * #ElmMapMarkerGetFunc.
23347 * These functions are set for the marker class with
23348 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23352 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23355 * Close all the bubbles opened by the user.
23357 * @param obj The map object.
23359 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23360 * when the user clicks on a marker.
23362 * This functions is set for the marker class with
23363 * elm_map_marker_class_get_cb_set().
23367 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23370 * Create a new group class.
23372 * @param obj The map object.
23373 * @return Returns the new group class.
23375 * Each marker must be associated to a group class. Markers in the same
23376 * group are grouped if they are close.
23378 * The group class defines the style of the marker when a marker is grouped
23379 * to others markers. When it is alone, another class will be used.
23381 * A group class will need to be provided when creating a marker with
23382 * elm_map_marker_add().
23384 * Some properties and functions can be set by class, as:
23385 * - style, with elm_map_group_class_style_set()
23386 * - data - to be associated to the group class. It can be set using
23387 * elm_map_group_class_data_set().
23388 * - min zoom to display markers, set with
23389 * elm_map_group_class_zoom_displayed_set().
23390 * - max zoom to group markers, set using
23391 * elm_map_group_class_zoom_grouped_set().
23392 * - visibility - set if markers will be visible or not, set with
23393 * elm_map_group_class_hide_set().
23394 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23395 * It can be set using elm_map_group_class_icon_cb_set().
23397 * @see elm_map_marker_add()
23398 * @see elm_map_group_class_style_set()
23399 * @see elm_map_group_class_data_set()
23400 * @see elm_map_group_class_zoom_displayed_set()
23401 * @see elm_map_group_class_zoom_grouped_set()
23402 * @see elm_map_group_class_hide_set()
23403 * @see elm_map_group_class_icon_cb_set()
23407 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23410 * Set the marker's style of a group class.
23412 * @param clas The group class.
23413 * @param style The style to be used by markers.
23415 * Each marker must be associated to a group class, and will use the style
23416 * defined by such class when grouped to other markers.
23418 * The following styles are provided by default theme:
23419 * @li @c radio - blue circle
23420 * @li @c radio2 - green circle
23423 * @see elm_map_group_class_new() for more details.
23424 * @see elm_map_marker_add()
23428 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23431 * Set the icon callback function of a group class.
23433 * @param clas The group class.
23434 * @param icon_get The callback function that will return the icon.
23436 * Each marker must be associated to a group class, and it can display a
23437 * custom icon. The function @p icon_get must return this icon.
23439 * @see elm_map_group_class_new() for more details.
23440 * @see elm_map_marker_add()
23444 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23447 * Set the data associated to the group class.
23449 * @param clas The group class.
23450 * @param data The new user data.
23452 * This data will be passed for callback functions, like icon get callback,
23453 * that can be set with elm_map_group_class_icon_cb_set().
23455 * If a data was previously set, the object will lose the pointer for it,
23456 * so if needs to be freed, you must do it yourself.
23458 * @see elm_map_group_class_new() for more details.
23459 * @see elm_map_group_class_icon_cb_set()
23460 * @see elm_map_marker_add()
23464 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23467 * Set the minimum zoom from where the markers are displayed.
23469 * @param clas The group class.
23470 * @param zoom The minimum zoom.
23472 * Markers only will be displayed when the map is displayed at @p zoom
23475 * @see elm_map_group_class_new() for more details.
23476 * @see elm_map_marker_add()
23480 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23483 * Set the zoom from where the markers are no more grouped.
23485 * @param clas The group class.
23486 * @param zoom The maximum zoom.
23488 * Markers only will be grouped when the map is displayed at
23489 * less than @p zoom.
23491 * @see elm_map_group_class_new() for more details.
23492 * @see elm_map_marker_add()
23496 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23499 * Set if the markers associated to the group class @clas are hidden or not.
23501 * @param clas The group class.
23502 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23505 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23510 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23513 * Create a new marker class.
23515 * @param obj The map object.
23516 * @return Returns the new group class.
23518 * Each marker must be associated to a class.
23520 * The marker class defines the style of the marker when a marker is
23521 * displayed alone, i.e., not grouped to to others markers. When grouped
23522 * it will use group class style.
23524 * A marker class will need to be provided when creating a marker with
23525 * elm_map_marker_add().
23527 * Some properties and functions can be set by class, as:
23528 * - style, with elm_map_marker_class_style_set()
23529 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23530 * It can be set using elm_map_marker_class_icon_cb_set().
23531 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23532 * Set using elm_map_marker_class_get_cb_set().
23533 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23534 * Set using elm_map_marker_class_del_cb_set().
23536 * @see elm_map_marker_add()
23537 * @see elm_map_marker_class_style_set()
23538 * @see elm_map_marker_class_icon_cb_set()
23539 * @see elm_map_marker_class_get_cb_set()
23540 * @see elm_map_marker_class_del_cb_set()
23544 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23547 * Set the marker's style of a marker class.
23549 * @param clas The marker class.
23550 * @param style The style to be used by markers.
23552 * Each marker must be associated to a marker class, and will use the style
23553 * defined by such class when alone, i.e., @b not grouped to other markers.
23555 * The following styles are provided by default theme:
23560 * @see elm_map_marker_class_new() for more details.
23561 * @see elm_map_marker_add()
23565 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23568 * Set the icon callback function of a marker class.
23570 * @param clas The marker class.
23571 * @param icon_get The callback function that will return the icon.
23573 * Each marker must be associated to a marker class, and it can display a
23574 * custom icon. The function @p icon_get must return this icon.
23576 * @see elm_map_marker_class_new() for more details.
23577 * @see elm_map_marker_add()
23581 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23584 * Set the bubble content callback function of a marker class.
23586 * @param clas The marker class.
23587 * @param get The callback function that will return the content.
23589 * Each marker must be associated to a marker class, and it can display a
23590 * a content on a bubble that opens when the user click over the marker.
23591 * The function @p get must return this content object.
23593 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23596 * @see elm_map_marker_class_new() for more details.
23597 * @see elm_map_marker_class_del_cb_set()
23598 * @see elm_map_marker_add()
23602 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23605 * Set the callback function used to delete bubble content of a marker class.
23607 * @param clas The marker class.
23608 * @param del The callback function that will delete the content.
23610 * Each marker must be associated to a marker class, and it can display a
23611 * a content on a bubble that opens when the user click over the marker.
23612 * The function to return such content can be set with
23613 * elm_map_marker_class_get_cb_set().
23615 * If this content must be freed, a callback function need to be
23616 * set for that task with this function.
23618 * If this callback is defined it will have to delete (or not) the
23619 * object inside, but if the callback is not defined the object will be
23620 * destroyed with evas_object_del().
23622 * @see elm_map_marker_class_new() for more details.
23623 * @see elm_map_marker_class_get_cb_set()
23624 * @see elm_map_marker_add()
23628 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23631 * Get the list of available sources.
23633 * @param obj The map object.
23634 * @return The source names list.
23636 * It will provide a list with all available sources, that can be set as
23637 * current source with elm_map_source_name_set(), or get with
23638 * elm_map_source_name_get().
23640 * Available sources:
23646 * @see elm_map_source_name_set() for more details.
23647 * @see elm_map_source_name_get()
23651 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23654 * Set the source of the map.
23656 * @param obj The map object.
23657 * @param source The source to be used.
23659 * Map widget retrieves images that composes the map from a web service.
23660 * This web service can be set with this method.
23662 * A different service can return a different maps with different
23663 * information and it can use different zoom values.
23665 * The @p source_name need to match one of the names provided by
23666 * elm_map_source_names_get().
23668 * The current source can be get using elm_map_source_name_get().
23670 * @see elm_map_source_names_get()
23671 * @see elm_map_source_name_get()
23676 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23679 * Get the name of currently used source.
23681 * @param obj The map object.
23682 * @return Returns the name of the source in use.
23684 * @see elm_map_source_name_set() for more details.
23688 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23691 * Set the source of the route service to be used by the map.
23693 * @param obj The map object.
23694 * @param source The route service to be used, being it one of
23695 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23696 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23698 * Each one has its own algorithm, so the route retrieved may
23699 * differ depending on the source route. Now, only the default is working.
23701 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23702 * http://www.yournavigation.org/.
23704 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23705 * assumptions. Its routing core is based on Contraction Hierarchies.
23707 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23709 * @see elm_map_route_source_get().
23713 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23716 * Get the current route source.
23718 * @param obj The map object.
23719 * @return The source of the route service used by the map.
23721 * @see elm_map_route_source_set() for details.
23725 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23728 * Set the minimum zoom of the source.
23730 * @param obj The map object.
23731 * @param zoom New minimum zoom value to be used.
23733 * By default, it's 0.
23737 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23740 * Get the minimum zoom of the source.
23742 * @param obj The map object.
23743 * @return Returns the minimum zoom of the source.
23745 * @see elm_map_source_zoom_min_set() for details.
23749 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23752 * Set the maximum zoom of the source.
23754 * @param obj The map object.
23755 * @param zoom New maximum zoom value to be used.
23757 * By default, it's 18.
23761 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23764 * Get the maximum zoom of the source.
23766 * @param obj The map object.
23767 * @return Returns the maximum zoom of the source.
23769 * @see elm_map_source_zoom_min_set() for details.
23773 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23776 * Set the user agent used by the map object to access routing services.
23778 * @param obj The map object.
23779 * @param user_agent The user agent to be used by the map.
23781 * User agent is a client application implementing a network protocol used
23782 * in communications within a client–server distributed computing system
23784 * The @p user_agent identification string will transmitted in a header
23785 * field @c User-Agent.
23787 * @see elm_map_user_agent_get()
23791 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23794 * Get the user agent used by the map object.
23796 * @param obj The map object.
23797 * @return The user agent identification string used by the map.
23799 * @see elm_map_user_agent_set() for details.
23803 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23806 * Add a new route to the map object.
23808 * @param obj The map object.
23809 * @param type The type of transport to be considered when tracing a route.
23810 * @param method The routing method, what should be priorized.
23811 * @param flon The start longitude.
23812 * @param flat The start latitude.
23813 * @param tlon The destination longitude.
23814 * @param tlat The destination latitude.
23816 * @return The created route or @c NULL upon failure.
23818 * A route will be traced by point on coordinates (@p flat, @p flon)
23819 * to point on coordinates (@p tlat, @p tlon), using the route service
23820 * set with elm_map_route_source_set().
23822 * It will take @p type on consideration to define the route,
23823 * depending if the user will be walking or driving, the route may vary.
23824 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23825 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23827 * Another parameter is what the route should priorize, the minor distance
23828 * or the less time to be spend on the route. So @p method should be one
23829 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23831 * Routes created with this method can be deleted with
23832 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23833 * and distance can be get with elm_map_route_distance_get().
23835 * @see elm_map_route_remove()
23836 * @see elm_map_route_color_set()
23837 * @see elm_map_route_distance_get()
23838 * @see elm_map_route_source_set()
23842 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);
23845 * Remove a route from the map.
23847 * @param route The route to remove.
23849 * @see elm_map_route_add()
23853 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23856 * Set the route color.
23858 * @param route The route object.
23859 * @param r Red channel value, from 0 to 255.
23860 * @param g Green channel value, from 0 to 255.
23861 * @param b Blue channel value, from 0 to 255.
23862 * @param a Alpha channel value, from 0 to 255.
23864 * It uses an additive color model, so each color channel represents
23865 * how much of each primary colors must to be used. 0 represents
23866 * ausence of this color, so if all of the three are set to 0,
23867 * the color will be black.
23869 * These component values should be integers in the range 0 to 255,
23870 * (single 8-bit byte).
23872 * This sets the color used for the route. By default, it is set to
23873 * solid red (r = 255, g = 0, b = 0, a = 255).
23875 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23877 * @see elm_map_route_color_get()
23881 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23884 * Get the route color.
23886 * @param route The route object.
23887 * @param r Pointer where to store the red channel value.
23888 * @param g Pointer where to store the green channel value.
23889 * @param b Pointer where to store the blue channel value.
23890 * @param a Pointer where to store the alpha channel value.
23892 * @see elm_map_route_color_set() for details.
23896 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23899 * Get the route distance in kilometers.
23901 * @param route The route object.
23902 * @return The distance of route (unit : km).
23906 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23909 * Get the information of route nodes.
23911 * @param route The route object.
23912 * @return Returns a string with the nodes of route.
23916 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23919 * Get the information of route waypoint.
23921 * @param route the route object.
23922 * @return Returns a string with information about waypoint of route.
23926 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23929 * Get the address of the name.
23931 * @param name The name handle.
23932 * @return Returns the address string of @p name.
23934 * This gets the coordinates of the @p name, created with one of the
23935 * conversion functions.
23937 * @see elm_map_utils_convert_name_into_coord()
23938 * @see elm_map_utils_convert_coord_into_name()
23942 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23945 * Get the current coordinates of the name.
23947 * @param name The name handle.
23948 * @param lat Pointer where to store the latitude.
23949 * @param lon Pointer where to store The longitude.
23951 * This gets the coordinates of the @p name, created with one of the
23952 * conversion functions.
23954 * @see elm_map_utils_convert_name_into_coord()
23955 * @see elm_map_utils_convert_coord_into_name()
23959 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23962 * Remove a name from the map.
23964 * @param name The name to remove.
23966 * Basically the struct handled by @p name will be freed, so convertions
23967 * between address and coordinates will be lost.
23969 * @see elm_map_utils_convert_name_into_coord()
23970 * @see elm_map_utils_convert_coord_into_name()
23974 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23979 * @param obj The map object.
23980 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23981 * @param cx Rotation's center horizontal position.
23982 * @param cy Rotation's center vertical position.
23984 * @see elm_map_rotate_get()
23988 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23991 * Get the rotate degree of the map
23993 * @param obj The map object
23994 * @param degree Pointer where to store degrees from 0.0 to 360.0
23995 * to rotate arount Z axis.
23996 * @param cx Pointer where to store rotation's center horizontal position.
23997 * @param cy Pointer where to store rotation's center vertical position.
23999 * @see elm_map_rotate_set() to set map rotation.
24003 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);
24006 * Enable or disable mouse wheel to be used to zoom in / out the map.
24008 * @param obj The map object.
24009 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24012 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24014 * It's disabled by default.
24016 * @see elm_map_wheel_disabled_get()
24020 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24023 * Get a value whether mouse wheel is enabled or not.
24025 * @param obj The map object.
24026 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24027 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24029 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24031 * @see elm_map_wheel_disabled_set() for details.
24035 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24039 * Add a track on the map
24041 * @param obj The map object.
24042 * @param emap The emap route object.
24043 * @return The route object. This is an elm object of type Route.
24045 * @see elm_route_add() for details.
24049 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24053 * Remove a track from the map
24055 * @param obj The map object.
24056 * @param route The track to remove.
24060 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24067 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24069 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24071 EAPI double elm_route_lon_min_get(Evas_Object *obj);
24072 EAPI double elm_route_lat_min_get(Evas_Object *obj);
24073 EAPI double elm_route_lon_max_get(Evas_Object *obj);
24074 EAPI double elm_route_lat_max_get(Evas_Object *obj);
24078 * @defgroup Panel Panel
24080 * @image html img/widget/panel/preview-00.png
24081 * @image latex img/widget/panel/preview-00.eps
24083 * @brief A panel is a type of animated container that contains subobjects.
24084 * It can be expanded or contracted by clicking the button on it's edge.
24086 * Orientations are as follows:
24087 * @li ELM_PANEL_ORIENT_TOP
24088 * @li ELM_PANEL_ORIENT_LEFT
24089 * @li ELM_PANEL_ORIENT_RIGHT
24091 * Default contents parts of the panel widget that you can use for are:
24092 * @li "default" - A content of the panel
24094 * @ref tutorial_panel shows one way to use this widget.
24097 typedef enum _Elm_Panel_Orient
24099 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24100 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24101 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24102 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24103 } Elm_Panel_Orient;
24105 * @brief Adds a panel object
24107 * @param parent The parent object
24109 * @return The panel object, or NULL on failure
24111 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24113 * @brief Sets the orientation of the panel
24115 * @param parent The parent object
24116 * @param orient The panel orientation. Can be one of the following:
24117 * @li ELM_PANEL_ORIENT_TOP
24118 * @li ELM_PANEL_ORIENT_LEFT
24119 * @li ELM_PANEL_ORIENT_RIGHT
24121 * Sets from where the panel will (dis)appear.
24123 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24125 * @brief Get the orientation of the panel.
24127 * @param obj The panel object
24128 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24130 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24132 * @brief Set the content of the panel.
24134 * @param obj The panel object
24135 * @param content The panel content
24137 * Once the content object is set, a previously set one will be deleted.
24138 * If you want to keep that old content object, use the
24139 * elm_panel_content_unset() function.
24141 * @deprecated use elm_object_content_set() instead
24144 WILL_DEPRECATE EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24146 * @brief Get the content of the panel.
24148 * @param obj The panel object
24149 * @return The content that is being used
24151 * Return the content object which is set for this widget.
24153 * @see elm_panel_content_set()
24155 * @deprecated use elm_object_content_get() instead
24158 WILL_DEPRECATE EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24160 * @brief Unset the content of the panel.
24162 * @param obj The panel object
24163 * @return The content that was being used
24165 * Unparent and return the content object which was set for this widget.
24167 * @see elm_panel_content_set()
24169 * @deprecated use elm_object_content_unset() instead
24172 WILL_DEPRECATE EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24174 * @brief Set the state of the panel.
24176 * @param obj The panel object
24177 * @param hidden If true, the panel will run the animation to contract
24179 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24181 * @brief Get the state of the panel.
24183 * @param obj The panel object
24184 * @param hidden If true, the panel is in the "hide" state
24186 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24188 * @brief Toggle the hidden state of the panel from code
24190 * @param obj The panel object
24192 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24198 * @defgroup Panes Panes
24199 * @ingroup Elementary
24201 * @image html img/widget/panes/preview-00.png
24202 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24204 * @image html img/panes.png
24205 * @image latex img/panes.eps width=\textwidth
24207 * The panes adds a dragable bar between two contents. When dragged
24208 * this bar will resize contents size.
24210 * Panes can be displayed vertically or horizontally, and contents
24211 * size proportion can be customized (homogeneous by default).
24213 * Smart callbacks one can listen to:
24214 * - "press" - The panes has been pressed (button wasn't released yet).
24215 * - "unpressed" - The panes was released after being pressed.
24216 * - "clicked" - The panes has been clicked>
24217 * - "clicked,double" - The panes has been double clicked
24219 * Available styles for it:
24222 * Default contents parts of the panes widget that you can use for are:
24223 * @li "left" - A leftside content of the panes
24224 * @li "right" - A rightside content of the panes
24226 * If panes is displayed vertically, left content will be displayed at
24229 * Here is an example on its usage:
24230 * @li @ref panes_example
24234 * @addtogroup Panes
24239 * Add a new panes widget to the given parent Elementary
24240 * (container) object.
24242 * @param parent The parent object.
24243 * @return a new panes widget handle or @c NULL, on errors.
24245 * This function inserts a new panes widget on the canvas.
24249 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24252 * Set the left content of the panes widget.
24254 * @param obj The panes object.
24255 * @param content The new left content object.
24257 * Once the content object is set, a previously set one will be deleted.
24258 * If you want to keep that old content object, use the
24259 * elm_panes_content_left_unset() function.
24261 * If panes is displayed vertically, left content will be displayed at
24264 * @see elm_panes_content_left_get()
24265 * @see elm_panes_content_right_set() to set content on the other side.
24267 * @deprecated use elm_object_part_content_set() instead
24271 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24274 * Set the right content of the panes widget.
24276 * @param obj The panes object.
24277 * @param content The new right content object.
24279 * Once the content object is set, a previously set one will be deleted.
24280 * If you want to keep that old content object, use the
24281 * elm_panes_content_right_unset() function.
24283 * If panes is displayed vertically, left content will be displayed at
24286 * @see elm_panes_content_right_get()
24287 * @see elm_panes_content_left_set() to set content on the other side.
24289 * @deprecated use elm_object_part_content_set() instead
24293 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24296 * Get the left content of the panes.
24298 * @param obj The panes object.
24299 * @return The left content object that is being used.
24301 * Return the left content object which is set for this widget.
24303 * @see elm_panes_content_left_set() for details.
24305 * @deprecated use elm_object_part_content_get() instead
24309 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24312 * Get the right content of the panes.
24314 * @param obj The panes object
24315 * @return The right content object that is being used
24317 * Return the right content object which is set for this widget.
24319 * @see elm_panes_content_right_set() for details.
24321 * @deprecated use elm_object_part_content_get() instead
24325 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24328 * Unset the left content used for the panes.
24330 * @param obj The panes object.
24331 * @return The left content object that was being used.
24333 * Unparent and return the left content object which was set for this widget.
24335 * @see elm_panes_content_left_set() for details.
24336 * @see elm_panes_content_left_get().
24338 * @deprecated use elm_object_part_content_unset() instead
24342 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24345 * Unset the right content used for the panes.
24347 * @param obj The panes object.
24348 * @return The right content object that was being used.
24350 * Unparent and return the right content object which was set for this
24353 * @see elm_panes_content_right_set() for details.
24354 * @see elm_panes_content_right_get().
24356 * @deprecated use elm_object_part_content_unset() instead
24360 WILL_DEPRECATE EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24363 * Get the size proportion of panes widget's left side.
24365 * @param obj The panes object.
24366 * @return float value between 0.0 and 1.0 representing size proportion
24369 * @see elm_panes_content_left_size_set() for more details.
24373 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24376 * Set the size proportion of panes widget's left side.
24378 * @param obj The panes object.
24379 * @param size Value between 0.0 and 1.0 representing size proportion
24382 * By default it's homogeneous, i.e., both sides have the same size.
24384 * If something different is required, it can be set with this function.
24385 * For example, if the left content should be displayed over
24386 * 75% of the panes size, @p size should be passed as @c 0.75.
24387 * This way, right content will be resized to 25% of panes size.
24389 * If displayed vertically, left content is displayed at top, and
24390 * right content at bottom.
24392 * @note This proportion will change when user drags the panes bar.
24394 * @see elm_panes_content_left_size_get()
24398 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24401 * Set the orientation of a given panes widget.
24403 * @param obj The panes object.
24404 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24405 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24407 * Use this function to change how your panes is to be
24408 * disposed: vertically or horizontally.
24410 * By default it's displayed horizontally.
24412 * @see elm_panes_horizontal_get()
24416 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24419 * Retrieve the orientation of a given panes widget.
24421 * @param obj The panes object.
24422 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24423 * @c EINA_FALSE if it's @b vertical (and on errors).
24425 * @see elm_panes_horizontal_set() for more details.
24429 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24430 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24431 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24438 * @defgroup Flip Flip
24440 * @image html img/widget/flip/preview-00.png
24441 * @image latex img/widget/flip/preview-00.eps
24443 * This widget holds 2 content objects(Evas_Object): one on the front and one
24444 * on the back. It allows you to flip from front to back and vice-versa using
24445 * various animations.
24447 * If either the front or back contents are not set the flip will treat that
24448 * as transparent. So if you wore to set the front content but not the back,
24449 * and then call elm_flip_go() you would see whatever is below the flip.
24451 * For a list of supported animations see elm_flip_go().
24453 * Signals that you can add callbacks for are:
24454 * "animate,begin" - when a flip animation was started
24455 * "animate,done" - when a flip animation is finished
24457 * @ref tutorial_flip show how to use most of the API.
24461 typedef enum _Elm_Flip_Mode
24463 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24464 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24465 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24466 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24467 ELM_FLIP_CUBE_LEFT,
24468 ELM_FLIP_CUBE_RIGHT,
24470 ELM_FLIP_CUBE_DOWN,
24471 ELM_FLIP_PAGE_LEFT,
24472 ELM_FLIP_PAGE_RIGHT,
24476 typedef enum _Elm_Flip_Interaction
24478 ELM_FLIP_INTERACTION_NONE,
24479 ELM_FLIP_INTERACTION_ROTATE,
24480 ELM_FLIP_INTERACTION_CUBE,
24481 ELM_FLIP_INTERACTION_PAGE
24482 } Elm_Flip_Interaction;
24483 typedef enum _Elm_Flip_Direction
24485 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24486 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24487 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24488 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24489 } Elm_Flip_Direction;
24491 * @brief Add a new flip to the parent
24493 * @param parent The parent object
24494 * @return The new object or NULL if it cannot be created
24496 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24498 * @brief Set the front content of the flip widget.
24500 * @param obj The flip object
24501 * @param content The new front content object
24503 * Once the content object is set, a previously set one will be deleted.
24504 * If you want to keep that old content object, use the
24505 * elm_flip_content_front_unset() function.
24507 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24509 * @brief Set the back content of the flip widget.
24511 * @param obj The flip object
24512 * @param content The new back content object
24514 * Once the content object is set, a previously set one will be deleted.
24515 * If you want to keep that old content object, use the
24516 * elm_flip_content_back_unset() function.
24518 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24520 * @brief Get the front content used for the flip
24522 * @param obj The flip object
24523 * @return The front content object that is being used
24525 * Return the front content object which is set for this widget.
24527 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24529 * @brief Get the back content used for the flip
24531 * @param obj The flip object
24532 * @return The back content object that is being used
24534 * Return the back content object which is set for this widget.
24536 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24538 * @brief Unset the front content used for the flip
24540 * @param obj The flip object
24541 * @return The front content object that was being used
24543 * Unparent and return the front content object which was set for this widget.
24545 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24547 * @brief Unset the back content used for the flip
24549 * @param obj The flip object
24550 * @return The back content object that was being used
24552 * Unparent and return the back content object which was set for this widget.
24554 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24556 * @brief Get flip front visibility state
24558 * @param obj The flip objct
24559 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24562 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24564 * @brief Set flip perspective
24566 * @param obj The flip object
24567 * @param foc The coordinate to set the focus on
24568 * @param x The X coordinate
24569 * @param y The Y coordinate
24571 * @warning This function currently does nothing.
24573 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24575 * @brief Runs the flip animation
24577 * @param obj The flip object
24578 * @param mode The mode type
24580 * Flips the front and back contents using the @p mode animation. This
24581 * efectively hides the currently visible content and shows the hidden one.
24583 * There a number of possible animations to use for the flipping:
24584 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24585 * around a horizontal axis in the middle of its height, the other content
24586 * is shown as the other side of the flip.
24587 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24588 * around a vertical axis in the middle of its width, the other content is
24589 * shown as the other side of the flip.
24590 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24591 * around a diagonal axis in the middle of its width, the other content is
24592 * shown as the other side of the flip.
24593 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24594 * around a diagonal axis in the middle of its height, the other content is
24595 * shown as the other side of the flip.
24596 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24597 * as if the flip was a cube, the other content is show as the right face of
24599 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24600 * right as if the flip was a cube, the other content is show as the left
24601 * face of the cube.
24602 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24603 * flip was a cube, the other content is show as the bottom face of the cube.
24604 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24605 * the flip was a cube, the other content is show as the upper face of the
24607 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24608 * if the flip was a book, the other content is shown as the page below that.
24609 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24610 * as if the flip was a book, the other content is shown as the page below
24612 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24613 * flip was a book, the other content is shown as the page below that.
24614 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24615 * flip was a book, the other content is shown as the page below that.
24617 * @image html elm_flip.png
24618 * @image latex elm_flip.eps width=\textwidth
24620 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24622 * @brief Set the interactive flip mode
24624 * @param obj The flip object
24625 * @param mode The interactive flip mode to use
24627 * This sets if the flip should be interactive (allow user to click and
24628 * drag a side of the flip to reveal the back page and cause it to flip).
24629 * By default a flip is not interactive. You may also need to set which
24630 * sides of the flip are "active" for flipping and how much space they use
24631 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24632 * and elm_flip_interacton_direction_hitsize_set()
24634 * The four avilable mode of interaction are:
24635 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24636 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24637 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24638 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24640 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24641 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24642 * happen, those can only be acheived with elm_flip_go();
24644 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24646 * @brief Get the interactive flip mode
24648 * @param obj The flip object
24649 * @return The interactive flip mode
24651 * Returns the interactive flip mode set by elm_flip_interaction_set()
24653 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24655 * @brief Set which directions of the flip respond to interactive flip
24657 * @param obj The flip object
24658 * @param dir The direction to change
24659 * @param enabled If that direction is enabled or not
24661 * By default all directions are disabled, so you may want to enable the
24662 * desired directions for flipping if you need interactive flipping. You must
24663 * call this function once for each direction that should be enabled.
24665 * @see elm_flip_interaction_set()
24667 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24669 * @brief Get the enabled state of that flip direction
24671 * @param obj The flip object
24672 * @param dir The direction to check
24673 * @return If that direction is enabled or not
24675 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24677 * @see elm_flip_interaction_set()
24679 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24681 * @brief Set the amount of the flip that is sensitive to interactive flip
24683 * @param obj The flip object
24684 * @param dir The direction to modify
24685 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24687 * Set the amount of the flip that is sensitive to interactive flip, with 0
24688 * representing no area in the flip and 1 representing the entire flip. There
24689 * is however a consideration to be made in that the area will never be
24690 * smaller than the finger size set(as set in your Elementary configuration).
24692 * @see elm_flip_interaction_set()
24694 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24696 * @brief Get the amount of the flip that is sensitive to interactive flip
24698 * @param obj The flip object
24699 * @param dir The direction to check
24700 * @return The size set for that direction
24702 * Returns the amount os sensitive area set by
24703 * elm_flip_interacton_direction_hitsize_set().
24705 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24710 /* scrolledentry */
24711 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24712 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24713 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24714 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24715 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24716 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24717 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24718 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24719 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24720 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24721 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24722 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24723 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24724 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24725 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24726 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24727 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24728 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24729 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24730 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24731 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24732 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24733 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24734 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24735 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24736 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24737 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24739 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24740 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24741 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24742 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24743 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24744 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24745 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24746 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);
24747 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24748 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24749 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);
24750 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24751 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);
24752 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24753 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24754 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24755 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24756 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24757 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24758 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24759 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24760 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);
24761 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);
24762 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);
24763 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);
24764 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);
24765 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);
24766 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24767 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24768 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24769 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24770 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24771 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24772 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24773 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24774 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24775 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24776 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24777 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24778 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24781 * @defgroup Conformant Conformant
24782 * @ingroup Elementary
24784 * @image html img/widget/conformant/preview-00.png
24785 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24787 * @image html img/conformant.png
24788 * @image latex img/conformant.eps width=\textwidth
24790 * The aim is to provide a widget that can be used in elementary apps to
24791 * account for space taken up by the indicator, virtual keypad & softkey
24792 * windows when running the illume2 module of E17.
24794 * So conformant content will be sized and positioned considering the
24795 * space required for such stuff, and when they popup, as a keyboard
24796 * shows when an entry is selected, conformant content won't change.
24798 * Available styles for it:
24801 * Default contents parts of the conformant widget that you can use for are:
24802 * @li "default" - A content of the conformant
24804 * See how to use this widget in this example:
24805 * @ref conformant_example
24809 * @addtogroup Conformant
24814 * Add a new conformant widget to the given parent Elementary
24815 * (container) object.
24817 * @param parent The parent object.
24818 * @return A new conformant widget handle or @c NULL, on errors.
24820 * This function inserts a new conformant widget on the canvas.
24822 * @ingroup Conformant
24824 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24827 * Set the content of the conformant widget.
24829 * @param obj The conformant object.
24830 * @param content The content to be displayed by the conformant.
24832 * Content will be sized and positioned considering the space required
24833 * to display a virtual keyboard. So it won't fill all the conformant
24834 * size. This way is possible to be sure that content won't resize
24835 * or be re-positioned after the keyboard is displayed.
24837 * Once the content object is set, a previously set one will be deleted.
24838 * If you want to keep that old content object, use the
24839 * elm_object_content_unset() function.
24841 * @see elm_object_content_unset()
24842 * @see elm_object_content_get()
24844 * @deprecated use elm_object_content_set() instead
24846 * @ingroup Conformant
24848 WILL_DEPRECATE EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24851 * Get the content of the conformant widget.
24853 * @param obj The conformant object.
24854 * @return The content that is being used.
24856 * Return the content object which is set for this widget.
24857 * It won't be unparent from conformant. For that, use
24858 * elm_object_content_unset().
24860 * @see elm_object_content_set().
24861 * @see elm_object_content_unset()
24863 * @deprecated use elm_object_content_get() instead
24865 * @ingroup Conformant
24867 WILL_DEPRECATE EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24870 * Unset the content of the conformant widget.
24872 * @param obj The conformant object.
24873 * @return The content that was being used.
24875 * Unparent and return the content object which was set for this widget.
24877 * @see elm_object_content_set().
24879 * @deprecated use elm_object_content_unset() instead
24881 * @ingroup Conformant
24883 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24886 * Returns the Evas_Object that represents the content area.
24888 * @param obj The conformant object.
24889 * @return The content area of the widget.
24891 * @ingroup Conformant
24893 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24900 * @defgroup Mapbuf Mapbuf
24901 * @ingroup Elementary
24903 * @image html img/widget/mapbuf/preview-00.png
24904 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24906 * This holds one content object and uses an Evas Map of transformation
24907 * points to be later used with this content. So the content will be
24908 * moved, resized, etc as a single image. So it will improve performance
24909 * when you have a complex interafce, with a lot of elements, and will
24910 * need to resize or move it frequently (the content object and its
24913 * Default contents parts of the mapbuf widget that you can use for are:
24914 * @li "default" - A content of the mapbuf
24916 * To enable map, elm_mapbuf_enabled_set() should be used.
24918 * See how to use this widget in this example:
24919 * @ref mapbuf_example
24923 * @addtogroup Mapbuf
24928 * Add a new mapbuf widget to the given parent Elementary
24929 * (container) object.
24931 * @param parent The parent object.
24932 * @return A new mapbuf widget handle or @c NULL, on errors.
24934 * This function inserts a new mapbuf widget on the canvas.
24938 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24941 * Set the content of the mapbuf.
24943 * @param obj The mapbuf object.
24944 * @param content The content that will be filled in this mapbuf object.
24946 * Once the content object is set, a previously set one will be deleted.
24947 * If you want to keep that old content object, use the
24948 * elm_mapbuf_content_unset() function.
24950 * To enable map, elm_mapbuf_enabled_set() should be used.
24952 * @deprecated use elm_object_content_set() instead
24956 WILL_DEPRECATE EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24959 * Get the content of the mapbuf.
24961 * @param obj The mapbuf object.
24962 * @return The content that is being used.
24964 * Return the content object which is set for this widget.
24966 * @see elm_mapbuf_content_set() for details.
24968 * @deprecated use elm_object_content_get() instead
24972 WILL_DEPRECATE EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24975 * Unset the content of the mapbuf.
24977 * @param obj The mapbuf object.
24978 * @return The content that was being used.
24980 * Unparent and return the content object which was set for this widget.
24982 * @see elm_mapbuf_content_set() for details.
24984 * @deprecated use elm_object_content_unset() instead
24988 WILL_DEPRECATE EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24991 * Enable or disable the map.
24993 * @param obj The mapbuf object.
24994 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24996 * This enables the map that is set or disables it. On enable, the object
24997 * geometry will be saved, and the new geometry will change (position and
24998 * size) to reflect the map geometry set.
25000 * Also, when enabled, alpha and smooth states will be used, so if the
25001 * content isn't solid, alpha should be enabled, for example, otherwise
25002 * a black retangle will fill the content.
25004 * When disabled, the stored map will be freed and geometry prior to
25005 * enabling the map will be restored.
25007 * It's disabled by default.
25009 * @see elm_mapbuf_alpha_set()
25010 * @see elm_mapbuf_smooth_set()
25014 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25017 * Get a value whether map is enabled or not.
25019 * @param obj The mapbuf object.
25020 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25021 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25023 * @see elm_mapbuf_enabled_set() for details.
25027 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25030 * Enable or disable smooth map rendering.
25032 * @param obj The mapbuf object.
25033 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25036 * This sets smoothing for map rendering. If the object is a type that has
25037 * its own smoothing settings, then both the smooth settings for this object
25038 * and the map must be turned off.
25040 * By default smooth maps are enabled.
25044 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25047 * Get a value whether smooth map rendering is enabled or not.
25049 * @param obj The mapbuf object.
25050 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25051 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25053 * @see elm_mapbuf_smooth_set() for details.
25057 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25060 * Set or unset alpha flag for map rendering.
25062 * @param obj The mapbuf object.
25063 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25066 * This sets alpha flag for map rendering. If the object is a type that has
25067 * its own alpha settings, then this will take precedence. Only image objects
25068 * have this currently. It stops alpha blending of the map area, and is
25069 * useful if you know the object and/or all sub-objects is 100% solid.
25071 * Alpha is enabled by default.
25075 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25078 * Get a value whether alpha blending is enabled or not.
25080 * @param obj The mapbuf object.
25081 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25082 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25084 * @see elm_mapbuf_alpha_set() for details.
25088 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25095 * @defgroup Flipselector Flip Selector
25097 * @image html img/widget/flipselector/preview-00.png
25098 * @image latex img/widget/flipselector/preview-00.eps
25100 * A flip selector is a widget to show a set of @b text items, one
25101 * at a time, with the same sheet switching style as the @ref Clock
25102 * "clock" widget, when one changes the current displaying sheet
25103 * (thus, the "flip" in the name).
25105 * User clicks to flip sheets which are @b held for some time will
25106 * make the flip selector to flip continuosly and automatically for
25107 * the user. The interval between flips will keep growing in time,
25108 * so that it helps the user to reach an item which is distant from
25109 * the current selection.
25111 * Smart callbacks one can register to:
25112 * - @c "selected" - when the widget's selected text item is changed
25113 * - @c "overflowed" - when the widget's current selection is changed
25114 * from the first item in its list to the last
25115 * - @c "underflowed" - when the widget's current selection is changed
25116 * from the last item in its list to the first
25118 * Available styles for it:
25121 * To set/get the label of the flipselector item, you can use
25122 * elm_object_item_text_set/get APIs.
25123 * Once the text is set, a previously set one will be deleted.
25125 * Here is an example on its usage:
25126 * @li @ref flipselector_example
25130 * @addtogroup Flipselector
25135 * Add a new flip selector widget to the given parent Elementary
25136 * (container) widget
25138 * @param parent The parent object
25139 * @return a new flip selector widget handle or @c NULL, on errors
25141 * This function inserts a new flip selector widget on the canvas.
25143 * @ingroup Flipselector
25145 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25148 * Programmatically select the next item of a flip selector widget
25150 * @param obj The flipselector object
25152 * @note The selection will be animated. Also, if it reaches the
25153 * end of its list of member items, it will continue with the first
25156 * @ingroup Flipselector
25158 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25161 * Programmatically select the previous item of a flip selector
25164 * @param obj The flipselector object
25166 * @note The selection will be animated. Also, if it reaches the
25167 * beginning of its list of member items, it will continue with the
25168 * last one backwards.
25170 * @ingroup Flipselector
25172 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25175 * Append a (text) item to a flip selector widget
25177 * @param obj The flipselector object
25178 * @param label The (text) label of the new item
25179 * @param func Convenience callback function to take place when
25181 * @param data Data passed to @p func, above
25182 * @return A handle to the item added or @c NULL, on errors
25184 * The widget's list of labels to show will be appended with the
25185 * given value. If the user wishes so, a callback function pointer
25186 * can be passed, which will get called when this same item is
25189 * @note The current selection @b won't be modified by appending an
25190 * element to the list.
25192 * @note The maximum length of the text label is going to be
25193 * determined <b>by the widget's theme</b>. Strings larger than
25194 * that value are going to be @b truncated.
25196 * @ingroup Flipselector
25198 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25201 * Prepend a (text) item to a flip selector widget
25203 * @param obj The flipselector object
25204 * @param label The (text) label of the new item
25205 * @param func Convenience callback function to take place when
25207 * @param data Data passed to @p func, above
25208 * @return A handle to the item added or @c NULL, on errors
25210 * The widget's list of labels to show will be prepended with the
25211 * given value. If the user wishes so, a callback function pointer
25212 * can be passed, which will get called when this same item is
25215 * @note The current selection @b won't be modified by prepending
25216 * an element to the list.
25218 * @note The maximum length of the text label is going to be
25219 * determined <b>by the widget's theme</b>. Strings larger than
25220 * that value are going to be @b truncated.
25222 * @ingroup Flipselector
25224 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25227 * Get the internal list of items in a given flip selector widget.
25229 * @param obj The flipselector object
25230 * @return The list of items (#Elm_Object_Item as data) or
25231 * @c NULL on errors.
25233 * This list is @b not to be modified in any way and must not be
25234 * freed. Use the list members with functions like
25235 * elm_object_item_text_set(),
25236 * elm_object_item_text_get(),
25237 * elm_flipselector_item_del(),
25238 * elm_flipselector_item_selected_get(),
25239 * elm_flipselector_item_selected_set().
25241 * @warning This list is only valid until @p obj object's internal
25242 * items list is changed. It should be fetched again with another
25243 * call to this function when changes happen.
25245 * @ingroup Flipselector
25247 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25250 * Get the first item in the given flip selector widget's list of
25253 * @param obj The flipselector object
25254 * @return The first item or @c NULL, if it has no items (and on
25257 * @see elm_flipselector_item_append()
25258 * @see elm_flipselector_last_item_get()
25260 * @ingroup Flipselector
25262 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25265 * Get the last item in the given flip selector widget's list of
25268 * @param obj The flipselector object
25269 * @return The last item or @c NULL, if it has no items (and on
25272 * @see elm_flipselector_item_prepend()
25273 * @see elm_flipselector_first_item_get()
25275 * @ingroup Flipselector
25277 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25280 * Get the currently selected item in a flip selector widget.
25282 * @param obj The flipselector object
25283 * @return The selected item or @c NULL, if the widget has no items
25286 * @ingroup Flipselector
25288 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25291 * Set whether a given flip selector widget's item should be the
25292 * currently selected one.
25294 * @param it The flip selector item
25295 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25297 * This sets whether @p item is or not the selected (thus, under
25298 * display) one. If @p item is different than one under display,
25299 * the latter will be unselected. If the @p item is set to be
25300 * unselected, on the other hand, the @b first item in the widget's
25301 * internal members list will be the new selected one.
25303 * @see elm_flipselector_item_selected_get()
25305 * @ingroup Flipselector
25307 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25310 * Get whether a given flip selector widget's item is the currently
25313 * @param it The flip selector item
25314 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25317 * @see elm_flipselector_item_selected_set()
25319 * @ingroup Flipselector
25321 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25324 * Delete a given item from a flip selector widget.
25326 * @param it The item to delete
25328 * @ingroup Flipselector
25330 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25333 * Get the label of a given flip selector widget's item.
25335 * @param it The item to get label from
25336 * @return The text label of @p item or @c NULL, on errors
25338 * @see elm_object_item_text_set()
25340 * @deprecated see elm_object_item_text_get() instead
25341 * @ingroup Flipselector
25343 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25346 * Set the label of a given flip selector widget's item.
25348 * @param it The item to set label on
25349 * @param label The text label string, in UTF-8 encoding
25351 * @see elm_object_item_text_get()
25353 * @deprecated see elm_object_item_text_set() instead
25354 * @ingroup Flipselector
25356 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25359 * Gets the item before @p item in a flip selector widget's
25360 * internal list of items.
25362 * @param it The item to fetch previous from
25363 * @return The item before the @p item, in its parent's list. If
25364 * there is no previous item for @p item or there's an
25365 * error, @c NULL is returned.
25367 * @see elm_flipselector_item_next_get()
25369 * @ingroup Flipselector
25371 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25374 * Gets the item after @p item in a flip selector widget's
25375 * internal list of items.
25377 * @param it The item to fetch next from
25378 * @return The item after the @p item, in its parent's list. If
25379 * there is no next item for @p item or there's an
25380 * error, @c NULL is returned.
25382 * @see elm_flipselector_item_next_get()
25384 * @ingroup Flipselector
25386 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25389 * Set the interval on time updates for an user mouse button hold
25390 * on a flip selector widget.
25392 * @param obj The flip selector object
25393 * @param interval The (first) interval value in seconds
25395 * This interval value is @b decreased while the user holds the
25396 * mouse pointer either flipping up or flipping doww a given flip
25399 * This helps the user to get to a given item distant from the
25400 * current one easier/faster, as it will start to flip quicker and
25401 * quicker on mouse button holds.
25403 * The calculation for the next flip interval value, starting from
25404 * the one set with this call, is the previous interval divided by
25405 * 1.05, so it decreases a little bit.
25407 * The default starting interval value for automatic flips is
25410 * @see elm_flipselector_interval_get()
25412 * @ingroup Flipselector
25414 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25417 * Get the interval on time updates for an user mouse button hold
25418 * on a flip selector widget.
25420 * @param obj The flip selector object
25421 * @return The (first) interval value, in seconds, set on it
25423 * @see elm_flipselector_interval_set() for more details
25425 * @ingroup Flipselector
25427 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25433 * @addtogroup Calendar
25438 * @enum _Elm_Calendar_Mark_Repeat
25439 * @typedef Elm_Calendar_Mark_Repeat
25441 * Event periodicity, used to define if a mark should be repeated
25442 * @b beyond event's day. It's set when a mark is added.
25444 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25445 * there will be marks every week after this date. Marks will be displayed
25446 * at 13th, 20th, 27th, 3rd June ...
25448 * Values don't work as bitmask, only one can be choosen.
25450 * @see elm_calendar_mark_add()
25452 * @ingroup Calendar
25454 typedef enum _Elm_Calendar_Mark_Repeat
25456 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25457 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25458 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25459 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*/
25460 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. */
25461 } Elm_Calendar_Mark_Repeat;
25463 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(). */
25466 * Add a new calendar widget to the given parent Elementary
25467 * (container) object.
25469 * @param parent The parent object.
25470 * @return a new calendar widget handle or @c NULL, on errors.
25472 * This function inserts a new calendar widget on the canvas.
25474 * @ref calendar_example_01
25476 * @ingroup Calendar
25478 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25481 * Get weekdays names displayed by the calendar.
25483 * @param obj The calendar object.
25484 * @return Array of seven strings to be used as weekday names.
25486 * By default, weekdays abbreviations get from system are displayed:
25487 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25488 * The first string is related to Sunday, the second to Monday...
25490 * @see elm_calendar_weekdays_name_set()
25492 * @ref calendar_example_05
25494 * @ingroup Calendar
25496 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25499 * Set weekdays names to be displayed by the calendar.
25501 * @param obj The calendar object.
25502 * @param weekdays Array of seven strings to be used as weekday names.
25503 * @warning It must have 7 elements, or it will access invalid memory.
25504 * @warning The strings must be NULL terminated ('@\0').
25506 * By default, weekdays abbreviations get from system are displayed:
25507 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25509 * The first string should be related to Sunday, the second to Monday...
25511 * The usage should be like this:
25513 * const char *weekdays[] =
25515 * "Sunday", "Monday", "Tuesday", "Wednesday",
25516 * "Thursday", "Friday", "Saturday"
25518 * elm_calendar_weekdays_names_set(calendar, weekdays);
25521 * @see elm_calendar_weekdays_name_get()
25523 * @ref calendar_example_02
25525 * @ingroup Calendar
25527 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25530 * Set the minimum and maximum values for the year
25532 * @param obj The calendar object
25533 * @param min The minimum year, greater than 1901;
25534 * @param max The maximum year;
25536 * Maximum must be greater than minimum, except if you don't wan't to set
25538 * Default values are 1902 and -1.
25540 * If the maximum year is a negative value, it will be limited depending
25541 * on the platform architecture (year 2037 for 32 bits);
25543 * @see elm_calendar_min_max_year_get()
25545 * @ref calendar_example_03
25547 * @ingroup Calendar
25549 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25552 * Get the minimum and maximum values for the year
25554 * @param obj The calendar object.
25555 * @param min The minimum year.
25556 * @param max The maximum year.
25558 * Default values are 1902 and -1.
25560 * @see elm_calendar_min_max_year_get() for more details.
25562 * @ref calendar_example_05
25564 * @ingroup Calendar
25566 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25569 * Enable or disable day selection
25571 * @param obj The calendar object.
25572 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25575 * Enabled by default. If disabled, the user still can select months,
25576 * but not days. Selected days are highlighted on calendar.
25577 * It should be used if you won't need such selection for the widget usage.
25579 * When a day is selected, or month is changed, smart callbacks for
25580 * signal "changed" will be called.
25582 * @see elm_calendar_day_selection_enable_get()
25584 * @ref calendar_example_04
25586 * @ingroup Calendar
25588 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25591 * Get a value whether day selection is enabled or not.
25593 * @see elm_calendar_day_selection_enable_set() for details.
25595 * @param obj The calendar object.
25596 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25597 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25599 * @ref calendar_example_05
25601 * @ingroup Calendar
25603 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25607 * Set selected date to be highlighted on calendar.
25609 * @param obj The calendar object.
25610 * @param selected_time A @b tm struct to represent the selected date.
25612 * Set the selected date, changing the displayed month if needed.
25613 * Selected date changes when the user goes to next/previous month or
25614 * select a day pressing over it on calendar.
25616 * @see elm_calendar_selected_time_get()
25618 * @ref calendar_example_04
25620 * @ingroup Calendar
25622 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25625 * Get selected date.
25627 * @param obj The calendar object
25628 * @param selected_time A @b tm struct to point to selected date
25629 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25632 * Get date selected by the user or set by function
25633 * elm_calendar_selected_time_set().
25634 * Selected date changes when the user goes to next/previous month or
25635 * select a day pressing over it on calendar.
25637 * @see elm_calendar_selected_time_get()
25639 * @ref calendar_example_05
25641 * @ingroup Calendar
25643 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25646 * Set a function to format the string that will be used to display
25649 * @param obj The calendar object
25650 * @param format_function Function to set the month-year string given
25651 * the selected date
25653 * By default it uses strftime with "%B %Y" format string.
25654 * It should allocate the memory that will be used by the string,
25655 * that will be freed by the widget after usage.
25656 * A pointer to the string and a pointer to the time struct will be provided.
25661 * _format_month_year(struct tm *selected_time)
25664 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25665 * return strdup(buf);
25668 * elm_calendar_format_function_set(calendar, _format_month_year);
25671 * @ref calendar_example_02
25673 * @ingroup Calendar
25675 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25678 * Add a new mark to the calendar
25680 * @param obj The calendar object
25681 * @param mark_type A string used to define the type of mark. It will be
25682 * emitted to the theme, that should display a related modification on these
25683 * days representation.
25684 * @param mark_time A time struct to represent the date of inclusion of the
25685 * mark. For marks that repeats it will just be displayed after the inclusion
25686 * date in the calendar.
25687 * @param repeat Repeat the event following this periodicity. Can be a unique
25688 * mark (that don't repeat), daily, weekly, monthly or annually.
25689 * @return The created mark or @p NULL upon failure.
25691 * Add a mark that will be drawn in the calendar respecting the insertion
25692 * time and periodicity. It will emit the type as signal to the widget theme.
25693 * Default theme supports "holiday" and "checked", but it can be extended.
25695 * It won't immediately update the calendar, drawing the marks.
25696 * For this, call elm_calendar_marks_draw(). However, when user selects
25697 * next or previous month calendar forces marks drawn.
25699 * Marks created with this method can be deleted with
25700 * elm_calendar_mark_del().
25704 * struct tm selected_time;
25705 * time_t current_time;
25707 * current_time = time(NULL) + 5 * 84600;
25708 * localtime_r(¤t_time, &selected_time);
25709 * elm_calendar_mark_add(cal, "holiday", selected_time,
25710 * ELM_CALENDAR_ANNUALLY);
25712 * current_time = time(NULL) + 1 * 84600;
25713 * localtime_r(¤t_time, &selected_time);
25714 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25716 * elm_calendar_marks_draw(cal);
25719 * @see elm_calendar_marks_draw()
25720 * @see elm_calendar_mark_del()
25722 * @ref calendar_example_06
25724 * @ingroup Calendar
25726 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);
25729 * Delete mark from the calendar.
25731 * @param mark The mark to be deleted.
25733 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25734 * should be used instead of getting marks list and deleting each one.
25736 * @see elm_calendar_mark_add()
25738 * @ref calendar_example_06
25740 * @ingroup Calendar
25742 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25745 * Remove all calendar's marks
25747 * @param obj The calendar object.
25749 * @see elm_calendar_mark_add()
25750 * @see elm_calendar_mark_del()
25752 * @ingroup Calendar
25754 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25758 * Get a list of all the calendar marks.
25760 * @param obj The calendar object.
25761 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25763 * @see elm_calendar_mark_add()
25764 * @see elm_calendar_mark_del()
25765 * @see elm_calendar_marks_clear()
25767 * @ingroup Calendar
25769 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25772 * Draw calendar marks.
25774 * @param obj The calendar object.
25776 * Should be used after adding, removing or clearing marks.
25777 * It will go through the entire marks list updating the calendar.
25778 * If lots of marks will be added, add all the marks and then call
25781 * When the month is changed, i.e. user selects next or previous month,
25782 * marks will be drawed.
25784 * @see elm_calendar_mark_add()
25785 * @see elm_calendar_mark_del()
25786 * @see elm_calendar_marks_clear()
25788 * @ref calendar_example_06
25790 * @ingroup Calendar
25792 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25795 * Set a day text color to the same that represents Saturdays.
25797 * @param obj The calendar object.
25798 * @param pos The text position. Position is the cell counter, from left
25799 * to right, up to down. It starts on 0 and ends on 41.
25801 * @deprecated use elm_calendar_mark_add() instead like:
25804 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25805 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25808 * @see elm_calendar_mark_add()
25810 * @ingroup Calendar
25812 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25815 * Set a day text color to the same that represents Sundays.
25817 * @param obj The calendar object.
25818 * @param pos The text position. Position is the cell counter, from left
25819 * to right, up to down. It starts on 0 and ends on 41.
25821 * @deprecated use elm_calendar_mark_add() instead like:
25824 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25825 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25828 * @see elm_calendar_mark_add()
25830 * @ingroup Calendar
25832 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25835 * Set a day text color to the same that represents Weekdays.
25837 * @param obj The calendar object
25838 * @param pos The text position. Position is the cell counter, from left
25839 * to right, up to down. It starts on 0 and ends on 41.
25841 * @deprecated use elm_calendar_mark_add() instead like:
25844 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25846 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25847 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25848 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25849 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25850 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25851 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25852 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25853 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25854 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25857 * @see elm_calendar_mark_add()
25859 * @ingroup Calendar
25861 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25864 * Set the interval on time updates for an user mouse button hold
25865 * on calendar widgets' month selection.
25867 * @param obj The calendar object
25868 * @param interval The (first) interval value in seconds
25870 * This interval value is @b decreased while the user holds the
25871 * mouse pointer either selecting next or previous month.
25873 * This helps the user to get to a given month distant from the
25874 * current one easier/faster, as it will start to change quicker and
25875 * quicker on mouse button holds.
25877 * The calculation for the next change interval value, starting from
25878 * the one set with this call, is the previous interval divided by
25879 * 1.05, so it decreases a little bit.
25881 * The default starting interval value for automatic changes is
25884 * @see elm_calendar_interval_get()
25886 * @ingroup Calendar
25888 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25891 * Get the interval on time updates for an user mouse button hold
25892 * on calendar widgets' month selection.
25894 * @param obj The calendar object
25895 * @return The (first) interval value, in seconds, set on it
25897 * @see elm_calendar_interval_set() for more details
25899 * @ingroup Calendar
25901 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25908 * @defgroup Diskselector Diskselector
25909 * @ingroup Elementary
25911 * @image html img/widget/diskselector/preview-00.png
25912 * @image latex img/widget/diskselector/preview-00.eps
25914 * A diskselector is a kind of list widget. It scrolls horizontally,
25915 * and can contain label and icon objects. Three items are displayed
25916 * with the selected one in the middle.
25918 * It can act like a circular list with round mode and labels can be
25919 * reduced for a defined length for side items.
25921 * Smart callbacks one can listen to:
25922 * - "selected" - when item is selected, i.e. scroller stops.
25924 * Available styles for it:
25927 * List of examples:
25928 * @li @ref diskselector_example_01
25929 * @li @ref diskselector_example_02
25933 * @addtogroup Diskselector
25937 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(). */
25940 * Add a new diskselector widget to the given parent Elementary
25941 * (container) object.
25943 * @param parent The parent object.
25944 * @return a new diskselector widget handle or @c NULL, on errors.
25946 * This function inserts a new diskselector widget on the canvas.
25948 * @ingroup Diskselector
25950 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25953 * Enable or disable round mode.
25955 * @param obj The diskselector object.
25956 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25959 * Disabled by default. If round mode is enabled the items list will
25960 * work like a circle list, so when the user reaches the last item,
25961 * the first one will popup.
25963 * @see elm_diskselector_round_get()
25965 * @ingroup Diskselector
25967 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25970 * Get a value whether round mode is enabled or not.
25972 * @see elm_diskselector_round_set() for details.
25974 * @param obj The diskselector object.
25975 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25976 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25978 * @ingroup Diskselector
25980 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25983 * Get the side labels max length.
25985 * @deprecated use elm_diskselector_side_label_length_get() instead:
25987 * @param obj The diskselector object.
25988 * @return The max length defined for side labels, or 0 if not a valid
25991 * @ingroup Diskselector
25993 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25996 * Set the side labels max length.
25998 * @deprecated use elm_diskselector_side_label_length_set() instead:
26000 * @param obj The diskselector object.
26001 * @param len The max length defined for side labels.
26003 * @ingroup Diskselector
26005 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26008 * Get the side labels max length.
26010 * @see elm_diskselector_side_label_length_set() for details.
26012 * @param obj The diskselector object.
26013 * @return The max length defined for side labels, or 0 if not a valid
26016 * @ingroup Diskselector
26018 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26021 * Set the side labels max length.
26023 * @param obj The diskselector object.
26024 * @param len The max length defined for side labels.
26026 * Length is the number of characters of items' label that will be
26027 * visible when it's set on side positions. It will just crop
26028 * the string after defined size. E.g.:
26030 * An item with label "January" would be displayed on side position as
26031 * "Jan" if max length is set to 3, or "Janu", if this property
26034 * When it's selected, the entire label will be displayed, except for
26035 * width restrictions. In this case label will be cropped and "..."
26036 * will be concatenated.
26038 * Default side label max length is 3.
26040 * This property will be applyed over all items, included before or
26041 * later this function call.
26043 * @ingroup Diskselector
26045 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26048 * Set the number of items to be displayed.
26050 * @param obj The diskselector object.
26051 * @param num The number of items the diskselector will display.
26053 * Default value is 3, and also it's the minimun. If @p num is less
26054 * than 3, it will be set to 3.
26056 * Also, it can be set on theme, using data item @c display_item_num
26057 * on group "elm/diskselector/item/X", where X is style set.
26060 * group { name: "elm/diskselector/item/X";
26062 * item: "display_item_num" "5";
26065 * @ingroup Diskselector
26067 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26070 * Get the number of items in the diskselector object.
26072 * @param obj The diskselector object.
26074 * @ingroup Diskselector
26076 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26079 * Set bouncing behaviour when the scrolled content reaches an edge.
26081 * Tell the internal scroller object whether it should bounce or not
26082 * when it reaches the respective edges for each axis.
26084 * @param obj The diskselector object.
26085 * @param h_bounce Whether to bounce or not in the horizontal axis.
26086 * @param v_bounce Whether to bounce or not in the vertical axis.
26088 * @see elm_scroller_bounce_set()
26090 * @ingroup Diskselector
26092 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26095 * Get the bouncing behaviour of the internal scroller.
26097 * Get whether the internal scroller should bounce when the edge of each
26098 * axis is reached scrolling.
26100 * @param obj The diskselector object.
26101 * @param h_bounce Pointer where to store the bounce state of the horizontal
26103 * @param v_bounce Pointer where to store the bounce state of the vertical
26106 * @see elm_scroller_bounce_get()
26107 * @see elm_diskselector_bounce_set()
26109 * @ingroup Diskselector
26111 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26114 * Get the scrollbar policy.
26116 * @see elm_diskselector_scroller_policy_get() for details.
26118 * @param obj The diskselector object.
26119 * @param policy_h Pointer where to store horizontal scrollbar policy.
26120 * @param policy_v Pointer where to store vertical scrollbar policy.
26122 * @ingroup Diskselector
26124 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);
26127 * Set the scrollbar policy.
26129 * @param obj The diskselector object.
26130 * @param policy_h Horizontal scrollbar policy.
26131 * @param policy_v Vertical scrollbar policy.
26133 * This sets the scrollbar visibility policy for the given scroller.
26134 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26135 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26136 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26137 * This applies respectively for the horizontal and vertical scrollbars.
26139 * The both are disabled by default, i.e., are set to
26140 * #ELM_SCROLLER_POLICY_OFF.
26142 * @ingroup Diskselector
26144 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26147 * Remove all diskselector's items.
26149 * @param obj The diskselector object.
26151 * @see elm_diskselector_item_del()
26152 * @see elm_diskselector_item_append()
26154 * @ingroup Diskselector
26156 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26159 * Get a list of all the diskselector items.
26161 * @param obj The diskselector object.
26162 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26163 * or @c NULL on failure.
26165 * @see elm_diskselector_item_append()
26166 * @see elm_diskselector_item_del()
26167 * @see elm_diskselector_clear()
26169 * @ingroup Diskselector
26171 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26174 * Appends a new item to the diskselector object.
26176 * @param obj The diskselector object.
26177 * @param label The label of the diskselector item.
26178 * @param icon The icon object to use at left side of the item. An
26179 * icon can be any Evas object, but usually it is an icon created
26180 * with elm_icon_add().
26181 * @param func The function to call when the item is selected.
26182 * @param data The data to associate with the item for related callbacks.
26184 * @return The created item or @c NULL upon failure.
26186 * A new item will be created and appended to the diskselector, i.e., will
26187 * be set as last item. Also, if there is no selected item, it will
26188 * be selected. This will always happens for the first appended item.
26190 * If no icon is set, label will be centered on item position, otherwise
26191 * the icon will be placed at left of the label, that will be shifted
26194 * Items created with this method can be deleted with
26195 * elm_diskselector_item_del().
26197 * Associated @p data can be properly freed when item is deleted if a
26198 * callback function is set with elm_diskselector_item_del_cb_set().
26200 * If a function is passed as argument, it will be called everytime this item
26201 * is selected, i.e., the user stops the diskselector with this
26202 * item on center position. If such function isn't needed, just passing
26203 * @c NULL as @p func is enough. The same should be done for @p data.
26205 * Simple example (with no function callback or data associated):
26207 * disk = elm_diskselector_add(win);
26208 * ic = elm_icon_add(win);
26209 * elm_icon_file_set(ic, "path/to/image", NULL);
26210 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26211 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26214 * @see elm_diskselector_item_del()
26215 * @see elm_diskselector_item_del_cb_set()
26216 * @see elm_diskselector_clear()
26217 * @see elm_icon_add()
26219 * @ingroup Diskselector
26221 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);
26225 * Delete them item from the diskselector.
26227 * @param it The item of diskselector to be deleted.
26229 * If deleting all diskselector items is required, elm_diskselector_clear()
26230 * should be used instead of getting items list and deleting each one.
26232 * @see elm_diskselector_clear()
26233 * @see elm_diskselector_item_append()
26234 * @see elm_diskselector_item_del_cb_set()
26236 * @ingroup Diskselector
26238 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26241 * Set the function called when a diskselector item is freed.
26243 * @param it The item to set the callback on
26244 * @param func The function called
26246 * If there is a @p func, then it will be called prior item's memory release.
26247 * That will be called with the following arguments:
26249 * @li item's Evas object;
26252 * This way, a data associated to a diskselector item could be properly
26255 * @ingroup Diskselector
26257 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26260 * Get the data associated to the item.
26262 * @param it The diskselector item
26263 * @return The data associated to @p it
26265 * The return value is a pointer to data associated to @p item when it was
26266 * created, with function elm_diskselector_item_append(). If no data
26267 * was passed as argument, it will return @c NULL.
26269 * @see elm_diskselector_item_append()
26271 * @ingroup Diskselector
26273 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26276 * Set the icon associated to the item.
26278 * @param it The diskselector item
26279 * @param icon The icon object to associate with @p it
26281 * The icon object to use at left side of the item. An
26282 * icon can be any Evas object, but usually it is an icon created
26283 * with elm_icon_add().
26285 * Once the icon object is set, a previously set one will be deleted.
26286 * @warning Setting the same icon for two items will cause the icon to
26287 * dissapear from the first item.
26289 * If an icon was passed as argument on item creation, with function
26290 * elm_diskselector_item_append(), it will be already
26291 * associated to the item.
26293 * @see elm_diskselector_item_append()
26294 * @see elm_diskselector_item_icon_get()
26296 * @ingroup Diskselector
26298 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26301 * Get the icon associated to the item.
26303 * @param it The diskselector item
26304 * @return The icon associated to @p it
26306 * The return value is a pointer to the icon associated to @p item when it was
26307 * created, with function elm_diskselector_item_append(), or later
26308 * with function elm_diskselector_item_icon_set. If no icon
26309 * was passed as argument, it will return @c NULL.
26311 * @see elm_diskselector_item_append()
26312 * @see elm_diskselector_item_icon_set()
26314 * @ingroup Diskselector
26316 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26319 * Set the label of item.
26321 * @param it The item of diskselector.
26322 * @param label The label of item.
26324 * The label to be displayed by the item.
26326 * If no icon is set, label will be centered on item position, otherwise
26327 * the icon will be placed at left of the label, that will be shifted
26330 * An item with label "January" would be displayed on side position as
26331 * "Jan" if max length is set to 3 with function
26332 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26335 * When this @p item is selected, the entire label will be displayed,
26336 * except for width restrictions.
26337 * In this case label will be cropped and "..." will be concatenated,
26338 * but only for display purposes. It will keep the entire string, so
26339 * if diskselector is resized the remaining characters will be displayed.
26341 * If a label was passed as argument on item creation, with function
26342 * elm_diskselector_item_append(), it will be already
26343 * displayed by the item.
26345 * @see elm_diskselector_side_label_lenght_set()
26346 * @see elm_diskselector_item_label_get()
26347 * @see elm_diskselector_item_append()
26349 * @ingroup Diskselector
26351 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26354 * Get the label of item.
26356 * @param it The item of diskselector.
26357 * @return The label of item.
26359 * The return value is a pointer to the label associated to @p item when it was
26360 * created, with function elm_diskselector_item_append(), or later
26361 * with function elm_diskselector_item_label_set. If no label
26362 * was passed as argument, it will return @c NULL.
26364 * @see elm_diskselector_item_label_set() for more details.
26365 * @see elm_diskselector_item_append()
26367 * @ingroup Diskselector
26369 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26372 * Get the selected item.
26374 * @param obj The diskselector object.
26375 * @return The selected diskselector item.
26377 * The selected item can be unselected with function
26378 * elm_diskselector_item_selected_set(), and the first item of
26379 * diskselector will be selected.
26381 * The selected item always will be centered on diskselector, with
26382 * full label displayed, i.e., max lenght set to side labels won't
26383 * apply on the selected item. More details on
26384 * elm_diskselector_side_label_length_set().
26386 * @ingroup Diskselector
26388 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26391 * Set the selected state of an item.
26393 * @param it The diskselector item
26394 * @param selected The selected state
26396 * This sets the selected state of the given item @p it.
26397 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26399 * If a new item is selected the previosly selected will be unselected.
26400 * Previoulsy selected item can be get with function
26401 * elm_diskselector_selected_item_get().
26403 * If the item @p it is unselected, the first item of diskselector will
26406 * Selected items will be visible on center position of diskselector.
26407 * So if it was on another position before selected, or was invisible,
26408 * diskselector will animate items until the selected item reaches center
26411 * @see elm_diskselector_item_selected_get()
26412 * @see elm_diskselector_selected_item_get()
26414 * @ingroup Diskselector
26416 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26419 * Get whether the @p item is selected or not.
26421 * @param it The diskselector item.
26422 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26423 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26425 * @see elm_diskselector_selected_item_set() for details.
26426 * @see elm_diskselector_item_selected_get()
26428 * @ingroup Diskselector
26430 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26433 * Get the first item of the diskselector.
26435 * @param obj The diskselector object.
26436 * @return The first item, or @c NULL if none.
26438 * The list of items follows append order. So it will return the first
26439 * item appended to the widget that wasn't deleted.
26441 * @see elm_diskselector_item_append()
26442 * @see elm_diskselector_items_get()
26444 * @ingroup Diskselector
26446 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26449 * Get the last item of the diskselector.
26451 * @param obj The diskselector object.
26452 * @return The last item, or @c NULL if none.
26454 * The list of items follows append order. So it will return last first
26455 * item appended to the widget that wasn't deleted.
26457 * @see elm_diskselector_item_append()
26458 * @see elm_diskselector_items_get()
26460 * @ingroup Diskselector
26462 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26465 * Get the item before @p item in diskselector.
26467 * @param it The diskselector item.
26468 * @return The item before @p item, or @c NULL if none or on failure.
26470 * The list of items follows append order. So it will return item appended
26471 * just before @p item and that wasn't deleted.
26473 * If it is the first item, @c NULL will be returned.
26474 * First item can be get by elm_diskselector_first_item_get().
26476 * @see elm_diskselector_item_append()
26477 * @see elm_diskselector_items_get()
26479 * @ingroup Diskselector
26481 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26484 * Get the item after @p item in diskselector.
26486 * @param it The diskselector item.
26487 * @return The item after @p item, or @c NULL if none or on failure.
26489 * The list of items follows append order. So it will return item appended
26490 * just after @p item and that wasn't deleted.
26492 * If it is the last item, @c NULL will be returned.
26493 * Last item can be get by elm_diskselector_last_item_get().
26495 * @see elm_diskselector_item_append()
26496 * @see elm_diskselector_items_get()
26498 * @ingroup Diskselector
26500 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26503 * Set the text to be shown in the diskselector item.
26505 * @param item Target item
26506 * @param text The text to set in the content
26508 * Setup the text as tooltip to object. The item can have only one tooltip,
26509 * so any previous tooltip data is removed.
26511 * @see elm_object_tooltip_text_set() for more details.
26513 * @ingroup Diskselector
26515 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26518 * Set the content to be shown in the tooltip item.
26520 * Setup the tooltip to item. The item can have only one tooltip,
26521 * so any previous tooltip data is removed. @p func(with @p data) will
26522 * be called every time that need show the tooltip and it should
26523 * return a valid Evas_Object. This object is then managed fully by
26524 * tooltip system and is deleted when the tooltip is gone.
26526 * @param item the diskselector item being attached a tooltip.
26527 * @param func the function used to create the tooltip contents.
26528 * @param data what to provide to @a func as callback data/context.
26529 * @param del_cb called when data is not needed anymore, either when
26530 * another callback replaces @p func, the tooltip is unset with
26531 * elm_diskselector_item_tooltip_unset() or the owner @a item
26532 * dies. This callback receives as the first parameter the
26533 * given @a data, and @c event_info is the item.
26535 * @see elm_object_tooltip_content_cb_set() for more details.
26537 * @ingroup Diskselector
26539 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);
26542 * Unset tooltip from item.
26544 * @param item diskselector item to remove previously set tooltip.
26546 * Remove tooltip from item. The callback provided as del_cb to
26547 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26548 * it is not used anymore.
26550 * @see elm_object_tooltip_unset() for more details.
26551 * @see elm_diskselector_item_tooltip_content_cb_set()
26553 * @ingroup Diskselector
26555 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26559 * Sets a different style for this item tooltip.
26561 * @note before you set a style you should define a tooltip with
26562 * elm_diskselector_item_tooltip_content_cb_set() or
26563 * elm_diskselector_item_tooltip_text_set()
26565 * @param item diskselector item with tooltip already set.
26566 * @param style the theme style to use (default, transparent, ...)
26568 * @see elm_object_tooltip_style_set() for more details.
26570 * @ingroup Diskselector
26572 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26575 * Get the style for this item tooltip.
26577 * @param item diskselector item with tooltip already set.
26578 * @return style the theme style in use, defaults to "default". If the
26579 * object does not have a tooltip set, then NULL is returned.
26581 * @see elm_object_tooltip_style_get() for more details.
26582 * @see elm_diskselector_item_tooltip_style_set()
26584 * @ingroup Diskselector
26586 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26589 * Set the cursor to be shown when mouse is over the diskselector item
26591 * @param item Target item
26592 * @param cursor the cursor name to be used.
26594 * @see elm_object_cursor_set() for more details.
26596 * @ingroup Diskselector
26598 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26601 * Get the cursor to be shown when mouse is over the diskselector item
26603 * @param item diskselector item with cursor already set.
26604 * @return the cursor name.
26606 * @see elm_object_cursor_get() for more details.
26607 * @see elm_diskselector_cursor_set()
26609 * @ingroup Diskselector
26611 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26615 * Unset the cursor to be shown when mouse is over the diskselector item
26617 * @param item Target item
26619 * @see elm_object_cursor_unset() for more details.
26620 * @see elm_diskselector_cursor_set()
26622 * @ingroup Diskselector
26624 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26627 * Sets a different style for this item cursor.
26629 * @note before you set a style you should define a cursor with
26630 * elm_diskselector_item_cursor_set()
26632 * @param item diskselector item with cursor already set.
26633 * @param style the theme style to use (default, transparent, ...)
26635 * @see elm_object_cursor_style_set() for more details.
26637 * @ingroup Diskselector
26639 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26643 * Get the style for this item cursor.
26645 * @param item diskselector item with cursor already set.
26646 * @return style the theme style in use, defaults to "default". If the
26647 * object does not have a cursor set, then @c NULL is returned.
26649 * @see elm_object_cursor_style_get() for more details.
26650 * @see elm_diskselector_item_cursor_style_set()
26652 * @ingroup Diskselector
26654 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26658 * Set if the cursor set should be searched on the theme or should use
26659 * the provided by the engine, only.
26661 * @note before you set if should look on theme you should define a cursor
26662 * with elm_diskselector_item_cursor_set().
26663 * By default it will only look for cursors provided by the engine.
26665 * @param item widget item with cursor already set.
26666 * @param engine_only boolean to define if cursors set with
26667 * elm_diskselector_item_cursor_set() should be searched only
26668 * between cursors provided by the engine or searched on widget's
26671 * @see elm_object_cursor_engine_only_set() for more details.
26673 * @ingroup Diskselector
26675 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26678 * Get the cursor engine only usage for this item cursor.
26680 * @param item widget item with cursor already set.
26681 * @return engine_only boolean to define it cursors should be looked only
26682 * between the provided by the engine or searched on widget's theme as well.
26683 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26685 * @see elm_object_cursor_engine_only_get() for more details.
26686 * @see elm_diskselector_item_cursor_engine_only_set()
26688 * @ingroup Diskselector
26690 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26697 * @defgroup Colorselector Colorselector
26701 * @image html img/widget/colorselector/preview-00.png
26702 * @image latex img/widget/colorselector/preview-00.eps
26704 * @brief Widget for user to select a color.
26706 * Signals that you can add callbacks for are:
26707 * "changed" - When the color value changes(event_info is NULL).
26709 * See @ref tutorial_colorselector.
26712 * @brief Add a new colorselector to the parent
26714 * @param parent The parent object
26715 * @return The new object or NULL if it cannot be created
26717 * @ingroup Colorselector
26719 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26721 * Set a color for the colorselector
26723 * @param obj Colorselector object
26724 * @param r r-value of color
26725 * @param g g-value of color
26726 * @param b b-value of color
26727 * @param a a-value of color
26729 * @ingroup Colorselector
26731 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26733 * Get a color from the colorselector
26735 * @param obj Colorselector object
26736 * @param r integer pointer for r-value of color
26737 * @param g integer pointer for g-value of color
26738 * @param b integer pointer for b-value of color
26739 * @param a integer pointer for a-value of color
26741 * @ingroup Colorselector
26743 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26749 * @defgroup Ctxpopup Ctxpopup
26751 * @image html img/widget/ctxpopup/preview-00.png
26752 * @image latex img/widget/ctxpopup/preview-00.eps
26754 * @brief Context popup widet.
26756 * A ctxpopup is a widget that, when shown, pops up a list of items.
26757 * It automatically chooses an area inside its parent object's view
26758 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26759 * optimally fit into it. In the default theme, it will also point an
26760 * arrow to it's top left position at the time one shows it. Ctxpopup
26761 * items have a label and/or an icon. It is intended for a small
26762 * number of items (hence the use of list, not genlist).
26764 * @note Ctxpopup is a especialization of @ref Hover.
26766 * Signals that you can add callbacks for are:
26767 * "dismissed" - the ctxpopup was dismissed
26769 * Default contents parts of the ctxpopup widget that you can use for are:
26770 * @li "default" - A content of the ctxpopup
26772 * Default contents parts of the naviframe items that you can use for are:
26773 * @li "icon" - A icon in the title area
26775 * Default text parts of the naviframe items that you can use for are:
26776 * @li "default" - Title label in the title area
26778 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26781 typedef enum _Elm_Ctxpopup_Direction
26783 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26785 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26786 the clicked area */
26787 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26788 the clicked area */
26789 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26791 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26792 } Elm_Ctxpopup_Direction;
26793 #define Elm_Ctxpopup_Item Elm_Object_Item
26796 * @brief Add a new Ctxpopup object to the parent.
26798 * @param parent Parent object
26799 * @return New object or @c NULL, if it cannot be created
26801 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26803 * @brief Set the Ctxpopup's parent
26805 * @param obj The ctxpopup object
26806 * @param area The parent to use
26808 * Set the parent object.
26810 * @note elm_ctxpopup_add() will automatically call this function
26811 * with its @c parent argument.
26813 * @see elm_ctxpopup_add()
26814 * @see elm_hover_parent_set()
26816 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26818 * @brief Get the Ctxpopup's parent
26820 * @param obj The ctxpopup object
26822 * @see elm_ctxpopup_hover_parent_set() for more information
26824 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26826 * @brief Clear all items in the given ctxpopup object.
26828 * @param obj Ctxpopup object
26830 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26832 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26834 * @param obj Ctxpopup object
26835 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26837 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26839 * @brief Get the value of current ctxpopup object's orientation.
26841 * @param obj Ctxpopup object
26842 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26844 * @see elm_ctxpopup_horizontal_set()
26846 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26848 * @brief Add a new item to a ctxpopup object.
26850 * @param obj Ctxpopup object
26851 * @param icon Icon to be set on new item
26852 * @param label The Label of the new item
26853 * @param func Convenience function called when item selected
26854 * @param data Data passed to @p func
26855 * @return A handle to the item added or @c NULL, on errors
26857 * @warning Ctxpopup can't hold both an item list and a content at the same
26858 * time. When an item is added, any previous content will be removed.
26860 * @see elm_ctxpopup_content_set()
26862 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);
26864 * @brief Delete the given item in a ctxpopup object.
26866 * @param it Ctxpopup item to be deleted
26868 * @see elm_ctxpopup_item_append()
26870 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26872 * @brief Set the ctxpopup item's state as disabled or enabled.
26874 * @param it Ctxpopup item to be enabled/disabled
26875 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26877 * When disabled the item is greyed out to indicate it's state.
26878 * @deprecated use elm_object_item_disabled_set() instead
26880 WILL_DEPRECATE EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26882 * @brief Get the ctxpopup item's disabled/enabled state.
26884 * @param it Ctxpopup item to be enabled/disabled
26885 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26887 * @see elm_ctxpopup_item_disabled_set()
26888 * @deprecated use elm_object_item_disabled_get() instead
26890 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26892 * @brief Get the icon object for the given ctxpopup item.
26894 * @param it Ctxpopup item
26895 * @return icon object or @c NULL, if the item does not have icon or an error
26898 * @see elm_ctxpopup_item_append()
26899 * @see elm_ctxpopup_item_icon_set()
26901 * @deprecated use elm_object_item_part_content_get() instead
26903 WILL_DEPRECATE EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26905 * @brief Sets the side icon associated with the ctxpopup item
26907 * @param it Ctxpopup item
26908 * @param icon Icon object to be set
26910 * Once the icon object is set, a previously set one will be deleted.
26911 * @warning Setting the same icon for two items will cause the icon to
26912 * dissapear from the first item.
26914 * @see elm_ctxpopup_item_append()
26916 * @deprecated use elm_object_item_part_content_set() instead
26919 WILL_DEPRECATE EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26921 * @brief Get the label for the given ctxpopup item.
26923 * @param it Ctxpopup item
26924 * @return label string or @c NULL, if the item does not have label or an
26927 * @see elm_ctxpopup_item_append()
26928 * @see elm_ctxpopup_item_label_set()
26930 * @deprecated use elm_object_item_text_get() instead
26932 WILL_DEPRECATE EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26934 * @brief (Re)set the label on the given ctxpopup item.
26936 * @param it Ctxpopup item
26937 * @param label String to set as label
26939 * @deprecated use elm_object_item_text_set() instead
26941 WILL_DEPRECATE EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26943 * @brief Set an elm widget as the content of the ctxpopup.
26945 * @param obj Ctxpopup object
26946 * @param content Content to be swallowed
26948 * If the content object is already set, a previous one will bedeleted. If
26949 * you want to keep that old content object, use the
26950 * elm_ctxpopup_content_unset() function.
26952 * @warning Ctxpopup can't hold both a item list and a content at the same
26953 * time. When a content is set, any previous items will be removed.
26955 * @deprecated use elm_object_content_set() instead
26958 WILL_DEPRECATE EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26960 * @brief Unset the ctxpopup content
26962 * @param obj Ctxpopup object
26963 * @return The content that was being used
26965 * Unparent and return the content object which was set for this widget.
26967 * @deprecated use elm_object_content_unset()
26969 * @see elm_ctxpopup_content_set()
26971 * @deprecated use elm_object_content_unset() instead
26974 WILL_DEPRECATE EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26976 * @brief Set the direction priority of a ctxpopup.
26978 * @param obj Ctxpopup object
26979 * @param first 1st priority of direction
26980 * @param second 2nd priority of direction
26981 * @param third 3th priority of direction
26982 * @param fourth 4th priority of direction
26984 * This functions gives a chance to user to set the priority of ctxpopup
26985 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26986 * requested direction.
26988 * @see Elm_Ctxpopup_Direction
26990 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);
26992 * @brief Get the direction priority of a ctxpopup.
26994 * @param obj Ctxpopup object
26995 * @param first 1st priority of direction to be returned
26996 * @param second 2nd priority of direction to be returned
26997 * @param third 3th priority of direction to be returned
26998 * @param fourth 4th priority of direction to be returned
27000 * @see elm_ctxpopup_direction_priority_set() for more information.
27002 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);
27005 * @brief Get the current direction of a ctxpopup.
27007 * @param obj Ctxpopup object
27008 * @return current direction of a ctxpopup
27010 * @warning Once the ctxpopup showed up, the direction would be determined
27012 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27021 * @defgroup Transit Transit
27022 * @ingroup Elementary
27024 * Transit is designed to apply various animated transition effects to @c
27025 * Evas_Object, such like translation, rotation, etc. For using these
27026 * effects, create an @ref Elm_Transit and add the desired transition effects.
27028 * Once the effects are added into transit, they will be automatically
27029 * managed (their callback will be called until the duration is ended, and
27030 * they will be deleted on completion).
27034 * Elm_Transit *trans = elm_transit_add();
27035 * elm_transit_object_add(trans, obj);
27036 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27037 * elm_transit_duration_set(transit, 1);
27038 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27039 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27040 * elm_transit_repeat_times_set(transit, 3);
27043 * Some transition effects are used to change the properties of objects. They
27045 * @li @ref elm_transit_effect_translation_add
27046 * @li @ref elm_transit_effect_color_add
27047 * @li @ref elm_transit_effect_rotation_add
27048 * @li @ref elm_transit_effect_wipe_add
27049 * @li @ref elm_transit_effect_zoom_add
27050 * @li @ref elm_transit_effect_resizing_add
27052 * Other transition effects are used to make one object disappear and another
27053 * object appear on its old place. These effects are:
27055 * @li @ref elm_transit_effect_flip_add
27056 * @li @ref elm_transit_effect_resizable_flip_add
27057 * @li @ref elm_transit_effect_fade_add
27058 * @li @ref elm_transit_effect_blend_add
27060 * It's also possible to make a transition chain with @ref
27061 * elm_transit_chain_transit_add.
27063 * @warning We strongly recommend to use elm_transit just when edje can not do
27064 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27065 * animations can be manipulated inside the theme.
27067 * List of examples:
27068 * @li @ref transit_example_01_explained
27069 * @li @ref transit_example_02_explained
27070 * @li @ref transit_example_03_c
27071 * @li @ref transit_example_04_c
27077 * @enum Elm_Transit_Tween_Mode
27079 * The type of acceleration used in the transition.
27083 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27084 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27085 over time, then decrease again
27087 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27089 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27091 } Elm_Transit_Tween_Mode;
27094 * @enum Elm_Transit_Effect_Flip_Axis
27096 * The axis where flip effect should be applied.
27100 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27101 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27102 } Elm_Transit_Effect_Flip_Axis;
27104 * @enum Elm_Transit_Effect_Wipe_Dir
27106 * The direction where the wipe effect should occur.
27110 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27111 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27112 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27113 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27114 } Elm_Transit_Effect_Wipe_Dir;
27115 /** @enum Elm_Transit_Effect_Wipe_Type
27117 * Whether the wipe effect should show or hide the object.
27121 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27123 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27125 } Elm_Transit_Effect_Wipe_Type;
27128 * @typedef Elm_Transit
27130 * The Transit created with elm_transit_add(). This type has the information
27131 * about the objects which the transition will be applied, and the
27132 * transition effects that will be used. It also contains info about
27133 * duration, number of repetitions, auto-reverse, etc.
27135 typedef struct _Elm_Transit Elm_Transit;
27136 typedef void Elm_Transit_Effect;
27138 * @typedef Elm_Transit_Effect_Transition_Cb
27140 * Transition callback called for this effect on each transition iteration.
27142 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27144 * Elm_Transit_Effect_End_Cb
27146 * Transition callback called for this effect when the transition is over.
27148 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27151 * Elm_Transit_Del_Cb
27153 * A callback called when the transit is deleted.
27155 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27160 * @note Is not necessary to delete the transit object, it will be deleted at
27161 * the end of its operation.
27162 * @note The transit will start playing when the program enter in the main loop, is not
27163 * necessary to give a start to the transit.
27165 * @return The transit object.
27169 EAPI Elm_Transit *elm_transit_add(void);
27172 * Stops the animation and delete the @p transit object.
27174 * Call this function if you wants to stop the animation before the duration
27175 * time. Make sure the @p transit object is still alive with
27176 * elm_transit_del_cb_set() function.
27177 * All added effects will be deleted, calling its repective data_free_cb
27178 * functions. The function setted by elm_transit_del_cb_set() will be called.
27180 * @see elm_transit_del_cb_set()
27182 * @param transit The transit object to be deleted.
27185 * @warning Just call this function if you are sure the transit is alive.
27187 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27190 * Add a new effect to the transit.
27192 * @note The cb function and the data are the key to the effect. If you try to
27193 * add an already added effect, nothing is done.
27194 * @note After the first addition of an effect in @p transit, if its
27195 * effect list become empty again, the @p transit will be killed by
27196 * elm_transit_del(transit) function.
27200 * Elm_Transit *transit = elm_transit_add();
27201 * elm_transit_effect_add(transit,
27202 * elm_transit_effect_blend_op,
27203 * elm_transit_effect_blend_context_new(),
27204 * elm_transit_effect_blend_context_free);
27207 * @param transit The transit object.
27208 * @param transition_cb The operation function. It is called when the
27209 * animation begins, it is the function that actually performs the animation.
27210 * It is called with the @p data, @p transit and the time progression of the
27211 * animation (a double value between 0.0 and 1.0).
27212 * @param effect The context data of the effect.
27213 * @param end_cb The function to free the context data, it will be called
27214 * at the end of the effect, it must finalize the animation and free the
27218 * @warning The transit free the context data at the and of the transition with
27219 * the data_free_cb function, do not use the context data in another transit.
27221 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);
27224 * Delete an added effect.
27226 * This function will remove the effect from the @p transit, calling the
27227 * data_free_cb to free the @p data.
27229 * @see elm_transit_effect_add()
27231 * @note If the effect is not found, nothing is done.
27232 * @note If the effect list become empty, this function will call
27233 * elm_transit_del(transit), that is, it will kill the @p transit.
27235 * @param transit The transit object.
27236 * @param transition_cb The operation function.
27237 * @param effect The context data of the effect.
27241 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);
27244 * Add new object to apply the effects.
27246 * @note After the first addition of an object in @p transit, if its
27247 * object list become empty again, the @p transit will be killed by
27248 * elm_transit_del(transit) function.
27249 * @note If the @p obj belongs to another transit, the @p obj will be
27250 * removed from it and it will only belong to the @p transit. If the old
27251 * transit stays without objects, it will die.
27252 * @note When you add an object into the @p transit, its state from
27253 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27254 * transit ends, if you change this state whith evas_object_pass_events_set()
27255 * after add the object, this state will change again when @p transit stops to
27258 * @param transit The transit object.
27259 * @param obj Object to be animated.
27262 * @warning It is not allowed to add a new object after transit begins to go.
27264 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27267 * Removes an added object from the transit.
27269 * @note If the @p obj is not in the @p transit, nothing is done.
27270 * @note If the list become empty, this function will call
27271 * elm_transit_del(transit), that is, it will kill the @p transit.
27273 * @param transit The transit object.
27274 * @param obj Object to be removed from @p transit.
27277 * @warning It is not allowed to remove objects after transit begins to go.
27279 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27282 * Get the objects of the transit.
27284 * @param transit The transit object.
27285 * @return a Eina_List with the objects from the transit.
27289 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27292 * Enable/disable keeping up the objects states.
27293 * If it is not kept, the objects states will be reset when transition ends.
27295 * @note @p transit can not be NULL.
27296 * @note One state includes geometry, color, map data.
27298 * @param transit The transit object.
27299 * @param state_keep Keeping or Non Keeping.
27303 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27306 * Get a value whether the objects states will be reset or not.
27308 * @note @p transit can not be NULL
27310 * @see elm_transit_objects_final_state_keep_set()
27312 * @param transit The transit object.
27313 * @return EINA_TRUE means the states of the objects will be reset.
27314 * If @p transit is NULL, EINA_FALSE is returned
27318 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27321 * Set the event enabled when transit is operating.
27323 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27324 * events from mouse and keyboard during the animation.
27325 * @note When you add an object with elm_transit_object_add(), its state from
27326 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27327 * transit ends, if you change this state with evas_object_pass_events_set()
27328 * after adding the object, this state will change again when @p transit stops
27331 * @param transit The transit object.
27332 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27333 * ignored otherwise.
27337 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27340 * Get the value of event enabled status.
27342 * @see elm_transit_event_enabled_set()
27344 * @param transit The Transit object
27345 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27346 * EINA_FALSE is returned
27350 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27353 * Set the user-callback function when the transit is deleted.
27355 * @note Using this function twice will overwrite the first function setted.
27356 * @note the @p transit object will be deleted after call @p cb function.
27358 * @param transit The transit object.
27359 * @param cb Callback function pointer. This function will be called before
27360 * the deletion of the transit.
27361 * @param data Callback funtion user data. It is the @p op parameter.
27365 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27368 * Set reverse effect automatically.
27370 * If auto reverse is setted, after running the effects with the progress
27371 * parameter from 0 to 1, it will call the effecs again with the progress
27372 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27373 * where the duration was setted with the function elm_transit_add and
27374 * the repeat with the function elm_transit_repeat_times_set().
27376 * @param transit The transit object.
27377 * @param reverse EINA_TRUE means the auto_reverse is on.
27381 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27384 * Get if the auto reverse is on.
27386 * @see elm_transit_auto_reverse_set()
27388 * @param transit The transit object.
27389 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27390 * EINA_FALSE is returned
27394 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27397 * Set the transit repeat count. Effect will be repeated by repeat count.
27399 * This function sets the number of repetition the transit will run after
27400 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27401 * If the @p repeat is a negative number, it will repeat infinite times.
27403 * @note If this function is called during the transit execution, the transit
27404 * will run @p repeat times, ignoring the times it already performed.
27406 * @param transit The transit object
27407 * @param repeat Repeat count
27411 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27414 * Get the transit repeat count.
27416 * @see elm_transit_repeat_times_set()
27418 * @param transit The Transit object.
27419 * @return The repeat count. If @p transit is NULL
27424 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27427 * Set the transit animation acceleration type.
27429 * This function sets the tween mode of the transit that can be:
27430 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27431 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27432 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27433 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27435 * @param transit The transit object.
27436 * @param tween_mode The tween type.
27440 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27443 * Get the transit animation acceleration type.
27445 * @note @p transit can not be NULL
27447 * @param transit The transit object.
27448 * @return The tween type. If @p transit is NULL
27449 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27453 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27456 * Set the transit animation time
27458 * @note @p transit can not be NULL
27460 * @param transit The transit object.
27461 * @param duration The animation time.
27465 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27468 * Get the transit animation time
27470 * @note @p transit can not be NULL
27472 * @param transit The transit object.
27474 * @return The transit animation time.
27478 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27481 * Starts the transition.
27482 * Once this API is called, the transit begins to measure the time.
27484 * @note @p transit can not be NULL
27486 * @param transit The transit object.
27490 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27493 * Pause/Resume the transition.
27495 * If you call elm_transit_go again, the transit will be started from the
27496 * beginning, and will be unpaused.
27498 * @note @p transit can not be NULL
27500 * @param transit The transit object.
27501 * @param paused Whether the transition should be paused or not.
27505 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27508 * Get the value of paused status.
27510 * @see elm_transit_paused_set()
27512 * @note @p transit can not be NULL
27514 * @param transit The transit object.
27515 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27516 * EINA_FALSE is returned
27520 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27523 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27525 * The value returned is a fraction (current time / total time). It
27526 * represents the progression position relative to the total.
27528 * @note @p transit can not be NULL
27530 * @param transit The transit object.
27532 * @return The time progression value. If @p transit is NULL
27537 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27540 * Makes the chain relationship between two transits.
27542 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27543 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27545 * @param transit The transit object.
27546 * @param chain_transit The chain transit object. This transit will be operated
27547 * after transit is done.
27549 * This function adds @p chain_transit transition to a chain after the @p
27550 * transit, and will be started as soon as @p transit ends. See @ref
27551 * transit_example_02_explained for a full example.
27555 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27558 * Cut off the chain relationship between two transits.
27560 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27561 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27563 * @param transit The transit object.
27564 * @param chain_transit The chain transit object.
27566 * This function remove the @p chain_transit transition from the @p transit.
27570 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27573 * Get the current chain transit list.
27575 * @note @p transit can not be NULL.
27577 * @param transit The transit object.
27578 * @return chain transit list.
27582 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27585 * Add the Resizing Effect to Elm_Transit.
27587 * @note This API is one of the facades. It creates resizing effect context
27588 * and add it's required APIs to elm_transit_effect_add.
27590 * @see elm_transit_effect_add()
27592 * @param transit Transit object.
27593 * @param from_w Object width size when effect begins.
27594 * @param from_h Object height size when effect begins.
27595 * @param to_w Object width size when effect ends.
27596 * @param to_h Object height size when effect ends.
27597 * @return Resizing effect context data.
27601 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);
27604 * Add the Translation Effect to Elm_Transit.
27606 * @note This API is one of the facades. It creates translation effect context
27607 * and add it's required APIs to elm_transit_effect_add.
27609 * @see elm_transit_effect_add()
27611 * @param transit Transit object.
27612 * @param from_dx X Position variation when effect begins.
27613 * @param from_dy Y Position variation when effect begins.
27614 * @param to_dx X Position variation when effect ends.
27615 * @param to_dy Y Position variation when effect ends.
27616 * @return Translation effect context data.
27619 * @warning It is highly recommended just create a transit with this effect when
27620 * the window that the objects of the transit belongs has already been created.
27621 * This is because this effect needs the geometry information about the objects,
27622 * and if the window was not created yet, it can get a wrong information.
27624 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);
27627 * Add the Zoom Effect to Elm_Transit.
27629 * @note This API is one of the facades. It creates zoom effect context
27630 * and add it's required APIs to elm_transit_effect_add.
27632 * @see elm_transit_effect_add()
27634 * @param transit Transit object.
27635 * @param from_rate Scale rate when effect begins (1 is current rate).
27636 * @param to_rate Scale rate when effect ends.
27637 * @return Zoom effect context data.
27640 * @warning It is highly recommended just create a transit with this effect when
27641 * the window that the objects of the transit belongs has already been created.
27642 * This is because this effect needs the geometry information about the objects,
27643 * and if the window was not created yet, it can get a wrong information.
27645 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27648 * Add the Flip Effect to Elm_Transit.
27650 * @note This API is one of the facades. It creates flip effect context
27651 * and add it's required APIs to elm_transit_effect_add.
27652 * @note This effect is applied to each pair of objects in the order they are listed
27653 * in the transit list of objects. The first object in the pair will be the
27654 * "front" object and the second will be the "back" object.
27656 * @see elm_transit_effect_add()
27658 * @param transit Transit object.
27659 * @param axis Flipping Axis(X or Y).
27660 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27661 * @return Flip effect context data.
27664 * @warning It is highly recommended just create a transit with this effect when
27665 * the window that the objects of the transit belongs has already been created.
27666 * This is because this effect needs the geometry information about the objects,
27667 * and if the window was not created yet, it can get a wrong information.
27669 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27672 * Add the Resizable Flip Effect to Elm_Transit.
27674 * @note This API is one of the facades. It creates resizable flip effect context
27675 * and add it's required APIs to elm_transit_effect_add.
27676 * @note This effect is applied to each pair of objects in the order they are listed
27677 * in the transit list of objects. The first object in the pair will be the
27678 * "front" object and the second will be the "back" object.
27680 * @see elm_transit_effect_add()
27682 * @param transit Transit object.
27683 * @param axis Flipping Axis(X or Y).
27684 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27685 * @return Resizable flip effect context data.
27688 * @warning It is highly recommended just create a transit with this effect when
27689 * the window that the objects of the transit belongs has already been created.
27690 * This is because this effect needs the geometry information about the objects,
27691 * and if the window was not created yet, it can get a wrong information.
27693 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27696 * Add the Wipe Effect to Elm_Transit.
27698 * @note This API is one of the facades. It creates wipe effect context
27699 * and add it's required APIs to elm_transit_effect_add.
27701 * @see elm_transit_effect_add()
27703 * @param transit Transit object.
27704 * @param type Wipe type. Hide or show.
27705 * @param dir Wipe Direction.
27706 * @return Wipe effect context data.
27709 * @warning It is highly recommended just create a transit with this effect when
27710 * the window that the objects of the transit belongs has already been created.
27711 * This is because this effect needs the geometry information about the objects,
27712 * and if the window was not created yet, it can get a wrong information.
27714 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27717 * Add the Color Effect to Elm_Transit.
27719 * @note This API is one of the facades. It creates color effect context
27720 * and add it's required APIs to elm_transit_effect_add.
27722 * @see elm_transit_effect_add()
27724 * @param transit Transit object.
27725 * @param from_r RGB R when effect begins.
27726 * @param from_g RGB G when effect begins.
27727 * @param from_b RGB B when effect begins.
27728 * @param from_a RGB A when effect begins.
27729 * @param to_r RGB R when effect ends.
27730 * @param to_g RGB G when effect ends.
27731 * @param to_b RGB B when effect ends.
27732 * @param to_a RGB A when effect ends.
27733 * @return Color effect context data.
27737 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);
27740 * Add the Fade Effect to Elm_Transit.
27742 * @note This API is one of the facades. It creates fade effect context
27743 * and add it's required APIs to elm_transit_effect_add.
27744 * @note This effect is applied to each pair of objects in the order they are listed
27745 * in the transit list of objects. The first object in the pair will be the
27746 * "before" object and the second will be the "after" object.
27748 * @see elm_transit_effect_add()
27750 * @param transit Transit object.
27751 * @return Fade effect context data.
27754 * @warning It is highly recommended just create a transit with this effect when
27755 * the window that the objects of the transit belongs has already been created.
27756 * This is because this effect needs the color information about the objects,
27757 * and if the window was not created yet, it can get a wrong information.
27759 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27762 * Add the Blend Effect to Elm_Transit.
27764 * @note This API is one of the facades. It creates blend effect context
27765 * and add it's required APIs to elm_transit_effect_add.
27766 * @note This effect is applied to each pair of objects in the order they are listed
27767 * in the transit list of objects. The first object in the pair will be the
27768 * "before" object and the second will be the "after" object.
27770 * @see elm_transit_effect_add()
27772 * @param transit Transit object.
27773 * @return Blend effect context data.
27776 * @warning It is highly recommended just create a transit with this effect when
27777 * the window that the objects of the transit belongs has already been created.
27778 * This is because this effect needs the color information about the objects,
27779 * and if the window was not created yet, it can get a wrong information.
27781 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27784 * Add the Rotation Effect to Elm_Transit.
27786 * @note This API is one of the facades. It creates rotation effect context
27787 * and add it's required APIs to elm_transit_effect_add.
27789 * @see elm_transit_effect_add()
27791 * @param transit Transit object.
27792 * @param from_degree Degree when effect begins.
27793 * @param to_degree Degree when effect is ends.
27794 * @return Rotation effect context data.
27797 * @warning It is highly recommended just create a transit with this effect when
27798 * the window that the objects of the transit belongs has already been created.
27799 * This is because this effect needs the geometry information about the objects,
27800 * and if the window was not created yet, it can get a wrong information.
27802 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27805 * Add the ImageAnimation Effect to Elm_Transit.
27807 * @note This API is one of the facades. It creates image animation effect context
27808 * and add it's required APIs to elm_transit_effect_add.
27809 * The @p images parameter is a list images paths. This list and
27810 * its contents will be deleted at the end of the effect by
27811 * elm_transit_effect_image_animation_context_free() function.
27815 * char buf[PATH_MAX];
27816 * Eina_List *images = NULL;
27817 * Elm_Transit *transi = elm_transit_add();
27819 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27820 * images = eina_list_append(images, eina_stringshare_add(buf));
27822 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27823 * images = eina_list_append(images, eina_stringshare_add(buf));
27824 * elm_transit_effect_image_animation_add(transi, images);
27828 * @see elm_transit_effect_add()
27830 * @param transit Transit object.
27831 * @param images Eina_List of images file paths. This list and
27832 * its contents will be deleted at the end of the effect by
27833 * elm_transit_effect_image_animation_context_free() function.
27834 * @return Image Animation effect context data.
27838 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27844 typedef struct _Elm_Store Elm_Store;
27845 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27846 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27847 typedef struct _Elm_Store_Item Elm_Store_Item;
27848 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27849 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27850 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27851 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27852 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27853 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27854 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27855 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27856 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27858 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27859 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27860 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27861 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27862 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27863 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27864 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27868 ELM_STORE_ITEM_MAPPING_NONE = 0,
27869 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27870 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27871 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27872 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27873 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27874 // can add more here as needed by common apps
27875 ELM_STORE_ITEM_MAPPING_LAST
27876 } Elm_Store_Item_Mapping_Type;
27878 struct _Elm_Store_Item_Mapping_Icon
27880 // FIXME: allow edje file icons
27882 Elm_Icon_Lookup_Order lookup_order;
27883 Eina_Bool standard_name : 1;
27884 Eina_Bool no_scale : 1;
27885 Eina_Bool smooth : 1;
27886 Eina_Bool scale_up : 1;
27887 Eina_Bool scale_down : 1;
27890 struct _Elm_Store_Item_Mapping_Empty
27895 struct _Elm_Store_Item_Mapping_Photo
27900 struct _Elm_Store_Item_Mapping_Custom
27902 Elm_Store_Item_Mapping_Cb func;
27905 struct _Elm_Store_Item_Mapping
27907 Elm_Store_Item_Mapping_Type type;
27912 Elm_Store_Item_Mapping_Empty empty;
27913 Elm_Store_Item_Mapping_Icon icon;
27914 Elm_Store_Item_Mapping_Photo photo;
27915 Elm_Store_Item_Mapping_Custom custom;
27916 // add more types here
27920 struct _Elm_Store_Item_Info
27925 Eina_Bool rec_item;
27926 int pre_group_index;
27928 Elm_Genlist_Item_Class *item_class;
27929 const Elm_Store_Item_Mapping *mapping;
27934 struct _Elm_Store_Item_Info_Filesystem
27936 Elm_Store_Item_Info base;
27940 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27941 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27943 EAPI Elm_Store *elm_store_dbsystem_new(void);
27944 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27945 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27946 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27947 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27948 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27949 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27950 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27951 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27952 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27953 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27954 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27955 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27956 EAPI void elm_store_free(Elm_Store *st);
27957 EAPI Elm_Store *elm_store_filesystem_new(void);
27958 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27959 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27960 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27962 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27964 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27965 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27966 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27967 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27968 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27969 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27971 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27972 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27973 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27974 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27975 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27976 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27977 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27980 * @defgroup SegmentControl SegmentControl
27981 * @ingroup Elementary
27983 * @image html img/widget/segment_control/preview-00.png
27984 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27986 * @image html img/segment_control.png
27987 * @image latex img/segment_control.eps width=\textwidth
27989 * Segment control widget is a horizontal control made of multiple segment
27990 * items, each segment item functioning similar to discrete two state button.
27991 * A segment control groups the items together and provides compact
27992 * single button with multiple equal size segments.
27994 * Segment item size is determined by base widget
27995 * size and the number of items added.
27996 * Only one segment item can be at selected state. A segment item can display
27997 * combination of Text and any Evas_Object like Images or other widget.
27999 * Smart callbacks one can listen to:
28000 * - "changed" - When the user clicks on a segment item which is not
28001 * previously selected and get selected. The event_info parameter is the
28002 * segment item pointer.
28004 * Available styles for it:
28007 * Here is an example on its usage:
28008 * @li @ref segment_control_example
28012 * @addtogroup SegmentControl
28016 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28019 * Add a new segment control widget to the given parent Elementary
28020 * (container) object.
28022 * @param parent The parent object.
28023 * @return a new segment control widget handle or @c NULL, on errors.
28025 * This function inserts a new segment control widget on the canvas.
28027 * @ingroup SegmentControl
28029 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28032 * Append a new item to the segment control object.
28034 * @param obj The segment control object.
28035 * @param icon The icon object to use for the left side of the item. An
28036 * icon can be any Evas object, but usually it is an icon created
28037 * with elm_icon_add().
28038 * @param label The label of the item.
28039 * Note that, NULL is different from empty string "".
28040 * @return The created item or @c NULL upon failure.
28042 * A new item will be created and appended to the segment control, i.e., will
28043 * be set as @b last item.
28045 * If it should be inserted at another position,
28046 * elm_segment_control_item_insert_at() should be used instead.
28048 * Items created with this function can be deleted with function
28049 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28051 * @note @p label set to @c NULL is different from empty string "".
28053 * only has icon, it will be displayed bigger and centered. If it has
28054 * icon and label, even that an empty string, icon will be smaller and
28055 * positioned at left.
28059 * sc = elm_segment_control_add(win);
28060 * ic = elm_icon_add(win);
28061 * elm_icon_file_set(ic, "path/to/image", NULL);
28062 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28063 * elm_segment_control_item_add(sc, ic, "label");
28064 * evas_object_show(sc);
28067 * @see elm_segment_control_item_insert_at()
28068 * @see elm_segment_control_item_del()
28070 * @ingroup SegmentControl
28072 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28075 * Insert a new item to the segment control object at specified position.
28077 * @param obj The segment control object.
28078 * @param icon The icon object to use for the left side of the item. An
28079 * icon can be any Evas object, but usually it is an icon created
28080 * with elm_icon_add().
28081 * @param label The label of the item.
28082 * @param index Item position. Value should be between 0 and items count.
28083 * @return The created item or @c NULL upon failure.
28085 * Index values must be between @c 0, when item will be prepended to
28086 * segment control, and items count, that can be get with
28087 * elm_segment_control_item_count_get(), case when item will be appended
28088 * to segment control, just like elm_segment_control_item_add().
28090 * Items created with this function can be deleted with function
28091 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28093 * @note @p label set to @c NULL is different from empty string "".
28095 * only has icon, it will be displayed bigger and centered. If it has
28096 * icon and label, even that an empty string, icon will be smaller and
28097 * positioned at left.
28099 * @see elm_segment_control_item_add()
28100 * @see elm_segment_control_item_count_get()
28101 * @see elm_segment_control_item_del()
28103 * @ingroup SegmentControl
28105 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);
28108 * Remove a segment control item from its parent, deleting it.
28110 * @param it The item to be removed.
28112 * Items can be added with elm_segment_control_item_add() or
28113 * elm_segment_control_item_insert_at().
28115 * @ingroup SegmentControl
28117 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28120 * Remove a segment control item at given index from its parent,
28123 * @param obj The segment control object.
28124 * @param index The position of the segment control item to be deleted.
28126 * Items can be added with elm_segment_control_item_add() or
28127 * elm_segment_control_item_insert_at().
28129 * @ingroup SegmentControl
28131 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28134 * Get the Segment items count from segment control.
28136 * @param obj The segment control object.
28137 * @return Segment items count.
28139 * It will just return the number of items added to segment control @p obj.
28141 * @ingroup SegmentControl
28143 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28146 * Get the item placed at specified index.
28148 * @param obj The segment control object.
28149 * @param index The index of the segment item.
28150 * @return The segment control item or @c NULL on failure.
28152 * Index is the position of an item in segment control widget. Its
28153 * range is from @c 0 to <tt> count - 1 </tt>.
28154 * Count is the number of items, that can be get with
28155 * elm_segment_control_item_count_get().
28157 * @ingroup SegmentControl
28159 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28162 * Get the label of item.
28164 * @param obj The segment control object.
28165 * @param index The index of the segment item.
28166 * @return The label of the item at @p index.
28168 * The return value is a pointer to the label associated to the item when
28169 * it was created, with function elm_segment_control_item_add(), or later
28170 * with function elm_segment_control_item_label_set. If no label
28171 * was passed as argument, it will return @c NULL.
28173 * @see elm_segment_control_item_label_set() for more details.
28174 * @see elm_segment_control_item_add()
28176 * @ingroup SegmentControl
28178 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28181 * Set the label of item.
28183 * @param it The item of segment control.
28184 * @param text The label of item.
28186 * The label to be displayed by the item.
28187 * Label will be at right of the icon (if set).
28189 * If a label was passed as argument on item creation, with function
28190 * elm_control_segment_item_add(), it will be already
28191 * displayed by the item.
28193 * @see elm_segment_control_item_label_get()
28194 * @see elm_segment_control_item_add()
28196 * @ingroup SegmentControl
28198 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28201 * Get the icon associated to the item.
28203 * @param obj The segment control object.
28204 * @param index The index of the segment item.
28205 * @return The left side icon associated to the item at @p index.
28207 * The return value is a pointer to the icon associated to the item when
28208 * it was created, with function elm_segment_control_item_add(), or later
28209 * with function elm_segment_control_item_icon_set(). If no icon
28210 * was passed as argument, it will return @c NULL.
28212 * @see elm_segment_control_item_add()
28213 * @see elm_segment_control_item_icon_set()
28215 * @ingroup SegmentControl
28217 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28220 * Set the icon associated to the item.
28222 * @param it The segment control item.
28223 * @param icon The icon object to associate with @p it.
28225 * The icon object to use at left side of the item. An
28226 * icon can be any Evas object, but usually it is an icon created
28227 * with elm_icon_add().
28229 * Once the icon object is set, a previously set one will be deleted.
28230 * @warning Setting the same icon for two items will cause the icon to
28231 * dissapear from the first item.
28233 * If an icon was passed as argument on item creation, with function
28234 * elm_segment_control_item_add(), it will be already
28235 * associated to the item.
28237 * @see elm_segment_control_item_add()
28238 * @see elm_segment_control_item_icon_get()
28240 * @ingroup SegmentControl
28242 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28245 * Get the index of an item.
28247 * @param it The segment control item.
28248 * @return The position of item in segment control widget.
28250 * Index is the position of an item in segment control widget. Its
28251 * range is from @c 0 to <tt> count - 1 </tt>.
28252 * Count is the number of items, that can be get with
28253 * elm_segment_control_item_count_get().
28255 * @ingroup SegmentControl
28257 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28260 * Get the base object of the item.
28262 * @param it The segment control item.
28263 * @return The base object associated with @p it.
28265 * Base object is the @c Evas_Object that represents that item.
28267 * @ingroup SegmentControl
28269 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28272 * Get the selected item.
28274 * @param obj The segment control object.
28275 * @return The selected item or @c NULL if none of segment items is
28278 * The selected item can be unselected with function
28279 * elm_segment_control_item_selected_set().
28281 * The selected item always will be highlighted on segment control.
28283 * @ingroup SegmentControl
28285 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28288 * Set the selected state of an item.
28290 * @param it The segment control item
28291 * @param select The selected state
28293 * This sets the selected state of the given item @p it.
28294 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28296 * If a new item is selected the previosly selected will be unselected.
28297 * Previoulsy selected item can be get with function
28298 * elm_segment_control_item_selected_get().
28300 * The selected item always will be highlighted on segment control.
28302 * @see elm_segment_control_item_selected_get()
28304 * @ingroup SegmentControl
28306 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28313 * @defgroup Grid Grid
28315 * The grid is a grid layout widget that lays out a series of children as a
28316 * fixed "grid" of widgets using a given percentage of the grid width and
28317 * height each using the child object.
28319 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28320 * widgets size itself. The default is 100 x 100, so that means the
28321 * position and sizes of children will effectively be percentages (0 to 100)
28322 * of the width or height of the grid widget
28328 * Add a new grid to the parent
28330 * @param parent The parent object
28331 * @return The new object or NULL if it cannot be created
28335 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28338 * Set the virtual size of the grid
28340 * @param obj The grid object
28341 * @param w The virtual width of the grid
28342 * @param h The virtual height of the grid
28346 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28349 * Get the virtual size of the grid
28351 * @param obj The grid object
28352 * @param w Pointer to integer to store the virtual width of the grid
28353 * @param h Pointer to integer to store the virtual height of the grid
28357 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28360 * Pack child at given position and size
28362 * @param obj The grid object
28363 * @param subobj The child to pack
28364 * @param x The virtual x coord at which to pack it
28365 * @param y The virtual y coord at which to pack it
28366 * @param w The virtual width at which to pack it
28367 * @param h The virtual height at which to pack it
28371 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28374 * Unpack a child from a grid object
28376 * @param obj The grid object
28377 * @param subobj The child to unpack
28381 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28384 * Faster way to remove all child objects from a grid object.
28386 * @param obj The grid object
28387 * @param clear If true, it will delete just removed children
28391 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28394 * Set packing of an existing child at to position and size
28396 * @param subobj The child to set packing of
28397 * @param x The virtual x coord at which to pack it
28398 * @param y The virtual y coord at which to pack it
28399 * @param w The virtual width at which to pack it
28400 * @param h The virtual height at which to pack it
28404 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28407 * get packing of a child
28409 * @param subobj The child to query
28410 * @param x Pointer to integer to store the virtual x coord
28411 * @param y Pointer to integer to store the virtual y coord
28412 * @param w Pointer to integer to store the virtual width
28413 * @param h Pointer to integer to store the virtual height
28417 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28423 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28424 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28425 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28426 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28427 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28428 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28431 * @defgroup Video Video
28433 * @addtogroup Video
28436 * Elementary comes with two object that help design application that need
28437 * to display video. The main one, Elm_Video, display a video by using Emotion.
28438 * It does embedded the video inside an Edje object, so you can do some
28439 * animation depending on the video state change. It does also implement a
28440 * ressource management policy to remove this burden from the application writer.
28442 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28443 * It take care of updating its content according to Emotion event and provide a
28444 * way to theme itself. It also does automatically raise the priority of the
28445 * linked Elm_Video so it will use the video decoder if available. It also does
28446 * activate the remember function on the linked Elm_Video object.
28448 * Signals that you can add callback for are :
28450 * "forward,clicked" - the user clicked the forward button.
28451 * "info,clicked" - the user clicked the info button.
28452 * "next,clicked" - the user clicked the next button.
28453 * "pause,clicked" - the user clicked the pause button.
28454 * "play,clicked" - the user clicked the play button.
28455 * "prev,clicked" - the user clicked the prev button.
28456 * "rewind,clicked" - the user clicked the rewind button.
28457 * "stop,clicked" - the user clicked the stop button.
28459 * Default contents parts of the player widget that you can use for are:
28460 * @li "video" - A video of the player
28465 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28467 * @param parent The parent object
28468 * @return a new player widget handle or @c NULL, on errors.
28470 * This function inserts a new player widget on the canvas.
28472 * @see elm_object_part_content_set()
28476 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28479 * @brief Link a Elm_Payer with an Elm_Video object.
28481 * @param player the Elm_Player object.
28482 * @param video The Elm_Video object.
28484 * This mean that action on the player widget will affect the
28485 * video object and the state of the video will be reflected in
28486 * the player itself.
28488 * @see elm_player_add()
28489 * @see elm_video_add()
28490 * @deprecated use elm_object_part_content_set() instead
28494 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28497 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28499 * @param parent The parent object
28500 * @return a new video widget handle or @c NULL, on errors.
28502 * This function inserts a new video widget on the canvas.
28504 * @seeelm_video_file_set()
28505 * @see elm_video_uri_set()
28509 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28512 * @brief Define the file that will be the video source.
28514 * @param video The video object to define the file for.
28515 * @param filename The file to target.
28517 * This function will explicitly define a filename as a source
28518 * for the video of the Elm_Video object.
28520 * @see elm_video_uri_set()
28521 * @see elm_video_add()
28522 * @see elm_player_add()
28526 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28529 * @brief Define the uri that will be the video source.
28531 * @param video The video object to define the file for.
28532 * @param uri The uri to target.
28534 * This function will define an uri as a source for the video of the
28535 * Elm_Video object. URI could be remote source of video, like http:// or local source
28536 * like for example WebCam who are most of the time v4l2:// (but that depend and
28537 * you should use Emotion API to request and list the available Webcam on your system).
28539 * @see elm_video_file_set()
28540 * @see elm_video_add()
28541 * @see elm_player_add()
28545 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28548 * @brief Get the underlying Emotion object.
28550 * @param video The video object to proceed the request on.
28551 * @return the underlying Emotion object.
28555 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28558 * @brief Start to play the video
28560 * @param video The video object to proceed the request on.
28562 * Start to play the video and cancel all suspend state.
28566 EAPI void elm_video_play(Evas_Object *video);
28569 * @brief Pause the video
28571 * @param video The video object to proceed the request on.
28573 * Pause the video and start a timer to trigger suspend mode.
28577 EAPI void elm_video_pause(Evas_Object *video);
28580 * @brief Stop the video
28582 * @param video The video object to proceed the request on.
28584 * Stop the video and put the emotion in deep sleep mode.
28588 EAPI void elm_video_stop(Evas_Object *video);
28591 * @brief Is the video actually playing.
28593 * @param video The video object to proceed the request on.
28594 * @return EINA_TRUE if the video is actually playing.
28596 * You should consider watching event on the object instead of polling
28597 * the object state.
28601 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28604 * @brief Is it possible to seek inside the video.
28606 * @param video The video object to proceed the request on.
28607 * @return EINA_TRUE if is possible to seek inside the video.
28611 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28614 * @brief Is the audio muted.
28616 * @param video The video object to proceed the request on.
28617 * @return EINA_TRUE if the audio is muted.
28621 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28624 * @brief Change the mute state of the Elm_Video object.
28626 * @param video The video object to proceed the request on.
28627 * @param mute The new mute state.
28631 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28634 * @brief Get the audio level of the current video.
28636 * @param video The video object to proceed the request on.
28637 * @return the current audio level.
28641 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28644 * @brief Set the audio level of anElm_Video object.
28646 * @param video The video object to proceed the request on.
28647 * @param volume The new audio volume.
28651 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28653 EAPI double elm_video_play_position_get(const Evas_Object *video);
28654 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28655 EAPI double elm_video_play_length_get(const Evas_Object *video);
28656 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28657 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28658 EAPI const char *elm_video_title_get(const Evas_Object *video);
28663 // FIXME: incomplete - carousel. don't use this until this comment is removed
28664 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28665 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28666 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28667 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28668 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28669 /* smart callbacks called:
28670 * "clicked" - when the user clicks on a carousel item and becomes selected
28675 typedef enum _Elm_Datefield_ItemType
28677 ELM_DATEFIELD_YEAR = 0,
28678 ELM_DATEFIELD_MONTH,
28679 ELM_DATEFIELD_DATE,
28680 ELM_DATEFIELD_HOUR,
28681 ELM_DATEFIELD_MINUTE,
28683 } Elm_Datefield_ItemType;
28685 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28686 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28687 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28688 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28689 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28690 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28691 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28692 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28693 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28694 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28695 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28696 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28697 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28699 /* smart callbacks called:
28700 * "changed" - when datefield value is changed, this signal is sent.
28703 ////////////////////// DEPRECATED ///////////////////////////////////
28705 typedef enum _Elm_Datefield_Layout
28707 ELM_DATEFIELD_LAYOUT_TIME,
28708 ELM_DATEFIELD_LAYOUT_DATE,
28709 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28710 } Elm_Datefield_Layout;
28712 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28713 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28714 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28715 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28716 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28717 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28718 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28719 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28720 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28721 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28722 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28723 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28724 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
28725 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28726 /////////////////////////////////////////////////////////////////////
28729 typedef enum _Elm_Popup_Response
28731 ELM_POPUP_RESPONSE_NONE = -1,
28732 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28733 ELM_POPUP_RESPONSE_OK = -3,
28734 ELM_POPUP_RESPONSE_CANCEL = -4,
28735 ELM_POPUP_RESPONSE_CLOSE = -5
28736 } Elm_Popup_Response;
28738 typedef enum _Elm_Popup_Mode
28740 ELM_POPUP_TYPE_NONE = 0,
28741 ELM_POPUP_TYPE_ALERT = (1 << 0)
28744 typedef enum _Elm_Popup_Orient
28746 ELM_POPUP_ORIENT_TOP,
28747 ELM_POPUP_ORIENT_CENTER,
28748 ELM_POPUP_ORIENT_BOTTOM,
28749 ELM_POPUP_ORIENT_LEFT,
28750 ELM_POPUP_ORIENT_RIGHT,
28751 ELM_POPUP_ORIENT_TOP_LEFT,
28752 ELM_POPUP_ORIENT_TOP_RIGHT,
28753 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28754 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28755 } Elm_Popup_Orient;
28757 /* smart callbacks called:
28758 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28761 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28762 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28763 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28764 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28765 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28766 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28767 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28768 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28769 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28770 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28771 EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
28772 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28773 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28774 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28775 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28776 EAPI int elm_popup_run(Evas_Object *obj);
28778 /* NavigationBar */
28779 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28780 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28784 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28785 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28786 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28787 ELM_NAVIGATIONBAR_BACK_BUTTON
28788 } Elm_Navi_Button_Type;
28790 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28791 EINA_DEPRECATED EAPI void elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
28792 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28793 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28794 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28795 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28796 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28797 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28798 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28799 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28800 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28801 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28802 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28803 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28804 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28805 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28806 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28807 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28808 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28809 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28810 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28811 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28813 /* NavigationBar */
28814 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28815 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28819 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28820 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28821 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28822 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28823 ELM_NAVIGATIONBAR_EX_MAX
28824 } Elm_Navi_ex_Button_Type;
28825 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28827 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28828 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28829 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28830 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28831 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28832 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28833 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28834 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28835 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28836 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
28837 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28838 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28839 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28840 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28841 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28842 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28843 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28844 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28845 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28846 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28847 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28848 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28849 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28850 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28851 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28852 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28853 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28854 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28857 * @defgroup Naviframe Naviframe
28858 * @ingroup Elementary
28860 * @brief Naviframe is a kind of view manager for the applications.
28862 * Naviframe provides functions to switch different pages with stack
28863 * mechanism. It means if one page(item) needs to be changed to the new one,
28864 * then naviframe would push the new page to it's internal stack. Of course,
28865 * it can be back to the previous page by popping the top page. Naviframe
28866 * provides some transition effect while the pages are switching (same as
28869 * Since each item could keep the different styles, users could keep the
28870 * same look & feel for the pages or different styles for the items in it's
28873 * Signals that you can add callback for are:
28874 * @li "transition,finished" - When the transition is finished in changing
28876 * @li "title,clicked" - User clicked title area
28878 * Default contents parts of the naviframe items that you can use for are:
28879 * @li "default" - A main content of the page
28880 * @li "icon" - A icon in the title area
28881 * @li "prev_btn" - A button to go to the previous page
28882 * @li "next_btn" - A button to go to the next page
28884 * Default text parts of the naviframe items that you can use for are:
28885 * @li "default" - Title label in the title area
28886 * @li "subtitle" - Sub-title label in the title area
28888 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28891 //Available commonly
28892 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28893 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28894 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28895 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28896 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28897 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28898 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28899 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28900 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28901 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28902 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28903 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28904 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28905 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28906 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28907 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28908 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28910 //Available only in a style - "2line"
28911 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28913 //Available only in a style - "segment"
28914 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28915 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28918 * @addtogroup Naviframe
28923 * @brief Add a new Naviframe object to the parent.
28925 * @param parent Parent object
28926 * @return New object or @c NULL, if it cannot be created
28928 * @ingroup Naviframe
28930 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28932 * @brief Push a new item to the top of the naviframe stack (and show it).
28934 * @param obj The naviframe object
28935 * @param title_label The label in the title area. The name of the title
28936 * label part is "elm.text.title"
28937 * @param prev_btn The button to go to the previous item. If it is NULL,
28938 * then naviframe will create a back button automatically. The name of
28939 * the prev_btn part is "elm.swallow.prev_btn"
28940 * @param next_btn The button to go to the next item. Or It could be just an
28941 * extra function button. The name of the next_btn part is
28942 * "elm.swallow.next_btn"
28943 * @param content The main content object. The name of content part is
28944 * "elm.swallow.content"
28945 * @param item_style The current item style name. @c NULL would be default.
28946 * @return The created item or @c NULL upon failure.
28948 * The item pushed becomes one page of the naviframe, this item will be
28949 * deleted when it is popped.
28951 * @see also elm_naviframe_item_style_set()
28952 * @see also elm_naviframe_item_insert_before()
28953 * @see also elm_naviframe_item_insert_after()
28955 * The following styles are available for this item:
28958 * @ingroup Naviframe
28960 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);
28962 * @brief Insert a new item into the naviframe before item @p before.
28964 * @param before The naviframe item to insert before.
28965 * @param title_label The label in the title area. The name of the title
28966 * label part is "elm.text.title"
28967 * @param prev_btn The button to go to the previous item. If it is NULL,
28968 * then naviframe will create a back button automatically. The name of
28969 * the prev_btn part is "elm.swallow.prev_btn"
28970 * @param next_btn The button to go to the next item. Or It could be just an
28971 * extra function button. The name of the next_btn part is
28972 * "elm.swallow.next_btn"
28973 * @param content The main content object. The name of content part is
28974 * "elm.swallow.content"
28975 * @param item_style The current item style name. @c NULL would be default.
28976 * @return The created item or @c NULL upon failure.
28978 * The item is inserted into the naviframe straight away without any
28979 * transition operations. This item will be deleted when it is popped.
28981 * @see also elm_naviframe_item_style_set()
28982 * @see also elm_naviframe_item_push()
28983 * @see also elm_naviframe_item_insert_after()
28985 * The following styles are available for this item:
28988 * @ingroup Naviframe
28990 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);
28992 * @brief Insert a new item into the naviframe after item @p after.
28994 * @param after The naviframe item to insert after.
28995 * @param title_label The label in the title area. The name of the title
28996 * label part is "elm.text.title"
28997 * @param prev_btn The button to go to the previous item. If it is NULL,
28998 * then naviframe will create a back button automatically. The name of
28999 * the prev_btn part is "elm.swallow.prev_btn"
29000 * @param next_btn The button to go to the next item. Or It could be just an
29001 * extra function button. The name of the next_btn part is
29002 * "elm.swallow.next_btn"
29003 * @param content The main content object. The name of content part is
29004 * "elm.swallow.content"
29005 * @param item_style The current item style name. @c NULL would be default.
29006 * @return The created item or @c NULL upon failure.
29008 * The item is inserted into the naviframe straight away without any
29009 * transition operations. This item will be deleted when it is popped.
29011 * @see also elm_naviframe_item_style_set()
29012 * @see also elm_naviframe_item_push()
29013 * @see also elm_naviframe_item_insert_before()
29015 * The following styles are available for this item:
29018 * @ingroup Naviframe
29020 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);
29022 * @brief Pop an item that is on top of the stack
29024 * @param obj The naviframe object
29025 * @return @c NULL or the content object(if the
29026 * elm_naviframe_content_preserve_on_pop_get is true).
29028 * This pops an item that is on the top(visible) of the naviframe, makes it
29029 * disappear, then deletes the item. The item that was underneath it on the
29030 * stack will become visible.
29032 * @see also elm_naviframe_content_preserve_on_pop_get()
29034 * @ingroup Naviframe
29036 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29038 * @brief Pop the items between the top and the above one on the given item.
29040 * @param it The naviframe item
29042 * @ingroup Naviframe
29044 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29046 * Promote an item already in the naviframe stack to the top of the stack
29048 * @param it The naviframe item
29050 * This will take the indicated item and promote it to the top of the stack
29051 * as if it had been pushed there. The item must already be inside the
29052 * naviframe stack to work.
29055 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29057 * @brief Delete the given item instantly.
29059 * @param it The naviframe item
29061 * This just deletes the given item from the naviframe item list instantly.
29062 * So this would not emit any signals for view transitions but just change
29063 * the current view if the given item is a top one.
29065 * @ingroup Naviframe
29067 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29069 * @brief preserve the content objects when items are popped.
29071 * @param obj The naviframe object
29072 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29074 * @see also elm_naviframe_content_preserve_on_pop_get()
29076 * @ingroup Naviframe
29078 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29080 * @brief Get a value whether preserve mode is enabled or not.
29082 * @param obj The naviframe object
29083 * @return If @c EINA_TRUE, preserve mode is enabled
29085 * @see also elm_naviframe_content_preserve_on_pop_set()
29087 * @ingroup Naviframe
29089 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29091 * @brief Get a top item on the naviframe stack
29093 * @param obj The naviframe object
29094 * @return The top item on the naviframe stack or @c NULL, if the stack is
29097 * @ingroup Naviframe
29099 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29101 * @brief Get a bottom item on the naviframe stack
29103 * @param obj The naviframe object
29104 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29107 * @ingroup Naviframe
29109 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29111 * @brief Set an item style
29113 * @param obj The naviframe item
29114 * @param item_style The current item style name. @c NULL would be default
29116 * The following styles are available for this item:
29119 * @see also elm_naviframe_item_style_get()
29121 * @ingroup Naviframe
29123 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29125 * @brief Get an item style
29127 * @param obj The naviframe item
29128 * @return The current item style name
29130 * @see also elm_naviframe_item_style_set()
29132 * @ingroup Naviframe
29134 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29136 * @brief Show/Hide the title area
29138 * @param it The naviframe item
29139 * @param visible If @c EINA_TRUE, title area will be visible, hidden
29142 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
29144 * @see also elm_naviframe_item_title_visible_get()
29146 * @ingroup Naviframe
29148 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29150 * @brief Get a value whether title area is visible or not.
29152 * @param it The naviframe item
29153 * @return If @c EINA_TRUE, title area is visible
29155 * @see also elm_naviframe_item_title_visible_set()
29157 * @ingroup Naviframe
29159 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29162 * @brief Set creating prev button automatically or not
29164 * @param obj The naviframe object
29165 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29166 * be created internally when you pass the @c NULL to the prev_btn
29167 * parameter in elm_naviframe_item_push
29169 * @see also elm_naviframe_item_push()
29171 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29173 * @brief Get a value whether prev button(back button) will be auto pushed or
29176 * @param obj The naviframe object
29177 * @return If @c EINA_TRUE, prev button will be auto pushed.
29179 * @see also elm_naviframe_item_push()
29180 * elm_naviframe_prev_btn_auto_pushed_set()
29182 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29184 * @brief Get a list of all the naviframe items.
29186 * @param obj The naviframe object
29187 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29188 * or @c NULL on failure.
29190 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29197 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29198 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29199 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29200 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29201 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29202 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29203 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29204 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29205 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29207 typedef enum _Elm_Controlbar_Mode_Type
29209 ELM_CONTROLBAR_MODE_DEFAULT = 0,
29210 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29211 ELM_CONTROLBAR_MODE_TRANSPARENCY,
29212 ELM_CONTROLBAR_MODE_LARGE,
29213 ELM_CONTROLBAR_MODE_SMALL,
29214 ELM_CONTROLBAR_MODE_LEFT,
29215 ELM_CONTROLBAR_MODE_RIGHT
29216 } Elm_Controlbar_Mode_Type;
29218 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29219 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29220 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29221 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29222 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
29223 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
29224 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29225 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29226 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29227 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29228 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29229 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29230 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29231 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29232 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29233 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
29234 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
29235 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29236 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29237 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29238 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29239 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29240 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29241 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29242 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29243 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29244 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29245 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29246 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
29247 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29248 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29249 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29250 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29251 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29252 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29253 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
29254 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29255 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29256 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29259 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29260 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29261 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
29262 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29263 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29264 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29265 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29266 EAPI void elm_searchbar_clear(Evas_Object *obj);
29267 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29269 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29270 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29271 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29272 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29275 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29276 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
29277 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
29278 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29279 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29284 ELM_TICKERNOTI_ORIENT_TOP = 0,
29285 ELM_TICKERNOTI_ORIENT_BOTTOM,
29286 ELM_TICKERNOTI_ORIENT_LAST
29287 } Elm_Tickernoti_Orient;
29289 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
29290 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29291 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29292 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29293 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29294 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29295 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29298 ELM_TICKERNOTI_DEFAULT,
29299 ELM_TICKERNOTI_DETAILVIEW
29300 } Elm_Tickernoti_Mode;
29301 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29302 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29303 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29304 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29305 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29306 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29307 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29308 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29309 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29310 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29311 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29312 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29313 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29314 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29315 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29316 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29317 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29318 /* ############################################################################### */
29320 * Parts which can be used with elm_object_text_part_set() and
29321 * elm_object_text_part_get():
29323 * @li NULL/"default" - Operates on tickernoti content-text
29325 * Parts which can be used with elm_object_content_part_set(),
29326 * elm_object_content_part_get() and elm_object_content_part_unset():
29328 * @li "icon" - Operates on tickernoti's icon
29329 * @li "button" - Operates on tickernoti's button
29331 * smart callbacks called:
29332 * @li "clicked" - emitted when tickernoti is clicked, except at the
29333 * swallow/button region, if any.
29334 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29335 * any hide animation, this signal is emitted after the animation.
29339 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29341 struct _Colorpalette_Color
29343 unsigned int r, g, b;
29346 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29347 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29348 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29349 /* smart callbacks called:
29350 * "clicked" - when image clicked
29354 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29355 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29356 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29357 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29358 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29359 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29360 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29361 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29362 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29363 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29364 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29365 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29366 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29367 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29368 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29369 /* smart callbacks called:
29370 * "clicked" - when an editfield is clicked
29371 * "unfocused" - when an editfield is unfocused
29375 /* Sliding Drawer */
29376 typedef enum _Elm_SlidingDrawer_Pos
29378 ELM_SLIDINGDRAWER_BOTTOM,
29379 ELM_SLIDINGDRAWER_LEFT,
29380 ELM_SLIDINGDRAWER_RIGHT,
29381 ELM_SLIDINGDRAWER_TOP
29382 } Elm_SlidingDrawer_Pos;
29384 typedef struct _Elm_SlidingDrawer_Drag_Value
29387 } Elm_SlidingDrawer_Drag_Value;
29389 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29390 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29391 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29392 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29393 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
29394 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29396 /* multibuttonentry */
29397 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29398 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29399 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29400 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
29401 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29402 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29403 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29404 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29405 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29406 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29407 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29408 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29409 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29410 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29411 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
29412 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29413 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29414 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29415 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29416 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29417 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29418 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29419 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29420 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29421 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29422 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29423 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29424 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29425 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29426 /* smart callback called:
29427 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29428 * "added" - This signal is emitted when a new multibuttonentry item is added.
29429 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29430 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29431 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29432 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29433 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29434 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29435 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29436 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29437 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29438 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29440 /* available styles:
29445 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29446 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29447 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29448 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29449 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29450 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29451 /* smart callback called:
29452 * "expanded" - This signal is emitted when a stackedicon is expanded.
29453 * "clicked" - This signal is emitted when a stackedicon is clicked.
29455 /* available styles:
29459 /* dialoguegroup */
29460 typedef struct _Dialogue_Item Dialogue_Item;
29462 typedef enum _Elm_Dialoguegourp_Item_Style
29464 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29465 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29466 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29467 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29468 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29469 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29470 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29471 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29472 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29473 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29474 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29475 } Elm_Dialoguegroup_Item_Style;
29477 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29478 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29479 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29480 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29481 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29482 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29483 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29484 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29485 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29486 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29487 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29488 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29489 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29490 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29491 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29492 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29497 ELM_DAYSELECTOR_SUN,
29498 ELM_DAYSELECTOR_MON,
29499 ELM_DAYSELECTOR_TUE,
29500 ELM_DAYSELECTOR_WED,
29501 ELM_DAYSELECTOR_THU,
29502 ELM_DAYSELECTOR_FRI,
29503 ELM_DAYSELECTOR_SAT
29504 } Elm_DaySelector_Day;
29506 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29507 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29508 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29511 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29512 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29513 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29514 EAPI Elm_Imageslider_Item *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
29515 EAPI Elm_Imageslider_Item *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
29516 EAPI Elm_Imageslider_Item *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
29517 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29518 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29519 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29520 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29521 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29522 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29523 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29524 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29525 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29526 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29527 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);