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 in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to build it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
301 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
302 @author Kim Yunhan <spbear@gmail.com>
304 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
305 contact with the developers and maintainers.
313 * @brief Elementary's API
318 @ELM_UNIX_DEF@ ELM_UNIX
319 @ELM_WIN32_DEF@ ELM_WIN32
320 @ELM_WINCE_DEF@ ELM_WINCE
321 @ELM_EDBUS_DEF@ ELM_EDBUS
322 @ELM_EFREET_DEF@ ELM_EFREET
323 @ELM_ETHUMB_DEF@ ELM_ETHUMB
324 @ELM_WEB_DEF@ ELM_WEB
325 @ELM_EMAP_DEF@ ELM_EMAP
326 @ELM_DEBUG_DEF@ ELM_DEBUG
327 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
328 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
330 /* Standard headers for standard system calls etc. */
335 #include <sys/types.h>
336 #include <sys/stat.h>
337 #include <sys/time.h>
338 #include <sys/param.h>
351 # ifdef ELM_LIBINTL_H
352 # include <libintl.h>
363 #if defined (ELM_WIN32) || defined (ELM_WINCE)
366 # define alloca _alloca
377 #include <Ecore_Evas.h>
378 #include <Ecore_File.h>
379 #include <Ecore_IMF.h>
380 #include <Ecore_Con.h>
389 # include <Efreet_Mime.h>
390 # include <Efreet_Trash.h>
394 # include <Ethumb_Client.h>
406 # ifdef ELEMENTARY_BUILD
408 # define EAPI __declspec(dllexport)
411 # endif /* ! DLL_EXPORT */
413 # define EAPI __declspec(dllimport)
414 # endif /* ! EFL_EVAS_BUILD */
418 # define EAPI __attribute__ ((visibility("default")))
425 #endif /* ! _WIN32 */
430 # define EAPI_MAIN EAPI
433 /* allow usage from c++ */
438 #define ELM_VERSION_MAJOR @VMAJ@
439 #define ELM_VERSION_MINOR @VMIN@
441 typedef struct _Elm_Version
449 EAPI extern Elm_Version *elm_version;
452 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
453 #define ELM_PI 3.14159265358979323846
456 * @defgroup General General
458 * @brief General Elementary API. Functions that don't relate to
459 * Elementary objects specifically.
461 * Here are documented functions which init/shutdown the library,
462 * that apply to generic Elementary objects, that deal with
463 * configuration, et cetera.
465 * @ref general_functions_example_page "This" example contemplates
466 * some of these functions.
470 * @addtogroup General
475 * Defines couple of standard Evas_Object layers to be used
476 * with evas_object_layer_set().
478 * @note whenever extending with new values, try to keep some padding
479 * to siblings so there is room for further extensions.
481 typedef enum _Elm_Object_Layer
483 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
484 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
485 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
486 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
487 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
488 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
491 /**************************************************************************/
492 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
495 * Emitted when any Elementary's policy value is changed.
497 EAPI extern int ELM_EVENT_POLICY_CHANGED;
500 * @typedef Elm_Event_Policy_Changed
502 * Data on the event when an Elementary policy has changed
504 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
507 * @struct _Elm_Event_Policy_Changed
509 * Data on the event when an Elementary policy has changed
511 struct _Elm_Event_Policy_Changed
513 unsigned int policy; /**< the policy identifier */
514 int new_value; /**< value the policy had before the change */
515 int old_value; /**< new value the policy got */
519 * Policy identifiers.
521 typedef enum _Elm_Policy
523 ELM_POLICY_QUIT, /**< under which circumstances the application
524 * should quit automatically. @see
528 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
531 typedef enum _Elm_Policy_Quit
533 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
535 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
537 * window is closed */
538 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
540 typedef enum _Elm_Focus_Direction
544 } Elm_Focus_Direction;
546 typedef enum _Elm_Text_Format
548 ELM_TEXT_FORMAT_PLAIN_UTF8,
549 ELM_TEXT_FORMAT_MARKUP_UTF8
553 * Line wrapping types.
555 typedef enum _Elm_Wrap_Type
557 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
558 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
559 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
560 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
566 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
567 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
568 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
569 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
570 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
571 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
572 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
573 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
574 ELM_INPUT_PANEL_LAYOUT_INVALID
575 } Elm_Input_Panel_Layout;
578 * @typedef Elm_Object_Item
579 * An Elementary Object item handle.
582 typedef struct _Elm_Object_Item Elm_Object_Item;
586 * Called back when a widget's tooltip is activated and needs content.
587 * @param data user-data given to elm_object_tooltip_content_cb_set()
588 * @param obj owner widget.
589 * @param tooltip The tooltip object (affix content to this!)
591 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
594 * Called back when a widget's item tooltip is activated and needs content.
595 * @param data user-data given to elm_object_tooltip_content_cb_set()
596 * @param obj owner widget.
597 * @param tooltip The tooltip object (affix content to this!)
598 * @param item context dependent item. As an example, if tooltip was
599 * set on Elm_List_Item, then it is of this type.
601 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
603 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. */
605 #ifndef ELM_LIB_QUICKLAUNCH
606 #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 */
608 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
611 /**************************************************************************/
615 * Initialize Elementary
617 * @param[in] argc System's argument count value
618 * @param[in] argv System's pointer to array of argument strings
619 * @return The init counter value.
621 * This function initializes Elementary and increments a counter of
622 * the number of calls to it. It returns the new counter's value.
624 * @warning This call is exported only for use by the @c ELM_MAIN()
625 * macro. There is no need to use this if you use this macro (which
626 * is highly advisable). An elm_main() should contain the entry
627 * point code for your application, having the same prototype as
628 * elm_init(), and @b not being static (putting the @c EAPI symbol
629 * in front of its type declaration is advisable). The @c
630 * ELM_MAIN() call should be placed just after it.
633 * @dontinclude bg_example_01.c
637 * See the full @ref bg_example_01_c "example".
639 * @see elm_shutdown().
642 EAPI int elm_init(int argc, char **argv);
645 * Shut down Elementary
647 * @return The init counter value.
649 * This should be called at the end of your application, just
650 * before it ceases to do any more processing. This will clean up
651 * any permanent resources your application may have allocated via
652 * Elementary that would otherwise persist.
654 * @see elm_init() for an example
658 EAPI int elm_shutdown(void);
661 * Run Elementary's main loop
663 * This call should be issued just after all initialization is
664 * completed. This function will not return until elm_exit() is
665 * called. It will keep looping, running the main
666 * (event/processing) loop for Elementary.
668 * @see elm_init() for an example
672 EAPI void elm_run(void);
675 * Exit Elementary's main loop
677 * If this call is issued, it will flag the main loop to cease
678 * processing and return back to its parent function (usually your
679 * elm_main() function).
681 * @see elm_init() for an example. There, just after a request to
682 * close the window comes, the main loop will be left.
684 * @note By using the #ELM_POLICY_QUIT on your Elementary
685 * applications, you'll this function called automatically for you.
689 EAPI void elm_exit(void);
692 * Provide information in order to make Elementary determine the @b
693 * run time location of the software in question, so other data files
694 * such as images, sound files, executable utilities, libraries,
695 * modules and locale files can be found.
697 * @param mainfunc This is your application's main function name,
698 * whose binary's location is to be found. Providing @c NULL
699 * will make Elementary not to use it
700 * @param dom This will be used as the application's "domain", in the
701 * form of a prefix to any environment variables that may
702 * override prefix detection and the directory name, inside the
703 * standard share or data directories, where the software's
704 * data files will be looked for.
705 * @param checkfile This is an (optional) magic file's path to check
706 * for existence (and it must be located in the data directory,
707 * under the share directory provided above). Its presence will
708 * help determine the prefix found was correct. Pass @c NULL if
709 * the check is not to be done.
711 * This function allows one to re-locate the application somewhere
712 * else after compilation, if the developer wishes for easier
713 * distribution of pre-compiled binaries.
715 * The prefix system is designed to locate where the given software is
716 * installed (under a common path prefix) at run time and then report
717 * specific locations of this prefix and common directories inside
718 * this prefix like the binary, library, data and locale directories,
719 * through the @c elm_app_*_get() family of functions.
721 * Call elm_app_info_set() early on before you change working
722 * directory or anything about @c argv[0], so it gets accurate
725 * It will then try and trace back which file @p mainfunc comes from,
726 * if provided, to determine the application's prefix directory.
728 * The @p dom parameter provides a string prefix to prepend before
729 * environment variables, allowing a fallback to @b specific
730 * environment variables to locate the software. You would most
731 * probably provide a lowercase string there, because it will also
732 * serve as directory domain, explained next. For environment
733 * variables purposes, this string is made uppercase. For example if
734 * @c "myapp" is provided as the prefix, then the program would expect
735 * @c "MYAPP_PREFIX" as a master environment variable to specify the
736 * exact install prefix for the software, or more specific environment
737 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
738 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
739 * the user or scripts before launching. If not provided (@c NULL),
740 * environment variables will not be used to override compiled-in
741 * defaults or auto detections.
743 * The @p dom string also provides a subdirectory inside the system
744 * shared data directory for data files. For example, if the system
745 * directory is @c /usr/local/share, then this directory name is
746 * appended, creating @c /usr/local/share/myapp, if it @p was @c
747 * "myapp". It is expected the application installs data files in
750 * The @p checkfile is a file name or path of something inside the
751 * share or data directory to be used to test that the prefix
752 * detection worked. For example, your app will install a wallpaper
753 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
754 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
757 * @see elm_app_compile_bin_dir_set()
758 * @see elm_app_compile_lib_dir_set()
759 * @see elm_app_compile_data_dir_set()
760 * @see elm_app_compile_locale_set()
761 * @see elm_app_prefix_dir_get()
762 * @see elm_app_bin_dir_get()
763 * @see elm_app_lib_dir_get()
764 * @see elm_app_data_dir_get()
765 * @see elm_app_locale_dir_get()
767 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
770 * Provide information on the @b fallback application's binaries
771 * directory, on scenarios where they get overriden by
772 * elm_app_info_set().
774 * @param dir The path to the default binaries directory (compile time
777 * @note Elementary will as well use this path to determine actual
778 * names of binaries' directory paths, maybe changing it to be @c
779 * something/local/bin instead of @c something/bin, only, for
782 * @warning You should call this function @b before
783 * elm_app_info_set().
785 EAPI void elm_app_compile_bin_dir_set(const char *dir);
788 * Provide information on the @b fallback application's libraries
789 * directory, on scenarios where they get overriden by
790 * elm_app_info_set().
792 * @param dir The path to the default libraries directory (compile
795 * @note Elementary will as well use this path to determine actual
796 * names of libraries' directory paths, maybe changing it to be @c
797 * something/lib32 or @c something/lib64 instead of @c something/lib,
800 * @warning You should call this function @b before
801 * elm_app_info_set().
803 EAPI void elm_app_compile_lib_dir_set(const char *dir);
806 * Provide information on the @b fallback application's data
807 * directory, on scenarios where they get overriden by
808 * elm_app_info_set().
810 * @param dir The path to the default data directory (compile time
813 * @note Elementary will as well use this path to determine actual
814 * names of data directory paths, maybe changing it to be @c
815 * something/local/share instead of @c something/share, only, for
818 * @warning You should call this function @b before
819 * elm_app_info_set().
821 EAPI void elm_app_compile_data_dir_set(const char *dir);
824 * Provide information on the @b fallback application's locale
825 * directory, on scenarios where they get overriden by
826 * elm_app_info_set().
828 * @param dir The path to the default locale directory (compile time
831 * @warning You should call this function @b before
832 * elm_app_info_set().
834 EAPI void elm_app_compile_locale_set(const char *dir);
837 * Retrieve the application's run time prefix directory, as set by
838 * elm_app_info_set() and the way (environment) the application was
841 * @return The directory prefix the application is actually using
843 EAPI const char *elm_app_prefix_dir_get(void);
846 * Retrieve the application's run time binaries prefix directory, as
847 * set by elm_app_info_set() and the way (environment) the application
850 * @return The binaries directory prefix the application is actually
853 EAPI const char *elm_app_bin_dir_get(void);
856 * Retrieve the application's run time libraries prefix directory, as
857 * set by elm_app_info_set() and the way (environment) the application
860 * @return The libraries directory prefix the application is actually
863 EAPI const char *elm_app_lib_dir_get(void);
866 * Retrieve the application's run time data prefix directory, as
867 * set by elm_app_info_set() and the way (environment) the application
870 * @return The data directory prefix the application is actually
873 EAPI const char *elm_app_data_dir_get(void);
876 * Retrieve the application's run time locale prefix directory, as
877 * set by elm_app_info_set() and the way (environment) the application
880 * @return The locale directory prefix the application is actually
883 EAPI const char *elm_app_locale_dir_get(void);
885 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
886 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
887 EAPI int elm_quicklaunch_init(int argc, char **argv);
888 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
889 EAPI int elm_quicklaunch_sub_shutdown(void);
890 EAPI int elm_quicklaunch_shutdown(void);
891 EAPI void elm_quicklaunch_seed(void);
892 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
893 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
894 EAPI void elm_quicklaunch_cleanup(void);
895 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
896 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
898 EAPI Eina_Bool elm_need_efreet(void);
899 EAPI Eina_Bool elm_need_e_dbus(void);
902 * This must be called before any other function that handle with
903 * elm_thumb objects or ethumb_client instances.
907 EAPI Eina_Bool elm_need_ethumb(void);
910 * This must be called before any other function that handle with
911 * elm_web objects or ewk_view instances.
915 EAPI Eina_Bool elm_need_web(void);
918 * Set a new policy's value (for a given policy group/identifier).
920 * @param policy policy identifier, as in @ref Elm_Policy.
921 * @param value policy value, which depends on the identifier
923 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
925 * Elementary policies define applications' behavior,
926 * somehow. These behaviors are divided in policy groups (see
927 * #Elm_Policy enumeration). This call will emit the Ecore event
928 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
929 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
932 * @note Currently, we have only one policy identifier/group
933 * (#ELM_POLICY_QUIT), which has two possible values.
937 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
940 * Gets the policy value set for given policy identifier.
942 * @param policy policy identifier, as in #Elm_Policy.
943 * @return The currently set policy value, for that
944 * identifier. Will be @c 0 if @p policy passed is invalid.
948 EAPI int elm_policy_get(unsigned int policy);
951 * Set a label of an object
953 * @param obj The Elementary object
954 * @param part The text part name to set (NULL for the default label)
955 * @param label The new text of the label
957 * @note Elementary objects may have many labels (e.g. Action Slider)
961 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
963 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
966 * Get a label of an object
968 * @param obj The Elementary object
969 * @param part The text part name to get (NULL for the default label)
970 * @return text of the label or NULL for any error
972 * @note Elementary objects may have many labels (e.g. Action Slider)
976 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
978 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
981 * Set a content of an object
983 * @param obj The Elementary object
984 * @param part The content part name to set (NULL for the default content)
985 * @param content The new content of the object
987 * @note Elementary objects may have many contents
991 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
993 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
996 * Get a content of an object
998 * @param obj The Elementary object
999 * @param item The content part name to get (NULL for the default content)
1000 * @return content of the object or NULL for any error
1002 * @note Elementary objects may have many contents
1006 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1008 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1011 * Unset a content of an object
1013 * @param obj The Elementary object
1014 * @param item The content part name to unset (NULL for the default content)
1016 * @note Elementary objects may have many contents
1020 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1022 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1025 * Set a content of an object item
1027 * @param it The Elementary object item
1028 * @param part The content part name to set (NULL for the default content)
1029 * @param content The new content of the object item
1031 * @note Elementary object items may have many contents
1035 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1037 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1040 * Get a content of an object item
1042 * @param it The Elementary object item
1043 * @param part The content part name to unset (NULL for the default content)
1044 * @return content of the object item or NULL for any error
1046 * @note Elementary object items may have many contents
1050 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1052 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1055 * Unset a content of an object item
1057 * @param it The Elementary object item
1058 * @param part The content part name to unset (NULL for the default content)
1060 * @note Elementary object items may have many contents
1064 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1066 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1069 * Set a label of an objec itemt
1071 * @param it The Elementary object item
1072 * @param part The text part name to set (NULL for the default label)
1073 * @param label The new text of the label
1075 * @note Elementary object items may have many labels
1079 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1081 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1084 * Get a label of an object
1086 * @param it The Elementary object item
1087 * @param part The text part name to get (NULL for the default label)
1088 * @return text of the label or NULL for any error
1090 * @note Elementary object items may have many labels
1094 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1097 * Set the text to read out when in accessibility mode
1099 * @param obj The object which is to be described
1100 * @param txt The text that describes the widget to people with poor or no vision
1104 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1107 * Set the text to read out when in accessibility mode
1109 * @param it The object item which is to be described
1110 * @param txt The text that describes the widget to people with poor or no vision
1114 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1117 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1120 * Get the data associated with an object item
1121 * @param it The object item
1122 * @return The data associated with @p it
1126 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1129 * Set the data associated with an object item
1130 * @param it The object item
1131 * @param data The data to be associated with @p it
1135 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1138 * Send a signal to the edje object of the widget item.
1140 * This function sends a signal to the edje object of the obj item. An
1141 * edje program can respond to a signal by specifying matching
1142 * 'signal' and 'source' fields.
1144 * @param it The Elementary object item
1145 * @param emission The signal's name.
1146 * @param source The signal's source.
1149 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1156 * @defgroup Caches Caches
1158 * These are functions which let one fine-tune some cache values for
1159 * Elementary applications, thus allowing for performance adjustments.
1165 * @brief Flush all caches.
1167 * Frees all data that was in cache and is not currently being used to reduce
1168 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1169 * to calling all of the following functions:
1170 * @li edje_file_cache_flush()
1171 * @li edje_collection_cache_flush()
1172 * @li eet_clearcache()
1173 * @li evas_image_cache_flush()
1174 * @li evas_font_cache_flush()
1175 * @li evas_render_dump()
1176 * @note Evas caches are flushed for every canvas associated with a window.
1180 EAPI void elm_all_flush(void);
1183 * Get the configured cache flush interval time
1185 * This gets the globally configured cache flush interval time, in
1188 * @return The cache flush interval time
1191 * @see elm_all_flush()
1193 EAPI int elm_cache_flush_interval_get(void);
1196 * Set the configured cache flush interval time
1198 * This sets the globally configured cache flush interval time, in ticks
1200 * @param size The cache flush interval time
1203 * @see elm_all_flush()
1205 EAPI void elm_cache_flush_interval_set(int size);
1208 * Set the configured cache flush interval time for all applications on the
1211 * This sets the globally configured cache flush interval time -- in ticks
1212 * -- for all applications on the display.
1214 * @param size The cache flush interval time
1217 EAPI void elm_cache_flush_interval_all_set(int size);
1220 * Get the configured cache flush enabled state
1222 * This gets the globally configured cache flush state - if it is enabled
1223 * or not. When cache flushing is enabled, elementary will regularly
1224 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1225 * memory and allow usage to re-seed caches and data in memory where it
1226 * can do so. An idle application will thus minimise its memory usage as
1227 * data will be freed from memory and not be re-loaded as it is idle and
1228 * not rendering or doing anything graphically right now.
1230 * @return The cache flush state
1233 * @see elm_all_flush()
1235 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1238 * Set the configured cache flush enabled state
1240 * This sets the globally configured cache flush enabled state
1242 * @param size The cache flush enabled state
1245 * @see elm_all_flush()
1247 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1250 * Set the configured cache flush enabled state for all applications on the
1253 * This sets the globally configured cache flush enabled state for all
1254 * applications on the display.
1256 * @param size The cache flush enabled state
1259 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1262 * Get the configured font cache size
1264 * This gets the globally configured font cache size, in bytes
1266 * @return The font cache size
1269 EAPI int elm_font_cache_get(void);
1272 * Set the configured font cache size
1274 * This sets the globally configured font cache size, in bytes
1276 * @param size The font cache size
1279 EAPI void elm_font_cache_set(int size);
1282 * Set the configured font cache size for all applications on the
1285 * This sets the globally configured font cache size -- in bytes
1286 * -- for all applications on the display.
1288 * @param size The font cache size
1291 EAPI void elm_font_cache_all_set(int size);
1294 * Get the configured image cache size
1296 * This gets the globally configured image cache size, in bytes
1298 * @return The image cache size
1301 EAPI int elm_image_cache_get(void);
1304 * Set the configured image cache size
1306 * This sets the globally configured image cache size, in bytes
1308 * @param size The image cache size
1311 EAPI void elm_image_cache_set(int size);
1314 * Set the configured image cache size for all applications on the
1317 * This sets the globally configured image cache size -- in bytes
1318 * -- for all applications on the display.
1320 * @param size The image cache size
1323 EAPI void elm_image_cache_all_set(int size);
1326 * Get the configured edje file cache size.
1328 * This gets the globally configured edje file cache size, in number
1331 * @return The edje file cache size
1334 EAPI int elm_edje_file_cache_get(void);
1337 * Set the configured edje file cache size
1339 * This sets the globally configured edje file cache size, in number
1342 * @param size The edje file cache size
1345 EAPI void elm_edje_file_cache_set(int size);
1348 * Set the configured edje file cache size for all applications on the
1351 * This sets the globally configured edje file cache size -- in number
1352 * of files -- for all applications on the display.
1354 * @param size The edje file cache size
1357 EAPI void elm_edje_file_cache_all_set(int size);
1360 * Get the configured edje collections (groups) cache size.
1362 * This gets the globally configured edje collections cache size, in
1363 * number of collections.
1365 * @return The edje collections cache size
1368 EAPI int elm_edje_collection_cache_get(void);
1371 * Set the configured edje collections (groups) cache size
1373 * This sets the globally configured edje collections cache size, in
1374 * number of collections.
1376 * @param size The edje collections cache size
1379 EAPI void elm_edje_collection_cache_set(int size);
1382 * Set the configured edje collections (groups) cache size for all
1383 * applications on the display
1385 * This sets the globally configured edje collections cache size -- in
1386 * number of collections -- for all applications on the display.
1388 * @param size The edje collections cache size
1391 EAPI void elm_edje_collection_cache_all_set(int size);
1398 * @defgroup Scaling Widget Scaling
1400 * Different widgets can be scaled independently. These functions
1401 * allow you to manipulate this scaling on a per-widget basis. The
1402 * object and all its children get their scaling factors multiplied
1403 * by the scale factor set. This is multiplicative, in that if a
1404 * child also has a scale size set it is in turn multiplied by its
1405 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1406 * double size, @c 0.5 is half, etc.
1408 * @ref general_functions_example_page "This" example contemplates
1409 * some of these functions.
1413 * Get the global scaling factor
1415 * This gets the globally configured scaling factor that is applied to all
1418 * @return The scaling factor
1421 EAPI double elm_scale_get(void);
1424 * Set the global scaling factor
1426 * This sets the globally configured scaling factor that is applied to all
1429 * @param scale The scaling factor to set
1432 EAPI void elm_scale_set(double scale);
1435 * Set the global scaling factor for all applications on the display
1437 * This sets the globally configured scaling factor that is applied to all
1438 * objects for all applications.
1439 * @param scale The scaling factor to set
1442 EAPI void elm_scale_all_set(double scale);
1445 * Set the scaling factor for a given Elementary object
1447 * @param obj The Elementary to operate on
1448 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1453 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1456 * Get the scaling factor for a given Elementary object
1458 * @param obj The object
1459 * @return The scaling factor set by elm_object_scale_set()
1463 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1466 * @defgroup Password_last_show Password last input show
1468 * Last show feature of password mode enables user to view
1469 * the last input entered for few seconds before masking it.
1470 * These functions allow to set this feature in password mode
1471 * of entry widget and also allow to manipulate the duration
1472 * for which the input has to be visible.
1478 * Get show last setting of password mode.
1480 * This gets the show last input setting of password mode which might be
1481 * enabled or disabled.
1483 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1485 * @ingroup Password_last_show
1487 EAPI Eina_Bool elm_password_show_last_get(void);
1490 * Set show last setting in password mode.
1492 * This enables or disables show last setting of password mode.
1494 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1495 * @see elm_password_show_last_timeout_set()
1496 * @ingroup Password_last_show
1498 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1501 * Get's the timeout value in last show password mode.
1503 * This gets the time out value for which the last input entered in password
1504 * mode will be visible.
1506 * @return The timeout value of last show password mode.
1507 * @ingroup Password_last_show
1509 EAPI double elm_password_show_last_timeout_get(void);
1512 * Set's the timeout value in last show password mode.
1514 * This sets the time out value for which the last input entered in password
1515 * mode will be visible.
1517 * @param password_show_last_timeout The timeout value.
1518 * @see elm_password_show_last_set()
1519 * @ingroup Password_last_show
1521 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1528 * @defgroup UI-Mirroring Selective Widget mirroring
1530 * These functions allow you to set ui-mirroring on specific
1531 * widgets or the whole interface. Widgets can be in one of two
1532 * modes, automatic and manual. Automatic means they'll be changed
1533 * according to the system mirroring mode and manual means only
1534 * explicit changes will matter. You are not supposed to change
1535 * mirroring state of a widget set to automatic, will mostly work,
1536 * but the behavior is not really defined.
1541 EAPI Eina_Bool elm_mirrored_get(void);
1542 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1545 * Get the system mirrored mode. This determines the default mirrored mode
1548 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1550 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553 * Set the system mirrored mode. This determines the default mirrored mode
1556 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1558 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1561 * Returns the widget's mirrored mode setting.
1563 * @param obj The widget.
1564 * @return mirrored mode setting of the object.
1567 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1570 * Sets the widget's mirrored mode setting.
1571 * When widget in automatic mode, it follows the system mirrored mode set by
1572 * elm_mirrored_set().
1573 * @param obj The widget.
1574 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1576 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1583 * Set the style to use by a widget
1585 * Sets the style name that will define the appearance of a widget. Styles
1586 * vary from widget to widget and may also be defined by other themes
1587 * by means of extensions and overlays.
1589 * @param obj The Elementary widget to style
1590 * @param style The style name to use
1592 * @see elm_theme_extension_add()
1593 * @see elm_theme_extension_del()
1594 * @see elm_theme_overlay_add()
1595 * @see elm_theme_overlay_del()
1599 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1601 * Get the style used by the widget
1603 * This gets the style being used for that widget. Note that the string
1604 * pointer is only valid as longas the object is valid and the style doesn't
1607 * @param obj The Elementary widget to query for its style
1608 * @return The style name used
1610 * @see elm_object_style_set()
1614 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1617 * @defgroup Styles Styles
1619 * Widgets can have different styles of look. These generic API's
1620 * set styles of widgets, if they support them (and if the theme(s)
1623 * @ref general_functions_example_page "This" example contemplates
1624 * some of these functions.
1628 * Set the disabled state of an Elementary object.
1630 * @param obj The Elementary object to operate on
1631 * @param disabled The state to put in in: @c EINA_TRUE for
1632 * disabled, @c EINA_FALSE for enabled
1634 * Elementary objects can be @b disabled, in which state they won't
1635 * receive input and, in general, will be themed differently from
1636 * their normal state, usually greyed out. Useful for contexts
1637 * where you don't want your users to interact with some of the
1638 * parts of you interface.
1640 * This sets the state for the widget, either disabling it or
1645 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1648 * Get the disabled state of an Elementary object.
1650 * @param obj The Elementary object to operate on
1651 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1652 * if it's enabled (or on errors)
1654 * This gets the state of the widget, which might be enabled or disabled.
1658 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1661 * @defgroup WidgetNavigation Widget Tree Navigation.
1663 * How to check if an Evas Object is an Elementary widget? How to
1664 * get the first elementary widget that is parent of the given
1665 * object? These are all covered in widget tree navigation.
1667 * @ref general_functions_example_page "This" example contemplates
1668 * some of these functions.
1672 * Check if the given Evas Object is an Elementary widget.
1674 * @param obj the object to query.
1675 * @return @c EINA_TRUE if it is an elementary widget variant,
1676 * @c EINA_FALSE otherwise
1677 * @ingroup WidgetNavigation
1679 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1682 * Get the first parent of the given object that is an Elementary
1685 * @param obj the Elementary object to query parent from.
1686 * @return the parent object that is an Elementary widget, or @c
1687 * NULL, if it was not found.
1689 * Use this to query for an object's parent widget.
1691 * @note Most of Elementary users wouldn't be mixing non-Elementary
1692 * smart objects in the objects tree of an application, as this is
1693 * an advanced usage of Elementary with Evas. So, except for the
1694 * application's window, which is the root of that tree, all other
1695 * objects would have valid Elementary widget parents.
1697 * @ingroup WidgetNavigation
1699 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1702 * Get the top level parent of an Elementary widget.
1704 * @param obj The object to query.
1705 * @return The top level Elementary widget, or @c NULL if parent cannot be
1707 * @ingroup WidgetNavigation
1709 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1712 * Get the string that represents this Elementary widget.
1714 * @note Elementary is weird and exposes itself as a single
1715 * Evas_Object_Smart_Class of type "elm_widget", so
1716 * evas_object_type_get() always return that, making debug and
1717 * language bindings hard. This function tries to mitigate this
1718 * problem, but the solution is to change Elementary to use
1719 * proper inheritance.
1721 * @param obj the object to query.
1722 * @return Elementary widget name, or @c NULL if not a valid widget.
1723 * @ingroup WidgetNavigation
1725 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1728 * @defgroup Config Elementary Config
1730 * Elementary configuration is formed by a set options bounded to a
1731 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1732 * "finger size", etc. These are functions with which one syncronizes
1733 * changes made to those values to the configuration storing files, de
1734 * facto. You most probably don't want to use the functions in this
1735 * group unlees you're writing an elementary configuration manager.
1741 * Save back Elementary's configuration, so that it will persist on
1744 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1747 * This function will take effect -- thus, do I/O -- immediately. Use
1748 * it when you want to apply all configuration changes at once. The
1749 * current configuration set will get saved onto the current profile
1750 * configuration file.
1753 EAPI Eina_Bool elm_config_save(void);
1756 * Reload Elementary's configuration, bounded to current selected
1759 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1762 * Useful when you want to force reloading of configuration values for
1763 * a profile. If one removes user custom configuration directories,
1764 * for example, it will force a reload with system values insted.
1767 EAPI void elm_config_reload(void);
1774 * @defgroup Profile Elementary Profile
1776 * Profiles are pre-set options that affect the whole look-and-feel of
1777 * Elementary-based applications. There are, for example, profiles
1778 * aimed at desktop computer applications and others aimed at mobile,
1779 * touchscreen-based ones. You most probably don't want to use the
1780 * functions in this group unlees you're writing an elementary
1781 * configuration manager.
1787 * Get Elementary's profile in use.
1789 * This gets the global profile that is applied to all Elementary
1792 * @return The profile's name
1795 EAPI const char *elm_profile_current_get(void);
1798 * Get an Elementary's profile directory path in the filesystem. One
1799 * may want to fetch a system profile's dir or an user one (fetched
1802 * @param profile The profile's name
1803 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1804 * or a system one (@c EINA_FALSE)
1805 * @return The profile's directory path.
1808 * @note You must free it with elm_profile_dir_free().
1810 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1813 * Free an Elementary's profile directory path, as returned by
1814 * elm_profile_dir_get().
1816 * @param p_dir The profile's path
1820 EAPI void elm_profile_dir_free(const char *p_dir);
1823 * Get Elementary's list of available profiles.
1825 * @return The profiles list. List node data are the profile name
1829 * @note One must free this list, after usage, with the function
1830 * elm_profile_list_free().
1832 EAPI Eina_List *elm_profile_list_get(void);
1835 * Free Elementary's list of available profiles.
1837 * @param l The profiles list, as returned by elm_profile_list_get().
1841 EAPI void elm_profile_list_free(Eina_List *l);
1844 * Set Elementary's profile.
1846 * This sets the global profile that is applied to Elementary
1847 * applications. Just the process the call comes from will be
1850 * @param profile The profile's name
1854 EAPI void elm_profile_set(const char *profile);
1857 * Set Elementary's profile.
1859 * This sets the global profile that is applied to all Elementary
1860 * applications. All running Elementary windows will be affected.
1862 * @param profile The profile's name
1866 EAPI void elm_profile_all_set(const char *profile);
1873 * @defgroup Engine Elementary Engine
1875 * These are functions setting and querying which rendering engine
1876 * Elementary will use for drawing its windows' pixels.
1878 * The following are the available engines:
1879 * @li "software_x11"
1882 * @li "software_16_x11"
1883 * @li "software_8_x11"
1886 * @li "software_gdi"
1887 * @li "software_16_wince_gdi"
1889 * @li "software_16_sdl"
1897 * @brief Get Elementary's rendering engine in use.
1899 * @return The rendering engine's name
1900 * @note there's no need to free the returned string, here.
1902 * This gets the global rendering engine that is applied to all Elementary
1905 * @see elm_engine_set()
1907 EAPI const char *elm_engine_current_get(void);
1910 * @brief Set Elementary's rendering engine for use.
1912 * @param engine The rendering engine's name
1914 * This sets global rendering engine that is applied to all Elementary
1915 * applications. Note that it will take effect only to Elementary windows
1916 * created after this is called.
1918 * @see elm_win_add()
1920 EAPI void elm_engine_set(const char *engine);
1927 * @defgroup Fonts Elementary Fonts
1929 * These are functions dealing with font rendering, selection and the
1930 * like for Elementary applications. One might fetch which system
1931 * fonts are there to use and set custom fonts for individual classes
1932 * of UI items containing text (text classes).
1937 typedef struct _Elm_Text_Class
1943 typedef struct _Elm_Font_Overlay
1945 const char *text_class;
1947 Evas_Font_Size size;
1950 typedef struct _Elm_Font_Properties
1954 } Elm_Font_Properties;
1957 * Get Elementary's list of supported text classes.
1959 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1962 * Release the list with elm_text_classes_list_free().
1964 EAPI const Eina_List *elm_text_classes_list_get(void);
1967 * Free Elementary's list of supported text classes.
1971 * @see elm_text_classes_list_get().
1973 EAPI void elm_text_classes_list_free(const Eina_List *list);
1976 * Get Elementary's list of font overlays, set with
1977 * elm_font_overlay_set().
1979 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1984 * For each text class, one can set a <b>font overlay</b> for it,
1985 * overriding the default font properties for that class coming from
1986 * the theme in use. There is no need to free this list.
1988 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1990 EAPI const Eina_List *elm_font_overlay_list_get(void);
1993 * Set a font overlay for a given Elementary text class.
1995 * @param text_class Text class name
1996 * @param font Font name and style string
1997 * @param size Font size
2001 * @p font has to be in the format returned by
2002 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2003 * and elm_font_overlay_unset().
2005 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2008 * Unset a font overlay for a given Elementary text class.
2010 * @param text_class Text class name
2014 * This will bring back text elements belonging to text class
2015 * @p text_class back to their default font settings.
2017 EAPI void elm_font_overlay_unset(const char *text_class);
2020 * Apply the changes made with elm_font_overlay_set() and
2021 * elm_font_overlay_unset() on the current Elementary window.
2025 * This applies all font overlays set to all objects in the UI.
2027 EAPI void elm_font_overlay_apply(void);
2030 * Apply the changes made with elm_font_overlay_set() and
2031 * elm_font_overlay_unset() on all Elementary application windows.
2035 * This applies all font overlays set to all objects in the UI.
2037 EAPI void elm_font_overlay_all_apply(void);
2040 * Translate a font (family) name string in fontconfig's font names
2041 * syntax into an @c Elm_Font_Properties struct.
2043 * @param font The font name and styles string
2044 * @return the font properties struct
2048 * @note The reverse translation can be achived with
2049 * elm_font_fontconfig_name_get(), for one style only (single font
2050 * instance, not family).
2052 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2055 * Free font properties return by elm_font_properties_get().
2057 * @param efp the font properties struct
2061 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2064 * Translate a font name, bound to a style, into fontconfig's font names
2067 * @param name The font (family) name
2068 * @param style The given style (may be @c NULL)
2070 * @return the font name and style string
2074 * @note The reverse translation can be achived with
2075 * elm_font_properties_get(), for one style only (single font
2076 * instance, not family).
2078 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2081 * Free the font string return by elm_font_fontconfig_name_get().
2083 * @param efp the font properties struct
2087 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2090 * Create a font hash table of available system fonts.
2092 * One must call it with @p list being the return value of
2093 * evas_font_available_list(). The hash will be indexed by font
2094 * (family) names, being its values @c Elm_Font_Properties blobs.
2096 * @param list The list of available system fonts, as returned by
2097 * evas_font_available_list().
2098 * @return the font hash.
2102 * @note The user is supposed to get it populated at least with 3
2103 * default font families (Sans, Serif, Monospace), which should be
2104 * present on most systems.
2106 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2109 * Free the hash return by elm_font_available_hash_add().
2111 * @param hash the hash to be freed.
2115 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2122 * @defgroup Fingers Fingers
2124 * Elementary is designed to be finger-friendly for touchscreens,
2125 * and so in addition to scaling for display resolution, it can
2126 * also scale based on finger "resolution" (or size). You can then
2127 * customize the granularity of the areas meant to receive clicks
2130 * Different profiles may have pre-set values for finger sizes.
2132 * @ref general_functions_example_page "This" example contemplates
2133 * some of these functions.
2139 * Get the configured "finger size"
2141 * @return The finger size
2143 * This gets the globally configured finger size, <b>in pixels</b>
2147 EAPI Evas_Coord elm_finger_size_get(void);
2150 * Set the configured finger size
2152 * This sets the globally configured finger size in pixels
2154 * @param size The finger size
2157 EAPI void elm_finger_size_set(Evas_Coord size);
2160 * Set the configured finger size for all applications on the display
2162 * This sets the globally configured finger size in pixels for all
2163 * applications on the display
2165 * @param size The finger size
2168 EAPI void elm_finger_size_all_set(Evas_Coord size);
2175 * @defgroup Focus Focus
2177 * An Elementary application has, at all times, one (and only one)
2178 * @b focused object. This is what determines where the input
2179 * events go to within the application's window. Also, focused
2180 * objects can be decorated differently, in order to signal to the
2181 * user where the input is, at a given moment.
2183 * Elementary applications also have the concept of <b>focus
2184 * chain</b>: one can cycle through all the windows' focusable
2185 * objects by input (tab key) or programmatically. The default
2186 * focus chain for an application is the one define by the order in
2187 * which the widgets where added in code. One will cycle through
2188 * top level widgets, and, for each one containg sub-objects, cycle
2189 * through them all, before returning to the level
2190 * above. Elementary also allows one to set @b custom focus chains
2191 * for their applications.
2193 * Besides the focused decoration a widget may exhibit, when it
2194 * gets focus, Elementary has a @b global focus highlight object
2195 * that can be enabled for a window. If one chooses to do so, this
2196 * extra highlight effect will surround the current focused object,
2199 * @note Some Elementary widgets are @b unfocusable, after
2200 * creation, by their very nature: they are not meant to be
2201 * interacted with input events, but are there just for visual
2204 * @ref general_functions_example_page "This" example contemplates
2205 * some of these functions.
2209 * Get the enable status of the focus highlight
2211 * This gets whether the highlight on focused objects is enabled or not
2214 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2217 * Set the enable status of the focus highlight
2219 * Set whether to show or not the highlight on focused objects
2220 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2223 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2226 * Get the enable status of the highlight animation
2228 * Get whether the focus highlight, if enabled, will animate its switch from
2229 * one object to the next
2232 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2235 * Set the enable status of the highlight animation
2237 * Set whether the focus highlight, if enabled, will animate its switch from
2238 * one object to the next
2239 * @param animate Enable animation if EINA_TRUE, disable otherwise
2242 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2245 * Get the whether an Elementary object has the focus or not.
2247 * @param obj The Elementary object to get the information from
2248 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2249 * not (and on errors).
2251 * @see elm_object_focus_set()
2255 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2258 * Set/unset focus to a given Elementary object.
2260 * @param obj The Elementary object to operate on.
2261 * @param enable @c EINA_TRUE Set focus to a given object,
2262 * @c EINA_FALSE Unset focus to a given object.
2264 * @note When you set focus to this object, if it can handle focus, will
2265 * take the focus away from the one who had it previously and will, for
2266 * now on, be the one receiving input events. Unsetting focus will remove
2267 * the focus from @p obj, passing it back to the previous element in the
2270 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2274 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2277 * Make a given Elementary object the focused one.
2279 * @param obj The Elementary object to make focused.
2281 * @note This object, if it can handle focus, will take the focus
2282 * away from the one who had it previously and will, for now on, be
2283 * the one receiving input events.
2285 * @see elm_object_focus_get()
2286 * @deprecated use elm_object_focus_set() instead.
2290 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2293 * Remove the focus from an Elementary object
2295 * @param obj The Elementary to take focus from
2297 * This removes the focus from @p obj, passing it back to the
2298 * previous element in the focus chain list.
2300 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2301 * @deprecated use elm_object_focus_set() instead.
2305 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2308 * Set the ability for an Element object to be focused
2310 * @param obj The Elementary object to operate on
2311 * @param enable @c EINA_TRUE if the object can be focused, @c
2312 * EINA_FALSE if not (and on errors)
2314 * This sets whether the object @p obj is able to take focus or
2315 * not. Unfocusable objects do nothing when programmatically
2316 * focused, being the nearest focusable parent object the one
2317 * really getting focus. Also, when they receive mouse input, they
2318 * will get the event, but not take away the focus from where it
2323 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2326 * Get whether an Elementary object is focusable or not
2328 * @param obj The Elementary object to operate on
2329 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2330 * EINA_FALSE if not (and on errors)
2332 * @note Objects which are meant to be interacted with by input
2333 * events are created able to be focused, by default. All the
2338 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2341 * Set custom focus chain.
2343 * This function overwrites any previous custom focus chain within
2344 * the list of objects. The previous list will be deleted and this list
2345 * will be managed by elementary. After it is set, don't modify it.
2347 * @note On focus cycle, only will be evaluated children of this container.
2349 * @param obj The container object
2350 * @param objs Chain of objects to pass focus
2353 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2356 * Unset a custom focus chain on a given Elementary widget
2358 * @param obj The container object to remove focus chain from
2360 * Any focus chain previously set on @p obj (for its child objects)
2361 * is removed entirely after this call.
2365 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2368 * Get custom focus chain
2370 * @param obj The container object
2373 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2376 * Append object to custom focus chain.
2378 * @note If relative_child equal to NULL or not in custom chain, the object
2379 * will be added in end.
2381 * @note On focus cycle, only will be evaluated children of this container.
2383 * @param obj The container object
2384 * @param child The child to be added in custom chain
2385 * @param relative_child The relative object to position the child
2388 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2391 * Prepend object to custom focus chain.
2393 * @note If relative_child equal to NULL or not in custom chain, the object
2394 * will be added in begin.
2396 * @note On focus cycle, only will be evaluated children of this container.
2398 * @param obj The container object
2399 * @param child The child to be added in custom chain
2400 * @param relative_child The relative object to position the child
2403 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2406 * Give focus to next object in object tree.
2408 * Give focus to next object in focus chain of one object sub-tree.
2409 * If the last object of chain already have focus, the focus will go to the
2410 * first object of chain.
2412 * @param obj The object root of sub-tree
2413 * @param dir Direction to cycle the focus
2417 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2420 * Give focus to near object in one direction.
2422 * Give focus to near object in direction of one object.
2423 * If none focusable object in given direction, the focus will not change.
2425 * @param obj The reference object
2426 * @param x Horizontal component of direction to focus
2427 * @param y Vertical component of direction to focus
2431 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2434 * Make the elementary object and its children to be unfocusable
2437 * @param obj The Elementary object to operate on
2438 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2439 * @c EINA_FALSE for focusable.
2441 * This sets whether the object @p obj and its children objects
2442 * are able to take focus or not. If the tree is set as unfocusable,
2443 * newest focused object which is not in this tree will get focus.
2444 * This API can be helpful for an object to be deleted.
2445 * When an object will be deleted soon, it and its children may not
2446 * want to get focus (by focus reverting or by other focus controls).
2447 * Then, just use this API before deleting.
2449 * @see elm_object_tree_unfocusable_get()
2453 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2456 * Get whether an Elementary object and its children are unfocusable or not.
2458 * @param obj The Elementary object to get the information from
2459 * @return @c EINA_TRUE, if the tree is unfocussable,
2460 * @c EINA_FALSE if not (and on errors).
2462 * @see elm_object_tree_unfocusable_set()
2466 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2469 * @defgroup Scrolling Scrolling
2471 * These are functions setting how scrollable views in Elementary
2472 * widgets should behave on user interaction.
2478 * Get whether scrollers should bounce when they reach their
2479 * viewport's edge during a scroll.
2481 * @return the thumb scroll bouncing state
2483 * This is the default behavior for touch screens, in general.
2484 * @ingroup Scrolling
2486 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2489 * Set whether scrollers should bounce when they reach their
2490 * viewport's edge during a scroll.
2492 * @param enabled the thumb scroll bouncing state
2494 * @see elm_thumbscroll_bounce_enabled_get()
2495 * @ingroup Scrolling
2497 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2500 * Set whether scrollers should bounce when they reach their
2501 * viewport's edge during a scroll, for all Elementary application
2504 * @param enabled the thumb scroll bouncing state
2506 * @see elm_thumbscroll_bounce_enabled_get()
2507 * @ingroup Scrolling
2509 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2512 * Get the amount of inertia a scroller will impose at bounce
2515 * @return the thumb scroll bounce friction
2517 * @ingroup Scrolling
2519 EAPI double elm_scroll_bounce_friction_get(void);
2522 * Set the amount of inertia a scroller will impose at bounce
2525 * @param friction the thumb scroll bounce friction
2527 * @see elm_thumbscroll_bounce_friction_get()
2528 * @ingroup Scrolling
2530 EAPI void elm_scroll_bounce_friction_set(double friction);
2533 * Set the amount of inertia a scroller will impose at bounce
2534 * animations, for all Elementary application windows.
2536 * @param friction the thumb scroll bounce friction
2538 * @see elm_thumbscroll_bounce_friction_get()
2539 * @ingroup Scrolling
2541 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2544 * Get the amount of inertia a <b>paged</b> scroller will impose at
2545 * page fitting animations.
2547 * @return the page scroll friction
2549 * @ingroup Scrolling
2551 EAPI double elm_scroll_page_scroll_friction_get(void);
2554 * Set the amount of inertia a <b>paged</b> scroller will impose at
2555 * page fitting animations.
2557 * @param friction the page scroll friction
2559 * @see elm_thumbscroll_page_scroll_friction_get()
2560 * @ingroup Scrolling
2562 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2565 * Set the amount of inertia a <b>paged</b> scroller will impose at
2566 * page fitting animations, for all Elementary application windows.
2568 * @param friction the page scroll friction
2570 * @see elm_thumbscroll_page_scroll_friction_get()
2571 * @ingroup Scrolling
2573 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2576 * Get the amount of inertia a scroller will impose at region bring
2579 * @return the bring in scroll friction
2581 * @ingroup Scrolling
2583 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2586 * Set the amount of inertia a scroller will impose at region bring
2589 * @param friction the bring in scroll friction
2591 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2592 * @ingroup Scrolling
2594 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2597 * Set the amount of inertia a scroller will impose at region bring
2598 * animations, for all Elementary application windows.
2600 * @param friction the bring in scroll friction
2602 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2603 * @ingroup Scrolling
2605 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2608 * Get the amount of inertia scrollers will impose at animations
2609 * triggered by Elementary widgets' zooming API.
2611 * @return the zoom friction
2613 * @ingroup Scrolling
2615 EAPI double elm_scroll_zoom_friction_get(void);
2618 * Set the amount of inertia scrollers will impose at animations
2619 * triggered by Elementary widgets' zooming API.
2621 * @param friction the zoom friction
2623 * @see elm_thumbscroll_zoom_friction_get()
2624 * @ingroup Scrolling
2626 EAPI void elm_scroll_zoom_friction_set(double friction);
2629 * Set the amount of inertia scrollers will impose at animations
2630 * triggered by Elementary widgets' zooming API, for all Elementary
2631 * application windows.
2633 * @param friction the zoom friction
2635 * @see elm_thumbscroll_zoom_friction_get()
2636 * @ingroup Scrolling
2638 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2641 * Get whether scrollers should be draggable from any point in their
2644 * @return the thumb scroll state
2646 * @note This is the default behavior for touch screens, in general.
2647 * @note All other functions namespaced with "thumbscroll" will only
2648 * have effect if this mode is enabled.
2650 * @ingroup Scrolling
2652 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2655 * Set whether scrollers should be draggable from any point in their
2658 * @param enabled the thumb scroll state
2660 * @see elm_thumbscroll_enabled_get()
2661 * @ingroup Scrolling
2663 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2666 * Set whether scrollers should be draggable from any point in their
2667 * views, for all Elementary application windows.
2669 * @param enabled the thumb scroll state
2671 * @see elm_thumbscroll_enabled_get()
2672 * @ingroup Scrolling
2674 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2677 * Get the number of pixels one should travel while dragging a
2678 * scroller's view to actually trigger scrolling.
2680 * @return the thumb scroll threshould
2682 * One would use higher values for touch screens, in general, because
2683 * of their inherent imprecision.
2684 * @ingroup Scrolling
2686 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2689 * Set the number of pixels one should travel while dragging a
2690 * scroller's view to actually trigger scrolling.
2692 * @param threshold the thumb scroll threshould
2694 * @see elm_thumbscroll_threshould_get()
2695 * @ingroup Scrolling
2697 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2700 * Set the number of pixels one should travel while dragging a
2701 * scroller's view to actually trigger scrolling, for all Elementary
2702 * application windows.
2704 * @param threshold the thumb scroll threshould
2706 * @see elm_thumbscroll_threshould_get()
2707 * @ingroup Scrolling
2709 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2712 * Get the minimum speed of mouse cursor movement which will trigger
2713 * list self scrolling animation after a mouse up event
2716 * @return the thumb scroll momentum threshould
2718 * @ingroup Scrolling
2720 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2723 * Set the minimum speed of mouse cursor movement which will trigger
2724 * list self scrolling animation after a mouse up event
2727 * @param threshold the thumb scroll momentum threshould
2729 * @see elm_thumbscroll_momentum_threshould_get()
2730 * @ingroup Scrolling
2732 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2735 * Set the minimum speed of mouse cursor movement which will trigger
2736 * list self scrolling animation after a mouse up event
2737 * (pixels/second), for all Elementary application windows.
2739 * @param threshold the thumb scroll momentum threshould
2741 * @see elm_thumbscroll_momentum_threshould_get()
2742 * @ingroup Scrolling
2744 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2747 * Get the amount of inertia a scroller will impose at self scrolling
2750 * @return the thumb scroll friction
2752 * @ingroup Scrolling
2754 EAPI double elm_scroll_thumbscroll_friction_get(void);
2757 * Set the amount of inertia a scroller will impose at self scrolling
2760 * @param friction the thumb scroll friction
2762 * @see elm_thumbscroll_friction_get()
2763 * @ingroup Scrolling
2765 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2768 * Set the amount of inertia a scroller will impose at self scrolling
2769 * animations, for all Elementary application windows.
2771 * @param friction the thumb scroll friction
2773 * @see elm_thumbscroll_friction_get()
2774 * @ingroup Scrolling
2776 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2779 * Get the amount of lag between your actual mouse cursor dragging
2780 * movement and a scroller's view movement itself, while pushing it
2781 * into bounce state manually.
2783 * @return the thumb scroll border friction
2785 * @ingroup Scrolling
2787 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2790 * Set the amount of lag between your actual mouse cursor dragging
2791 * movement and a scroller's view movement itself, while pushing it
2792 * into bounce state manually.
2794 * @param friction the thumb scroll border friction. @c 0.0 for
2795 * perfect synchrony between two movements, @c 1.0 for maximum
2798 * @see elm_thumbscroll_border_friction_get()
2799 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2801 * @ingroup Scrolling
2803 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2806 * Set the amount of lag between your actual mouse cursor dragging
2807 * movement and a scroller's view movement itself, while pushing it
2808 * into bounce state manually, for all Elementary application windows.
2810 * @param friction the thumb scroll border friction. @c 0.0 for
2811 * perfect synchrony between two movements, @c 1.0 for maximum
2814 * @see elm_thumbscroll_border_friction_get()
2815 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2817 * @ingroup Scrolling
2819 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2826 * @defgroup Scrollhints Scrollhints
2828 * Objects when inside a scroller can scroll, but this may not always be
2829 * desirable in certain situations. This allows an object to hint to itself
2830 * and parents to "not scroll" in one of 2 ways. If any child object of a
2831 * scroller has pushed a scroll freeze or hold then it affects all parent
2832 * scrollers until all children have released them.
2834 * 1. To hold on scrolling. This means just flicking and dragging may no
2835 * longer scroll, but pressing/dragging near an edge of the scroller will
2836 * still scroll. This is automatically used by the entry object when
2839 * 2. To totally freeze scrolling. This means it stops. until
2846 * Push the scroll hold by 1
2848 * This increments the scroll hold count by one. If it is more than 0 it will
2849 * take effect on the parents of the indicated object.
2851 * @param obj The object
2852 * @ingroup Scrollhints
2854 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2857 * Pop the scroll hold by 1
2859 * This decrements the scroll hold count by one. If it is more than 0 it will
2860 * take effect on the parents of the indicated object.
2862 * @param obj The object
2863 * @ingroup Scrollhints
2865 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2868 * Push the scroll freeze by 1
2870 * This increments the scroll freeze count by one. If it is more
2871 * than 0 it will take effect on the parents of the indicated
2874 * @param obj The object
2875 * @ingroup Scrollhints
2877 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2880 * Pop the scroll freeze by 1
2882 * This decrements the scroll freeze count by one. If it is more
2883 * than 0 it will take effect on the parents of the indicated
2886 * @param obj The object
2887 * @ingroup Scrollhints
2889 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2892 * Lock the scrolling of the given widget (and thus all parents)
2894 * This locks the given object from scrolling in the X axis (and implicitly
2895 * also locks all parent scrollers too from doing the same).
2897 * @param obj The object
2898 * @param lock The lock state (1 == locked, 0 == unlocked)
2899 * @ingroup Scrollhints
2901 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2904 * Lock the scrolling of the given widget (and thus all parents)
2906 * This locks the given object from scrolling in the Y axis (and implicitly
2907 * also locks all parent scrollers too from doing the same).
2909 * @param obj The object
2910 * @param lock The lock state (1 == locked, 0 == unlocked)
2911 * @ingroup Scrollhints
2913 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2916 * Get the scrolling lock of the given widget
2918 * This gets the lock for X axis scrolling.
2920 * @param obj The object
2921 * @ingroup Scrollhints
2923 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2926 * Get the scrolling lock of the given widget
2928 * This gets the lock for X axis scrolling.
2930 * @param obj The object
2931 * @ingroup Scrollhints
2933 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2940 * Send a signal to the widget edje object.
2942 * This function sends a signal to the edje object of the obj. An
2943 * edje program can respond to a signal by specifying matching
2944 * 'signal' and 'source' fields.
2946 * @param obj The object
2947 * @param emission The signal's name.
2948 * @param source The signal's source.
2951 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2954 * Add a callback for a signal emitted by widget edje object.
2956 * This function connects a callback function to a signal emitted by the
2957 * edje object of the obj.
2958 * Globs can occur in either the emission or source name.
2960 * @param obj The object
2961 * @param emission The signal's name.
2962 * @param source The signal's source.
2963 * @param func The callback function to be executed when the signal is
2965 * @param data A pointer to data to pass in to the callback function.
2968 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);
2971 * Remove a signal-triggered callback from a widget edje object.
2973 * This function removes a callback, previoulsy attached to a
2974 * signal emitted by the edje object of the obj. The parameters
2975 * emission, source and func must match exactly those passed to a
2976 * previous call to elm_object_signal_callback_add(). The data
2977 * pointer that was passed to this call will be returned.
2979 * @param obj The object
2980 * @param emission The signal's name.
2981 * @param source The signal's source.
2982 * @param func The callback function to be executed when the signal is
2984 * @return The data pointer
2987 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);
2990 * Add a callback for input events (key up, key down, mouse wheel)
2991 * on a given Elementary widget
2993 * @param obj The widget to add an event callback on
2994 * @param func The callback function to be executed when the event
2996 * @param data Data to pass in to @p func
2998 * Every widget in an Elementary interface set to receive focus,
2999 * with elm_object_focus_allow_set(), will propagate @b all of its
3000 * key up, key down and mouse wheel input events up to its parent
3001 * object, and so on. All of the focusable ones in this chain which
3002 * had an event callback set, with this call, will be able to treat
3003 * those events. There are two ways of making the propagation of
3004 * these event upwards in the tree of widgets to @b cease:
3005 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3006 * the event was @b not processed, so the propagation will go on.
3007 * - The @c event_info pointer passed to @p func will contain the
3008 * event's structure and, if you OR its @c event_flags inner
3009 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3010 * one has already handled it, thus killing the event's
3013 * @note Your event callback will be issued on those events taking
3014 * place only if no other child widget of @obj has consumed the
3017 * @note Not to be confused with @c
3018 * evas_object_event_callback_add(), which will add event callbacks
3019 * per type on general Evas objects (no event propagation
3020 * infrastructure taken in account).
3022 * @note Not to be confused with @c
3023 * elm_object_signal_callback_add(), which will add callbacks to @b
3024 * signals coming from a widget's theme, not input events.
3026 * @note Not to be confused with @c
3027 * edje_object_signal_callback_add(), which does the same as
3028 * elm_object_signal_callback_add(), but directly on an Edje
3031 * @note Not to be confused with @c
3032 * evas_object_smart_callback_add(), which adds callbacks to smart
3033 * objects' <b>smart events</b>, and not input events.
3035 * @see elm_object_event_callback_del()
3039 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3042 * Remove an event callback from a widget.
3044 * This function removes a callback, previoulsy attached to event emission
3046 * The parameters func and data must match exactly those passed to
3047 * a previous call to elm_object_event_callback_add(). The data pointer that
3048 * was passed to this call will be returned.
3050 * @param obj The object
3051 * @param func The callback function to be executed when the event is
3053 * @param data Data to pass in to the callback function.
3054 * @return The data pointer
3057 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3060 * Adjust size of an element for finger usage.
3062 * @param times_w How many fingers should fit horizontally
3063 * @param w Pointer to the width size to adjust
3064 * @param times_h How many fingers should fit vertically
3065 * @param h Pointer to the height size to adjust
3067 * This takes width and height sizes (in pixels) as input and a
3068 * size multiple (which is how many fingers you want to place
3069 * within the area, being "finger" the size set by
3070 * elm_finger_size_set()), and adjusts the size to be large enough
3071 * to accommodate the resulting size -- if it doesn't already
3072 * accommodate it. On return the @p w and @p h sizes pointed to by
3073 * these parameters will be modified, on those conditions.
3075 * @note This is kind of a low level Elementary call, most useful
3076 * on size evaluation times for widgets. An external user wouldn't
3077 * be calling, most of the time.
3081 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3084 * Get the duration for occuring long press event.
3086 * @return Timeout for long press event
3087 * @ingroup Longpress
3089 EAPI double elm_longpress_timeout_get(void);
3092 * Set the duration for occuring long press event.
3094 * @param lonpress_timeout Timeout for long press event
3095 * @ingroup Longpress
3097 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3100 * @defgroup Debug Debug
3101 * don't use it unless you are sure
3107 * Print Tree object hierarchy in stdout
3109 * @param obj The root object
3112 EAPI void elm_object_tree_dump(const Evas_Object *top);
3115 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3117 * @param obj The root object
3118 * @param file The path of output file
3121 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3128 * @defgroup Theme Theme
3130 * Elementary uses Edje to theme its widgets, naturally. But for the most
3131 * part this is hidden behind a simpler interface that lets the user set
3132 * extensions and choose the style of widgets in a much easier way.
3134 * Instead of thinking in terms of paths to Edje files and their groups
3135 * each time you want to change the appearance of a widget, Elementary
3136 * works so you can add any theme file with extensions or replace the
3137 * main theme at one point in the application, and then just set the style
3138 * of widgets with elm_object_style_set() and related functions. Elementary
3139 * will then look in its list of themes for a matching group and apply it,
3140 * and when the theme changes midway through the application, all widgets
3141 * will be updated accordingly.
3143 * There are three concepts you need to know to understand how Elementary
3144 * theming works: default theme, extensions and overlays.
3146 * Default theme, obviously enough, is the one that provides the default
3147 * look of all widgets. End users can change the theme used by Elementary
3148 * by setting the @c ELM_THEME environment variable before running an
3149 * application, or globally for all programs using the @c elementary_config
3150 * utility. Applications can change the default theme using elm_theme_set(),
3151 * but this can go against the user wishes, so it's not an adviced practice.
3153 * Ideally, applications should find everything they need in the already
3154 * provided theme, but there may be occasions when that's not enough and
3155 * custom styles are required to correctly express the idea. For this
3156 * cases, Elementary has extensions.
3158 * Extensions allow the application developer to write styles of its own
3159 * to apply to some widgets. This requires knowledge of how each widget
3160 * is themed, as extensions will always replace the entire group used by
3161 * the widget, so important signals and parts need to be there for the
3162 * object to behave properly (see documentation of Edje for details).
3163 * Once the theme for the extension is done, the application needs to add
3164 * it to the list of themes Elementary will look into, using
3165 * elm_theme_extension_add(), and set the style of the desired widgets as
3166 * he would normally with elm_object_style_set().
3168 * Overlays, on the other hand, can replace the look of all widgets by
3169 * overriding the default style. Like extensions, it's up to the application
3170 * developer to write the theme for the widgets it wants, the difference
3171 * being that when looking for the theme, Elementary will check first the
3172 * list of overlays, then the set theme and lastly the list of extensions,
3173 * so with overlays it's possible to replace the default view and every
3174 * widget will be affected. This is very much alike to setting the whole
3175 * theme for the application and will probably clash with the end user
3176 * options, not to mention the risk of ending up with not matching styles
3177 * across the program. Unless there's a very special reason to use them,
3178 * overlays should be avoided for the resons exposed before.
3180 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3181 * keeps one default internally and every function that receives one of
3182 * these can be called with NULL to refer to this default (except for
3183 * elm_theme_free()). It's possible to create a new instance of a
3184 * ::Elm_Theme to set other theme for a specific widget (and all of its
3185 * children), but this is as discouraged, if not even more so, than using
3186 * overlays. Don't use this unless you really know what you are doing.
3188 * But to be less negative about things, you can look at the following
3190 * @li @ref theme_example_01 "Using extensions"
3191 * @li @ref theme_example_02 "Using overlays"
3196 * @typedef Elm_Theme
3198 * Opaque handler for the list of themes Elementary looks for when
3199 * rendering widgets.
3201 * Stay out of this unless you really know what you are doing. For most
3202 * cases, sticking to the default is all a developer needs.
3204 typedef struct _Elm_Theme Elm_Theme;
3207 * Create a new specific theme
3209 * This creates an empty specific theme that only uses the default theme. A
3210 * specific theme has its own private set of extensions and overlays too
3211 * (which are empty by default). Specific themes do not fall back to themes
3212 * of parent objects. They are not intended for this use. Use styles, overlays
3213 * and extensions when needed, but avoid specific themes unless there is no
3214 * other way (example: you want to have a preview of a new theme you are
3215 * selecting in a "theme selector" window. The preview is inside a scroller
3216 * and should display what the theme you selected will look like, but not
3217 * actually apply it yet. The child of the scroller will have a specific
3218 * theme set to show this preview before the user decides to apply it to all
3221 EAPI Elm_Theme *elm_theme_new(void);
3223 * Free a specific theme
3225 * @param th The theme to free
3227 * This frees a theme created with elm_theme_new().
3229 EAPI void elm_theme_free(Elm_Theme *th);
3231 * Copy the theme fom the source to the destination theme
3233 * @param th The source theme to copy from
3234 * @param thdst The destination theme to copy data to
3236 * This makes a one-time static copy of all the theme config, extensions
3237 * and overlays from @p th to @p thdst. If @p th references a theme, then
3238 * @p thdst is also set to reference it, with all the theme settings,
3239 * overlays and extensions that @p th had.
3241 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3243 * Tell the source theme to reference the ref theme
3245 * @param th The theme that will do the referencing
3246 * @param thref The theme that is the reference source
3248 * This clears @p th to be empty and then sets it to refer to @p thref
3249 * so @p th acts as an override to @p thref, but where its overrides
3250 * don't apply, it will fall through to @p thref for configuration.
3252 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3254 * Return the theme referred to
3256 * @param th The theme to get the reference from
3257 * @return The referenced theme handle
3259 * This gets the theme set as the reference theme by elm_theme_ref_set().
3260 * If no theme is set as a reference, NULL is returned.
3262 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3264 * Return the default theme
3266 * @return The default theme handle
3268 * This returns the internal default theme setup handle that all widgets
3269 * use implicitly unless a specific theme is set. This is also often use
3270 * as a shorthand of NULL.
3272 EAPI Elm_Theme *elm_theme_default_get(void);
3274 * Prepends a theme overlay to the list of overlays
3276 * @param th The theme to add to, or if NULL, the default theme
3277 * @param item The Edje file path to be used
3279 * Use this if your application needs to provide some custom overlay theme
3280 * (An Edje file that replaces some default styles of widgets) where adding
3281 * new styles, or changing system theme configuration is not possible. Do
3282 * NOT use this instead of a proper system theme configuration. Use proper
3283 * configuration files, profiles, environment variables etc. to set a theme
3284 * so that the theme can be altered by simple confiugration by a user. Using
3285 * this call to achieve that effect is abusing the API and will create lots
3288 * @see elm_theme_extension_add()
3290 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3292 * Delete a theme overlay from the list of overlays
3294 * @param th The theme to delete from, or if NULL, the default theme
3295 * @param item The name of the theme overlay
3297 * @see elm_theme_overlay_add()
3299 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3301 * Appends a theme extension to the list of extensions.
3303 * @param th The theme to add to, or if NULL, the default theme
3304 * @param item The Edje file path to be used
3306 * This is intended when an application needs more styles of widgets or new
3307 * widget themes that the default does not provide (or may not provide). The
3308 * application has "extended" usage by coming up with new custom style names
3309 * for widgets for specific uses, but as these are not "standard", they are
3310 * not guaranteed to be provided by a default theme. This means the
3311 * application is required to provide these extra elements itself in specific
3312 * Edje files. This call adds one of those Edje files to the theme search
3313 * path to be search after the default theme. The use of this call is
3314 * encouraged when default styles do not meet the needs of the application.
3315 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3317 * @see elm_object_style_set()
3319 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3321 * Deletes a theme extension from the list of extensions.
3323 * @param th The theme to delete from, or if NULL, the default theme
3324 * @param item The name of the theme extension
3326 * @see elm_theme_extension_add()
3328 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3330 * Set the theme search order for the given theme
3332 * @param th The theme to set the search order, or if NULL, the default theme
3333 * @param theme Theme search string
3335 * This sets the search string for the theme in path-notation from first
3336 * theme to search, to last, delimited by the : character. Example:
3338 * "shiny:/path/to/file.edj:default"
3340 * See the ELM_THEME environment variable for more information.
3342 * @see elm_theme_get()
3343 * @see elm_theme_list_get()
3345 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3347 * Return the theme search order
3349 * @param th The theme to get the search order, or if NULL, the default theme
3350 * @return The internal search order path
3352 * This function returns a colon separated string of theme elements as
3353 * returned by elm_theme_list_get().
3355 * @see elm_theme_set()
3356 * @see elm_theme_list_get()
3358 EAPI const char *elm_theme_get(Elm_Theme *th);
3360 * Return a list of theme elements to be used in a theme.
3362 * @param th Theme to get the list of theme elements from.
3363 * @return The internal list of theme elements
3365 * This returns the internal list of theme elements (will only be valid as
3366 * long as the theme is not modified by elm_theme_set() or theme is not
3367 * freed by elm_theme_free(). This is a list of strings which must not be
3368 * altered as they are also internal. If @p th is NULL, then the default
3369 * theme element list is returned.
3371 * A theme element can consist of a full or relative path to a .edj file,
3372 * or a name, without extension, for a theme to be searched in the known
3373 * theme paths for Elemementary.
3375 * @see elm_theme_set()
3376 * @see elm_theme_get()
3378 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3380 * Return the full patrh for a theme element
3382 * @param f The theme element name
3383 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3384 * @return The full path to the file found.
3386 * This returns a string you should free with free() on success, NULL on
3387 * failure. This will search for the given theme element, and if it is a
3388 * full or relative path element or a simple searchable name. The returned
3389 * path is the full path to the file, if searched, and the file exists, or it
3390 * is simply the full path given in the element or a resolved path if
3391 * relative to home. The @p in_search_path boolean pointed to is set to
3392 * EINA_TRUE if the file was a searchable file andis in the search path,
3393 * and EINA_FALSE otherwise.
3395 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3397 * Flush the current theme.
3399 * @param th Theme to flush
3401 * This flushes caches that let elementary know where to find theme elements
3402 * in the given theme. If @p th is NULL, then the default theme is flushed.
3403 * Call this function if source theme data has changed in such a way as to
3404 * make any caches Elementary kept invalid.
3406 EAPI void elm_theme_flush(Elm_Theme *th);
3408 * This flushes all themes (default and specific ones).
3410 * This will flush all themes in the current application context, by calling
3411 * elm_theme_flush() on each of them.
3413 EAPI void elm_theme_full_flush(void);
3415 * Set the theme for all elementary using applications on the current display
3417 * @param theme The name of the theme to use. Format same as the ELM_THEME
3418 * environment variable.
3420 EAPI void elm_theme_all_set(const char *theme);
3422 * Return a list of theme elements in the theme search path
3424 * @return A list of strings that are the theme element names.
3426 * This lists all available theme files in the standard Elementary search path
3427 * for theme elements, and returns them in alphabetical order as theme
3428 * element names in a list of strings. Free this with
3429 * elm_theme_name_available_list_free() when you are done with the list.
3431 EAPI Eina_List *elm_theme_name_available_list_new(void);
3433 * Free the list returned by elm_theme_name_available_list_new()
3435 * This frees the list of themes returned by
3436 * elm_theme_name_available_list_new(). Once freed the list should no longer
3437 * be used. a new list mys be created.
3439 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3441 * Set a specific theme to be used for this object and its children
3443 * @param obj The object to set the theme on
3444 * @param th The theme to set
3446 * This sets a specific theme that will be used for the given object and any
3447 * child objects it has. If @p th is NULL then the theme to be used is
3448 * cleared and the object will inherit its theme from its parent (which
3449 * ultimately will use the default theme if no specific themes are set).
3451 * Use special themes with great care as this will annoy users and make
3452 * configuration difficult. Avoid any custom themes at all if it can be
3455 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3457 * Get the specific theme to be used
3459 * @param obj The object to get the specific theme from
3460 * @return The specifc theme set.
3462 * This will return a specific theme set, or NULL if no specific theme is
3463 * set on that object. It will not return inherited themes from parents, only
3464 * the specific theme set for that specific object. See elm_object_theme_set()
3465 * for more information.
3467 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3470 * Get a data item from a theme
3472 * @param th The theme, or NULL for default theme
3473 * @param key The data key to search with
3474 * @return The data value, or NULL on failure
3476 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3477 * It works the same way as edje_file_data_get() except that the return is stringshared.
3479 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3485 /** @defgroup Win Win
3487 * @image html img/widget/win/preview-00.png
3488 * @image latex img/widget/win/preview-00.eps
3490 * The window class of Elementary. Contains functions to manipulate
3491 * windows. The Evas engine used to render the window contents is specified
3492 * in the system or user elementary config files (whichever is found last),
3493 * and can be overridden with the ELM_ENGINE environment variable for
3494 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3495 * compilation setup and modules actually installed at runtime) are (listed
3496 * in order of best supported and most likely to be complete and work to
3499 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3500 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3502 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3504 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3506 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3508 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3509 * rendering using SDL as the buffer)
3510 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3511 * GDI with software)
3512 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3513 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3514 * grayscale using dedicated 8bit software engine in X11)
3515 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3516 * X11 using 16bit software engine)
3517 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3518 * (Windows CE rendering via GDI with 16bit software renderer)
3519 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3520 * buffer with 16bit software renderer)
3522 * All engines use a simple string to select the engine to render, EXCEPT
3523 * the "shot" engine. This actually encodes the output of the virtual
3524 * screenshot and how long to delay in the engine string. The engine string
3525 * is encoded in the following way:
3527 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3529 * Where options are separated by a ":" char if more than one option is
3530 * given, with delay, if provided being the first option and file the last
3531 * (order is important). The delay specifies how long to wait after the
3532 * window is shown before doing the virtual "in memory" rendering and then
3533 * save the output to the file specified by the file option (and then exit).
3534 * If no delay is given, the default is 0.5 seconds. If no file is given the
3535 * default output file is "out.png". Repeat option is for continous
3536 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3537 * fixed to "out001.png" Some examples of using the shot engine:
3539 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3540 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3541 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3542 * ELM_ENGINE="shot:delay=2.0" elementary_test
3543 * ELM_ENGINE="shot:" elementary_test
3545 * Signals that you can add callbacks for are:
3547 * @li "delete,request": the user requested to close the window. See
3548 * elm_win_autodel_set().
3549 * @li "focus,in": window got focus
3550 * @li "focus,out": window lost focus
3551 * @li "moved": window that holds the canvas was moved
3554 * @li @ref win_example_01
3559 * Defines the types of window that can be created
3561 * These are hints set on the window so that a running Window Manager knows
3562 * how the window should be handled and/or what kind of decorations it
3565 * Currently, only the X11 backed engines use them.
3567 typedef enum _Elm_Win_Type
3569 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3570 window. Almost every window will be created with this
3572 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3573 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3574 window holding desktop icons. */
3575 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3576 be kept on top of any other window by the Window
3578 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3580 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3581 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3583 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3584 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3585 entry in a menubar is clicked. Typically used
3586 with elm_win_override_set(). This hint exists
3587 for completion only, as the EFL way of
3588 implementing a menu would not normally use a
3589 separate window for its contents. */
3590 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3591 triggered by right-clicking an object. */
3592 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3593 explanatory text that typically appear after the
3594 mouse cursor hovers over an object for a while.
3595 Typically used with elm_win_override_set() and also
3596 not very commonly used in the EFL. */
3597 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3598 battery life or a new E-Mail received. */
3599 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3600 usually used in the EFL. */
3601 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3602 object being dragged across different windows, or even
3603 applications. Typically used with
3604 elm_win_override_set(). */
3605 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3606 buffer. No actual window is created for this
3607 type, instead the window and all of its
3608 contents will be rendered to an image buffer.
3609 This allows to have children window inside a
3610 parent one just like any other object would
3611 be, and do other things like applying @c
3612 Evas_Map effects to it. This is the only type
3613 of window that requires the @c parent
3614 parameter of elm_win_add() to be a valid @c
3619 * The differents layouts that can be requested for the virtual keyboard.
3621 * When the application window is being managed by Illume, it may request
3622 * any of the following layouts for the virtual keyboard.
3624 typedef enum _Elm_Win_Keyboard_Mode
3626 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3627 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3628 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3629 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3630 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3631 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3632 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3633 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3634 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3635 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3636 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3637 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3638 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3639 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3640 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3641 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3642 } Elm_Win_Keyboard_Mode;
3645 * Available commands that can be sent to the Illume manager.
3647 * When running under an Illume session, a window may send commands to the
3648 * Illume manager to perform different actions.
3650 typedef enum _Elm_Illume_Command
3652 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3654 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3656 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3658 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3659 } Elm_Illume_Command;
3662 * Adds a window object. If this is the first window created, pass NULL as
3665 * @param parent Parent object to add the window to, or NULL
3666 * @param name The name of the window
3667 * @param type The window type, one of #Elm_Win_Type.
3669 * The @p parent paramter can be @c NULL for every window @p type except
3670 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3671 * which the image object will be created.
3673 * @return The created object, or NULL on failure
3675 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3677 * Add @p subobj as a resize object of window @p obj.
3680 * Setting an object as a resize object of the window means that the
3681 * @p subobj child's size and position will be controlled by the window
3682 * directly. That is, the object will be resized to match the window size
3683 * and should never be moved or resized manually by the developer.
3685 * In addition, resize objects of the window control what the minimum size
3686 * of it will be, as well as whether it can or not be resized by the user.
3688 * For the end user to be able to resize a window by dragging the handles
3689 * or borders provided by the Window Manager, or using any other similar
3690 * mechanism, all of the resize objects in the window should have their
3691 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3693 * @param obj The window object
3694 * @param subobj The resize object to add
3696 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3698 * Delete @p subobj as a resize object of window @p obj.
3700 * This function removes the object @p subobj from the resize objects of
3701 * the window @p obj. It will not delete the object itself, which will be
3702 * left unmanaged and should be deleted by the developer, manually handled
3703 * or set as child of some other container.
3705 * @param obj The window object
3706 * @param subobj The resize object to add
3708 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3710 * Set the title of the window
3712 * @param obj The window object
3713 * @param title The title to set
3715 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3717 * Get the title of the window
3719 * The returned string is an internal one and should not be freed or
3720 * modified. It will also be rendered invalid if a new title is set or if
3721 * the window is destroyed.
3723 * @param obj The window object
3726 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3728 * Set the window's autodel state.
3730 * When closing the window in any way outside of the program control, like
3731 * pressing the X button in the titlebar or using a command from the
3732 * Window Manager, a "delete,request" signal is emitted to indicate that
3733 * this event occurred and the developer can take any action, which may
3734 * include, or not, destroying the window object.
3736 * When the @p autodel parameter is set, the window will be automatically
3737 * destroyed when this event occurs, after the signal is emitted.
3738 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3739 * and is up to the program to do so when it's required.
3741 * @param obj The window object
3742 * @param autodel If true, the window will automatically delete itself when
3745 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3747 * Get the window's autodel state.
3749 * @param obj The window object
3750 * @return If the window will automatically delete itself when closed
3752 * @see elm_win_autodel_set()
3754 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3756 * Activate a window object.
3758 * This function sends a request to the Window Manager to activate the
3759 * window pointed by @p obj. If honored by the WM, the window will receive
3760 * the keyboard focus.
3762 * @note This is just a request that a Window Manager may ignore, so calling
3763 * this function does not ensure in any way that the window will be the
3764 * active one after it.
3766 * @param obj The window object
3768 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3770 * Lower a window object.
3772 * Places the window pointed by @p obj at the bottom of the stack, so that
3773 * no other window is covered by it.
3775 * If elm_win_override_set() is not set, the Window Manager may ignore this
3778 * @param obj The window object
3780 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3782 * Raise a window object.
3784 * Places the window pointed by @p obj at the top of the stack, so that it's
3785 * not covered by any other window.
3787 * If elm_win_override_set() is not set, the Window Manager may ignore this
3790 * @param obj The window object
3792 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3794 * Set the borderless state of a window.
3796 * This function requests the Window Manager to not draw any decoration
3797 * around the window.
3799 * @param obj The window object
3800 * @param borderless If true, the window is borderless
3802 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3804 * Get the borderless state of a window.
3806 * @param obj The window object
3807 * @return If true, the window is borderless
3809 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3811 * Set the shaped state of a window.
3813 * Shaped windows, when supported, will render the parts of the window that
3814 * has no content, transparent.
3816 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3817 * background object or cover the entire window in any other way, or the
3818 * parts of the canvas that have no data will show framebuffer artifacts.
3820 * @param obj The window object
3821 * @param shaped If true, the window is shaped
3823 * @see elm_win_alpha_set()
3825 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3827 * Get the shaped state of a window.
3829 * @param obj The window object
3830 * @return If true, the window is shaped
3832 * @see elm_win_shaped_set()
3834 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3836 * Set the alpha channel state of a window.
3838 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3839 * possibly making parts of the window completely or partially transparent.
3840 * This is also subject to the underlying system supporting it, like for
3841 * example, running under a compositing manager. If no compositing is
3842 * available, enabling this option will instead fallback to using shaped
3843 * windows, with elm_win_shaped_set().
3845 * @param obj The window object
3846 * @param alpha If true, the window has an alpha channel
3848 * @see elm_win_alpha_set()
3850 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3852 * Get the transparency state of a window.
3854 * @param obj The window object
3855 * @return If true, the window is transparent
3857 * @see elm_win_transparent_set()
3859 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3861 * Set the transparency state of a window.
3863 * Use elm_win_alpha_set() instead.
3865 * @param obj The window object
3866 * @param transparent If true, the window is transparent
3868 * @see elm_win_alpha_set()
3870 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3872 * Get the alpha channel state of a window.
3874 * @param obj The window object
3875 * @return If true, the window has an alpha channel
3877 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3879 * Set the override state of a window.
3881 * A window with @p override set to EINA_TRUE will not be managed by the
3882 * Window Manager. This means that no decorations of any kind will be shown
3883 * for it, moving and resizing must be handled by the application, as well
3884 * as the window visibility.
3886 * This should not be used for normal windows, and even for not so normal
3887 * ones, it should only be used when there's a good reason and with a lot
3888 * of care. Mishandling override windows may result situations that
3889 * disrupt the normal workflow of the end user.
3891 * @param obj The window object
3892 * @param override If true, the window is overridden
3894 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3896 * Get the override state of a window.
3898 * @param obj The window object
3899 * @return If true, the window is overridden
3901 * @see elm_win_override_set()
3903 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3905 * Set the fullscreen state of a window.
3907 * @param obj The window object
3908 * @param fullscreen If true, the window is fullscreen
3910 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3912 * Get the fullscreen state of a window.
3914 * @param obj The window object
3915 * @return If true, the window is fullscreen
3917 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3919 * Set the maximized state of a window.
3921 * @param obj The window object
3922 * @param maximized If true, the window is maximized
3924 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3926 * Get the maximized state of a window.
3928 * @param obj The window object
3929 * @return If true, the window is maximized
3931 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3933 * Set the iconified state of a window.
3935 * @param obj The window object
3936 * @param iconified If true, the window is iconified
3938 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3940 * Get the iconified state of a window.
3942 * @param obj The window object
3943 * @return If true, the window is iconified
3945 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3947 * Set the layer of the window.
3949 * What this means exactly will depend on the underlying engine used.
3951 * In the case of X11 backed engines, the value in @p layer has the
3952 * following meanings:
3953 * @li < 3: The window will be placed below all others.
3954 * @li > 5: The window will be placed above all others.
3955 * @li other: The window will be placed in the default layer.
3957 * @param obj The window object
3958 * @param layer The layer of the window
3960 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3962 * Get the layer of the window.
3964 * @param obj The window object
3965 * @return The layer of the window
3967 * @see elm_win_layer_set()
3969 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3971 * Set the rotation of the window.
3973 * Most engines only work with multiples of 90.
3975 * This function is used to set the orientation of the window @p obj to
3976 * match that of the screen. The window itself will be resized to adjust
3977 * to the new geometry of its contents. If you want to keep the window size,
3978 * see elm_win_rotation_with_resize_set().
3980 * @param obj The window object
3981 * @param rotation The rotation of the window, in degrees (0-360),
3982 * counter-clockwise.
3984 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3986 * Rotates the window and resizes it.
3988 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3989 * that they fit inside the current window geometry.
3991 * @param obj The window object
3992 * @param layer The rotation of the window in degrees (0-360),
3993 * counter-clockwise.
3995 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3997 * Get the rotation of the window.
3999 * @param obj The window object
4000 * @return The rotation of the window in degrees (0-360)
4002 * @see elm_win_rotation_set()
4003 * @see elm_win_rotation_with_resize_set()
4005 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4007 * Set the sticky state of the window.
4009 * Hints the Window Manager that the window in @p obj should be left fixed
4010 * at its position even when the virtual desktop it's on moves or changes.
4012 * @param obj The window object
4013 * @param sticky If true, the window's sticky state is enabled
4015 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4017 * Get the sticky state of the window.
4019 * @param obj The window object
4020 * @return If true, the window's sticky state is enabled
4022 * @see elm_win_sticky_set()
4024 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4026 * Set if this window is an illume conformant window
4028 * @param obj The window object
4029 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4031 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4033 * Get if this window is an illume conformant window
4035 * @param obj The window object
4036 * @return A boolean if this window is illume conformant or not
4038 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4040 * Set a window to be an illume quickpanel window
4042 * By default window objects are not quickpanel windows.
4044 * @param obj The window object
4045 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4047 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4049 * Get if this window is a quickpanel or not
4051 * @param obj The window object
4052 * @return A boolean if this window is a quickpanel or not
4054 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4056 * Set the major priority of a quickpanel window
4058 * @param obj The window object
4059 * @param priority The major priority for this quickpanel
4061 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4063 * Get the major priority of a quickpanel window
4065 * @param obj The window object
4066 * @return The major priority of this quickpanel
4068 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4070 * Set the minor priority of a quickpanel window
4072 * @param obj The window object
4073 * @param priority The minor priority for this quickpanel
4075 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4077 * Get the minor priority of a quickpanel window
4079 * @param obj The window object
4080 * @return The minor priority of this quickpanel
4082 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4084 * Set which zone this quickpanel should appear in
4086 * @param obj The window object
4087 * @param zone The requested zone for this quickpanel
4089 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4091 * Get which zone this quickpanel should appear in
4093 * @param obj The window object
4094 * @return The requested zone for this quickpanel
4096 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4098 * Set the window to be skipped by keyboard focus
4100 * This sets the window to be skipped by normal keyboard input. This means
4101 * a window manager will be asked to not focus this window as well as omit
4102 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4104 * Call this and enable it on a window BEFORE you show it for the first time,
4105 * otherwise it may have no effect.
4107 * Use this for windows that have only output information or might only be
4108 * interacted with by the mouse or fingers, and never for typing input.
4109 * Be careful that this may have side-effects like making the window
4110 * non-accessible in some cases unless the window is specially handled. Use
4113 * @param obj The window object
4114 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4116 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4118 * Send a command to the windowing environment
4120 * This is intended to work in touchscreen or small screen device
4121 * environments where there is a more simplistic window management policy in
4122 * place. This uses the window object indicated to select which part of the
4123 * environment to control (the part that this window lives in), and provides
4124 * a command and an optional parameter structure (use NULL for this if not
4127 * @param obj The window object that lives in the environment to control
4128 * @param command The command to send
4129 * @param params Optional parameters for the command
4131 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4133 * Get the inlined image object handle
4135 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4136 * then the window is in fact an evas image object inlined in the parent
4137 * canvas. You can get this object (be careful to not manipulate it as it
4138 * is under control of elementary), and use it to do things like get pixel
4139 * data, save the image to a file, etc.
4141 * @param obj The window object to get the inlined image from
4142 * @return The inlined image object, or NULL if none exists
4144 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4146 * Set the enabled status for the focus highlight in a window
4148 * This function will enable or disable the focus highlight only for the
4149 * given window, regardless of the global setting for it
4151 * @param obj The window where to enable the highlight
4152 * @param enabled The enabled value for the highlight
4154 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4156 * Get the enabled value of the focus highlight for this window
4158 * @param obj The window in which to check if the focus highlight is enabled
4160 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4162 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4164 * Set the style for the focus highlight on this window
4166 * Sets the style to use for theming the highlight of focused objects on
4167 * the given window. If @p style is NULL, the default will be used.
4169 * @param obj The window where to set the style
4170 * @param style The style to set
4172 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4174 * Get the style set for the focus highlight object
4176 * Gets the style set for this windows highilght object, or NULL if none
4179 * @param obj The window to retrieve the highlights style from
4181 * @return The style set or NULL if none was. Default is used in that case.
4183 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4185 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4186 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4187 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4188 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4189 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4190 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4191 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4193 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4194 * (blank mouse, private mouse obj, defaultmouse)
4198 * Sets the keyboard mode of the window.
4200 * @param obj The window object
4201 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4203 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4205 * Gets the keyboard mode of the window.
4207 * @param obj The window object
4208 * @return The mode, one of #Elm_Win_Keyboard_Mode
4210 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4212 * Sets whether the window is a keyboard.
4214 * @param obj The window object
4215 * @param is_keyboard If true, the window is a virtual keyboard
4217 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4219 * Gets whether the window is a keyboard.
4221 * @param obj The window object
4222 * @return If the window is a virtual keyboard
4224 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4227 * Get the screen position of a window.
4229 * @param obj The window object
4230 * @param x The int to store the x coordinate to
4231 * @param y The int to store the y coordinate to
4233 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4239 * @defgroup Inwin Inwin
4241 * @image html img/widget/inwin/preview-00.png
4242 * @image latex img/widget/inwin/preview-00.eps
4243 * @image html img/widget/inwin/preview-01.png
4244 * @image latex img/widget/inwin/preview-01.eps
4245 * @image html img/widget/inwin/preview-02.png
4246 * @image latex img/widget/inwin/preview-02.eps
4248 * An inwin is a window inside a window that is useful for a quick popup.
4249 * It does not hover.
4251 * It works by creating an object that will occupy the entire window, so it
4252 * must be created using an @ref Win "elm_win" as parent only. The inwin
4253 * object can be hidden or restacked below every other object if it's
4254 * needed to show what's behind it without destroying it. If this is done,
4255 * the elm_win_inwin_activate() function can be used to bring it back to
4256 * full visibility again.
4258 * There are three styles available in the default theme. These are:
4259 * @li default: The inwin is sized to take over most of the window it's
4261 * @li minimal: The size of the inwin will be the minimum necessary to show
4263 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4264 * possible, but it's sized vertically the most it needs to fit its\
4267 * Some examples of Inwin can be found in the following:
4268 * @li @ref inwin_example_01
4273 * Adds an inwin to the current window
4275 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4276 * Never call this function with anything other than the top-most window
4277 * as its parameter, unless you are fond of undefined behavior.
4279 * After creating the object, the widget will set itself as resize object
4280 * for the window with elm_win_resize_object_add(), so when shown it will
4281 * appear to cover almost the entire window (how much of it depends on its
4282 * content and the style used). It must not be added into other container
4283 * objects and it needs not be moved or resized manually.
4285 * @param parent The parent object
4286 * @return The new object or NULL if it cannot be created
4288 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4290 * Activates an inwin object, ensuring its visibility
4292 * This function will make sure that the inwin @p obj is completely visible
4293 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4294 * to the front. It also sets the keyboard focus to it, which will be passed
4297 * The object's theme will also receive the signal "elm,action,show" with
4300 * @param obj The inwin to activate
4302 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4304 * Set the content of an inwin object.
4306 * Once the content object is set, a previously set one will be deleted.
4307 * If you want to keep that old content object, use the
4308 * elm_win_inwin_content_unset() function.
4310 * @param obj The inwin object
4311 * @param content The object to set as content
4313 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4315 * Get the content of an inwin object.
4317 * Return the content object which is set for this widget.
4319 * The returned object is valid as long as the inwin is still alive and no
4320 * other content is set on it. Deleting the object will notify the inwin
4321 * about it and this one will be left empty.
4323 * If you need to remove an inwin's content to be reused somewhere else,
4324 * see elm_win_inwin_content_unset().
4326 * @param obj The inwin object
4327 * @return The content that is being used
4329 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4331 * Unset the content of an inwin object.
4333 * Unparent and return the content object which was set for this widget.
4335 * @param obj The inwin object
4336 * @return The content that was being used
4338 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4342 /* X specific calls - won't work on non-x engines (return 0) */
4345 * Get the Ecore_X_Window of an Evas_Object
4347 * @param obj The object
4349 * @return The Ecore_X_Window of @p obj
4353 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4355 /* smart callbacks called:
4356 * "delete,request" - the user requested to delete the window
4357 * "focus,in" - window got focus
4358 * "focus,out" - window lost focus
4359 * "moved" - window that holds the canvas was moved
4365 * @image html img/widget/bg/preview-00.png
4366 * @image latex img/widget/bg/preview-00.eps
4368 * @brief Background object, used for setting a solid color, image or Edje
4369 * group as background to a window or any container object.
4371 * The bg object is used for setting a solid background to a window or
4372 * packing into any container object. It works just like an image, but has
4373 * some properties useful to a background, like setting it to tiled,
4374 * centered, scaled or stretched.
4376 * Here is some sample code using it:
4377 * @li @ref bg_01_example_page
4378 * @li @ref bg_02_example_page
4379 * @li @ref bg_03_example_page
4383 typedef enum _Elm_Bg_Option
4385 ELM_BG_OPTION_CENTER, /**< center the background */
4386 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4387 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4388 ELM_BG_OPTION_TILE /**< tile background at its original size */
4392 * Add a new background to the parent
4394 * @param parent The parent object
4395 * @return The new object or NULL if it cannot be created
4399 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4402 * Set the file (image or edje) used for the background
4404 * @param obj The bg object
4405 * @param file The file path
4406 * @param group Optional key (group in Edje) within the file
4408 * This sets the image file used in the background object. The image (or edje)
4409 * will be stretched (retaining aspect if its an image file) to completely fill
4410 * the bg object. This may mean some parts are not visible.
4412 * @note Once the image of @p obj is set, a previously set one will be deleted,
4413 * even if @p file is NULL.
4417 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4420 * Get the file (image or edje) used for the background
4422 * @param obj The bg object
4423 * @param file The file path
4424 * @param group Optional key (group in Edje) within the file
4428 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4431 * Set the option used for the background image
4433 * @param obj The bg object
4434 * @param option The desired background option (TILE, SCALE)
4436 * This sets the option used for manipulating the display of the background
4437 * image. The image can be tiled or scaled.
4441 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4444 * Get the option used for the background image
4446 * @param obj The bg object
4447 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4451 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4453 * Set the option used for the background color
4455 * @param obj The bg object
4460 * This sets the color used for the background rectangle. Its range goes
4465 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4467 * Get the option used for the background color
4469 * @param obj The bg object
4476 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4479 * Set the overlay object used for the background object.
4481 * @param obj The bg object
4482 * @param overlay The overlay object
4484 * This provides a way for elm_bg to have an 'overlay' that will be on top
4485 * of the bg. Once the over object is set, a previously set one will be
4486 * deleted, even if you set the new one to NULL. If you want to keep that
4487 * old content object, use the elm_bg_overlay_unset() function.
4492 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4495 * Get the overlay object used for the background object.
4497 * @param obj The bg object
4498 * @return The content that is being used
4500 * Return the content object which is set for this widget
4504 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4507 * Get the overlay object used for the background object.
4509 * @param obj The bg object
4510 * @return The content that was being used
4512 * Unparent and return the overlay object which was set for this widget
4516 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4519 * Set the size of the pixmap representation of the image.
4521 * This option just makes sense if an image is going to be set in the bg.
4523 * @param obj The bg object
4524 * @param w The new width of the image pixmap representation.
4525 * @param h The new height of the image pixmap representation.
4527 * This function sets a new size for pixmap representation of the given bg
4528 * image. It allows the image to be loaded already in the specified size,
4529 * reducing the memory usage and load time when loading a big image with load
4530 * size set to a smaller size.
4532 * NOTE: this is just a hint, the real size of the pixmap may differ
4533 * depending on the type of image being loaded, being bigger than requested.
4537 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4538 /* smart callbacks called:
4542 * @defgroup Icon Icon
4544 * @image html img/widget/icon/preview-00.png
4545 * @image latex img/widget/icon/preview-00.eps
4547 * An object that provides standard icon images (delete, edit, arrows, etc.)
4548 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4550 * The icon image requested can be in the elementary theme, or in the
4551 * freedesktop.org paths. It's possible to set the order of preference from
4552 * where the image will be used.
4554 * This API is very similar to @ref Image, but with ready to use images.
4556 * Default images provided by the theme are described below.
4558 * The first list contains icons that were first intended to be used in
4559 * toolbars, but can be used in many other places too:
4575 * Now some icons that were designed to be used in menus (but again, you can
4576 * use them anywhere else):
4581 * @li menu/arrow_down
4582 * @li menu/arrow_left
4583 * @li menu/arrow_right
4592 * And here we have some media player specific icons:
4593 * @li media_player/forward
4594 * @li media_player/info
4595 * @li media_player/next
4596 * @li media_player/pause
4597 * @li media_player/play
4598 * @li media_player/prev
4599 * @li media_player/rewind
4600 * @li media_player/stop
4602 * Signals that you can add callbacks for are:
4604 * "clicked" - This is called when a user has clicked the icon
4606 * An example of usage for this API follows:
4607 * @li @ref tutorial_icon
4615 typedef enum _Elm_Icon_Type
4622 * @enum _Elm_Icon_Lookup_Order
4623 * @typedef Elm_Icon_Lookup_Order
4625 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4626 * theme, FDO paths, or both?
4630 typedef enum _Elm_Icon_Lookup_Order
4632 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4633 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4634 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4635 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4636 } Elm_Icon_Lookup_Order;
4639 * Add a new icon object to the parent.
4641 * @param parent The parent object
4642 * @return The new object or NULL if it cannot be created
4644 * @see elm_icon_file_set()
4648 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4650 * Set the file that will be used as icon.
4652 * @param obj The icon object
4653 * @param file The path to file that will be used as icon image
4654 * @param group The group that the icon belongs to in edje file
4656 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4658 * @note The icon image set by this function can be changed by
4659 * elm_icon_standard_set().
4661 * @see elm_icon_file_get()
4665 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4667 * Set a location in memory to be used as an icon
4669 * @param obj The icon object
4670 * @param img The binary data that will be used as an image
4671 * @param size The size of binary data @p img
4672 * @param format Optional format of @p img to pass to the image loader
4673 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4675 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4677 * @note The icon image set by this function can be changed by
4678 * elm_icon_standard_set().
4682 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);
4684 * Get the file that will be used as icon.
4686 * @param obj The icon object
4687 * @param file The path to file that will be used as icon icon image
4688 * @param group The group that the icon belongs to in edje file
4690 * @see elm_icon_file_set()
4694 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4695 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4697 * Set the icon by icon standards names.
4699 * @param obj The icon object
4700 * @param name The icon name
4702 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4704 * For example, freedesktop.org defines standard icon names such as "home",
4705 * "network", etc. There can be different icon sets to match those icon
4706 * keys. The @p name given as parameter is one of these "keys", and will be
4707 * used to look in the freedesktop.org paths and elementary theme. One can
4708 * change the lookup order with elm_icon_order_lookup_set().
4710 * If name is not found in any of the expected locations and it is the
4711 * absolute path of an image file, this image will be used.
4713 * @note The icon image set by this function can be changed by
4714 * elm_icon_file_set().
4716 * @see elm_icon_standard_get()
4717 * @see elm_icon_file_set()
4721 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4723 * Get the icon name set by icon standard names.
4725 * @param obj The icon object
4726 * @return The icon name
4728 * If the icon image was set using elm_icon_file_set() instead of
4729 * elm_icon_standard_set(), then this function will return @c NULL.
4731 * @see elm_icon_standard_set()
4735 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4737 * Set the smooth effect for an icon object.
4739 * @param obj The icon object
4740 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4741 * otherwise. Default is @c EINA_TRUE.
4743 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4744 * scaling provides a better resulting image, but is slower.
4746 * The smooth scaling should be disabled when making animations that change
4747 * the icon size, since they will be faster. Animations that don't require
4748 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4749 * is already scaled, since the scaled icon image will be cached).
4751 * @see elm_icon_smooth_get()
4755 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4757 * Get the smooth effect for an icon object.
4759 * @param obj The icon object
4760 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4762 * @see elm_icon_smooth_set()
4766 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4768 * Disable scaling of this object.
4770 * @param obj The icon object.
4771 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4772 * otherwise. Default is @c EINA_FALSE.
4774 * This function disables scaling of the icon object through the function
4775 * elm_object_scale_set(). However, this does not affect the object
4776 * size/resize in any way. For that effect, take a look at
4777 * elm_icon_scale_set().
4779 * @see elm_icon_no_scale_get()
4780 * @see elm_icon_scale_set()
4781 * @see elm_object_scale_set()
4785 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4787 * Get whether scaling is disabled on the object.
4789 * @param obj The icon object
4790 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4792 * @see elm_icon_no_scale_set()
4796 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4798 * Set if the object is (up/down) resizable.
4800 * @param obj The icon object
4801 * @param scale_up A bool to set if the object is resizable up. Default is
4803 * @param scale_down A bool to set if the object is resizable down. Default
4806 * This function limits the icon object resize ability. If @p scale_up is set to
4807 * @c EINA_FALSE, the object can't have its height or width resized to a value
4808 * higher than the original icon size. Same is valid for @p scale_down.
4810 * @see elm_icon_scale_get()
4814 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4816 * Get if the object is (up/down) resizable.
4818 * @param obj The icon object
4819 * @param scale_up A bool to set if the object is resizable up
4820 * @param scale_down A bool to set if the object is resizable down
4822 * @see elm_icon_scale_set()
4826 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4828 * Get the object's image size
4830 * @param obj The icon object
4831 * @param w A pointer to store the width in
4832 * @param h A pointer to store the height in
4836 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4838 * Set if the icon fill the entire object area.
4840 * @param obj The icon object
4841 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4842 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4844 * When the icon object is resized to a different aspect ratio from the
4845 * original icon image, the icon image will still keep its aspect. This flag
4846 * tells how the image should fill the object's area. They are: keep the
4847 * entire icon inside the limits of height and width of the object (@p
4848 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4849 * of the object, and the icon will fill the entire object (@p fill_outside
4852 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4853 * retain property to false. Thus, the icon image will always keep its
4854 * original aspect ratio.
4856 * @see elm_icon_fill_outside_get()
4857 * @see elm_image_fill_outside_set()
4861 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4863 * Get if the object is filled outside.
4865 * @param obj The icon object
4866 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4868 * @see elm_icon_fill_outside_set()
4872 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4874 * Set the prescale size for the icon.
4876 * @param obj The icon object
4877 * @param size The prescale size. This value is used for both width and
4880 * This function sets a new size for pixmap representation of the given
4881 * icon. It allows the icon to be loaded already in the specified size,
4882 * reducing the memory usage and load time when loading a big icon with load
4883 * size set to a smaller size.
4885 * It's equivalent to the elm_bg_load_size_set() function for bg.
4887 * @note this is just a hint, the real size of the pixmap may differ
4888 * depending on the type of icon being loaded, being bigger than requested.
4890 * @see elm_icon_prescale_get()
4891 * @see elm_bg_load_size_set()
4895 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4897 * Get the prescale size for the icon.
4899 * @param obj The icon object
4900 * @return The prescale size
4902 * @see elm_icon_prescale_set()
4906 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4908 * Sets the icon lookup order used by elm_icon_standard_set().
4910 * @param obj The icon object
4911 * @param order The icon lookup order (can be one of
4912 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4913 * or ELM_ICON_LOOKUP_THEME)
4915 * @see elm_icon_order_lookup_get()
4916 * @see Elm_Icon_Lookup_Order
4920 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4922 * Gets the icon lookup order.
4924 * @param obj The icon object
4925 * @return The icon lookup order
4927 * @see elm_icon_order_lookup_set()
4928 * @see Elm_Icon_Lookup_Order
4932 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4934 * Get if the icon supports animation or not.
4936 * @param obj The icon object
4937 * @return @c EINA_TRUE if the icon supports animation,
4938 * @c EINA_FALSE otherwise.
4940 * Return if this elm icon's image can be animated. Currently Evas only
4941 * supports gif animation. If the return value is EINA_FALSE, other
4942 * elm_icon_animated_XXX APIs won't work.
4945 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4947 * Set animation mode of the icon.
4949 * @param obj The icon object
4950 * @param anim @c EINA_TRUE if the object do animation job,
4951 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4953 * Even though elm icon's file can be animated,
4954 * sometimes appication developer want to just first page of image.
4955 * In that time, don't call this function, because default value is EINA_FALSE
4956 * Only when you want icon support anition,
4957 * use this function and set animated to EINA_TURE
4960 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4962 * Get animation mode of the icon.
4964 * @param obj The icon object
4965 * @return The animation mode of the icon object
4966 * @see elm_icon_animated_set
4969 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4971 * Set animation play mode of the icon.
4973 * @param obj The icon object
4974 * @param play @c EINA_TRUE the object play animation images,
4975 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4977 * If you want to play elm icon's animation, you set play to EINA_TURE.
4978 * For example, you make gif player using this set/get API and click event.
4980 * 1. Click event occurs
4981 * 2. Check play flag using elm_icon_animaged_play_get
4982 * 3. If elm icon was playing, set play to EINA_FALSE.
4983 * Then animation will be stopped and vice versa
4986 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4988 * Get animation play mode of the icon.
4990 * @param obj The icon object
4991 * @return The play mode of the icon object
4993 * @see elm_icon_animated_lay_get
4996 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5003 * @defgroup Image Image
5005 * @image html img/widget/image/preview-00.png
5006 * @image latex img/widget/image/preview-00.eps
5009 * An object that allows one to load an image file to it. It can be used
5010 * anywhere like any other elementary widget.
5012 * This widget provides most of the functionality provided from @ref Bg or @ref
5013 * Icon, but with a slightly different API (use the one that fits better your
5016 * The features not provided by those two other image widgets are:
5017 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5018 * @li change the object orientation with elm_image_orient_set();
5019 * @li and turning the image editable with elm_image_editable_set().
5021 * Signals that you can add callbacks for are:
5023 * @li @c "clicked" - This is called when a user has clicked the image
5025 * An example of usage for this API follows:
5026 * @li @ref tutorial_image
5035 * @enum _Elm_Image_Orient
5036 * @typedef Elm_Image_Orient
5038 * Possible orientation options for elm_image_orient_set().
5040 * @image html elm_image_orient_set.png
5041 * @image latex elm_image_orient_set.eps width=\textwidth
5045 typedef enum _Elm_Image_Orient
5047 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5048 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5049 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5050 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5051 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5052 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5053 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5054 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5058 * Add a new image to the parent.
5060 * @param parent The parent object
5061 * @return The new object or NULL if it cannot be created
5063 * @see elm_image_file_set()
5067 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5069 * Set the file that will be used as image.
5071 * @param obj The image object
5072 * @param file The path to file that will be used as image
5073 * @param group The group that the image belongs in edje file (if it's an
5076 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5078 * @see elm_image_file_get()
5082 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5084 * Get the file that will be used as image.
5086 * @param obj The image object
5087 * @param file The path to file
5088 * @param group The group that the image belongs in edje file
5090 * @see elm_image_file_set()
5094 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5096 * Set the smooth effect for an image.
5098 * @param obj The image object
5099 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5100 * otherwise. Default is @c EINA_TRUE.
5102 * Set the scaling algorithm to be used when scaling the image. Smooth
5103 * scaling provides a better resulting image, but is slower.
5105 * The smooth scaling should be disabled when making animations that change
5106 * the image size, since it will be faster. Animations that don't require
5107 * resizing of the image can keep the smooth scaling enabled (even if the
5108 * image is already scaled, since the scaled image will be cached).
5110 * @see elm_image_smooth_get()
5114 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5116 * Get the smooth effect for an image.
5118 * @param obj The image object
5119 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5121 * @see elm_image_smooth_get()
5125 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5127 * Gets the current size of the image.
5129 * @param obj The image object.
5130 * @param w Pointer to store width, or NULL.
5131 * @param h Pointer to store height, or NULL.
5133 * This is the real size of the image, not the size of the object.
5135 * On error, neither w or h will be written.
5139 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5141 * Disable scaling of this object.
5143 * @param obj The image object.
5144 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5145 * otherwise. Default is @c EINA_FALSE.
5147 * This function disables scaling of the elm_image widget through the
5148 * function elm_object_scale_set(). However, this does not affect the widget
5149 * size/resize in any way. For that effect, take a look at
5150 * elm_image_scale_set().
5152 * @see elm_image_no_scale_get()
5153 * @see elm_image_scale_set()
5154 * @see elm_object_scale_set()
5158 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5160 * Get whether scaling is disabled on the object.
5162 * @param obj The image object
5163 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5165 * @see elm_image_no_scale_set()
5169 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5171 * Set if the object is (up/down) resizable.
5173 * @param obj The image object
5174 * @param scale_up A bool to set if the object is resizable up. Default is
5176 * @param scale_down A bool to set if the object is resizable down. Default
5179 * This function limits the image resize ability. If @p scale_up is set to
5180 * @c EINA_FALSE, the object can't have its height or width resized to a value
5181 * higher than the original image size. Same is valid for @p scale_down.
5183 * @see elm_image_scale_get()
5187 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5189 * Get if the object is (up/down) resizable.
5191 * @param obj The image object
5192 * @param scale_up A bool to set if the object is resizable up
5193 * @param scale_down A bool to set if the object is resizable down
5195 * @see elm_image_scale_set()
5199 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5201 * Set if the image fill the entire object area when keeping the aspect ratio.
5203 * @param obj The image object
5204 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5205 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5207 * When the image should keep its aspect ratio even if resized to another
5208 * aspect ratio, there are two possibilities to resize it: keep the entire
5209 * image inside the limits of height and width of the object (@p fill_outside
5210 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5211 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5213 * @note This option will have no effect if
5214 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5216 * @see elm_image_fill_outside_get()
5217 * @see elm_image_aspect_ratio_retained_set()
5221 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5223 * Get if the object is filled outside
5225 * @param obj The image object
5226 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5228 * @see elm_image_fill_outside_set()
5232 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5234 * Set the prescale size for the image
5236 * @param obj The image object
5237 * @param size The prescale size. This value is used for both width and
5240 * This function sets a new size for pixmap representation of the given
5241 * image. It allows the image to be loaded already in the specified size,
5242 * reducing the memory usage and load time when loading a big image with load
5243 * size set to a smaller size.
5245 * It's equivalent to the elm_bg_load_size_set() function for bg.
5247 * @note this is just a hint, the real size of the pixmap may differ
5248 * depending on the type of image being loaded, being bigger than requested.
5250 * @see elm_image_prescale_get()
5251 * @see elm_bg_load_size_set()
5255 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5257 * Get the prescale size for the image
5259 * @param obj The image object
5260 * @return The prescale size
5262 * @see elm_image_prescale_set()
5266 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5268 * Set the image orientation.
5270 * @param obj The image object
5271 * @param orient The image orientation
5272 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5273 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5274 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5275 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5276 * Default is #ELM_IMAGE_ORIENT_NONE.
5278 * This function allows to rotate or flip the given image.
5280 * @see elm_image_orient_get()
5281 * @see @ref Elm_Image_Orient
5285 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5287 * Get the image orientation.
5289 * @param obj The image object
5290 * @return The image orientation
5291 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5292 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5293 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5294 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5296 * @see elm_image_orient_set()
5297 * @see @ref Elm_Image_Orient
5301 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5303 * Make the image 'editable'.
5305 * @param obj Image object.
5306 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5308 * This means the image is a valid drag target for drag and drop, and can be
5309 * cut or pasted too.
5313 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5315 * Make the image 'editable'.
5317 * @param obj Image object.
5318 * @return Editability.
5320 * This means the image is a valid drag target for drag and drop, and can be
5321 * cut or pasted too.
5325 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5327 * Get the basic Evas_Image object from this object (widget).
5329 * @param obj The image object to get the inlined image from
5330 * @return The inlined image object, or NULL if none exists
5332 * This function allows one to get the underlying @c Evas_Object of type
5333 * Image from this elementary widget. It can be useful to do things like get
5334 * the pixel data, save the image to a file, etc.
5336 * @note Be careful to not manipulate it, as it is under control of
5341 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5343 * Set whether the original aspect ratio of the image should be kept on resize.
5345 * @param obj The image object.
5346 * @param retained @c EINA_TRUE if the image should retain the aspect,
5347 * @c EINA_FALSE otherwise.
5349 * The original aspect ratio (width / height) of the image is usually
5350 * distorted to match the object's size. Enabling this option will retain
5351 * this original aspect, and the way that the image is fit into the object's
5352 * area depends on the option set by elm_image_fill_outside_set().
5354 * @see elm_image_aspect_ratio_retained_get()
5355 * @see elm_image_fill_outside_set()
5359 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5361 * Get if the object retains the original aspect ratio.
5363 * @param obj The image object.
5364 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5369 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5376 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5378 typedef enum _Elm_GLView_Mode
5380 ELM_GLVIEW_ALPHA = 1,
5381 ELM_GLVIEW_DEPTH = 2,
5382 ELM_GLVIEW_STENCIL = 4
5386 * Defines a policy for the glview resizing.
5388 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5390 typedef enum _Elm_GLView_Resize_Policy
5392 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5393 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5394 } Elm_GLView_Resize_Policy;
5396 typedef enum _Elm_GLView_Render_Policy
5398 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5399 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5400 } Elm_GLView_Render_Policy;
5405 * A simple GLView widget that allows GL rendering.
5407 * Signals that you can add callbacks for are:
5413 * Add a new glview to the parent
5415 * @param parent The parent object
5416 * @return The new object or NULL if it cannot be created
5420 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5423 * Sets the size of the glview
5425 * @param obj The glview object
5426 * @param width width of the glview object
5427 * @param height height of the glview object
5431 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5434 * Gets the size of the glview.
5436 * @param obj The glview object
5437 * @param width width of the glview object
5438 * @param height height of the glview object
5440 * Note that this function returns the actual image size of the
5441 * glview. This means that when the scale policy is set to
5442 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5447 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5450 * Gets the gl api struct for gl rendering
5452 * @param obj The glview object
5453 * @return The api object or NULL if it cannot be created
5457 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5460 * Set the mode of the GLView. Supports Three simple modes.
5462 * @param obj The glview object
5463 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5464 * @return True if set properly.
5468 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5471 * Set the resize policy for the glview object.
5473 * @param obj The glview object.
5474 * @param policy The scaling policy.
5476 * By default, the resize policy is set to
5477 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5478 * destroys the previous surface and recreates the newly specified
5479 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5480 * however, glview only scales the image object and not the underlying
5485 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5488 * Set the render policy for the glview object.
5490 * @param obj The glview object.
5491 * @param policy The render policy.
5493 * By default, the render policy is set to
5494 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5495 * that during the render loop, glview is only redrawn if it needs
5496 * to be redrawn. (i.e. When it is visible) If the policy is set to
5497 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5498 * whether it is visible/need redrawing or not.
5502 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5505 * Set the init function that runs once in the main loop.
5507 * @param obj The glview object.
5508 * @param func The init function to be registered.
5510 * The registered init function gets called once during the render loop.
5514 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5517 * Set the render function that runs in the main loop.
5519 * @param obj The glview object.
5520 * @param func The delete function to be registered.
5522 * The registered del function gets called when GLView object is deleted.
5526 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5529 * Set the resize function that gets called when resize happens.
5531 * @param obj The glview object.
5532 * @param func The resize function to be registered.
5536 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5539 * Set the render function that runs in the main loop.
5541 * @param obj The glview object.
5542 * @param func The render function to be registered.
5546 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5549 * Notifies that there has been changes in the GLView.
5551 * @param obj The glview object.
5555 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5565 * @image html img/widget/box/preview-00.png
5566 * @image latex img/widget/box/preview-00.eps width=\textwidth
5568 * @image html img/box.png
5569 * @image latex img/box.eps width=\textwidth
5571 * A box arranges objects in a linear fashion, governed by a layout function
5572 * that defines the details of this arrangement.
5574 * By default, the box will use an internal function to set the layout to
5575 * a single row, either vertical or horizontal. This layout is affected
5576 * by a number of parameters, such as the homogeneous flag set by
5577 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5578 * elm_box_align_set() and the hints set to each object in the box.
5580 * For this default layout, it's possible to change the orientation with
5581 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5582 * placing its elements ordered from top to bottom. When horizontal is set,
5583 * the order will go from left to right. If the box is set to be
5584 * homogeneous, every object in it will be assigned the same space, that
5585 * of the largest object. Padding can be used to set some spacing between
5586 * the cell given to each object. The alignment of the box, set with
5587 * elm_box_align_set(), determines how the bounding box of all the elements
5588 * will be placed within the space given to the box widget itself.
5590 * The size hints of each object also affect how they are placed and sized
5591 * within the box. evas_object_size_hint_min_set() will give the minimum
5592 * size the object can have, and the box will use it as the basis for all
5593 * latter calculations. Elementary widgets set their own minimum size as
5594 * needed, so there's rarely any need to use it manually.
5596 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5597 * used to tell whether the object will be allocated the minimum size it
5598 * needs or if the space given to it should be expanded. It's important
5599 * to realize that expanding the size given to the object is not the same
5600 * thing as resizing the object. It could very well end being a small
5601 * widget floating in a much larger empty space. If not set, the weight
5602 * for objects will normally be 0.0 for both axis, meaning the widget will
5603 * not be expanded. To take as much space possible, set the weight to
5604 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5606 * Besides how much space each object is allocated, it's possible to control
5607 * how the widget will be placed within that space using
5608 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5609 * for both axis, meaning the object will be centered, but any value from
5610 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5611 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5612 * is -1.0, means the object will be resized to fill the entire space it
5615 * In addition, customized functions to define the layout can be set, which
5616 * allow the application developer to organize the objects within the box
5617 * in any number of ways.
5619 * The special elm_box_layout_transition() function can be used
5620 * to switch from one layout to another, animating the motion of the
5621 * children of the box.
5623 * @note Objects should not be added to box objects using _add() calls.
5625 * Some examples on how to use boxes follow:
5626 * @li @ref box_example_01
5627 * @li @ref box_example_02
5632 * @typedef Elm_Box_Transition
5634 * Opaque handler containing the parameters to perform an animated
5635 * transition of the layout the box uses.
5637 * @see elm_box_transition_new()
5638 * @see elm_box_layout_set()
5639 * @see elm_box_layout_transition()
5641 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5644 * Add a new box to the parent
5646 * By default, the box will be in vertical mode and non-homogeneous.
5648 * @param parent The parent object
5649 * @return The new object or NULL if it cannot be created
5651 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5653 * Set the horizontal orientation
5655 * By default, box object arranges their contents vertically from top to
5657 * By calling this function with @p horizontal as EINA_TRUE, the box will
5658 * become horizontal, arranging contents from left to right.
5660 * @note This flag is ignored if a custom layout function is set.
5662 * @param obj The box object
5663 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5664 * EINA_FALSE = vertical)
5666 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5668 * Get the horizontal orientation
5670 * @param obj The box object
5671 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5673 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5675 * Set the box to arrange its children homogeneously
5677 * If enabled, homogeneous layout makes all items the same size, according
5678 * to the size of the largest of its children.
5680 * @note This flag is ignored if a custom layout function is set.
5682 * @param obj The box object
5683 * @param homogeneous The homogeneous flag
5685 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5687 * Get whether the box is using homogeneous mode or not
5689 * @param obj The box object
5690 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5692 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5693 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5694 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5696 * Add an object to the beginning of the pack list
5698 * Pack @p subobj into the box @p obj, placing it first in the list of
5699 * children objects. The actual position the object will get on screen
5700 * depends on the layout used. If no custom layout is set, it will be at
5701 * the top or left, depending if the box is vertical or horizontal,
5704 * @param obj The box object
5705 * @param subobj The object to add to the box
5707 * @see elm_box_pack_end()
5708 * @see elm_box_pack_before()
5709 * @see elm_box_pack_after()
5710 * @see elm_box_unpack()
5711 * @see elm_box_unpack_all()
5712 * @see elm_box_clear()
5714 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5716 * Add an object at the end of the pack list
5718 * Pack @p subobj into the box @p obj, placing it last in the list of
5719 * children objects. The actual position the object will get on screen
5720 * depends on the layout used. If no custom layout is set, it will be at
5721 * the bottom or right, depending if the box is vertical or horizontal,
5724 * @param obj The box object
5725 * @param subobj The object to add to the box
5727 * @see elm_box_pack_start()
5728 * @see elm_box_pack_before()
5729 * @see elm_box_pack_after()
5730 * @see elm_box_unpack()
5731 * @see elm_box_unpack_all()
5732 * @see elm_box_clear()
5734 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5736 * Adds an object to the box before the indicated object
5738 * This will add the @p subobj to the box indicated before the object
5739 * indicated with @p before. If @p before is not already in the box, results
5740 * are undefined. Before means either to the left of the indicated object or
5741 * above it depending on orientation.
5743 * @param obj The box object
5744 * @param subobj The object to add to the box
5745 * @param before The object before which to add it
5747 * @see elm_box_pack_start()
5748 * @see elm_box_pack_end()
5749 * @see elm_box_pack_after()
5750 * @see elm_box_unpack()
5751 * @see elm_box_unpack_all()
5752 * @see elm_box_clear()
5754 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5756 * Adds an object to the box after the indicated object
5758 * This will add the @p subobj to the box indicated after the object
5759 * indicated with @p after. If @p after is not already in the box, results
5760 * are undefined. After means either to the right of the indicated object or
5761 * below it depending on orientation.
5763 * @param obj The box object
5764 * @param subobj The object to add to the box
5765 * @param after The object after which to add it
5767 * @see elm_box_pack_start()
5768 * @see elm_box_pack_end()
5769 * @see elm_box_pack_before()
5770 * @see elm_box_unpack()
5771 * @see elm_box_unpack_all()
5772 * @see elm_box_clear()
5774 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5776 * Clear the box of all children
5778 * Remove all the elements contained by the box, deleting the respective
5781 * @param obj The box object
5783 * @see elm_box_unpack()
5784 * @see elm_box_unpack_all()
5786 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5790 * Remove the object given by @p subobj from the box @p obj without
5793 * @param obj The box object
5795 * @see elm_box_unpack_all()
5796 * @see elm_box_clear()
5798 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5800 * Remove all items from the box, without deleting them
5802 * Clear the box from all children, but don't delete the respective objects.
5803 * If no other references of the box children exist, the objects will never
5804 * be deleted, and thus the application will leak the memory. Make sure
5805 * when using this function that you hold a reference to all the objects
5806 * in the box @p obj.
5808 * @param obj The box object
5810 * @see elm_box_clear()
5811 * @see elm_box_unpack()
5813 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5815 * Retrieve a list of the objects packed into the box
5817 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5818 * The order of the list corresponds to the packing order the box uses.
5820 * You must free this list with eina_list_free() once you are done with it.
5822 * @param obj The box object
5824 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5826 * Set the space (padding) between the box's elements.
5828 * Extra space in pixels that will be added between a box child and its
5829 * neighbors after its containing cell has been calculated. This padding
5830 * is set for all elements in the box, besides any possible padding that
5831 * individual elements may have through their size hints.
5833 * @param obj The box object
5834 * @param horizontal The horizontal space between elements
5835 * @param vertical The vertical space between elements
5837 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5839 * Get the space (padding) between the box's elements.
5841 * @param obj The box object
5842 * @param horizontal The horizontal space between elements
5843 * @param vertical The vertical space between elements
5845 * @see elm_box_padding_set()
5847 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5849 * Set the alignment of the whole bouding box of contents.
5851 * Sets how the bounding box containing all the elements of the box, after
5852 * their sizes and position has been calculated, will be aligned within
5853 * the space given for the whole box widget.
5855 * @param obj The box object
5856 * @param horizontal The horizontal alignment of elements
5857 * @param vertical The vertical alignment of elements
5859 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5861 * Get the alignment of the whole bouding box of contents.
5863 * @param obj The box object
5864 * @param horizontal The horizontal alignment of elements
5865 * @param vertical The vertical alignment of elements
5867 * @see elm_box_align_set()
5869 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5872 * Force the box to recalculate its children packing.
5874 * If any children was added or removed, box will not calculate the
5875 * values immediately rather leaving it to the next main loop
5876 * iteration. While this is great as it would save lots of
5877 * recalculation, whenever you need to get the position of a just
5878 * added item you must force recalculate before doing so.
5880 * @param obj The box object.
5882 EAPI void elm_box_recalculate(Evas_Object *obj);
5885 * Set the layout defining function to be used by the box
5887 * Whenever anything changes that requires the box in @p obj to recalculate
5888 * the size and position of its elements, the function @p cb will be called
5889 * to determine what the layout of the children will be.
5891 * Once a custom function is set, everything about the children layout
5892 * is defined by it. The flags set by elm_box_horizontal_set() and
5893 * elm_box_homogeneous_set() no longer have any meaning, and the values
5894 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5895 * layout function to decide if they are used and how. These last two
5896 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5897 * passed to @p cb. The @c Evas_Object the function receives is not the
5898 * Elementary widget, but the internal Evas Box it uses, so none of the
5899 * functions described here can be used on it.
5901 * Any of the layout functions in @c Evas can be used here, as well as the
5902 * special elm_box_layout_transition().
5904 * The final @p data argument received by @p cb is the same @p data passed
5905 * here, and the @p free_data function will be called to free it
5906 * whenever the box is destroyed or another layout function is set.
5908 * Setting @p cb to NULL will revert back to the default layout function.
5910 * @param obj The box object
5911 * @param cb The callback function used for layout
5912 * @param data Data that will be passed to layout function
5913 * @param free_data Function called to free @p data
5915 * @see elm_box_layout_transition()
5917 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);
5919 * Special layout function that animates the transition from one layout to another
5921 * Normally, when switching the layout function for a box, this will be
5922 * reflected immediately on screen on the next render, but it's also
5923 * possible to do this through an animated transition.
5925 * This is done by creating an ::Elm_Box_Transition and setting the box
5926 * layout to this function.
5930 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5931 * evas_object_box_layout_vertical, // start
5932 * NULL, // data for initial layout
5933 * NULL, // free function for initial data
5934 * evas_object_box_layout_horizontal, // end
5935 * NULL, // data for final layout
5936 * NULL, // free function for final data
5937 * anim_end, // will be called when animation ends
5938 * NULL); // data for anim_end function\
5939 * elm_box_layout_set(box, elm_box_layout_transition, t,
5940 * elm_box_transition_free);
5943 * @note This function can only be used with elm_box_layout_set(). Calling
5944 * it directly will not have the expected results.
5946 * @see elm_box_transition_new
5947 * @see elm_box_transition_free
5948 * @see elm_box_layout_set
5950 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5952 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5954 * If you want to animate the change from one layout to another, you need
5955 * to set the layout function of the box to elm_box_layout_transition(),
5956 * passing as user data to it an instance of ::Elm_Box_Transition with the
5957 * necessary information to perform this animation. The free function to
5958 * set for the layout is elm_box_transition_free().
5960 * The parameters to create an ::Elm_Box_Transition sum up to how long
5961 * will it be, in seconds, a layout function to describe the initial point,
5962 * another for the final position of the children and one function to be
5963 * called when the whole animation ends. This last function is useful to
5964 * set the definitive layout for the box, usually the same as the end
5965 * layout for the animation, but could be used to start another transition.
5967 * @param start_layout The layout function that will be used to start the animation
5968 * @param start_layout_data The data to be passed the @p start_layout function
5969 * @param start_layout_free_data Function to free @p start_layout_data
5970 * @param end_layout The layout function that will be used to end the animation
5971 * @param end_layout_free_data The data to be passed the @p end_layout function
5972 * @param end_layout_free_data Function to free @p end_layout_data
5973 * @param transition_end_cb Callback function called when animation ends
5974 * @param transition_end_data Data to be passed to @p transition_end_cb
5975 * @return An instance of ::Elm_Box_Transition
5977 * @see elm_box_transition_new
5978 * @see elm_box_layout_transition
5980 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);
5982 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5984 * This function is mostly useful as the @c free_data parameter in
5985 * elm_box_layout_set() when elm_box_layout_transition().
5987 * @param data The Elm_Box_Transition instance to be freed.
5989 * @see elm_box_transition_new
5990 * @see elm_box_layout_transition
5992 EAPI void elm_box_transition_free(void *data);
5999 * @defgroup Button Button
6001 * @image html img/widget/button/preview-00.png
6002 * @image latex img/widget/button/preview-00.eps
6003 * @image html img/widget/button/preview-01.png
6004 * @image latex img/widget/button/preview-01.eps
6005 * @image html img/widget/button/preview-02.png
6006 * @image latex img/widget/button/preview-02.eps
6008 * This is a push-button. Press it and run some function. It can contain
6009 * a simple label and icon object and it also has an autorepeat feature.
6011 * This widgets emits the following signals:
6012 * @li "clicked": the user clicked the button (press/release).
6013 * @li "repeated": the user pressed the button without releasing it.
6014 * @li "pressed": button was pressed.
6015 * @li "unpressed": button was released after being pressed.
6016 * In all three cases, the @c event parameter of the callback will be
6019 * Also, defined in the default theme, the button has the following styles
6021 * @li default: a normal button.
6022 * @li anchor: Like default, but the button fades away when the mouse is not
6023 * over it, leaving only the text or icon.
6024 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6025 * continuous look across its options.
6026 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6028 * Follow through a complete example @ref button_example_01 "here".
6032 * Add a new button to the parent's canvas
6034 * @param parent The parent object
6035 * @return The new object or NULL if it cannot be created
6037 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6039 * Set the label used in the button
6041 * The passed @p label can be NULL to clean any existing text in it and
6042 * leave the button as an icon only object.
6044 * @param obj The button object
6045 * @param label The text will be written on the button
6046 * @deprecated use elm_object_text_set() instead.
6048 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6050 * Get the label set for the button
6052 * The string returned is an internal pointer and should not be freed or
6053 * altered. It will also become invalid when the button is destroyed.
6054 * The string returned, if not NULL, is a stringshare, so if you need to
6055 * keep it around even after the button is destroyed, you can use
6056 * eina_stringshare_ref().
6058 * @param obj The button object
6059 * @return The text set to the label, or NULL if nothing is set
6060 * @deprecated use elm_object_text_set() instead.
6062 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6064 * Set the icon used for the button
6066 * Setting a new icon will delete any other that was previously set, making
6067 * any reference to them invalid. If you need to maintain the previous
6068 * object alive, unset it first with elm_button_icon_unset().
6070 * @param obj The button object
6071 * @param icon The icon object for the button
6073 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6075 * Get the icon used for the button
6077 * Return the icon object which is set for this widget. If the button is
6078 * destroyed or another icon is set, the returned object will be deleted
6079 * and any reference to it will be invalid.
6081 * @param obj The button object
6082 * @return The icon object that is being used
6084 * @see elm_button_icon_unset()
6086 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6088 * Remove the icon set without deleting it and return the object
6090 * This function drops the reference the button holds of the icon object
6091 * and returns this last object. It is used in case you want to remove any
6092 * icon, or set another one, without deleting the actual object. The button
6093 * will be left without an icon set.
6095 * @param obj The button object
6096 * @return The icon object that was being used
6098 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6100 * Turn on/off the autorepeat event generated when the button is kept pressed
6102 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6103 * signal when they are clicked.
6105 * When on, keeping a button pressed will continuously emit a @c repeated
6106 * signal until the button is released. The time it takes until it starts
6107 * emitting the signal is given by
6108 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6109 * new emission by elm_button_autorepeat_gap_timeout_set().
6111 * @param obj The button object
6112 * @param on A bool to turn on/off the event
6114 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6116 * Get whether the autorepeat feature is enabled
6118 * @param obj The button object
6119 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6121 * @see elm_button_autorepeat_set()
6123 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6125 * Set the initial timeout before the autorepeat event is generated
6127 * Sets the timeout, in seconds, since the button is pressed until the
6128 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6129 * won't be any delay and the even will be fired the moment the button is
6132 * @param obj The button object
6133 * @param t Timeout in seconds
6135 * @see elm_button_autorepeat_set()
6136 * @see elm_button_autorepeat_gap_timeout_set()
6138 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6140 * Get the initial timeout before the autorepeat event is generated
6142 * @param obj The button object
6143 * @return Timeout in seconds
6145 * @see elm_button_autorepeat_initial_timeout_set()
6147 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6149 * Set the interval between each generated autorepeat event
6151 * After the first @c repeated event is fired, all subsequent ones will
6152 * follow after a delay of @p t seconds for each.
6154 * @param obj The button object
6155 * @param t Interval in seconds
6157 * @see elm_button_autorepeat_initial_timeout_set()
6159 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6161 * Get the interval between each generated autorepeat event
6163 * @param obj The button object
6164 * @return Interval in seconds
6166 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6172 * @defgroup File_Selector_Button File Selector Button
6174 * @image html img/widget/fileselector_button/preview-00.png
6175 * @image latex img/widget/fileselector_button/preview-00.eps
6176 * @image html img/widget/fileselector_button/preview-01.png
6177 * @image latex img/widget/fileselector_button/preview-01.eps
6178 * @image html img/widget/fileselector_button/preview-02.png
6179 * @image latex img/widget/fileselector_button/preview-02.eps
6181 * This is a button that, when clicked, creates an Elementary
6182 * window (or inner window) <b> with a @ref Fileselector "file
6183 * selector widget" within</b>. When a file is chosen, the (inner)
6184 * window is closed and the button emits a signal having the
6185 * selected file as it's @c event_info.
6187 * This widget encapsulates operations on its internal file
6188 * selector on its own API. There is less control over its file
6189 * selector than that one would have instatiating one directly.
6191 * The following styles are available for this button:
6194 * @li @c "hoversel_vertical"
6195 * @li @c "hoversel_vertical_entry"
6197 * Smart callbacks one can register to:
6198 * - @c "file,chosen" - the user has selected a path, whose string
6199 * pointer comes as the @c event_info data (a stringshared
6202 * Here is an example on its usage:
6203 * @li @ref fileselector_button_example
6205 * @see @ref File_Selector_Entry for a similar widget.
6210 * Add a new file selector button widget to the given parent
6211 * Elementary (container) object
6213 * @param parent The parent object
6214 * @return a new file selector button widget handle or @c NULL, on
6217 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6220 * Set the label for a given file selector button widget
6222 * @param obj The file selector button widget
6223 * @param label The text label to be displayed on @p obj
6225 * @deprecated use elm_object_text_set() instead.
6227 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6230 * Get the label set for a given file selector button widget
6232 * @param obj The file selector button widget
6233 * @return The button label
6235 * @deprecated use elm_object_text_set() instead.
6237 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6240 * Set the icon on a given file selector button widget
6242 * @param obj The file selector button widget
6243 * @param icon The icon object for the button
6245 * Once the icon object is set, a previously set one will be
6246 * deleted. If you want to keep the latter, use the
6247 * elm_fileselector_button_icon_unset() function.
6249 * @see elm_fileselector_button_icon_get()
6251 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6254 * Get the icon set for a given file selector button widget
6256 * @param obj The file selector button widget
6257 * @return The icon object currently set on @p obj or @c NULL, if
6260 * @see elm_fileselector_button_icon_set()
6262 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6265 * Unset the icon used in a given file selector button widget
6267 * @param obj The file selector button widget
6268 * @return The icon object that was being used on @p obj or @c
6271 * Unparent and return the icon object which was set for this
6274 * @see elm_fileselector_button_icon_set()
6276 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6279 * Set the title for a given file selector button widget's window
6281 * @param obj The file selector button widget
6282 * @param title The title string
6284 * This will change the window's title, when the file selector pops
6285 * out after a click on the button. Those windows have the default
6286 * (unlocalized) value of @c "Select a file" as titles.
6288 * @note It will only take any effect if the file selector
6289 * button widget is @b not under "inwin mode".
6291 * @see elm_fileselector_button_window_title_get()
6293 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6296 * Get the title set for a given file selector button widget's
6299 * @param obj The file selector button widget
6300 * @return Title of the file selector button's window
6302 * @see elm_fileselector_button_window_title_get() for more details
6304 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6307 * Set the size of a given file selector button widget's window,
6308 * holding the file selector itself.
6310 * @param obj The file selector button widget
6311 * @param width The window's width
6312 * @param height The window's height
6314 * @note it will only take any effect if the file selector button
6315 * widget is @b not under "inwin mode". The default size for the
6316 * window (when applicable) is 400x400 pixels.
6318 * @see elm_fileselector_button_window_size_get()
6320 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6323 * Get the size of a given file selector button widget's window,
6324 * holding the file selector itself.
6326 * @param obj The file selector button widget
6327 * @param width Pointer into which to store the width value
6328 * @param height Pointer into which to store the height value
6330 * @note Use @c NULL pointers on the size values you're not
6331 * interested in: they'll be ignored by the function.
6333 * @see elm_fileselector_button_window_size_set(), for more details
6335 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6338 * Set the initial file system path for a given file selector
6341 * @param obj The file selector button widget
6342 * @param path The path string
6344 * It must be a <b>directory</b> path, which will have the contents
6345 * displayed initially in the file selector's view, when invoked
6346 * from @p obj. The default initial path is the @c "HOME"
6347 * environment variable's value.
6349 * @see elm_fileselector_button_path_get()
6351 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6354 * Get the initial file system path set for a given file selector
6357 * @param obj The file selector button widget
6358 * @return path The path string
6360 * @see elm_fileselector_button_path_set() for more details
6362 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6365 * Enable/disable a tree view in the given file selector button
6366 * widget's internal file selector
6368 * @param obj The file selector button widget
6369 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6372 * This has the same effect as elm_fileselector_expandable_set(),
6373 * but now applied to a file selector button's internal file
6376 * @note There's no way to put a file selector button's internal
6377 * file selector in "grid mode", as one may do with "pure" file
6380 * @see elm_fileselector_expandable_get()
6382 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6385 * Get whether tree view is enabled for the given file selector
6386 * button widget's internal file selector
6388 * @param obj The file selector button widget
6389 * @return @c EINA_TRUE if @p obj widget's internal file selector
6390 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6392 * @see elm_fileselector_expandable_set() for more details
6394 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6397 * Set whether a given file selector button widget's internal file
6398 * selector is to display folders only or the directory contents,
6401 * @param obj The file selector button widget
6402 * @param only @c EINA_TRUE to make @p obj widget's internal file
6403 * selector only display directories, @c EINA_FALSE to make files
6404 * to be displayed in it too
6406 * This has the same effect as elm_fileselector_folder_only_set(),
6407 * but now applied to a file selector button's internal file
6410 * @see elm_fileselector_folder_only_get()
6412 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6415 * Get whether a given file selector button widget's internal file
6416 * selector is displaying folders only or the directory contents,
6419 * @param obj The file selector button widget
6420 * @return @c EINA_TRUE if @p obj widget's internal file
6421 * selector is only displaying directories, @c EINA_FALSE if files
6422 * are being displayed in it too (and on errors)
6424 * @see elm_fileselector_button_folder_only_set() for more details
6426 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6429 * Enable/disable the file name entry box where the user can type
6430 * in a name for a file, in a given file selector button widget's
6431 * internal file selector.
6433 * @param obj The file selector button widget
6434 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6435 * file selector a "saving dialog", @c EINA_FALSE otherwise
6437 * This has the same effect as elm_fileselector_is_save_set(),
6438 * but now applied to a file selector button's internal file
6441 * @see elm_fileselector_is_save_get()
6443 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6446 * Get whether the given file selector button widget's internal
6447 * file selector is in "saving dialog" mode
6449 * @param obj The file selector button widget
6450 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6451 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6454 * @see elm_fileselector_button_is_save_set() for more details
6456 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6459 * Set whether a given file selector button widget's internal file
6460 * selector will raise an Elementary "inner window", instead of a
6461 * dedicated Elementary window. By default, it won't.
6463 * @param obj The file selector button widget
6464 * @param value @c EINA_TRUE to make it use an inner window, @c
6465 * EINA_TRUE to make it use a dedicated window
6467 * @see elm_win_inwin_add() for more information on inner windows
6468 * @see elm_fileselector_button_inwin_mode_get()
6470 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6473 * Get whether a given file selector button widget's internal file
6474 * selector will raise an Elementary "inner window", instead of a
6475 * dedicated Elementary window.
6477 * @param obj The file selector button widget
6478 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6479 * if it will use a dedicated window
6481 * @see elm_fileselector_button_inwin_mode_set() for more details
6483 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6490 * @defgroup File_Selector_Entry File Selector Entry
6492 * @image html img/widget/fileselector_entry/preview-00.png
6493 * @image latex img/widget/fileselector_entry/preview-00.eps
6495 * This is an entry made to be filled with or display a <b>file
6496 * system path string</b>. Besides the entry itself, the widget has
6497 * a @ref File_Selector_Button "file selector button" on its side,
6498 * which will raise an internal @ref Fileselector "file selector widget",
6499 * when clicked, for path selection aided by file system
6502 * This file selector may appear in an Elementary window or in an
6503 * inner window. When a file is chosen from it, the (inner) window
6504 * is closed and the selected file's path string is exposed both as
6505 * an smart event and as the new text on the entry.
6507 * This widget encapsulates operations on its internal file
6508 * selector on its own API. There is less control over its file
6509 * selector than that one would have instatiating one directly.
6511 * Smart callbacks one can register to:
6512 * - @c "changed" - The text within the entry was changed
6513 * - @c "activated" - The entry has had editing finished and
6514 * changes are to be "committed"
6515 * - @c "press" - The entry has been clicked
6516 * - @c "longpressed" - The entry has been clicked (and held) for a
6518 * - @c "clicked" - The entry has been clicked
6519 * - @c "clicked,double" - The entry has been double clicked
6520 * - @c "focused" - The entry has received focus
6521 * - @c "unfocused" - The entry has lost focus
6522 * - @c "selection,paste" - A paste action has occurred on the
6524 * - @c "selection,copy" - A copy action has occurred on the entry
6525 * - @c "selection,cut" - A cut action has occurred on the entry
6526 * - @c "unpressed" - The file selector entry's button was released
6527 * after being pressed.
6528 * - @c "file,chosen" - The user has selected a path via the file
6529 * selector entry's internal file selector, whose string pointer
6530 * comes as the @c event_info data (a stringshared string)
6532 * Here is an example on its usage:
6533 * @li @ref fileselector_entry_example
6535 * @see @ref File_Selector_Button for a similar widget.
6540 * Add a new file selector entry widget to the given parent
6541 * Elementary (container) object
6543 * @param parent The parent object
6544 * @return a new file selector entry widget handle or @c NULL, on
6547 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6550 * Set the label for a given file selector entry widget's button
6552 * @param obj The file selector entry widget
6553 * @param label The text label to be displayed on @p obj widget's
6556 * @deprecated use elm_object_text_set() instead.
6558 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6561 * Get the label set for a given file selector entry widget's button
6563 * @param obj The file selector entry widget
6564 * @return The widget button's label
6566 * @deprecated use elm_object_text_set() instead.
6568 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6571 * Set the icon on a given file selector entry widget's button
6573 * @param obj The file selector entry widget
6574 * @param icon The icon object for the entry's button
6576 * Once the icon object is set, a previously set one will be
6577 * deleted. If you want to keep the latter, use the
6578 * elm_fileselector_entry_button_icon_unset() function.
6580 * @see elm_fileselector_entry_button_icon_get()
6582 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6585 * Get the icon set for a given file selector entry widget's button
6587 * @param obj The file selector entry widget
6588 * @return The icon object currently set on @p obj widget's button
6589 * or @c NULL, if none is
6591 * @see elm_fileselector_entry_button_icon_set()
6593 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6596 * Unset the icon used in a given file selector entry widget's
6599 * @param obj The file selector entry widget
6600 * @return The icon object that was being used on @p obj widget's
6601 * button or @c NULL, on errors
6603 * Unparent and return the icon object which was set for this
6606 * @see elm_fileselector_entry_button_icon_set()
6608 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6611 * Set the title for a given file selector entry widget's window
6613 * @param obj The file selector entry widget
6614 * @param title The title string
6616 * This will change the window's title, when the file selector pops
6617 * out after a click on the entry's button. Those windows have the
6618 * default (unlocalized) value of @c "Select a file" as titles.
6620 * @note It will only take any effect if the file selector
6621 * entry widget is @b not under "inwin mode".
6623 * @see elm_fileselector_entry_window_title_get()
6625 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6628 * Get the title set for a given file selector entry widget's
6631 * @param obj The file selector entry widget
6632 * @return Title of the file selector entry's window
6634 * @see elm_fileselector_entry_window_title_get() for more details
6636 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6639 * Set the size of a given file selector entry widget's window,
6640 * holding the file selector itself.
6642 * @param obj The file selector entry widget
6643 * @param width The window's width
6644 * @param height The window's height
6646 * @note it will only take any effect if the file selector entry
6647 * widget is @b not under "inwin mode". The default size for the
6648 * window (when applicable) is 400x400 pixels.
6650 * @see elm_fileselector_entry_window_size_get()
6652 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6655 * Get the size of a given file selector entry widget's window,
6656 * holding the file selector itself.
6658 * @param obj The file selector entry widget
6659 * @param width Pointer into which to store the width value
6660 * @param height Pointer into which to store the height value
6662 * @note Use @c NULL pointers on the size values you're not
6663 * interested in: they'll be ignored by the function.
6665 * @see elm_fileselector_entry_window_size_set(), for more details
6667 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6670 * Set the initial file system path and the entry's path string for
6671 * a given file selector entry widget
6673 * @param obj The file selector entry widget
6674 * @param path The path string
6676 * It must be a <b>directory</b> path, which will have the contents
6677 * displayed initially in the file selector's view, when invoked
6678 * from @p obj. The default initial path is the @c "HOME"
6679 * environment variable's value.
6681 * @see elm_fileselector_entry_path_get()
6683 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6686 * Get the entry's path string for a given file selector entry
6689 * @param obj The file selector entry widget
6690 * @return path The path string
6692 * @see elm_fileselector_entry_path_set() for more details
6694 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6697 * Enable/disable a tree view in the given file selector entry
6698 * widget's internal file selector
6700 * @param obj The file selector entry widget
6701 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6704 * This has the same effect as elm_fileselector_expandable_set(),
6705 * but now applied to a file selector entry's internal file
6708 * @note There's no way to put a file selector entry's internal
6709 * file selector in "grid mode", as one may do with "pure" file
6712 * @see elm_fileselector_expandable_get()
6714 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6717 * Get whether tree view is enabled for the given file selector
6718 * entry widget's internal file selector
6720 * @param obj The file selector entry widget
6721 * @return @c EINA_TRUE if @p obj widget's internal file selector
6722 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6724 * @see elm_fileselector_expandable_set() for more details
6726 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6729 * Set whether a given file selector entry widget's internal file
6730 * selector is to display folders only or the directory contents,
6733 * @param obj The file selector entry widget
6734 * @param only @c EINA_TRUE to make @p obj widget's internal file
6735 * selector only display directories, @c EINA_FALSE to make files
6736 * to be displayed in it too
6738 * This has the same effect as elm_fileselector_folder_only_set(),
6739 * but now applied to a file selector entry's internal file
6742 * @see elm_fileselector_folder_only_get()
6744 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6747 * Get whether a given file selector entry widget's internal file
6748 * selector is displaying folders only or the directory contents,
6751 * @param obj The file selector entry widget
6752 * @return @c EINA_TRUE if @p obj widget's internal file
6753 * selector is only displaying directories, @c EINA_FALSE if files
6754 * are being displayed in it too (and on errors)
6756 * @see elm_fileselector_entry_folder_only_set() for more details
6758 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6761 * Enable/disable the file name entry box where the user can type
6762 * in a name for a file, in a given file selector entry widget's
6763 * internal file selector.
6765 * @param obj The file selector entry widget
6766 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6767 * file selector a "saving dialog", @c EINA_FALSE otherwise
6769 * This has the same effect as elm_fileselector_is_save_set(),
6770 * but now applied to a file selector entry's internal file
6773 * @see elm_fileselector_is_save_get()
6775 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6778 * Get whether the given file selector entry widget's internal
6779 * file selector is in "saving dialog" mode
6781 * @param obj The file selector entry widget
6782 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6783 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6786 * @see elm_fileselector_entry_is_save_set() for more details
6788 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6791 * Set whether a given file selector entry widget's internal file
6792 * selector will raise an Elementary "inner window", instead of a
6793 * dedicated Elementary window. By default, it won't.
6795 * @param obj The file selector entry widget
6796 * @param value @c EINA_TRUE to make it use an inner window, @c
6797 * EINA_TRUE to make it use a dedicated window
6799 * @see elm_win_inwin_add() for more information on inner windows
6800 * @see elm_fileselector_entry_inwin_mode_get()
6802 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6805 * Get whether a given file selector entry widget's internal file
6806 * selector will raise an Elementary "inner window", instead of a
6807 * dedicated Elementary window.
6809 * @param obj The file selector entry widget
6810 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6811 * if it will use a dedicated window
6813 * @see elm_fileselector_entry_inwin_mode_set() for more details
6815 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6818 * Set the initial file system path for a given file selector entry
6821 * @param obj The file selector entry widget
6822 * @param path The path string
6824 * It must be a <b>directory</b> path, which will have the contents
6825 * displayed initially in the file selector's view, when invoked
6826 * from @p obj. The default initial path is the @c "HOME"
6827 * environment variable's value.
6829 * @see elm_fileselector_entry_path_get()
6831 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6834 * Get the parent directory's path to the latest file selection on
6835 * a given filer selector entry widget
6837 * @param obj The file selector object
6838 * @return The (full) path of the directory of the last selection
6839 * on @p obj widget, a @b stringshared string
6841 * @see elm_fileselector_entry_path_set()
6843 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6850 * @defgroup Scroller Scroller
6852 * A scroller holds a single object and "scrolls it around". This means that
6853 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6854 * region around, allowing to move through a much larger object that is
6855 * contained in the scroller. The scroiller will always have a small minimum
6856 * size by default as it won't be limited by the contents of the scroller.
6858 * Signals that you can add callbacks for are:
6859 * @li "edge,left" - the left edge of the content has been reached
6860 * @li "edge,right" - the right edge of the content has been reached
6861 * @li "edge,top" - the top edge of the content has been reached
6862 * @li "edge,bottom" - the bottom edge of the content has been reached
6863 * @li "scroll" - the content has been scrolled (moved)
6864 * @li "scroll,anim,start" - scrolling animation has started
6865 * @li "scroll,anim,stop" - scrolling animation has stopped
6866 * @li "scroll,drag,start" - dragging the contents around has started
6867 * @li "scroll,drag,stop" - dragging the contents around has stopped
6868 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6871 * @note When Elemementary is in embedded mode the scrollbars will not be
6872 * dragable, they appear merely as indicators of how much has been scrolled.
6873 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6874 * fingerscroll) won't work.
6876 * In @ref tutorial_scroller you'll find an example of how to use most of
6881 * @brief Type that controls when scrollbars should appear.
6883 * @see elm_scroller_policy_set()
6885 typedef enum _Elm_Scroller_Policy
6887 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6888 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6889 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6890 ELM_SCROLLER_POLICY_LAST
6891 } Elm_Scroller_Policy;
6893 * @brief Add a new scroller to the parent
6895 * @param parent The parent object
6896 * @return The new object or NULL if it cannot be created
6898 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6900 * @brief Set the content of the scroller widget (the object to be scrolled around).
6902 * @param obj The scroller object
6903 * @param content The new content object
6905 * Once the content object is set, a previously set one will be deleted.
6906 * If you want to keep that old content object, use the
6907 * elm_scroller_content_unset() function.
6909 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6911 * @brief Get the content of the scroller widget
6913 * @param obj The slider object
6914 * @return The content that is being used
6916 * Return the content object which is set for this widget
6918 * @see elm_scroller_content_set()
6920 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6922 * @brief Unset the content of the scroller widget
6924 * @param obj The slider object
6925 * @return The content that was being used
6927 * Unparent and return the content object which was set for this widget
6929 * @see elm_scroller_content_set()
6931 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6933 * @brief Set custom theme elements for the scroller
6935 * @param obj The scroller object
6936 * @param widget The widget name to use (default is "scroller")
6937 * @param base The base name to use (default is "base")
6939 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6941 * @brief Make the scroller minimum size limited to the minimum size of the content
6943 * @param obj The scroller object
6944 * @param w Enable limiting minimum size horizontally
6945 * @param h Enable limiting minimum size vertically
6947 * By default the scroller will be as small as its design allows,
6948 * irrespective of its content. This will make the scroller minimum size the
6949 * right size horizontally and/or vertically to perfectly fit its content in
6952 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6954 * @brief Show a specific virtual region within the scroller content object
6956 * @param obj The scroller object
6957 * @param x X coordinate of the region
6958 * @param y Y coordinate of the region
6959 * @param w Width of the region
6960 * @param h Height of the region
6962 * This will ensure all (or part if it does not fit) of the designated
6963 * region in the virtual content object (0, 0 starting at the top-left of the
6964 * virtual content object) is shown within the scroller.
6966 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);
6968 * @brief Set the scrollbar visibility policy
6970 * @param obj The scroller object
6971 * @param policy_h Horizontal scrollbar policy
6972 * @param policy_v Vertical scrollbar policy
6974 * This sets the scrollbar visibility policy for the given scroller.
6975 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6976 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6977 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6978 * respectively for the horizontal and vertical scrollbars.
6980 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6982 * @brief Gets scrollbar visibility policy
6984 * @param obj The scroller object
6985 * @param policy_h Horizontal scrollbar policy
6986 * @param policy_v Vertical scrollbar policy
6988 * @see elm_scroller_policy_set()
6990 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6992 * @brief Get the currently visible content region
6994 * @param obj The scroller object
6995 * @param x X coordinate of the region
6996 * @param y Y coordinate of the region
6997 * @param w Width of the region
6998 * @param h Height of the region
7000 * This gets the current region in the content object that is visible through
7001 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7002 * w, @p h values pointed to.
7004 * @note All coordinates are relative to the content.
7006 * @see elm_scroller_region_show()
7008 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);
7010 * @brief Get the size of the content object
7012 * @param obj The scroller object
7013 * @param w Width return
7014 * @param h Height return
7016 * This gets the size of the content object of the scroller.
7018 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7020 * @brief Set bouncing behavior
7022 * @param obj The scroller object
7023 * @param h_bounce Will the scroller bounce horizontally or not
7024 * @param v_bounce Will the scroller bounce vertically or not
7026 * When scrolling, the scroller may "bounce" when reaching an edge of the
7027 * content object. This is a visual way to indicate the end has been reached.
7028 * This is enabled by default for both axis. This will set if it is enabled
7029 * for that axis with the boolean parameters for each axis.
7031 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7033 * @brief Get the bounce mode
7035 * @param obj The Scroller object
7036 * @param h_bounce Allow bounce horizontally
7037 * @param v_bounce Allow bounce vertically
7039 * @see elm_scroller_bounce_set()
7041 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7043 * @brief Set scroll page size relative to viewport size.
7045 * @param obj The scroller object
7046 * @param h_pagerel The horizontal page relative size
7047 * @param v_pagerel The vertical page relative size
7049 * The scroller is capable of limiting scrolling by the user to "pages". That
7050 * is to jump by and only show a "whole page" at a time as if the continuous
7051 * area of the scroller content is split into page sized pieces. This sets
7052 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7053 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7054 * axis. This is mutually exclusive with page size
7055 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7056 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7057 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7060 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7062 * @brief Set scroll page size.
7064 * @param obj The scroller object
7065 * @param h_pagesize The horizontal page size
7066 * @param v_pagesize The vertical page size
7068 * This sets the page size to an absolute fixed value, with 0 turning it off
7071 * @see elm_scroller_page_relative_set()
7073 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7075 * @brief Get scroll current page number.
7077 * @param obj The scroller object
7078 * @param h_pagenumber The horizontal page number
7079 * @param v_pagenumber The vertical page number
7081 * The page number starts from 0. 0 is the first page.
7082 * Current page means the page which meet the top-left of the viewport.
7083 * If there are two or more pages in the viewport, it returns the number of page
7084 * which meet the top-left of the viewport.
7086 * @see elm_scroller_last_page_get()
7087 * @see elm_scroller_page_show()
7088 * @see elm_scroller_page_brint_in()
7090 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7092 * @brief Get scroll last page number.
7094 * @param obj The scroller object
7095 * @param h_pagenumber The horizontal page number
7096 * @param v_pagenumber The vertical page number
7098 * The page number starts from 0. 0 is the first page.
7099 * This returns the last page number among the pages.
7101 * @see elm_scroller_current_page_get()
7102 * @see elm_scroller_page_show()
7103 * @see elm_scroller_page_brint_in()
7105 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7107 * Show a specific virtual region within the scroller content object by page number.
7109 * @param obj The scroller object
7110 * @param h_pagenumber The horizontal page number
7111 * @param v_pagenumber The vertical page number
7113 * 0, 0 of the indicated page is located at the top-left of the viewport.
7114 * This will jump to the page directly without animation.
7119 * sc = elm_scroller_add(win);
7120 * elm_scroller_content_set(sc, content);
7121 * elm_scroller_page_relative_set(sc, 1, 0);
7122 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7123 * elm_scroller_page_show(sc, h_page + 1, v_page);
7126 * @see elm_scroller_page_bring_in()
7128 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7130 * Show a specific virtual region within the scroller content object by page number.
7132 * @param obj The scroller object
7133 * @param h_pagenumber The horizontal page number
7134 * @param v_pagenumber The vertical page number
7136 * 0, 0 of the indicated page is located at the top-left of the viewport.
7137 * This will slide to the page with animation.
7142 * sc = elm_scroller_add(win);
7143 * elm_scroller_content_set(sc, content);
7144 * elm_scroller_page_relative_set(sc, 1, 0);
7145 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7146 * elm_scroller_page_bring_in(sc, h_page, v_page);
7149 * @see elm_scroller_page_show()
7151 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7153 * @brief Show a specific virtual region within the scroller content object.
7155 * @param obj The scroller object
7156 * @param x X coordinate of the region
7157 * @param y Y coordinate of the region
7158 * @param w Width of the region
7159 * @param h Height of the region
7161 * This will ensure all (or part if it does not fit) of the designated
7162 * region in the virtual content object (0, 0 starting at the top-left of the
7163 * virtual content object) is shown within the scroller. Unlike
7164 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7165 * to this location (if configuration in general calls for transitions). It
7166 * may not jump immediately to the new location and make take a while and
7167 * show other content along the way.
7169 * @see elm_scroller_region_show()
7171 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);
7173 * @brief Set event propagation on a scroller
7175 * @param obj The scroller object
7176 * @param propagation If propagation is enabled or not
7178 * This enables or disabled event propagation from the scroller content to
7179 * the scroller and its parent. By default event propagation is disabled.
7181 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7183 * @brief Get event propagation for a scroller
7185 * @param obj The scroller object
7186 * @return The propagation state
7188 * This gets the event propagation for a scroller.
7190 * @see elm_scroller_propagate_events_set()
7192 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7198 * @defgroup Label Label
7200 * @image html img/widget/label/preview-00.png
7201 * @image latex img/widget/label/preview-00.eps
7203 * @brief Widget to display text, with simple html-like markup.
7205 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7206 * text doesn't fit the geometry of the label it will be ellipsized or be
7207 * cut. Elementary provides several themes for this widget:
7208 * @li default - No animation
7209 * @li marker - Centers the text in the label and make it bold by default
7210 * @li slide_long - The entire text appears from the right of the screen and
7211 * slides until it disappears in the left of the screen(reappering on the
7213 * @li slide_short - The text appears in the left of the label and slides to
7214 * the right to show the overflow. When all of the text has been shown the
7215 * position is reset.
7216 * @li slide_bounce - The text appears in the left of the label and slides to
7217 * the right to show the overflow. When all of the text has been shown the
7218 * animation reverses, moving the text to the left.
7220 * Custom themes can of course invent new markup tags and style them any way
7223 * See @ref tutorial_label for a demonstration of how to use a label widget.
7227 * @brief Add a new label to the parent
7229 * @param parent The parent object
7230 * @return The new object or NULL if it cannot be created
7232 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7234 * @brief Set the label on the label object
7236 * @param obj The label object
7237 * @param label The label will be used on the label object
7238 * @deprecated See elm_object_text_set()
7240 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 */
7242 * @brief Get the label used on the label object
7244 * @param obj The label object
7245 * @return The string inside the label
7246 * @deprecated See elm_object_text_get()
7248 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7250 * @brief Set the wrapping behavior of the label
7252 * @param obj The label object
7253 * @param wrap To wrap text or not
7255 * By default no wrapping is done. Possible values for @p wrap are:
7256 * @li ELM_WRAP_NONE - No wrapping
7257 * @li ELM_WRAP_CHAR - wrap between characters
7258 * @li ELM_WRAP_WORD - wrap between words
7259 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7261 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7263 * @brief Get the wrapping behavior of the label
7265 * @param obj The label object
7268 * @see elm_label_line_wrap_set()
7270 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7272 * @brief Set wrap width of the label
7274 * @param obj The label object
7275 * @param w The wrap width in pixels at a minimum where words need to wrap
7277 * This function sets the maximum width size hint of the label.
7279 * @warning This is only relevant if the label is inside a container.
7281 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7283 * @brief Get wrap width of the label
7285 * @param obj The label object
7286 * @return The wrap width in pixels at a minimum where words need to wrap
7288 * @see elm_label_wrap_width_set()
7290 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7292 * @brief Set wrap height of the label
7294 * @param obj The label object
7295 * @param h The wrap height in pixels at a minimum where words need to wrap
7297 * This function sets the maximum height size hint of the label.
7299 * @warning This is only relevant if the label is inside a container.
7301 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7303 * @brief get wrap width of the label
7305 * @param obj The label object
7306 * @return The wrap height in pixels at a minimum where words need to wrap
7308 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7310 * @brief Set the font size on the label object.
7312 * @param obj The label object
7313 * @param size font size
7315 * @warning NEVER use this. It is for hyper-special cases only. use styles
7316 * instead. e.g. "big", "medium", "small" - or better name them by use:
7317 * "title", "footnote", "quote" etc.
7319 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7321 * @brief Set the text color on the label object
7323 * @param obj The label object
7324 * @param r Red property background color of The label object
7325 * @param g Green property background color of The label object
7326 * @param b Blue property background color of The label object
7327 * @param a Alpha property background color of The label object
7329 * @warning NEVER use this. It is for hyper-special cases only. use styles
7330 * instead. e.g. "big", "medium", "small" - or better name them by use:
7331 * "title", "footnote", "quote" etc.
7333 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);
7335 * @brief Set the text align on the label object
7337 * @param obj The label object
7338 * @param align align mode ("left", "center", "right")
7340 * @warning NEVER use this. It is for hyper-special cases only. use styles
7341 * instead. e.g. "big", "medium", "small" - or better name them by use:
7342 * "title", "footnote", "quote" etc.
7344 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7346 * @brief Set background color of the label
7348 * @param obj The label object
7349 * @param r Red property background color of The label object
7350 * @param g Green property background color of The label object
7351 * @param b Blue property background color of The label object
7352 * @param a Alpha property background alpha of The label object
7354 * @warning NEVER use this. It is for hyper-special cases only. use styles
7355 * instead. e.g. "big", "medium", "small" - or better name them by use:
7356 * "title", "footnote", "quote" etc.
7358 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);
7360 * @brief Set the ellipsis behavior of the label
7362 * @param obj The label object
7363 * @param ellipsis To ellipsis text or not
7365 * If set to true and the text doesn't fit in the label an ellipsis("...")
7366 * will be shown at the end of the widget.
7368 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7369 * choosen wrap method was ELM_WRAP_WORD.
7371 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7373 * @brief Set the text slide of the label
7375 * @param obj The label object
7376 * @param slide To start slide or stop
7378 * If set to true the text of the label will slide throught the length of
7381 * @warning This only work with the themes "slide_short", "slide_long" and
7384 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7386 * @brief Get the text slide mode of the label
7388 * @param obj The label object
7389 * @return slide slide mode value
7391 * @see elm_label_slide_set()
7393 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7395 * @brief Set the slide duration(speed) of the label
7397 * @param obj The label object
7398 * @return The duration in seconds in moving text from slide begin position
7399 * to slide end position
7401 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7403 * @brief Get the slide duration(speed) of the label
7405 * @param obj The label object
7406 * @return The duration time in moving text from slide begin position to slide end position
7408 * @see elm_label_slide_duration_set()
7410 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7416 * @defgroup Toggle Toggle
7418 * @image html img/widget/toggle/preview-00.png
7419 * @image latex img/widget/toggle/preview-00.eps
7421 * @brief A toggle is a slider which can be used to toggle between
7422 * two values. It has two states: on and off.
7424 * Signals that you can add callbacks for are:
7425 * @li "changed" - Whenever the toggle value has been changed. Is not called
7426 * until the toggle is released by the cursor (assuming it
7427 * has been triggered by the cursor in the first place).
7429 * @ref tutorial_toggle show how to use a toggle.
7433 * @brief Add a toggle to @p parent.
7435 * @param parent The parent object
7437 * @return The toggle object
7439 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7441 * @brief Sets the label to be displayed with the toggle.
7443 * @param obj The toggle object
7444 * @param label The label to be displayed
7446 * @deprecated use elm_object_text_set() instead.
7448 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7450 * @brief Gets the label of the toggle
7452 * @param obj toggle object
7453 * @return The label of the toggle
7455 * @deprecated use elm_object_text_get() instead.
7457 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7459 * @brief Set the icon used for the toggle
7461 * @param obj The toggle object
7462 * @param icon The icon object for the button
7464 * Once the icon object is set, a previously set one will be deleted
7465 * If you want to keep that old content object, use the
7466 * elm_toggle_icon_unset() function.
7468 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7470 * @brief Get the icon used for the toggle
7472 * @param obj The toggle object
7473 * @return The icon object that is being used
7475 * Return the icon object which is set for this widget.
7477 * @see elm_toggle_icon_set()
7479 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7481 * @brief Unset the icon used for the toggle
7483 * @param obj The toggle object
7484 * @return The icon object that was being used
7486 * Unparent and return the icon object which was set for this widget.
7488 * @see elm_toggle_icon_set()
7490 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7492 * @brief Sets the labels to be associated with the on and off states of the toggle.
7494 * @param obj The toggle object
7495 * @param onlabel The label displayed when the toggle is in the "on" state
7496 * @param offlabel The label displayed when the toggle is in the "off" state
7498 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7500 * @brief Gets the labels associated with the on and off states of the toggle.
7502 * @param obj The toggle object
7503 * @param onlabel A char** to place the onlabel of @p obj into
7504 * @param offlabel A char** to place the offlabel of @p obj into
7506 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7508 * @brief Sets the state of the toggle to @p state.
7510 * @param obj The toggle object
7511 * @param state The state of @p obj
7513 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7515 * @brief Gets the state of the toggle to @p state.
7517 * @param obj The toggle object
7518 * @return The state of @p obj
7520 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7522 * @brief Sets the state pointer of the toggle to @p statep.
7524 * @param obj The toggle object
7525 * @param statep The state pointer of @p obj
7527 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7533 * @defgroup Frame Frame
7535 * @image html img/widget/frame/preview-00.png
7536 * @image latex img/widget/frame/preview-00.eps
7538 * @brief Frame is a widget that holds some content and has a title.
7540 * The default look is a frame with a title, but Frame supports multple
7548 * @li outdent_bottom
7550 * Of all this styles only default shows the title. Frame emits no signals.
7552 * For a detailed example see the @ref tutorial_frame.
7557 * @brief Add a new frame to the parent
7559 * @param parent The parent object
7560 * @return The new object or NULL if it cannot be created
7562 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7564 * @brief Set the frame label
7566 * @param obj The frame object
7567 * @param label The label of this frame object
7569 * @deprecated use elm_object_text_set() instead.
7571 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7573 * @brief Get the frame label
7575 * @param obj The frame object
7577 * @return The label of this frame objet or NULL if unable to get frame
7579 * @deprecated use elm_object_text_get() instead.
7581 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7583 * @brief Set the content of the frame widget
7585 * Once the content object is set, a previously set one will be deleted.
7586 * If you want to keep that old content object, use the
7587 * elm_frame_content_unset() function.
7589 * @param obj The frame object
7590 * @param content The content will be filled in this frame object
7592 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7594 * @brief Get the content of the frame widget
7596 * Return the content object which is set for this widget
7598 * @param obj The frame object
7599 * @return The content that is being used
7601 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7603 * @brief Unset the content of the frame widget
7605 * Unparent and return the content object which was set for this widget
7607 * @param obj The frame object
7608 * @return The content that was being used
7610 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7616 * @defgroup Table Table
7618 * A container widget to arrange other widgets in a table where items can
7619 * also span multiple columns or rows - even overlap (and then be raised or
7620 * lowered accordingly to adjust stacking if they do overlap).
7622 * The followin are examples of how to use a table:
7623 * @li @ref tutorial_table_01
7624 * @li @ref tutorial_table_02
7629 * @brief Add a new table to the parent
7631 * @param parent The parent object
7632 * @return The new object or NULL if it cannot be created
7634 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7636 * @brief Set the homogeneous layout in the table
7638 * @param obj The layout object
7639 * @param homogeneous A boolean to set if the layout is homogeneous in the
7640 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7642 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7644 * @brief Get the current table homogeneous mode.
7646 * @param obj The table object
7647 * @return A boolean to indicating if the layout is homogeneous in the table
7648 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7650 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7652 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7654 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7656 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7658 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7660 * @brief Set padding between cells.
7662 * @param obj The layout object.
7663 * @param horizontal set the horizontal padding.
7664 * @param vertical set the vertical padding.
7666 * Default value is 0.
7668 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7670 * @brief Get padding between cells.
7672 * @param obj The layout object.
7673 * @param horizontal set the horizontal padding.
7674 * @param vertical set the vertical padding.
7676 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7678 * @brief Add a subobject on the table with the coordinates passed
7680 * @param obj The table object
7681 * @param subobj The subobject to be added to the table
7682 * @param x Row number
7683 * @param y Column number
7687 * @note All positioning inside the table is relative to rows and columns, so
7688 * a value of 0 for x and y, means the top left cell of the table, and a
7689 * value of 1 for w and h means @p subobj only takes that 1 cell.
7691 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7693 * @brief Remove child from table.
7695 * @param obj The table object
7696 * @param subobj The subobject
7698 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7700 * @brief Faster way to remove all child objects from a table object.
7702 * @param obj The table object
7703 * @param clear If true, will delete children, else just remove from table.
7705 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7707 * @brief Set the packing location of an existing child of the table
7709 * @param subobj The subobject to be modified in the table
7710 * @param x Row number
7711 * @param y Column number
7715 * Modifies the position of an object already in the table.
7717 * @note All positioning inside the table is relative to rows and columns, so
7718 * a value of 0 for x and y, means the top left cell of the table, and a
7719 * value of 1 for w and h means @p subobj only takes that 1 cell.
7721 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7723 * @brief Get the packing location of an existing child of the table
7725 * @param subobj The subobject to be modified in the table
7726 * @param x Row number
7727 * @param y Column number
7731 * @see elm_table_pack_set()
7733 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7739 * @defgroup Gengrid Gengrid (Generic grid)
7741 * This widget aims to position objects in a grid layout while
7742 * actually creating and rendering only the visible ones, using the
7743 * same idea as the @ref Genlist "genlist": the user defines a @b
7744 * class for each item, specifying functions that will be called at
7745 * object creation, deletion, etc. When those items are selected by
7746 * the user, a callback function is issued. Users may interact with
7747 * a gengrid via the mouse (by clicking on items to select them and
7748 * clicking on the grid's viewport and swiping to pan the whole
7749 * view) or via the keyboard, navigating through item with the
7752 * @section Gengrid_Layouts Gengrid layouts
7754 * Gengrids may layout its items in one of two possible layouts:
7758 * When in "horizontal mode", items will be placed in @b columns,
7759 * from top to bottom and, when the space for a column is filled,
7760 * another one is started on the right, thus expanding the grid
7761 * horizontally, making for horizontal scrolling. When in "vertical
7762 * mode" , though, items will be placed in @b rows, from left to
7763 * right and, when the space for a row is filled, another one is
7764 * started below, thus expanding the grid vertically (and making
7765 * for vertical scrolling).
7767 * @section Gengrid_Items Gengrid items
7769 * An item in a gengrid can have 0 or more text labels (they can be
7770 * regular text or textblock Evas objects - that's up to the style
7771 * to determine), 0 or more icons (which are simply objects
7772 * swallowed into the gengrid item's theming Edje object) and 0 or
7773 * more <b>boolean states</b>, which have the behavior left to the
7774 * user to define. The Edje part names for each of these properties
7775 * will be looked up, in the theme file for the gengrid, under the
7776 * Edje (string) data items named @c "labels", @c "icons" and @c
7777 * "states", respectively. For each of those properties, if more
7778 * than one part is provided, they must have names listed separated
7779 * by spaces in the data fields. For the default gengrid item
7780 * theme, we have @b one label part (@c "elm.text"), @b two icon
7781 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7784 * A gengrid item may be at one of several styles. Elementary
7785 * provides one by default - "default", but this can be extended by
7786 * system or application custom themes/overlays/extensions (see
7787 * @ref Theme "themes" for more details).
7789 * @section Gengrid_Item_Class Gengrid item classes
7791 * In order to have the ability to add and delete items on the fly,
7792 * gengrid implements a class (callback) system where the
7793 * application provides a structure with information about that
7794 * type of item (gengrid may contain multiple different items with
7795 * different classes, states and styles). Gengrid will call the
7796 * functions in this struct (methods) when an item is "realized"
7797 * (i.e., created dynamically, while the user is scrolling the
7798 * grid). All objects will simply be deleted when no longer needed
7799 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7800 * contains the following members:
7801 * - @c item_style - This is a constant string and simply defines
7802 * the name of the item style. It @b must be specified and the
7803 * default should be @c "default".
7804 * - @c func.label_get - This function is called when an item
7805 * object is actually created. The @c data parameter will point to
7806 * the same data passed to elm_gengrid_item_append() and related
7807 * item creation functions. The @c obj parameter is the gengrid
7808 * object itself, while the @c part one is the name string of one
7809 * of the existing text parts in the Edje group implementing the
7810 * item's theme. This function @b must return a strdup'()ed string,
7811 * as the caller will free() it when done. See
7812 * #Elm_Gengrid_Item_Label_Get_Cb.
7813 * - @c func.icon_get - This function is called when an item object
7814 * is actually created. The @c data parameter will point to the
7815 * same data passed to elm_gengrid_item_append() and related item
7816 * creation functions. The @c obj parameter is the gengrid object
7817 * itself, while the @c part one is the name string of one of the
7818 * existing (icon) swallow parts in the Edje group implementing the
7819 * item's theme. It must return @c NULL, when no icon is desired,
7820 * or a valid object handle, otherwise. The object will be deleted
7821 * by the gengrid on its deletion or when the item is "unrealized".
7822 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7823 * - @c func.state_get - This function is called when an item
7824 * object is actually created. The @c data parameter will point to
7825 * the same data passed to elm_gengrid_item_append() and related
7826 * item creation functions. The @c obj parameter is the gengrid
7827 * object itself, while the @c part one is the name string of one
7828 * of the state parts in the Edje group implementing the item's
7829 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7830 * true/on. Gengrids will emit a signal to its theming Edje object
7831 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7832 * "source" arguments, respectively, when the state is true (the
7833 * default is false), where @c XXX is the name of the (state) part.
7834 * See #Elm_Gengrid_Item_State_Get_Cb.
7835 * - @c func.del - This is called when elm_gengrid_item_del() is
7836 * called on an item or elm_gengrid_clear() is called on the
7837 * gengrid. This is intended for use when gengrid items are
7838 * deleted, so any data attached to the item (e.g. its data
7839 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7841 * @section Gengrid_Usage_Hints Usage hints
7843 * If the user wants to have multiple items selected at the same
7844 * time, elm_gengrid_multi_select_set() will permit it. If the
7845 * gengrid is single-selection only (the default), then
7846 * elm_gengrid_select_item_get() will return the selected item or
7847 * @c NULL, if none is selected. If the gengrid is under
7848 * multi-selection, then elm_gengrid_selected_items_get() will
7849 * return a list (that is only valid as long as no items are
7850 * modified (added, deleted, selected or unselected) of child items
7853 * If an item changes (internal (boolean) state, label or icon
7854 * changes), then use elm_gengrid_item_update() to have gengrid
7855 * update the item with the new state. A gengrid will re-"realize"
7856 * the item, thus calling the functions in the
7857 * #Elm_Gengrid_Item_Class set for that item.
7859 * To programmatically (un)select an item, use
7860 * elm_gengrid_item_selected_set(). To get its selected state use
7861 * elm_gengrid_item_selected_get(). To make an item disabled
7862 * (unable to be selected and appear differently) use
7863 * elm_gengrid_item_disabled_set() to set this and
7864 * elm_gengrid_item_disabled_get() to get the disabled state.
7866 * Grid cells will only have their selection smart callbacks called
7867 * when firstly getting selected. Any further clicks will do
7868 * nothing, unless you enable the "always select mode", with
7869 * elm_gengrid_always_select_mode_set(), thus making every click to
7870 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7871 * turn off the ability to select items entirely in the widget and
7872 * they will neither appear selected nor call the selection smart
7875 * Remember that you can create new styles and add your own theme
7876 * augmentation per application with elm_theme_extension_add(). If
7877 * you absolutely must have a specific style that overrides any
7878 * theme the user or system sets up you can use
7879 * elm_theme_overlay_add() to add such a file.
7881 * @section Gengrid_Smart_Events Gengrid smart events
7883 * Smart events that you can add callbacks for are:
7884 * - @c "activated" - The user has double-clicked or pressed
7885 * (enter|return|spacebar) on an item. The @c event_info parameter
7886 * is the gengrid item that was activated.
7887 * - @c "clicked,double" - The user has double-clicked an item.
7888 * The @c event_info parameter is the gengrid item that was double-clicked.
7889 * - @c "longpressed" - This is called when the item is pressed for a certain
7890 * amount of time. By default it's 1 second.
7891 * - @c "selected" - The user has made an item selected. The
7892 * @c event_info parameter is the gengrid item that was selected.
7893 * - @c "unselected" - The user has made an item unselected. The
7894 * @c event_info parameter is the gengrid item that was unselected.
7895 * - @c "realized" - This is called when the item in the gengrid
7896 * has its implementing Evas object instantiated, de facto. @c
7897 * event_info is the gengrid item that was created. The object
7898 * may be deleted at any time, so it is highly advised to the
7899 * caller @b not to use the object pointer returned from
7900 * elm_gengrid_item_object_get(), because it may point to freed
7902 * - @c "unrealized" - This is called when the implementing Evas
7903 * object for this item is deleted. @c event_info is the gengrid
7904 * item that was deleted.
7905 * - @c "changed" - Called when an item is added, removed, resized
7906 * or moved and when the gengrid is resized or gets "horizontal"
7908 * - @c "scroll,anim,start" - This is called when scrolling animation has
7910 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7912 * - @c "drag,start,up" - Called when the item in the gengrid has
7913 * been dragged (not scrolled) up.
7914 * - @c "drag,start,down" - Called when the item in the gengrid has
7915 * been dragged (not scrolled) down.
7916 * - @c "drag,start,left" - Called when the item in the gengrid has
7917 * been dragged (not scrolled) left.
7918 * - @c "drag,start,right" - Called when the item in the gengrid has
7919 * been dragged (not scrolled) right.
7920 * - @c "drag,stop" - Called when the item in the gengrid has
7921 * stopped being dragged.
7922 * - @c "drag" - Called when the item in the gengrid is being
7924 * - @c "scroll" - called when the content has been scrolled
7926 * - @c "scroll,drag,start" - called when dragging the content has
7928 * - @c "scroll,drag,stop" - called when dragging the content has
7930 * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
7932 * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
7933 * until the bottom edge.
7934 * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
7935 * until the left edge.
7936 * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
7937 * until the right edge.
7939 * List of gengrid examples:
7940 * @li @ref gengrid_example
7944 * @addtogroup Gengrid
7948 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7949 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7950 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7951 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7952 typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7953 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7954 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7956 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7957 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7958 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7959 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7962 * @struct _Elm_Gengrid_Item_Class
7964 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7967 struct _Elm_Gengrid_Item_Class
7969 const char *item_style;
7970 struct _Elm_Gengrid_Item_Class_Func
7972 Elm_Gengrid_Item_Label_Get_Cb label_get;
7973 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7974 Elm_Gengrid_Item_State_Get_Cb state_get;
7975 Elm_Gengrid_Item_Del_Cb del;
7977 }; /**< #Elm_Gengrid_Item_Class member definitions */
7980 * Add a new gengrid widget to the given parent Elementary
7981 * (container) object
7983 * @param parent The parent object
7984 * @return a new gengrid widget handle or @c NULL, on errors
7986 * This function inserts a new gengrid widget on the canvas.
7988 * @see elm_gengrid_item_size_set()
7989 * @see elm_gengrid_group_item_size_set()
7990 * @see elm_gengrid_horizontal_set()
7991 * @see elm_gengrid_item_append()
7992 * @see elm_gengrid_item_del()
7993 * @see elm_gengrid_clear()
7997 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8000 * Set the size for the items of a given gengrid widget
8002 * @param obj The gengrid object.
8003 * @param w The items' width.
8004 * @param h The items' height;
8006 * A gengrid, after creation, has still no information on the size
8007 * to give to each of its cells. So, you most probably will end up
8008 * with squares one @ref Fingers "finger" wide, the default
8009 * size. Use this function to force a custom size for you items,
8010 * making them as big as you wish.
8012 * @see elm_gengrid_item_size_get()
8016 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8019 * Get the size set for the items of a given gengrid widget
8021 * @param obj The gengrid object.
8022 * @param w Pointer to a variable where to store the items' width.
8023 * @param h Pointer to a variable where to store the items' height.
8025 * @note Use @c NULL pointers on the size values you're not
8026 * interested in: they'll be ignored by the function.
8028 * @see elm_gengrid_item_size_get() for more details
8032 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8035 * Set the size for the group items of a given gengrid widget
8037 * @param obj The gengrid object.
8038 * @param w The group items' width.
8039 * @param h The group items' height;
8041 * A gengrid, after creation, has still no information on the size
8042 * to give to each of its cells. So, you most probably will end up
8043 * with squares one @ref Fingers "finger" wide, the default
8044 * size. Use this function to force a custom size for you group items,
8045 * making them as big as you wish.
8047 * @see elm_gengrid_group_item_size_get()
8051 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8054 * Get the size set for the group items of a given gengrid widget
8056 * @param obj The gengrid object.
8057 * @param w Pointer to a variable where to store the group items' width.
8058 * @param h Pointer to a variable where to store the group items' height.
8060 * @note Use @c NULL pointers on the size values you're not
8061 * interested in: they'll be ignored by the function.
8063 * @see elm_gengrid_group_item_size_get() for more details
8067 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8070 * Set the items grid's alignment within a given gengrid widget
8072 * @param obj The gengrid object.
8073 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8074 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8076 * This sets the alignment of the whole grid of items of a gengrid
8077 * within its given viewport. By default, those values are both
8078 * 0.5, meaning that the gengrid will have its items grid placed
8079 * exactly in the middle of its viewport.
8081 * @note If given alignment values are out of the cited ranges,
8082 * they'll be changed to the nearest boundary values on the valid
8085 * @see elm_gengrid_align_get()
8089 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8092 * Get the items grid's alignment values within a given gengrid
8095 * @param obj The gengrid object.
8096 * @param align_x Pointer to a variable where to store the
8097 * horizontal alignment.
8098 * @param align_y Pointer to a variable where to store the vertical
8101 * @note Use @c NULL pointers on the alignment values you're not
8102 * interested in: they'll be ignored by the function.
8104 * @see elm_gengrid_align_set() for more details
8108 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8111 * Set whether a given gengrid widget is or not able have items
8114 * @param obj The gengrid object
8115 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8116 * @c EINA_FALSE to turn it off
8118 * If a gengrid is set to allow reordering, a click held for more
8119 * than 0.5 over a given item will highlight it specially,
8120 * signalling the gengrid has entered the reordering state. From
8121 * that time on, the user will be able to, while still holding the
8122 * mouse button down, move the item freely in the gengrid's
8123 * viewport, replacing to said item to the locations it goes to.
8124 * The replacements will be animated and, whenever the user
8125 * releases the mouse button, the item being replaced gets a new
8126 * definitive place in the grid.
8128 * @see elm_gengrid_reorder_mode_get()
8132 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8135 * Get whether a given gengrid widget is or not able have items
8138 * @param obj The gengrid object
8139 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8142 * @see elm_gengrid_reorder_mode_set() for more details
8146 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8149 * Append a new item in a given gengrid widget.
8151 * @param obj The gengrid object.
8152 * @param gic The item class for the item.
8153 * @param data The item data.
8154 * @param func Convenience function called when the item is
8156 * @param func_data Data to be passed to @p func.
8157 * @return A handle to the item added or @c NULL, on errors.
8159 * This adds an item to the beginning of the gengrid.
8161 * @see elm_gengrid_item_prepend()
8162 * @see elm_gengrid_item_insert_before()
8163 * @see elm_gengrid_item_insert_after()
8164 * @see elm_gengrid_item_del()
8168 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);
8171 * Prepend a new item in a given gengrid widget.
8173 * @param obj The gengrid object.
8174 * @param gic The item class for the item.
8175 * @param data The item data.
8176 * @param func Convenience function called when the item is
8178 * @param func_data Data to be passed to @p func.
8179 * @return A handle to the item added or @c NULL, on errors.
8181 * This adds an item to the end of the gengrid.
8183 * @see elm_gengrid_item_append()
8184 * @see elm_gengrid_item_insert_before()
8185 * @see elm_gengrid_item_insert_after()
8186 * @see elm_gengrid_item_del()
8190 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);
8193 * Insert an item before another in a gengrid widget
8195 * @param obj The gengrid object.
8196 * @param gic The item class for the item.
8197 * @param data The item data.
8198 * @param relative The item to place this new one before.
8199 * @param func Convenience function called when the item is
8201 * @param func_data Data to be passed to @p func.
8202 * @return A handle to the item added or @c NULL, on errors.
8204 * This inserts an item before another in the gengrid.
8206 * @see elm_gengrid_item_append()
8207 * @see elm_gengrid_item_prepend()
8208 * @see elm_gengrid_item_insert_after()
8209 * @see elm_gengrid_item_del()
8213 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);
8216 * Insert an item after another in a gengrid widget
8218 * @param obj The gengrid object.
8219 * @param gic The item class for the item.
8220 * @param data The item data.
8221 * @param relative The item to place this new one after.
8222 * @param func Convenience function called when the item is
8224 * @param func_data Data to be passed to @p func.
8225 * @return A handle to the item added or @c NULL, on errors.
8227 * This inserts an item after another in the gengrid.
8229 * @see elm_gengrid_item_append()
8230 * @see elm_gengrid_item_prepend()
8231 * @see elm_gengrid_item_insert_after()
8232 * @see elm_gengrid_item_del()
8236 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);
8238 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);
8240 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);
8243 * Set whether items on a given gengrid widget are to get their
8244 * selection callbacks issued for @b every subsequent selection
8245 * click on them or just for the first click.
8247 * @param obj The gengrid object
8248 * @param always_select @c EINA_TRUE to make items "always
8249 * selected", @c EINA_FALSE, otherwise
8251 * By default, grid items will only call their selection callback
8252 * function when firstly getting selected, any subsequent further
8253 * clicks will do nothing. With this call, you make those
8254 * subsequent clicks also to issue the selection callbacks.
8256 * @note <b>Double clicks</b> will @b always be reported on items.
8258 * @see elm_gengrid_always_select_mode_get()
8262 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8265 * Get whether items on a given gengrid widget have their selection
8266 * callbacks issued for @b every subsequent selection click on them
8267 * or just for the first click.
8269 * @param obj The gengrid object.
8270 * @return @c EINA_TRUE if the gengrid items are "always selected",
8271 * @c EINA_FALSE, otherwise
8273 * @see elm_gengrid_always_select_mode_set() for more details
8277 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8280 * Set whether items on a given gengrid widget can be selected or not.
8282 * @param obj The gengrid object
8283 * @param no_select @c EINA_TRUE to make items selectable,
8284 * @c EINA_FALSE otherwise
8286 * This will make items in @p obj selectable or not. In the latter
8287 * case, any user interaction on the gengrid items will neither make
8288 * them appear selected nor them call their selection callback
8291 * @see elm_gengrid_no_select_mode_get()
8295 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8298 * Get whether items on a given gengrid widget can be selected or
8301 * @param obj The gengrid object
8302 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8305 * @see elm_gengrid_no_select_mode_set() for more details
8309 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8312 * Enable or disable multi-selection in a given gengrid widget
8314 * @param obj The gengrid object.
8315 * @param multi @c EINA_TRUE, to enable multi-selection,
8316 * @c EINA_FALSE to disable it.
8318 * Multi-selection is the ability for one to have @b more than one
8319 * item selected, on a given gengrid, simultaneously. When it is
8320 * enabled, a sequence of clicks on different items will make them
8321 * all selected, progressively. A click on an already selected item
8322 * will unselect it. If interecting via the keyboard,
8323 * multi-selection is enabled while holding the "Shift" key.
8325 * @note By default, multi-selection is @b disabled on gengrids
8327 * @see elm_gengrid_multi_select_get()
8331 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8334 * Get whether multi-selection is enabled or disabled for a given
8337 * @param obj The gengrid object.
8338 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8339 * EINA_FALSE otherwise
8341 * @see elm_gengrid_multi_select_set() for more details
8345 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8348 * Enable or disable bouncing effect for a given gengrid widget
8350 * @param obj The gengrid object
8351 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8352 * @c EINA_FALSE to disable it
8353 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8354 * @c EINA_FALSE to disable it
8356 * The bouncing effect occurs whenever one reaches the gengrid's
8357 * edge's while panning it -- it will scroll past its limits a
8358 * little bit and return to the edge again, in a animated for,
8361 * @note By default, gengrids have bouncing enabled on both axis
8363 * @see elm_gengrid_bounce_get()
8367 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8370 * Get whether bouncing effects are enabled or disabled, for a
8371 * given gengrid widget, on each axis
8373 * @param obj The gengrid object
8374 * @param h_bounce Pointer to a variable where to store the
8375 * horizontal bouncing flag.
8376 * @param v_bounce Pointer to a variable where to store the
8377 * vertical bouncing flag.
8379 * @see elm_gengrid_bounce_set() for more details
8383 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8386 * Set a given gengrid widget's scrolling page size, relative to
8387 * its viewport size.
8389 * @param obj The gengrid object
8390 * @param h_pagerel The horizontal page (relative) size
8391 * @param v_pagerel The vertical page (relative) size
8393 * The gengrid's scroller is capable of binding scrolling by the
8394 * user to "pages". It means that, while scrolling and, specially
8395 * after releasing the mouse button, the grid will @b snap to the
8396 * nearest displaying page's area. When page sizes are set, the
8397 * grid's continuous content area is split into (equal) page sized
8400 * This function sets the size of a page <b>relatively to the
8401 * viewport dimensions</b> of the gengrid, for each axis. A value
8402 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8403 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8404 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8405 * 1.0. Values beyond those will make it behave behave
8406 * inconsistently. If you only want one axis to snap to pages, use
8407 * the value @c 0.0 for the other one.
8409 * There is a function setting page size values in @b absolute
8410 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8411 * is mutually exclusive to this one.
8413 * @see elm_gengrid_page_relative_get()
8417 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8420 * Get a given gengrid widget's scrolling page size, relative to
8421 * its viewport size.
8423 * @param obj The gengrid object
8424 * @param h_pagerel Pointer to a variable where to store the
8425 * horizontal page (relative) size
8426 * @param v_pagerel Pointer to a variable where to store the
8427 * vertical page (relative) size
8429 * @see elm_gengrid_page_relative_set() for more details
8433 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8436 * Set a given gengrid widget's scrolling page size
8438 * @param obj The gengrid object
8439 * @param h_pagerel The horizontal page size, in pixels
8440 * @param v_pagerel The vertical page size, in pixels
8442 * The gengrid's scroller is capable of binding scrolling by the
8443 * user to "pages". It means that, while scrolling and, specially
8444 * after releasing the mouse button, the grid will @b snap to the
8445 * nearest displaying page's area. When page sizes are set, the
8446 * grid's continuous content area is split into (equal) page sized
8449 * This function sets the size of a page of the gengrid, in pixels,
8450 * for each axis. Sane usable values are, between @c 0 and the
8451 * dimensions of @p obj, for each axis. Values beyond those will
8452 * make it behave behave inconsistently. If you only want one axis
8453 * to snap to pages, use the value @c 0 for the other one.
8455 * There is a function setting page size values in @b relative
8456 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8457 * use is mutually exclusive to this one.
8461 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8464 * @brief Get gengrid current page number.
8466 * @param obj The gengrid object
8467 * @param h_pagenumber The horizontal page number
8468 * @param v_pagenumber The vertical page number
8470 * The page number starts from 0. 0 is the first page.
8471 * Current page means the page which meet the top-left of the viewport.
8472 * If there are two or more pages in the viewport, it returns the number of page
8473 * which meet the top-left of the viewport.
8475 * @see elm_gengrid_last_page_get()
8476 * @see elm_gengrid_page_show()
8477 * @see elm_gengrid_page_brint_in()
8479 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8482 * @brief Get scroll last page number.
8484 * @param obj The gengrid object
8485 * @param h_pagenumber The horizontal page number
8486 * @param v_pagenumber The vertical page number
8488 * The page number starts from 0. 0 is the first page.
8489 * This returns the last page number among the pages.
8491 * @see elm_gengrid_current_page_get()
8492 * @see elm_gengrid_page_show()
8493 * @see elm_gengrid_page_brint_in()
8495 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8498 * Show a specific virtual region within the gengrid content object by page number.
8500 * @param obj The gengrid object
8501 * @param h_pagenumber The horizontal page number
8502 * @param v_pagenumber The vertical page number
8504 * 0, 0 of the indicated page is located at the top-left of the viewport.
8505 * This will jump to the page directly without animation.
8510 * sc = elm_gengrid_add(win);
8511 * elm_gengrid_content_set(sc, content);
8512 * elm_gengrid_page_relative_set(sc, 1, 0);
8513 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8514 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8517 * @see elm_gengrid_page_bring_in()
8519 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8522 * Show a specific virtual region within the gengrid content object by page number.
8524 * @param obj The gengrid object
8525 * @param h_pagenumber The horizontal page number
8526 * @param v_pagenumber The vertical page number
8528 * 0, 0 of the indicated page is located at the top-left of the viewport.
8529 * This will slide to the page with animation.
8534 * sc = elm_gengrid_add(win);
8535 * elm_gengrid_content_set(sc, content);
8536 * elm_gengrid_page_relative_set(sc, 1, 0);
8537 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8538 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8541 * @see elm_gengrid_page_show()
8543 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8546 * Set for what direction a given gengrid widget will expand while
8547 * placing its items.
8549 * @param obj The gengrid object.
8550 * @param setting @c EINA_TRUE to make the gengrid expand
8551 * horizontally, @c EINA_FALSE to expand vertically.
8553 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8554 * in @b columns, from top to bottom and, when the space for a
8555 * column is filled, another one is started on the right, thus
8556 * expanding the grid horizontally. When in "vertical mode"
8557 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8558 * to right and, when the space for a row is filled, another one is
8559 * started below, thus expanding the grid vertically.
8561 * @see elm_gengrid_horizontal_get()
8565 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8568 * Get for what direction a given gengrid widget will expand while
8569 * placing its items.
8571 * @param obj The gengrid object.
8572 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8573 * @c EINA_FALSE if it's set to expand vertically.
8575 * @see elm_gengrid_horizontal_set() for more detais
8579 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8582 * Get the first item in a given gengrid widget
8584 * @param obj The gengrid object
8585 * @return The first item's handle or @c NULL, if there are no
8586 * items in @p obj (and on errors)
8588 * This returns the first item in the @p obj's internal list of
8591 * @see elm_gengrid_last_item_get()
8595 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8598 * Get the last item in a given gengrid widget
8600 * @param obj The gengrid object
8601 * @return The last item's handle or @c NULL, if there are no
8602 * items in @p obj (and on errors)
8604 * This returns the last item in the @p obj's internal list of
8607 * @see elm_gengrid_first_item_get()
8611 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8614 * Get the @b next item in a gengrid widget's internal list of items,
8615 * given a handle to one of those items.
8617 * @param item The gengrid item to fetch next from
8618 * @return The item after @p item, or @c NULL if there's none (and
8621 * This returns the item placed after the @p item, on the container
8624 * @see elm_gengrid_item_prev_get()
8628 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8631 * Get the @b previous item in a gengrid widget's internal list of items,
8632 * given a handle to one of those items.
8634 * @param item The gengrid item to fetch previous from
8635 * @return The item before @p item, or @c NULL if there's none (and
8638 * This returns the item placed before the @p item, on the container
8641 * @see elm_gengrid_item_next_get()
8645 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8648 * Get the gengrid object's handle which contains a given gengrid
8651 * @param item The item to fetch the container from
8652 * @return The gengrid (parent) object
8654 * This returns the gengrid object itself that an item belongs to.
8658 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8661 * Remove a gengrid item from the its parent, deleting it.
8663 * @param item The item to be removed.
8664 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8666 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8671 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8674 * Update the contents of a given gengrid item
8676 * @param item The gengrid item
8678 * This updates an item by calling all the item class functions
8679 * again to get the icons, labels and states. Use this when the
8680 * original item data has changed and you want thta changes to be
8685 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8686 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8687 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8690 * Return the data associated to a given gengrid item
8692 * @param item The gengrid item.
8693 * @return the data associated to this item.
8695 * This returns the @c data value passed on the
8696 * elm_gengrid_item_append() and related item addition calls.
8698 * @see elm_gengrid_item_append()
8699 * @see elm_gengrid_item_data_set()
8703 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8706 * Set the data associated to a given gengrid item
8708 * @param item The gengrid item
8709 * @param data The new data pointer to set on it
8711 * This @b overrides the @c data value passed on the
8712 * elm_gengrid_item_append() and related item addition calls. This
8713 * function @b won't call elm_gengrid_item_update() automatically,
8714 * so you'd issue it afterwards if you want to hove the item
8715 * updated to reflect the that new data.
8717 * @see elm_gengrid_item_data_get()
8721 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8724 * Get a given gengrid item's position, relative to the whole
8725 * gengrid's grid area.
8727 * @param item The Gengrid item.
8728 * @param x Pointer to variable where to store the item's <b>row
8730 * @param y Pointer to variable where to store the item's <b>column
8733 * This returns the "logical" position of the item whithin the
8734 * gengrid. For example, @c (0, 1) would stand for first row,
8739 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8742 * Set whether a given gengrid item is selected or not
8744 * @param item The gengrid item
8745 * @param selected Use @c EINA_TRUE, to make it selected, @c
8746 * EINA_FALSE to make it unselected
8748 * This sets the selected state of an item. If multi selection is
8749 * not enabled on the containing gengrid and @p selected is @c
8750 * EINA_TRUE, any other previously selected items will get
8751 * unselected in favor of this new one.
8753 * @see elm_gengrid_item_selected_get()
8757 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8760 * Get whether a given gengrid item is selected or not
8762 * @param item The gengrid item
8763 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8765 * @see elm_gengrid_item_selected_set() for more details
8769 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8772 * Get the real Evas object created to implement the view of a
8773 * given gengrid item
8775 * @param item The gengrid item.
8776 * @return the Evas object implementing this item's view.
8778 * This returns the actual Evas object used to implement the
8779 * specified gengrid item's view. This may be @c NULL, as it may
8780 * not have been created or may have been deleted, at any time, by
8781 * the gengrid. <b>Do not modify this object</b> (move, resize,
8782 * show, hide, etc.), as the gengrid is controlling it. This
8783 * function is for querying, emitting custom signals or hooking
8784 * lower level callbacks for events on that object. Do not delete
8785 * this object under any circumstances.
8787 * @see elm_gengrid_item_data_get()
8791 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8794 * Show the portion of a gengrid's internal grid containing a given
8795 * item, @b immediately.
8797 * @param item The item to display
8799 * This causes gengrid to @b redraw its viewport's contents to the
8800 * region contining the given @p item item, if it is not fully
8803 * @see elm_gengrid_item_bring_in()
8807 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8810 * Animatedly bring in, to the visible are of a gengrid, a given
8813 * @param item The gengrid item to display
8815 * This causes gengrig to jump to the given @p item item and show
8816 * it (by scrolling), if it is not fully visible. This will use
8817 * animation to do so and take a period of time to complete.
8819 * @see elm_gengrid_item_show()
8823 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8826 * Set whether a given gengrid item is disabled or not.
8828 * @param item The gengrid item
8829 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8830 * to enable it back.
8832 * A disabled item cannot be selected or unselected. It will also
8833 * change its appearance, to signal the user it's disabled.
8835 * @see elm_gengrid_item_disabled_get()
8839 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8842 * Get whether a given gengrid item is disabled or not.
8844 * @param item The gengrid item
8845 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8848 * @see elm_gengrid_item_disabled_set() for more details
8852 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8855 * Set the text to be shown in a given gengrid item's tooltips.
8857 * @param item The gengrid item
8858 * @param text The text to set in the content
8860 * This call will setup the text to be used as tooltip to that item
8861 * (analogous to elm_object_tooltip_text_set(), but being item
8862 * tooltips with higher precedence than object tooltips). It can
8863 * have only one tooltip at a time, so any previous tooltip data
8868 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8871 * Set the content to be shown in a given gengrid item's tooltips
8873 * @param item The gengrid item.
8874 * @param func The function returning the tooltip contents.
8875 * @param data What to provide to @a func as callback data/context.
8876 * @param del_cb Called when data is not needed anymore, either when
8877 * another callback replaces @p func, the tooltip is unset with
8878 * elm_gengrid_item_tooltip_unset() or the owner @p item
8879 * dies. This callback receives as its first parameter the
8880 * given @p data, being @c event_info the item handle.
8882 * This call will setup the tooltip's contents to @p item
8883 * (analogous to elm_object_tooltip_content_cb_set(), but being
8884 * item tooltips with higher precedence than object tooltips). It
8885 * can have only one tooltip at a time, so any previous tooltip
8886 * content will get removed. @p func (with @p data) will be called
8887 * every time Elementary needs to show the tooltip and it should
8888 * return a valid Evas object, which will be fully managed by the
8889 * tooltip system, getting deleted when the tooltip is gone.
8893 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);
8896 * Unset a tooltip from a given gengrid item
8898 * @param item gengrid item to remove a previously set tooltip from.
8900 * This call removes any tooltip set on @p item. The callback
8901 * provided as @c del_cb to
8902 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8903 * notify it is not used anymore (and have resources cleaned, if
8906 * @see elm_gengrid_item_tooltip_content_cb_set()
8910 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8913 * Set a different @b style for a given gengrid item's tooltip.
8915 * @param item gengrid item with tooltip set
8916 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8917 * "default", @c "transparent", etc)
8919 * Tooltips can have <b>alternate styles</b> to be displayed on,
8920 * which are defined by the theme set on Elementary. This function
8921 * works analogously as elm_object_tooltip_style_set(), but here
8922 * applied only to gengrid item objects. The default style for
8923 * tooltips is @c "default".
8925 * @note before you set a style you should define a tooltip with
8926 * elm_gengrid_item_tooltip_content_cb_set() or
8927 * elm_gengrid_item_tooltip_text_set()
8929 * @see elm_gengrid_item_tooltip_style_get()
8933 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8936 * Get the style set a given gengrid item's tooltip.
8938 * @param item gengrid item with tooltip already set on.
8939 * @return style the theme style in use, which defaults to
8940 * "default". If the object does not have a tooltip set,
8941 * then @c NULL is returned.
8943 * @see elm_gengrid_item_tooltip_style_set() for more details
8947 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8949 * @brief Disable size restrictions on an object's tooltip
8950 * @param item The tooltip's anchor object
8951 * @param disable If EINA_TRUE, size restrictions are disabled
8952 * @return EINA_FALSE on failure, EINA_TRUE on success
8954 * This function allows a tooltip to expand beyond its parant window's canvas.
8955 * It will instead be limited only by the size of the display.
8957 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8959 * @brief Retrieve size restriction state of an object's tooltip
8960 * @param item The tooltip's anchor object
8961 * @return If EINA_TRUE, size restrictions are disabled
8963 * This function returns whether a tooltip is allowed to expand beyond
8964 * its parant window's canvas.
8965 * It will instead be limited only by the size of the display.
8967 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8969 * Set the type of mouse pointer/cursor decoration to be shown,
8970 * when the mouse pointer is over the given gengrid widget item
8972 * @param item gengrid item to customize cursor on
8973 * @param cursor the cursor type's name
8975 * This function works analogously as elm_object_cursor_set(), but
8976 * here the cursor's changing area is restricted to the item's
8977 * area, and not the whole widget's. Note that that item cursors
8978 * have precedence over widget cursors, so that a mouse over @p
8979 * item will always show cursor @p type.
8981 * If this function is called twice for an object, a previously set
8982 * cursor will be unset on the second call.
8984 * @see elm_object_cursor_set()
8985 * @see elm_gengrid_item_cursor_get()
8986 * @see elm_gengrid_item_cursor_unset()
8990 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8993 * Get the type of mouse pointer/cursor decoration set to be shown,
8994 * when the mouse pointer is over the given gengrid widget item
8996 * @param item gengrid item with custom cursor set
8997 * @return the cursor type's name or @c NULL, if no custom cursors
8998 * were set to @p item (and on errors)
9000 * @see elm_object_cursor_get()
9001 * @see elm_gengrid_item_cursor_set() for more details
9002 * @see elm_gengrid_item_cursor_unset()
9006 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9009 * Unset any custom mouse pointer/cursor decoration set to be
9010 * shown, when the mouse pointer is over the given gengrid widget
9011 * item, thus making it show the @b default cursor again.
9013 * @param item a gengrid item
9015 * Use this call to undo any custom settings on this item's cursor
9016 * decoration, bringing it back to defaults (no custom style set).
9018 * @see elm_object_cursor_unset()
9019 * @see elm_gengrid_item_cursor_set() for more details
9023 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9026 * Set a different @b style for a given custom cursor set for a
9029 * @param item gengrid item with custom cursor set
9030 * @param style the <b>theme style</b> to use (e.g. @c "default",
9031 * @c "transparent", etc)
9033 * This function only makes sense when one is using custom mouse
9034 * cursor decorations <b>defined in a theme file</b> , which can
9035 * have, given a cursor name/type, <b>alternate styles</b> on
9036 * it. It works analogously as elm_object_cursor_style_set(), but
9037 * here applied only to gengrid item objects.
9039 * @warning Before you set a cursor style you should have defined a
9040 * custom cursor previously on the item, with
9041 * elm_gengrid_item_cursor_set()
9043 * @see elm_gengrid_item_cursor_engine_only_set()
9044 * @see elm_gengrid_item_cursor_style_get()
9048 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9051 * Get the current @b style set for a given gengrid item's custom
9054 * @param item gengrid item with custom cursor set.
9055 * @return style the cursor style in use. If the object does not
9056 * have a cursor set, then @c NULL is returned.
9058 * @see elm_gengrid_item_cursor_style_set() for more details
9062 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9065 * Set if the (custom) cursor for a given gengrid item should be
9066 * searched in its theme, also, or should only rely on the
9069 * @param item item with custom (custom) cursor already set on
9070 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9071 * only on those provided by the rendering engine, @c EINA_FALSE to
9072 * have them searched on the widget's theme, as well.
9074 * @note This call is of use only if you've set a custom cursor
9075 * for gengrid items, with elm_gengrid_item_cursor_set().
9077 * @note By default, cursors will only be looked for between those
9078 * provided by the rendering engine.
9082 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9085 * Get if the (custom) cursor for a given gengrid item is being
9086 * searched in its theme, also, or is only relying on the rendering
9089 * @param item a gengrid item
9090 * @return @c EINA_TRUE, if cursors are being looked for only on
9091 * those provided by the rendering engine, @c EINA_FALSE if they
9092 * are being searched on the widget's theme, as well.
9094 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9098 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9101 * Remove all items from a given gengrid widget
9103 * @param obj The gengrid object.
9105 * This removes (and deletes) all items in @p obj, leaving it
9108 * @see elm_gengrid_item_del(), to remove just one item.
9112 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9115 * Get the selected item in a given gengrid widget
9117 * @param obj The gengrid object.
9118 * @return The selected item's handleor @c NULL, if none is
9119 * selected at the moment (and on errors)
9121 * This returns the selected item in @p obj. If multi selection is
9122 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9123 * the first item in the list is selected, which might not be very
9124 * useful. For that case, see elm_gengrid_selected_items_get().
9128 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9131 * Get <b>a list</b> of selected items in a given gengrid
9133 * @param obj The gengrid object.
9134 * @return The list of selected items or @c NULL, if none is
9135 * selected at the moment (and on errors)
9137 * This returns a list of the selected items, in the order that
9138 * they appear in the grid. This list is only valid as long as no
9139 * more items are selected or unselected (or unselected implictly
9140 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9143 * @see elm_gengrid_selected_item_get()
9147 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9154 * @defgroup Clock Clock
9156 * @image html img/widget/clock/preview-00.png
9157 * @image latex img/widget/clock/preview-00.eps
9159 * This is a @b digital clock widget. In its default theme, it has a
9160 * vintage "flipping numbers clock" appearance, which will animate
9161 * sheets of individual algarisms individually as time goes by.
9163 * A newly created clock will fetch system's time (already
9164 * considering local time adjustments) to start with, and will tick
9165 * accondingly. It may or may not show seconds.
9167 * Clocks have an @b edition mode. When in it, the sheets will
9168 * display extra arrow indications on the top and bottom and the
9169 * user may click on them to raise or lower the time values. After
9170 * it's told to exit edition mode, it will keep ticking with that
9171 * new time set (it keeps the difference from local time).
9173 * Also, when under edition mode, user clicks on the cited arrows
9174 * which are @b held for some time will make the clock to flip the
9175 * sheet, thus editing the time, continuosly and automatically for
9176 * the user. The interval between sheet flips will keep growing in
9177 * time, so that it helps the user to reach a time which is distant
9180 * The time display is, by default, in military mode (24h), but an
9181 * am/pm indicator may be optionally shown, too, when it will
9184 * Smart callbacks one can register to:
9185 * - "changed" - the clock's user changed the time
9187 * Here is an example on its usage:
9188 * @li @ref clock_example
9197 * Identifiers for which clock digits should be editable, when a
9198 * clock widget is in edition mode. Values may be ORed together to
9199 * make a mask, naturally.
9201 * @see elm_clock_edit_set()
9202 * @see elm_clock_digit_edit_set()
9204 typedef enum _Elm_Clock_Digedit
9206 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9207 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9208 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9209 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9210 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9211 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9212 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9213 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9214 } Elm_Clock_Digedit;
9217 * Add a new clock widget to the given parent Elementary
9218 * (container) object
9220 * @param parent The parent object
9221 * @return a new clock widget handle or @c NULL, on errors
9223 * This function inserts a new clock widget on the canvas.
9227 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9230 * Set a clock widget's time, programmatically
9232 * @param obj The clock widget object
9233 * @param hrs The hours to set
9234 * @param min The minutes to set
9235 * @param sec The secondes to set
9237 * This function updates the time that is showed by the clock
9240 * Values @b must be set within the following ranges:
9241 * - 0 - 23, for hours
9242 * - 0 - 59, for minutes
9243 * - 0 - 59, for seconds,
9245 * even if the clock is not in "military" mode.
9247 * @warning The behavior for values set out of those ranges is @b
9252 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9255 * Get a clock widget's time values
9257 * @param obj The clock object
9258 * @param[out] hrs Pointer to the variable to get the hours value
9259 * @param[out] min Pointer to the variable to get the minutes value
9260 * @param[out] sec Pointer to the variable to get the seconds value
9262 * This function gets the time set for @p obj, returning
9263 * it on the variables passed as the arguments to function
9265 * @note Use @c NULL pointers on the time values you're not
9266 * interested in: they'll be ignored by the function.
9270 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9273 * Set whether a given clock widget is under <b>edition mode</b> or
9274 * under (default) displaying-only mode.
9276 * @param obj The clock object
9277 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9278 * put it back to "displaying only" mode
9280 * This function makes a clock's time to be editable or not <b>by
9281 * user interaction</b>. When in edition mode, clocks @b stop
9282 * ticking, until one brings them back to canonical mode. The
9283 * elm_clock_digit_edit_set() function will influence which digits
9284 * of the clock will be editable. By default, all of them will be
9285 * (#ELM_CLOCK_NONE).
9287 * @note am/pm sheets, if being shown, will @b always be editable
9288 * under edition mode.
9290 * @see elm_clock_edit_get()
9294 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9297 * Retrieve whether a given clock widget is under <b>edition
9298 * mode</b> or under (default) displaying-only mode.
9300 * @param obj The clock object
9301 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9304 * This function retrieves whether the clock's time can be edited
9305 * or not by user interaction.
9307 * @see elm_clock_edit_set() for more details
9311 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9314 * Set what digits of the given clock widget should be editable
9315 * when in edition mode.
9317 * @param obj The clock object
9318 * @param digedit Bit mask indicating the digits to be editable
9319 * (values in #Elm_Clock_Digedit).
9321 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9322 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9325 * @see elm_clock_digit_edit_get()
9329 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9332 * Retrieve what digits of the given clock widget should be
9333 * editable when in edition mode.
9335 * @param obj The clock object
9336 * @return Bit mask indicating the digits to be editable
9337 * (values in #Elm_Clock_Digedit).
9339 * @see elm_clock_digit_edit_set() for more details
9343 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9346 * Set if the given clock widget must show hours in military or
9349 * @param obj The clock object
9350 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9353 * This function sets if the clock must show hours in military or
9354 * am/pm mode. In some countries like Brazil the military mode
9355 * (00-24h-format) is used, in opposition to the USA, where the
9356 * am/pm mode is more commonly used.
9358 * @see elm_clock_show_am_pm_get()
9362 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9365 * Get if the given clock widget shows hours in military or am/pm
9368 * @param obj The clock object
9369 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9372 * This function gets if the clock shows hours in military or am/pm
9375 * @see elm_clock_show_am_pm_set() for more details
9379 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9382 * Set if the given clock widget must show time with seconds or not
9384 * @param obj The clock object
9385 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9387 * This function sets if the given clock must show or not elapsed
9388 * seconds. By default, they are @b not shown.
9390 * @see elm_clock_show_seconds_get()
9394 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9397 * Get whether the given clock widget is showing time with seconds
9400 * @param obj The clock object
9401 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9403 * This function gets whether @p obj is showing or not the elapsed
9406 * @see elm_clock_show_seconds_set()
9410 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9413 * Set the interval on time updates for an user mouse button hold
9414 * on clock widgets' time edition.
9416 * @param obj The clock object
9417 * @param interval The (first) interval value in seconds
9419 * This interval value is @b decreased while the user holds the
9420 * mouse pointer either incrementing or decrementing a given the
9421 * clock digit's value.
9423 * This helps the user to get to a given time distant from the
9424 * current one easier/faster, as it will start to flip quicker and
9425 * quicker on mouse button holds.
9427 * The calculation for the next flip interval value, starting from
9428 * the one set with this call, is the previous interval divided by
9429 * 1.05, so it decreases a little bit.
9431 * The default starting interval value for automatic flips is
9434 * @see elm_clock_interval_get()
9438 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9441 * Get the interval on time updates for an user mouse button hold
9442 * on clock widgets' time edition.
9444 * @param obj The clock object
9445 * @return The (first) interval value, in seconds, set on it
9447 * @see elm_clock_interval_set() for more details
9451 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9458 * @defgroup Layout Layout
9460 * @image html img/widget/layout/preview-00.png
9461 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9463 * @image html img/layout-predefined.png
9464 * @image latex img/layout-predefined.eps width=\textwidth
9466 * This is a container widget that takes a standard Edje design file and
9467 * wraps it very thinly in a widget.
9469 * An Edje design (theme) file has a very wide range of possibilities to
9470 * describe the behavior of elements added to the Layout. Check out the Edje
9471 * documentation and the EDC reference to get more information about what can
9472 * be done with Edje.
9474 * Just like @ref List, @ref Box, and other container widgets, any
9475 * object added to the Layout will become its child, meaning that it will be
9476 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9478 * The Layout widget can contain as many Contents, Boxes or Tables as
9479 * described in its theme file. For instance, objects can be added to
9480 * different Tables by specifying the respective Table part names. The same
9481 * is valid for Content and Box.
9483 * The objects added as child of the Layout will behave as described in the
9484 * part description where they were added. There are 3 possible types of
9485 * parts where a child can be added:
9487 * @section secContent Content (SWALLOW part)
9489 * Only one object can be added to the @c SWALLOW part (but you still can
9490 * have many @c SWALLOW parts and one object on each of them). Use the @c
9491 * elm_layout_content_* set of functions to set, retrieve and unset objects
9492 * as content of the @c SWALLOW. After being set to this part, the object
9493 * size, position, visibility, clipping and other description properties
9494 * will be totally controled by the description of the given part (inside
9495 * the Edje theme file).
9497 * One can use @c evas_object_size_hint_* functions on the child to have some
9498 * kind of control over its behavior, but the resulting behavior will still
9499 * depend heavily on the @c SWALLOW part description.
9501 * The Edje theme also can change the part description, based on signals or
9502 * scripts running inside the theme. This change can also be animated. All of
9503 * this will affect the child object set as content accordingly. The object
9504 * size will be changed if the part size is changed, it will animate move if
9505 * the part is moving, and so on.
9507 * The following picture demonstrates a Layout widget with a child object
9508 * added to its @c SWALLOW:
9510 * @image html layout_swallow.png
9511 * @image latex layout_swallow.eps width=\textwidth
9513 * @section secBox Box (BOX part)
9515 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9516 * allows one to add objects to the box and have them distributed along its
9517 * area, accordingly to the specified @a layout property (now by @a layout we
9518 * mean the chosen layouting design of the Box, not the Layout widget
9521 * A similar effect for having a box with its position, size and other things
9522 * controled by the Layout theme would be to create an Elementary @ref Box
9523 * widget and add it as a Content in the @c SWALLOW part.
9525 * The main difference of using the Layout Box is that its behavior, the box
9526 * properties like layouting format, padding, align, etc. will be all
9527 * controled by the theme. This means, for example, that a signal could be
9528 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9529 * handled the signal by changing the box padding, or align, or both. Using
9530 * the Elementary @ref Box widget is not necessarily harder or easier, it
9531 * just depends on the circunstances and requirements.
9533 * The Layout Box can be used through the @c elm_layout_box_* set of
9536 * The following picture demonstrates a Layout widget with many child objects
9537 * added to its @c BOX part:
9539 * @image html layout_box.png
9540 * @image latex layout_box.eps width=\textwidth
9542 * @section secTable Table (TABLE part)
9544 * Just like the @ref secBox, the Layout Table is very similar to the
9545 * Elementary @ref Table widget. It allows one to add objects to the Table
9546 * specifying the row and column where the object should be added, and any
9547 * column or row span if necessary.
9549 * Again, we could have this design by adding a @ref Table widget to the @c
9550 * SWALLOW part using elm_layout_content_set(). The same difference happens
9551 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9552 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9554 * The Layout Table can be used through the @c elm_layout_table_* set of
9557 * The following picture demonstrates a Layout widget with many child objects
9558 * added to its @c TABLE part:
9560 * @image html layout_table.png
9561 * @image latex layout_table.eps width=\textwidth
9563 * @section secPredef Predefined Layouts
9565 * Another interesting thing about the Layout widget is that it offers some
9566 * predefined themes that come with the default Elementary theme. These
9567 * themes can be set by the call elm_layout_theme_set(), and provide some
9568 * basic functionality depending on the theme used.
9570 * Most of them already send some signals, some already provide a toolbar or
9571 * back and next buttons.
9573 * These are available predefined theme layouts. All of them have class = @c
9574 * layout, group = @c application, and style = one of the following options:
9576 * @li @c toolbar-content - application with toolbar and main content area
9577 * @li @c toolbar-content-back - application with toolbar and main content
9578 * area with a back button and title area
9579 * @li @c toolbar-content-back-next - application with toolbar and main
9580 * content area with a back and next buttons and title area
9581 * @li @c content-back - application with a main content area with a back
9582 * button and title area
9583 * @li @c content-back-next - application with a main content area with a
9584 * back and next buttons and title area
9585 * @li @c toolbar-vbox - application with toolbar and main content area as a
9587 * @li @c toolbar-table - application with toolbar and main content area as a
9590 * @section secExamples Examples
9592 * Some examples of the Layout widget can be found here:
9593 * @li @ref layout_example_01
9594 * @li @ref layout_example_02
9595 * @li @ref layout_example_03
9596 * @li @ref layout_example_edc
9601 * Add a new layout to the parent
9603 * @param parent The parent object
9604 * @return The new object or NULL if it cannot be created
9606 * @see elm_layout_file_set()
9607 * @see elm_layout_theme_set()
9611 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9613 * Set the file that will be used as layout
9615 * @param obj The layout object
9616 * @param file The path to file (edj) that will be used as layout
9617 * @param group The group that the layout belongs in edje file
9619 * @return (1 = success, 0 = error)
9623 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9625 * Set the edje group from the elementary theme that will be used as layout
9627 * @param obj The layout object
9628 * @param clas the clas of the group
9629 * @param group the group
9630 * @param style the style to used
9632 * @return (1 = success, 0 = error)
9636 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9638 * Set the layout content.
9640 * @param obj The layout object
9641 * @param swallow The swallow part name in the edje file
9642 * @param content The child that will be added in this layout object
9644 * Once the content object is set, a previously set one will be deleted.
9645 * If you want to keep that old content object, use the
9646 * elm_layout_content_unset() function.
9648 * @note In an Edje theme, the part used as a content container is called @c
9649 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9650 * expected to be a part name just like the second parameter of
9651 * elm_layout_box_append().
9653 * @see elm_layout_box_append()
9654 * @see elm_layout_content_get()
9655 * @see elm_layout_content_unset()
9660 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9662 * Get the child object in the given content part.
9664 * @param obj The layout object
9665 * @param swallow The SWALLOW part to get its content
9667 * @return The swallowed object or NULL if none or an error occurred
9669 * @see elm_layout_content_set()
9673 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9675 * Unset the layout content.
9677 * @param obj The layout object
9678 * @param swallow The swallow part name in the edje file
9679 * @return The content that was being used
9681 * Unparent and return the content object which was set for this part.
9683 * @see elm_layout_content_set()
9687 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9689 * Set the text of the given part
9691 * @param obj The layout object
9692 * @param part The TEXT part where to set the text
9693 * @param text The text to set
9696 * @deprecated use elm_object_text_* instead.
9698 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9700 * Get the text set in the given part
9702 * @param obj The layout object
9703 * @param part The TEXT part to retrieve the text off
9705 * @return The text set in @p part
9708 * @deprecated use elm_object_text_* instead.
9710 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9712 * Append child to layout box part.
9714 * @param obj the layout object
9715 * @param part the box part to which the object will be appended.
9716 * @param child the child object to append to box.
9718 * Once the object is appended, it will become child of the layout. Its
9719 * lifetime will be bound to the layout, whenever the layout dies the child
9720 * will be deleted automatically. One should use elm_layout_box_remove() to
9721 * make this layout forget about the object.
9723 * @see elm_layout_box_prepend()
9724 * @see elm_layout_box_insert_before()
9725 * @see elm_layout_box_insert_at()
9726 * @see elm_layout_box_remove()
9730 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9732 * Prepend child to layout box part.
9734 * @param obj the layout object
9735 * @param part the box part to prepend.
9736 * @param child the child object to prepend to box.
9738 * Once the object is prepended, it will become child of the layout. Its
9739 * lifetime will be bound to the layout, whenever the layout dies the child
9740 * will be deleted automatically. One should use elm_layout_box_remove() to
9741 * make this layout forget about the object.
9743 * @see elm_layout_box_append()
9744 * @see elm_layout_box_insert_before()
9745 * @see elm_layout_box_insert_at()
9746 * @see elm_layout_box_remove()
9750 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9752 * Insert child to layout box part before a reference object.
9754 * @param obj the layout object
9755 * @param part the box part to insert.
9756 * @param child the child object to insert into box.
9757 * @param reference another reference object to insert before in box.
9759 * Once the object is inserted, it will become child of the layout. Its
9760 * lifetime will be bound to the layout, whenever the layout dies the child
9761 * will be deleted automatically. One should use elm_layout_box_remove() to
9762 * make this layout forget about the object.
9764 * @see elm_layout_box_append()
9765 * @see elm_layout_box_prepend()
9766 * @see elm_layout_box_insert_before()
9767 * @see elm_layout_box_remove()
9771 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9773 * Insert child to layout box part at a given position.
9775 * @param obj the layout object
9776 * @param part the box part to insert.
9777 * @param child the child object to insert into box.
9778 * @param pos the numeric position >=0 to insert the child.
9780 * Once the object is inserted, it will become child of the layout. Its
9781 * lifetime will be bound to the layout, whenever the layout dies the child
9782 * will be deleted automatically. One should use elm_layout_box_remove() to
9783 * make this layout forget about the object.
9785 * @see elm_layout_box_append()
9786 * @see elm_layout_box_prepend()
9787 * @see elm_layout_box_insert_before()
9788 * @see elm_layout_box_remove()
9792 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9794 * Remove a child of the given part box.
9796 * @param obj The layout object
9797 * @param part The box part name to remove child.
9798 * @param child The object to remove from box.
9799 * @return The object that was being used, or NULL if not found.
9801 * The object will be removed from the box part and its lifetime will
9802 * not be handled by the layout anymore. This is equivalent to
9803 * elm_layout_content_unset() for box.
9805 * @see elm_layout_box_append()
9806 * @see elm_layout_box_remove_all()
9810 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9812 * Remove all child of the given part box.
9814 * @param obj The layout object
9815 * @param part The box part name to remove child.
9816 * @param clear If EINA_TRUE, then all objects will be deleted as
9817 * well, otherwise they will just be removed and will be
9818 * dangling on the canvas.
9820 * The objects will be removed from the box part and their lifetime will
9821 * not be handled by the layout anymore. This is equivalent to
9822 * elm_layout_box_remove() for all box children.
9824 * @see elm_layout_box_append()
9825 * @see elm_layout_box_remove()
9829 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9831 * Insert child to layout table part.
9833 * @param obj the layout object
9834 * @param part the box part to pack child.
9835 * @param child_obj the child object to pack into table.
9836 * @param col the column to which the child should be added. (>= 0)
9837 * @param row the row to which the child should be added. (>= 0)
9838 * @param colspan how many columns should be used to store this object. (>=
9840 * @param rowspan how many rows should be used to store this object. (>= 1)
9842 * Once the object is inserted, it will become child of the table. Its
9843 * lifetime will be bound to the layout, and whenever the layout dies the
9844 * child will be deleted automatically. One should use
9845 * elm_layout_table_remove() to make this layout forget about the object.
9847 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9848 * more space than a single cell. For instance, the following code:
9850 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9853 * Would result in an object being added like the following picture:
9855 * @image html layout_colspan.png
9856 * @image latex layout_colspan.eps width=\textwidth
9858 * @see elm_layout_table_unpack()
9859 * @see elm_layout_table_clear()
9863 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);
9865 * Unpack (remove) a child of the given part table.
9867 * @param obj The layout object
9868 * @param part The table part name to remove child.
9869 * @param child_obj The object to remove from table.
9870 * @return The object that was being used, or NULL if not found.
9872 * The object will be unpacked from the table part and its lifetime
9873 * will not be handled by the layout anymore. This is equivalent to
9874 * elm_layout_content_unset() for table.
9876 * @see elm_layout_table_pack()
9877 * @see elm_layout_table_clear()
9881 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9883 * Remove all child of the given part table.
9885 * @param obj The layout object
9886 * @param part The table part name to remove child.
9887 * @param clear If EINA_TRUE, then all objects will be deleted as
9888 * well, otherwise they will just be removed and will be
9889 * dangling on the canvas.
9891 * The objects will be removed from the table part and their lifetime will
9892 * not be handled by the layout anymore. This is equivalent to
9893 * elm_layout_table_unpack() for all table children.
9895 * @see elm_layout_table_pack()
9896 * @see elm_layout_table_unpack()
9900 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9902 * Get the edje layout
9904 * @param obj The layout object
9906 * @return A Evas_Object with the edje layout settings loaded
9907 * with function elm_layout_file_set
9909 * This returns the edje object. It is not expected to be used to then
9910 * swallow objects via edje_object_part_swallow() for example. Use
9911 * elm_layout_content_set() instead so child object handling and sizing is
9914 * @note This function should only be used if you really need to call some
9915 * low level Edje function on this edje object. All the common stuff (setting
9916 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9917 * with proper elementary functions.
9919 * @see elm_object_signal_callback_add()
9920 * @see elm_object_signal_emit()
9921 * @see elm_object_text_part_set()
9922 * @see elm_layout_content_set()
9923 * @see elm_layout_box_append()
9924 * @see elm_layout_table_pack()
9925 * @see elm_layout_data_get()
9929 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9931 * Get the edje data from the given layout
9933 * @param obj The layout object
9934 * @param key The data key
9936 * @return The edje data string
9938 * This function fetches data specified inside the edje theme of this layout.
9939 * This function return NULL if data is not found.
9941 * In EDC this comes from a data block within the group block that @p
9942 * obj was loaded from. E.g.
9949 * item: "key1" "value1";
9950 * item: "key2" "value2";
9958 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9962 * @param obj The layout object
9964 * Manually forces a sizing re-evaluation. This is useful when the minimum
9965 * size required by the edje theme of this layout has changed. The change on
9966 * the minimum size required by the edje theme is not immediately reported to
9967 * the elementary layout, so one needs to call this function in order to tell
9968 * the widget (layout) that it needs to reevaluate its own size.
9970 * The minimum size of the theme is calculated based on minimum size of
9971 * parts, the size of elements inside containers like box and table, etc. All
9972 * of this can change due to state changes, and that's when this function
9975 * Also note that a standard signal of "size,eval" "elm" emitted from the
9976 * edje object will cause this to happen too.
9980 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9983 * Sets a specific cursor for an edje part.
9985 * @param obj The layout object.
9986 * @param part_name a part from loaded edje group.
9987 * @param cursor cursor name to use, see Elementary_Cursor.h
9989 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9990 * part not exists or it has "mouse_events: 0".
9994 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9997 * Get the cursor to be shown when mouse is over an edje part
9999 * @param obj The layout object.
10000 * @param part_name a part from loaded edje group.
10001 * @return the cursor name.
10005 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10008 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10010 * @param obj The layout object.
10011 * @param part_name a part from loaded edje group, that had a cursor set
10012 * with elm_layout_part_cursor_set().
10016 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10019 * Sets a specific cursor style for an edje part.
10021 * @param obj The layout object.
10022 * @param part_name a part from loaded edje group.
10023 * @param style the theme style to use (default, transparent, ...)
10025 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10026 * part not exists or it did not had a cursor set.
10030 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10033 * Gets a specific cursor style for an edje part.
10035 * @param obj The layout object.
10036 * @param part_name a part from loaded edje group.
10038 * @return the theme style in use, defaults to "default". If the
10039 * object does not have a cursor set, then NULL is returned.
10043 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10046 * Sets if the cursor set should be searched on the theme or should use
10047 * the provided by the engine, only.
10049 * @note before you set if should look on theme you should define a
10050 * cursor with elm_layout_part_cursor_set(). By default it will only
10051 * look for cursors provided by the engine.
10053 * @param obj The layout object.
10054 * @param part_name a part from loaded edje group.
10055 * @param engine_only if cursors should be just provided by the engine
10056 * or should also search on widget's theme as well
10058 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10059 * part not exists or it did not had a cursor set.
10063 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);
10066 * Gets a specific cursor engine_only for an edje part.
10068 * @param obj The layout object.
10069 * @param part_name a part from loaded edje group.
10071 * @return whenever the cursor is just provided by engine or also from theme.
10075 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10078 * @def elm_layout_icon_set
10079 * Convienience macro to set the icon object in a layout that follows the
10080 * Elementary naming convention for its parts.
10084 #define elm_layout_icon_set(_ly, _obj) \
10087 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10088 if ((_obj)) sig = "elm,state,icon,visible"; \
10089 else sig = "elm,state,icon,hidden"; \
10090 elm_object_signal_emit((_ly), sig, "elm"); \
10094 * @def elm_layout_icon_get
10095 * Convienience macro to get the icon object from a layout that follows the
10096 * Elementary naming convention for its parts.
10100 #define elm_layout_icon_get(_ly) \
10101 elm_layout_content_get((_ly), "elm.swallow.icon")
10104 * @def elm_layout_end_set
10105 * Convienience macro to set the end object in a layout that follows the
10106 * Elementary naming convention for its parts.
10110 #define elm_layout_end_set(_ly, _obj) \
10113 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10114 if ((_obj)) sig = "elm,state,end,visible"; \
10115 else sig = "elm,state,end,hidden"; \
10116 elm_object_signal_emit((_ly), sig, "elm"); \
10120 * @def elm_layout_end_get
10121 * Convienience macro to get the end object in a layout that follows the
10122 * Elementary naming convention for its parts.
10126 #define elm_layout_end_get(_ly) \
10127 elm_layout_content_get((_ly), "elm.swallow.end")
10130 * @def elm_layout_label_set
10131 * Convienience macro to set the label in a layout that follows the
10132 * Elementary naming convention for its parts.
10135 * @deprecated use elm_object_text_* instead.
10137 #define elm_layout_label_set(_ly, _txt) \
10138 elm_layout_text_set((_ly), "elm.text", (_txt))
10141 * @def elm_layout_label_get
10142 * Convienience macro to get the label in a layout that follows the
10143 * Elementary naming convention for its parts.
10146 * @deprecated use elm_object_text_* instead.
10148 #define elm_layout_label_get(_ly) \
10149 elm_layout_text_get((_ly), "elm.text")
10151 /* smart callbacks called:
10152 * "theme,changed" - when elm theme is changed.
10156 * @defgroup Notify Notify
10158 * @image html img/widget/notify/preview-00.png
10159 * @image latex img/widget/notify/preview-00.eps
10161 * Display a container in a particular region of the parent(top, bottom,
10162 * etc. A timeout can be set to automatically hide the notify. This is so
10163 * that, after an evas_object_show() on a notify object, if a timeout was set
10164 * on it, it will @b automatically get hidden after that time.
10166 * Signals that you can add callbacks for are:
10167 * @li "timeout" - when timeout happens on notify and it's hidden
10168 * @li "block,clicked" - when a click outside of the notify happens
10170 * @ref tutorial_notify show usage of the API.
10175 * @brief Possible orient values for notify.
10177 * This values should be used in conjunction to elm_notify_orient_set() to
10178 * set the position in which the notify should appear(relative to its parent)
10179 * and in conjunction with elm_notify_orient_get() to know where the notify
10182 typedef enum _Elm_Notify_Orient
10184 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10185 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10186 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10187 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10188 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10189 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10190 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10191 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10192 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10193 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10194 } Elm_Notify_Orient;
10196 * @brief Add a new notify to the parent
10198 * @param parent The parent object
10199 * @return The new object or NULL if it cannot be created
10201 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10203 * @brief Set the content of the notify widget
10205 * @param obj The notify object
10206 * @param content The content will be filled in this notify object
10208 * Once the content object is set, a previously set one will be deleted. If
10209 * you want to keep that old content object, use the
10210 * elm_notify_content_unset() function.
10212 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10214 * @brief Unset the content of the notify widget
10216 * @param obj The notify object
10217 * @return The content that was being used
10219 * Unparent and return the content object which was set for this widget
10221 * @see elm_notify_content_set()
10223 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10225 * @brief Return the content of the notify widget
10227 * @param obj The notify object
10228 * @return The content that is being used
10230 * @see elm_notify_content_set()
10232 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10234 * @brief Set the notify parent
10236 * @param obj The notify object
10237 * @param content The new parent
10239 * Once the parent object is set, a previously set one will be disconnected
10242 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10244 * @brief Get the notify parent
10246 * @param obj The notify object
10247 * @return The parent
10249 * @see elm_notify_parent_set()
10251 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10253 * @brief Set the orientation
10255 * @param obj The notify object
10256 * @param orient The new orientation
10258 * Sets the position in which the notify will appear in its parent.
10260 * @see @ref Elm_Notify_Orient for possible values.
10262 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10264 * @brief Return the orientation
10265 * @param obj The notify object
10266 * @return The orientation of the notification
10268 * @see elm_notify_orient_set()
10269 * @see Elm_Notify_Orient
10271 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10273 * @brief Set the time interval after which the notify window is going to be
10276 * @param obj The notify object
10277 * @param time The timeout in seconds
10279 * This function sets a timeout and starts the timer controlling when the
10280 * notify is hidden. Since calling evas_object_show() on a notify restarts
10281 * the timer controlling when the notify is hidden, setting this before the
10282 * notify is shown will in effect mean starting the timer when the notify is
10285 * @note Set a value <= 0.0 to disable a running timer.
10287 * @note If the value > 0.0 and the notify is previously visible, the
10288 * timer will be started with this value, canceling any running timer.
10290 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10292 * @brief Return the timeout value (in seconds)
10293 * @param obj the notify object
10295 * @see elm_notify_timeout_set()
10297 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10299 * @brief Sets whether events should be passed to by a click outside
10302 * @param obj The notify object
10303 * @param repeats EINA_TRUE Events are repeats, else no
10305 * When true if the user clicks outside the window the events will be caught
10306 * by the others widgets, else the events are blocked.
10308 * @note The default value is EINA_TRUE.
10310 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10312 * @brief Return true if events are repeat below the notify object
10313 * @param obj the notify object
10315 * @see elm_notify_repeat_events_set()
10317 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10323 * @defgroup Hover Hover
10325 * @image html img/widget/hover/preview-00.png
10326 * @image latex img/widget/hover/preview-00.eps
10328 * A Hover object will hover over its @p parent object at the @p target
10329 * location. Anything in the background will be given a darker coloring to
10330 * indicate that the hover object is on top (at the default theme). When the
10331 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10332 * clicked that @b doesn't cause the hover to be dismissed.
10334 * @note The hover object will take up the entire space of @p target
10337 * Elementary has the following styles for the hover widget:
10341 * @li hoversel_vertical
10343 * The following are the available position for content:
10355 * Signals that you can add callbacks for are:
10356 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10357 * @li "smart,changed" - a content object placed under the "smart"
10358 * policy was replaced to a new slot direction.
10360 * See @ref tutorial_hover for more information.
10364 typedef enum _Elm_Hover_Axis
10366 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10367 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10368 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10369 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10372 * @brief Adds a hover object to @p parent
10374 * @param parent The parent object
10375 * @return The hover object or NULL if one could not be created
10377 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10379 * @brief Sets the target object for the hover.
10381 * @param obj The hover object
10382 * @param target The object to center the hover onto. The hover
10384 * This function will cause the hover to be centered on the target object.
10386 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10388 * @brief Gets the target object for the hover.
10390 * @param obj The hover object
10391 * @param parent The object to locate the hover over.
10393 * @see elm_hover_target_set()
10395 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10397 * @brief Sets the parent object for the hover.
10399 * @param obj The hover object
10400 * @param parent The object to locate the hover over.
10402 * This function will cause the hover to take up the entire space that the
10403 * parent object fills.
10405 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10407 * @brief Gets the parent object for the hover.
10409 * @param obj The hover object
10410 * @return The parent object to locate the hover over.
10412 * @see elm_hover_parent_set()
10414 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10416 * @brief Sets the content of the hover object and the direction in which it
10419 * @param obj The hover object
10420 * @param swallow The direction that the object will be displayed
10421 * at. Accepted values are "left", "top-left", "top", "top-right",
10422 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10424 * @param content The content to place at @p swallow
10426 * Once the content object is set for a given direction, a previously
10427 * set one (on the same direction) will be deleted. If you want to
10428 * keep that old content object, use the elm_hover_content_unset()
10431 * All directions may have contents at the same time, except for
10432 * "smart". This is a special placement hint and its use case
10433 * independs of the calculations coming from
10434 * elm_hover_best_content_location_get(). Its use is for cases when
10435 * one desires only one hover content, but with a dinamic special
10436 * placement within the hover area. The content's geometry, whenever
10437 * it changes, will be used to decide on a best location not
10438 * extrapolating the hover's parent object view to show it in (still
10439 * being the hover's target determinant of its medium part -- move and
10440 * resize it to simulate finger sizes, for example). If one of the
10441 * directions other than "smart" are used, a previously content set
10442 * using it will be deleted, and vice-versa.
10444 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10446 * @brief Get the content of the hover object, in a given direction.
10448 * Return the content object which was set for this widget in the
10449 * @p swallow direction.
10451 * @param obj The hover object
10452 * @param swallow The direction that the object was display at.
10453 * @return The content that was being used
10455 * @see elm_hover_content_set()
10457 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10459 * @brief Unset the content of the hover object, in a given direction.
10461 * Unparent and return the content object set at @p swallow direction.
10463 * @param obj The hover object
10464 * @param swallow The direction that the object was display at.
10465 * @return The content that was being used.
10467 * @see elm_hover_content_set()
10469 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10471 * @brief Returns the best swallow location for content in the hover.
10473 * @param obj The hover object
10474 * @param pref_axis The preferred orientation axis for the hover object to use
10475 * @return The edje location to place content into the hover or @c
10478 * Best is defined here as the location at which there is the most available
10481 * @p pref_axis may be one of
10482 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10483 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10484 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10485 * - @c ELM_HOVER_AXIS_BOTH -- both
10487 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10488 * nescessarily be along the horizontal axis("left" or "right"). If
10489 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10490 * be along the vertical axis("top" or "bottom"). Chossing
10491 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10492 * returned position may be in either axis.
10494 * @see elm_hover_content_set()
10496 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10503 * @defgroup Entry Entry
10505 * @image html img/widget/entry/preview-00.png
10506 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10507 * @image html img/widget/entry/preview-01.png
10508 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10509 * @image html img/widget/entry/preview-02.png
10510 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10511 * @image html img/widget/entry/preview-03.png
10512 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10514 * An entry is a convenience widget which shows a box that the user can
10515 * enter text into. Entries by default don't scroll, so they grow to
10516 * accomodate the entire text, resizing the parent window as needed. This
10517 * can be changed with the elm_entry_scrollable_set() function.
10519 * They can also be single line or multi line (the default) and when set
10520 * to multi line mode they support text wrapping in any of the modes
10521 * indicated by #Elm_Wrap_Type.
10523 * Other features include password mode, filtering of inserted text with
10524 * elm_entry_text_filter_append() and related functions, inline "items" and
10525 * formatted markup text.
10527 * @section entry-markup Formatted text
10529 * The markup tags supported by the Entry are defined by the theme, but
10530 * even when writing new themes or extensions it's a good idea to stick to
10531 * a sane default, to maintain coherency and avoid application breakages.
10532 * Currently defined by the default theme are the following tags:
10533 * @li \<br\>: Inserts a line break.
10534 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10536 * @li \<tab\>: Inserts a tab.
10537 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10539 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10540 * @li \<link\>...\</link\>: Underlines the enclosed text.
10541 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10543 * @section entry-special Special markups
10545 * Besides those used to format text, entries support two special markup
10546 * tags used to insert clickable portions of text or items inlined within
10549 * @subsection entry-anchors Anchors
10551 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10552 * \</a\> tags and an event will be generated when this text is clicked,
10556 * This text is outside <a href=anc-01>but this one is an anchor</a>
10559 * The @c href attribute in the opening tag gives the name that will be
10560 * used to identify the anchor and it can be any valid utf8 string.
10562 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10563 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10564 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10565 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10568 * @subsection entry-items Items
10570 * Inlined in the text, any other @c Evas_Object can be inserted by using
10571 * \<item\> tags this way:
10574 * <item size=16x16 vsize=full href=emoticon/haha></item>
10577 * Just like with anchors, the @c href identifies each item, but these need,
10578 * in addition, to indicate their size, which is done using any one of
10579 * @c size, @c absize or @c relsize attributes. These attributes take their
10580 * value in the WxH format, where W is the width and H the height of the
10583 * @li absize: Absolute pixel size for the item. Whatever value is set will
10584 * be the item's size regardless of any scale value the object may have
10585 * been set to. The final line height will be adjusted to fit larger items.
10586 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10588 * @li relsize: Size is adjusted for the item to fit within the current
10591 * Besides their size, items are specificed a @c vsize value that affects
10592 * how their final size and position are calculated. The possible values
10594 * @li ascent: Item will be placed within the line's baseline and its
10595 * ascent. That is, the height between the line where all characters are
10596 * positioned and the highest point in the line. For @c size and @c absize
10597 * items, the descent value will be added to the total line height to make
10598 * them fit. @c relsize items will be adjusted to fit within this space.
10599 * @li full: Items will be placed between the descent and ascent, or the
10600 * lowest point in the line and its highest.
10602 * The next image shows different configurations of items and how they
10603 * are the previously mentioned options affect their sizes. In all cases,
10604 * the green line indicates the ascent, blue for the baseline and red for
10607 * @image html entry_item.png
10608 * @image latex entry_item.eps width=\textwidth
10610 * And another one to show how size differs from absize. In the first one,
10611 * the scale value is set to 1.0, while the second one is using one of 2.0.
10613 * @image html entry_item_scale.png
10614 * @image latex entry_item_scale.eps width=\textwidth
10616 * After the size for an item is calculated, the entry will request an
10617 * object to place in its space. For this, the functions set with
10618 * elm_entry_item_provider_append() and related functions will be called
10619 * in order until one of them returns a @c non-NULL value. If no providers
10620 * are available, or all of them return @c NULL, then the entry falls back
10621 * to one of the internal defaults, provided the name matches with one of
10624 * All of the following are currently supported:
10627 * - emoticon/angry-shout
10628 * - emoticon/crazy-laugh
10629 * - emoticon/evil-laugh
10631 * - emoticon/goggle-smile
10632 * - emoticon/grumpy
10633 * - emoticon/grumpy-smile
10634 * - emoticon/guilty
10635 * - emoticon/guilty-smile
10637 * - emoticon/half-smile
10638 * - emoticon/happy-panting
10640 * - emoticon/indifferent
10642 * - emoticon/knowing-grin
10644 * - emoticon/little-bit-sorry
10645 * - emoticon/love-lots
10647 * - emoticon/minimal-smile
10648 * - emoticon/not-happy
10649 * - emoticon/not-impressed
10651 * - emoticon/opensmile
10654 * - emoticon/squint-laugh
10655 * - emoticon/surprised
10656 * - emoticon/suspicious
10657 * - emoticon/tongue-dangling
10658 * - emoticon/tongue-poke
10660 * - emoticon/unhappy
10661 * - emoticon/very-sorry
10664 * - emoticon/worried
10667 * Alternatively, an item may reference an image by its path, using
10668 * the URI form @c file:///path/to/an/image.png and the entry will then
10669 * use that image for the item.
10671 * @section entry-files Loading and saving files
10673 * Entries have convinience functions to load text from a file and save
10674 * changes back to it after a short delay. The automatic saving is enabled
10675 * by default, but can be disabled with elm_entry_autosave_set() and files
10676 * can be loaded directly as plain text or have any markup in them
10677 * recognized. See elm_entry_file_set() for more details.
10679 * @section entry-signals Emitted signals
10681 * This widget emits the following signals:
10683 * @li "changed": The text within the entry was changed.
10684 * @li "changed,user": The text within the entry was changed because of user interaction.
10685 * @li "activated": The enter key was pressed on a single line entry.
10686 * @li "press": A mouse button has been pressed on the entry.
10687 * @li "longpressed": A mouse button has been pressed and held for a couple
10689 * @li "clicked": The entry has been clicked (mouse press and release).
10690 * @li "clicked,double": The entry has been double clicked.
10691 * @li "clicked,triple": The entry has been triple clicked.
10692 * @li "focused": The entry has received focus.
10693 * @li "unfocused": The entry has lost focus.
10694 * @li "selection,paste": A paste of the clipboard contents was requested.
10695 * @li "selection,copy": A copy of the selected text into the clipboard was
10697 * @li "selection,cut": A cut of the selected text into the clipboard was
10699 * @li "selection,start": A selection has begun and no previous selection
10701 * @li "selection,changed": The current selection has changed.
10702 * @li "selection,cleared": The current selection has been cleared.
10703 * @li "cursor,changed": The cursor has changed position.
10704 * @li "anchor,clicked": An anchor has been clicked. The event_info
10705 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10706 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10707 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10708 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10709 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10710 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10711 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10712 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10713 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10714 * @li "preedit,changed": The preedit string has changed.
10716 * @section entry-examples
10718 * An overview of the Entry API can be seen in @ref entry_example_01
10723 * @typedef Elm_Entry_Anchor_Info
10725 * The info sent in the callback for the "anchor,clicked" signals emitted
10728 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10730 * @struct _Elm_Entry_Anchor_Info
10732 * The info sent in the callback for the "anchor,clicked" signals emitted
10735 struct _Elm_Entry_Anchor_Info
10737 const char *name; /**< The name of the anchor, as stated in its href */
10738 int button; /**< The mouse button used to click on it */
10739 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10740 y, /**< Anchor geometry, relative to canvas */
10741 w, /**< Anchor geometry, relative to canvas */
10742 h; /**< Anchor geometry, relative to canvas */
10745 * @typedef Elm_Entry_Filter_Cb
10746 * This callback type is used by entry filters to modify text.
10747 * @param data The data specified as the last param when adding the filter
10748 * @param entry The entry object
10749 * @param text A pointer to the location of the text being filtered. This data can be modified,
10750 * but any additional allocations must be managed by the user.
10751 * @see elm_entry_text_filter_append
10752 * @see elm_entry_text_filter_prepend
10754 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10757 * This adds an entry to @p parent object.
10759 * By default, entries are:
10763 * @li autosave is enabled
10765 * @param parent The parent object
10766 * @return The new object or NULL if it cannot be created
10768 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10770 * Sets the entry to single line mode.
10772 * In single line mode, entries don't ever wrap when the text reaches the
10773 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10774 * key will generate an @c "activate" event instead of adding a new line.
10776 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10777 * and pressing enter will break the text into a different line
10778 * without generating any events.
10780 * @param obj The entry object
10781 * @param single_line If true, the text in the entry
10782 * will be on a single line.
10784 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10786 * Gets whether the entry is set to be single line.
10788 * @param obj The entry object
10789 * @return single_line If true, the text in the entry is set to display
10790 * on a single line.
10792 * @see elm_entry_single_line_set()
10794 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10796 * Sets the entry to password mode.
10798 * In password mode, entries are implicitly single line and the display of
10799 * any text in them is replaced with asterisks (*).
10801 * @param obj The entry object
10802 * @param password If true, password mode is enabled.
10804 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10806 * Gets whether the entry is set to password mode.
10808 * @param obj The entry object
10809 * @return If true, the entry is set to display all characters
10810 * as asterisks (*).
10812 * @see elm_entry_password_set()
10814 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10816 * This sets the text displayed within the entry to @p entry.
10818 * @param obj The entry object
10819 * @param entry The text to be displayed
10821 * @deprecated Use elm_object_text_set() instead.
10823 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10825 * This returns the text currently shown in object @p entry.
10826 * See also elm_entry_entry_set().
10828 * @param obj The entry object
10829 * @return The currently displayed text or NULL on failure
10831 * @deprecated Use elm_object_text_get() instead.
10833 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10835 * Appends @p entry to the text of the entry.
10837 * Adds the text in @p entry to the end of any text already present in the
10840 * The appended text is subject to any filters set for the widget.
10842 * @param obj The entry object
10843 * @param entry The text to be displayed
10845 * @see elm_entry_text_filter_append()
10847 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10849 * Gets whether the entry is empty.
10851 * Empty means no text at all. If there are any markup tags, like an item
10852 * tag for which no provider finds anything, and no text is displayed, this
10853 * function still returns EINA_FALSE.
10855 * @param obj The entry object
10856 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10858 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10860 * Gets any selected text within the entry.
10862 * If there's any selected text in the entry, this function returns it as
10863 * a string in markup format. NULL is returned if no selection exists or
10864 * if an error occurred.
10866 * The returned value points to an internal string and should not be freed
10867 * or modified in any way. If the @p entry object is deleted or its
10868 * contents are changed, the returned pointer should be considered invalid.
10870 * @param obj The entry object
10871 * @return The selected text within the entry or NULL on failure
10873 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10875 * Inserts the given text into the entry at the current cursor position.
10877 * This inserts text at the cursor position as if it was typed
10878 * by the user (note that this also allows markup which a user
10879 * can't just "type" as it would be converted to escaped text, so this
10880 * call can be used to insert things like emoticon items or bold push/pop
10881 * tags, other font and color change tags etc.)
10883 * If any selection exists, it will be replaced by the inserted text.
10885 * The inserted text is subject to any filters set for the widget.
10887 * @param obj The entry object
10888 * @param entry The text to insert
10890 * @see elm_entry_text_filter_append()
10892 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10894 * Set the line wrap type to use on multi-line entries.
10896 * Sets the wrap type used by the entry to any of the specified in
10897 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10898 * line (without inserting a line break or paragraph separator) when it
10899 * reaches the far edge of the widget.
10901 * Note that this only makes sense for multi-line entries. A widget set
10902 * to be single line will never wrap.
10904 * @param obj The entry object
10905 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10907 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10909 * Gets the wrap mode the entry was set to use.
10911 * @param obj The entry object
10912 * @return Wrap type
10914 * @see also elm_entry_line_wrap_set()
10916 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10918 * Sets if the entry is to be editable or not.
10920 * By default, entries are editable and when focused, any text input by the
10921 * user will be inserted at the current cursor position. But calling this
10922 * function with @p editable as EINA_FALSE will prevent the user from
10923 * inputting text into the entry.
10925 * The only way to change the text of a non-editable entry is to use
10926 * elm_object_text_set(), elm_entry_entry_insert() and other related
10929 * @param obj The entry object
10930 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10931 * if not, the entry is read-only and no user input is allowed.
10933 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10935 * Gets whether the entry is editable or not.
10937 * @param obj The entry object
10938 * @return If true, the entry is editable by the user.
10939 * If false, it is not editable by the user
10941 * @see elm_entry_editable_set()
10943 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10945 * This drops any existing text selection within the entry.
10947 * @param obj The entry object
10949 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10951 * This selects all text within the entry.
10953 * @param obj The entry object
10955 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10957 * This moves the cursor one place to the right within the entry.
10959 * @param obj The entry object
10960 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10962 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10964 * This moves the cursor one place to the left within the entry.
10966 * @param obj The entry object
10967 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10969 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10971 * This moves the cursor one line up within the entry.
10973 * @param obj The entry object
10974 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10976 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10978 * This moves the cursor one line down within the entry.
10980 * @param obj The entry object
10981 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10983 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10985 * This moves the cursor to the beginning of the entry.
10987 * @param obj The entry object
10989 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10991 * This moves the cursor to the end of the entry.
10993 * @param obj The entry object
10995 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10997 * This moves the cursor to the beginning of the current line.
10999 * @param obj The entry object
11001 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11003 * This moves the cursor to the end of the current line.
11005 * @param obj The entry object
11007 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11009 * This begins a selection within the entry as though
11010 * the user were holding down the mouse button to make a selection.
11012 * @param obj The entry object
11014 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11016 * This ends a selection within the entry as though
11017 * the user had just released the mouse button while making a selection.
11019 * @param obj The entry object
11021 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11023 * Gets whether a format node exists at the current cursor position.
11025 * A format node is anything that defines how the text is rendered. It can
11026 * be a visible format node, such as a line break or a paragraph separator,
11027 * or an invisible one, such as bold begin or end tag.
11028 * This function returns whether any format node exists at the current
11031 * @param obj The entry object
11032 * @return EINA_TRUE if the current cursor position contains a format node,
11033 * EINA_FALSE otherwise.
11035 * @see elm_entry_cursor_is_visible_format_get()
11037 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11039 * Gets if the current cursor position holds a visible format node.
11041 * @param obj The entry object
11042 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11043 * if it's an invisible one or no format exists.
11045 * @see elm_entry_cursor_is_format_get()
11047 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11049 * Gets the character pointed by the cursor at its current position.
11051 * This function returns a string with the utf8 character stored at the
11052 * current cursor position.
11053 * Only the text is returned, any format that may exist will not be part
11054 * of the return value.
11056 * @param obj The entry object
11057 * @return The text pointed by the cursors.
11059 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11061 * This function returns the geometry of the cursor.
11063 * It's useful if you want to draw something on the cursor (or where it is),
11064 * or for example in the case of scrolled entry where you want to show the
11067 * @param obj The entry object
11068 * @param x returned geometry
11069 * @param y returned geometry
11070 * @param w returned geometry
11071 * @param h returned geometry
11072 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11074 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);
11076 * Sets the cursor position in the entry to the given value
11078 * The value in @p pos is the index of the character position within the
11079 * contents of the string as returned by elm_entry_cursor_pos_get().
11081 * @param obj The entry object
11082 * @param pos The position of the cursor
11084 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11086 * Retrieves the current position of the cursor in the entry
11088 * @param obj The entry object
11089 * @return The cursor position
11091 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11093 * This executes a "cut" action on the selected text in the entry.
11095 * @param obj The entry object
11097 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11099 * This executes a "copy" action on the selected text in the entry.
11101 * @param obj The entry object
11103 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11105 * This executes a "paste" action in the entry.
11107 * @param obj The entry object
11109 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11111 * This clears and frees the items in a entry's contextual (longpress)
11114 * @param obj The entry object
11116 * @see elm_entry_context_menu_item_add()
11118 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11120 * This adds an item to the entry's contextual menu.
11122 * A longpress on an entry will make the contextual menu show up, if this
11123 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11124 * By default, this menu provides a few options like enabling selection mode,
11125 * which is useful on embedded devices that need to be explicit about it,
11126 * and when a selection exists it also shows the copy and cut actions.
11128 * With this function, developers can add other options to this menu to
11129 * perform any action they deem necessary.
11131 * @param obj The entry object
11132 * @param label The item's text label
11133 * @param icon_file The item's icon file
11134 * @param icon_type The item's icon type
11135 * @param func The callback to execute when the item is clicked
11136 * @param data The data to associate with the item for related functions
11138 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);
11140 * This disables the entry's contextual (longpress) menu.
11142 * @param obj The entry object
11143 * @param disabled If true, the menu is disabled
11145 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11147 * This returns whether the entry's contextual (longpress) menu is
11150 * @param obj The entry object
11151 * @return If true, the menu is disabled
11153 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11155 * This appends a custom item provider to the list for that entry
11157 * This appends the given callback. The list is walked from beginning to end
11158 * with each function called given the item href string in the text. If the
11159 * function returns an object handle other than NULL (it should create an
11160 * object to do this), then this object is used to replace that item. If
11161 * not the next provider is called until one provides an item object, or the
11162 * default provider in entry does.
11164 * @param obj The entry object
11165 * @param func The function called to provide the item object
11166 * @param data The data passed to @p func
11168 * @see @ref entry-items
11170 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);
11172 * This prepends a custom item provider to the list for that entry
11174 * This prepends the given callback. See elm_entry_item_provider_append() for
11177 * @param obj The entry object
11178 * @param func The function called to provide the item object
11179 * @param data The data passed to @p func
11181 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);
11183 * This removes a custom item provider to the list for that entry
11185 * This removes the given callback. See elm_entry_item_provider_append() for
11188 * @param obj The entry object
11189 * @param func The function called to provide the item object
11190 * @param data The data passed to @p func
11192 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);
11194 * Append a filter function for text inserted in the entry
11196 * Append the given callback to the list. This functions will be called
11197 * whenever any text is inserted into the entry, with the text to be inserted
11198 * as a parameter. The callback function is free to alter the text in any way
11199 * it wants, but it must remember to free the given pointer and update it.
11200 * If the new text is to be discarded, the function can free it and set its
11201 * text parameter to NULL. This will also prevent any following filters from
11204 * @param obj The entry object
11205 * @param func The function to use as text filter
11206 * @param data User data to pass to @p func
11208 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11210 * Prepend a filter function for text insdrted in the entry
11212 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11213 * for more information
11215 * @param obj The entry object
11216 * @param func The function to use as text filter
11217 * @param data User data to pass to @p func
11219 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11221 * Remove a filter from the list
11223 * Removes the given callback from the filter list. See
11224 * elm_entry_text_filter_append() for more information.
11226 * @param obj The entry object
11227 * @param func The filter function to remove
11228 * @param data The user data passed when adding the function
11230 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11232 * This converts a markup (HTML-like) string into UTF-8.
11234 * The returned string is a malloc'ed buffer and it should be freed when
11235 * not needed anymore.
11237 * @param s The string (in markup) to be converted
11238 * @return The converted string (in UTF-8). It should be freed.
11240 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11242 * This converts a UTF-8 string into markup (HTML-like).
11244 * The returned string is a malloc'ed buffer and it should be freed when
11245 * not needed anymore.
11247 * @param s The string (in UTF-8) to be converted
11248 * @return The converted string (in markup). It should be freed.
11250 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11252 * This sets the file (and implicitly loads it) for the text to display and
11253 * then edit. All changes are written back to the file after a short delay if
11254 * the entry object is set to autosave (which is the default).
11256 * If the entry had any other file set previously, any changes made to it
11257 * will be saved if the autosave feature is enabled, otherwise, the file
11258 * will be silently discarded and any non-saved changes will be lost.
11260 * @param obj The entry object
11261 * @param file The path to the file to load and save
11262 * @param format The file format
11264 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11266 * Gets the file being edited by the entry.
11268 * This function can be used to retrieve any file set on the entry for
11269 * edition, along with the format used to load and save it.
11271 * @param obj The entry object
11272 * @param file The path to the file to load and save
11273 * @param format The file format
11275 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11277 * This function writes any changes made to the file set with
11278 * elm_entry_file_set()
11280 * @param obj The entry object
11282 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11284 * This sets the entry object to 'autosave' the loaded text file or not.
11286 * @param obj The entry object
11287 * @param autosave Autosave the loaded file or not
11289 * @see elm_entry_file_set()
11291 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11293 * This gets the entry object's 'autosave' status.
11295 * @param obj The entry object
11296 * @return Autosave the loaded file or not
11298 * @see elm_entry_file_set()
11300 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11302 * Control pasting of text and images for the widget.
11304 * Normally the entry allows both text and images to be pasted. By setting
11305 * textonly to be true, this prevents images from being pasted.
11307 * Note this only changes the behaviour of text.
11309 * @param obj The entry object
11310 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11311 * text+image+other.
11313 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11315 * Getting elm_entry text paste/drop mode.
11317 * In textonly mode, only text may be pasted or dropped into the widget.
11319 * @param obj The entry object
11320 * @return If the widget only accepts text from pastes.
11322 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11324 * Enable or disable scrolling in entry
11326 * Normally the entry is not scrollable unless you enable it with this call.
11328 * @param obj The entry object
11329 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11331 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11333 * Get the scrollable state of the entry
11335 * Normally the entry is not scrollable. This gets the scrollable state
11336 * of the entry. See elm_entry_scrollable_set() for more information.
11338 * @param obj The entry object
11339 * @return The scrollable state
11341 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11343 * This sets a widget to be displayed to the left of a scrolled entry.
11345 * @param obj The scrolled entry object
11346 * @param icon The widget to display on the left side of the scrolled
11349 * @note A previously set widget will be destroyed.
11350 * @note If the object being set does not have minimum size hints set,
11351 * it won't get properly displayed.
11353 * @see elm_entry_end_set()
11355 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11357 * Gets the leftmost widget of the scrolled entry. This object is
11358 * owned by the scrolled entry and should not be modified.
11360 * @param obj The scrolled entry object
11361 * @return the left widget inside the scroller
11363 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11365 * Unset the leftmost widget of the scrolled entry, unparenting and
11368 * @param obj The scrolled entry object
11369 * @return the previously set icon sub-object of this entry, on
11372 * @see elm_entry_icon_set()
11374 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11376 * Sets the visibility of the left-side widget of the scrolled entry,
11377 * set by elm_entry_icon_set().
11379 * @param obj The scrolled entry object
11380 * @param setting EINA_TRUE if the object should be displayed,
11381 * EINA_FALSE if not.
11383 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11385 * This sets a widget to be displayed to the end of a scrolled entry.
11387 * @param obj The scrolled entry object
11388 * @param end The widget to display on the right side of the scrolled
11391 * @note A previously set widget will be destroyed.
11392 * @note If the object being set does not have minimum size hints set,
11393 * it won't get properly displayed.
11395 * @see elm_entry_icon_set
11397 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11399 * Gets the endmost widget of the scrolled entry. This object is owned
11400 * by the scrolled entry and should not be modified.
11402 * @param obj The scrolled entry object
11403 * @return the right widget inside the scroller
11405 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11407 * Unset the endmost widget of the scrolled entry, unparenting and
11410 * @param obj The scrolled entry object
11411 * @return the previously set icon sub-object of this entry, on
11414 * @see elm_entry_icon_set()
11416 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11418 * Sets the visibility of the end widget of the scrolled entry, set by
11419 * elm_entry_end_set().
11421 * @param obj The scrolled entry object
11422 * @param setting EINA_TRUE if the object should be displayed,
11423 * EINA_FALSE if not.
11425 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11427 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11430 * Setting an entry to single-line mode with elm_entry_single_line_set()
11431 * will automatically disable the display of scrollbars when the entry
11432 * moves inside its scroller.
11434 * @param obj The scrolled entry object
11435 * @param h The horizontal scrollbar policy to apply
11436 * @param v The vertical scrollbar policy to apply
11438 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11440 * This enables/disables bouncing within the entry.
11442 * This function sets whether the entry will bounce when scrolling reaches
11443 * the end of the contained entry.
11445 * @param obj The scrolled entry object
11446 * @param h The horizontal bounce state
11447 * @param v The vertical bounce state
11449 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11451 * Get the bounce mode
11453 * @param obj The Entry object
11454 * @param h_bounce Allow bounce horizontally
11455 * @param v_bounce Allow bounce vertically
11457 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11459 /* pre-made filters for entries */
11461 * @typedef Elm_Entry_Filter_Limit_Size
11463 * Data for the elm_entry_filter_limit_size() entry filter.
11465 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11467 * @struct _Elm_Entry_Filter_Limit_Size
11469 * Data for the elm_entry_filter_limit_size() entry filter.
11471 struct _Elm_Entry_Filter_Limit_Size
11473 int max_char_count; /**< The maximum number of characters allowed. */
11474 int max_byte_count; /**< The maximum number of bytes allowed*/
11477 * Filter inserted text based on user defined character and byte limits
11479 * Add this filter to an entry to limit the characters that it will accept
11480 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11481 * The funtion works on the UTF-8 representation of the string, converting
11482 * it from the set markup, thus not accounting for any format in it.
11484 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11485 * it as data when setting the filter. In it, it's possible to set limits
11486 * by character count or bytes (any of them is disabled if 0), and both can
11487 * be set at the same time. In that case, it first checks for characters,
11490 * The function will cut the inserted text in order to allow only the first
11491 * number of characters that are still allowed. The cut is made in
11492 * characters, even when limiting by bytes, in order to always contain
11493 * valid ones and avoid half unicode characters making it in.
11495 * This filter, like any others, does not apply when setting the entry text
11496 * directly with elm_object_text_set() (or the deprecated
11497 * elm_entry_entry_set()).
11499 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11501 * @typedef Elm_Entry_Filter_Accept_Set
11503 * Data for the elm_entry_filter_accept_set() entry filter.
11505 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11507 * @struct _Elm_Entry_Filter_Accept_Set
11509 * Data for the elm_entry_filter_accept_set() entry filter.
11511 struct _Elm_Entry_Filter_Accept_Set
11513 const char *accepted; /**< Set of characters accepted in the entry. */
11514 const char *rejected; /**< Set of characters rejected from the entry. */
11517 * Filter inserted text based on accepted or rejected sets of characters
11519 * Add this filter to an entry to restrict the set of accepted characters
11520 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11521 * This structure contains both accepted and rejected sets, but they are
11522 * mutually exclusive.
11524 * The @c accepted set takes preference, so if it is set, the filter will
11525 * only work based on the accepted characters, ignoring anything in the
11526 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11528 * In both cases, the function filters by matching utf8 characters to the
11529 * raw markup text, so it can be used to remove formatting tags.
11531 * This filter, like any others, does not apply when setting the entry text
11532 * directly with elm_object_text_set() (or the deprecated
11533 * elm_entry_entry_set()).
11535 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11537 * Set the input panel layout of the entry
11539 * @param obj The entry object
11540 * @param layout layout type
11542 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11544 * Get the input panel layout of the entry
11546 * @param obj The entry object
11547 * @return layout type
11549 * @see elm_entry_input_panel_layout_set
11551 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11556 /* composite widgets - these basically put together basic widgets above
11557 * in convenient packages that do more than basic stuff */
11561 * @defgroup Anchorview Anchorview
11563 * @image html img/widget/anchorview/preview-00.png
11564 * @image latex img/widget/anchorview/preview-00.eps
11566 * Anchorview is for displaying text that contains markup with anchors
11567 * like <c>\<a href=1234\>something\</\></c> in it.
11569 * Besides being styled differently, the anchorview widget provides the
11570 * necessary functionality so that clicking on these anchors brings up a
11571 * popup with user defined content such as "call", "add to contacts" or
11572 * "open web page". This popup is provided using the @ref Hover widget.
11574 * This widget is very similar to @ref Anchorblock, so refer to that
11575 * widget for an example. The only difference Anchorview has is that the
11576 * widget is already provided with scrolling functionality, so if the
11577 * text set to it is too large to fit in the given space, it will scroll,
11578 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11579 * text can be displayed.
11581 * This widget emits the following signals:
11582 * @li "anchor,clicked": will be called when an anchor is clicked. The
11583 * @p event_info parameter on the callback will be a pointer of type
11584 * ::Elm_Entry_Anchorview_Info.
11586 * See @ref Anchorblock for an example on how to use both of them.
11595 * @typedef Elm_Entry_Anchorview_Info
11597 * The info sent in the callback for "anchor,clicked" signals emitted by
11598 * the Anchorview widget.
11600 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11602 * @struct _Elm_Entry_Anchorview_Info
11604 * The info sent in the callback for "anchor,clicked" signals emitted by
11605 * the Anchorview widget.
11607 struct _Elm_Entry_Anchorview_Info
11609 const char *name; /**< Name of the anchor, as indicated in its href
11611 int button; /**< The mouse button used to click on it */
11612 Evas_Object *hover; /**< The hover object to use for the popup */
11614 Evas_Coord x, y, w, h;
11615 } anchor, /**< Geometry selection of text used as anchor */
11616 hover_parent; /**< Geometry of the object used as parent by the
11618 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11619 for content on the left side of
11620 the hover. Before calling the
11621 callback, the widget will make the
11622 necessary calculations to check
11623 which sides are fit to be set with
11624 content, based on the position the
11625 hover is activated and its distance
11626 to the edges of its parent object
11628 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11629 the right side of the hover.
11630 See @ref hover_left */
11631 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11632 of the hover. See @ref hover_left */
11633 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11634 below the hover. See @ref
11638 * Add a new Anchorview object
11640 * @param parent The parent object
11641 * @return The new object or NULL if it cannot be created
11643 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11645 * Set the text to show in the anchorview
11647 * Sets the text of the anchorview to @p text. This text can include markup
11648 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11649 * text that will be specially styled and react to click events, ended with
11650 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11651 * "anchor,clicked" signal that you can attach a callback to with
11652 * evas_object_smart_callback_add(). The name of the anchor given in the
11653 * event info struct will be the one set in the href attribute, in this
11654 * case, anchorname.
11656 * Other markup can be used to style the text in different ways, but it's
11657 * up to the style defined in the theme which tags do what.
11658 * @deprecated use elm_object_text_set() instead.
11660 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11662 * Get the markup text set for the anchorview
11664 * Retrieves the text set on the anchorview, with markup tags included.
11666 * @param obj The anchorview object
11667 * @return The markup text set or @c NULL if nothing was set or an error
11669 * @deprecated use elm_object_text_set() instead.
11671 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11673 * Set the parent of the hover popup
11675 * Sets the parent object to use by the hover created by the anchorview
11676 * when an anchor is clicked. See @ref Hover for more details on this.
11677 * If no parent is set, the same anchorview object will be used.
11679 * @param obj The anchorview object
11680 * @param parent The object to use as parent for the hover
11682 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11684 * Get the parent of the hover popup
11686 * Get the object used as parent for the hover created by the anchorview
11687 * widget. See @ref Hover for more details on this.
11689 * @param obj The anchorview object
11690 * @return The object used as parent for the hover, NULL if none is set.
11692 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11694 * Set the style that the hover should use
11696 * When creating the popup hover, anchorview will request that it's
11697 * themed according to @p style.
11699 * @param obj The anchorview object
11700 * @param style The style to use for the underlying hover
11702 * @see elm_object_style_set()
11704 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11706 * Get the style that the hover should use
11708 * Get the style the hover created by anchorview will use.
11710 * @param obj The anchorview object
11711 * @return The style to use by the hover. NULL means the default is used.
11713 * @see elm_object_style_set()
11715 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11717 * Ends the hover popup in the anchorview
11719 * When an anchor is clicked, the anchorview widget will create a hover
11720 * object to use as a popup with user provided content. This function
11721 * terminates this popup, returning the anchorview to its normal state.
11723 * @param obj The anchorview object
11725 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11727 * Set bouncing behaviour when the scrolled content reaches an edge
11729 * Tell the internal scroller object whether it should bounce or not
11730 * when it reaches the respective edges for each axis.
11732 * @param obj The anchorview object
11733 * @param h_bounce Whether to bounce or not in the horizontal axis
11734 * @param v_bounce Whether to bounce or not in the vertical axis
11736 * @see elm_scroller_bounce_set()
11738 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11740 * Get the set bouncing behaviour of the internal scroller
11742 * Get whether the internal scroller should bounce when the edge of each
11743 * axis is reached scrolling.
11745 * @param obj The anchorview object
11746 * @param h_bounce Pointer where to store the bounce state of the horizontal
11748 * @param v_bounce Pointer where to store the bounce state of the vertical
11751 * @see elm_scroller_bounce_get()
11753 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11755 * Appends a custom item provider to the given anchorview
11757 * Appends the given function to the list of items providers. This list is
11758 * called, one function at a time, with the given @p data pointer, the
11759 * anchorview object and, in the @p item parameter, the item name as
11760 * referenced in its href string. Following functions in the list will be
11761 * called in order until one of them returns something different to NULL,
11762 * which should be an Evas_Object which will be used in place of the item
11765 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11766 * href=item/name\>\</item\>
11768 * @param obj The anchorview object
11769 * @param func The function to add to the list of providers
11770 * @param data User data that will be passed to the callback function
11772 * @see elm_entry_item_provider_append()
11774 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);
11776 * Prepend a custom item provider to the given anchorview
11778 * Like elm_anchorview_item_provider_append(), but it adds the function
11779 * @p func to the beginning of the list, instead of the end.
11781 * @param obj The anchorview object
11782 * @param func The function to add to the list of providers
11783 * @param data User data that will be passed to the callback function
11785 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);
11787 * Remove a custom item provider from the list of the given anchorview
11789 * Removes the function and data pairing that matches @p func and @p data.
11790 * That is, unless the same function and same user data are given, the
11791 * function will not be removed from the list. This allows us to add the
11792 * same callback several times, with different @p data pointers and be
11793 * able to remove them later without conflicts.
11795 * @param obj The anchorview object
11796 * @param func The function to remove from the list
11797 * @param data The data matching the function to remove from the list
11799 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);
11806 * @defgroup Anchorblock Anchorblock
11808 * @image html img/widget/anchorblock/preview-00.png
11809 * @image latex img/widget/anchorblock/preview-00.eps
11811 * Anchorblock is for displaying text that contains markup with anchors
11812 * like <c>\<a href=1234\>something\</\></c> in it.
11814 * Besides being styled differently, the anchorblock widget provides the
11815 * necessary functionality so that clicking on these anchors brings up a
11816 * popup with user defined content such as "call", "add to contacts" or
11817 * "open web page". This popup is provided using the @ref Hover widget.
11819 * This widget emits the following signals:
11820 * @li "anchor,clicked": will be called when an anchor is clicked. The
11821 * @p event_info parameter on the callback will be a pointer of type
11822 * ::Elm_Entry_Anchorblock_Info.
11828 * Since examples are usually better than plain words, we might as well
11829 * try @ref tutorial_anchorblock_example "one".
11832 * @addtogroup Anchorblock
11836 * @typedef Elm_Entry_Anchorblock_Info
11838 * The info sent in the callback for "anchor,clicked" signals emitted by
11839 * the Anchorblock widget.
11841 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11843 * @struct _Elm_Entry_Anchorblock_Info
11845 * The info sent in the callback for "anchor,clicked" signals emitted by
11846 * the Anchorblock widget.
11848 struct _Elm_Entry_Anchorblock_Info
11850 const char *name; /**< Name of the anchor, as indicated in its href
11852 int button; /**< The mouse button used to click on it */
11853 Evas_Object *hover; /**< The hover object to use for the popup */
11855 Evas_Coord x, y, w, h;
11856 } anchor, /**< Geometry selection of text used as anchor */
11857 hover_parent; /**< Geometry of the object used as parent by the
11859 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11860 for content on the left side of
11861 the hover. Before calling the
11862 callback, the widget will make the
11863 necessary calculations to check
11864 which sides are fit to be set with
11865 content, based on the position the
11866 hover is activated and its distance
11867 to the edges of its parent object
11869 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11870 the right side of the hover.
11871 See @ref hover_left */
11872 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11873 of the hover. See @ref hover_left */
11874 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11875 below the hover. See @ref
11879 * Add a new Anchorblock object
11881 * @param parent The parent object
11882 * @return The new object or NULL if it cannot be created
11884 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11886 * Set the text to show in the anchorblock
11888 * Sets the text of the anchorblock to @p text. This text can include markup
11889 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11890 * of text that will be specially styled and react to click events, ended
11891 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11892 * "anchor,clicked" signal that you can attach a callback to with
11893 * evas_object_smart_callback_add(). The name of the anchor given in the
11894 * event info struct will be the one set in the href attribute, in this
11895 * case, anchorname.
11897 * Other markup can be used to style the text in different ways, but it's
11898 * up to the style defined in the theme which tags do what.
11899 * @deprecated use elm_object_text_set() instead.
11901 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11903 * Get the markup text set for the anchorblock
11905 * Retrieves the text set on the anchorblock, with markup tags included.
11907 * @param obj The anchorblock object
11908 * @return The markup text set or @c NULL if nothing was set or an error
11910 * @deprecated use elm_object_text_set() instead.
11912 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11914 * Set the parent of the hover popup
11916 * Sets the parent object to use by the hover created by the anchorblock
11917 * when an anchor is clicked. See @ref Hover for more details on this.
11919 * @param obj The anchorblock object
11920 * @param parent The object to use as parent for the hover
11922 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11924 * Get the parent of the hover popup
11926 * Get the object used as parent for the hover created by the anchorblock
11927 * widget. See @ref Hover for more details on this.
11928 * If no parent is set, the same anchorblock object will be used.
11930 * @param obj The anchorblock object
11931 * @return The object used as parent for the hover, NULL if none is set.
11933 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11935 * Set the style that the hover should use
11937 * When creating the popup hover, anchorblock will request that it's
11938 * themed according to @p style.
11940 * @param obj The anchorblock object
11941 * @param style The style to use for the underlying hover
11943 * @see elm_object_style_set()
11945 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11947 * Get the style that the hover should use
11949 * Get the style the hover created by anchorblock will use.
11951 * @param obj The anchorblock object
11952 * @return The style to use by the hover. NULL means the default is used.
11954 * @see elm_object_style_set()
11956 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11958 * Ends the hover popup in the anchorblock
11960 * When an anchor is clicked, the anchorblock widget will create a hover
11961 * object to use as a popup with user provided content. This function
11962 * terminates this popup, returning the anchorblock to its normal state.
11964 * @param obj The anchorblock object
11966 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11968 * Appends a custom item provider to the given anchorblock
11970 * Appends the given function to the list of items providers. This list is
11971 * called, one function at a time, with the given @p data pointer, the
11972 * anchorblock object and, in the @p item parameter, the item name as
11973 * referenced in its href string. Following functions in the list will be
11974 * called in order until one of them returns something different to NULL,
11975 * which should be an Evas_Object which will be used in place of the item
11978 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11979 * href=item/name\>\</item\>
11981 * @param obj The anchorblock object
11982 * @param func The function to add to the list of providers
11983 * @param data User data that will be passed to the callback function
11985 * @see elm_entry_item_provider_append()
11987 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);
11989 * Prepend a custom item provider to the given anchorblock
11991 * Like elm_anchorblock_item_provider_append(), but it adds the function
11992 * @p func to the beginning of the list, instead of the end.
11994 * @param obj The anchorblock object
11995 * @param func The function to add to the list of providers
11996 * @param data User data that will be passed to the callback function
11998 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);
12000 * Remove a custom item provider from the list of the given anchorblock
12002 * Removes the function and data pairing that matches @p func and @p data.
12003 * That is, unless the same function and same user data are given, the
12004 * function will not be removed from the list. This allows us to add the
12005 * same callback several times, with different @p data pointers and be
12006 * able to remove them later without conflicts.
12008 * @param obj The anchorblock object
12009 * @param func The function to remove from the list
12010 * @param data The data matching the function to remove from the list
12012 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);
12018 * @defgroup Bubble Bubble
12020 * @image html img/widget/bubble/preview-00.png
12021 * @image latex img/widget/bubble/preview-00.eps
12022 * @image html img/widget/bubble/preview-01.png
12023 * @image latex img/widget/bubble/preview-01.eps
12024 * @image html img/widget/bubble/preview-02.png
12025 * @image latex img/widget/bubble/preview-02.eps
12027 * @brief The Bubble is a widget to show text similarly to how speech is
12028 * represented in comics.
12030 * The bubble widget contains 5 important visual elements:
12031 * @li The frame is a rectangle with rounded rectangles and an "arrow".
12032 * @li The @p icon is an image to which the frame's arrow points to.
12033 * @li The @p label is a text which appears to the right of the icon if the
12034 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12036 * @li The @p info is a text which appears to the right of the label. Info's
12037 * font is of a ligther color than label.
12038 * @li The @p content is an evas object that is shown inside the frame.
12040 * The position of the arrow, icon, label and info depends on which corner is
12041 * selected. The four available corners are:
12042 * @li "top_left" - Default
12044 * @li "bottom_left"
12045 * @li "bottom_right"
12047 * Signals that you can add callbacks for are:
12048 * @li "clicked" - This is called when a user has clicked the bubble.
12050 * For an example of using a buble see @ref bubble_01_example_page "this".
12055 * Add a new bubble to the parent
12057 * @param parent The parent object
12058 * @return The new object or NULL if it cannot be created
12060 * This function adds a text bubble to the given parent evas object.
12062 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12064 * Set the label of the bubble
12066 * @param obj The bubble object
12067 * @param label The string to set in the label
12069 * This function sets the title of the bubble. Where this appears depends on
12070 * the selected corner.
12071 * @deprecated use elm_object_text_set() instead.
12073 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12075 * Get the label of the bubble
12077 * @param obj The bubble object
12078 * @return The string of set in the label
12080 * This function gets the title of the bubble.
12081 * @deprecated use elm_object_text_get() instead.
12083 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12085 * Set the info of the bubble
12087 * @param obj The bubble object
12088 * @param info The given info about the bubble
12090 * This function sets the info of the bubble. Where this appears depends on
12091 * the selected corner.
12092 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12094 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12096 * Get the info of the bubble
12098 * @param obj The bubble object
12100 * @return The "info" string of the bubble
12102 * This function gets the info text.
12103 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12105 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12107 * Set the content to be shown in the bubble
12109 * Once the content object is set, a previously set one will be deleted.
12110 * If you want to keep the old content object, use the
12111 * elm_bubble_content_unset() function.
12113 * @param obj The bubble object
12114 * @param content The given content of the bubble
12116 * This function sets the content shown on the middle of the bubble.
12118 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12120 * Get the content shown in the bubble
12122 * Return the content object which is set for this widget.
12124 * @param obj The bubble object
12125 * @return The content that is being used
12127 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12129 * Unset the content shown in the bubble
12131 * Unparent and return the content object which was set for this widget.
12133 * @param obj The bubble object
12134 * @return The content that was being used
12136 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12138 * Set the icon of the bubble
12140 * Once the icon object is set, a previously set one will be deleted.
12141 * If you want to keep the old content object, use the
12142 * elm_icon_content_unset() function.
12144 * @param obj The bubble object
12145 * @param icon The given icon for the bubble
12147 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12149 * Get the icon of the bubble
12151 * @param obj The bubble object
12152 * @return The icon for the bubble
12154 * This function gets the icon shown on the top left of bubble.
12156 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12158 * Unset the icon of the bubble
12160 * Unparent and return the icon object which was set for this widget.
12162 * @param obj The bubble object
12163 * @return The icon that was being used
12165 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12167 * Set the corner of the bubble
12169 * @param obj The bubble object.
12170 * @param corner The given corner for the bubble.
12172 * This function sets the corner of the bubble. The corner will be used to
12173 * determine where the arrow in the frame points to and where label, icon and
12176 * Possible values for corner are:
12177 * @li "top_left" - Default
12179 * @li "bottom_left"
12180 * @li "bottom_right"
12182 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12184 * Get the corner of the bubble
12186 * @param obj The bubble object.
12187 * @return The given corner for the bubble.
12189 * This function gets the selected corner of the bubble.
12191 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12197 * @defgroup Photo Photo
12199 * For displaying the photo of a person (contact). Simple yet
12200 * with a very specific purpose.
12202 * Signals that you can add callbacks for are:
12204 * "clicked" - This is called when a user has clicked the photo
12205 * "drag,start" - Someone started dragging the image out of the object
12206 * "drag,end" - Dragged item was dropped (somewhere)
12212 * Add a new photo to the parent
12214 * @param parent The parent object
12215 * @return The new object or NULL if it cannot be created
12219 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12222 * Set the file that will be used as photo
12224 * @param obj The photo object
12225 * @param file The path to file that will be used as photo
12227 * @return (1 = success, 0 = error)
12231 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12234 * Set the file that will be used as thumbnail in the photo.
12236 * @param obj The photo object.
12237 * @param file The path to file that will be used as thumb.
12238 * @param group The key used in case of an EET file.
12242 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12245 * Set the size that will be used on the photo
12247 * @param obj The photo object
12248 * @param size The size that the photo will be
12252 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12255 * Set if the photo should be completely visible or not.
12257 * @param obj The photo object
12258 * @param fill if true the photo will be completely visible
12262 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12265 * Set editability of the photo.
12267 * An editable photo can be dragged to or from, and can be cut or
12268 * pasted too. Note that pasting an image or dropping an item on
12269 * the image will delete the existing content.
12271 * @param obj The photo object.
12272 * @param set To set of clear editablity.
12274 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12280 /* gesture layer */
12282 * @defgroup Elm_Gesture_Layer Gesture Layer
12283 * Gesture Layer Usage:
12285 * Use Gesture Layer to detect gestures.
12286 * The advantage is that you don't have to implement
12287 * gesture detection, just set callbacks of gesture state.
12288 * By using gesture layer we make standard interface.
12290 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12291 * with a parent object parameter.
12292 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12293 * call. Usually with same object as target (2nd parameter).
12295 * Now you need to tell gesture layer what gestures you follow.
12296 * This is done with @ref elm_gesture_layer_cb_set call.
12297 * By setting the callback you actually saying to gesture layer:
12298 * I would like to know when the gesture @ref Elm_Gesture_Types
12299 * switches to state @ref Elm_Gesture_State.
12301 * Next, you need to implement the actual action that follows the input
12302 * in your callback.
12304 * Note that if you like to stop being reported about a gesture, just set
12305 * all callbacks referring this gesture to NULL.
12306 * (again with @ref elm_gesture_layer_cb_set)
12308 * The information reported by gesture layer to your callback is depending
12309 * on @ref Elm_Gesture_Types:
12310 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12311 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12312 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12314 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12315 * @ref ELM_GESTURE_MOMENTUM.
12317 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12318 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12319 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12320 * Note that we consider a flick as a line-gesture that should be completed
12321 * in flick-time-limit as defined in @ref Config.
12323 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12325 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12328 * Gesture Layer Tweaks:
12330 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12331 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12333 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12334 * so gesture starts when user touches (a *DOWN event) touch-surface
12335 * and ends when no fingers touches surface (a *UP event).
12339 * @enum _Elm_Gesture_Types
12340 * Enum of supported gesture types.
12341 * @ingroup Elm_Gesture_Layer
12343 enum _Elm_Gesture_Types
12345 ELM_GESTURE_FIRST = 0,
12347 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12348 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12349 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12350 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12352 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12354 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12355 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12357 ELM_GESTURE_ZOOM, /**< Zoom */
12358 ELM_GESTURE_ROTATE, /**< Rotate */
12364 * @typedef Elm_Gesture_Types
12365 * gesture types enum
12366 * @ingroup Elm_Gesture_Layer
12368 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12371 * @enum _Elm_Gesture_State
12372 * Enum of gesture states.
12373 * @ingroup Elm_Gesture_Layer
12375 enum _Elm_Gesture_State
12377 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12378 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12379 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12380 ELM_GESTURE_STATE_END, /**< Gesture completed */
12381 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12385 * @typedef Elm_Gesture_State
12386 * gesture states enum
12387 * @ingroup Elm_Gesture_Layer
12389 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12392 * @struct _Elm_Gesture_Taps_Info
12393 * Struct holds taps info for user
12394 * @ingroup Elm_Gesture_Layer
12396 struct _Elm_Gesture_Taps_Info
12398 Evas_Coord x, y; /**< Holds center point between fingers */
12399 unsigned int n; /**< Number of fingers tapped */
12400 unsigned int timestamp; /**< event timestamp */
12404 * @typedef Elm_Gesture_Taps_Info
12405 * holds taps info for user
12406 * @ingroup Elm_Gesture_Layer
12408 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12411 * @struct _Elm_Gesture_Momentum_Info
12412 * Struct holds momentum info for user
12413 * x1 and y1 are not necessarily in sync
12414 * x1 holds x value of x direction starting point
12415 * and same holds for y1.
12416 * This is noticeable when doing V-shape movement
12417 * @ingroup Elm_Gesture_Layer
12419 struct _Elm_Gesture_Momentum_Info
12420 { /* Report line ends, timestamps, and momentum computed */
12421 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12422 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12423 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12424 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12426 unsigned int tx; /**< Timestamp of start of final x-swipe */
12427 unsigned int ty; /**< Timestamp of start of final y-swipe */
12429 Evas_Coord mx; /**< Momentum on X */
12430 Evas_Coord my; /**< Momentum on Y */
12434 * @typedef Elm_Gesture_Momentum_Info
12435 * holds momentum info for user
12436 * @ingroup Elm_Gesture_Layer
12438 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12441 * @struct _Elm_Gesture_Line_Info
12442 * Struct holds line info for user
12443 * @ingroup Elm_Gesture_Layer
12445 struct _Elm_Gesture_Line_Info
12446 { /* Report line ends, timestamps, and momentum computed */
12447 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12448 unsigned int n; /**< Number of fingers (lines) */
12449 /* FIXME should be radians, bot degrees */
12450 double angle; /**< Angle (direction) of lines */
12454 * @typedef Elm_Gesture_Line_Info
12455 * Holds line info for user
12456 * @ingroup Elm_Gesture_Layer
12458 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12461 * @struct _Elm_Gesture_Zoom_Info
12462 * Struct holds zoom info for user
12463 * @ingroup Elm_Gesture_Layer
12465 struct _Elm_Gesture_Zoom_Info
12467 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12468 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12469 double zoom; /**< Zoom value: 1.0 means no zoom */
12470 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12474 * @typedef Elm_Gesture_Zoom_Info
12475 * Holds zoom info for user
12476 * @ingroup Elm_Gesture_Layer
12478 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12481 * @struct _Elm_Gesture_Rotate_Info
12482 * Struct holds rotation info for user
12483 * @ingroup Elm_Gesture_Layer
12485 struct _Elm_Gesture_Rotate_Info
12487 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12488 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12489 double base_angle; /**< Holds start-angle */
12490 double angle; /**< Rotation value: 0.0 means no rotation */
12491 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12495 * @typedef Elm_Gesture_Rotate_Info
12496 * Holds rotation info for user
12497 * @ingroup Elm_Gesture_Layer
12499 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12502 * @typedef Elm_Gesture_Event_Cb
12503 * User callback used to stream gesture info from gesture layer
12504 * @param data user data
12505 * @param event_info gesture report info
12506 * Returns a flag field to be applied on the causing event.
12507 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12508 * upon the event, in an irreversible way.
12510 * @ingroup Elm_Gesture_Layer
12512 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12515 * Use function to set callbacks to be notified about
12516 * change of state of gesture.
12517 * When a user registers a callback with this function
12518 * this means this gesture has to be tested.
12520 * When ALL callbacks for a gesture are set to NULL
12521 * it means user isn't interested in gesture-state
12522 * and it will not be tested.
12524 * @param obj Pointer to gesture-layer.
12525 * @param idx The gesture you would like to track its state.
12526 * @param cb callback function pointer.
12527 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12528 * @param data user info to be sent to callback (usually, Smart Data)
12530 * @ingroup Elm_Gesture_Layer
12532 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);
12535 * Call this function to get repeat-events settings.
12537 * @param obj Pointer to gesture-layer.
12539 * @return repeat events settings.
12540 * @see elm_gesture_layer_hold_events_set()
12541 * @ingroup Elm_Gesture_Layer
12543 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12546 * This function called in order to make gesture-layer repeat events.
12547 * Set this of you like to get the raw events only if gestures were not detected.
12548 * Clear this if you like gesture layer to fwd events as testing gestures.
12550 * @param obj Pointer to gesture-layer.
12551 * @param r Repeat: TRUE/FALSE
12553 * @ingroup Elm_Gesture_Layer
12555 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12558 * This function sets step-value for zoom action.
12559 * Set step to any positive value.
12560 * Cancel step setting by setting to 0.0
12562 * @param obj Pointer to gesture-layer.
12563 * @param s new zoom step value.
12565 * @ingroup Elm_Gesture_Layer
12567 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12570 * This function sets step-value for rotate action.
12571 * Set step to any positive value.
12572 * Cancel step setting by setting to 0.0
12574 * @param obj Pointer to gesture-layer.
12575 * @param s new roatate step value.
12577 * @ingroup Elm_Gesture_Layer
12579 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12582 * This function called to attach gesture-layer to an Evas_Object.
12583 * @param obj Pointer to gesture-layer.
12584 * @param t Pointer to underlying object (AKA Target)
12586 * @return TRUE, FALSE on success, failure.
12588 * @ingroup Elm_Gesture_Layer
12590 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12593 * Call this function to construct a new gesture-layer object.
12594 * This does not activate the gesture layer. You have to
12595 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12597 * @param parent the parent object.
12599 * @return Pointer to new gesture-layer object.
12601 * @ingroup Elm_Gesture_Layer
12603 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12606 * @defgroup Thumb Thumb
12608 * @image html img/widget/thumb/preview-00.png
12609 * @image latex img/widget/thumb/preview-00.eps
12611 * A thumb object is used for displaying the thumbnail of an image or video.
12612 * You must have compiled Elementary with Ethumb_Client support and the DBus
12613 * service must be present and auto-activated in order to have thumbnails to
12616 * Once the thumbnail object becomes visible, it will check if there is a
12617 * previously generated thumbnail image for the file set on it. If not, it
12618 * will start generating this thumbnail.
12620 * Different config settings will cause different thumbnails to be generated
12621 * even on the same file.
12623 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12624 * Ethumb documentation to change this path, and to see other configuration
12627 * Signals that you can add callbacks for are:
12629 * - "clicked" - This is called when a user has clicked the thumb without dragging
12631 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12632 * - "press" - This is called when a user has pressed down the thumb.
12633 * - "generate,start" - The thumbnail generation started.
12634 * - "generate,stop" - The generation process stopped.
12635 * - "generate,error" - The generation failed.
12636 * - "load,error" - The thumbnail image loading failed.
12638 * available styles:
12642 * An example of use of thumbnail:
12644 * - @ref thumb_example_01
12648 * @addtogroup Thumb
12653 * @enum _Elm_Thumb_Animation_Setting
12654 * @typedef Elm_Thumb_Animation_Setting
12656 * Used to set if a video thumbnail is animating or not.
12660 typedef enum _Elm_Thumb_Animation_Setting
12662 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12663 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12664 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12665 ELM_THUMB_ANIMATION_LAST
12666 } Elm_Thumb_Animation_Setting;
12669 * Add a new thumb object to the parent.
12671 * @param parent The parent object.
12672 * @return The new object or NULL if it cannot be created.
12674 * @see elm_thumb_file_set()
12675 * @see elm_thumb_ethumb_client_get()
12679 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12681 * Reload thumbnail if it was generated before.
12683 * @param obj The thumb object to reload
12685 * This is useful if the ethumb client configuration changed, like its
12686 * size, aspect or any other property one set in the handle returned
12687 * by elm_thumb_ethumb_client_get().
12689 * If the options didn't change, the thumbnail won't be generated again, but
12690 * the old one will still be used.
12692 * @see elm_thumb_file_set()
12696 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12698 * Set the file that will be used as thumbnail.
12700 * @param obj The thumb object.
12701 * @param file The path to file that will be used as thumb.
12702 * @param key The key used in case of an EET file.
12704 * The file can be an image or a video (in that case, acceptable extensions are:
12705 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12706 * function elm_thumb_animate().
12708 * @see elm_thumb_file_get()
12709 * @see elm_thumb_reload()
12710 * @see elm_thumb_animate()
12714 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12716 * Get the image or video path and key used to generate the thumbnail.
12718 * @param obj The thumb object.
12719 * @param file Pointer to filename.
12720 * @param key Pointer to key.
12722 * @see elm_thumb_file_set()
12723 * @see elm_thumb_path_get()
12727 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12729 * Get the path and key to the image or video generated by ethumb.
12731 * One just need to make sure that the thumbnail was generated before getting
12732 * its path; otherwise, the path will be NULL. One way to do that is by asking
12733 * for the path when/after the "generate,stop" smart callback is called.
12735 * @param obj The thumb object.
12736 * @param file Pointer to thumb path.
12737 * @param key Pointer to thumb key.
12739 * @see elm_thumb_file_get()
12743 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12745 * Set the animation state for the thumb object. If its content is an animated
12746 * video, you may start/stop the animation or tell it to play continuously and
12749 * @param obj The thumb object.
12750 * @param setting The animation setting.
12752 * @see elm_thumb_file_set()
12756 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12758 * Get the animation state for the thumb object.
12760 * @param obj The thumb object.
12761 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12764 * @see elm_thumb_animate_set()
12768 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12770 * Get the ethumb_client handle so custom configuration can be made.
12772 * @return Ethumb_Client instance or NULL.
12774 * This must be called before the objects are created to be sure no object is
12775 * visible and no generation started.
12777 * Example of usage:
12780 * #include <Elementary.h>
12781 * #ifndef ELM_LIB_QUICKLAUNCH
12783 * elm_main(int argc, char **argv)
12785 * Ethumb_Client *client;
12787 * elm_need_ethumb();
12791 * client = elm_thumb_ethumb_client_get();
12794 * ERR("could not get ethumb_client");
12797 * ethumb_client_size_set(client, 100, 100);
12798 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12801 * // Create elm_thumb objects here
12811 * @note There's only one client handle for Ethumb, so once a configuration
12812 * change is done to it, any other request for thumbnails (for any thumbnail
12813 * object) will use that configuration. Thus, this configuration is global.
12817 EAPI void *elm_thumb_ethumb_client_get(void);
12819 * Get the ethumb_client connection state.
12821 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12824 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12826 * Make the thumbnail 'editable'.
12828 * @param obj Thumb object.
12829 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12831 * This means the thumbnail is a valid drag target for drag and drop, and can be
12832 * cut or pasted too.
12834 * @see elm_thumb_editable_get()
12838 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12840 * Make the thumbnail 'editable'.
12842 * @param obj Thumb object.
12843 * @return Editability.
12845 * This means the thumbnail is a valid drag target for drag and drop, and can be
12846 * cut or pasted too.
12848 * @see elm_thumb_editable_set()
12852 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12859 * @defgroup Web Web
12861 * @image html img/widget/web/preview-00.png
12862 * @image latex img/widget/web/preview-00.eps
12864 * A web object is used for displaying web pages (HTML/CSS/JS)
12865 * using WebKit-EFL. You must have compiled Elementary with
12868 * Signals that you can add callbacks for are:
12869 * @li "download,request": A file download has been requested. Event info is
12870 * a pointer to a Elm_Web_Download
12871 * @li "editorclient,contents,changed": Editor client's contents changed
12872 * @li "editorclient,selection,changed": Editor client's selection changed
12873 * @li "frame,created": A new frame was created. Event info is an
12874 * Evas_Object which can be handled with WebKit's ewk_frame API
12875 * @li "icon,received": An icon was received by the main frame
12876 * @li "inputmethod,changed": Input method changed. Event info is an
12877 * Eina_Bool indicating whether it's enabled or not
12878 * @li "js,windowobject,clear": JS window object has been cleared
12879 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12880 * is a char *link[2], where the first string contains the URL the link
12881 * points to, and the second one the title of the link
12882 * @li "link,hover,out": Mouse cursor left the link
12883 * @li "load,document,finished": Loading of a document finished. Event info
12884 * is the frame that finished loading
12885 * @li "load,error": Load failed. Event info is a pointer to
12886 * Elm_Web_Frame_Load_Error
12887 * @li "load,finished": Load finished. Event info is NULL on success, on
12888 * error it's a pointer to Elm_Web_Frame_Load_Error
12889 * @li "load,newwindow,show": A new window was created and is ready to be
12891 * @li "load,progress": Overall load progress. Event info is a pointer to
12892 * a double containing a value between 0.0 and 1.0
12893 * @li "load,provisional": Started provisional load
12894 * @li "load,started": Loading of a document started
12895 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12896 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12897 * the menubar is visible, or EINA_FALSE in case it's not
12898 * @li "menubar,visible,set": Informs menubar visibility. Event info is
12899 * an Eina_Bool indicating the visibility
12900 * @li "popup,created": A dropdown widget was activated, requesting its
12901 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12902 * @li "popup,willdelete": The web object is ready to destroy the popup
12903 * object created. Event info is a pointer to Elm_Web_Menu
12904 * @li "ready": Page is fully loaded
12905 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12906 * info is a pointer to Eina_Bool where the visibility state should be set
12907 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12908 * is an Eina_Bool with the visibility state set
12909 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12910 * a string with the new text
12911 * @li "statusbar,visible,get": Queries visibility of the status bar.
12912 * Event info is a pointer to Eina_Bool where the visibility state should be
12914 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12915 * an Eina_Bool with the visibility value
12916 * @li "title,changed": Title of the main frame changed. Event info is a
12917 * string with the new title
12918 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
12919 * is a pointer to Eina_Bool where the visibility state should be set
12920 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
12921 * info is an Eina_Bool with the visibility state
12922 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
12923 * a string with the text to show
12924 * @li "uri,changed": URI of the main frame changed. Event info is a string
12926 * @li "view,resized": The web object internal's view changed sized
12927 * @li "windows,close,request": A JavaScript request to close the current
12928 * window was requested
12929 * @li "zoom,animated,end": Animated zoom finished
12931 * available styles:
12934 * An example of use of web:
12936 * - @ref web_example_01 TBD
12945 * Structure used to report load errors.
12947 * Load errors are reported as signal by elm_web. All the strings are
12948 * temporary references and should @b not be used after the signal
12949 * callback returns. If it's required, make copies with strdup() or
12950 * eina_stringshare_add() (they are not even guaranteed to be
12951 * stringshared, so must use eina_stringshare_add() and not
12952 * eina_stringshare_ref()).
12954 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
12956 * Structure used to report load errors.
12958 * Load errors are reported as signal by elm_web. All the strings are
12959 * temporary references and should @b not be used after the signal
12960 * callback returns. If it's required, make copies with strdup() or
12961 * eina_stringshare_add() (they are not even guaranteed to be
12962 * stringshared, so must use eina_stringshare_add() and not
12963 * eina_stringshare_ref()).
12965 struct _Elm_Web_Frame_Load_Error
12967 int code; /**< Numeric error code */
12968 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
12969 const char *domain; /**< Error domain name */
12970 const char *description; /**< Error description (already localized) */
12971 const char *failing_url; /**< The URL that failed to load */
12972 Evas_Object *frame; /**< Frame object that produced the error */
12976 * The possibles types that the items in a menu can be
12978 typedef enum _Elm_Web_Menu_Item_Type Elm_Web_Menu_Item_Type;
12980 * The possibles types that the items in a menu can be
12982 enum _Elm_Web_Menu_Item_Type
12984 ELM_WEB_MENU_SEPARATOR,
12985 ELM_WEB_MENU_GROUP,
12986 ELM_WEB_MENU_OPTION
12990 * Structure describing the items in a menu
12992 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
12994 * Structure describing the items in a menu
12996 struct _Elm_Web_Menu_Item
12998 const char *text; /**< The text for the item */
12999 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13003 * Structure describing the menu of a popup
13005 * This structure will be passed as the @c event_info for the "popup,create"
13006 * signal, which is emitted when a dropdown menu is opened. Users wanting
13007 * to handle these popups by themselves should listen to this signal and
13008 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13009 * property as @c EINA_FALSE means that the user will not handle the popup
13010 * and the default implementation will be used.
13012 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13013 * will be emitted to notify the user that it can destroy any objects and
13014 * free all data related to it.
13016 * @see elm_web_popup_selected_set()
13017 * @see elm_web_popup_destroy()
13019 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13021 * Structure describing the menu of a popup
13023 * This structure will be passed as the @c event_info for the "popup,create"
13024 * signal, which is emitted when a dropdown menu is opened. Users wanting
13025 * to handle these popups by themselves should listen to this signal and
13026 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13027 * property as @c EINA_FALSE means that the user will not handle the popup
13028 * and the default implementation will be used.
13030 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13031 * will be emitted to notify the user that it can destroy any objects and
13032 * free all data related to it.
13034 * @see elm_web_popup_selected_set()
13035 * @see elm_web_popup_destroy()
13037 struct _Elm_Web_Menu
13039 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13040 int x; /**< The X position of the popup, relative to the elm_web object */
13041 int y; /**< The Y position of the popup, relative to the elm_web object */
13042 int width; /**< Width of the popup menu */
13043 int height; /**< Height of the popup menu */
13045 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. */
13048 typedef struct _Elm_Web_Download Elm_Web_Download;
13049 struct _Elm_Web_Download
13055 * Opaque handler containing the features (such as statusbar, menubar, etc)
13056 * that are to be set on a newly requested window.
13058 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13060 * Callback type for the create_window hook.
13062 * The function parameters are:
13063 * @li @p data User data pointer set when setting the hook function
13064 * @li @p obj The elm_web object requesting the new window
13065 * @li @p js Set to @c EINA_TRUE if the request was originated from
13066 * JavaScript. @c EINA_FALSE otherwise.
13067 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13068 * the features requested for the new window.
13070 * The returned value of the function should be the @c elm_web widget where
13071 * the request will be loaded. That is, if a new window or tab is created,
13072 * the elm_web widget in it should be returned, and @b NOT the window
13074 * Returning @c NULL should cancel the request.
13076 * @see elm_web_window_create_hook_set()
13078 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13080 * Callback type for the JS alert hook.
13082 * The function parameters are:
13083 * @li @p data User data pointer set when setting the hook function
13084 * @li @p obj The elm_web object requesting the new window
13085 * @li @p message The message to show in the alert dialog
13087 * The function should return the object representing the alert dialog.
13088 * Elm_Web will run a second main loop to handle the dialog and normal
13089 * flow of the application will be restored when the object is deleted, so
13090 * the user should handle the popup properly in order to delete the object
13091 * when the action is finished.
13092 * If the function returns @c NULL the popup will be ignored.
13094 * @see elm_web_dialog_alert_hook_set()
13096 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13098 * Callback type for the JS confirm hook.
13100 * The function parameters are:
13101 * @li @p data User data pointer set when setting the hook function
13102 * @li @p obj The elm_web object requesting the new window
13103 * @li @p message The message to show in the confirm dialog
13104 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13105 * the user selected @c Ok, @c EINA_FALSE otherwise.
13107 * The function should return the object representing the confirm dialog.
13108 * Elm_Web will run a second main loop to handle the dialog and normal
13109 * flow of the application will be restored when the object is deleted, so
13110 * the user should handle the popup properly in order to delete the object
13111 * when the action is finished.
13112 * If the function returns @c NULL the popup will be ignored.
13114 * @see elm_web_dialog_confirm_hook_set()
13116 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13118 * Callback type for the JS prompt hook.
13120 * The function parameters are:
13121 * @li @p data User data pointer set when setting the hook function
13122 * @li @p obj The elm_web object requesting the new window
13123 * @li @p message The message to show in the prompt dialog
13124 * @li @p def_value The default value to present the user in the entry
13125 * @li @p value Pointer where to store the value given by the user. Must
13126 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13127 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13128 * the user selected @c Ok, @c EINA_FALSE otherwise.
13130 * The function should return the object representing the prompt dialog.
13131 * Elm_Web will run a second main loop to handle the dialog and normal
13132 * flow of the application will be restored when the object is deleted, so
13133 * the user should handle the popup properly in order to delete the object
13134 * when the action is finished.
13135 * If the function returns @c NULL the popup will be ignored.
13137 * @see elm_web_dialog_prompt_hook_set()
13139 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13141 * Callback type for the JS file selector hook.
13143 * The function parameters are:
13144 * @li @p data User data pointer set when setting the hook function
13145 * @li @p obj The elm_web object requesting the new window
13146 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13147 * @li @p accept_types Mime types accepted
13148 * @li @p selected Pointer where to store the list of malloc'ed strings
13149 * containing the path to each file selected. Must be @c NULL if the file
13150 * dialog is cancelled
13151 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13152 * the user selected @c Ok, @c EINA_FALSE otherwise.
13154 * The function should return the object representing the file selector
13156 * Elm_Web will run a second main loop to handle the dialog and normal
13157 * flow of the application will be restored when the object is deleted, so
13158 * the user should handle the popup properly in order to delete the object
13159 * when the action is finished.
13160 * If the function returns @c NULL the popup will be ignored.
13162 * @see elm_web_dialog_file selector_hook_set()
13164 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, const char *accept_types, Eina_List **selected, Eina_Bool *ret);
13166 * Callback type for the JS console message hook.
13168 * When a console message is added from JavaScript, any set function to the
13169 * console message hook will be called for the user to handle. There is no
13170 * default implementation of this hook.
13172 * The function parameters are:
13173 * @li @p data User data pointer set when setting the hook function
13174 * @li @p obj The elm_web object that originated the message
13175 * @li @p message The message sent
13176 * @li @p line_number The line number
13177 * @li @p source_id Source id
13179 * @see elm_web_console_message_hook_set()
13181 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13183 * Add a new web object to the parent.
13185 * @param parent The parent object.
13186 * @return The new object or NULL if it cannot be created.
13188 * @see elm_web_uri_set()
13189 * @see elm_web_webkit_view_get()
13191 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13194 * Get internal ewk_view object from web object.
13196 * Elementary may not provide some low level features of EWebKit,
13197 * instead of cluttering the API with proxy methods we opted to
13198 * return the internal reference. Be careful using it as it may
13199 * interfere with elm_web behavior.
13201 * @param obj The web object.
13202 * @return The internal ewk_view object or NULL if it does not
13203 * exist. (Failure to create or Elementary compiled without
13206 * @see elm_web_add()
13208 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13211 * Sets the function to call when a new window is requested
13213 * This hook will be called when a request to create a new window is
13214 * issued from the web page loaded.
13215 * There is no default implementation for this feature, so leaving this
13216 * unset or passing @c NULL in @p func will prevent new windows from
13219 * @param obj The web object where to set the hook function
13220 * @param func The hook function to be called when a window is requested
13221 * @param data User data
13223 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13225 * Sets the function to call when an alert dialog
13227 * This hook will be called when a JavaScript alert dialog is requested.
13228 * If no function is set or @c NULL is passed in @p func, the default
13229 * implementation will take place.
13231 * @param obj The web object where to set the hook function
13232 * @param func The callback function to be used
13233 * @param data User data
13235 * @see elm_web_inwin_mode_set()
13237 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13239 * Sets the function to call when an confirm dialog
13241 * This hook will be called when a JavaScript confirm dialog is requested.
13242 * If no function is set or @c NULL is passed in @p func, the default
13243 * implementation will take place.
13245 * @param obj The web object where to set the hook function
13246 * @param func The callback function to be used
13247 * @param data User data
13249 * @see elm_web_inwin_mode_set()
13251 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13253 * Sets the function to call when an prompt dialog
13255 * This hook will be called when a JavaScript prompt dialog is requested.
13256 * If no function is set or @c NULL is passed in @p func, the default
13257 * implementation will take place.
13259 * @param obj The web object where to set the hook function
13260 * @param func The callback function to be used
13261 * @param data User data
13263 * @see elm_web_inwin_mode_set()
13265 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13267 * Sets the function to call when an file selector dialog
13269 * This hook will be called when a JavaScript file selector dialog is
13271 * If no function is set or @c NULL is passed in @p func, the default
13272 * implementation will take place.
13274 * @param obj The web object where to set the hook function
13275 * @param func The callback function to be used
13276 * @param data User data
13278 * @see elm_web_inwin_mode_set()
13280 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13282 * Sets the function to call when a console message is emitted from JS
13284 * This hook will be called when a console message is emitted from
13285 * JavaScript. There is no default implementation for this feature.
13287 * @param obj The web object where to set the hook function
13288 * @param func The callback function to be used
13289 * @param data User data
13291 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13293 * Gets the status of the tab propagation
13295 * @param obj The web object to query
13296 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13298 * @see elm_web_tab_propagate_set()
13300 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13302 * Sets whether to use tab propagation
13304 * If tab propagation is enabled, whenever the user presses the Tab key,
13305 * Elementary will handle it and switch focus to the next widget.
13306 * The default value is disabled, where WebKit will handle the Tab key to
13307 * cycle focus though its internal objects, jumping to the next widget
13308 * only when that cycle ends.
13310 * @param obj The web object
13311 * @param propagate Whether to propagate Tab keys to Elementary or not
13313 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13315 * Sets the URI for the web object
13317 * It must be a full URI, with resource included, in the form
13318 * http://www.enlightenment.org or file:///tmp/something.html
13320 * @param obj The web object
13321 * @param uri The URI to set
13322 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13324 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13326 * Gets the current URI for the object
13328 * The returned string must not be freed and is guaranteed to be
13331 * @param obj The web object
13332 * @return A stringshared internal string with the current URI, or NULL on
13335 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13337 * Gets the current title
13339 * The returned string must not be freed and is guaranteed to be
13342 * @param obj The web object
13343 * @return A stringshared internal string with the current title, or NULL on
13346 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13348 * Sets the background color to be used by the web object
13350 * This is the color that will be used by default when the loaded page
13351 * does not set it's own. Color values are pre-multiplied.
13353 * @param obj The web object
13354 * @param r Red component
13355 * @param g Green component
13356 * @param b Blue component
13357 * @param a Alpha component
13359 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13361 * Gets the background color to be used by the web object
13363 * This is the color that will be used by default when the loaded page
13364 * does not set it's own. Color values are pre-multiplied.
13366 * @param obj The web object
13367 * @param r Red component
13368 * @param g Green component
13369 * @param b Blue component
13370 * @param a Alpha component
13372 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13374 * Gets a copy of the currently selected text
13376 * The string returned must be freed by the user when it's done with it.
13378 * @param obj The web object
13379 * @return A newly allocated string, or NULL if nothing is selected or an
13382 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13384 * Tells the web object which index in the currently open popup was selected
13386 * When the user handles the popup creation from the "popup,created" signal,
13387 * it needs to tell the web object which item was selected by calling this
13388 * function with the index corresponding to the item.
13390 * @param obj The web object
13391 * @param index The index selected
13393 * @see elm_web_popup_destroy()
13395 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13397 * Dismisses an open dropdown popup
13399 * When the popup from a dropdown widget is to be dismissed, either after
13400 * selecting an option or to cancel it, this function must be called, which
13401 * will later emit an "popup,willdelete" signal to notify the user that
13402 * any memory and objects related to this popup can be freed.
13404 * @param obj The web object
13405 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13406 * if there was no menu to destroy
13408 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13410 * Searches the given string in a document.
13412 * @param obj The web object where to search the text
13413 * @param string String to search
13414 * @param case_sensitive If search should be case sensitive or not
13415 * @param forward If search is from cursor and on or backwards
13416 * @param wrap If search should wrap at the end
13418 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13421 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13423 * Marks matches of the given string in a document.
13425 * @param obj The web object where to search text
13426 * @param string String to match
13427 * @param case_sensitive If match should be case sensitive or not
13428 * @param highlight If matches should be highlighted
13429 * @param limit Maximum amount of matches, or zero to unlimited
13431 * @return number of matched @a string
13433 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13435 * Clears all marked matches in the document
13437 * @param obj The web object
13439 * @return EINA_TRUE on success, EINA_FALSE otherwise
13441 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13443 * Sets whether to highlight the matched marks
13445 * If enabled, marks set with elm_web_text_matches_mark() will be
13448 * @param obj The web object
13449 * @param highlight Whether to highlight the marks or not
13451 * @return EINA_TRUE on success, EINA_FALSE otherwise
13453 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13455 * Gets whether highlighting marks is enabled
13457 * @param The web object
13459 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13462 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13464 * Gets the overall loading progress of the page
13466 * Returns the estimated loading progress of the page, with a value between
13467 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13468 * included in the page.
13470 * @param The web object
13472 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13475 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13477 * Stops loading the current page
13479 * Cancels the loading of the current page in the web object. This will
13480 * cause a "load,error" signal to be emitted, with the is_cancellation
13481 * flag set to EINA_TRUE.
13483 * @param obj The web object
13485 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13487 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13489 * Requests a reload of the current document in the object
13491 * @param obj The web object
13493 * @return EINA_TRUE on success, EINA_FALSE otherwise
13495 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13497 * Requests a reload of the current document, avoiding any existing caches
13499 * @param obj The web object
13501 * @return EINA_TRUE on success, EINA_FALSE otherwise
13503 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13505 * Goes back one step in the browsing history
13507 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13509 * @param obj The web object
13511 * @return EINA_TRUE on success, EINA_FALSE otherwise
13513 * @see elm_web_history_enable_set()
13514 * @see elm_web_back_possible()
13515 * @see elm_web_forward()
13516 * @see elm_web_navigate()
13518 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13520 * Goes forward one step in the browsing history
13522 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13524 * @param obj The web object
13526 * @return EINA_TRUE on success, EINA_FALSE otherwise
13528 * @see elm_web_history_enable_set()
13529 * @see elm_web_forward_possible()
13530 * @see elm_web_back()
13531 * @see elm_web_navigate()
13533 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13535 * Jumps the given number of steps in the browsing history
13537 * The @p steps value can be a negative integer to back in history, or a
13538 * positive to move forward.
13540 * @param obj The web object
13541 * @param steps The number of steps to jump
13543 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13544 * history exists to jump the given number of steps
13546 * @see elm_web_history_enable_set()
13547 * @see elm_web_navigate_possible()
13548 * @see elm_web_back()
13549 * @see elm_web_forward()
13551 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13553 * Queries whether it's possible to go back in history
13555 * @param obj The web object
13557 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13560 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13562 * Queries whether it's possible to go forward in history
13564 * @param obj The web object
13566 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13569 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13571 * Queries whether it's possible to jump the given number of steps
13573 * The @p steps value can be a negative integer to back in history, or a
13574 * positive to move forward.
13576 * @param obj The web object
13577 * @param steps The number of steps to check for
13579 * @return EINA_TRUE if enough history exists to perform the given jump,
13580 * EINA_FALSE otherwise
13582 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13584 * Gets whether browsing history is enabled for the given object
13586 * @param obj The web object
13588 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13590 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13592 * Enables or disables the browsing history
13594 * @param obj The web object
13595 * @param enable Whether to enable or disable the browsing history
13597 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13599 * Gets whether text-only zoom is set
13601 * @param obj The web object
13603 * @return EINA_TRUE if zoom is set to affect only text, EINA_FALSE
13606 * @see elm_web_zoom_text_only_set()
13608 EAPI Eina_Bool elm_web_zoom_text_only_get(const Evas_Object *obj);
13610 * Enables or disables zoom to affect only text
13612 * If set, then the zoom level set to the page will only be applied on text,
13613 * leaving other objects, such as images, at their original size.
13615 * @param obj The web object
13616 * @param setting EINA_TRUE to use text-only zoom, EINA_FALSE to have zoom
13617 * affect the entire page
13619 EAPI void elm_web_zoom_text_only_set(Evas_Object *obj, Eina_Bool setting);
13621 * Sets the default dialogs to use an Inwin instead of a normal window
13623 * If set, then the default implementation for the JavaScript dialogs and
13624 * file selector will be opened in an Inwin. Otherwise they will use a
13625 * normal separated window.
13627 * @param obj The web object
13628 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13630 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13632 * Gets whether Inwin mode is set for the current object
13634 * @param obj The web object
13636 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13638 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13640 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13641 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13642 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);
13643 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13650 * @defgroup Hoversel Hoversel
13652 * @image html img/widget/hoversel/preview-00.png
13653 * @image latex img/widget/hoversel/preview-00.eps
13655 * A hoversel is a button that pops up a list of items (automatically
13656 * choosing the direction to display) that have a label and, optionally, an
13657 * icon to select from. It is a convenience widget to avoid the need to do
13658 * all the piecing together yourself. It is intended for a small number of
13659 * items in the hoversel menu (no more than 8), though is capable of many
13662 * Signals that you can add callbacks for are:
13663 * "clicked" - the user clicked the hoversel button and popped up the sel
13664 * "selected" - an item in the hoversel list is selected. event_info is the item
13665 * "dismissed" - the hover is dismissed
13667 * See @ref tutorial_hoversel for an example.
13670 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13672 * @brief Add a new Hoversel object
13674 * @param parent The parent object
13675 * @return The new object or NULL if it cannot be created
13677 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13679 * @brief This sets the hoversel to expand horizontally.
13681 * @param obj The hoversel object
13682 * @param horizontal If true, the hover will expand horizontally to the
13685 * @note The initial button will display horizontally regardless of this
13688 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13690 * @brief This returns whether the hoversel is set to expand horizontally.
13692 * @param obj The hoversel object
13693 * @return If true, the hover will expand horizontally to the right.
13695 * @see elm_hoversel_horizontal_set()
13697 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13699 * @brief Set the Hover parent
13701 * @param obj The hoversel object
13702 * @param parent The parent to use
13704 * Sets the hover parent object, the area that will be darkened when the
13705 * hoversel is clicked. Should probably be the window that the hoversel is
13706 * in. See @ref Hover objects for more information.
13708 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13710 * @brief Get the Hover parent
13712 * @param obj The hoversel object
13713 * @return The used parent
13715 * Gets the hover parent object.
13717 * @see elm_hoversel_hover_parent_set()
13719 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13721 * @brief Set the hoversel button label
13723 * @param obj The hoversel object
13724 * @param label The label text.
13726 * This sets the label of the button that is always visible (before it is
13727 * clicked and expanded).
13729 * @deprecated elm_object_text_set()
13731 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13733 * @brief Get the hoversel button label
13735 * @param obj The hoversel object
13736 * @return The label text.
13738 * @deprecated elm_object_text_get()
13740 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13742 * @brief Set the icon of the hoversel button
13744 * @param obj The hoversel object
13745 * @param icon The icon object
13747 * Sets the icon of the button that is always visible (before it is clicked
13748 * and expanded). Once the icon object is set, a previously set one will be
13749 * deleted, if you want to keep that old content object, use the
13750 * elm_hoversel_icon_unset() function.
13752 * @see elm_button_icon_set()
13754 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13756 * @brief Get the icon of the hoversel button
13758 * @param obj The hoversel object
13759 * @return The icon object
13761 * Get the icon of the button that is always visible (before it is clicked
13762 * and expanded). Also see elm_button_icon_get().
13764 * @see elm_hoversel_icon_set()
13766 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13768 * @brief Get and unparent the icon of the hoversel button
13770 * @param obj The hoversel object
13771 * @return The icon object that was being used
13773 * Unparent and return the icon of the button that is always visible
13774 * (before it is clicked and expanded).
13776 * @see elm_hoversel_icon_set()
13777 * @see elm_button_icon_unset()
13779 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13781 * @brief This triggers the hoversel popup from code, the same as if the user
13782 * had clicked the button.
13784 * @param obj The hoversel object
13786 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13788 * @brief This dismisses the hoversel popup as if the user had clicked
13789 * outside the hover.
13791 * @param obj The hoversel object
13793 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13795 * @brief Returns whether the hoversel is expanded.
13797 * @param obj The hoversel object
13798 * @return This will return EINA_TRUE if the hoversel is expanded or
13799 * EINA_FALSE if it is not expanded.
13801 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13803 * @brief This will remove all the children items from the hoversel.
13805 * @param obj The hoversel object
13807 * @warning Should @b not be called while the hoversel is active; use
13808 * elm_hoversel_expanded_get() to check first.
13810 * @see elm_hoversel_item_del_cb_set()
13811 * @see elm_hoversel_item_del()
13813 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13815 * @brief Get the list of items within the given hoversel.
13817 * @param obj The hoversel object
13818 * @return Returns a list of Elm_Hoversel_Item*
13820 * @see elm_hoversel_item_add()
13822 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13824 * @brief Add an item to the hoversel button
13826 * @param obj The hoversel object
13827 * @param label The text label to use for the item (NULL if not desired)
13828 * @param icon_file An image file path on disk to use for the icon or standard
13829 * icon name (NULL if not desired)
13830 * @param icon_type The icon type if relevant
13831 * @param func Convenience function to call when this item is selected
13832 * @param data Data to pass to item-related functions
13833 * @return A handle to the item added.
13835 * This adds an item to the hoversel to show when it is clicked. Note: if you
13836 * need to use an icon from an edje file then use
13837 * elm_hoversel_item_icon_set() right after the this function, and set
13838 * icon_file to NULL here.
13840 * For more information on what @p icon_file and @p icon_type are see the
13841 * @ref Icon "icon documentation".
13843 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);
13845 * @brief Delete an item from the hoversel
13847 * @param item The item to delete
13849 * This deletes the item from the hoversel (should not be called while the
13850 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13852 * @see elm_hoversel_item_add()
13853 * @see elm_hoversel_item_del_cb_set()
13855 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13857 * @brief Set the function to be called when an item from the hoversel is
13860 * @param item The item to set the callback on
13861 * @param func The function called
13863 * That function will receive these parameters:
13864 * @li void *item_data
13865 * @li Evas_Object *the_item_object
13866 * @li Elm_Hoversel_Item *the_object_struct
13868 * @see elm_hoversel_item_add()
13870 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13872 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13873 * that will be passed to associated function callbacks.
13875 * @param item The item to get the data from
13876 * @return The data pointer set with elm_hoversel_item_add()
13878 * @see elm_hoversel_item_add()
13880 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13882 * @brief This returns the label text of the given hoversel item.
13884 * @param item The item to get the label
13885 * @return The label text of the hoversel item
13887 * @see elm_hoversel_item_add()
13889 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13891 * @brief This sets the icon for the given hoversel item.
13893 * @param item The item to set the icon
13894 * @param icon_file An image file path on disk to use for the icon or standard
13896 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13897 * to NULL if the icon is not an edje file
13898 * @param icon_type The icon type
13900 * The icon can be loaded from the standard set, from an image file, or from
13903 * @see elm_hoversel_item_add()
13905 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);
13907 * @brief Get the icon object of the hoversel item
13909 * @param item The item to get the icon from
13910 * @param icon_file The image file path on disk used for the icon or standard
13912 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13913 * if the icon is not an edje file
13914 * @param icon_type The icon type
13916 * @see elm_hoversel_item_icon_set()
13917 * @see elm_hoversel_item_add()
13919 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);
13925 * @defgroup Toolbar Toolbar
13926 * @ingroup Elementary
13928 * @image html img/widget/toolbar/preview-00.png
13929 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13931 * @image html img/toolbar.png
13932 * @image latex img/toolbar.eps width=\textwidth
13934 * A toolbar is a widget that displays a list of items inside
13935 * a box. It can be scrollable, show a menu with items that don't fit
13936 * to toolbar size or even crop them.
13938 * Only one item can be selected at a time.
13940 * Items can have multiple states, or show menus when selected by the user.
13942 * Smart callbacks one can listen to:
13943 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13945 * Available styles for it:
13947 * - @c "transparent" - no background or shadow, just show the content
13949 * List of examples:
13950 * @li @ref toolbar_example_01
13951 * @li @ref toolbar_example_02
13952 * @li @ref toolbar_example_03
13956 * @addtogroup Toolbar
13961 * @enum _Elm_Toolbar_Shrink_Mode
13962 * @typedef Elm_Toolbar_Shrink_Mode
13964 * Set toolbar's items display behavior, it can be scrollabel,
13965 * show a menu with exceeding items, or simply hide them.
13967 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13970 * Values <b> don't </b> work as bitmask, only one can be choosen.
13972 * @see elm_toolbar_mode_shrink_set()
13973 * @see elm_toolbar_mode_shrink_get()
13977 typedef enum _Elm_Toolbar_Shrink_Mode
13979 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
13980 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
13981 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13982 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
13983 } Elm_Toolbar_Shrink_Mode;
13985 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(). */
13987 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(). */
13990 * Add a new toolbar widget to the given parent Elementary
13991 * (container) object.
13993 * @param parent The parent object.
13994 * @return a new toolbar widget handle or @c NULL, on errors.
13996 * This function inserts a new toolbar widget on the canvas.
14000 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14003 * Set the icon size, in pixels, to be used by toolbar items.
14005 * @param obj The toolbar object
14006 * @param icon_size The icon size in pixels
14008 * @note Default value is @c 32. It reads value from elm config.
14010 * @see elm_toolbar_icon_size_get()
14014 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14017 * Get the icon size, in pixels, to be used by toolbar items.
14019 * @param obj The toolbar object.
14020 * @return The icon size in pixels.
14022 * @see elm_toolbar_icon_size_set() for details.
14026 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14029 * Sets icon lookup order, for toolbar items' icons.
14031 * @param obj The toolbar object.
14032 * @param order The icon lookup order.
14034 * Icons added before calling this function will not be affected.
14035 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14037 * @see elm_toolbar_icon_order_lookup_get()
14041 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14044 * Gets the icon lookup order.
14046 * @param obj The toolbar object.
14047 * @return The icon lookup order.
14049 * @see elm_toolbar_icon_order_lookup_set() for details.
14053 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14056 * Set whether the toolbar items' should be selected by the user or not.
14058 * @param obj The toolbar object.
14059 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14062 * This will turn off the ability to select items entirely and they will
14063 * neither appear selected nor emit selected signals. The clicked
14064 * callback function will still be called.
14066 * Selection is enabled by default.
14068 * @see elm_toolbar_no_select_mode_get().
14072 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14075 * Set whether the toolbar items' should be selected by the user or not.
14077 * @param obj The toolbar object.
14078 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14079 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14081 * @see elm_toolbar_no_select_mode_set() for details.
14085 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14088 * Append item to the toolbar.
14090 * @param obj The toolbar object.
14091 * @param icon A string with icon name or the absolute path of an image file.
14092 * @param label The label of the item.
14093 * @param func The function to call when the item is clicked.
14094 * @param data The data to associate with the item for related callbacks.
14095 * @return The created item or @c NULL upon failure.
14097 * A new item will be created and appended to the toolbar, i.e., will
14098 * be set as @b last item.
14100 * Items created with this method can be deleted with
14101 * elm_toolbar_item_del().
14103 * Associated @p data can be properly freed when item is deleted if a
14104 * callback function is set with elm_toolbar_item_del_cb_set().
14106 * If a function is passed as argument, it will be called everytime this item
14107 * is selected, i.e., the user clicks over an unselected item.
14108 * If such function isn't needed, just passing
14109 * @c NULL as @p func is enough. The same should be done for @p data.
14111 * Toolbar will load icon image from fdo or current theme.
14112 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14113 * If an absolute path is provided it will load it direct from a file.
14115 * @see elm_toolbar_item_icon_set()
14116 * @see elm_toolbar_item_del()
14117 * @see elm_toolbar_item_del_cb_set()
14121 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);
14124 * Prepend item to the toolbar.
14126 * @param obj The toolbar object.
14127 * @param icon A string with icon name or the absolute path of an image file.
14128 * @param label The label of the item.
14129 * @param func The function to call when the item is clicked.
14130 * @param data The data to associate with the item for related callbacks.
14131 * @return The created item or @c NULL upon failure.
14133 * A new item will be created and prepended to the toolbar, i.e., will
14134 * be set as @b first item.
14136 * Items created with this method can be deleted with
14137 * elm_toolbar_item_del().
14139 * Associated @p data can be properly freed when item is deleted if a
14140 * callback function is set with elm_toolbar_item_del_cb_set().
14142 * If a function is passed as argument, it will be called everytime this item
14143 * is selected, i.e., the user clicks over an unselected item.
14144 * If such function isn't needed, just passing
14145 * @c NULL as @p func is enough. The same should be done for @p data.
14147 * Toolbar will load icon image from fdo or current theme.
14148 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14149 * If an absolute path is provided it will load it direct from a file.
14151 * @see elm_toolbar_item_icon_set()
14152 * @see elm_toolbar_item_del()
14153 * @see elm_toolbar_item_del_cb_set()
14157 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);
14160 * Insert a new item into the toolbar object before item @p before.
14162 * @param obj The toolbar object.
14163 * @param before The toolbar item to insert before.
14164 * @param icon A string with icon name or the absolute path of an image file.
14165 * @param label The label of the item.
14166 * @param func The function to call when the item is clicked.
14167 * @param data The data to associate with the item for related callbacks.
14168 * @return The created item or @c NULL upon failure.
14170 * A new item will be created and added to the toolbar. Its position in
14171 * this toolbar will be just before item @p before.
14173 * Items created with this method can be deleted with
14174 * elm_toolbar_item_del().
14176 * Associated @p data can be properly freed when item is deleted if a
14177 * callback function is set with elm_toolbar_item_del_cb_set().
14179 * If a function is passed as argument, it will be called everytime this item
14180 * is selected, i.e., the user clicks over an unselected item.
14181 * If such function isn't needed, just passing
14182 * @c NULL as @p func is enough. The same should be done for @p data.
14184 * Toolbar will load icon image from fdo or current theme.
14185 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14186 * If an absolute path is provided it will load it direct from a file.
14188 * @see elm_toolbar_item_icon_set()
14189 * @see elm_toolbar_item_del()
14190 * @see elm_toolbar_item_del_cb_set()
14194 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);
14197 * Insert a new item into the toolbar object after item @p after.
14199 * @param obj The toolbar object.
14200 * @param before The toolbar item to insert before.
14201 * @param icon A string with icon name or the absolute path of an image file.
14202 * @param label The label of the item.
14203 * @param func The function to call when the item is clicked.
14204 * @param data The data to associate with the item for related callbacks.
14205 * @return The created item or @c NULL upon failure.
14207 * A new item will be created and added to the toolbar. Its position in
14208 * this toolbar will be just after item @p after.
14210 * Items created with this method can be deleted with
14211 * elm_toolbar_item_del().
14213 * Associated @p data can be properly freed when item is deleted if a
14214 * callback function is set with elm_toolbar_item_del_cb_set().
14216 * If a function is passed as argument, it will be called everytime this item
14217 * is selected, i.e., the user clicks over an unselected item.
14218 * If such function isn't needed, just passing
14219 * @c NULL as @p func is enough. The same should be done for @p data.
14221 * Toolbar will load icon image from fdo or current theme.
14222 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14223 * If an absolute path is provided it will load it direct from a file.
14225 * @see elm_toolbar_item_icon_set()
14226 * @see elm_toolbar_item_del()
14227 * @see elm_toolbar_item_del_cb_set()
14231 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);
14234 * Get the first item in the given toolbar widget's list of
14237 * @param obj The toolbar object
14238 * @return The first item or @c NULL, if it has no items (and on
14241 * @see elm_toolbar_item_append()
14242 * @see elm_toolbar_last_item_get()
14246 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14249 * Get the last item in the given toolbar widget's list of
14252 * @param obj The toolbar object
14253 * @return The last item or @c NULL, if it has no items (and on
14256 * @see elm_toolbar_item_prepend()
14257 * @see elm_toolbar_first_item_get()
14261 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14264 * Get the item after @p item in toolbar.
14266 * @param item The toolbar item.
14267 * @return The item after @p item, or @c NULL if none or on failure.
14269 * @note If it is the last item, @c NULL will be returned.
14271 * @see elm_toolbar_item_append()
14275 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14278 * Get the item before @p item in toolbar.
14280 * @param item The toolbar item.
14281 * @return The item before @p item, or @c NULL if none or on failure.
14283 * @note If it is the first item, @c NULL will be returned.
14285 * @see elm_toolbar_item_prepend()
14289 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14292 * Get the toolbar object from an item.
14294 * @param item The item.
14295 * @return The toolbar object.
14297 * This returns the toolbar object itself that an item belongs to.
14301 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14304 * Set the priority of a toolbar item.
14306 * @param item The toolbar item.
14307 * @param priority The item priority. The default is zero.
14309 * This is used only when the toolbar shrink mode is set to
14310 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14311 * When space is less than required, items with low priority
14312 * will be removed from the toolbar and added to a dynamically-created menu,
14313 * while items with higher priority will remain on the toolbar,
14314 * with the same order they were added.
14316 * @see elm_toolbar_item_priority_get()
14320 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14323 * Get the priority of a toolbar item.
14325 * @param item The toolbar item.
14326 * @return The @p item priority, or @c 0 on failure.
14328 * @see elm_toolbar_item_priority_set() for details.
14332 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14335 * Get the label of item.
14337 * @param item The item of toolbar.
14338 * @return The label of item.
14340 * The return value is a pointer to the label associated to @p item when
14341 * it was created, with function elm_toolbar_item_append() or similar,
14343 * with function elm_toolbar_item_label_set. If no label
14344 * was passed as argument, it will return @c NULL.
14346 * @see elm_toolbar_item_label_set() for more details.
14347 * @see elm_toolbar_item_append()
14351 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14354 * Set the label of item.
14356 * @param item The item of toolbar.
14357 * @param text The label of item.
14359 * The label to be displayed by the item.
14360 * Label will be placed at icons bottom (if set).
14362 * If a label was passed as argument on item creation, with function
14363 * elm_toolbar_item_append() or similar, it will be already
14364 * displayed by the item.
14366 * @see elm_toolbar_item_label_get()
14367 * @see elm_toolbar_item_append()
14371 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14374 * Return the data associated with a given toolbar widget item.
14376 * @param item The toolbar widget item handle.
14377 * @return The data associated with @p item.
14379 * @see elm_toolbar_item_data_set()
14383 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14386 * Set the data associated with a given toolbar widget item.
14388 * @param item The toolbar widget item handle.
14389 * @param data The new data pointer to set to @p item.
14391 * This sets new item data on @p item.
14393 * @warning The old data pointer won't be touched by this function, so
14394 * the user had better to free that old data himself/herself.
14398 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14401 * Returns a pointer to a toolbar item by its label.
14403 * @param obj The toolbar object.
14404 * @param label The label of the item to find.
14406 * @return The pointer to the toolbar item matching @p label or @c NULL
14411 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14414 * Get whether the @p item is selected or not.
14416 * @param item The toolbar item.
14417 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14418 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14420 * @see elm_toolbar_selected_item_set() for details.
14421 * @see elm_toolbar_item_selected_get()
14425 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14428 * Set the selected state of an item.
14430 * @param item The toolbar item
14431 * @param selected The selected state
14433 * This sets the selected state of the given item @p it.
14434 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14436 * If a new item is selected the previosly selected will be unselected.
14437 * Previoulsy selected item can be get with function
14438 * elm_toolbar_selected_item_get().
14440 * Selected items will be highlighted.
14442 * @see elm_toolbar_item_selected_get()
14443 * @see elm_toolbar_selected_item_get()
14447 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14450 * Get the selected item.
14452 * @param obj The toolbar object.
14453 * @return The selected toolbar item.
14455 * The selected item can be unselected with function
14456 * elm_toolbar_item_selected_set().
14458 * The selected item always will be highlighted on toolbar.
14460 * @see elm_toolbar_selected_items_get()
14464 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14467 * Set the icon associated with @p item.
14469 * @param obj The parent of this item.
14470 * @param item The toolbar item.
14471 * @param icon A string with icon name or the absolute path of an image file.
14473 * Toolbar will load icon image from fdo or current theme.
14474 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14475 * If an absolute path is provided it will load it direct from a file.
14477 * @see elm_toolbar_icon_order_lookup_set()
14478 * @see elm_toolbar_icon_order_lookup_get()
14482 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14485 * Get the string used to set the icon of @p item.
14487 * @param item The toolbar item.
14488 * @return The string associated with the icon object.
14490 * @see elm_toolbar_item_icon_set() for details.
14494 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14497 * Get the icon object of @p item.
14499 * @param item The toolbar item.
14500 * @return The icon object
14502 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14506 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14509 * Set the icon associated with @p item to an image in a binary buffer.
14511 * @param item The toolbar item.
14512 * @param img The binary data that will be used as an image
14513 * @param size The size of binary data @p img
14514 * @param format Optional format of @p img to pass to the image loader
14515 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14517 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14519 * @note The icon image set by this function can be changed by
14520 * elm_toolbar_item_icon_set().
14524 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);
14527 * Delete them item from the toolbar.
14529 * @param item The item of toolbar to be deleted.
14531 * @see elm_toolbar_item_append()
14532 * @see elm_toolbar_item_del_cb_set()
14536 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14539 * Set the function called when a toolbar item is freed.
14541 * @param item The item to set the callback on.
14542 * @param func The function called.
14544 * If there is a @p func, then it will be called prior item's memory release.
14545 * That will be called with the following arguments:
14547 * @li item's Evas object;
14550 * This way, a data associated to a toolbar item could be properly freed.
14554 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14557 * Get a value whether toolbar item is disabled or not.
14559 * @param item The item.
14560 * @return The disabled state.
14562 * @see elm_toolbar_item_disabled_set() for more details.
14566 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14569 * Sets the disabled/enabled state of a toolbar item.
14571 * @param item The item.
14572 * @param disabled The disabled state.
14574 * A disabled item cannot be selected or unselected. It will also
14575 * change its appearance (generally greyed out). This sets the
14576 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14581 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14584 * Set or unset item as a separator.
14586 * @param item The toolbar item.
14587 * @param setting @c EINA_TRUE to set item @p item as separator or
14588 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14590 * Items aren't set as separator by default.
14592 * If set as separator it will display separator theme, so won't display
14595 * @see elm_toolbar_item_separator_get()
14599 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14602 * Get a value whether item is a separator or not.
14604 * @param item The toolbar item.
14605 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14606 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14608 * @see elm_toolbar_item_separator_set() for details.
14612 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14615 * Set the shrink state of toolbar @p obj.
14617 * @param obj The toolbar object.
14618 * @param shrink_mode Toolbar's items display behavior.
14620 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14621 * but will enforce a minimun size so all the items will fit, won't scroll
14622 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14623 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14624 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14628 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14631 * Get the shrink mode of toolbar @p obj.
14633 * @param obj The toolbar object.
14634 * @return Toolbar's items display behavior.
14636 * @see elm_toolbar_mode_shrink_set() for details.
14640 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14643 * Enable/disable homogenous mode.
14645 * @param obj The toolbar object
14646 * @param homogeneous Assume the items within the toolbar are of the
14647 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14649 * This will enable the homogeneous mode where items are of the same size.
14650 * @see elm_toolbar_homogeneous_get()
14654 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14657 * Get whether the homogenous mode is enabled.
14659 * @param obj The toolbar object.
14660 * @return Assume the items within the toolbar are of the same height
14661 * and width (EINA_TRUE = on, EINA_FALSE = off).
14663 * @see elm_toolbar_homogeneous_set()
14667 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14670 * Enable/disable homogenous mode.
14672 * @param obj The toolbar object
14673 * @param homogeneous Assume the items within the toolbar are of the
14674 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14676 * This will enable the homogeneous mode where items are of the same size.
14677 * @see elm_toolbar_homogeneous_get()
14679 * @deprecated use elm_toolbar_homogeneous_set() instead.
14683 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14686 * Get whether the homogenous mode is enabled.
14688 * @param obj The toolbar object.
14689 * @return Assume the items within the toolbar are of the same height
14690 * and width (EINA_TRUE = on, EINA_FALSE = off).
14692 * @see elm_toolbar_homogeneous_set()
14693 * @deprecated use elm_toolbar_homogeneous_get() instead.
14697 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14700 * Set the parent object of the toolbar items' menus.
14702 * @param obj The toolbar object.
14703 * @param parent The parent of the menu objects.
14705 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14707 * For more details about setting the parent for toolbar menus, see
14708 * elm_menu_parent_set().
14710 * @see elm_menu_parent_set() for details.
14711 * @see elm_toolbar_item_menu_set() for details.
14715 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14718 * Get the parent object of the toolbar items' menus.
14720 * @param obj The toolbar object.
14721 * @return The parent of the menu objects.
14723 * @see elm_toolbar_menu_parent_set() for details.
14727 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14730 * Set the alignment of the items.
14732 * @param obj The toolbar object.
14733 * @param align The new alignment, a float between <tt> 0.0 </tt>
14734 * and <tt> 1.0 </tt>.
14736 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14737 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14740 * Centered items by default.
14742 * @see elm_toolbar_align_get()
14746 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14749 * Get the alignment of the items.
14751 * @param obj The toolbar object.
14752 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14755 * @see elm_toolbar_align_set() for details.
14759 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14762 * Set whether the toolbar item opens a menu.
14764 * @param item The toolbar item.
14765 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14767 * A toolbar item can be set to be a menu, using this function.
14769 * Once it is set to be a menu, it can be manipulated through the
14770 * menu-like function elm_toolbar_menu_parent_set() and the other
14771 * elm_menu functions, using the Evas_Object @c menu returned by
14772 * elm_toolbar_item_menu_get().
14774 * So, items to be displayed in this item's menu should be added with
14775 * elm_menu_item_add().
14777 * The following code exemplifies the most basic usage:
14779 * tb = elm_toolbar_add(win)
14780 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14781 * elm_toolbar_item_menu_set(item, EINA_TRUE);
14782 * elm_toolbar_menu_parent_set(tb, win);
14783 * menu = elm_toolbar_item_menu_get(item);
14784 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14785 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14789 * @see elm_toolbar_item_menu_get()
14793 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14796 * Get toolbar item's menu.
14798 * @param item The toolbar item.
14799 * @return Item's menu object or @c NULL on failure.
14801 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14802 * this function will set it.
14804 * @see elm_toolbar_item_menu_set() for details.
14808 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14811 * Add a new state to @p item.
14813 * @param item The item.
14814 * @param icon A string with icon name or the absolute path of an image file.
14815 * @param label The label of the new state.
14816 * @param func The function to call when the item is clicked when this
14817 * state is selected.
14818 * @param data The data to associate with the state.
14819 * @return The toolbar item state, or @c NULL upon failure.
14821 * Toolbar will load icon image from fdo or current theme.
14822 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14823 * If an absolute path is provided it will load it direct from a file.
14825 * States created with this function can be removed with
14826 * elm_toolbar_item_state_del().
14828 * @see elm_toolbar_item_state_del()
14829 * @see elm_toolbar_item_state_sel()
14830 * @see elm_toolbar_item_state_get()
14834 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);
14837 * Delete a previoulsy added state to @p item.
14839 * @param item The toolbar item.
14840 * @param state The state to be deleted.
14841 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14843 * @see elm_toolbar_item_state_add()
14845 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14848 * Set @p state as the current state of @p it.
14850 * @param it The item.
14851 * @param state The state to use.
14852 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14854 * If @p state is @c NULL, it won't select any state and the default item's
14855 * icon and label will be used. It's the same behaviour than
14856 * elm_toolbar_item_state_unser().
14858 * @see elm_toolbar_item_state_unset()
14862 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14865 * Unset the state of @p it.
14867 * @param it The item.
14869 * The default icon and label from this item will be displayed.
14871 * @see elm_toolbar_item_state_set() for more details.
14875 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14878 * Get the current state of @p it.
14880 * @param item The item.
14881 * @return The selected state or @c NULL if none is selected or on failure.
14883 * @see elm_toolbar_item_state_set() for details.
14884 * @see elm_toolbar_item_state_unset()
14885 * @see elm_toolbar_item_state_add()
14889 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14892 * Get the state after selected state in toolbar's @p item.
14894 * @param it The toolbar item to change state.
14895 * @return The state after current state, or @c NULL on failure.
14897 * If last state is selected, this function will return first state.
14899 * @see elm_toolbar_item_state_set()
14900 * @see elm_toolbar_item_state_add()
14904 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14907 * Get the state before selected state in toolbar's @p item.
14909 * @param it The toolbar item to change state.
14910 * @return The state before current state, or @c NULL on failure.
14912 * If first state is selected, this function will return last state.
14914 * @see elm_toolbar_item_state_set()
14915 * @see elm_toolbar_item_state_add()
14919 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14922 * Set the text to be shown in a given toolbar item's tooltips.
14924 * @param item Target item.
14925 * @param text The text to set in the content.
14927 * Setup the text as tooltip to object. The item can have only one tooltip,
14928 * so any previous tooltip data - set with this function or
14929 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14931 * @see elm_object_tooltip_text_set() for more details.
14935 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14938 * Set the content to be shown in the tooltip item.
14940 * Setup the tooltip to item. The item can have only one tooltip,
14941 * so any previous tooltip data is removed. @p func(with @p data) will
14942 * be called every time that need show the tooltip and it should
14943 * return a valid Evas_Object. This object is then managed fully by
14944 * tooltip system and is deleted when the tooltip is gone.
14946 * @param item the toolbar item being attached a tooltip.
14947 * @param func the function used to create the tooltip contents.
14948 * @param data what to provide to @a func as callback data/context.
14949 * @param del_cb called when data is not needed anymore, either when
14950 * another callback replaces @a func, the tooltip is unset with
14951 * elm_toolbar_item_tooltip_unset() or the owner @a item
14952 * dies. This callback receives as the first parameter the
14953 * given @a data, and @c event_info is the item.
14955 * @see elm_object_tooltip_content_cb_set() for more details.
14959 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);
14962 * Unset tooltip from item.
14964 * @param item toolbar item to remove previously set tooltip.
14966 * Remove tooltip from item. The callback provided as del_cb to
14967 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14968 * it is not used anymore.
14970 * @see elm_object_tooltip_unset() for more details.
14971 * @see elm_toolbar_item_tooltip_content_cb_set()
14975 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14978 * Sets a different style for this item tooltip.
14980 * @note before you set a style you should define a tooltip with
14981 * elm_toolbar_item_tooltip_content_cb_set() or
14982 * elm_toolbar_item_tooltip_text_set()
14984 * @param item toolbar item with tooltip already set.
14985 * @param style the theme style to use (default, transparent, ...)
14987 * @see elm_object_tooltip_style_set() for more details.
14991 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14994 * Get the style for this item tooltip.
14996 * @param item toolbar item with tooltip already set.
14997 * @return style the theme style in use, defaults to "default". If the
14998 * object does not have a tooltip set, then NULL is returned.
15000 * @see elm_object_tooltip_style_get() for more details.
15001 * @see elm_toolbar_item_tooltip_style_set()
15005 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15008 * Set the type of mouse pointer/cursor decoration to be shown,
15009 * when the mouse pointer is over the given toolbar widget item
15011 * @param item toolbar item to customize cursor on
15012 * @param cursor the cursor type's name
15014 * This function works analogously as elm_object_cursor_set(), but
15015 * here the cursor's changing area is restricted to the item's
15016 * area, and not the whole widget's. Note that that item cursors
15017 * have precedence over widget cursors, so that a mouse over an
15018 * item with custom cursor set will always show @b that cursor.
15020 * If this function is called twice for an object, a previously set
15021 * cursor will be unset on the second call.
15023 * @see elm_object_cursor_set()
15024 * @see elm_toolbar_item_cursor_get()
15025 * @see elm_toolbar_item_cursor_unset()
15029 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15032 * Get the type of mouse pointer/cursor decoration set to be shown,
15033 * when the mouse pointer is over the given toolbar widget item
15035 * @param item toolbar item with custom cursor set
15036 * @return the cursor type's name or @c NULL, if no custom cursors
15037 * were set to @p item (and on errors)
15039 * @see elm_object_cursor_get()
15040 * @see elm_toolbar_item_cursor_set()
15041 * @see elm_toolbar_item_cursor_unset()
15045 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15048 * Unset any custom mouse pointer/cursor decoration set to be
15049 * shown, when the mouse pointer is over the given toolbar widget
15050 * item, thus making it show the @b default cursor again.
15052 * @param item a toolbar item
15054 * Use this call to undo any custom settings on this item's cursor
15055 * decoration, bringing it back to defaults (no custom style set).
15057 * @see elm_object_cursor_unset()
15058 * @see elm_toolbar_item_cursor_set()
15062 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15065 * Set a different @b style for a given custom cursor set for a
15068 * @param item toolbar item with custom cursor set
15069 * @param style the <b>theme style</b> to use (e.g. @c "default",
15070 * @c "transparent", etc)
15072 * This function only makes sense when one is using custom mouse
15073 * cursor decorations <b>defined in a theme file</b>, which can have,
15074 * given a cursor name/type, <b>alternate styles</b> on it. It
15075 * works analogously as elm_object_cursor_style_set(), but here
15076 * applyed only to toolbar item objects.
15078 * @warning Before you set a cursor style you should have definen a
15079 * custom cursor previously on the item, with
15080 * elm_toolbar_item_cursor_set()
15082 * @see elm_toolbar_item_cursor_engine_only_set()
15083 * @see elm_toolbar_item_cursor_style_get()
15087 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15090 * Get the current @b style set for a given toolbar item's custom
15093 * @param item toolbar item with custom cursor set.
15094 * @return style the cursor style in use. If the object does not
15095 * have a cursor set, then @c NULL is returned.
15097 * @see elm_toolbar_item_cursor_style_set() for more details
15101 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15104 * Set if the (custom)cursor for a given toolbar item should be
15105 * searched in its theme, also, or should only rely on the
15106 * rendering engine.
15108 * @param item item with custom (custom) cursor already set on
15109 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15110 * only on those provided by the rendering engine, @c EINA_FALSE to
15111 * have them searched on the widget's theme, as well.
15113 * @note This call is of use only if you've set a custom cursor
15114 * for toolbar items, with elm_toolbar_item_cursor_set().
15116 * @note By default, cursors will only be looked for between those
15117 * provided by the rendering engine.
15121 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15124 * Get if the (custom) cursor for a given toolbar item is being
15125 * searched in its theme, also, or is only relying on the rendering
15128 * @param item a toolbar item
15129 * @return @c EINA_TRUE, if cursors are being looked for only on
15130 * those provided by the rendering engine, @c EINA_FALSE if they
15131 * are being searched on the widget's theme, as well.
15133 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15137 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15140 * Change a toolbar's orientation
15141 * @param obj The toolbar object
15142 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15143 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15146 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15149 * Get a toolbar's orientation
15150 * @param obj The toolbar object
15151 * @return If @c EINA_TRUE, the toolbar is vertical
15152 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15155 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15162 * @defgroup Tooltips Tooltips
15164 * The Tooltip is an (internal, for now) smart object used to show a
15165 * content in a frame on mouse hover of objects(or widgets), with
15166 * tips/information about them.
15171 EAPI double elm_tooltip_delay_get(void);
15172 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15173 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15174 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15175 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15176 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);
15177 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15178 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15179 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15180 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15181 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15188 * @defgroup Cursors Cursors
15190 * The Elementary cursor is an internal smart object used to
15191 * customize the mouse cursor displayed over objects (or
15192 * widgets). In the most common scenario, the cursor decoration
15193 * comes from the graphical @b engine Elementary is running
15194 * on. Those engines may provide different decorations for cursors,
15195 * and Elementary provides functions to choose them (think of X11
15196 * cursors, as an example).
15198 * There's also the possibility of, besides using engine provided
15199 * cursors, also use ones coming from Edje theming files. Both
15200 * globally and per widget, Elementary makes it possible for one to
15201 * make the cursors lookup to be held on engines only or on
15202 * Elementary's theme file, too.
15208 * Set the cursor to be shown when mouse is over the object
15210 * Set the cursor that will be displayed when mouse is over the
15211 * object. The object can have only one cursor set to it, so if
15212 * this function is called twice for an object, the previous set
15214 * If using X cursors, a definition of all the valid cursor names
15215 * is listed on Elementary_Cursors.h. If an invalid name is set
15216 * the default cursor will be used.
15218 * @param obj the object being set a cursor.
15219 * @param cursor the cursor name to be used.
15223 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15226 * Get the cursor to be shown when mouse is over the object
15228 * @param obj an object with cursor already set.
15229 * @return the cursor name.
15233 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15236 * Unset cursor for object
15238 * Unset cursor for object, and set the cursor to default if the mouse
15239 * was over this object.
15241 * @param obj Target object
15242 * @see elm_object_cursor_set()
15246 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15249 * Sets a different style for this object cursor.
15251 * @note before you set a style you should define a cursor with
15252 * elm_object_cursor_set()
15254 * @param obj an object with cursor already set.
15255 * @param style the theme style to use (default, transparent, ...)
15259 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15262 * Get the style for this object cursor.
15264 * @param obj an object with cursor already set.
15265 * @return style the theme style in use, defaults to "default". If the
15266 * object does not have a cursor set, then NULL is returned.
15270 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15273 * Set if the cursor set should be searched on the theme or should use
15274 * the provided by the engine, only.
15276 * @note before you set if should look on theme you should define a cursor
15277 * with elm_object_cursor_set(). By default it will only look for cursors
15278 * provided by the engine.
15280 * @param obj an object with cursor already set.
15281 * @param engine_only boolean to define it cursors should be looked only
15282 * between the provided by the engine or searched on widget's theme as well.
15286 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15289 * Get the cursor engine only usage for this object cursor.
15291 * @param obj an object with cursor already set.
15292 * @return engine_only boolean to define it cursors should be
15293 * looked only between the provided by the engine or searched on
15294 * widget's theme as well. If the object does not have a cursor
15295 * set, then EINA_FALSE is returned.
15299 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15302 * Get the configured cursor engine only usage
15304 * This gets the globally configured exclusive usage of engine cursors.
15306 * @return 1 if only engine cursors should be used
15309 EAPI int elm_cursor_engine_only_get(void);
15312 * Set the configured cursor engine only usage
15314 * This sets the globally configured exclusive usage of engine cursors.
15315 * It won't affect cursors set before changing this value.
15317 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15318 * look for them on theme before.
15319 * @return EINA_TRUE if value is valid and setted (0 or 1)
15322 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15329 * @defgroup Menu Menu
15331 * @image html img/widget/menu/preview-00.png
15332 * @image latex img/widget/menu/preview-00.eps
15334 * A menu is a list of items displayed above its parent. When the menu is
15335 * showing its parent is darkened. Each item can have a sub-menu. The menu
15336 * object can be used to display a menu on a right click event, in a toolbar,
15339 * Signals that you can add callbacks for are:
15340 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15341 * event_info is NULL.
15343 * @see @ref tutorial_menu
15346 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15348 * @brief Add a new menu to the parent
15350 * @param parent The parent object.
15351 * @return The new object or NULL if it cannot be created.
15353 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15355 * @brief Set the parent for the given menu widget
15357 * @param obj The menu object.
15358 * @param parent The new parent.
15360 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15362 * @brief Get the parent for the given menu widget
15364 * @param obj The menu object.
15365 * @return The parent.
15367 * @see elm_menu_parent_set()
15369 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15371 * @brief Move the menu to a new position
15373 * @param obj The menu object.
15374 * @param x The new position.
15375 * @param y The new position.
15377 * Sets the top-left position of the menu to (@p x,@p y).
15379 * @note @p x and @p y coordinates are relative to parent.
15381 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15383 * @brief Close a opened menu
15385 * @param obj the menu object
15388 * Hides the menu and all it's sub-menus.
15390 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15392 * @brief Returns a list of @p item's items.
15394 * @param obj The menu object
15395 * @return An Eina_List* of @p item's items
15397 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15399 * @brief Get the Evas_Object of an Elm_Menu_Item
15401 * @param item The menu item object.
15402 * @return The edje object containing the swallowed content
15404 * @warning Don't manipulate this object!
15406 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15408 * @brief Add an item at the end of the given menu widget
15410 * @param obj The menu object.
15411 * @param parent The parent menu item (optional)
15412 * @param icon A icon display on the item. The icon will be destryed by the menu.
15413 * @param label The label of the item.
15414 * @param func Function called when the user select the item.
15415 * @param data Data sent by the callback.
15416 * @return Returns the new item.
15418 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);
15420 * @brief Add an object swallowed in an item at the end of the given menu
15423 * @param obj The menu object.
15424 * @param parent The parent menu item (optional)
15425 * @param subobj The object to swallow
15426 * @param func Function called when the user select the item.
15427 * @param data Data sent by the callback.
15428 * @return Returns the new item.
15430 * Add an evas object as an item to the menu.
15432 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);
15434 * @brief Set the label of a menu item
15436 * @param item The menu item object.
15437 * @param label The label to set for @p item
15439 * @warning Don't use this funcion on items created with
15440 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15442 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15444 * @brief Get the label of a menu item
15446 * @param item The menu item object.
15447 * @return The label of @p item
15449 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15451 * @brief Set the icon of a menu item to the standard icon with name @p icon
15453 * @param item The menu item object.
15454 * @param icon The icon object to set for the content of @p item
15456 * Once this icon is set, any previously set icon will be deleted.
15458 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15460 * @brief Get the string representation from the icon of a menu item
15462 * @param item The menu item object.
15463 * @return The string representation of @p item's icon or NULL
15465 * @see elm_menu_item_object_icon_name_set()
15467 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15469 * @brief Set the content object of a menu item
15471 * @param item The menu item object
15472 * @param The content object or NULL
15473 * @return EINA_TRUE on success, else EINA_FALSE
15475 * Use this function to change the object swallowed by a menu item, deleting
15476 * any previously swallowed object.
15478 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15480 * @brief Get the content object of a menu item
15482 * @param item The menu item object
15483 * @return The content object or NULL
15484 * @note If @p item was added with elm_menu_item_add_object, this
15485 * function will return the object passed, else it will return the
15488 * @see elm_menu_item_object_content_set()
15490 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15492 * @brief Set the selected state of @p item.
15494 * @param item The menu item object.
15495 * @param selected The selected/unselected state of the item
15497 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15499 * @brief Get the selected state of @p item.
15501 * @param item The menu item object.
15502 * @return The selected/unselected state of the item
15504 * @see elm_menu_item_selected_set()
15506 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15508 * @brief Set the disabled state of @p item.
15510 * @param item The menu item object.
15511 * @param disabled The enabled/disabled state of the item
15513 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15515 * @brief Get the disabled state of @p item.
15517 * @param item The menu item object.
15518 * @return The enabled/disabled state of the item
15520 * @see elm_menu_item_disabled_set()
15522 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15524 * @brief Add a separator item to menu @p obj under @p parent.
15526 * @param obj The menu object
15527 * @param parent The item to add the separator under
15528 * @return The created item or NULL on failure
15530 * This is item is a @ref Separator.
15532 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15534 * @brief Returns whether @p item is a separator.
15536 * @param item The item to check
15537 * @return If true, @p item is a separator
15539 * @see elm_menu_item_separator_add()
15541 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15543 * @brief Deletes an item from the menu.
15545 * @param item The item to delete.
15547 * @see elm_menu_item_add()
15549 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15551 * @brief Set the function called when a menu item is deleted.
15553 * @param item The item to set the callback on
15554 * @param func The function called
15556 * @see elm_menu_item_add()
15557 * @see elm_menu_item_del()
15559 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15561 * @brief Returns the data associated with menu item @p item.
15563 * @param item The item
15564 * @return The data associated with @p item or NULL if none was set.
15566 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15568 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15570 * @brief Sets the data to be associated with menu item @p item.
15572 * @param item The item
15573 * @param data The data to be associated with @p item
15575 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15577 * @brief Returns a list of @p item's subitems.
15579 * @param item The item
15580 * @return An Eina_List* of @p item's subitems
15582 * @see elm_menu_add()
15584 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15586 * @brief Get the position of a menu item
15588 * @param item The menu item
15589 * @return The item's index
15591 * This function returns the index position of a menu item in a menu.
15592 * For a sub-menu, this number is relative to the first item in the sub-menu.
15594 * @note Index values begin with 0
15596 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15598 * @brief @brief Return a menu item's owner menu
15600 * @param item The menu item
15601 * @return The menu object owning @p item, or NULL on failure
15603 * Use this function to get the menu object owning an item.
15605 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15607 * @brief Get the selected item in the menu
15609 * @param obj The menu object
15610 * @return The selected item, or NULL if none
15612 * @see elm_menu_item_selected_get()
15613 * @see elm_menu_item_selected_set()
15615 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15617 * @brief Get the last item in the menu
15619 * @param obj The menu object
15620 * @return The last item, or NULL if none
15622 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15624 * @brief Get the first item in the menu
15626 * @param obj The menu object
15627 * @return The first item, or NULL if none
15629 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15631 * @brief Get the next item in the menu.
15633 * @param item The menu item object.
15634 * @return The item after it, or NULL if none
15636 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15638 * @brief Get the previous item in the menu.
15640 * @param item The menu item object.
15641 * @return The item before it, or NULL if none
15643 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15649 * @defgroup List List
15650 * @ingroup Elementary
15652 * @image html img/widget/list/preview-00.png
15653 * @image latex img/widget/list/preview-00.eps width=\textwidth
15655 * @image html img/list.png
15656 * @image latex img/list.eps width=\textwidth
15658 * A list widget is a container whose children are displayed vertically or
15659 * horizontally, in order, and can be selected.
15660 * The list can accept only one or multiple items selection. Also has many
15661 * modes of items displaying.
15663 * A list is a very simple type of list widget. For more robust
15664 * lists, @ref Genlist should probably be used.
15666 * Smart callbacks one can listen to:
15667 * - @c "activated" - The user has double-clicked or pressed
15668 * (enter|return|spacebar) on an item. The @c event_info parameter
15669 * is the item that was activated.
15670 * - @c "clicked,double" - The user has double-clicked an item.
15671 * The @c event_info parameter is the item that was double-clicked.
15672 * - "selected" - when the user selected an item
15673 * - "unselected" - when the user unselected an item
15674 * - "longpressed" - an item in the list is long-pressed
15675 * - "scroll,edge,top" - the list is scrolled until the top edge
15676 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
15677 * - "scroll,edge,left" - the list is scrolled until the left edge
15678 * - "scroll,edge,right" - the list is scrolled until the right edge
15680 * Available styles for it:
15683 * List of examples:
15684 * @li @ref list_example_01
15685 * @li @ref list_example_02
15686 * @li @ref list_example_03
15695 * @enum _Elm_List_Mode
15696 * @typedef Elm_List_Mode
15698 * Set list's resize behavior, transverse axis scroll and
15699 * items cropping. See each mode's description for more details.
15701 * @note Default value is #ELM_LIST_SCROLL.
15703 * Values <b> don't </b> work as bitmask, only one can be choosen.
15705 * @see elm_list_mode_set()
15706 * @see elm_list_mode_get()
15710 typedef enum _Elm_List_Mode
15712 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. */
15713 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). */
15714 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. */
15715 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. */
15716 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15719 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(). */
15722 * Add a new list widget to the given parent Elementary
15723 * (container) object.
15725 * @param parent The parent object.
15726 * @return a new list widget handle or @c NULL, on errors.
15728 * This function inserts a new list widget on the canvas.
15732 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15737 * @param obj The list object
15739 * @note Call before running show() on the list object.
15740 * @warning If not called, it won't display the list properly.
15743 * li = elm_list_add(win);
15744 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15745 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15747 * evas_object_show(li);
15752 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15755 * Enable or disable multiple items selection on the list object.
15757 * @param obj The list object
15758 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15761 * Disabled by default. If disabled, the user can select a single item of
15762 * the list each time. Selected items are highlighted on list.
15763 * If enabled, many items can be selected.
15765 * If a selected item is selected again, it will be unselected.
15767 * @see elm_list_multi_select_get()
15771 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15774 * Get a value whether multiple items selection is enabled or not.
15776 * @see elm_list_multi_select_set() for details.
15778 * @param obj The list object.
15779 * @return @c EINA_TRUE means multiple items selection is enabled.
15780 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15781 * @c EINA_FALSE is returned.
15785 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15788 * Set which mode to use for the list object.
15790 * @param obj The list object
15791 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15792 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15794 * Set list's resize behavior, transverse axis scroll and
15795 * items cropping. See each mode's description for more details.
15797 * @note Default value is #ELM_LIST_SCROLL.
15799 * Only one can be set, if a previous one was set, it will be changed
15800 * by the new mode set. Bitmask won't work as well.
15802 * @see elm_list_mode_get()
15806 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15809 * Get the mode the list is at.
15811 * @param obj The list object
15812 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15813 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15815 * @note see elm_list_mode_set() for more information.
15819 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15822 * Enable or disable horizontal mode on the list object.
15824 * @param obj The list object.
15825 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15826 * disable it, i.e., to enable vertical mode.
15828 * @note Vertical mode is set by default.
15830 * On horizontal mode items are displayed on list from left to right,
15831 * instead of from top to bottom. Also, the list will scroll horizontally.
15832 * Each item will presents left icon on top and right icon, or end, at
15835 * @see elm_list_horizontal_get()
15839 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15842 * Get a value whether horizontal mode is enabled or not.
15844 * @param obj The list object.
15845 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15846 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15847 * @c EINA_FALSE is returned.
15849 * @see elm_list_horizontal_set() for details.
15853 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15856 * Enable or disable always select mode on the list object.
15858 * @param obj The list object
15859 * @param always_select @c EINA_TRUE to enable always select mode or
15860 * @c EINA_FALSE to disable it.
15862 * @note Always select mode is disabled by default.
15864 * Default behavior of list items is to only call its callback function
15865 * the first time it's pressed, i.e., when it is selected. If a selected
15866 * item is pressed again, and multi-select is disabled, it won't call
15867 * this function (if multi-select is enabled it will unselect the item).
15869 * If always select is enabled, it will call the callback function
15870 * everytime a item is pressed, so it will call when the item is selected,
15871 * and again when a selected item is pressed.
15873 * @see elm_list_always_select_mode_get()
15874 * @see elm_list_multi_select_set()
15878 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15881 * Get a value whether always select mode is enabled or not, meaning that
15882 * an item will always call its callback function, even if already selected.
15884 * @param obj The list object
15885 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15886 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15887 * @c EINA_FALSE is returned.
15889 * @see elm_list_always_select_mode_set() for details.
15893 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15896 * Set bouncing behaviour when the scrolled content reaches an edge.
15898 * Tell the internal scroller object whether it should bounce or not
15899 * when it reaches the respective edges for each axis.
15901 * @param obj The list object
15902 * @param h_bounce Whether to bounce or not in the horizontal axis.
15903 * @param v_bounce Whether to bounce or not in the vertical axis.
15905 * @see elm_scroller_bounce_set()
15909 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15912 * Get the bouncing behaviour of the internal scroller.
15914 * Get whether the internal scroller should bounce when the edge of each
15915 * axis is reached scrolling.
15917 * @param obj The list object.
15918 * @param h_bounce Pointer where to store the bounce state of the horizontal
15920 * @param v_bounce Pointer where to store the bounce state of the vertical
15923 * @see elm_scroller_bounce_get()
15924 * @see elm_list_bounce_set()
15928 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15931 * Set the scrollbar policy.
15933 * @param obj The list object
15934 * @param policy_h Horizontal scrollbar policy.
15935 * @param policy_v Vertical scrollbar policy.
15937 * This sets the scrollbar visibility policy for the given scroller.
15938 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15939 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15940 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15941 * This applies respectively for the horizontal and vertical scrollbars.
15943 * The both are disabled by default, i.e., are set to
15944 * #ELM_SCROLLER_POLICY_OFF.
15948 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15951 * Get the scrollbar policy.
15953 * @see elm_list_scroller_policy_get() for details.
15955 * @param obj The list object.
15956 * @param policy_h Pointer where to store horizontal scrollbar policy.
15957 * @param policy_v Pointer where to store vertical scrollbar policy.
15961 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);
15964 * Append a new item to the list object.
15966 * @param obj The list object.
15967 * @param label The label of the list item.
15968 * @param icon The icon object to use for the left side of the item. An
15969 * icon can be any Evas object, but usually it is an icon created
15970 * with elm_icon_add().
15971 * @param end The icon object to use for the right side of the item. An
15972 * icon can be any Evas object.
15973 * @param func The function to call when the item is clicked.
15974 * @param data The data to associate with the item for related callbacks.
15976 * @return The created item or @c NULL upon failure.
15978 * A new item will be created and appended to the list, i.e., will
15979 * be set as @b last item.
15981 * Items created with this method can be deleted with
15982 * elm_list_item_del().
15984 * Associated @p data can be properly freed when item is deleted if a
15985 * callback function is set with elm_list_item_del_cb_set().
15987 * If a function is passed as argument, it will be called everytime this item
15988 * is selected, i.e., the user clicks over an unselected item.
15989 * If always select is enabled it will call this function every time
15990 * user clicks over an item (already selected or not).
15991 * If such function isn't needed, just passing
15992 * @c NULL as @p func is enough. The same should be done for @p data.
15994 * Simple example (with no function callback or data associated):
15996 * li = elm_list_add(win);
15997 * ic = elm_icon_add(win);
15998 * elm_icon_file_set(ic, "path/to/image", NULL);
15999 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16000 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16002 * evas_object_show(li);
16005 * @see elm_list_always_select_mode_set()
16006 * @see elm_list_item_del()
16007 * @see elm_list_item_del_cb_set()
16008 * @see elm_list_clear()
16009 * @see elm_icon_add()
16013 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);
16016 * Prepend a new item to the list object.
16018 * @param obj The list object.
16019 * @param label The label of the list item.
16020 * @param icon The icon object to use for the left side of the item. An
16021 * icon can be any Evas object, but usually it is an icon created
16022 * with elm_icon_add().
16023 * @param end The icon object to use for the right side of the item. An
16024 * icon can be any Evas object.
16025 * @param func The function to call when the item is clicked.
16026 * @param data The data to associate with the item for related callbacks.
16028 * @return The created item or @c NULL upon failure.
16030 * A new item will be created and prepended to the list, i.e., will
16031 * be set as @b first item.
16033 * Items created with this method can be deleted with
16034 * elm_list_item_del().
16036 * Associated @p data can be properly freed when item is deleted if a
16037 * callback function is set with elm_list_item_del_cb_set().
16039 * If a function is passed as argument, it will be called everytime this item
16040 * is selected, i.e., the user clicks over an unselected item.
16041 * If always select is enabled it will call this function every time
16042 * user clicks over an item (already selected or not).
16043 * If such function isn't needed, just passing
16044 * @c NULL as @p func is enough. The same should be done for @p data.
16046 * @see elm_list_item_append() for a simple code example.
16047 * @see elm_list_always_select_mode_set()
16048 * @see elm_list_item_del()
16049 * @see elm_list_item_del_cb_set()
16050 * @see elm_list_clear()
16051 * @see elm_icon_add()
16055 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);
16058 * Insert a new item into the list object before item @p before.
16060 * @param obj The list object.
16061 * @param before The list item to insert before.
16062 * @param label The label of the list item.
16063 * @param icon The icon object to use for the left side of the item. An
16064 * icon can be any Evas object, but usually it is an icon created
16065 * with elm_icon_add().
16066 * @param end The icon object to use for the right side of the item. An
16067 * icon can be any Evas object.
16068 * @param func The function to call when the item is clicked.
16069 * @param data The data to associate with the item for related callbacks.
16071 * @return The created item or @c NULL upon failure.
16073 * A new item will be created and added to the list. Its position in
16074 * this list will be just before item @p before.
16076 * Items created with this method can be deleted with
16077 * elm_list_item_del().
16079 * Associated @p data can be properly freed when item is deleted if a
16080 * callback function is set with elm_list_item_del_cb_set().
16082 * If a function is passed as argument, it will be called everytime this item
16083 * is selected, i.e., the user clicks over an unselected item.
16084 * If always select is enabled it will call this function every time
16085 * user clicks over an item (already selected or not).
16086 * If such function isn't needed, just passing
16087 * @c NULL as @p func is enough. The same should be done for @p data.
16089 * @see elm_list_item_append() for a simple code example.
16090 * @see elm_list_always_select_mode_set()
16091 * @see elm_list_item_del()
16092 * @see elm_list_item_del_cb_set()
16093 * @see elm_list_clear()
16094 * @see elm_icon_add()
16098 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);
16101 * Insert a new item into the list object after item @p after.
16103 * @param obj The list object.
16104 * @param after The list item to insert after.
16105 * @param label The label of the list item.
16106 * @param icon The icon object to use for the left side of the item. An
16107 * icon can be any Evas object, but usually it is an icon created
16108 * with elm_icon_add().
16109 * @param end The icon object to use for the right side of the item. An
16110 * icon can be any Evas object.
16111 * @param func The function to call when the item is clicked.
16112 * @param data The data to associate with the item for related callbacks.
16114 * @return The created item or @c NULL upon failure.
16116 * A new item will be created and added to the list. Its position in
16117 * this list will be just after item @p after.
16119 * Items created with this method can be deleted with
16120 * elm_list_item_del().
16122 * Associated @p data can be properly freed when item is deleted if a
16123 * callback function is set with elm_list_item_del_cb_set().
16125 * If a function is passed as argument, it will be called everytime this item
16126 * is selected, i.e., the user clicks over an unselected item.
16127 * If always select is enabled it will call this function every time
16128 * user clicks over an item (already selected or not).
16129 * If such function isn't needed, just passing
16130 * @c NULL as @p func is enough. The same should be done for @p data.
16132 * @see elm_list_item_append() for a simple code example.
16133 * @see elm_list_always_select_mode_set()
16134 * @see elm_list_item_del()
16135 * @see elm_list_item_del_cb_set()
16136 * @see elm_list_clear()
16137 * @see elm_icon_add()
16141 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);
16144 * Insert a new item into the sorted list object.
16146 * @param obj The list object.
16147 * @param label The label of the list item.
16148 * @param icon The icon object to use for the left side of the item. An
16149 * icon can be any Evas object, but usually it is an icon created
16150 * with elm_icon_add().
16151 * @param end The icon object to use for the right side of the item. An
16152 * icon can be any Evas object.
16153 * @param func The function to call when the item is clicked.
16154 * @param data The data to associate with the item for related callbacks.
16155 * @param cmp_func The comparing function to be used to sort list
16156 * items <b>by #Elm_List_Item item handles</b>. This function will
16157 * receive two items and compare them, returning a non-negative integer
16158 * if the second item should be place after the first, or negative value
16159 * if should be placed before.
16161 * @return The created item or @c NULL upon failure.
16163 * @note This function inserts values into a list object assuming it was
16164 * sorted and the result will be sorted.
16166 * A new item will be created and added to the list. Its position in
16167 * this list will be found comparing the new item with previously inserted
16168 * items using function @p cmp_func.
16170 * Items created with this method can be deleted with
16171 * elm_list_item_del().
16173 * Associated @p data can be properly freed when item is deleted if a
16174 * callback function is set with elm_list_item_del_cb_set().
16176 * If a function is passed as argument, it will be called everytime this item
16177 * is selected, i.e., the user clicks over an unselected item.
16178 * If always select is enabled it will call this function every time
16179 * user clicks over an item (already selected or not).
16180 * If such function isn't needed, just passing
16181 * @c NULL as @p func is enough. The same should be done for @p data.
16183 * @see elm_list_item_append() for a simple code example.
16184 * @see elm_list_always_select_mode_set()
16185 * @see elm_list_item_del()
16186 * @see elm_list_item_del_cb_set()
16187 * @see elm_list_clear()
16188 * @see elm_icon_add()
16192 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);
16195 * Remove all list's items.
16197 * @param obj The list object
16199 * @see elm_list_item_del()
16200 * @see elm_list_item_append()
16204 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16207 * Get a list of all the list items.
16209 * @param obj The list object
16210 * @return An @c Eina_List of list items, #Elm_List_Item,
16211 * or @c NULL on failure.
16213 * @see elm_list_item_append()
16214 * @see elm_list_item_del()
16215 * @see elm_list_clear()
16219 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16222 * Get the selected item.
16224 * @param obj The list object.
16225 * @return The selected list item.
16227 * The selected item can be unselected with function
16228 * elm_list_item_selected_set().
16230 * The selected item always will be highlighted on list.
16232 * @see elm_list_selected_items_get()
16236 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16239 * Return a list of the currently selected list items.
16241 * @param obj The list object.
16242 * @return An @c Eina_List of list items, #Elm_List_Item,
16243 * or @c NULL on failure.
16245 * Multiple items can be selected if multi select is enabled. It can be
16246 * done with elm_list_multi_select_set().
16248 * @see elm_list_selected_item_get()
16249 * @see elm_list_multi_select_set()
16253 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16256 * Set the selected state of an item.
16258 * @param item The list item
16259 * @param selected The selected state
16261 * This sets the selected state of the given item @p it.
16262 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16264 * If a new item is selected the previosly selected will be unselected,
16265 * unless multiple selection is enabled with elm_list_multi_select_set().
16266 * Previoulsy selected item can be get with function
16267 * elm_list_selected_item_get().
16269 * Selected items will be highlighted.
16271 * @see elm_list_item_selected_get()
16272 * @see elm_list_selected_item_get()
16273 * @see elm_list_multi_select_set()
16277 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16280 * Get whether the @p item is selected or not.
16282 * @param item The list item.
16283 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16284 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16286 * @see elm_list_selected_item_set() for details.
16287 * @see elm_list_item_selected_get()
16291 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16294 * Set or unset item as a separator.
16296 * @param it The list item.
16297 * @param setting @c EINA_TRUE to set item @p it as separator or
16298 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16300 * Items aren't set as separator by default.
16302 * If set as separator it will display separator theme, so won't display
16305 * @see elm_list_item_separator_get()
16309 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16312 * Get a value whether item is a separator or not.
16314 * @see elm_list_item_separator_set() for details.
16316 * @param it The list item.
16317 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16318 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16322 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16325 * Show @p item in the list view.
16327 * @param item The list item to be shown.
16329 * It won't animate list until item is visible. If such behavior is wanted,
16330 * use elm_list_bring_in() intead.
16334 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16337 * Bring in the given item to list view.
16339 * @param item The item.
16341 * This causes list to jump to the given item @p item and show it
16342 * (by scrolling), if it is not fully visible.
16344 * This may use animation to do so and take a period of time.
16346 * If animation isn't wanted, elm_list_item_show() can be used.
16350 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16353 * Delete them item from the list.
16355 * @param item The item of list to be deleted.
16357 * If deleting all list items is required, elm_list_clear()
16358 * should be used instead of getting items list and deleting each one.
16360 * @see elm_list_clear()
16361 * @see elm_list_item_append()
16362 * @see elm_list_item_del_cb_set()
16366 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16369 * Set the function called when a list item is freed.
16371 * @param item The item to set the callback on
16372 * @param func The function called
16374 * If there is a @p func, then it will be called prior item's memory release.
16375 * That will be called with the following arguments:
16377 * @li item's Evas object;
16380 * This way, a data associated to a list item could be properly freed.
16384 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16387 * Get the data associated to the item.
16389 * @param item The list item
16390 * @return The data associated to @p item
16392 * The return value is a pointer to data associated to @p item when it was
16393 * created, with function elm_list_item_append() or similar. If no data
16394 * was passed as argument, it will return @c NULL.
16396 * @see elm_list_item_append()
16400 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16403 * Get the left side icon associated to the item.
16405 * @param item The list item
16406 * @return The left side icon associated to @p item
16408 * The return value is a pointer to the icon associated to @p item when
16410 * created, with function elm_list_item_append() or similar, or later
16411 * with function elm_list_item_icon_set(). If no icon
16412 * was passed as argument, it will return @c NULL.
16414 * @see elm_list_item_append()
16415 * @see elm_list_item_icon_set()
16419 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16422 * Set the left side icon associated to the item.
16424 * @param item The list item
16425 * @param icon The left side icon object to associate with @p item
16427 * The icon object to use at left side of the item. An
16428 * icon can be any Evas object, but usually it is an icon created
16429 * with elm_icon_add().
16431 * Once the icon object is set, a previously set one will be deleted.
16432 * @warning Setting the same icon for two items will cause the icon to
16433 * dissapear from the first item.
16435 * If an icon was passed as argument on item creation, with function
16436 * elm_list_item_append() or similar, it will be already
16437 * associated to the item.
16439 * @see elm_list_item_append()
16440 * @see elm_list_item_icon_get()
16444 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16447 * Get the right side icon associated to the item.
16449 * @param item The list item
16450 * @return The right side icon associated to @p item
16452 * The return value is a pointer to the icon associated to @p item when
16454 * created, with function elm_list_item_append() or similar, or later
16455 * with function elm_list_item_icon_set(). If no icon
16456 * was passed as argument, it will return @c NULL.
16458 * @see elm_list_item_append()
16459 * @see elm_list_item_icon_set()
16463 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16466 * Set the right side icon associated to the item.
16468 * @param item The list item
16469 * @param end The right side icon object to associate with @p item
16471 * The icon object to use at right side of the item. An
16472 * icon can be any Evas object, but usually it is an icon created
16473 * with elm_icon_add().
16475 * Once the icon object is set, a previously set one will be deleted.
16476 * @warning Setting the same icon for two items will cause the icon to
16477 * dissapear from the first item.
16479 * If an icon was passed as argument on item creation, with function
16480 * elm_list_item_append() or similar, it will be already
16481 * associated to the item.
16483 * @see elm_list_item_append()
16484 * @see elm_list_item_end_get()
16488 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16491 * Gets the base object of the item.
16493 * @param item The list item
16494 * @return The base object associated with @p item
16496 * Base object is the @c Evas_Object that represents that item.
16500 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16501 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16504 * Get the label of item.
16506 * @param item The item of list.
16507 * @return The label of item.
16509 * The return value is a pointer to the label associated to @p item when
16510 * it was created, with function elm_list_item_append(), or later
16511 * with function elm_list_item_label_set. If no label
16512 * was passed as argument, it will return @c NULL.
16514 * @see elm_list_item_label_set() for more details.
16515 * @see elm_list_item_append()
16519 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16522 * Set the label of item.
16524 * @param item The item of list.
16525 * @param text The label of item.
16527 * The label to be displayed by the item.
16528 * Label will be placed between left and right side icons (if set).
16530 * If a label was passed as argument on item creation, with function
16531 * elm_list_item_append() or similar, it will be already
16532 * displayed by the item.
16534 * @see elm_list_item_label_get()
16535 * @see elm_list_item_append()
16539 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16543 * Get the item before @p it in list.
16545 * @param it The list item.
16546 * @return The item before @p it, or @c NULL if none or on failure.
16548 * @note If it is the first item, @c NULL will be returned.
16550 * @see elm_list_item_append()
16551 * @see elm_list_items_get()
16555 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16558 * Get the item after @p it in list.
16560 * @param it The list item.
16561 * @return The item after @p it, or @c NULL if none or on failure.
16563 * @note If it is the last item, @c NULL will be returned.
16565 * @see elm_list_item_append()
16566 * @see elm_list_items_get()
16570 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16573 * Sets the disabled/enabled state of a list item.
16575 * @param it The item.
16576 * @param disabled The disabled state.
16578 * A disabled item cannot be selected or unselected. It will also
16579 * change its appearance (generally greyed out). This sets the
16580 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16585 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16588 * Get a value whether list item is disabled or not.
16590 * @param it The item.
16591 * @return The disabled state.
16593 * @see elm_list_item_disabled_set() for more details.
16597 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16600 * Set the text to be shown in a given list item's tooltips.
16602 * @param item Target item.
16603 * @param text The text to set in the content.
16605 * Setup the text as tooltip to object. The item can have only one tooltip,
16606 * so any previous tooltip data - set with this function or
16607 * elm_list_item_tooltip_content_cb_set() - is removed.
16609 * @see elm_object_tooltip_text_set() for more details.
16613 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16617 * @brief Disable size restrictions on an object's tooltip
16618 * @param item The tooltip's anchor object
16619 * @param disable If EINA_TRUE, size restrictions are disabled
16620 * @return EINA_FALSE on failure, EINA_TRUE on success
16622 * This function allows a tooltip to expand beyond its parant window's canvas.
16623 * It will instead be limited only by the size of the display.
16625 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16627 * @brief Retrieve size restriction state of an object's tooltip
16628 * @param obj The tooltip's anchor object
16629 * @return If EINA_TRUE, size restrictions are disabled
16631 * This function returns whether a tooltip is allowed to expand beyond
16632 * its parant window's canvas.
16633 * It will instead be limited only by the size of the display.
16635 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16638 * Set the content to be shown in the tooltip item.
16640 * Setup the tooltip to item. The item can have only one tooltip,
16641 * so any previous tooltip data is removed. @p func(with @p data) will
16642 * be called every time that need show the tooltip and it should
16643 * return a valid Evas_Object. This object is then managed fully by
16644 * tooltip system and is deleted when the tooltip is gone.
16646 * @param item the list item being attached a tooltip.
16647 * @param func the function used to create the tooltip contents.
16648 * @param data what to provide to @a func as callback data/context.
16649 * @param del_cb called when data is not needed anymore, either when
16650 * another callback replaces @a func, the tooltip is unset with
16651 * elm_list_item_tooltip_unset() or the owner @a item
16652 * dies. This callback receives as the first parameter the
16653 * given @a data, and @c event_info is the item.
16655 * @see elm_object_tooltip_content_cb_set() for more details.
16659 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);
16662 * Unset tooltip from item.
16664 * @param item list item to remove previously set tooltip.
16666 * Remove tooltip from item. The callback provided as del_cb to
16667 * elm_list_item_tooltip_content_cb_set() will be called to notify
16668 * it is not used anymore.
16670 * @see elm_object_tooltip_unset() for more details.
16671 * @see elm_list_item_tooltip_content_cb_set()
16675 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16678 * Sets a different style for this item tooltip.
16680 * @note before you set a style you should define a tooltip with
16681 * elm_list_item_tooltip_content_cb_set() or
16682 * elm_list_item_tooltip_text_set()
16684 * @param item list item with tooltip already set.
16685 * @param style the theme style to use (default, transparent, ...)
16687 * @see elm_object_tooltip_style_set() for more details.
16691 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16694 * Get the style for this item tooltip.
16696 * @param item list item with tooltip already set.
16697 * @return style the theme style in use, defaults to "default". If the
16698 * object does not have a tooltip set, then NULL is returned.
16700 * @see elm_object_tooltip_style_get() for more details.
16701 * @see elm_list_item_tooltip_style_set()
16705 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16708 * Set the type of mouse pointer/cursor decoration to be shown,
16709 * when the mouse pointer is over the given list widget item
16711 * @param item list item to customize cursor on
16712 * @param cursor the cursor type's name
16714 * This function works analogously as elm_object_cursor_set(), but
16715 * here the cursor's changing area is restricted to the item's
16716 * area, and not the whole widget's. Note that that item cursors
16717 * have precedence over widget cursors, so that a mouse over an
16718 * item with custom cursor set will always show @b that cursor.
16720 * If this function is called twice for an object, a previously set
16721 * cursor will be unset on the second call.
16723 * @see elm_object_cursor_set()
16724 * @see elm_list_item_cursor_get()
16725 * @see elm_list_item_cursor_unset()
16729 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16732 * Get the type of mouse pointer/cursor decoration set to be shown,
16733 * when the mouse pointer is over the given list widget item
16735 * @param item list item with custom cursor set
16736 * @return the cursor type's name or @c NULL, if no custom cursors
16737 * were set to @p item (and on errors)
16739 * @see elm_object_cursor_get()
16740 * @see elm_list_item_cursor_set()
16741 * @see elm_list_item_cursor_unset()
16745 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16748 * Unset any custom mouse pointer/cursor decoration set to be
16749 * shown, when the mouse pointer is over the given list widget
16750 * item, thus making it show the @b default cursor again.
16752 * @param item a list item
16754 * Use this call to undo any custom settings on this item's cursor
16755 * decoration, bringing it back to defaults (no custom style set).
16757 * @see elm_object_cursor_unset()
16758 * @see elm_list_item_cursor_set()
16762 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16765 * Set a different @b style for a given custom cursor set for a
16768 * @param item list item with custom cursor set
16769 * @param style the <b>theme style</b> to use (e.g. @c "default",
16770 * @c "transparent", etc)
16772 * This function only makes sense when one is using custom mouse
16773 * cursor decorations <b>defined in a theme file</b>, which can have,
16774 * given a cursor name/type, <b>alternate styles</b> on it. It
16775 * works analogously as elm_object_cursor_style_set(), but here
16776 * applyed only to list item objects.
16778 * @warning Before you set a cursor style you should have definen a
16779 * custom cursor previously on the item, with
16780 * elm_list_item_cursor_set()
16782 * @see elm_list_item_cursor_engine_only_set()
16783 * @see elm_list_item_cursor_style_get()
16787 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16790 * Get the current @b style set for a given list item's custom
16793 * @param item list item with custom cursor set.
16794 * @return style the cursor style in use. If the object does not
16795 * have a cursor set, then @c NULL is returned.
16797 * @see elm_list_item_cursor_style_set() for more details
16801 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16804 * Set if the (custom)cursor for a given list item should be
16805 * searched in its theme, also, or should only rely on the
16806 * rendering engine.
16808 * @param item item with custom (custom) cursor already set on
16809 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16810 * only on those provided by the rendering engine, @c EINA_FALSE to
16811 * have them searched on the widget's theme, as well.
16813 * @note This call is of use only if you've set a custom cursor
16814 * for list items, with elm_list_item_cursor_set().
16816 * @note By default, cursors will only be looked for between those
16817 * provided by the rendering engine.
16821 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16824 * Get if the (custom) cursor for a given list item is being
16825 * searched in its theme, also, or is only relying on the rendering
16828 * @param item a list item
16829 * @return @c EINA_TRUE, if cursors are being looked for only on
16830 * those provided by the rendering engine, @c EINA_FALSE if they
16831 * are being searched on the widget's theme, as well.
16833 * @see elm_list_item_cursor_engine_only_set(), for more details
16837 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16844 * @defgroup Slider Slider
16845 * @ingroup Elementary
16847 * @image html img/widget/slider/preview-00.png
16848 * @image latex img/widget/slider/preview-00.eps width=\textwidth
16850 * The slider adds a dragable “slider” widget for selecting the value of
16851 * something within a range.
16853 * A slider can be horizontal or vertical. It can contain an Icon and has a
16854 * primary label as well as a units label (that is formatted with floating
16855 * point values and thus accepts a printf-style format string, like
16856 * “%1.2f units”. There is also an indicator string that may be somewhere
16857 * else (like on the slider itself) that also accepts a format string like
16858 * units. Label, Icon Unit and Indicator strings/objects are optional.
16860 * A slider may be inverted which means values invert, with high vales being
16861 * on the left or top and low values on the right or bottom (as opposed to
16862 * normally being low on the left or top and high on the bottom and right).
16864 * The slider should have its minimum and maximum values set by the
16865 * application with elm_slider_min_max_set() and value should also be set by
16866 * the application before use with elm_slider_value_set(). The span of the
16867 * slider is its length (horizontally or vertically). This will be scaled by
16868 * the object or applications scaling factor. At any point code can query the
16869 * slider for its value with elm_slider_value_get().
16871 * Smart callbacks one can listen to:
16872 * - "changed" - Whenever the slider value is changed by the user.
16873 * - "slider,drag,start" - dragging the slider indicator around has started.
16874 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16875 * - "delay,changed" - A short time after the value is changed by the user.
16876 * This will be called only when the user stops dragging for
16877 * a very short period or when they release their
16878 * finger/mouse, so it avoids possibly expensive reactions to
16879 * the value change.
16881 * Available styles for it:
16884 * Here is an example on its usage:
16885 * @li @ref slider_example
16889 * @addtogroup Slider
16894 * Add a new slider widget to the given parent Elementary
16895 * (container) object.
16897 * @param parent The parent object.
16898 * @return a new slider widget handle or @c NULL, on errors.
16900 * This function inserts a new slider widget on the canvas.
16904 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16907 * Set the label of a given slider widget
16909 * @param obj The progress bar object
16910 * @param label The text label string, in UTF-8
16913 * @deprecated use elm_object_text_set() instead.
16915 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16918 * Get the label of a given slider widget
16920 * @param obj The progressbar object
16921 * @return The text label string, in UTF-8
16924 * @deprecated use elm_object_text_get() instead.
16926 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16929 * Set the icon object of the slider object.
16931 * @param obj The slider object.
16932 * @param icon The icon object.
16934 * On horizontal mode, icon is placed at left, and on vertical mode,
16937 * @note Once the icon object is set, a previously set one will be deleted.
16938 * If you want to keep that old content object, use the
16939 * elm_slider_icon_unset() function.
16941 * @warning If the object being set does not have minimum size hints set,
16942 * it won't get properly displayed.
16946 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16949 * Unset an icon set on a given slider widget.
16951 * @param obj The slider object.
16952 * @return The icon object that was being used, if any was set, or
16953 * @c NULL, otherwise (and on errors).
16955 * On horizontal mode, icon is placed at left, and on vertical mode,
16958 * This call will unparent and return the icon object which was set
16959 * for this widget, previously, on success.
16961 * @see elm_slider_icon_set() for more details
16962 * @see elm_slider_icon_get()
16966 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16969 * Retrieve the icon object set for a given slider widget.
16971 * @param obj The slider object.
16972 * @return The icon object's handle, if @p obj had one set, or @c NULL,
16973 * otherwise (and on errors).
16975 * On horizontal mode, icon is placed at left, and on vertical mode,
16978 * @see elm_slider_icon_set() for more details
16979 * @see elm_slider_icon_unset()
16983 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16986 * Set the end object of the slider object.
16988 * @param obj The slider object.
16989 * @param end The end object.
16991 * On horizontal mode, end is placed at left, and on vertical mode,
16992 * placed at bottom.
16994 * @note Once the icon object is set, a previously set one will be deleted.
16995 * If you want to keep that old content object, use the
16996 * elm_slider_end_unset() function.
16998 * @warning If the object being set does not have minimum size hints set,
16999 * it won't get properly displayed.
17003 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17006 * Unset an end object set on a given slider widget.
17008 * @param obj The slider object.
17009 * @return The end object that was being used, if any was set, or
17010 * @c NULL, otherwise (and on errors).
17012 * On horizontal mode, end is placed at left, and on vertical mode,
17013 * placed at bottom.
17015 * This call will unparent and return the icon object which was set
17016 * for this widget, previously, on success.
17018 * @see elm_slider_end_set() for more details.
17019 * @see elm_slider_end_get()
17023 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17026 * Retrieve the end object set for a given slider widget.
17028 * @param obj The slider object.
17029 * @return The end object's handle, if @p obj had one set, or @c NULL,
17030 * otherwise (and on errors).
17032 * On horizontal mode, icon is placed at right, and on vertical mode,
17033 * placed at bottom.
17035 * @see elm_slider_end_set() for more details.
17036 * @see elm_slider_end_unset()
17040 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17043 * Set the (exact) length of the bar region of a given slider widget.
17045 * @param obj The slider object.
17046 * @param size The length of the slider's bar region.
17048 * This sets the minimum width (when in horizontal mode) or height
17049 * (when in vertical mode) of the actual bar area of the slider
17050 * @p obj. This in turn affects the object's minimum size. Use
17051 * this when you're not setting other size hints expanding on the
17052 * given direction (like weight and alignment hints) and you would
17053 * like it to have a specific size.
17055 * @note Icon, end, label, indicator and unit text around @p obj
17056 * will require their
17057 * own space, which will make @p obj to require more the @p size,
17060 * @see elm_slider_span_size_get()
17064 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17067 * Get the length set for the bar region of a given slider widget
17069 * @param obj The slider object.
17070 * @return The length of the slider's bar region.
17072 * If that size was not set previously, with
17073 * elm_slider_span_size_set(), this call will return @c 0.
17077 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17080 * Set the format string for the unit label.
17082 * @param obj The slider object.
17083 * @param format The format string for the unit display.
17085 * Unit label is displayed all the time, if set, after slider's bar.
17086 * In horizontal mode, at right and in vertical mode, at bottom.
17088 * If @c NULL, unit label won't be visible. If not it sets the format
17089 * string for the label text. To the label text is provided a floating point
17090 * value, so the label text can display up to 1 floating point value.
17091 * Note that this is optional.
17093 * Use a format string such as "%1.2f meters" for example, and it will
17094 * display values like: "3.14 meters" for a value equal to 3.14159.
17096 * Default is unit label disabled.
17098 * @see elm_slider_indicator_format_get()
17102 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17105 * Get the unit label format of the slider.
17107 * @param obj The slider object.
17108 * @return The unit label format string in UTF-8.
17110 * Unit label is displayed all the time, if set, after slider's bar.
17111 * In horizontal mode, at right and in vertical mode, at bottom.
17113 * @see elm_slider_unit_format_set() for more
17114 * information on how this works.
17118 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17121 * Set the format string for the indicator label.
17123 * @param obj The slider object.
17124 * @param indicator The format string for the indicator display.
17126 * The slider may display its value somewhere else then unit label,
17127 * for example, above the slider knob that is dragged around. This function
17128 * sets the format string used for this.
17130 * If @c NULL, indicator label won't be visible. If not it sets the format
17131 * string for the label text. To the label text is provided a floating point
17132 * value, so the label text can display up to 1 floating point value.
17133 * Note that this is optional.
17135 * Use a format string such as "%1.2f meters" for example, and it will
17136 * display values like: "3.14 meters" for a value equal to 3.14159.
17138 * Default is indicator label disabled.
17140 * @see elm_slider_indicator_format_get()
17144 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17147 * Get the indicator label format of the slider.
17149 * @param obj The slider object.
17150 * @return The indicator label format string in UTF-8.
17152 * The slider may display its value somewhere else then unit label,
17153 * for example, above the slider knob that is dragged around. This function
17154 * gets the format string used for this.
17156 * @see elm_slider_indicator_format_set() for more
17157 * information on how this works.
17161 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17164 * Set the format function pointer for the indicator label
17166 * @param obj The slider object.
17167 * @param func The indicator format function.
17168 * @param free_func The freeing function for the format string.
17170 * Set the callback function to format the indicator string.
17172 * @see elm_slider_indicator_format_set() for more info on how this works.
17176 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);
17179 * Set the format function pointer for the units label
17181 * @param obj The slider object.
17182 * @param func The units format function.
17183 * @param free_func The freeing function for the format string.
17185 * Set the callback function to format the indicator string.
17187 * @see elm_slider_units_format_set() for more info on how this works.
17191 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);
17194 * Set the orientation of a given slider widget.
17196 * @param obj The slider object.
17197 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17198 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17200 * Use this function to change how your slider is to be
17201 * disposed: vertically or horizontally.
17203 * By default it's displayed horizontally.
17205 * @see elm_slider_horizontal_get()
17209 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17212 * Retrieve the orientation of a given slider widget
17214 * @param obj The slider object.
17215 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17216 * @c EINA_FALSE if it's @b vertical (and on errors).
17218 * @see elm_slider_horizontal_set() for more details.
17222 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17225 * Set the minimum and maximum values for the slider.
17227 * @param obj The slider object.
17228 * @param min The minimum value.
17229 * @param max The maximum value.
17231 * Define the allowed range of values to be selected by the user.
17233 * If actual value is less than @p min, it will be updated to @p min. If it
17234 * is bigger then @p max, will be updated to @p max. Actual value can be
17235 * get with elm_slider_value_get().
17237 * By default, min is equal to 0.0, and max is equal to 1.0.
17239 * @warning Maximum must be greater than minimum, otherwise behavior
17242 * @see elm_slider_min_max_get()
17246 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17249 * Get the minimum and maximum values of the slider.
17251 * @param obj The slider object.
17252 * @param min Pointer where to store the minimum value.
17253 * @param max Pointer where to store the maximum value.
17255 * @note If only one value is needed, the other pointer can be passed
17258 * @see elm_slider_min_max_set() for details.
17262 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17265 * Set the value the slider displays.
17267 * @param obj The slider object.
17268 * @param val The value to be displayed.
17270 * Value will be presented on the unit label following format specified with
17271 * elm_slider_unit_format_set() and on indicator with
17272 * elm_slider_indicator_format_set().
17274 * @warning The value must to be between min and max values. This values
17275 * are set by elm_slider_min_max_set().
17277 * @see elm_slider_value_get()
17278 * @see elm_slider_unit_format_set()
17279 * @see elm_slider_indicator_format_set()
17280 * @see elm_slider_min_max_set()
17284 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17287 * Get the value displayed by the spinner.
17289 * @param obj The spinner object.
17290 * @return The value displayed.
17292 * @see elm_spinner_value_set() for details.
17296 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17299 * Invert a given slider widget's displaying values order
17301 * @param obj The slider object.
17302 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17303 * @c EINA_FALSE to bring it back to default, non-inverted values.
17305 * A slider may be @b inverted, in which state it gets its
17306 * values inverted, with high vales being on the left or top and
17307 * low values on the right or bottom, as opposed to normally have
17308 * the low values on the former and high values on the latter,
17309 * respectively, for horizontal and vertical modes.
17311 * @see elm_slider_inverted_get()
17315 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17318 * Get whether a given slider widget's displaying values are
17321 * @param obj The slider object.
17322 * @return @c EINA_TRUE, if @p obj has inverted values,
17323 * @c EINA_FALSE otherwise (and on errors).
17325 * @see elm_slider_inverted_set() for more details.
17329 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17332 * Set whether to enlarge slider indicator (augmented knob) or not.
17334 * @param obj The slider object.
17335 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17336 * let the knob always at default size.
17338 * By default, indicator will be bigger while dragged by the user.
17340 * @warning It won't display values set with
17341 * elm_slider_indicator_format_set() if you disable indicator.
17345 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17348 * Get whether a given slider widget's enlarging indicator or not.
17350 * @param obj The slider object.
17351 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17352 * @c EINA_FALSE otherwise (and on errors).
17354 * @see elm_slider_indicator_show_set() for details.
17358 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17365 * @addtogroup Actionslider Actionslider
17367 * @image html img/widget/actionslider/preview-00.png
17368 * @image latex img/widget/actionslider/preview-00.eps
17370 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17371 * properties. The indicator is the element the user drags to choose a label.
17372 * When the position is set with magnet, when released the indicator will be
17373 * moved to it if it's nearest the magnetized position.
17375 * @note By default all positions are set as enabled.
17377 * Signals that you can add callbacks for are:
17379 * "selected" - when user selects an enabled position (the label is passed
17382 * "pos_changed" - when the indicator reaches any of the positions("left",
17383 * "right" or "center").
17385 * See an example of actionslider usage @ref actionslider_example_page "here"
17388 typedef enum _Elm_Actionslider_Pos
17390 ELM_ACTIONSLIDER_NONE = 0,
17391 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17392 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17393 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17394 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17395 } Elm_Actionslider_Pos;
17398 * Add a new actionslider to the parent.
17400 * @param parent The parent object
17401 * @return The new actionslider object or NULL if it cannot be created
17403 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17405 * Set actionslider labels.
17407 * @param obj The actionslider object
17408 * @param left_label The label to be set on the left.
17409 * @param center_label The label to be set on the center.
17410 * @param right_label The label to be set on the right.
17411 * @deprecated use elm_object_text_set() instead.
17413 EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
17415 * Get actionslider labels.
17417 * @param obj The actionslider object
17418 * @param left_label A char** to place the left_label of @p obj into.
17419 * @param center_label A char** to place the center_label of @p obj into.
17420 * @param right_label A char** to place the right_label of @p obj into.
17421 * @deprecated use elm_object_text_set() instead.
17423 EINA_DEPRECATED EAPI void elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
17425 * Get actionslider selected label.
17427 * @param obj The actionslider object
17428 * @return The selected label
17430 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17432 * Set actionslider indicator position.
17434 * @param obj The actionslider object.
17435 * @param pos The position of the indicator.
17437 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17439 * Get actionslider indicator position.
17441 * @param obj The actionslider object.
17442 * @return The position of the indicator.
17444 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17446 * Set actionslider magnet position. To make multiple positions magnets @c or
17447 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17449 * @param obj The actionslider object.
17450 * @param pos Bit mask indicating the magnet positions.
17452 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17454 * Get actionslider magnet position.
17456 * @param obj The actionslider object.
17457 * @return The positions with magnet property.
17459 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17461 * Set actionslider enabled position. To set multiple positions as enabled @c or
17462 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17464 * @note All the positions are enabled by default.
17466 * @param obj The actionslider object.
17467 * @param pos Bit mask indicating the enabled positions.
17469 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17471 * Get actionslider enabled position.
17473 * @param obj The actionslider object.
17474 * @return The enabled positions.
17476 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17478 * Set the label used on the indicator.
17480 * @param obj The actionslider object
17481 * @param label The label to be set on the indicator.
17482 * @deprecated use elm_object_text_set() instead.
17484 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17486 * Get the label used on the indicator object.
17488 * @param obj The actionslider object
17489 * @return The indicator label
17490 * @deprecated use elm_object_text_get() instead.
17492 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17498 * @defgroup Genlist Genlist
17500 * @image html img/widget/genlist/preview-00.png
17501 * @image latex img/widget/genlist/preview-00.eps
17502 * @image html img/genlist.png
17503 * @image latex img/genlist.eps
17505 * This widget aims to have more expansive list than the simple list in
17506 * Elementary that could have more flexible items and allow many more entries
17507 * while still being fast and low on memory usage. At the same time it was
17508 * also made to be able to do tree structures. But the price to pay is more
17509 * complexity when it comes to usage. If all you want is a simple list with
17510 * icons and a single label, use the normal @ref List object.
17512 * Genlist has a fairly large API, mostly because it's relatively complex,
17513 * trying to be both expansive, powerful and efficient. First we will begin
17514 * an overview on the theory behind genlist.
17516 * @section Genlist_Item_Class Genlist item classes - creating items
17518 * In order to have the ability to add and delete items on the fly, genlist
17519 * implements a class (callback) system where the application provides a
17520 * structure with information about that type of item (genlist may contain
17521 * multiple different items with different classes, states and styles).
17522 * Genlist will call the functions in this struct (methods) when an item is
17523 * "realized" (i.e., created dynamically, while the user is scrolling the
17524 * grid). All objects will simply be deleted when no longer needed with
17525 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17526 * following members:
17527 * - @c item_style - This is a constant string and simply defines the name
17528 * of the item style. It @b must be specified and the default should be @c
17530 * - @c mode_item_style - This is a constant string and simply defines the
17531 * name of the style that will be used for mode animations. It can be left
17532 * as @c NULL if you don't plan to use Genlist mode. See
17533 * elm_genlist_item_mode_set() for more info.
17535 * - @c func - A struct with pointers to functions that will be called when
17536 * an item is going to be actually created. All of them receive a @c data
17537 * parameter that will point to the same data passed to
17538 * elm_genlist_item_append() and related item creation functions, and a @c
17539 * obj parameter that points to the genlist object itself.
17541 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17542 * state_get and @c del. The 3 first functions also receive a @c part
17543 * parameter described below. A brief description of these functions follows:
17545 * - @c label_get - The @c part parameter is the name string of one of the
17546 * existing text parts in the Edje group implementing the item's theme.
17547 * This function @b must return a strdup'()ed string, as the caller will
17548 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17549 * - @c icon_get - The @c part parameter is the name string of one of the
17550 * existing (icon) swallow parts in the Edje group implementing the item's
17551 * theme. It must return @c NULL, when no icon is desired, or a valid
17552 * object handle, otherwise. The object will be deleted by the genlist on
17553 * its deletion or when the item is "unrealized". See
17554 * #Elm_Genlist_Item_Icon_Get_Cb.
17555 * - @c func.state_get - The @c part parameter is the name string of one of
17556 * the state parts in the Edje group implementing the item's theme. Return
17557 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17558 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17559 * and @c "elm" as "emission" and "source" arguments, respectively, when
17560 * the state is true (the default is false), where @c XXX is the name of
17561 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17562 * - @c func.del - This is intended for use when genlist items are deleted,
17563 * so any data attached to the item (e.g. its data parameter on creation)
17564 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17566 * available item styles:
17568 * - default_style - The text part is a textblock
17570 * @image html img/widget/genlist/preview-04.png
17571 * @image latex img/widget/genlist/preview-04.eps
17575 * @image html img/widget/genlist/preview-01.png
17576 * @image latex img/widget/genlist/preview-01.eps
17578 * - icon_top_text_bottom
17580 * @image html img/widget/genlist/preview-02.png
17581 * @image latex img/widget/genlist/preview-02.eps
17585 * @image html img/widget/genlist/preview-03.png
17586 * @image latex img/widget/genlist/preview-03.eps
17588 * @section Genlist_Items Structure of items
17590 * An item in a genlist can have 0 or more text labels (they can be regular
17591 * text or textblock Evas objects - that's up to the style to determine), 0
17592 * or more icons (which are simply objects swallowed into the genlist item's
17593 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17594 * behavior left to the user to define. The Edje part names for each of
17595 * these properties will be looked up, in the theme file for the genlist,
17596 * under the Edje (string) data items named @c "labels", @c "icons" and @c
17597 * "states", respectively. For each of those properties, if more than one
17598 * part is provided, they must have names listed separated by spaces in the
17599 * data fields. For the default genlist item theme, we have @b one label
17600 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17601 * "elm.swallow.end") and @b no state parts.
17603 * A genlist item may be at one of several styles. Elementary provides one
17604 * by default - "default", but this can be extended by system or application
17605 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17608 * @section Genlist_Manipulation Editing and Navigating
17610 * Items can be added by several calls. All of them return a @ref
17611 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17612 * They all take a data parameter that is meant to be used for a handle to
17613 * the applications internal data (eg the struct with the original item
17614 * data). The parent parameter is the parent genlist item this belongs to if
17615 * it is a tree or an indexed group, and NULL if there is no parent. The
17616 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17617 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17618 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17619 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17620 * is set then this item is group index item that is displayed at the top
17621 * until the next group comes. The func parameter is a convenience callback
17622 * that is called when the item is selected and the data parameter will be
17623 * the func_data parameter, obj be the genlist object and event_info will be
17624 * the genlist item.
17626 * elm_genlist_item_append() adds an item to the end of the list, or if
17627 * there is a parent, to the end of all the child items of the parent.
17628 * elm_genlist_item_prepend() is the same but adds to the beginning of
17629 * the list or children list. elm_genlist_item_insert_before() inserts at
17630 * item before another item and elm_genlist_item_insert_after() inserts after
17631 * the indicated item.
17633 * The application can clear the list with elm_genlist_clear() which deletes
17634 * all the items in the list and elm_genlist_item_del() will delete a specific
17635 * item. elm_genlist_item_subitems_clear() will clear all items that are
17636 * children of the indicated parent item.
17638 * To help inspect list items you can jump to the item at the top of the list
17639 * with elm_genlist_first_item_get() which will return the item pointer, and
17640 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17641 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17642 * and previous items respectively relative to the indicated item. Using
17643 * these calls you can walk the entire item list/tree. Note that as a tree
17644 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17645 * let you know which item is the parent (and thus know how to skip them if
17648 * @section Genlist_Muti_Selection Multi-selection
17650 * If the application wants multiple items to be able to be selected,
17651 * elm_genlist_multi_select_set() can enable this. If the list is
17652 * single-selection only (the default), then elm_genlist_selected_item_get()
17653 * will return the selected item, if any, or NULL I none is selected. If the
17654 * list is multi-select then elm_genlist_selected_items_get() will return a
17655 * list (that is only valid as long as no items are modified (added, deleted,
17656 * selected or unselected)).
17658 * @section Genlist_Usage_Hints Usage hints
17660 * There are also convenience functions. elm_genlist_item_genlist_get() will
17661 * return the genlist object the item belongs to. elm_genlist_item_show()
17662 * will make the scroller scroll to show that specific item so its visible.
17663 * elm_genlist_item_data_get() returns the data pointer set by the item
17664 * creation functions.
17666 * If an item changes (state of boolean changes, label or icons change),
17667 * then use elm_genlist_item_update() to have genlist update the item with
17668 * the new state. Genlist will re-realize the item thus call the functions
17669 * in the _Elm_Genlist_Item_Class for that item.
17671 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17672 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17673 * to expand/contract an item and get its expanded state, use
17674 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17675 * again to make an item disabled (unable to be selected and appear
17676 * differently) use elm_genlist_item_disabled_set() to set this and
17677 * elm_genlist_item_disabled_get() to get the disabled state.
17679 * In general to indicate how the genlist should expand items horizontally to
17680 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17681 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17682 * mode means that if items are too wide to fit, the scroller will scroll
17683 * horizontally. Otherwise items are expanded to fill the width of the
17684 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17685 * to the viewport width and limited to that size. This can be combined with
17686 * a different style that uses edjes' ellipsis feature (cutting text off like
17689 * Items will only call their selection func and callback when first becoming
17690 * selected. Any further clicks will do nothing, unless you enable always
17691 * select with elm_genlist_always_select_mode_set(). This means even if
17692 * selected, every click will make the selected callbacks be called.
17693 * elm_genlist_no_select_mode_set() will turn off the ability to select
17694 * items entirely and they will neither appear selected nor call selected
17695 * callback functions.
17697 * Remember that you can create new styles and add your own theme augmentation
17698 * per application with elm_theme_extension_add(). If you absolutely must
17699 * have a specific style that overrides any theme the user or system sets up
17700 * you can use elm_theme_overlay_add() to add such a file.
17702 * @section Genlist_Implementation Implementation
17704 * Evas tracks every object you create. Every time it processes an event
17705 * (mouse move, down, up etc.) it needs to walk through objects and find out
17706 * what event that affects. Even worse every time it renders display updates,
17707 * in order to just calculate what to re-draw, it needs to walk through many
17708 * many many objects. Thus, the more objects you keep active, the more
17709 * overhead Evas has in just doing its work. It is advisable to keep your
17710 * active objects to the minimum working set you need. Also remember that
17711 * object creation and deletion carries an overhead, so there is a
17712 * middle-ground, which is not easily determined. But don't keep massive lists
17713 * of objects you can't see or use. Genlist does this with list objects. It
17714 * creates and destroys them dynamically as you scroll around. It groups them
17715 * into blocks so it can determine the visibility etc. of a whole block at
17716 * once as opposed to having to walk the whole list. This 2-level list allows
17717 * for very large numbers of items to be in the list (tests have used up to
17718 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17719 * may be different sizes, every item added needs to be calculated as to its
17720 * size and thus this presents a lot of overhead on populating the list, this
17721 * genlist employs a queue. Any item added is queued and spooled off over
17722 * time, actually appearing some time later, so if your list has many members
17723 * you may find it takes a while for them to all appear, with your process
17724 * consuming a lot of CPU while it is busy spooling.
17726 * Genlist also implements a tree structure, but it does so with callbacks to
17727 * the application, with the application filling in tree structures when
17728 * requested (allowing for efficient building of a very deep tree that could
17729 * even be used for file-management). See the above smart signal callbacks for
17732 * @section Genlist_Smart_Events Genlist smart events
17734 * Signals that you can add callbacks for are:
17735 * - @c "activated" - The user has double-clicked or pressed
17736 * (enter|return|spacebar) on an item. The @c event_info parameter is the
17737 * item that was activated.
17738 * - @c "clicked,double" - The user has double-clicked an item. The @c
17739 * event_info parameter is the item that was double-clicked.
17740 * - @c "selected" - This is called when a user has made an item selected.
17741 * The event_info parameter is the genlist item that was selected.
17742 * - @c "unselected" - This is called when a user has made an item
17743 * unselected. The event_info parameter is the genlist item that was
17745 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17746 * called and the item is now meant to be expanded. The event_info
17747 * parameter is the genlist item that was indicated to expand. It is the
17748 * job of this callback to then fill in the child items.
17749 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17750 * called and the item is now meant to be contracted. The event_info
17751 * parameter is the genlist item that was indicated to contract. It is the
17752 * job of this callback to then delete the child items.
17753 * - @c "expand,request" - This is called when a user has indicated they want
17754 * to expand a tree branch item. The callback should decide if the item can
17755 * expand (has any children) and then call elm_genlist_item_expanded_set()
17756 * appropriately to set the state. The event_info parameter is the genlist
17757 * item that was indicated to expand.
17758 * - @c "contract,request" - This is called when a user has indicated they
17759 * want to contract a tree branch item. The callback should decide if the
17760 * item can contract (has any children) and then call
17761 * elm_genlist_item_expanded_set() appropriately to set the state. The
17762 * event_info parameter is the genlist item that was indicated to contract.
17763 * - @c "realized" - This is called when the item in the list is created as a
17764 * real evas object. event_info parameter is the genlist item that was
17765 * created. The object may be deleted at any time, so it is up to the
17766 * caller to not use the object pointer from elm_genlist_item_object_get()
17767 * in a way where it may point to freed objects.
17768 * - @c "unrealized" - This is called just before an item is unrealized.
17769 * After this call icon objects provided will be deleted and the item
17770 * object itself delete or be put into a floating cache.
17771 * - @c "drag,start,up" - This is called when the item in the list has been
17772 * dragged (not scrolled) up.
17773 * - @c "drag,start,down" - This is called when the item in the list has been
17774 * dragged (not scrolled) down.
17775 * - @c "drag,start,left" - This is called when the item in the list has been
17776 * dragged (not scrolled) left.
17777 * - @c "drag,start,right" - This is called when the item in the list has
17778 * been dragged (not scrolled) right.
17779 * - @c "drag,stop" - This is called when the item in the list has stopped
17781 * - @c "drag" - This is called when the item in the list is being dragged.
17782 * - @c "longpressed" - This is called when the item is pressed for a certain
17783 * amount of time. By default it's 1 second.
17784 * - @c "scroll,anim,start" - This is called when scrolling animation has
17786 * - @c "scroll,anim,stop" - This is called when scrolling animation has
17788 * - @c "scroll,drag,start" - This is called when dragging the content has
17790 * - @c "scroll,drag,stop" - This is called when dragging the content has
17792 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
17794 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
17795 * until the bottom edge.
17796 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
17797 * until the left edge.
17798 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
17799 * until the right edge.
17800 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17802 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17804 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17806 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17808 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17809 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
17810 * multi-touch pinched in.
17811 * - @c "swipe" - This is called when the genlist is swiped.
17813 * @section Genlist_Examples Examples
17815 * Here is a list of examples that use the genlist, trying to show some of
17816 * its capabilities:
17817 * - @ref genlist_example_01
17818 * - @ref genlist_example_02
17819 * - @ref genlist_example_03
17820 * - @ref genlist_example_04
17821 * - @ref genlist_example_05
17825 * @addtogroup Genlist
17830 * @enum _Elm_Genlist_Item_Flags
17831 * @typedef Elm_Genlist_Item_Flags
17833 * Defines if the item is of any special type (has subitems or it's the
17834 * index of a group), or is just a simple item.
17838 typedef enum _Elm_Genlist_Item_Flags
17840 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17841 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17842 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17843 } Elm_Genlist_Item_Flags;
17844 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
17845 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17846 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
17847 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
17848 typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
17849 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
17850 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
17851 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
17853 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17854 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17855 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17856 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17859 * @struct _Elm_Genlist_Item_Class
17861 * Genlist item class definition structs.
17863 * This struct contains the style and fetching functions that will define the
17864 * contents of each item.
17866 * @see @ref Genlist_Item_Class
17868 struct _Elm_Genlist_Item_Class
17870 const char *item_style; /**< style of this class. */
17873 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
17874 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
17875 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
17876 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
17877 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
17879 const char *mode_item_style;
17883 * Add a new genlist widget to the given parent Elementary
17884 * (container) object
17886 * @param parent The parent object
17887 * @return a new genlist widget handle or @c NULL, on errors
17889 * This function inserts a new genlist widget on the canvas.
17891 * @see elm_genlist_item_append()
17892 * @see elm_genlist_item_del()
17893 * @see elm_genlist_clear()
17897 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17899 * Remove all items from a given genlist widget.
17901 * @param obj The genlist object
17903 * This removes (and deletes) all items in @p obj, leaving it empty.
17905 * @see elm_genlist_item_del(), to remove just one item.
17909 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17911 * Enable or disable multi-selection in the genlist
17913 * @param obj The genlist object
17914 * @param multi Multi-select enable/disable. Default is disabled.
17916 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17917 * the list. This allows more than 1 item to be selected. To retrieve the list
17918 * of selected items, use elm_genlist_selected_items_get().
17920 * @see elm_genlist_selected_items_get()
17921 * @see elm_genlist_multi_select_get()
17925 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17927 * Gets if multi-selection in genlist is enabled or disabled.
17929 * @param obj The genlist object
17930 * @return Multi-select enabled/disabled
17931 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17933 * @see elm_genlist_multi_select_set()
17937 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17939 * This sets the horizontal stretching mode.
17941 * @param obj The genlist object
17942 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17944 * This sets the mode used for sizing items horizontally. Valid modes
17945 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17946 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17947 * the scroller will scroll horizontally. Otherwise items are expanded
17948 * to fill the width of the viewport of the scroller. If it is
17949 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17950 * limited to that size.
17952 * @see elm_genlist_horizontal_get()
17956 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17957 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17959 * Gets the horizontal stretching mode.
17961 * @param obj The genlist object
17962 * @return The mode to use
17963 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17965 * @see elm_genlist_horizontal_set()
17969 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17970 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17972 * Set the always select mode.
17974 * @param obj The genlist object
17975 * @param always_select The always select mode (@c EINA_TRUE = on, @c
17976 * EINA_FALSE = off). Default is @c EINA_FALSE.
17978 * Items will only call their selection func and callback when first
17979 * becoming selected. Any further clicks will do nothing, unless you
17980 * enable always select with elm_genlist_always_select_mode_set().
17981 * This means that, even if selected, every click will make the selected
17982 * callbacks be called.
17984 * @see elm_genlist_always_select_mode_get()
17988 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17990 * Get the always select mode.
17992 * @param obj The genlist object
17993 * @return The always select mode
17994 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17996 * @see elm_genlist_always_select_mode_set()
18000 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18002 * Enable/disable the no select mode.
18004 * @param obj The genlist object
18005 * @param no_select The no select mode
18006 * (EINA_TRUE = on, EINA_FALSE = off)
18008 * This will turn off the ability to select items entirely and they
18009 * will neither appear selected nor call selected callback functions.
18011 * @see elm_genlist_no_select_mode_get()
18015 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18017 * Gets whether the no select mode is enabled.
18019 * @param obj The genlist object
18020 * @return The no select mode
18021 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18023 * @see elm_genlist_no_select_mode_set()
18027 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18029 * Enable/disable compress mode.
18031 * @param obj The genlist object
18032 * @param compress The compress mode
18033 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18035 * This will enable the compress mode where items are "compressed"
18036 * horizontally to fit the genlist scrollable viewport width. This is
18037 * special for genlist. Do not rely on
18038 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18039 * work as genlist needs to handle it specially.
18041 * @see elm_genlist_compress_mode_get()
18045 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18047 * Get whether the compress mode is enabled.
18049 * @param obj The genlist object
18050 * @return The compress mode
18051 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18053 * @see elm_genlist_compress_mode_set()
18057 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18059 * Enable/disable height-for-width mode.
18061 * @param obj The genlist object
18062 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18063 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18065 * With height-for-width mode the item width will be fixed (restricted
18066 * to a minimum of) to the list width when calculating its size in
18067 * order to allow the height to be calculated based on it. This allows,
18068 * for instance, text block to wrap lines if the Edje part is
18069 * configured with "text.min: 0 1".
18071 * @note This mode will make list resize slower as it will have to
18072 * recalculate every item height again whenever the list width
18075 * @note When height-for-width mode is enabled, it also enables
18076 * compress mode (see elm_genlist_compress_mode_set()) and
18077 * disables homogeneous (see elm_genlist_homogeneous_set()).
18081 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18083 * Get whether the height-for-width mode is enabled.
18085 * @param obj The genlist object
18086 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18091 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18093 * Enable/disable horizontal and vertical bouncing effect.
18095 * @param obj The genlist object
18096 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18097 * EINA_FALSE = off). Default is @c EINA_FALSE.
18098 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18099 * EINA_FALSE = off). Default is @c EINA_TRUE.
18101 * This will enable or disable the scroller bouncing effect for the
18102 * genlist. See elm_scroller_bounce_set() for details.
18104 * @see elm_scroller_bounce_set()
18105 * @see elm_genlist_bounce_get()
18109 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18111 * Get whether the horizontal and vertical bouncing effect is enabled.
18113 * @param obj The genlist object
18114 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18116 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18119 * @see elm_genlist_bounce_set()
18123 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18125 * Enable/disable homogenous mode.
18127 * @param obj The genlist object
18128 * @param homogeneous Assume the items within the genlist are of the
18129 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18132 * This will enable the homogeneous mode where items are of the same
18133 * height and width so that genlist may do the lazy-loading at its
18134 * maximum (which increases the performance for scrolling the list). This
18135 * implies 'compressed' mode.
18137 * @see elm_genlist_compress_mode_set()
18138 * @see elm_genlist_homogeneous_get()
18142 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18144 * Get whether the homogenous mode is enabled.
18146 * @param obj The genlist object
18147 * @return Assume the items within the genlist are of the same height
18148 * and width (EINA_TRUE = on, EINA_FALSE = off)
18150 * @see elm_genlist_homogeneous_set()
18154 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18156 * Set the maximum number of items within an item block
18158 * @param obj The genlist object
18159 * @param n Maximum number of items within an item block. Default is 32.
18161 * This will configure the block count to tune to the target with
18162 * particular performance matrix.
18164 * A block of objects will be used to reduce the number of operations due to
18165 * many objects in the screen. It can determine the visibility, or if the
18166 * object has changed, it theme needs to be updated, etc. doing this kind of
18167 * calculation to the entire block, instead of per object.
18169 * The default value for the block count is enough for most lists, so unless
18170 * you know you will have a lot of objects visible in the screen at the same
18171 * time, don't try to change this.
18173 * @see elm_genlist_block_count_get()
18174 * @see @ref Genlist_Implementation
18178 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18180 * Get the maximum number of items within an item block
18182 * @param obj The genlist object
18183 * @return Maximum number of items within an item block
18185 * @see elm_genlist_block_count_set()
18189 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18191 * Set the timeout in seconds for the longpress event.
18193 * @param obj The genlist object
18194 * @param timeout timeout in seconds. Default is 1.
18196 * This option will change how long it takes to send an event "longpressed"
18197 * after the mouse down signal is sent to the list. If this event occurs, no
18198 * "clicked" event will be sent.
18200 * @see elm_genlist_longpress_timeout_set()
18204 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18206 * Get the timeout in seconds for the longpress event.
18208 * @param obj The genlist object
18209 * @return timeout in seconds
18211 * @see elm_genlist_longpress_timeout_get()
18215 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18217 * Append a new item in a given genlist widget.
18219 * @param obj The genlist object
18220 * @param itc The item class for the item
18221 * @param data The item data
18222 * @param parent The parent item, or NULL if none
18223 * @param flags Item flags
18224 * @param func Convenience function called when the item is selected
18225 * @param func_data Data passed to @p func above.
18226 * @return A handle to the item added or @c NULL if not possible
18228 * This adds the given item to the end of the list or the end of
18229 * the children list if the @p parent is given.
18231 * @see elm_genlist_item_prepend()
18232 * @see elm_genlist_item_insert_before()
18233 * @see elm_genlist_item_insert_after()
18234 * @see elm_genlist_item_del()
18238 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);
18240 * Prepend a new item in a given genlist widget.
18242 * @param obj The genlist object
18243 * @param itc The item class for the item
18244 * @param data The item data
18245 * @param parent The parent item, or NULL if none
18246 * @param flags Item flags
18247 * @param func Convenience function called when the item is selected
18248 * @param func_data Data passed to @p func above.
18249 * @return A handle to the item added or NULL if not possible
18251 * This adds an item to the beginning of the list or beginning of the
18252 * children of the parent if given.
18254 * @see elm_genlist_item_append()
18255 * @see elm_genlist_item_insert_before()
18256 * @see elm_genlist_item_insert_after()
18257 * @see elm_genlist_item_del()
18261 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);
18263 * Insert an item before another in a genlist widget
18265 * @param obj The genlist object
18266 * @param itc The item class for the item
18267 * @param data The item data
18268 * @param before The item to place this new one before.
18269 * @param flags Item flags
18270 * @param func Convenience function called when the item is selected
18271 * @param func_data Data passed to @p func above.
18272 * @return A handle to the item added or @c NULL if not possible
18274 * This inserts an item before another in the list. It will be in the
18275 * same tree level or group as the item it is inserted before.
18277 * @see elm_genlist_item_append()
18278 * @see elm_genlist_item_prepend()
18279 * @see elm_genlist_item_insert_after()
18280 * @see elm_genlist_item_del()
18284 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);
18286 * Insert an item after another in a genlist widget
18288 * @param obj The genlist object
18289 * @param itc The item class for the item
18290 * @param data The item data
18291 * @param after The item to place this new one after.
18292 * @param flags Item flags
18293 * @param func Convenience function called when the item is selected
18294 * @param func_data Data passed to @p func above.
18295 * @return A handle to the item added or @c NULL if not possible
18297 * This inserts an item after another in the list. It will be in the
18298 * same tree level or group as the item it is inserted after.
18300 * @see elm_genlist_item_append()
18301 * @see elm_genlist_item_prepend()
18302 * @see elm_genlist_item_insert_before()
18303 * @see elm_genlist_item_del()
18307 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);
18309 * Insert a new item into the sorted genlist object
18311 * @param obj The genlist object
18312 * @param itc The item class for the item
18313 * @param data The item data
18314 * @param parent The parent item, or NULL if none
18315 * @param flags Item flags
18316 * @param comp The function called for the sort
18317 * @param func Convenience function called when item selected
18318 * @param func_data Data passed to @p func above.
18319 * @return A handle to the item added or NULL if not possible
18323 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);
18324 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);
18325 /* operations to retrieve existing items */
18327 * Get the selectd item in the genlist.
18329 * @param obj The genlist object
18330 * @return The selected item, or NULL if none is selected.
18332 * This gets the selected item in the list (if multi-selection is enabled, only
18333 * the item that was first selected in the list is returned - which is not very
18334 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18337 * If no item is selected, NULL is returned.
18339 * @see elm_genlist_selected_items_get()
18343 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18345 * Get a list of selected items in the genlist.
18347 * @param obj The genlist object
18348 * @return The list of selected items, or NULL if none are selected.
18350 * It returns a list of the selected items. This list pointer is only valid so
18351 * long as the selection doesn't change (no items are selected or unselected, or
18352 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18353 * pointers. The order of the items in this list is the order which they were
18354 * selected, i.e. the first item in this list is the first item that was
18355 * selected, and so on.
18357 * @note If not in multi-select mode, consider using function
18358 * elm_genlist_selected_item_get() instead.
18360 * @see elm_genlist_multi_select_set()
18361 * @see elm_genlist_selected_item_get()
18365 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18367 * Get a list of realized items in genlist
18369 * @param obj The genlist object
18370 * @return The list of realized items, nor NULL if none are realized.
18372 * This returns a list of the realized items in the genlist. The list
18373 * contains Elm_Genlist_Item pointers. The list must be freed by the
18374 * caller when done with eina_list_free(). The item pointers in the
18375 * list are only valid so long as those items are not deleted or the
18376 * genlist is not deleted.
18378 * @see elm_genlist_realized_items_update()
18382 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18384 * Get the item that is at the x, y canvas coords.
18386 * @param obj The gelinst object.
18387 * @param x The input x coordinate
18388 * @param y The input y coordinate
18389 * @param posret The position relative to the item returned here
18390 * @return The item at the coordinates or NULL if none
18392 * This returns the item at the given coordinates (which are canvas
18393 * relative, not object-relative). If an item is at that coordinate,
18394 * that item handle is returned, and if @p posret is not NULL, the
18395 * integer pointed to is set to a value of -1, 0 or 1, depending if
18396 * the coordinate is on the upper portion of that item (-1), on the
18397 * middle section (0) or on the lower part (1). If NULL is returned as
18398 * an item (no item found there), then posret may indicate -1 or 1
18399 * based if the coordinate is above or below all items respectively in
18404 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);
18406 * Get the first item in the genlist
18408 * This returns the first item in the list.
18410 * @param obj The genlist object
18411 * @return The first item, or NULL if none
18415 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18417 * Get the last item in the genlist
18419 * This returns the last item in the list.
18421 * @return The last item, or NULL if none
18425 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18427 * Set the scrollbar policy
18429 * @param obj The genlist object
18430 * @param policy_h Horizontal scrollbar policy.
18431 * @param policy_v Vertical scrollbar policy.
18433 * This sets the scrollbar visibility policy for the given genlist
18434 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18435 * made visible if it is needed, and otherwise kept hidden.
18436 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18437 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18438 * respectively for the horizontal and vertical scrollbars. Default is
18439 * #ELM_SMART_SCROLLER_POLICY_AUTO
18441 * @see elm_genlist_scroller_policy_get()
18445 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18447 * Get the scrollbar policy
18449 * @param obj The genlist object
18450 * @param policy_h Pointer to store the horizontal scrollbar policy.
18451 * @param policy_v Pointer to store the vertical scrollbar policy.
18453 * @see elm_genlist_scroller_policy_set()
18457 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);
18459 * Get the @b next item in a genlist widget's internal list of items,
18460 * given a handle to one of those items.
18462 * @param item The genlist item to fetch next from
18463 * @return The item after @p item, or @c NULL if there's none (and
18466 * This returns the item placed after the @p item, on the container
18469 * @see elm_genlist_item_prev_get()
18473 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18475 * Get the @b previous item in a genlist widget's internal list of items,
18476 * given a handle to one of those items.
18478 * @param item The genlist item to fetch previous from
18479 * @return The item before @p item, or @c NULL if there's none (and
18482 * This returns the item placed before the @p item, on the container
18485 * @see elm_genlist_item_next_get()
18489 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18491 * Get the genlist object's handle which contains a given genlist
18494 * @param item The item to fetch the container from
18495 * @return The genlist (parent) object
18497 * This returns the genlist object itself that an item belongs to.
18501 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18503 * Get the parent item of the given item
18505 * @param it The item
18506 * @return The parent of the item or @c NULL if it has no parent.
18508 * This returns the item that was specified as parent of the item @p it on
18509 * elm_genlist_item_append() and insertion related functions.
18513 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18515 * Remove all sub-items (children) of the given item
18517 * @param it The item
18519 * This removes all items that are children (and their descendants) of the
18520 * given item @p it.
18522 * @see elm_genlist_clear()
18523 * @see elm_genlist_item_del()
18527 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18529 * Set whether a given genlist item is selected or not
18531 * @param it The item
18532 * @param selected Use @c EINA_TRUE, to make it selected, @c
18533 * EINA_FALSE to make it unselected
18535 * This sets the selected state of an item. If multi selection is
18536 * not enabled on the containing genlist and @p selected is @c
18537 * EINA_TRUE, any other previously selected items will get
18538 * unselected in favor of this new one.
18540 * @see elm_genlist_item_selected_get()
18544 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18546 * Get whether a given genlist item is selected or not
18548 * @param it The item
18549 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18551 * @see elm_genlist_item_selected_set() for more details
18555 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18557 * Sets the expanded state of an item.
18559 * @param it The item
18560 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18562 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18565 * The theme will respond to this change visually, and a signal "expanded" or
18566 * "contracted" will be sent from the genlist with a pointer to the item that
18567 * has been expanded/contracted.
18569 * Calling this function won't show or hide any child of this item (if it is
18570 * a parent). You must manually delete and create them on the callbacks fo
18571 * the "expanded" or "contracted" signals.
18573 * @see elm_genlist_item_expanded_get()
18577 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18579 * Get the expanded state of an item
18581 * @param it The item
18582 * @return The expanded state
18584 * This gets the expanded state of an item.
18586 * @see elm_genlist_item_expanded_set()
18590 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18592 * Get the depth of expanded item
18594 * @param it The genlist item object
18595 * @return The depth of expanded item
18599 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18601 * Set whether a given genlist item is disabled or not.
18603 * @param it The item
18604 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18605 * to enable it back.
18607 * A disabled item cannot be selected or unselected. It will also
18608 * change its appearance, to signal the user it's disabled.
18610 * @see elm_genlist_item_disabled_get()
18614 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18616 * Get whether a given genlist item is disabled or not.
18618 * @param it The item
18619 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18622 * @see elm_genlist_item_disabled_set() for more details
18626 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18628 * Sets the display only state of an item.
18630 * @param it The item
18631 * @param display_only @c EINA_TRUE if the item is display only, @c
18632 * EINA_FALSE otherwise.
18634 * A display only item cannot be selected or unselected. It is for
18635 * display only and not selecting or otherwise clicking, dragging
18636 * etc. by the user, thus finger size rules will not be applied to
18639 * It's good to set group index items to display only state.
18641 * @see elm_genlist_item_display_only_get()
18645 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18647 * Get the display only state of an item
18649 * @param it The item
18650 * @return @c EINA_TRUE if the item is display only, @c
18651 * EINA_FALSE otherwise.
18653 * @see elm_genlist_item_display_only_set()
18657 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18659 * Show the portion of a genlist's internal list containing a given
18660 * item, immediately.
18662 * @param it The item to display
18664 * This causes genlist to jump to the given item @p it and show it (by
18665 * immediately scrolling to that position), if it is not fully visible.
18667 * @see elm_genlist_item_bring_in()
18668 * @see elm_genlist_item_top_show()
18669 * @see elm_genlist_item_middle_show()
18673 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18675 * Animatedly bring in, to the visible are of a genlist, a given
18678 * @param it The item to display
18680 * This causes genlist to jump to the given item @p it and show it (by
18681 * animatedly scrolling), if it is not fully visible. This may use animation
18682 * to do so and take a period of time
18684 * @see elm_genlist_item_show()
18685 * @see elm_genlist_item_top_bring_in()
18686 * @see elm_genlist_item_middle_bring_in()
18690 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18692 * Show the portion of a genlist's internal list containing a given
18693 * item, immediately.
18695 * @param it The item to display
18697 * This causes genlist to jump to the given item @p it and show it (by
18698 * immediately scrolling to that position), if it is not fully visible.
18700 * The item will be positioned at the top of the genlist viewport.
18702 * @see elm_genlist_item_show()
18703 * @see elm_genlist_item_top_bring_in()
18707 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18709 * Animatedly bring in, to the visible are of a genlist, a given
18712 * @param it The item
18714 * This causes genlist to jump to the given item @p it and show it (by
18715 * animatedly scrolling), if it is not fully visible. This may use animation
18716 * to do so and take a period of time
18718 * The item will be positioned at the top of the genlist viewport.
18720 * @see elm_genlist_item_bring_in()
18721 * @see elm_genlist_item_top_show()
18725 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18727 * Show the portion of a genlist's internal list containing a given
18728 * item, immediately.
18730 * @param it The item to display
18732 * This causes genlist to jump to the given item @p it and show it (by
18733 * immediately scrolling to that position), if it is not fully visible.
18735 * The item will be positioned at the middle of the genlist viewport.
18737 * @see elm_genlist_item_show()
18738 * @see elm_genlist_item_middle_bring_in()
18742 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18744 * Animatedly bring in, to the visible are of a genlist, a given
18747 * @param it The item
18749 * This causes genlist to jump to the given item @p it and show it (by
18750 * animatedly scrolling), if it is not fully visible. This may use animation
18751 * to do so and take a period of time
18753 * The item will be positioned at the middle of the genlist viewport.
18755 * @see elm_genlist_item_bring_in()
18756 * @see elm_genlist_item_middle_show()
18760 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18762 * Remove a genlist item from the its parent, deleting it.
18764 * @param item The item to be removed.
18765 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18767 * @see elm_genlist_clear(), to remove all items in a genlist at
18772 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18774 * Return the data associated to a given genlist item
18776 * @param item The genlist item.
18777 * @return the data associated to this item.
18779 * This returns the @c data value passed on the
18780 * elm_genlist_item_append() and related item addition calls.
18782 * @see elm_genlist_item_append()
18783 * @see elm_genlist_item_data_set()
18787 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18789 * Set the data associated to a given genlist item
18791 * @param item The genlist item
18792 * @param data The new data pointer to set on it
18794 * This @b overrides the @c data value passed on the
18795 * elm_genlist_item_append() and related item addition calls. This
18796 * function @b won't call elm_genlist_item_update() automatically,
18797 * so you'd issue it afterwards if you want to hove the item
18798 * updated to reflect the that new data.
18800 * @see elm_genlist_item_data_get()
18804 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18806 * Tells genlist to "orphan" icons fetchs by the item class
18808 * @param it The item
18810 * This instructs genlist to release references to icons in the item,
18811 * meaning that they will no longer be managed by genlist and are
18812 * floating "orphans" that can be re-used elsewhere if the user wants
18817 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18819 * Get the real Evas object created to implement the view of a
18820 * given genlist item
18822 * @param item The genlist item.
18823 * @return the Evas object implementing this item's view.
18825 * This returns the actual Evas object used to implement the
18826 * specified genlist item's view. This may be @c NULL, as it may
18827 * not have been created or may have been deleted, at any time, by
18828 * the genlist. <b>Do not modify this object</b> (move, resize,
18829 * show, hide, etc.), as the genlist is controlling it. This
18830 * function is for querying, emitting custom signals or hooking
18831 * lower level callbacks for events on that object. Do not delete
18832 * this object under any circumstances.
18834 * @see elm_genlist_item_data_get()
18838 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18840 * Update the contents of an item
18842 * @param it The item
18844 * This updates an item by calling all the item class functions again
18845 * to get the icons, labels and states. Use this when the original
18846 * item data has changed and the changes are desired to be reflected.
18848 * Use elm_genlist_realized_items_update() to update all already realized
18851 * @see elm_genlist_realized_items_update()
18855 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18857 * Update the item class of an item
18859 * @param it The item
18860 * @param itc The item class for the item
18862 * This sets another class fo the item, changing the way that it is
18863 * displayed. After changing the item class, elm_genlist_item_update() is
18864 * called on the item @p it.
18868 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18869 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18871 * Set the text to be shown in a given genlist item's tooltips.
18873 * @param item The genlist item
18874 * @param text The text to set in the content
18876 * This call will setup the text to be used as tooltip to that item
18877 * (analogous to elm_object_tooltip_text_set(), but being item
18878 * tooltips with higher precedence than object tooltips). It can
18879 * have only one tooltip at a time, so any previous tooltip data
18880 * will get removed.
18882 * In order to set an icon or something else as a tooltip, look at
18883 * elm_genlist_item_tooltip_content_cb_set().
18887 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18889 * Set the content to be shown in a given genlist item's tooltips
18891 * @param item The genlist item.
18892 * @param func The function returning the tooltip contents.
18893 * @param data What to provide to @a func as callback data/context.
18894 * @param del_cb Called when data is not needed anymore, either when
18895 * another callback replaces @p func, the tooltip is unset with
18896 * elm_genlist_item_tooltip_unset() or the owner @p item
18897 * dies. This callback receives as its first parameter the
18898 * given @p data, being @c event_info the item handle.
18900 * This call will setup the tooltip's contents to @p item
18901 * (analogous to elm_object_tooltip_content_cb_set(), but being
18902 * item tooltips with higher precedence than object tooltips). It
18903 * can have only one tooltip at a time, so any previous tooltip
18904 * content will get removed. @p func (with @p data) will be called
18905 * every time Elementary needs to show the tooltip and it should
18906 * return a valid Evas object, which will be fully managed by the
18907 * tooltip system, getting deleted when the tooltip is gone.
18909 * In order to set just a text as a tooltip, look at
18910 * elm_genlist_item_tooltip_text_set().
18914 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);
18916 * Unset a tooltip from a given genlist item
18918 * @param item genlist item to remove a previously set tooltip from.
18920 * This call removes any tooltip set on @p item. The callback
18921 * provided as @c del_cb to
18922 * elm_genlist_item_tooltip_content_cb_set() will be called to
18923 * notify it is not used anymore (and have resources cleaned, if
18926 * @see elm_genlist_item_tooltip_content_cb_set()
18930 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18932 * Set a different @b style for a given genlist item's tooltip.
18934 * @param item genlist item with tooltip set
18935 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18936 * "default", @c "transparent", etc)
18938 * Tooltips can have <b>alternate styles</b> to be displayed on,
18939 * which are defined by the theme set on Elementary. This function
18940 * works analogously as elm_object_tooltip_style_set(), but here
18941 * applied only to genlist item objects. The default style for
18942 * tooltips is @c "default".
18944 * @note before you set a style you should define a tooltip with
18945 * elm_genlist_item_tooltip_content_cb_set() or
18946 * elm_genlist_item_tooltip_text_set()
18948 * @see elm_genlist_item_tooltip_style_get()
18952 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18954 * Get the style set a given genlist item's tooltip.
18956 * @param item genlist item with tooltip already set on.
18957 * @return style the theme style in use, which defaults to
18958 * "default". If the object does not have a tooltip set,
18959 * then @c NULL is returned.
18961 * @see elm_genlist_item_tooltip_style_set() for more details
18965 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18967 * @brief Disable size restrictions on an object's tooltip
18968 * @param item The tooltip's anchor object
18969 * @param disable If EINA_TRUE, size restrictions are disabled
18970 * @return EINA_FALSE on failure, EINA_TRUE on success
18972 * This function allows a tooltip to expand beyond its parant window's canvas.
18973 * It will instead be limited only by the size of the display.
18975 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18977 * @brief Retrieve size restriction state of an object's tooltip
18978 * @param item The tooltip's anchor object
18979 * @return If EINA_TRUE, size restrictions are disabled
18981 * This function returns whether a tooltip is allowed to expand beyond
18982 * its parant window's canvas.
18983 * It will instead be limited only by the size of the display.
18985 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18987 * Set the type of mouse pointer/cursor decoration to be shown,
18988 * when the mouse pointer is over the given genlist widget item
18990 * @param item genlist item to customize cursor on
18991 * @param cursor the cursor type's name
18993 * This function works analogously as elm_object_cursor_set(), but
18994 * here the cursor's changing area is restricted to the item's
18995 * area, and not the whole widget's. Note that that item cursors
18996 * have precedence over widget cursors, so that a mouse over @p
18997 * item will always show cursor @p type.
18999 * If this function is called twice for an object, a previously set
19000 * cursor will be unset on the second call.
19002 * @see elm_object_cursor_set()
19003 * @see elm_genlist_item_cursor_get()
19004 * @see elm_genlist_item_cursor_unset()
19008 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19010 * Get the type of mouse pointer/cursor decoration set to be shown,
19011 * when the mouse pointer is over the given genlist widget item
19013 * @param item genlist item with custom cursor set
19014 * @return the cursor type's name or @c NULL, if no custom cursors
19015 * were set to @p item (and on errors)
19017 * @see elm_object_cursor_get()
19018 * @see elm_genlist_item_cursor_set() for more details
19019 * @see elm_genlist_item_cursor_unset()
19023 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19025 * Unset any custom mouse pointer/cursor decoration set to be
19026 * shown, when the mouse pointer is over the given genlist widget
19027 * item, thus making it show the @b default cursor again.
19029 * @param item a genlist item
19031 * Use this call to undo any custom settings on this item's cursor
19032 * decoration, bringing it back to defaults (no custom style set).
19034 * @see elm_object_cursor_unset()
19035 * @see elm_genlist_item_cursor_set() for more details
19039 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19041 * Set a different @b style for a given custom cursor set for a
19044 * @param item genlist item with custom cursor set
19045 * @param style the <b>theme style</b> to use (e.g. @c "default",
19046 * @c "transparent", etc)
19048 * This function only makes sense when one is using custom mouse
19049 * cursor decorations <b>defined in a theme file</b> , which can
19050 * have, given a cursor name/type, <b>alternate styles</b> on
19051 * it. It works analogously as elm_object_cursor_style_set(), but
19052 * here applied only to genlist item objects.
19054 * @warning Before you set a cursor style you should have defined a
19055 * custom cursor previously on the item, with
19056 * elm_genlist_item_cursor_set()
19058 * @see elm_genlist_item_cursor_engine_only_set()
19059 * @see elm_genlist_item_cursor_style_get()
19063 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19065 * Get the current @b style set for a given genlist item's custom
19068 * @param item genlist item with custom cursor set.
19069 * @return style the cursor style in use. If the object does not
19070 * have a cursor set, then @c NULL is returned.
19072 * @see elm_genlist_item_cursor_style_set() for more details
19076 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19078 * Set if the (custom) cursor for a given genlist item should be
19079 * searched in its theme, also, or should only rely on the
19080 * rendering engine.
19082 * @param item item with custom (custom) cursor already set on
19083 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19084 * only on those provided by the rendering engine, @c EINA_FALSE to
19085 * have them searched on the widget's theme, as well.
19087 * @note This call is of use only if you've set a custom cursor
19088 * for genlist items, with elm_genlist_item_cursor_set().
19090 * @note By default, cursors will only be looked for between those
19091 * provided by the rendering engine.
19095 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19097 * Get if the (custom) cursor for a given genlist item is being
19098 * searched in its theme, also, or is only relying on the rendering
19101 * @param item a genlist item
19102 * @return @c EINA_TRUE, if cursors are being looked for only on
19103 * those provided by the rendering engine, @c EINA_FALSE if they
19104 * are being searched on the widget's theme, as well.
19106 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19110 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19112 * Update the contents of all realized items.
19114 * @param obj The genlist object.
19116 * This updates all realized items by calling all the item class functions again
19117 * to get the icons, labels and states. Use this when the original
19118 * item data has changed and the changes are desired to be reflected.
19120 * To update just one item, use elm_genlist_item_update().
19122 * @see elm_genlist_realized_items_get()
19123 * @see elm_genlist_item_update()
19127 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19129 * Activate a genlist mode on an item
19131 * @param item The genlist item
19132 * @param mode Mode name
19133 * @param mode_set Boolean to define set or unset mode.
19135 * A genlist mode is a different way of selecting an item. Once a mode is
19136 * activated on an item, any other selected item is immediately unselected.
19137 * This feature provides an easy way of implementing a new kind of animation
19138 * for selecting an item, without having to entirely rewrite the item style
19139 * theme. However, the elm_genlist_selected_* API can't be used to get what
19140 * item is activate for a mode.
19142 * The current item style will still be used, but applying a genlist mode to
19143 * an item will select it using a different kind of animation.
19145 * The current active item for a mode can be found by
19146 * elm_genlist_mode_item_get().
19148 * The characteristics of genlist mode are:
19149 * - Only one mode can be active at any time, and for only one item.
19150 * - Genlist handles deactivating other items when one item is activated.
19151 * - A mode is defined in the genlist theme (edc), and more modes can easily
19153 * - A mode style and the genlist item style are different things. They
19154 * can be combined to provide a default style to the item, with some kind
19155 * of animation for that item when the mode is activated.
19157 * When a mode is activated on an item, a new view for that item is created.
19158 * The theme of this mode defines the animation that will be used to transit
19159 * the item from the old view to the new view. This second (new) view will be
19160 * active for that item while the mode is active on the item, and will be
19161 * destroyed after the mode is totally deactivated from that item.
19163 * @see elm_genlist_mode_get()
19164 * @see elm_genlist_mode_item_get()
19168 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19170 * Get the last (or current) genlist mode used.
19172 * @param obj The genlist object
19174 * This function just returns the name of the last used genlist mode. It will
19175 * be the current mode if it's still active.
19177 * @see elm_genlist_item_mode_set()
19178 * @see elm_genlist_mode_item_get()
19182 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19184 * Get active genlist mode item
19186 * @param obj The genlist object
19187 * @return The active item for that current mode. Or @c NULL if no item is
19188 * activated with any mode.
19190 * This function returns the item that was activated with a mode, by the
19191 * function elm_genlist_item_mode_set().
19193 * @see elm_genlist_item_mode_set()
19194 * @see elm_genlist_mode_get()
19198 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19203 * @param obj The genlist object
19204 * @param reorder_mode The reorder mode
19205 * (EINA_TRUE = on, EINA_FALSE = off)
19209 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19212 * Get the reorder mode
19214 * @param obj The genlist object
19215 * @return The reorder mode
19216 * (EINA_TRUE = on, EINA_FALSE = off)
19220 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19227 * @defgroup Check Check
19229 * @image html img/widget/check/preview-00.png
19230 * @image latex img/widget/check/preview-00.eps
19231 * @image html img/widget/check/preview-01.png
19232 * @image latex img/widget/check/preview-01.eps
19233 * @image html img/widget/check/preview-02.png
19234 * @image latex img/widget/check/preview-02.eps
19236 * @brief The check widget allows for toggling a value between true and
19239 * Check objects are a lot like radio objects in layout and functionality
19240 * except they do not work as a group, but independently and only toggle the
19241 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19242 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19243 * returns the current state. For convenience, like the radio objects, you
19244 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19245 * for it to modify.
19247 * Signals that you can add callbacks for are:
19248 * "changed" - This is called whenever the user changes the state of one of
19249 * the check object(event_info is NULL).
19251 * @ref tutorial_check should give you a firm grasp of how to use this widget.
19255 * @brief Add a new Check object
19257 * @param parent The parent object
19258 * @return The new object or NULL if it cannot be created
19260 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19262 * @brief Set the text label of the check object
19264 * @param obj The check object
19265 * @param label The text label string in UTF-8
19267 * @deprecated use elm_object_text_set() instead.
19269 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19271 * @brief Get the text label of the check object
19273 * @param obj The check object
19274 * @return The text label string in UTF-8
19276 * @deprecated use elm_object_text_get() instead.
19278 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19280 * @brief Set the icon object of the check object
19282 * @param obj The check object
19283 * @param icon The icon object
19285 * Once the icon object is set, a previously set one will be deleted.
19286 * If you want to keep that old content object, use the
19287 * elm_check_icon_unset() function.
19289 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19291 * @brief Get the icon object of the check object
19293 * @param obj The check object
19294 * @return The icon object
19296 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19298 * @brief Unset the icon used for the check object
19300 * @param obj The check object
19301 * @return The icon object that was being used
19303 * Unparent and return the icon object which was set for this widget.
19305 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19307 * @brief Set the on/off state of the check object
19309 * @param obj The check object
19310 * @param state The state to use (1 == on, 0 == off)
19312 * This sets the state of the check. If set
19313 * with elm_check_state_pointer_set() the state of that variable is also
19314 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19316 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19318 * @brief Get the state of the check object
19320 * @param obj The check object
19321 * @return The boolean state
19323 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19325 * @brief Set a convenience pointer to a boolean to change
19327 * @param obj The check object
19328 * @param statep Pointer to the boolean to modify
19330 * This sets a pointer to a boolean, that, in addition to the check objects
19331 * state will also be modified directly. To stop setting the object pointed
19332 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19333 * then when this is called, the check objects state will also be modified to
19334 * reflect the value of the boolean @p statep points to, just like calling
19335 * elm_check_state_set().
19337 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19343 * @defgroup Radio Radio
19345 * @image html img/widget/radio/preview-00.png
19346 * @image latex img/widget/radio/preview-00.eps
19348 * @brief Radio is a widget that allows for 1 or more options to be displayed
19349 * and have the user choose only 1 of them.
19351 * A radio object contains an indicator, an optional Label and an optional
19352 * icon object. While it's possible to have a group of only one radio they,
19353 * are normally used in groups of 2 or more. To add a radio to a group use
19354 * elm_radio_group_add(). The radio object(s) will select from one of a set
19355 * of integer values, so any value they are configuring needs to be mapped to
19356 * a set of integers. To configure what value that radio object represents,
19357 * use elm_radio_state_value_set() to set the integer it represents. To set
19358 * the value the whole group(which one is currently selected) is to indicate
19359 * use elm_radio_value_set() on any group member, and to get the groups value
19360 * use elm_radio_value_get(). For convenience the radio objects are also able
19361 * to directly set an integer(int) to the value that is selected. To specify
19362 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19363 * The radio objects will modify this directly. That implies the pointer must
19364 * point to valid memory for as long as the radio objects exist.
19366 * Signals that you can add callbacks for are:
19367 * @li changed - This is called whenever the user changes the state of one of
19368 * the radio objects within the group of radio objects that work together.
19370 * @ref tutorial_radio show most of this API in action.
19374 * @brief Add a new radio to the parent
19376 * @param parent The parent object
19377 * @return The new object or NULL if it cannot be created
19379 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19381 * @brief Set the text label of the radio object
19383 * @param obj The radio object
19384 * @param label The text label string in UTF-8
19386 * @deprecated use elm_object_text_set() instead.
19388 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19390 * @brief Get the text label of the radio object
19392 * @param obj The radio object
19393 * @return The text label string in UTF-8
19395 * @deprecated use elm_object_text_set() instead.
19397 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19399 * @brief Set the icon object of the radio object
19401 * @param obj The radio object
19402 * @param icon The icon object
19404 * Once the icon object is set, a previously set one will be deleted. If you
19405 * want to keep that old content object, use the elm_radio_icon_unset()
19408 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19410 * @brief Get the icon object of the radio object
19412 * @param obj The radio object
19413 * @return The icon object
19415 * @see elm_radio_icon_set()
19417 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19419 * @brief Unset the icon used for the radio object
19421 * @param obj The radio object
19422 * @return The icon object that was being used
19424 * Unparent and return the icon object which was set for this widget.
19426 * @see elm_radio_icon_set()
19428 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19430 * @brief Add this radio to a group of other radio objects
19432 * @param obj The radio object
19433 * @param group Any object whose group the @p obj is to join.
19435 * Radio objects work in groups. Each member should have a different integer
19436 * value assigned. In order to have them work as a group, they need to know
19437 * about each other. This adds the given radio object to the group of which
19438 * the group object indicated is a member.
19440 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19442 * @brief Set the integer value that this radio object represents
19444 * @param obj The radio object
19445 * @param value The value to use if this radio object is selected
19447 * This sets the value of the radio.
19449 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19451 * @brief Get the integer value that this radio object represents
19453 * @param obj The radio object
19454 * @return The value used if this radio object is selected
19456 * This gets the value of the radio.
19458 * @see elm_radio_value_set()
19460 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19462 * @brief Set the value of the radio.
19464 * @param obj The radio object
19465 * @param value The value to use for the group
19467 * This sets the value of the radio group and will also set the value if
19468 * pointed to, to the value supplied, but will not call any callbacks.
19470 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19472 * @brief Get the state of the radio object
19474 * @param obj The radio object
19475 * @return The integer state
19477 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19479 * @brief Set a convenience pointer to a integer to change
19481 * @param obj The radio object
19482 * @param valuep Pointer to the integer to modify
19484 * This sets a pointer to a integer, that, in addition to the radio objects
19485 * state will also be modified directly. To stop setting the object pointed
19486 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19487 * when this is called, the radio objects state will also be modified to
19488 * reflect the value of the integer valuep points to, just like calling
19489 * elm_radio_value_set().
19491 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19497 * @defgroup Pager Pager
19499 * @image html img/widget/pager/preview-00.png
19500 * @image latex img/widget/pager/preview-00.eps
19502 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19504 * The flipping between “pages” of objects is animated. All content in pager
19505 * is kept in a stack, the last content to be added will be on the top of the
19506 * stack(be visible).
19508 * Objects can be pushed or popped from the stack or deleted as normal.
19509 * Pushes and pops will animate (and a pop will delete the object once the
19510 * animation is finished). Any object already in the pager can be promoted to
19511 * the top(from its current stacking position) through the use of
19512 * elm_pager_content_promote(). Objects are pushed to the top with
19513 * elm_pager_content_push() and when the top item is no longer wanted, simply
19514 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19515 * object is no longer needed and is not the top item, just delete it as
19516 * normal. You can query which objects are the top and bottom with
19517 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19519 * Signals that you can add callbacks for are:
19520 * "hide,finished" - when the previous page is hided
19522 * This widget has the following styles available:
19525 * @li fade_translucide
19526 * @li fade_invisible
19527 * @note This styles affect only the flipping animations, the appearance when
19528 * not animating is unaffected by styles.
19530 * @ref tutorial_pager gives a good overview of the usage of the API.
19534 * Add a new pager to the parent
19536 * @param parent The parent object
19537 * @return The new object or NULL if it cannot be created
19541 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19543 * @brief Push an object to the top of the pager stack (and show it).
19545 * @param obj The pager object
19546 * @param content The object to push
19548 * The object pushed becomes a child of the pager, it will be controlled and
19549 * deleted when the pager is deleted.
19551 * @note If the content is already in the stack use
19552 * elm_pager_content_promote().
19553 * @warning Using this function on @p content already in the stack results in
19554 * undefined behavior.
19556 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19558 * @brief Pop the object that is on top of the stack
19560 * @param obj The pager object
19562 * This pops the object that is on the top(visible) of the pager, makes it
19563 * disappear, then deletes the object. The object that was underneath it on
19564 * the stack will become visible.
19566 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19568 * @brief Moves an object already in the pager stack to the top of the stack.
19570 * @param obj The pager object
19571 * @param content The object to promote
19573 * This will take the @p content and move it to the top of the stack as
19574 * if it had been pushed there.
19576 * @note If the content isn't already in the stack use
19577 * elm_pager_content_push().
19578 * @warning Using this function on @p content not already in the stack
19579 * results in undefined behavior.
19581 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19583 * @brief Return the object at the bottom of the pager stack
19585 * @param obj The pager object
19586 * @return The bottom object or NULL if none
19588 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19590 * @brief Return the object at the top of the pager stack
19592 * @param obj The pager object
19593 * @return The top object or NULL if none
19595 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19601 * @defgroup Slideshow Slideshow
19603 * @image html img/widget/slideshow/preview-00.png
19604 * @image latex img/widget/slideshow/preview-00.eps
19606 * This widget, as the name indicates, is a pre-made image
19607 * slideshow panel, with API functions acting on (child) image
19608 * items presentation. Between those actions, are:
19609 * - advance to next/previous image
19610 * - select the style of image transition animation
19611 * - set the exhibition time for each image
19612 * - start/stop the slideshow
19614 * The transition animations are defined in the widget's theme,
19615 * consequently new animations can be added without having to
19616 * update the widget's code.
19618 * @section Slideshow_Items Slideshow items
19620 * For slideshow items, just like for @ref Genlist "genlist" ones,
19621 * the user defines a @b classes, specifying functions that will be
19622 * called on the item's creation and deletion times.
19624 * The #Elm_Slideshow_Item_Class structure contains the following
19627 * - @c func.get - When an item is displayed, this function is
19628 * called, and it's where one should create the item object, de
19629 * facto. For example, the object can be a pure Evas image object
19630 * or an Elementary @ref Photocam "photocam" widget. See
19631 * #SlideshowItemGetFunc.
19632 * - @c func.del - When an item is no more displayed, this function
19633 * is called, where the user must delete any data associated to
19634 * the item. See #SlideshowItemDelFunc.
19636 * @section Slideshow_Caching Slideshow caching
19638 * The slideshow provides facilities to have items adjacent to the
19639 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19640 * you, so that the system does not have to decode image data
19641 * anymore at the time it has to actually switch images on its
19642 * viewport. The user is able to set the numbers of items to be
19643 * cached @b before and @b after the current item, in the widget's
19646 * Smart events one can add callbacks for are:
19648 * - @c "changed" - when the slideshow switches its view to a new
19651 * List of examples for the slideshow widget:
19652 * @li @ref slideshow_example
19656 * @addtogroup Slideshow
19660 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19661 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19662 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19663 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19664 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19667 * @struct _Elm_Slideshow_Item_Class
19669 * Slideshow item class definition. See @ref Slideshow_Items for
19672 struct _Elm_Slideshow_Item_Class
19674 struct _Elm_Slideshow_Item_Class_Func
19676 SlideshowItemGetFunc get;
19677 SlideshowItemDelFunc del;
19679 }; /**< #Elm_Slideshow_Item_Class member definitions */
19682 * Add a new slideshow widget to the given parent Elementary
19683 * (container) object
19685 * @param parent The parent object
19686 * @return A new slideshow widget handle or @c NULL, on errors
19688 * This function inserts a new slideshow widget on the canvas.
19690 * @ingroup Slideshow
19692 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19695 * Add (append) a new item in a given slideshow widget.
19697 * @param obj The slideshow object
19698 * @param itc The item class for the item
19699 * @param data The item's data
19700 * @return A handle to the item added or @c NULL, on errors
19702 * Add a new item to @p obj's internal list of items, appending it.
19703 * The item's class must contain the function really fetching the
19704 * image object to show for this item, which could be an Evas image
19705 * object or an Elementary photo, for example. The @p data
19706 * parameter is going to be passed to both class functions of the
19709 * @see #Elm_Slideshow_Item_Class
19710 * @see elm_slideshow_item_sorted_insert()
19712 * @ingroup Slideshow
19714 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19717 * Insert a new item into the given slideshow widget, using the @p func
19718 * function to sort items (by item handles).
19720 * @param obj The slideshow object
19721 * @param itc The item class for the item
19722 * @param data The item's data
19723 * @param func The comparing function to be used to sort slideshow
19724 * items <b>by #Elm_Slideshow_Item item handles</b>
19725 * @return Returns The slideshow item handle, on success, or
19726 * @c NULL, on errors
19728 * Add a new item to @p obj's internal list of items, in a position
19729 * determined by the @p func comparing function. The item's class
19730 * must contain the function really fetching the image object to
19731 * show for this item, which could be an Evas image object or an
19732 * Elementary photo, for example. The @p data parameter is going to
19733 * be passed to both class functions of the item.
19735 * @see #Elm_Slideshow_Item_Class
19736 * @see elm_slideshow_item_add()
19738 * @ingroup Slideshow
19740 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);
19743 * Display a given slideshow widget's item, programmatically.
19745 * @param obj The slideshow object
19746 * @param item The item to display on @p obj's viewport
19748 * The change between the current item and @p item will use the
19749 * transition @p obj is set to use (@see
19750 * elm_slideshow_transition_set()).
19752 * @ingroup Slideshow
19754 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19757 * Slide to the @b next item, in a given slideshow widget
19759 * @param obj The slideshow object
19761 * The sliding animation @p obj is set to use will be the
19762 * transition effect used, after this call is issued.
19764 * @note If the end of the slideshow's internal list of items is
19765 * reached, it'll wrap around to the list's beginning, again.
19767 * @ingroup Slideshow
19769 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19772 * Slide to the @b previous item, in a given slideshow widget
19774 * @param obj The slideshow object
19776 * The sliding animation @p obj is set to use will be the
19777 * transition effect used, after this call is issued.
19779 * @note If the beginning of the slideshow's internal list of items
19780 * is reached, it'll wrap around to the list's end, again.
19782 * @ingroup Slideshow
19784 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19787 * Returns the list of sliding transition/effect names available, for a
19788 * given slideshow widget.
19790 * @param obj The slideshow object
19791 * @return The list of transitions (list of @b stringshared strings
19794 * The transitions, which come from @p obj's theme, must be an EDC
19795 * data item named @c "transitions" on the theme file, with (prefix)
19796 * names of EDC programs actually implementing them.
19798 * The available transitions for slideshows on the default theme are:
19799 * - @c "fade" - the current item fades out, while the new one
19800 * fades in to the slideshow's viewport.
19801 * - @c "black_fade" - the current item fades to black, and just
19802 * then, the new item will fade in.
19803 * - @c "horizontal" - the current item slides horizontally, until
19804 * it gets out of the slideshow's viewport, while the new item
19805 * comes from the left to take its place.
19806 * - @c "vertical" - the current item slides vertically, until it
19807 * gets out of the slideshow's viewport, while the new item comes
19808 * from the bottom to take its place.
19809 * - @c "square" - the new item starts to appear from the middle of
19810 * the current one, but with a tiny size, growing until its
19811 * target (full) size and covering the old one.
19813 * @warning The stringshared strings get no new references
19814 * exclusive to the user grabbing the list, here, so if you'd like
19815 * to use them out of this call's context, you'd better @c
19816 * eina_stringshare_ref() them.
19818 * @see elm_slideshow_transition_set()
19820 * @ingroup Slideshow
19822 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19825 * Set the current slide transition/effect in use for a given
19828 * @param obj The slideshow object
19829 * @param transition The new transition's name string
19831 * If @p transition is implemented in @p obj's theme (i.e., is
19832 * contained in the list returned by
19833 * elm_slideshow_transitions_get()), this new sliding effect will
19834 * be used on the widget.
19836 * @see elm_slideshow_transitions_get() for more details
19838 * @ingroup Slideshow
19840 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19843 * Get the current slide transition/effect in use for a given
19846 * @param obj The slideshow object
19847 * @return The current transition's name
19849 * @see elm_slideshow_transition_set() for more details
19851 * @ingroup Slideshow
19853 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19856 * Set the interval between each image transition on a given
19857 * slideshow widget, <b>and start the slideshow, itself</b>
19859 * @param obj The slideshow object
19860 * @param timeout The new displaying timeout for images
19862 * After this call, the slideshow widget will start cycling its
19863 * view, sequentially and automatically, with the images of the
19864 * items it has. The time between each new image displayed is going
19865 * to be @p timeout, in @b seconds. If a different timeout was set
19866 * previously and an slideshow was in progress, it will continue
19867 * with the new time between transitions, after this call.
19869 * @note A value less than or equal to 0 on @p timeout will disable
19870 * the widget's internal timer, thus halting any slideshow which
19871 * could be happening on @p obj.
19873 * @see elm_slideshow_timeout_get()
19875 * @ingroup Slideshow
19877 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19880 * Get the interval set for image transitions on a given slideshow
19883 * @param obj The slideshow object
19884 * @return Returns the timeout set on it
19886 * @see elm_slideshow_timeout_set() for more details
19888 * @ingroup Slideshow
19890 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19893 * Set if, after a slideshow is started, for a given slideshow
19894 * widget, its items should be displayed cyclically or not.
19896 * @param obj The slideshow object
19897 * @param loop Use @c EINA_TRUE to make it cycle through items or
19898 * @c EINA_FALSE for it to stop at the end of @p obj's internal
19901 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19902 * ignore what is set by this functions, i.e., they'll @b always
19903 * cycle through items. This affects only the "automatic"
19904 * slideshow, as set by elm_slideshow_timeout_set().
19906 * @see elm_slideshow_loop_get()
19908 * @ingroup Slideshow
19910 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19913 * Get if, after a slideshow is started, for a given slideshow
19914 * widget, its items are to be displayed cyclically or not.
19916 * @param obj The slideshow object
19917 * @return @c EINA_TRUE, if the items in @p obj will be cycled
19918 * through or @c EINA_FALSE, otherwise
19920 * @see elm_slideshow_loop_set() for more details
19922 * @ingroup Slideshow
19924 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19927 * Remove all items from a given slideshow widget
19929 * @param obj The slideshow object
19931 * This removes (and deletes) all items in @p obj, leaving it
19934 * @see elm_slideshow_item_del(), to remove just one item.
19936 * @ingroup Slideshow
19938 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19941 * Get the internal list of items in a given slideshow widget.
19943 * @param obj The slideshow object
19944 * @return The list of items (#Elm_Slideshow_Item as data) or
19945 * @c NULL on errors.
19947 * This list is @b not to be modified in any way and must not be
19948 * freed. Use the list members with functions like
19949 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19951 * @warning This list is only valid until @p obj object's internal
19952 * items list is changed. It should be fetched again with another
19953 * call to this function when changes happen.
19955 * @ingroup Slideshow
19957 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19960 * Delete a given item from a slideshow widget.
19962 * @param item The slideshow item
19964 * @ingroup Slideshow
19966 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19969 * Return the data associated with a given slideshow item
19971 * @param item The slideshow item
19972 * @return Returns the data associated to this item
19974 * @ingroup Slideshow
19976 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19979 * Returns the currently displayed item, in a given slideshow widget
19981 * @param obj The slideshow object
19982 * @return A handle to the item being displayed in @p obj or
19983 * @c NULL, if none is (and on errors)
19985 * @ingroup Slideshow
19987 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19990 * Get the real Evas object created to implement the view of a
19991 * given slideshow item
19993 * @param item The slideshow item.
19994 * @return the Evas object implementing this item's view.
19996 * This returns the actual Evas object used to implement the
19997 * specified slideshow item's view. This may be @c NULL, as it may
19998 * not have been created or may have been deleted, at any time, by
19999 * the slideshow. <b>Do not modify this object</b> (move, resize,
20000 * show, hide, etc.), as the slideshow is controlling it. This
20001 * function is for querying, emitting custom signals or hooking
20002 * lower level callbacks for events on that object. Do not delete
20003 * this object under any circumstances.
20005 * @see elm_slideshow_item_data_get()
20007 * @ingroup Slideshow
20009 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20012 * Get the the item, in a given slideshow widget, placed at
20013 * position @p nth, in its internal items list
20015 * @param obj The slideshow object
20016 * @param nth The number of the item to grab a handle to (0 being
20018 * @return The item stored in @p obj at position @p nth or @c NULL,
20019 * if there's no item with that index (and on errors)
20021 * @ingroup Slideshow
20023 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20026 * Set the current slide layout in use for a given slideshow widget
20028 * @param obj The slideshow object
20029 * @param layout The new layout's name string
20031 * If @p layout is implemented in @p obj's theme (i.e., is contained
20032 * in the list returned by elm_slideshow_layouts_get()), this new
20033 * images layout will be used on the widget.
20035 * @see elm_slideshow_layouts_get() for more details
20037 * @ingroup Slideshow
20039 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20042 * Get the current slide layout in use for a given slideshow widget
20044 * @param obj The slideshow object
20045 * @return The current layout's name
20047 * @see elm_slideshow_layout_set() for more details
20049 * @ingroup Slideshow
20051 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20054 * Returns the list of @b layout names available, for a given
20055 * slideshow widget.
20057 * @param obj The slideshow object
20058 * @return The list of layouts (list of @b stringshared strings
20061 * Slideshow layouts will change how the widget is to dispose each
20062 * image item in its viewport, with regard to cropping, scaling,
20065 * The layouts, which come from @p obj's theme, must be an EDC
20066 * data item name @c "layouts" on the theme file, with (prefix)
20067 * names of EDC programs actually implementing them.
20069 * The available layouts for slideshows on the default theme are:
20070 * - @c "fullscreen" - item images with original aspect, scaled to
20071 * touch top and down slideshow borders or, if the image's heigh
20072 * is not enough, left and right slideshow borders.
20073 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20074 * one, but always leaving 10% of the slideshow's dimensions of
20075 * distance between the item image's borders and the slideshow
20076 * borders, for each axis.
20078 * @warning The stringshared strings get no new references
20079 * exclusive to the user grabbing the list, here, so if you'd like
20080 * to use them out of this call's context, you'd better @c
20081 * eina_stringshare_ref() them.
20083 * @see elm_slideshow_layout_set()
20085 * @ingroup Slideshow
20087 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20090 * Set the number of items to cache, on a given slideshow widget,
20091 * <b>before the current item</b>
20093 * @param obj The slideshow object
20094 * @param count Number of items to cache before the current one
20096 * The default value for this property is @c 2. See
20097 * @ref Slideshow_Caching "slideshow caching" for more details.
20099 * @see elm_slideshow_cache_before_get()
20101 * @ingroup Slideshow
20103 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20106 * Retrieve the number of items to cache, on a given slideshow widget,
20107 * <b>before the current item</b>
20109 * @param obj The slideshow object
20110 * @return The number of items set to be cached before the current one
20112 * @see elm_slideshow_cache_before_set() for more details
20114 * @ingroup Slideshow
20116 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20119 * Set the number of items to cache, on a given slideshow widget,
20120 * <b>after the current item</b>
20122 * @param obj The slideshow object
20123 * @param count Number of items to cache after the current one
20125 * The default value for this property is @c 2. See
20126 * @ref Slideshow_Caching "slideshow caching" for more details.
20128 * @see elm_slideshow_cache_after_get()
20130 * @ingroup Slideshow
20132 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20135 * Retrieve the number of items to cache, on a given slideshow widget,
20136 * <b>after the current item</b>
20138 * @param obj The slideshow object
20139 * @return The number of items set to be cached after the current one
20141 * @see elm_slideshow_cache_after_set() for more details
20143 * @ingroup Slideshow
20145 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20148 * Get the number of items stored in a given slideshow widget
20150 * @param obj The slideshow object
20151 * @return The number of items on @p obj, at the moment of this call
20153 * @ingroup Slideshow
20155 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20162 * @defgroup Fileselector File Selector
20164 * @image html img/widget/fileselector/preview-00.png
20165 * @image latex img/widget/fileselector/preview-00.eps
20167 * A file selector is a widget that allows a user to navigate
20168 * through a file system, reporting file selections back via its
20171 * It contains shortcut buttons for home directory (@c ~) and to
20172 * jump one directory upwards (..), as well as cancel/ok buttons to
20173 * confirm/cancel a given selection. After either one of those two
20174 * former actions, the file selector will issue its @c "done" smart
20177 * There's a text entry on it, too, showing the name of the current
20178 * selection. There's the possibility of making it editable, so it
20179 * is useful on file saving dialogs on applications, where one
20180 * gives a file name to save contents to, in a given directory in
20181 * the system. This custom file name will be reported on the @c
20182 * "done" smart callback (explained in sequence).
20184 * Finally, it has a view to display file system items into in two
20189 * If Elementary is built with support of the Ethumb thumbnailing
20190 * library, the second form of view will display preview thumbnails
20191 * of files which it supports.
20193 * Smart callbacks one can register to:
20195 * - @c "selected" - the user has clicked on a file (when not in
20196 * folders-only mode) or directory (when in folders-only mode)
20197 * - @c "directory,open" - the list has been populated with new
20198 * content (@c event_info is a pointer to the directory's
20199 * path, a @b stringshared string)
20200 * - @c "done" - the user has clicked on the "ok" or "cancel"
20201 * buttons (@c event_info is a pointer to the selection's
20202 * path, a @b stringshared string)
20204 * Here is an example on its usage:
20205 * @li @ref fileselector_example
20209 * @addtogroup Fileselector
20214 * Defines how a file selector widget is to layout its contents
20215 * (file system entries).
20217 typedef enum _Elm_Fileselector_Mode
20219 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20220 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20221 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20222 } Elm_Fileselector_Mode;
20225 * Add a new file selector widget to the given parent Elementary
20226 * (container) object
20228 * @param parent The parent object
20229 * @return a new file selector widget handle or @c NULL, on errors
20231 * This function inserts a new file selector widget on the canvas.
20233 * @ingroup Fileselector
20235 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20238 * Enable/disable the file name entry box where the user can type
20239 * in a name for a file, in a given file selector widget
20241 * @param obj The file selector object
20242 * @param is_save @c EINA_TRUE to make the file selector a "saving
20243 * dialog", @c EINA_FALSE otherwise
20245 * Having the entry editable is useful on file saving dialogs on
20246 * applications, where one gives a file name to save contents to,
20247 * in a given directory in the system. This custom file name will
20248 * be reported on the @c "done" smart callback.
20250 * @see elm_fileselector_is_save_get()
20252 * @ingroup Fileselector
20254 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20257 * Get whether the given file selector is in "saving dialog" mode
20259 * @param obj The file selector object
20260 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20261 * mode, @c EINA_FALSE otherwise (and on errors)
20263 * @see elm_fileselector_is_save_set() for more details
20265 * @ingroup Fileselector
20267 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20270 * Enable/disable folder-only view for a given file selector widget
20272 * @param obj The file selector object
20273 * @param only @c EINA_TRUE to make @p obj only display
20274 * directories, @c EINA_FALSE to make files to be displayed in it
20277 * If enabled, the widget's view will only display folder items,
20280 * @see elm_fileselector_folder_only_get()
20282 * @ingroup Fileselector
20284 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20287 * Get whether folder-only view is set for a given file selector
20290 * @param obj The file selector object
20291 * @return only @c EINA_TRUE if @p obj is only displaying
20292 * directories, @c EINA_FALSE if files are being displayed in it
20293 * too (and on errors)
20295 * @see elm_fileselector_folder_only_get()
20297 * @ingroup Fileselector
20299 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20302 * Enable/disable the "ok" and "cancel" buttons on a given file
20305 * @param obj The file selector object
20306 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20308 * @note A file selector without those buttons will never emit the
20309 * @c "done" smart event, and is only usable if one is just hooking
20310 * to the other two events.
20312 * @see elm_fileselector_buttons_ok_cancel_get()
20314 * @ingroup Fileselector
20316 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20319 * Get whether the "ok" and "cancel" buttons on a given file
20320 * selector widget are being shown.
20322 * @param obj The file selector object
20323 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20324 * otherwise (and on errors)
20326 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20328 * @ingroup Fileselector
20330 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20333 * Enable/disable a tree view in the given file selector widget,
20334 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20336 * @param obj The file selector object
20337 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20340 * In a tree view, arrows are created on the sides of directories,
20341 * allowing them to expand in place.
20343 * @note If it's in other mode, the changes made by this function
20344 * will only be visible when one switches back to "list" mode.
20346 * @see elm_fileselector_expandable_get()
20348 * @ingroup Fileselector
20350 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20353 * Get whether tree view is enabled for the given file selector
20356 * @param obj The file selector object
20357 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20358 * otherwise (and or errors)
20360 * @see elm_fileselector_expandable_set() for more details
20362 * @ingroup Fileselector
20364 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20367 * Set, programmatically, the @b directory that a given file
20368 * selector widget will display contents from
20370 * @param obj The file selector object
20371 * @param path The path to display in @p obj
20373 * This will change the @b directory that @p obj is displaying. It
20374 * will also clear the text entry area on the @p obj object, which
20375 * displays select files' names.
20377 * @see elm_fileselector_path_get()
20379 * @ingroup Fileselector
20381 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20384 * Get the parent directory's path that a given file selector
20385 * widget is displaying
20387 * @param obj The file selector object
20388 * @return The (full) path of the directory the file selector is
20389 * displaying, a @b stringshared string
20391 * @see elm_fileselector_path_set()
20393 * @ingroup Fileselector
20395 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20398 * Set, programmatically, the currently selected file/directory in
20399 * the given file selector widget
20401 * @param obj The file selector object
20402 * @param path The (full) path to a file or directory
20403 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20404 * latter case occurs if the directory or file pointed to do not
20407 * @see elm_fileselector_selected_get()
20409 * @ingroup Fileselector
20411 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20414 * Get the currently selected item's (full) path, in the given file
20417 * @param obj The file selector object
20418 * @return The absolute path of the selected item, a @b
20419 * stringshared string
20421 * @note Custom editions on @p obj object's text entry, if made,
20422 * will appear on the return string of this function, naturally.
20424 * @see elm_fileselector_selected_set() for more details
20426 * @ingroup Fileselector
20428 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20431 * Set the mode in which a given file selector widget will display
20432 * (layout) file system entries in its view
20434 * @param obj The file selector object
20435 * @param mode The mode of the fileselector, being it one of
20436 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20437 * first one, naturally, will display the files in a list. The
20438 * latter will make the widget to display its entries in a grid
20441 * @note By using elm_fileselector_expandable_set(), the user may
20442 * trigger a tree view for that list.
20444 * @note If Elementary is built with support of the Ethumb
20445 * thumbnailing library, the second form of view will display
20446 * preview thumbnails of files which it supports. You must have
20447 * elm_need_ethumb() called in your Elementary for thumbnailing to
20450 * @see elm_fileselector_expandable_set().
20451 * @see elm_fileselector_mode_get().
20453 * @ingroup Fileselector
20455 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20458 * Get the mode in which a given file selector widget is displaying
20459 * (layouting) file system entries in its view
20461 * @param obj The fileselector object
20462 * @return The mode in which the fileselector is at
20464 * @see elm_fileselector_mode_set() for more details
20466 * @ingroup Fileselector
20468 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20475 * @defgroup Progressbar Progress bar
20477 * The progress bar is a widget for visually representing the
20478 * progress status of a given job/task.
20480 * A progress bar may be horizontal or vertical. It may display an
20481 * icon besides it, as well as primary and @b units labels. The
20482 * former is meant to label the widget as a whole, while the
20483 * latter, which is formatted with floating point values (and thus
20484 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20485 * units"</c>), is meant to label the widget's <b>progress
20486 * value</b>. Label, icon and unit strings/objects are @b optional
20487 * for progress bars.
20489 * A progress bar may be @b inverted, in which state it gets its
20490 * values inverted, with high values being on the left or top and
20491 * low values on the right or bottom, as opposed to normally have
20492 * the low values on the former and high values on the latter,
20493 * respectively, for horizontal and vertical modes.
20495 * The @b span of the progress, as set by
20496 * elm_progressbar_span_size_set(), is its length (horizontally or
20497 * vertically), unless one puts size hints on the widget to expand
20498 * on desired directions, by any container. That length will be
20499 * scaled by the object or applications scaling factor. At any
20500 * point code can query the progress bar for its value with
20501 * elm_progressbar_value_get().
20503 * Available widget styles for progress bars:
20505 * - @c "wheel" (simple style, no text, no progression, only
20506 * "pulse" effect is available)
20508 * Here is an example on its usage:
20509 * @li @ref progressbar_example
20513 * Add a new progress bar widget to the given parent Elementary
20514 * (container) object
20516 * @param parent The parent object
20517 * @return a new progress bar widget handle or @c NULL, on errors
20519 * This function inserts a new progress bar widget on the canvas.
20521 * @ingroup Progressbar
20523 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20526 * Set whether a given progress bar widget is at "pulsing mode" or
20529 * @param obj The progress bar object
20530 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20531 * @c EINA_FALSE to put it back to its default one
20533 * By default, progress bars will display values from the low to
20534 * high value boundaries. There are, though, contexts in which the
20535 * state of progression of a given task is @b unknown. For those,
20536 * one can set a progress bar widget to a "pulsing state", to give
20537 * the user an idea that some computation is being held, but
20538 * without exact progress values. In the default theme it will
20539 * animate its bar with the contents filling in constantly and back
20540 * to non-filled, in a loop. To start and stop this pulsing
20541 * animation, one has to explicitly call elm_progressbar_pulse().
20543 * @see elm_progressbar_pulse_get()
20544 * @see elm_progressbar_pulse()
20546 * @ingroup Progressbar
20548 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20551 * Get whether a given progress bar widget is at "pulsing mode" or
20554 * @param obj The progress bar object
20555 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20556 * if it's in the default one (and on errors)
20558 * @ingroup Progressbar
20560 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20563 * Start/stop a given progress bar "pulsing" animation, if its
20566 * @param obj The progress bar object
20567 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20568 * @c EINA_FALSE to @b stop it
20570 * @note This call won't do anything if @p obj is not under "pulsing mode".
20572 * @see elm_progressbar_pulse_set() for more details.
20574 * @ingroup Progressbar
20576 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20579 * Set the progress value (in percentage) on a given progress bar
20582 * @param obj The progress bar object
20583 * @param val The progress value (@b must be between @c 0.0 and @c
20586 * Use this call to set progress bar levels.
20588 * @note If you passes a value out of the specified range for @p
20589 * val, it will be interpreted as the @b closest of the @b boundary
20590 * values in the range.
20592 * @ingroup Progressbar
20594 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20597 * Get the progress value (in percentage) on a given progress bar
20600 * @param obj The progress bar object
20601 * @return The value of the progressbar
20603 * @see elm_progressbar_value_set() for more details
20605 * @ingroup Progressbar
20607 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20610 * Set the label of a given progress bar widget
20612 * @param obj The progress bar object
20613 * @param label The text label string, in UTF-8
20615 * @ingroup Progressbar
20616 * @deprecated use elm_object_text_set() instead.
20618 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20621 * Get the label of a given progress bar widget
20623 * @param obj The progressbar object
20624 * @return The text label string, in UTF-8
20626 * @ingroup Progressbar
20627 * @deprecated use elm_object_text_set() instead.
20629 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20632 * Set the icon object of a given progress bar widget
20634 * @param obj The progress bar object
20635 * @param icon The icon object
20637 * Use this call to decorate @p obj with an icon next to it.
20639 * @note Once the icon object is set, a previously set one will be
20640 * deleted. If you want to keep that old content object, use the
20641 * elm_progressbar_icon_unset() function.
20643 * @see elm_progressbar_icon_get()
20645 * @ingroup Progressbar
20647 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20650 * Retrieve the icon object set for a given progress bar widget
20652 * @param obj The progress bar object
20653 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20654 * otherwise (and on errors)
20656 * @see elm_progressbar_icon_set() for more details
20658 * @ingroup Progressbar
20660 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20663 * Unset an icon set on a given progress bar widget
20665 * @param obj The progress bar object
20666 * @return The icon object that was being used, if any was set, or
20667 * @c NULL, otherwise (and on errors)
20669 * This call will unparent and return the icon object which was set
20670 * for this widget, previously, on success.
20672 * @see elm_progressbar_icon_set() for more details
20674 * @ingroup Progressbar
20676 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20679 * Set the (exact) length of the bar region of a given progress bar
20682 * @param obj The progress bar object
20683 * @param size The length of the progress bar's bar region
20685 * This sets the minimum width (when in horizontal mode) or height
20686 * (when in vertical mode) of the actual bar area of the progress
20687 * bar @p obj. This in turn affects the object's minimum size. Use
20688 * this when you're not setting other size hints expanding on the
20689 * given direction (like weight and alignment hints) and you would
20690 * like it to have a specific size.
20692 * @note Icon, label and unit text around @p obj will require their
20693 * own space, which will make @p obj to require more the @p size,
20696 * @see elm_progressbar_span_size_get()
20698 * @ingroup Progressbar
20700 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20703 * Get the length set for the bar region of a given progress bar
20706 * @param obj The progress bar object
20707 * @return The length of the progress bar's bar region
20709 * If that size was not set previously, with
20710 * elm_progressbar_span_size_set(), this call will return @c 0.
20712 * @ingroup Progressbar
20714 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20717 * Set the format string for a given progress bar widget's units
20720 * @param obj The progress bar object
20721 * @param format The format string for @p obj's units label
20723 * If @c NULL is passed on @p format, it will make @p obj's units
20724 * area to be hidden completely. If not, it'll set the <b>format
20725 * string</b> for the units label's @b text. The units label is
20726 * provided a floating point value, so the units text is up display
20727 * at most one floating point falue. Note that the units label is
20728 * optional. Use a format string such as "%1.2f meters" for
20731 * @note The default format string for a progress bar is an integer
20732 * percentage, as in @c "%.0f %%".
20734 * @see elm_progressbar_unit_format_get()
20736 * @ingroup Progressbar
20738 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20741 * Retrieve the format string set for a given progress bar widget's
20744 * @param obj The progress bar object
20745 * @return The format set string for @p obj's units label or
20746 * @c NULL, if none was set (and on errors)
20748 * @see elm_progressbar_unit_format_set() for more details
20750 * @ingroup Progressbar
20752 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20755 * Set the orientation of a given progress bar widget
20757 * @param obj The progress bar object
20758 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20759 * @b horizontal, @c EINA_FALSE to make it @b vertical
20761 * Use this function to change how your progress bar is to be
20762 * disposed: vertically or horizontally.
20764 * @see elm_progressbar_horizontal_get()
20766 * @ingroup Progressbar
20768 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20771 * Retrieve the orientation of a given progress bar widget
20773 * @param obj The progress bar object
20774 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20775 * @c EINA_FALSE if it's @b vertical (and on errors)
20777 * @see elm_progressbar_horizontal_set() for more details
20779 * @ingroup Progressbar
20781 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20784 * Invert a given progress bar widget's displaying values order
20786 * @param obj The progress bar object
20787 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20788 * @c EINA_FALSE to bring it back to default, non-inverted values.
20790 * A progress bar may be @b inverted, in which state it gets its
20791 * values inverted, with high values being on the left or top and
20792 * low values on the right or bottom, as opposed to normally have
20793 * the low values on the former and high values on the latter,
20794 * respectively, for horizontal and vertical modes.
20796 * @see elm_progressbar_inverted_get()
20798 * @ingroup Progressbar
20800 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20803 * Get whether a given progress bar widget's displaying values are
20806 * @param obj The progress bar object
20807 * @return @c EINA_TRUE, if @p obj has inverted values,
20808 * @c EINA_FALSE otherwise (and on errors)
20810 * @see elm_progressbar_inverted_set() for more details
20812 * @ingroup Progressbar
20814 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20817 * @defgroup Separator Separator
20819 * @brief Separator is a very thin object used to separate other objects.
20821 * A separator can be vertical or horizontal.
20823 * @ref tutorial_separator is a good example of how to use a separator.
20827 * @brief Add a separator object to @p parent
20829 * @param parent The parent object
20831 * @return The separator object, or NULL upon failure
20833 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20835 * @brief Set the horizontal mode of a separator object
20837 * @param obj The separator object
20838 * @param horizontal If true, the separator is horizontal
20840 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20842 * @brief Get the horizontal mode of a separator object
20844 * @param obj The separator object
20845 * @return If true, the separator is horizontal
20847 * @see elm_separator_horizontal_set()
20849 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20855 * @defgroup Spinner Spinner
20856 * @ingroup Elementary
20858 * @image html img/widget/spinner/preview-00.png
20859 * @image latex img/widget/spinner/preview-00.eps
20861 * A spinner is a widget which allows the user to increase or decrease
20862 * numeric values using arrow buttons, or edit values directly, clicking
20863 * over it and typing the new value.
20865 * By default the spinner will not wrap and has a label
20866 * of "%.0f" (just showing the integer value of the double).
20868 * A spinner has a label that is formatted with floating
20869 * point values and thus accepts a printf-style format string, like
20872 * It also allows specific values to be replaced by pre-defined labels.
20874 * Smart callbacks one can register to:
20876 * - "changed" - Whenever the spinner value is changed.
20877 * - "delay,changed" - A short time after the value is changed by the user.
20878 * This will be called only when the user stops dragging for a very short
20879 * period or when they release their finger/mouse, so it avoids possibly
20880 * expensive reactions to the value change.
20882 * Available styles for it:
20884 * - @c "vertical": up/down buttons at the right side and text left aligned.
20886 * Here is an example on its usage:
20887 * @ref spinner_example
20891 * @addtogroup Spinner
20896 * Add a new spinner widget to the given parent Elementary
20897 * (container) object.
20899 * @param parent The parent object.
20900 * @return a new spinner widget handle or @c NULL, on errors.
20902 * This function inserts a new spinner widget on the canvas.
20907 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20910 * Set the format string of the displayed label.
20912 * @param obj The spinner object.
20913 * @param fmt The format string for the label display.
20915 * If @c NULL, this sets the format to "%.0f". If not it sets the format
20916 * string for the label text. The label text is provided a floating point
20917 * value, so the label text can display up to 1 floating point value.
20918 * Note that this is optional.
20920 * Use a format string such as "%1.2f meters" for example, and it will
20921 * display values like: "3.14 meters" for a value equal to 3.14159.
20923 * Default is "%0.f".
20925 * @see elm_spinner_label_format_get()
20929 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20932 * Get the label format of the spinner.
20934 * @param obj The spinner object.
20935 * @return The text label format string in UTF-8.
20937 * @see elm_spinner_label_format_set() for details.
20941 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20944 * Set the minimum and maximum values for the spinner.
20946 * @param obj The spinner object.
20947 * @param min The minimum value.
20948 * @param max The maximum value.
20950 * Define the allowed range of values to be selected by the user.
20952 * If actual value is less than @p min, it will be updated to @p min. If it
20953 * is bigger then @p max, will be updated to @p max. Actual value can be
20954 * get with elm_spinner_value_get().
20956 * By default, min is equal to 0, and max is equal to 100.
20958 * @warning Maximum must be greater than minimum.
20960 * @see elm_spinner_min_max_get()
20964 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20967 * Get the minimum and maximum values of the spinner.
20969 * @param obj The spinner object.
20970 * @param min Pointer where to store the minimum value.
20971 * @param max Pointer where to store the maximum value.
20973 * @note If only one value is needed, the other pointer can be passed
20976 * @see elm_spinner_min_max_set() for details.
20980 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20983 * Set the step used to increment or decrement the spinner value.
20985 * @param obj The spinner object.
20986 * @param step The step value.
20988 * This value will be incremented or decremented to the displayed value.
20989 * It will be incremented while the user keep right or top arrow pressed,
20990 * and will be decremented while the user keep left or bottom arrow pressed.
20992 * The interval to increment / decrement can be set with
20993 * elm_spinner_interval_set().
20995 * By default step value is equal to 1.
20997 * @see elm_spinner_step_get()
21001 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21004 * Get the step used to increment or decrement the spinner value.
21006 * @param obj The spinner object.
21007 * @return The step value.
21009 * @see elm_spinner_step_get() for more details.
21013 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21016 * Set the value the spinner displays.
21018 * @param obj The spinner object.
21019 * @param val The value to be displayed.
21021 * Value will be presented on the label following format specified with
21022 * elm_spinner_format_set().
21024 * @warning The value must to be between min and max values. This values
21025 * are set by elm_spinner_min_max_set().
21027 * @see elm_spinner_value_get().
21028 * @see elm_spinner_format_set().
21029 * @see elm_spinner_min_max_set().
21033 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21036 * Get the value displayed by the spinner.
21038 * @param obj The spinner object.
21039 * @return The value displayed.
21041 * @see elm_spinner_value_set() for details.
21045 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21048 * Set whether the spinner should wrap when it reaches its
21049 * minimum or maximum value.
21051 * @param obj The spinner object.
21052 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21055 * Disabled by default. If disabled, when the user tries to increment the
21057 * but displayed value plus step value is bigger than maximum value,
21059 * won't allow it. The same happens when the user tries to decrement it,
21060 * but the value less step is less than minimum value.
21062 * When wrap is enabled, in such situations it will allow these changes,
21063 * but will get the value that would be less than minimum and subtracts
21064 * from maximum. Or add the value that would be more than maximum to
21068 * @li min value = 10
21069 * @li max value = 50
21070 * @li step value = 20
21071 * @li displayed value = 20
21073 * When the user decrement value (using left or bottom arrow), it will
21074 * displays @c 40, because max - (min - (displayed - step)) is
21075 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21077 * @see elm_spinner_wrap_get().
21081 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21084 * Get whether the spinner should wrap when it reaches its
21085 * minimum or maximum value.
21087 * @param obj The spinner object
21088 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21089 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21091 * @see elm_spinner_wrap_set() for details.
21095 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21098 * Set whether the spinner can be directly edited by the user or not.
21100 * @param obj The spinner object.
21101 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21102 * don't allow users to edit it directly.
21104 * Spinner objects can have edition @b disabled, in which state they will
21105 * be changed only by arrows.
21106 * Useful for contexts
21107 * where you don't want your users to interact with it writting the value.
21109 * when using special values, the user can see real value instead
21110 * of special label on edition.
21112 * It's enabled by default.
21114 * @see elm_spinner_editable_get()
21118 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21121 * Get whether the spinner can be directly edited by the user or not.
21123 * @param obj The spinner object.
21124 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21125 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21127 * @see elm_spinner_editable_set() for details.
21131 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21134 * Set a special string to display in the place of the numerical value.
21136 * @param obj The spinner object.
21137 * @param value The value to be replaced.
21138 * @param label The label to be used.
21140 * It's useful for cases when a user should select an item that is
21141 * better indicated by a label than a value. For example, weekdays or months.
21145 * sp = elm_spinner_add(win);
21146 * elm_spinner_min_max_set(sp, 1, 3);
21147 * elm_spinner_special_value_add(sp, 1, "January");
21148 * elm_spinner_special_value_add(sp, 2, "February");
21149 * elm_spinner_special_value_add(sp, 3, "March");
21150 * evas_object_show(sp);
21155 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21158 * Set the interval on time updates for an user mouse button hold
21159 * on spinner widgets' arrows.
21161 * @param obj The spinner object.
21162 * @param interval The (first) interval value in seconds.
21164 * This interval value is @b decreased while the user holds the
21165 * mouse pointer either incrementing or decrementing spinner's value.
21167 * This helps the user to get to a given value distant from the
21168 * current one easier/faster, as it will start to change quicker and
21169 * quicker on mouse button holds.
21171 * The calculation for the next change interval value, starting from
21172 * the one set with this call, is the previous interval divided by
21173 * @c 1.05, so it decreases a little bit.
21175 * The default starting interval value for automatic changes is
21178 * @see elm_spinner_interval_get()
21182 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21185 * Get the interval on time updates for an user mouse button hold
21186 * on spinner widgets' arrows.
21188 * @param obj The spinner object.
21189 * @return The (first) interval value, in seconds, set on it.
21191 * @see elm_spinner_interval_set() for more details.
21195 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21202 * @defgroup Index Index
21204 * @image html img/widget/index/preview-00.png
21205 * @image latex img/widget/index/preview-00.eps
21207 * An index widget gives you an index for fast access to whichever
21208 * group of other UI items one might have. It's a list of text
21209 * items (usually letters, for alphabetically ordered access).
21211 * Index widgets are by default hidden and just appear when the
21212 * user clicks over it's reserved area in the canvas. In its
21213 * default theme, it's an area one @ref Fingers "finger" wide on
21214 * the right side of the index widget's container.
21216 * When items on the index are selected, smart callbacks get
21217 * called, so that its user can make other container objects to
21218 * show a given area or child object depending on the index item
21219 * selected. You'd probably be using an index together with @ref
21220 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21223 * Smart events one can add callbacks for are:
21224 * - @c "changed" - When the selected index item changes. @c
21225 * event_info is the selected item's data pointer.
21226 * - @c "delay,changed" - When the selected index item changes, but
21227 * after a small idling period. @c event_info is the selected
21228 * item's data pointer.
21229 * - @c "selected" - When the user releases a mouse button and
21230 * selects an item. @c event_info is the selected item's data
21232 * - @c "level,up" - when the user moves a finger from the first
21233 * level to the second level
21234 * - @c "level,down" - when the user moves a finger from the second
21235 * level to the first level
21237 * The @c "delay,changed" event is so that it'll wait a small time
21238 * before actually reporting those events and, moreover, just the
21239 * last event happening on those time frames will actually be
21242 * Here are some examples on its usage:
21243 * @li @ref index_example_01
21244 * @li @ref index_example_02
21248 * @addtogroup Index
21252 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21255 * Add a new index widget to the given parent Elementary
21256 * (container) object
21258 * @param parent The parent object
21259 * @return a new index widget handle or @c NULL, on errors
21261 * This function inserts a new index widget on the canvas.
21265 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21268 * Set whether a given index widget is or not visible,
21271 * @param obj The index object
21272 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21274 * Not to be confused with visible as in @c evas_object_show() --
21275 * visible with regard to the widget's auto hiding feature.
21277 * @see elm_index_active_get()
21281 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21284 * Get whether a given index widget is currently visible or not.
21286 * @param obj The index object
21287 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21289 * @see elm_index_active_set() for more details
21293 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21296 * Set the items level for a given index widget.
21298 * @param obj The index object.
21299 * @param level @c 0 or @c 1, the currently implemented levels.
21301 * @see elm_index_item_level_get()
21305 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21308 * Get the items level set for a given index widget.
21310 * @param obj The index object.
21311 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21313 * @see elm_index_item_level_set() for more information
21317 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21320 * Returns the last selected item's data, for a given index widget.
21322 * @param obj The index object.
21323 * @return The item @b data associated to the last selected item on
21324 * @p obj (or @c NULL, on errors).
21326 * @warning The returned value is @b not an #Elm_Index_Item item
21327 * handle, but the data associated to it (see the @c item parameter
21328 * in elm_index_item_append(), as an example).
21332 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21335 * Append a new item on a given index widget.
21337 * @param obj The index object.
21338 * @param letter Letter under which the item should be indexed
21339 * @param item The item data to set for the index's item
21341 * Despite the most common usage of the @p letter argument is for
21342 * single char strings, one could use arbitrary strings as index
21345 * @c item will be the pointer returned back on @c "changed", @c
21346 * "delay,changed" and @c "selected" smart events.
21350 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21353 * Prepend a new item on a given index widget.
21355 * @param obj The index object.
21356 * @param letter Letter under which the item should be indexed
21357 * @param item The item data to set for the index's item
21359 * Despite the most common usage of the @p letter argument is for
21360 * single char strings, one could use arbitrary strings as index
21363 * @c item will be the pointer returned back on @c "changed", @c
21364 * "delay,changed" and @c "selected" smart events.
21368 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21371 * Append a new item, on a given index widget, <b>after the item
21372 * having @p relative as data</b>.
21374 * @param obj The index object.
21375 * @param letter Letter under which the item should be indexed
21376 * @param item The item data to set for the index's item
21377 * @param relative The item data of the index item to be the
21378 * predecessor of this new one
21380 * Despite the most common usage of the @p letter argument is for
21381 * single char strings, one could use arbitrary strings as index
21384 * @c item will be the pointer returned back on @c "changed", @c
21385 * "delay,changed" and @c "selected" smart events.
21387 * @note If @p relative is @c NULL or if it's not found to be data
21388 * set on any previous item on @p obj, this function will behave as
21389 * elm_index_item_append().
21393 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21396 * Prepend a new item, on a given index widget, <b>after the item
21397 * having @p relative as data</b>.
21399 * @param obj The index object.
21400 * @param letter Letter under which the item should be indexed
21401 * @param item The item data to set for the index's item
21402 * @param relative The item data of the index item to be the
21403 * successor of this new one
21405 * Despite the most common usage of the @p letter argument is for
21406 * single char strings, one could use arbitrary strings as index
21409 * @c item will be the pointer returned back on @c "changed", @c
21410 * "delay,changed" and @c "selected" smart events.
21412 * @note If @p relative is @c NULL or if it's not found to be data
21413 * set on any previous item on @p obj, this function will behave as
21414 * elm_index_item_prepend().
21418 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21421 * Insert a new item into the given index widget, using @p cmp_func
21422 * function to sort items (by item handles).
21424 * @param obj The index object.
21425 * @param letter Letter under which the item should be indexed
21426 * @param item The item data to set for the index's item
21427 * @param cmp_func The comparing function to be used to sort index
21428 * items <b>by #Elm_Index_Item item handles</b>
21429 * @param cmp_data_func A @b fallback function to be called for the
21430 * sorting of index items <b>by item data</b>). It will be used
21431 * when @p cmp_func returns @c 0 (equality), which means an index
21432 * item with provided item data already exists. To decide which
21433 * data item should be pointed to by the index item in question, @p
21434 * cmp_data_func will be used. If @p cmp_data_func returns a
21435 * non-negative value, the previous index item data will be
21436 * replaced by the given @p item pointer. If the previous data need
21437 * to be freed, it should be done by the @p cmp_data_func function,
21438 * because all references to it will be lost. If this function is
21439 * not provided (@c NULL is given), index items will be @b
21440 * duplicated, if @p cmp_func returns @c 0.
21442 * Despite the most common usage of the @p letter argument is for
21443 * single char strings, one could use arbitrary strings as index
21446 * @c item will be the pointer returned back on @c "changed", @c
21447 * "delay,changed" and @c "selected" smart events.
21451 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);
21454 * Remove an item from a given index widget, <b>to be referenced by
21455 * it's data value</b>.
21457 * @param obj The index object
21458 * @param item The item's data pointer for the item to be removed
21461 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21462 * that callback function will be called by this one.
21464 * @warning The item to be removed from @p obj will be found via
21465 * its item data pointer, and not by an #Elm_Index_Item handle.
21469 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21472 * Find a given index widget's item, <b>using item data</b>.
21474 * @param obj The index object
21475 * @param item The item data pointed to by the desired index item
21476 * @return The index item handle, if found, or @c NULL otherwise
21480 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21483 * Removes @b all items from a given index widget.
21485 * @param obj The index object.
21487 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21488 * that callback function will be called for each item in @p obj.
21492 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21495 * Go to a given items level on a index widget
21497 * @param obj The index object
21498 * @param level The index level (one of @c 0 or @c 1)
21502 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21505 * Return the data associated with a given index widget item
21507 * @param it The index widget item handle
21508 * @return The data associated with @p it
21510 * @see elm_index_item_data_set()
21514 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21517 * Set the data associated with a given index widget item
21519 * @param it The index widget item handle
21520 * @param data The new data pointer to set to @p it
21522 * This sets new item data on @p it.
21524 * @warning The old data pointer won't be touched by this function, so
21525 * the user had better to free that old data himself/herself.
21529 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21532 * Set the function to be called when a given index widget item is freed.
21534 * @param it The item to set the callback on
21535 * @param func The function to call on the item's deletion
21537 * When called, @p func will have both @c data and @c event_info
21538 * arguments with the @p it item's data value and, naturally, the
21539 * @c obj argument with a handle to the parent index widget.
21543 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21546 * Get the letter (string) set on a given index widget item.
21548 * @param it The index item handle
21549 * @return The letter string set on @p it
21553 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21560 * @defgroup Photocam Photocam
21562 * @image html img/widget/photocam/preview-00.png
21563 * @image latex img/widget/photocam/preview-00.eps
21565 * This is a widget specifically for displaying high-resolution digital
21566 * camera photos giving speedy feedback (fast load), low memory footprint
21567 * and zooming and panning as well as fitting logic. It is entirely focused
21568 * on jpeg images, and takes advantage of properties of the jpeg format (via
21569 * evas loader features in the jpeg loader).
21571 * Signals that you can add callbacks for are:
21572 * @li "clicked" - This is called when a user has clicked the photo without
21574 * @li "press" - This is called when a user has pressed down on the photo.
21575 * @li "longpressed" - This is called when a user has pressed down on the
21576 * photo for a long time without dragging around.
21577 * @li "clicked,double" - This is called when a user has double-clicked the
21579 * @li "load" - Photo load begins.
21580 * @li "loaded" - This is called when the image file load is complete for the
21581 * first view (low resolution blurry version).
21582 * @li "load,detail" - Photo detailed data load begins.
21583 * @li "loaded,detail" - This is called when the image file load is complete
21584 * for the detailed image data (full resolution needed).
21585 * @li "zoom,start" - Zoom animation started.
21586 * @li "zoom,stop" - Zoom animation stopped.
21587 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21588 * @li "scroll" - the content has been scrolled (moved)
21589 * @li "scroll,anim,start" - scrolling animation has started
21590 * @li "scroll,anim,stop" - scrolling animation has stopped
21591 * @li "scroll,drag,start" - dragging the contents around has started
21592 * @li "scroll,drag,stop" - dragging the contents around has stopped
21594 * @ref tutorial_photocam shows the API in action.
21598 * @brief Types of zoom available.
21600 typedef enum _Elm_Photocam_Zoom_Mode
21602 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21603 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21604 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21605 ELM_PHOTOCAM_ZOOM_MODE_LAST
21606 } Elm_Photocam_Zoom_Mode;
21608 * @brief Add a new Photocam object
21610 * @param parent The parent object
21611 * @return The new object or NULL if it cannot be created
21613 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21615 * @brief Set the photo file to be shown
21617 * @param obj The photocam object
21618 * @param file The photo file
21619 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21621 * This sets (and shows) the specified file (with a relative or absolute
21622 * path) and will return a load error (same error that
21623 * evas_object_image_load_error_get() will return). The image will change and
21624 * adjust its size at this point and begin a background load process for this
21625 * photo that at some time in the future will be displayed at the full
21628 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21630 * @brief Returns the path of the current image file
21632 * @param obj The photocam object
21633 * @return Returns the path
21635 * @see elm_photocam_file_set()
21637 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21639 * @brief Set the zoom level of the photo
21641 * @param obj The photocam object
21642 * @param zoom The zoom level to set
21644 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21645 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21646 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21647 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21650 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21652 * @brief Get the zoom level of the photo
21654 * @param obj The photocam object
21655 * @return The current zoom level
21657 * This returns the current zoom level of the photocam object. Note that if
21658 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21659 * (which is the default), the zoom level may be changed at any time by the
21660 * photocam object itself to account for photo size and photocam viewpoer
21663 * @see elm_photocam_zoom_set()
21664 * @see elm_photocam_zoom_mode_set()
21666 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21668 * @brief Set the zoom mode
21670 * @param obj The photocam object
21671 * @param mode The desired mode
21673 * This sets the zoom mode to manual or one of several automatic levels.
21674 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21675 * elm_photocam_zoom_set() and will stay at that level until changed by code
21676 * or until zoom mode is changed. This is the default mode. The Automatic
21677 * modes will allow the photocam object to automatically adjust zoom mode
21678 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21679 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21680 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21681 * pixels within the frame are left unfilled.
21683 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21685 * @brief Get the zoom mode
21687 * @param obj The photocam object
21688 * @return The current zoom mode
21690 * This gets the current zoom mode of the photocam object.
21692 * @see elm_photocam_zoom_mode_set()
21694 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21696 * @brief Get the current image pixel width and height
21698 * @param obj The photocam object
21699 * @param w A pointer to the width return
21700 * @param h A pointer to the height return
21702 * This gets the current photo pixel width and height (for the original).
21703 * The size will be returned in the integers @p w and @p h that are pointed
21706 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21708 * @brief Get the area of the image that is currently shown
21711 * @param x A pointer to the X-coordinate of region
21712 * @param y A pointer to the Y-coordinate of region
21713 * @param w A pointer to the width
21714 * @param h A pointer to the height
21716 * @see elm_photocam_image_region_show()
21717 * @see elm_photocam_image_region_bring_in()
21719 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21721 * @brief Set the viewed portion of the image
21723 * @param obj The photocam object
21724 * @param x X-coordinate of region in image original pixels
21725 * @param y Y-coordinate of region in image original pixels
21726 * @param w Width of region in image original pixels
21727 * @param h Height of region in image original pixels
21729 * This shows the region of the image without using animation.
21731 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21733 * @brief Bring in the viewed portion of the image
21735 * @param obj The photocam object
21736 * @param x X-coordinate of region in image original pixels
21737 * @param y Y-coordinate of region in image original pixels
21738 * @param w Width of region in image original pixels
21739 * @param h Height of region in image original pixels
21741 * This shows the region of the image using animation.
21743 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21745 * @brief Set the paused state for photocam
21747 * @param obj The photocam object
21748 * @param paused The pause state to set
21750 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21751 * photocam. The default is off. This will stop zooming using animation on
21752 * zoom levels changes and change instantly. This will stop any existing
21753 * animations that are running.
21755 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21757 * @brief Get the paused state for photocam
21759 * @param obj The photocam object
21760 * @return The current paused state
21762 * This gets the current paused state for the photocam object.
21764 * @see elm_photocam_paused_set()
21766 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21768 * @brief Get the internal low-res image used for photocam
21770 * @param obj The photocam object
21771 * @return The internal image object handle, or NULL if none exists
21773 * This gets the internal image object inside photocam. Do not modify it. It
21774 * is for inspection only, and hooking callbacks to. Nothing else. It may be
21775 * deleted at any time as well.
21777 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21779 * @brief Set the photocam scrolling bouncing.
21781 * @param obj The photocam object
21782 * @param h_bounce bouncing for horizontal
21783 * @param v_bounce bouncing for vertical
21785 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21787 * @brief Get the photocam scrolling bouncing.
21789 * @param obj The photocam object
21790 * @param h_bounce bouncing for horizontal
21791 * @param v_bounce bouncing for vertical
21793 * @see elm_photocam_bounce_set()
21795 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21801 * @defgroup Map Map
21802 * @ingroup Elementary
21804 * @image html img/widget/map/preview-00.png
21805 * @image latex img/widget/map/preview-00.eps
21807 * This is a widget specifically for displaying a map. It uses basically
21808 * OpenStreetMap provider http://www.openstreetmap.org/,
21809 * but custom providers can be added.
21811 * It supports some basic but yet nice features:
21812 * @li zoom and scroll
21813 * @li markers with content to be displayed when user clicks over it
21814 * @li group of markers
21817 * Smart callbacks one can listen to:
21819 * - "clicked" - This is called when a user has clicked the map without
21821 * - "press" - This is called when a user has pressed down on the map.
21822 * - "longpressed" - This is called when a user has pressed down on the map
21823 * for a long time without dragging around.
21824 * - "clicked,double" - This is called when a user has double-clicked
21826 * - "load,detail" - Map detailed data load begins.
21827 * - "loaded,detail" - This is called when all currently visible parts of
21828 * the map are loaded.
21829 * - "zoom,start" - Zoom animation started.
21830 * - "zoom,stop" - Zoom animation stopped.
21831 * - "zoom,change" - Zoom changed when using an auto zoom mode.
21832 * - "scroll" - the content has been scrolled (moved).
21833 * - "scroll,anim,start" - scrolling animation has started.
21834 * - "scroll,anim,stop" - scrolling animation has stopped.
21835 * - "scroll,drag,start" - dragging the contents around has started.
21836 * - "scroll,drag,stop" - dragging the contents around has stopped.
21837 * - "downloaded" - This is called when all currently required map images
21839 * - "route,load" - This is called when route request begins.
21840 * - "route,loaded" - This is called when route request ends.
21841 * - "name,load" - This is called when name request begins.
21842 * - "name,loaded- This is called when name request ends.
21844 * Available style for map widget:
21847 * Available style for markers:
21852 * Available style for marker bubble:
21855 * List of examples:
21856 * @li @ref map_example_01
21857 * @li @ref map_example_02
21858 * @li @ref map_example_03
21867 * @enum _Elm_Map_Zoom_Mode
21868 * @typedef Elm_Map_Zoom_Mode
21870 * Set map's zoom behavior. It can be set to manual or automatic.
21872 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21874 * Values <b> don't </b> work as bitmask, only one can be choosen.
21876 * @note Valid sizes are 2^zoom, consequently the map may be smaller
21877 * than the scroller view.
21879 * @see elm_map_zoom_mode_set()
21880 * @see elm_map_zoom_mode_get()
21884 typedef enum _Elm_Map_Zoom_Mode
21886 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21887 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21888 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21889 ELM_MAP_ZOOM_MODE_LAST
21890 } Elm_Map_Zoom_Mode;
21893 * @enum _Elm_Map_Route_Sources
21894 * @typedef Elm_Map_Route_Sources
21896 * Set route service to be used. By default used source is
21897 * #ELM_MAP_ROUTE_SOURCE_YOURS.
21899 * @see elm_map_route_source_set()
21900 * @see elm_map_route_source_get()
21904 typedef enum _Elm_Map_Route_Sources
21906 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21907 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. */
21908 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21909 ELM_MAP_ROUTE_SOURCE_LAST
21910 } Elm_Map_Route_Sources;
21912 typedef enum _Elm_Map_Name_Sources
21914 ELM_MAP_NAME_SOURCE_NOMINATIM,
21915 ELM_MAP_NAME_SOURCE_LAST
21916 } Elm_Map_Name_Sources;
21919 * @enum _Elm_Map_Route_Type
21920 * @typedef Elm_Map_Route_Type
21922 * Set type of transport used on route.
21924 * @see elm_map_route_add()
21928 typedef enum _Elm_Map_Route_Type
21930 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21931 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21932 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21933 ELM_MAP_ROUTE_TYPE_LAST
21934 } Elm_Map_Route_Type;
21937 * @enum _Elm_Map_Route_Method
21938 * @typedef Elm_Map_Route_Method
21940 * Set the routing method, what should be priorized, time or distance.
21942 * @see elm_map_route_add()
21946 typedef enum _Elm_Map_Route_Method
21948 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21949 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21950 ELM_MAP_ROUTE_METHOD_LAST
21951 } Elm_Map_Route_Method;
21953 typedef enum _Elm_Map_Name_Method
21955 ELM_MAP_NAME_METHOD_SEARCH,
21956 ELM_MAP_NAME_METHOD_REVERSE,
21957 ELM_MAP_NAME_METHOD_LAST
21958 } Elm_Map_Name_Method;
21960 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(). */
21961 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(). */
21962 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(). */
21963 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(). */
21964 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
21965 typedef struct _Elm_Map_Track Elm_Map_Track;
21967 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. */
21968 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21969 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21970 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21972 typedef char *(*ElmMapModuleSourceFunc) (void);
21973 typedef int (*ElmMapModuleZoomMinFunc) (void);
21974 typedef int (*ElmMapModuleZoomMaxFunc) (void);
21975 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21976 typedef int (*ElmMapModuleRouteSourceFunc) (void);
21977 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21978 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21979 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21980 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21983 * Add a new map widget to the given parent Elementary (container) object.
21985 * @param parent The parent object.
21986 * @return a new map widget handle or @c NULL, on errors.
21988 * This function inserts a new map widget on the canvas.
21992 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21995 * Set the zoom level of the map.
21997 * @param obj The map object.
21998 * @param zoom The zoom level to set.
22000 * This sets the zoom level.
22002 * It will respect limits defined by elm_map_source_zoom_min_set() and
22003 * elm_map_source_zoom_max_set().
22005 * By default these values are 0 (world map) and 18 (maximum zoom).
22007 * This function should be used when zoom mode is set to
22008 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22009 * with elm_map_zoom_mode_set().
22011 * @see elm_map_zoom_mode_set().
22012 * @see elm_map_zoom_get().
22016 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22019 * Get the zoom level of the map.
22021 * @param obj The map object.
22022 * @return The current zoom level.
22024 * This returns the current zoom level of the map object.
22026 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22027 * (which is the default), the zoom level may be changed at any time by the
22028 * map object itself to account for map size and map viewport size.
22030 * @see elm_map_zoom_set() for details.
22034 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22037 * Set the zoom mode used by the map object.
22039 * @param obj The map object.
22040 * @param mode The zoom mode of the map, being it one of
22041 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22042 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22044 * This sets the zoom mode to manual or one of the automatic levels.
22045 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22046 * elm_map_zoom_set() and will stay at that level until changed by code
22047 * or until zoom mode is changed. This is the default mode.
22049 * The Automatic modes will allow the map object to automatically
22050 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22051 * adjust zoom so the map fits inside the scroll frame with no pixels
22052 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22053 * ensure no pixels within the frame are left unfilled. Do not forget that
22054 * the valid sizes are 2^zoom, consequently the map may be smaller than
22055 * the scroller view.
22057 * @see elm_map_zoom_set()
22061 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22064 * Get the zoom mode used by the map object.
22066 * @param obj The map object.
22067 * @return The zoom mode of the map, being it one of
22068 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22069 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22071 * This function returns the current zoom mode used by the map object.
22073 * @see elm_map_zoom_mode_set() for more details.
22077 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22080 * Get the current coordinates of the map.
22082 * @param obj The map object.
22083 * @param lon Pointer where to store longitude.
22084 * @param lat Pointer where to store latitude.
22086 * This gets the current center coordinates of the map object. It can be
22087 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22089 * @see elm_map_geo_region_bring_in()
22090 * @see elm_map_geo_region_show()
22094 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22097 * Animatedly bring in given coordinates to the center of the map.
22099 * @param obj The map object.
22100 * @param lon Longitude to center at.
22101 * @param lat Latitude to center at.
22103 * This causes map to jump to the given @p lat and @p lon coordinates
22104 * and show it (by scrolling) in the center of the viewport, if it is not
22105 * already centered. This will use animation to do so and take a period
22106 * of time to complete.
22108 * @see elm_map_geo_region_show() for a function to avoid animation.
22109 * @see elm_map_geo_region_get()
22113 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22116 * Show the given coordinates at the center of the map, @b immediately.
22118 * @param obj The map object.
22119 * @param lon Longitude to center at.
22120 * @param lat Latitude to center at.
22122 * This causes map to @b redraw its viewport's contents to the
22123 * region contining the given @p lat and @p lon, that will be moved to the
22124 * center of the map.
22126 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22127 * @see elm_map_geo_region_get()
22131 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22134 * Pause or unpause the map.
22136 * @param obj The map object.
22137 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22140 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22143 * The default is off.
22145 * This will stop zooming using animation, changing zoom levels will
22146 * change instantly. This will stop any existing animations that are running.
22148 * @see elm_map_paused_get()
22152 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22155 * Get a value whether map is paused or not.
22157 * @param obj The map object.
22158 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22159 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22161 * This gets the current paused state for the map object.
22163 * @see elm_map_paused_set() for details.
22167 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22170 * Set to show markers during zoom level changes or not.
22172 * @param obj The map object.
22173 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22176 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22179 * The default is off.
22181 * This will stop zooming using animation, changing zoom levels will
22182 * change instantly. This will stop any existing animations that are running.
22184 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22187 * The default is off.
22189 * Enabling it will force the map to stop displaying the markers during
22190 * zoom level changes. Set to on if you have a large number of markers.
22192 * @see elm_map_paused_markers_get()
22196 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22199 * Get a value whether markers will be displayed on zoom level changes or not
22201 * @param obj The map object.
22202 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22203 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22205 * This gets the current markers paused state for the map object.
22207 * @see elm_map_paused_markers_set() for details.
22211 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22214 * Get the information of downloading status.
22216 * @param obj The map object.
22217 * @param try_num Pointer where to store number of tiles being downloaded.
22218 * @param finish_num Pointer where to store number of tiles successfully
22221 * This gets the current downloading status for the map object, the number
22222 * of tiles being downloaded and the number of tiles already downloaded.
22226 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22229 * Convert a pixel coordinate (x,y) into a geographic coordinate
22230 * (longitude, latitude).
22232 * @param obj The map object.
22233 * @param x the coordinate.
22234 * @param y the coordinate.
22235 * @param size the size in pixels of the map.
22236 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22237 * @param lon Pointer where to store the longitude that correspond to x.
22238 * @param lat Pointer where to store the latitude that correspond to y.
22240 * @note Origin pixel point is the top left corner of the viewport.
22241 * Map zoom and size are taken on account.
22243 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22247 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);
22250 * Convert a geographic coordinate (longitude, latitude) into a pixel
22251 * coordinate (x, y).
22253 * @param obj The map object.
22254 * @param lon the longitude.
22255 * @param lat the latitude.
22256 * @param size the size in pixels of the map. The map is a square
22257 * and generally his size is : pow(2.0, zoom)*256.
22258 * @param x Pointer where to store the horizontal pixel coordinate that
22259 * correspond to the longitude.
22260 * @param y Pointer where to store the vertical pixel coordinate that
22261 * correspond to the latitude.
22263 * @note Origin pixel point is the top left corner of the viewport.
22264 * Map zoom and size are taken on account.
22266 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22270 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);
22273 * Convert a geographic coordinate (longitude, latitude) into a name
22276 * @param obj The map object.
22277 * @param lon the longitude.
22278 * @param lat the latitude.
22279 * @return name A #Elm_Map_Name handle for this coordinate.
22281 * To get the string for this address, elm_map_name_address_get()
22284 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22288 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22291 * Convert a name (address) into a geographic coordinate
22292 * (longitude, latitude).
22294 * @param obj The map object.
22295 * @param name The address.
22296 * @return name A #Elm_Map_Name handle for this address.
22298 * To get the longitude and latitude, elm_map_name_region_get()
22301 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22305 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22308 * Convert a pixel coordinate into a rotated pixel coordinate.
22310 * @param obj The map object.
22311 * @param x horizontal coordinate of the point to rotate.
22312 * @param y vertical coordinate of the point to rotate.
22313 * @param cx rotation's center horizontal position.
22314 * @param cy rotation's center vertical position.
22315 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22316 * @param xx Pointer where to store rotated x.
22317 * @param yy Pointer where to store rotated y.
22321 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);
22324 * Add a new marker to the map object.
22326 * @param obj The map object.
22327 * @param lon The longitude of the marker.
22328 * @param lat The latitude of the marker.
22329 * @param clas The class, to use when marker @b isn't grouped to others.
22330 * @param clas_group The class group, to use when marker is grouped to others
22331 * @param data The data passed to the callbacks.
22333 * @return The created marker or @c NULL upon failure.
22335 * A marker will be created and shown in a specific point of the map, defined
22336 * by @p lon and @p lat.
22338 * It will be displayed using style defined by @p class when this marker
22339 * is displayed alone (not grouped). A new class can be created with
22340 * elm_map_marker_class_new().
22342 * If the marker is grouped to other markers, it will be displayed with
22343 * style defined by @p class_group. Markers with the same group are grouped
22344 * if they are close. A new group class can be created with
22345 * elm_map_marker_group_class_new().
22347 * Markers created with this method can be deleted with
22348 * elm_map_marker_remove().
22350 * A marker can have associated content to be displayed by a bubble,
22351 * when a user click over it, as well as an icon. These objects will
22352 * be fetch using class' callback functions.
22354 * @see elm_map_marker_class_new()
22355 * @see elm_map_marker_group_class_new()
22356 * @see elm_map_marker_remove()
22360 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);
22363 * Set the maximum numbers of markers' content to be displayed in a group.
22365 * @param obj The map object.
22366 * @param max The maximum numbers of items displayed in a bubble.
22368 * A bubble will be displayed when the user clicks over the group,
22369 * and will place the content of markers that belong to this group
22372 * A group can have a long list of markers, consequently the creation
22373 * of the content of the bubble can be very slow.
22375 * In order to avoid this, a maximum number of items is displayed
22378 * By default this number is 30.
22380 * Marker with the same group class are grouped if they are close.
22382 * @see elm_map_marker_add()
22386 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22389 * Remove a marker from the map.
22391 * @param marker The marker to remove.
22393 * @see elm_map_marker_add()
22397 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22400 * Get the current coordinates of the marker.
22402 * @param marker marker.
22403 * @param lat Pointer where to store the marker's latitude.
22404 * @param lon Pointer where to store the marker's longitude.
22406 * These values are set when adding markers, with function
22407 * elm_map_marker_add().
22409 * @see elm_map_marker_add()
22413 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22416 * Animatedly bring in given marker to the center of the map.
22418 * @param marker The marker to center at.
22420 * This causes map to jump to the given @p marker's coordinates
22421 * and show it (by scrolling) in the center of the viewport, if it is not
22422 * already centered. This will use animation to do so and take a period
22423 * of time to complete.
22425 * @see elm_map_marker_show() for a function to avoid animation.
22426 * @see elm_map_marker_region_get()
22430 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22433 * Show the given marker at the center of the map, @b immediately.
22435 * @param marker The marker to center at.
22437 * This causes map to @b redraw its viewport's contents to the
22438 * region contining the given @p marker's coordinates, that will be
22439 * moved to the center of the map.
22441 * @see elm_map_marker_bring_in() for a function to move with animation.
22442 * @see elm_map_markers_list_show() if more than one marker need to be
22444 * @see elm_map_marker_region_get()
22448 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22451 * Move and zoom the map to display a list of markers.
22453 * @param markers A list of #Elm_Map_Marker handles.
22455 * The map will be centered on the center point of the markers in the list.
22456 * Then the map will be zoomed in order to fit the markers using the maximum
22457 * zoom which allows display of all the markers.
22459 * @warning All the markers should belong to the same map object.
22461 * @see elm_map_marker_show() to show a single marker.
22462 * @see elm_map_marker_bring_in()
22466 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22469 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22471 * @param marker The marker wich content should be returned.
22472 * @return Return the evas object if it exists, else @c NULL.
22474 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22475 * elm_map_marker_class_get_cb_set() should be used.
22477 * This content is what will be inside the bubble that will be displayed
22478 * when an user clicks over the marker.
22480 * This returns the actual Evas object used to be placed inside
22481 * the bubble. This may be @c NULL, as it may
22482 * not have been created or may have been deleted, at any time, by
22483 * the map. <b>Do not modify this object</b> (move, resize,
22484 * show, hide, etc.), as the map is controlling it. This
22485 * function is for querying, emitting custom signals or hooking
22486 * lower level callbacks for events on that object. Do not delete
22487 * this object under any circumstances.
22491 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22494 * Update the marker
22496 * @param marker The marker to be updated.
22498 * If a content is set to this marker, it will call function to delete it,
22499 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22500 * #ElmMapMarkerGetFunc.
22502 * These functions are set for the marker class with
22503 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22507 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22510 * Close all the bubbles opened by the user.
22512 * @param obj The map object.
22514 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22515 * when the user clicks on a marker.
22517 * This functions is set for the marker class with
22518 * elm_map_marker_class_get_cb_set().
22522 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22525 * Create a new group class.
22527 * @param obj The map object.
22528 * @return Returns the new group class.
22530 * Each marker must be associated to a group class. Markers in the same
22531 * group are grouped if they are close.
22533 * The group class defines the style of the marker when a marker is grouped
22534 * to others markers. When it is alone, another class will be used.
22536 * A group class will need to be provided when creating a marker with
22537 * elm_map_marker_add().
22539 * Some properties and functions can be set by class, as:
22540 * - style, with elm_map_group_class_style_set()
22541 * - data - to be associated to the group class. It can be set using
22542 * elm_map_group_class_data_set().
22543 * - min zoom to display markers, set with
22544 * elm_map_group_class_zoom_displayed_set().
22545 * - max zoom to group markers, set using
22546 * elm_map_group_class_zoom_grouped_set().
22547 * - visibility - set if markers will be visible or not, set with
22548 * elm_map_group_class_hide_set().
22549 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22550 * It can be set using elm_map_group_class_icon_cb_set().
22552 * @see elm_map_marker_add()
22553 * @see elm_map_group_class_style_set()
22554 * @see elm_map_group_class_data_set()
22555 * @see elm_map_group_class_zoom_displayed_set()
22556 * @see elm_map_group_class_zoom_grouped_set()
22557 * @see elm_map_group_class_hide_set()
22558 * @see elm_map_group_class_icon_cb_set()
22562 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22565 * Set the marker's style of a group class.
22567 * @param clas The group class.
22568 * @param style The style to be used by markers.
22570 * Each marker must be associated to a group class, and will use the style
22571 * defined by such class when grouped to other markers.
22573 * The following styles are provided by default theme:
22574 * @li @c radio - blue circle
22575 * @li @c radio2 - green circle
22578 * @see elm_map_group_class_new() for more details.
22579 * @see elm_map_marker_add()
22583 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22586 * Set the icon callback function of a group class.
22588 * @param clas The group class.
22589 * @param icon_get The callback function that will return the icon.
22591 * Each marker must be associated to a group class, and it can display a
22592 * custom icon. The function @p icon_get must return this icon.
22594 * @see elm_map_group_class_new() for more details.
22595 * @see elm_map_marker_add()
22599 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22602 * Set the data associated to the group class.
22604 * @param clas The group class.
22605 * @param data The new user data.
22607 * This data will be passed for callback functions, like icon get callback,
22608 * that can be set with elm_map_group_class_icon_cb_set().
22610 * If a data was previously set, the object will lose the pointer for it,
22611 * so if needs to be freed, you must do it yourself.
22613 * @see elm_map_group_class_new() for more details.
22614 * @see elm_map_group_class_icon_cb_set()
22615 * @see elm_map_marker_add()
22619 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22622 * Set the minimum zoom from where the markers are displayed.
22624 * @param clas The group class.
22625 * @param zoom The minimum zoom.
22627 * Markers only will be displayed when the map is displayed at @p zoom
22630 * @see elm_map_group_class_new() for more details.
22631 * @see elm_map_marker_add()
22635 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22638 * Set the zoom from where the markers are no more grouped.
22640 * @param clas The group class.
22641 * @param zoom The maximum zoom.
22643 * Markers only will be grouped when the map is displayed at
22644 * less than @p zoom.
22646 * @see elm_map_group_class_new() for more details.
22647 * @see elm_map_marker_add()
22651 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22654 * Set if the markers associated to the group class @clas are hidden or not.
22656 * @param clas The group class.
22657 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22660 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22665 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22668 * Create a new marker class.
22670 * @param obj The map object.
22671 * @return Returns the new group class.
22673 * Each marker must be associated to a class.
22675 * The marker class defines the style of the marker when a marker is
22676 * displayed alone, i.e., not grouped to to others markers. When grouped
22677 * it will use group class style.
22679 * A marker class will need to be provided when creating a marker with
22680 * elm_map_marker_add().
22682 * Some properties and functions can be set by class, as:
22683 * - style, with elm_map_marker_class_style_set()
22684 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22685 * It can be set using elm_map_marker_class_icon_cb_set().
22686 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22687 * Set using elm_map_marker_class_get_cb_set().
22688 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22689 * Set using elm_map_marker_class_del_cb_set().
22691 * @see elm_map_marker_add()
22692 * @see elm_map_marker_class_style_set()
22693 * @see elm_map_marker_class_icon_cb_set()
22694 * @see elm_map_marker_class_get_cb_set()
22695 * @see elm_map_marker_class_del_cb_set()
22699 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22702 * Set the marker's style of a marker class.
22704 * @param clas The marker class.
22705 * @param style The style to be used by markers.
22707 * Each marker must be associated to a marker class, and will use the style
22708 * defined by such class when alone, i.e., @b not grouped to other markers.
22710 * The following styles are provided by default theme:
22715 * @see elm_map_marker_class_new() for more details.
22716 * @see elm_map_marker_add()
22720 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22723 * Set the icon callback function of a marker class.
22725 * @param clas The marker class.
22726 * @param icon_get The callback function that will return the icon.
22728 * Each marker must be associated to a marker class, and it can display a
22729 * custom icon. The function @p icon_get must return this icon.
22731 * @see elm_map_marker_class_new() for more details.
22732 * @see elm_map_marker_add()
22736 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22739 * Set the bubble content callback function of a marker class.
22741 * @param clas The marker class.
22742 * @param get The callback function that will return the content.
22744 * Each marker must be associated to a marker class, and it can display a
22745 * a content on a bubble that opens when the user click over the marker.
22746 * The function @p get must return this content object.
22748 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22751 * @see elm_map_marker_class_new() for more details.
22752 * @see elm_map_marker_class_del_cb_set()
22753 * @see elm_map_marker_add()
22757 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22760 * Set the callback function used to delete bubble content of a marker class.
22762 * @param clas The marker class.
22763 * @param del The callback function that will delete the content.
22765 * Each marker must be associated to a marker class, and it can display a
22766 * a content on a bubble that opens when the user click over the marker.
22767 * The function to return such content can be set with
22768 * elm_map_marker_class_get_cb_set().
22770 * If this content must be freed, a callback function need to be
22771 * set for that task with this function.
22773 * If this callback is defined it will have to delete (or not) the
22774 * object inside, but if the callback is not defined the object will be
22775 * destroyed with evas_object_del().
22777 * @see elm_map_marker_class_new() for more details.
22778 * @see elm_map_marker_class_get_cb_set()
22779 * @see elm_map_marker_add()
22783 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22786 * Get the list of available sources.
22788 * @param obj The map object.
22789 * @return The source names list.
22791 * It will provide a list with all available sources, that can be set as
22792 * current source with elm_map_source_name_set(), or get with
22793 * elm_map_source_name_get().
22795 * Available sources:
22801 * @see elm_map_source_name_set() for more details.
22802 * @see elm_map_source_name_get()
22806 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22809 * Set the source of the map.
22811 * @param obj The map object.
22812 * @param source The source to be used.
22814 * Map widget retrieves images that composes the map from a web service.
22815 * This web service can be set with this method.
22817 * A different service can return a different maps with different
22818 * information and it can use different zoom values.
22820 * The @p source_name need to match one of the names provided by
22821 * elm_map_source_names_get().
22823 * The current source can be get using elm_map_source_name_get().
22825 * @see elm_map_source_names_get()
22826 * @see elm_map_source_name_get()
22831 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22834 * Get the name of currently used source.
22836 * @param obj The map object.
22837 * @return Returns the name of the source in use.
22839 * @see elm_map_source_name_set() for more details.
22843 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22846 * Set the source of the route service to be used by the map.
22848 * @param obj The map object.
22849 * @param source The route service to be used, being it one of
22850 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22851 * and #ELM_MAP_ROUTE_SOURCE_ORS.
22853 * Each one has its own algorithm, so the route retrieved may
22854 * differ depending on the source route. Now, only the default is working.
22856 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22857 * http://www.yournavigation.org/.
22859 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22860 * assumptions. Its routing core is based on Contraction Hierarchies.
22862 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22864 * @see elm_map_route_source_get().
22868 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22871 * Get the current route source.
22873 * @param obj The map object.
22874 * @return The source of the route service used by the map.
22876 * @see elm_map_route_source_set() for details.
22880 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22883 * Set the minimum zoom of the source.
22885 * @param obj The map object.
22886 * @param zoom New minimum zoom value to be used.
22888 * By default, it's 0.
22892 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22895 * Get the minimum zoom of the source.
22897 * @param obj The map object.
22898 * @return Returns the minimum zoom of the source.
22900 * @see elm_map_source_zoom_min_set() for details.
22904 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22907 * Set the maximum zoom of the source.
22909 * @param obj The map object.
22910 * @param zoom New maximum zoom value to be used.
22912 * By default, it's 18.
22916 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22919 * Get the maximum zoom of the source.
22921 * @param obj The map object.
22922 * @return Returns the maximum zoom of the source.
22924 * @see elm_map_source_zoom_min_set() for details.
22928 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22931 * Set the user agent used by the map object to access routing services.
22933 * @param obj The map object.
22934 * @param user_agent The user agent to be used by the map.
22936 * User agent is a client application implementing a network protocol used
22937 * in communications within a client–server distributed computing system
22939 * The @p user_agent identification string will transmitted in a header
22940 * field @c User-Agent.
22942 * @see elm_map_user_agent_get()
22946 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22949 * Get the user agent used by the map object.
22951 * @param obj The map object.
22952 * @return The user agent identification string used by the map.
22954 * @see elm_map_user_agent_set() for details.
22958 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22961 * Add a new route to the map object.
22963 * @param obj The map object.
22964 * @param type The type of transport to be considered when tracing a route.
22965 * @param method The routing method, what should be priorized.
22966 * @param flon The start longitude.
22967 * @param flat The start latitude.
22968 * @param tlon The destination longitude.
22969 * @param tlat The destination latitude.
22971 * @return The created route or @c NULL upon failure.
22973 * A route will be traced by point on coordinates (@p flat, @p flon)
22974 * to point on coordinates (@p tlat, @p tlon), using the route service
22975 * set with elm_map_route_source_set().
22977 * It will take @p type on consideration to define the route,
22978 * depending if the user will be walking or driving, the route may vary.
22979 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22980 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22982 * Another parameter is what the route should priorize, the minor distance
22983 * or the less time to be spend on the route. So @p method should be one
22984 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22986 * Routes created with this method can be deleted with
22987 * elm_map_route_remove(), colored with elm_map_route_color_set(),
22988 * and distance can be get with elm_map_route_distance_get().
22990 * @see elm_map_route_remove()
22991 * @see elm_map_route_color_set()
22992 * @see elm_map_route_distance_get()
22993 * @see elm_map_route_source_set()
22997 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);
23000 * Remove a route from the map.
23002 * @param route The route to remove.
23004 * @see elm_map_route_add()
23008 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23011 * Set the route color.
23013 * @param route The route object.
23014 * @param r Red channel value, from 0 to 255.
23015 * @param g Green channel value, from 0 to 255.
23016 * @param b Blue channel value, from 0 to 255.
23017 * @param a Alpha channel value, from 0 to 255.
23019 * It uses an additive color model, so each color channel represents
23020 * how much of each primary colors must to be used. 0 represents
23021 * ausence of this color, so if all of the three are set to 0,
23022 * the color will be black.
23024 * These component values should be integers in the range 0 to 255,
23025 * (single 8-bit byte).
23027 * This sets the color used for the route. By default, it is set to
23028 * solid red (r = 255, g = 0, b = 0, a = 255).
23030 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23032 * @see elm_map_route_color_get()
23036 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23039 * Get the route color.
23041 * @param route The route object.
23042 * @param r Pointer where to store the red channel value.
23043 * @param g Pointer where to store the green channel value.
23044 * @param b Pointer where to store the blue channel value.
23045 * @param a Pointer where to store the alpha channel value.
23047 * @see elm_map_route_color_set() for details.
23051 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23054 * Get the route distance in kilometers.
23056 * @param route The route object.
23057 * @return The distance of route (unit : km).
23061 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23064 * Get the information of route nodes.
23066 * @param route The route object.
23067 * @return Returns a string with the nodes of route.
23071 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23074 * Get the information of route waypoint.
23076 * @param route the route object.
23077 * @return Returns a string with information about waypoint of route.
23081 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23084 * Get the address of the name.
23086 * @param name The name handle.
23087 * @return Returns the address string of @p name.
23089 * This gets the coordinates of the @p name, created with one of the
23090 * conversion functions.
23092 * @see elm_map_utils_convert_name_into_coord()
23093 * @see elm_map_utils_convert_coord_into_name()
23097 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23100 * Get the current coordinates of the name.
23102 * @param name The name handle.
23103 * @param lat Pointer where to store the latitude.
23104 * @param lon Pointer where to store The longitude.
23106 * This gets the coordinates of the @p name, created with one of the
23107 * conversion functions.
23109 * @see elm_map_utils_convert_name_into_coord()
23110 * @see elm_map_utils_convert_coord_into_name()
23114 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23117 * Remove a name from the map.
23119 * @param name The name to remove.
23121 * Basically the struct handled by @p name will be freed, so convertions
23122 * between address and coordinates will be lost.
23124 * @see elm_map_utils_convert_name_into_coord()
23125 * @see elm_map_utils_convert_coord_into_name()
23129 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23134 * @param obj The map object.
23135 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23136 * @param cx Rotation's center horizontal position.
23137 * @param cy Rotation's center vertical position.
23139 * @see elm_map_rotate_get()
23143 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23146 * Get the rotate degree of the map
23148 * @param obj The map object
23149 * @param degree Pointer where to store degrees from 0.0 to 360.0
23150 * to rotate arount Z axis.
23151 * @param cx Pointer where to store rotation's center horizontal position.
23152 * @param cy Pointer where to store rotation's center vertical position.
23154 * @see elm_map_rotate_set() to set map rotation.
23158 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);
23161 * Enable or disable mouse wheel to be used to zoom in / out the map.
23163 * @param obj The map object.
23164 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23167 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23169 * It's disabled by default.
23171 * @see elm_map_wheel_disabled_get()
23175 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23178 * Get a value whether mouse wheel is enabled or not.
23180 * @param obj The map object.
23181 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23182 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23184 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23186 * @see elm_map_wheel_disabled_set() for details.
23190 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23194 * Add a track on the map
23196 * @param obj The map object.
23197 * @param emap The emap route object.
23198 * @return The route object. This is an elm object of type Route.
23200 * @see elm_route_add() for details.
23204 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23208 * Remove a track from the map
23210 * @param obj The map object.
23211 * @param route The track to remove.
23215 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23222 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23224 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23226 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23227 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23228 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23229 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23233 * @defgroup Panel Panel
23235 * @image html img/widget/panel/preview-00.png
23236 * @image latex img/widget/panel/preview-00.eps
23238 * @brief A panel is a type of animated container that contains subobjects.
23239 * It can be expanded or contracted by clicking the button on it's edge.
23241 * Orientations are as follows:
23242 * @li ELM_PANEL_ORIENT_TOP
23243 * @li ELM_PANEL_ORIENT_LEFT
23244 * @li ELM_PANEL_ORIENT_RIGHT
23246 * @ref tutorial_panel shows one way to use this widget.
23249 typedef enum _Elm_Panel_Orient
23251 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23252 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23253 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23254 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23255 } Elm_Panel_Orient;
23257 * @brief Adds a panel object
23259 * @param parent The parent object
23261 * @return The panel object, or NULL on failure
23263 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23265 * @brief Sets the orientation of the panel
23267 * @param parent The parent object
23268 * @param orient The panel orientation. Can be one of the following:
23269 * @li ELM_PANEL_ORIENT_TOP
23270 * @li ELM_PANEL_ORIENT_LEFT
23271 * @li ELM_PANEL_ORIENT_RIGHT
23273 * Sets from where the panel will (dis)appear.
23275 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23277 * @brief Get the orientation of the panel.
23279 * @param obj The panel object
23280 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23282 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23284 * @brief Set the content of the panel.
23286 * @param obj The panel object
23287 * @param content The panel content
23289 * Once the content object is set, a previously set one will be deleted.
23290 * If you want to keep that old content object, use the
23291 * elm_panel_content_unset() function.
23293 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23295 * @brief Get the content of the panel.
23297 * @param obj The panel object
23298 * @return The content that is being used
23300 * Return the content object which is set for this widget.
23302 * @see elm_panel_content_set()
23304 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23306 * @brief Unset the content of the panel.
23308 * @param obj The panel object
23309 * @return The content that was being used
23311 * Unparent and return the content object which was set for this widget.
23313 * @see elm_panel_content_set()
23315 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23317 * @brief Set the state of the panel.
23319 * @param obj The panel object
23320 * @param hidden If true, the panel will run the animation to contract
23322 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23324 * @brief Get the state of the panel.
23326 * @param obj The panel object
23327 * @param hidden If true, the panel is in the "hide" state
23329 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23331 * @brief Toggle the hidden state of the panel from code
23333 * @param obj The panel object
23335 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23341 * @defgroup Panes Panes
23342 * @ingroup Elementary
23344 * @image html img/widget/panes/preview-00.png
23345 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23347 * @image html img/panes.png
23348 * @image latex img/panes.eps width=\textwidth
23350 * The panes adds a dragable bar between two contents. When dragged
23351 * this bar will resize contents size.
23353 * Panes can be displayed vertically or horizontally, and contents
23354 * size proportion can be customized (homogeneous by default).
23356 * Smart callbacks one can listen to:
23357 * - "press" - The panes has been pressed (button wasn't released yet).
23358 * - "unpressed" - The panes was released after being pressed.
23359 * - "clicked" - The panes has been clicked>
23360 * - "clicked,double" - The panes has been double clicked
23362 * Available styles for it:
23365 * Here is an example on its usage:
23366 * @li @ref panes_example
23370 * @addtogroup Panes
23375 * Add a new panes widget to the given parent Elementary
23376 * (container) object.
23378 * @param parent The parent object.
23379 * @return a new panes widget handle or @c NULL, on errors.
23381 * This function inserts a new panes widget on the canvas.
23385 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23388 * Set the left content of the panes widget.
23390 * @param obj The panes object.
23391 * @param content The new left content object.
23393 * Once the content object is set, a previously set one will be deleted.
23394 * If you want to keep that old content object, use the
23395 * elm_panes_content_left_unset() function.
23397 * If panes is displayed vertically, left content will be displayed at
23400 * @see elm_panes_content_left_get()
23401 * @see elm_panes_content_right_set() to set content on the other side.
23405 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23408 * Set the right content of the panes widget.
23410 * @param obj The panes object.
23411 * @param content The new right content object.
23413 * Once the content object is set, a previously set one will be deleted.
23414 * If you want to keep that old content object, use the
23415 * elm_panes_content_right_unset() function.
23417 * If panes is displayed vertically, left content will be displayed at
23420 * @see elm_panes_content_right_get()
23421 * @see elm_panes_content_left_set() to set content on the other side.
23425 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23428 * Get the left content of the panes.
23430 * @param obj The panes object.
23431 * @return The left content object that is being used.
23433 * Return the left content object which is set for this widget.
23435 * @see elm_panes_content_left_set() for details.
23439 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23442 * Get the right content of the panes.
23444 * @param obj The panes object
23445 * @return The right content object that is being used
23447 * Return the right content object which is set for this widget.
23449 * @see elm_panes_content_right_set() for details.
23453 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23456 * Unset the left content used for the panes.
23458 * @param obj The panes object.
23459 * @return The left content object that was being used.
23461 * Unparent and return the left content object which was set for this widget.
23463 * @see elm_panes_content_left_set() for details.
23464 * @see elm_panes_content_left_get().
23468 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23471 * Unset the right content used for the panes.
23473 * @param obj The panes object.
23474 * @return The right content object that was being used.
23476 * Unparent and return the right content object which was set for this
23479 * @see elm_panes_content_right_set() for details.
23480 * @see elm_panes_content_right_get().
23484 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23487 * Get the size proportion of panes widget's left side.
23489 * @param obj The panes object.
23490 * @return float value between 0.0 and 1.0 representing size proportion
23493 * @see elm_panes_content_left_size_set() for more details.
23497 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23500 * Set the size proportion of panes widget's left side.
23502 * @param obj The panes object.
23503 * @param size Value between 0.0 and 1.0 representing size proportion
23506 * By default it's homogeneous, i.e., both sides have the same size.
23508 * If something different is required, it can be set with this function.
23509 * For example, if the left content should be displayed over
23510 * 75% of the panes size, @p size should be passed as @c 0.75.
23511 * This way, right content will be resized to 25% of panes size.
23513 * If displayed vertically, left content is displayed at top, and
23514 * right content at bottom.
23516 * @note This proportion will change when user drags the panes bar.
23518 * @see elm_panes_content_left_size_get()
23522 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23525 * Set the orientation of a given panes widget.
23527 * @param obj The panes object.
23528 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23529 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23531 * Use this function to change how your panes is to be
23532 * disposed: vertically or horizontally.
23534 * By default it's displayed horizontally.
23536 * @see elm_panes_horizontal_get()
23540 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23543 * Retrieve the orientation of a given panes widget.
23545 * @param obj The panes object.
23546 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23547 * @c EINA_FALSE if it's @b vertical (and on errors).
23549 * @see elm_panes_horizontal_set() for more details.
23553 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23560 * @defgroup Flip Flip
23562 * @image html img/widget/flip/preview-00.png
23563 * @image latex img/widget/flip/preview-00.eps
23565 * This widget holds 2 content objects(Evas_Object): one on the front and one
23566 * on the back. It allows you to flip from front to back and vice-versa using
23567 * various animations.
23569 * If either the front or back contents are not set the flip will treat that
23570 * as transparent. So if you wore to set the front content but not the back,
23571 * and then call elm_flip_go() you would see whatever is below the flip.
23573 * For a list of supported animations see elm_flip_go().
23575 * Signals that you can add callbacks for are:
23576 * "animate,begin" - when a flip animation was started
23577 * "animate,done" - when a flip animation is finished
23579 * @ref tutorial_flip show how to use most of the API.
23583 typedef enum _Elm_Flip_Mode
23585 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23586 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23587 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23588 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23589 ELM_FLIP_CUBE_LEFT,
23590 ELM_FLIP_CUBE_RIGHT,
23592 ELM_FLIP_CUBE_DOWN,
23593 ELM_FLIP_PAGE_LEFT,
23594 ELM_FLIP_PAGE_RIGHT,
23598 typedef enum _Elm_Flip_Interaction
23600 ELM_FLIP_INTERACTION_NONE,
23601 ELM_FLIP_INTERACTION_ROTATE,
23602 ELM_FLIP_INTERACTION_CUBE,
23603 ELM_FLIP_INTERACTION_PAGE
23604 } Elm_Flip_Interaction;
23605 typedef enum _Elm_Flip_Direction
23607 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23608 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23609 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23610 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23611 } Elm_Flip_Direction;
23613 * @brief Add a new flip to the parent
23615 * @param parent The parent object
23616 * @return The new object or NULL if it cannot be created
23618 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23620 * @brief Set the front content of the flip widget.
23622 * @param obj The flip object
23623 * @param content The new front content object
23625 * Once the content object is set, a previously set one will be deleted.
23626 * If you want to keep that old content object, use the
23627 * elm_flip_content_front_unset() function.
23629 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23631 * @brief Set the back content of the flip widget.
23633 * @param obj The flip object
23634 * @param content The new back content object
23636 * Once the content object is set, a previously set one will be deleted.
23637 * If you want to keep that old content object, use the
23638 * elm_flip_content_back_unset() function.
23640 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23642 * @brief Get the front content used for the flip
23644 * @param obj The flip object
23645 * @return The front content object that is being used
23647 * Return the front content object which is set for this widget.
23649 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23651 * @brief Get the back content used for the flip
23653 * @param obj The flip object
23654 * @return The back content object that is being used
23656 * Return the back content object which is set for this widget.
23658 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23660 * @brief Unset the front content used for the flip
23662 * @param obj The flip object
23663 * @return The front content object that was being used
23665 * Unparent and return the front content object which was set for this widget.
23667 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23669 * @brief Unset the back content used for the flip
23671 * @param obj The flip object
23672 * @return The back content object that was being used
23674 * Unparent and return the back content object which was set for this widget.
23676 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23678 * @brief Get flip front visibility state
23680 * @param obj The flip objct
23681 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23684 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23686 * @brief Set flip perspective
23688 * @param obj The flip object
23689 * @param foc The coordinate to set the focus on
23690 * @param x The X coordinate
23691 * @param y The Y coordinate
23693 * @warning This function currently does nothing.
23695 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23697 * @brief Runs the flip animation
23699 * @param obj The flip object
23700 * @param mode The mode type
23702 * Flips the front and back contents using the @p mode animation. This
23703 * efectively hides the currently visible content and shows the hidden one.
23705 * There a number of possible animations to use for the flipping:
23706 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23707 * around a horizontal axis in the middle of its height, the other content
23708 * is shown as the other side of the flip.
23709 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23710 * around a vertical axis in the middle of its width, the other content is
23711 * shown as the other side of the flip.
23712 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23713 * around a diagonal axis in the middle of its width, the other content is
23714 * shown as the other side of the flip.
23715 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23716 * around a diagonal axis in the middle of its height, the other content is
23717 * shown as the other side of the flip.
23718 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23719 * as if the flip was a cube, the other content is show as the right face of
23721 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23722 * right as if the flip was a cube, the other content is show as the left
23723 * face of the cube.
23724 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23725 * flip was a cube, the other content is show as the bottom face of the cube.
23726 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23727 * the flip was a cube, the other content is show as the upper face of the
23729 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23730 * if the flip was a book, the other content is shown as the page below that.
23731 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23732 * as if the flip was a book, the other content is shown as the page below
23734 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23735 * flip was a book, the other content is shown as the page below that.
23736 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23737 * flip was a book, the other content is shown as the page below that.
23739 * @image html elm_flip.png
23740 * @image latex elm_flip.eps width=\textwidth
23742 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23744 * @brief Set the interactive flip mode
23746 * @param obj The flip object
23747 * @param mode The interactive flip mode to use
23749 * This sets if the flip should be interactive (allow user to click and
23750 * drag a side of the flip to reveal the back page and cause it to flip).
23751 * By default a flip is not interactive. You may also need to set which
23752 * sides of the flip are "active" for flipping and how much space they use
23753 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23754 * and elm_flip_interacton_direction_hitsize_set()
23756 * The four avilable mode of interaction are:
23757 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23758 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23759 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23760 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23762 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23763 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23764 * happen, those can only be acheived with elm_flip_go();
23766 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23768 * @brief Get the interactive flip mode
23770 * @param obj The flip object
23771 * @return The interactive flip mode
23773 * Returns the interactive flip mode set by elm_flip_interaction_set()
23775 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23777 * @brief Set which directions of the flip respond to interactive flip
23779 * @param obj The flip object
23780 * @param dir The direction to change
23781 * @param enabled If that direction is enabled or not
23783 * By default all directions are disabled, so you may want to enable the
23784 * desired directions for flipping if you need interactive flipping. You must
23785 * call this function once for each direction that should be enabled.
23787 * @see elm_flip_interaction_set()
23789 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23791 * @brief Get the enabled state of that flip direction
23793 * @param obj The flip object
23794 * @param dir The direction to check
23795 * @return If that direction is enabled or not
23797 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23799 * @see elm_flip_interaction_set()
23801 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23803 * @brief Set the amount of the flip that is sensitive to interactive flip
23805 * @param obj The flip object
23806 * @param dir The direction to modify
23807 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23809 * Set the amount of the flip that is sensitive to interactive flip, with 0
23810 * representing no area in the flip and 1 representing the entire flip. There
23811 * is however a consideration to be made in that the area will never be
23812 * smaller than the finger size set(as set in your Elementary configuration).
23814 * @see elm_flip_interaction_set()
23816 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23818 * @brief Get the amount of the flip that is sensitive to interactive flip
23820 * @param obj The flip object
23821 * @param dir The direction to check
23822 * @return The size set for that direction
23824 * Returns the amount os sensitive area set by
23825 * elm_flip_interacton_direction_hitsize_set().
23827 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23832 /* scrolledentry */
23833 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23834 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23835 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23836 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23837 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23838 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23839 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23840 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23841 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23842 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23843 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23844 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23845 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23846 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23847 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23848 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23849 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23850 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23851 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23852 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23853 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23854 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23855 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23856 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23857 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23858 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23859 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23860 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23861 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23862 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23863 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23864 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23865 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23866 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23867 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23868 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);
23869 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23870 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23871 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);
23872 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23873 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);
23874 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23875 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23876 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23877 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23878 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23879 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23880 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23881 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23882 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);
23883 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);
23884 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);
23885 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);
23886 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);
23887 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);
23888 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23889 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23890 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23891 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23892 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23893 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23894 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23897 * @defgroup Conformant Conformant
23898 * @ingroup Elementary
23900 * @image html img/widget/conformant/preview-00.png
23901 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23903 * @image html img/conformant.png
23904 * @image latex img/conformant.eps width=\textwidth
23906 * The aim is to provide a widget that can be used in elementary apps to
23907 * account for space taken up by the indicator, virtual keypad & softkey
23908 * windows when running the illume2 module of E17.
23910 * So conformant content will be sized and positioned considering the
23911 * space required for such stuff, and when they popup, as a keyboard
23912 * shows when an entry is selected, conformant content won't change.
23914 * Available styles for it:
23917 * See how to use this widget in this example:
23918 * @ref conformant_example
23922 * @addtogroup Conformant
23927 * Add a new conformant widget to the given parent Elementary
23928 * (container) object.
23930 * @param parent The parent object.
23931 * @return A new conformant widget handle or @c NULL, on errors.
23933 * This function inserts a new conformant widget on the canvas.
23935 * @ingroup Conformant
23937 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23940 * Set the content of the conformant widget.
23942 * @param obj The conformant object.
23943 * @param content The content to be displayed by the conformant.
23945 * Content will be sized and positioned considering the space required
23946 * to display a virtual keyboard. So it won't fill all the conformant
23947 * size. This way is possible to be sure that content won't resize
23948 * or be re-positioned after the keyboard is displayed.
23950 * Once the content object is set, a previously set one will be deleted.
23951 * If you want to keep that old content object, use the
23952 * elm_conformat_content_unset() function.
23954 * @see elm_conformant_content_unset()
23955 * @see elm_conformant_content_get()
23957 * @ingroup Conformant
23959 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23962 * Get the content of the conformant widget.
23964 * @param obj The conformant object.
23965 * @return The content that is being used.
23967 * Return the content object which is set for this widget.
23968 * It won't be unparent from conformant. For that, use
23969 * elm_conformant_content_unset().
23971 * @see elm_conformant_content_set() for more details.
23972 * @see elm_conformant_content_unset()
23974 * @ingroup Conformant
23976 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23979 * Unset the content of the conformant widget.
23981 * @param obj The conformant object.
23982 * @return The content that was being used.
23984 * Unparent and return the content object which was set for this widget.
23986 * @see elm_conformant_content_set() for more details.
23988 * @ingroup Conformant
23990 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23993 * Returns the Evas_Object that represents the content area.
23995 * @param obj The conformant object.
23996 * @return The content area of the widget.
23998 * @ingroup Conformant
24000 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24007 * @defgroup Mapbuf Mapbuf
24008 * @ingroup Elementary
24010 * @image html img/widget/mapbuf/preview-00.png
24011 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24013 * This holds one content object and uses an Evas Map of transformation
24014 * points to be later used with this content. So the content will be
24015 * moved, resized, etc as a single image. So it will improve performance
24016 * when you have a complex interafce, with a lot of elements, and will
24017 * need to resize or move it frequently (the content object and its
24020 * See how to use this widget in this example:
24021 * @ref mapbuf_example
24025 * @addtogroup Mapbuf
24030 * Add a new mapbuf widget to the given parent Elementary
24031 * (container) object.
24033 * @param parent The parent object.
24034 * @return A new mapbuf widget handle or @c NULL, on errors.
24036 * This function inserts a new mapbuf widget on the canvas.
24040 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24043 * Set the content of the mapbuf.
24045 * @param obj The mapbuf object.
24046 * @param content The content that will be filled in this mapbuf object.
24048 * Once the content object is set, a previously set one will be deleted.
24049 * If you want to keep that old content object, use the
24050 * elm_mapbuf_content_unset() function.
24052 * To enable map, elm_mapbuf_enabled_set() should be used.
24056 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24059 * Get the content of the mapbuf.
24061 * @param obj The mapbuf object.
24062 * @return The content that is being used.
24064 * Return the content object which is set for this widget.
24066 * @see elm_mapbuf_content_set() for details.
24070 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24073 * Unset the content of the mapbuf.
24075 * @param obj The mapbuf object.
24076 * @return The content that was being used.
24078 * Unparent and return the content object which was set for this widget.
24080 * @see elm_mapbuf_content_set() for details.
24084 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24087 * Enable or disable the map.
24089 * @param obj The mapbuf object.
24090 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24092 * This enables the map that is set or disables it. On enable, the object
24093 * geometry will be saved, and the new geometry will change (position and
24094 * size) to reflect the map geometry set.
24096 * Also, when enabled, alpha and smooth states will be used, so if the
24097 * content isn't solid, alpha should be enabled, for example, otherwise
24098 * a black retangle will fill the content.
24100 * When disabled, the stored map will be freed and geometry prior to
24101 * enabling the map will be restored.
24103 * It's disabled by default.
24105 * @see elm_mapbuf_alpha_set()
24106 * @see elm_mapbuf_smooth_set()
24110 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24113 * Get a value whether map is enabled or not.
24115 * @param obj The mapbuf object.
24116 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24117 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24119 * @see elm_mapbuf_enabled_set() for details.
24123 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24126 * Enable or disable smooth map rendering.
24128 * @param obj The mapbuf object.
24129 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24132 * This sets smoothing for map rendering. If the object is a type that has
24133 * its own smoothing settings, then both the smooth settings for this object
24134 * and the map must be turned off.
24136 * By default smooth maps are enabled.
24140 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24143 * Get a value whether smooth map rendering is enabled or not.
24145 * @param obj The mapbuf object.
24146 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24147 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24149 * @see elm_mapbuf_smooth_set() for details.
24153 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24156 * Set or unset alpha flag for map rendering.
24158 * @param obj The mapbuf object.
24159 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24162 * This sets alpha flag for map rendering. If the object is a type that has
24163 * its own alpha settings, then this will take precedence. Only image objects
24164 * have this currently. It stops alpha blending of the map area, and is
24165 * useful if you know the object and/or all sub-objects is 100% solid.
24167 * Alpha is enabled by default.
24171 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24174 * Get a value whether alpha blending is enabled or not.
24176 * @param obj The mapbuf object.
24177 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24178 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24180 * @see elm_mapbuf_alpha_set() for details.
24184 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24191 * @defgroup Flipselector Flip Selector
24193 * @image html img/widget/flipselector/preview-00.png
24194 * @image latex img/widget/flipselector/preview-00.eps
24196 * A flip selector is a widget to show a set of @b text items, one
24197 * at a time, with the same sheet switching style as the @ref Clock
24198 * "clock" widget, when one changes the current displaying sheet
24199 * (thus, the "flip" in the name).
24201 * User clicks to flip sheets which are @b held for some time will
24202 * make the flip selector to flip continuosly and automatically for
24203 * the user. The interval between flips will keep growing in time,
24204 * so that it helps the user to reach an item which is distant from
24205 * the current selection.
24207 * Smart callbacks one can register to:
24208 * - @c "selected" - when the widget's selected text item is changed
24209 * - @c "overflowed" - when the widget's current selection is changed
24210 * from the first item in its list to the last
24211 * - @c "underflowed" - when the widget's current selection is changed
24212 * from the last item in its list to the first
24214 * Available styles for it:
24217 * Here is an example on its usage:
24218 * @li @ref flipselector_example
24222 * @addtogroup Flipselector
24226 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24229 * Add a new flip selector widget to the given parent Elementary
24230 * (container) widget
24232 * @param parent The parent object
24233 * @return a new flip selector widget handle or @c NULL, on errors
24235 * This function inserts a new flip selector widget on the canvas.
24237 * @ingroup Flipselector
24239 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24242 * Programmatically select the next item of a flip selector widget
24244 * @param obj The flipselector object
24246 * @note The selection will be animated. Also, if it reaches the
24247 * end of its list of member items, it will continue with the first
24250 * @ingroup Flipselector
24252 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24255 * Programmatically select the previous item of a flip selector
24258 * @param obj The flipselector object
24260 * @note The selection will be animated. Also, if it reaches the
24261 * beginning of its list of member items, it will continue with the
24262 * last one backwards.
24264 * @ingroup Flipselector
24266 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24269 * Append a (text) item to a flip selector widget
24271 * @param obj The flipselector object
24272 * @param label The (text) label of the new item
24273 * @param func Convenience callback function to take place when
24275 * @param data Data passed to @p func, above
24276 * @return A handle to the item added or @c NULL, on errors
24278 * The widget's list of labels to show will be appended with the
24279 * given value. If the user wishes so, a callback function pointer
24280 * can be passed, which will get called when this same item is
24283 * @note The current selection @b won't be modified by appending an
24284 * element to the list.
24286 * @note The maximum length of the text label is going to be
24287 * determined <b>by the widget's theme</b>. Strings larger than
24288 * that value are going to be @b truncated.
24290 * @ingroup Flipselector
24292 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24295 * Prepend a (text) item to a flip selector widget
24297 * @param obj The flipselector object
24298 * @param label The (text) label of the new item
24299 * @param func Convenience callback function to take place when
24301 * @param data Data passed to @p func, above
24302 * @return A handle to the item added or @c NULL, on errors
24304 * The widget's list of labels to show will be prepended with the
24305 * given value. If the user wishes so, a callback function pointer
24306 * can be passed, which will get called when this same item is
24309 * @note The current selection @b won't be modified by prepending
24310 * an element to the list.
24312 * @note The maximum length of the text label is going to be
24313 * determined <b>by the widget's theme</b>. Strings larger than
24314 * that value are going to be @b truncated.
24316 * @ingroup Flipselector
24318 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24321 * Get the internal list of items in a given flip selector widget.
24323 * @param obj The flipselector object
24324 * @return The list of items (#Elm_Flipselector_Item as data) or
24325 * @c NULL on errors.
24327 * This list is @b not to be modified in any way and must not be
24328 * freed. Use the list members with functions like
24329 * elm_flipselector_item_label_set(),
24330 * elm_flipselector_item_label_get(),
24331 * elm_flipselector_item_del(),
24332 * elm_flipselector_item_selected_get(),
24333 * elm_flipselector_item_selected_set().
24335 * @warning This list is only valid until @p obj object's internal
24336 * items list is changed. It should be fetched again with another
24337 * call to this function when changes happen.
24339 * @ingroup Flipselector
24341 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24344 * Get the first item in the given flip selector widget's list of
24347 * @param obj The flipselector object
24348 * @return The first item or @c NULL, if it has no items (and on
24351 * @see elm_flipselector_item_append()
24352 * @see elm_flipselector_last_item_get()
24354 * @ingroup Flipselector
24356 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24359 * Get the last item in the given flip selector widget's list of
24362 * @param obj The flipselector object
24363 * @return The last item or @c NULL, if it has no items (and on
24366 * @see elm_flipselector_item_prepend()
24367 * @see elm_flipselector_first_item_get()
24369 * @ingroup Flipselector
24371 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24374 * Get the currently selected item in a flip selector widget.
24376 * @param obj The flipselector object
24377 * @return The selected item or @c NULL, if the widget has no items
24380 * @ingroup Flipselector
24382 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24385 * Set whether a given flip selector widget's item should be the
24386 * currently selected one.
24388 * @param item The flip selector item
24389 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24391 * This sets whether @p item is or not the selected (thus, under
24392 * display) one. If @p item is different than one under display,
24393 * the latter will be unselected. If the @p item is set to be
24394 * unselected, on the other hand, the @b first item in the widget's
24395 * internal members list will be the new selected one.
24397 * @see elm_flipselector_item_selected_get()
24399 * @ingroup Flipselector
24401 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24404 * Get whether a given flip selector widget's item is the currently
24407 * @param item The flip selector item
24408 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24411 * @see elm_flipselector_item_selected_set()
24413 * @ingroup Flipselector
24415 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24418 * Delete a given item from a flip selector widget.
24420 * @param item The item to delete
24422 * @ingroup Flipselector
24424 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24427 * Get the label of a given flip selector widget's item.
24429 * @param item The item to get label from
24430 * @return The text label of @p item or @c NULL, on errors
24432 * @see elm_flipselector_item_label_set()
24434 * @ingroup Flipselector
24436 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24439 * Set the label of a given flip selector widget's item.
24441 * @param item The item to set label on
24442 * @param label The text label string, in UTF-8 encoding
24444 * @see elm_flipselector_item_label_get()
24446 * @ingroup Flipselector
24448 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24451 * Gets the item before @p item in a flip selector widget's
24452 * internal list of items.
24454 * @param item The item to fetch previous from
24455 * @return The item before the @p item, in its parent's list. If
24456 * there is no previous item for @p item or there's an
24457 * error, @c NULL is returned.
24459 * @see elm_flipselector_item_next_get()
24461 * @ingroup Flipselector
24463 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24466 * Gets the item after @p item in a flip selector widget's
24467 * internal list of items.
24469 * @param item The item to fetch next from
24470 * @return The item after the @p item, in its parent's list. If
24471 * there is no next item for @p item or there's an
24472 * error, @c NULL is returned.
24474 * @see elm_flipselector_item_next_get()
24476 * @ingroup Flipselector
24478 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24481 * Set the interval on time updates for an user mouse button hold
24482 * on a flip selector widget.
24484 * @param obj The flip selector object
24485 * @param interval The (first) interval value in seconds
24487 * This interval value is @b decreased while the user holds the
24488 * mouse pointer either flipping up or flipping doww a given flip
24491 * This helps the user to get to a given item distant from the
24492 * current one easier/faster, as it will start to flip quicker and
24493 * quicker on mouse button holds.
24495 * The calculation for the next flip interval value, starting from
24496 * the one set with this call, is the previous interval divided by
24497 * 1.05, so it decreases a little bit.
24499 * The default starting interval value for automatic flips is
24502 * @see elm_flipselector_interval_get()
24504 * @ingroup Flipselector
24506 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24509 * Get the interval on time updates for an user mouse button hold
24510 * on a flip selector widget.
24512 * @param obj The flip selector object
24513 * @return The (first) interval value, in seconds, set on it
24515 * @see elm_flipselector_interval_set() for more details
24517 * @ingroup Flipselector
24519 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24525 * @addtogroup Calendar
24530 * @enum _Elm_Calendar_Mark_Repeat
24531 * @typedef Elm_Calendar_Mark_Repeat
24533 * Event periodicity, used to define if a mark should be repeated
24534 * @b beyond event's day. It's set when a mark is added.
24536 * So, for a mark added to 13th May with periodicity set to WEEKLY,
24537 * there will be marks every week after this date. Marks will be displayed
24538 * at 13th, 20th, 27th, 3rd June ...
24540 * Values don't work as bitmask, only one can be choosen.
24542 * @see elm_calendar_mark_add()
24544 * @ingroup Calendar
24546 typedef enum _Elm_Calendar_Mark_Repeat
24548 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24549 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24550 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24551 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*/
24552 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. */
24553 } Elm_Calendar_Mark_Repeat;
24555 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(). */
24558 * Add a new calendar widget to the given parent Elementary
24559 * (container) object.
24561 * @param parent The parent object.
24562 * @return a new calendar widget handle or @c NULL, on errors.
24564 * This function inserts a new calendar widget on the canvas.
24566 * @ref calendar_example_01
24568 * @ingroup Calendar
24570 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24573 * Get weekdays names displayed by the calendar.
24575 * @param obj The calendar object.
24576 * @return Array of seven strings to be used as weekday names.
24578 * By default, weekdays abbreviations get from system are displayed:
24579 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24580 * The first string is related to Sunday, the second to Monday...
24582 * @see elm_calendar_weekdays_name_set()
24584 * @ref calendar_example_05
24586 * @ingroup Calendar
24588 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24591 * Set weekdays names to be displayed by the calendar.
24593 * @param obj The calendar object.
24594 * @param weekdays Array of seven strings to be used as weekday names.
24595 * @warning It must have 7 elements, or it will access invalid memory.
24596 * @warning The strings must be NULL terminated ('@\0').
24598 * By default, weekdays abbreviations get from system are displayed:
24599 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24601 * The first string should be related to Sunday, the second to Monday...
24603 * The usage should be like this:
24605 * const char *weekdays[] =
24607 * "Sunday", "Monday", "Tuesday", "Wednesday",
24608 * "Thursday", "Friday", "Saturday"
24610 * elm_calendar_weekdays_names_set(calendar, weekdays);
24613 * @see elm_calendar_weekdays_name_get()
24615 * @ref calendar_example_02
24617 * @ingroup Calendar
24619 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24622 * Set the minimum and maximum values for the year
24624 * @param obj The calendar object
24625 * @param min The minimum year, greater than 1901;
24626 * @param max The maximum year;
24628 * Maximum must be greater than minimum, except if you don't wan't to set
24630 * Default values are 1902 and -1.
24632 * If the maximum year is a negative value, it will be limited depending
24633 * on the platform architecture (year 2037 for 32 bits);
24635 * @see elm_calendar_min_max_year_get()
24637 * @ref calendar_example_03
24639 * @ingroup Calendar
24641 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24644 * Get the minimum and maximum values for the year
24646 * @param obj The calendar object.
24647 * @param min The minimum year.
24648 * @param max The maximum year.
24650 * Default values are 1902 and -1.
24652 * @see elm_calendar_min_max_year_get() for more details.
24654 * @ref calendar_example_05
24656 * @ingroup Calendar
24658 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24661 * Enable or disable day selection
24663 * @param obj The calendar object.
24664 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24667 * Enabled by default. If disabled, the user still can select months,
24668 * but not days. Selected days are highlighted on calendar.
24669 * It should be used if you won't need such selection for the widget usage.
24671 * When a day is selected, or month is changed, smart callbacks for
24672 * signal "changed" will be called.
24674 * @see elm_calendar_day_selection_enable_get()
24676 * @ref calendar_example_04
24678 * @ingroup Calendar
24680 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24683 * Get a value whether day selection is enabled or not.
24685 * @see elm_calendar_day_selection_enable_set() for details.
24687 * @param obj The calendar object.
24688 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24689 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24691 * @ref calendar_example_05
24693 * @ingroup Calendar
24695 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24699 * Set selected date to be highlighted on calendar.
24701 * @param obj The calendar object.
24702 * @param selected_time A @b tm struct to represent the selected date.
24704 * Set the selected date, changing the displayed month if needed.
24705 * Selected date changes when the user goes to next/previous month or
24706 * select a day pressing over it on calendar.
24708 * @see elm_calendar_selected_time_get()
24710 * @ref calendar_example_04
24712 * @ingroup Calendar
24714 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
24717 * Get selected date.
24719 * @param obj The calendar object
24720 * @param selected_time A @b tm struct to point to selected date
24721 * @return EINA_FALSE means an error ocurred and returned time shouldn't
24724 * Get date selected by the user or set by function
24725 * elm_calendar_selected_time_set().
24726 * Selected date changes when the user goes to next/previous month or
24727 * select a day pressing over it on calendar.
24729 * @see elm_calendar_selected_time_get()
24731 * @ref calendar_example_05
24733 * @ingroup Calendar
24735 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
24738 * Set a function to format the string that will be used to display
24741 * @param obj The calendar object
24742 * @param format_function Function to set the month-year string given
24743 * the selected date
24745 * By default it uses strftime with "%B %Y" format string.
24746 * It should allocate the memory that will be used by the string,
24747 * that will be freed by the widget after usage.
24748 * A pointer to the string and a pointer to the time struct will be provided.
24753 * _format_month_year(struct tm *selected_time)
24756 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
24757 * return strdup(buf);
24760 * elm_calendar_format_function_set(calendar, _format_month_year);
24763 * @ref calendar_example_02
24765 * @ingroup Calendar
24767 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
24770 * Add a new mark to the calendar
24772 * @param obj The calendar object
24773 * @param mark_type A string used to define the type of mark. It will be
24774 * emitted to the theme, that should display a related modification on these
24775 * days representation.
24776 * @param mark_time A time struct to represent the date of inclusion of the
24777 * mark. For marks that repeats it will just be displayed after the inclusion
24778 * date in the calendar.
24779 * @param repeat Repeat the event following this periodicity. Can be a unique
24780 * mark (that don't repeat), daily, weekly, monthly or annually.
24781 * @return The created mark or @p NULL upon failure.
24783 * Add a mark that will be drawn in the calendar respecting the insertion
24784 * time and periodicity. It will emit the type as signal to the widget theme.
24785 * Default theme supports "holiday" and "checked", but it can be extended.
24787 * It won't immediately update the calendar, drawing the marks.
24788 * For this, call elm_calendar_marks_draw(). However, when user selects
24789 * next or previous month calendar forces marks drawn.
24791 * Marks created with this method can be deleted with
24792 * elm_calendar_mark_del().
24796 * struct tm selected_time;
24797 * time_t current_time;
24799 * current_time = time(NULL) + 5 * 84600;
24800 * localtime_r(¤t_time, &selected_time);
24801 * elm_calendar_mark_add(cal, "holiday", selected_time,
24802 * ELM_CALENDAR_ANNUALLY);
24804 * current_time = time(NULL) + 1 * 84600;
24805 * localtime_r(¤t_time, &selected_time);
24806 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
24808 * elm_calendar_marks_draw(cal);
24811 * @see elm_calendar_marks_draw()
24812 * @see elm_calendar_mark_del()
24814 * @ref calendar_example_06
24816 * @ingroup Calendar
24818 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);
24821 * Delete mark from the calendar.
24823 * @param mark The mark to be deleted.
24825 * If deleting all calendar marks is required, elm_calendar_marks_clear()
24826 * should be used instead of getting marks list and deleting each one.
24828 * @see elm_calendar_mark_add()
24830 * @ref calendar_example_06
24832 * @ingroup Calendar
24834 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
24837 * Remove all calendar's marks
24839 * @param obj The calendar object.
24841 * @see elm_calendar_mark_add()
24842 * @see elm_calendar_mark_del()
24844 * @ingroup Calendar
24846 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24850 * Get a list of all the calendar marks.
24852 * @param obj The calendar object.
24853 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24855 * @see elm_calendar_mark_add()
24856 * @see elm_calendar_mark_del()
24857 * @see elm_calendar_marks_clear()
24859 * @ingroup Calendar
24861 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24864 * Draw calendar marks.
24866 * @param obj The calendar object.
24868 * Should be used after adding, removing or clearing marks.
24869 * It will go through the entire marks list updating the calendar.
24870 * If lots of marks will be added, add all the marks and then call
24873 * When the month is changed, i.e. user selects next or previous month,
24874 * marks will be drawed.
24876 * @see elm_calendar_mark_add()
24877 * @see elm_calendar_mark_del()
24878 * @see elm_calendar_marks_clear()
24880 * @ref calendar_example_06
24882 * @ingroup Calendar
24884 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24887 * Set a day text color to the same that represents Saturdays.
24889 * @param obj The calendar object.
24890 * @param pos The text position. Position is the cell counter, from left
24891 * to right, up to down. It starts on 0 and ends on 41.
24893 * @deprecated use elm_calendar_mark_add() instead like:
24896 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24897 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24900 * @see elm_calendar_mark_add()
24902 * @ingroup Calendar
24904 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24907 * Set a day text color to the same that represents Sundays.
24909 * @param obj The calendar object.
24910 * @param pos The text position. Position is the cell counter, from left
24911 * to right, up to down. It starts on 0 and ends on 41.
24913 * @deprecated use elm_calendar_mark_add() instead like:
24916 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24917 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24920 * @see elm_calendar_mark_add()
24922 * @ingroup Calendar
24924 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24927 * Set a day text color to the same that represents Weekdays.
24929 * @param obj The calendar object
24930 * @param pos The text position. Position is the cell counter, from left
24931 * to right, up to down. It starts on 0 and ends on 41.
24933 * @deprecated use elm_calendar_mark_add() instead like:
24936 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24938 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24939 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24940 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24941 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24942 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24943 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24944 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24945 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24946 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24949 * @see elm_calendar_mark_add()
24951 * @ingroup Calendar
24953 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24956 * Set the interval on time updates for an user mouse button hold
24957 * on calendar widgets' month selection.
24959 * @param obj The calendar object
24960 * @param interval The (first) interval value in seconds
24962 * This interval value is @b decreased while the user holds the
24963 * mouse pointer either selecting next or previous month.
24965 * This helps the user to get to a given month distant from the
24966 * current one easier/faster, as it will start to change quicker and
24967 * quicker on mouse button holds.
24969 * The calculation for the next change interval value, starting from
24970 * the one set with this call, is the previous interval divided by
24971 * 1.05, so it decreases a little bit.
24973 * The default starting interval value for automatic changes is
24976 * @see elm_calendar_interval_get()
24978 * @ingroup Calendar
24980 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24983 * Get the interval on time updates for an user mouse button hold
24984 * on calendar widgets' month selection.
24986 * @param obj The calendar object
24987 * @return The (first) interval value, in seconds, set on it
24989 * @see elm_calendar_interval_set() for more details
24991 * @ingroup Calendar
24993 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25000 * @defgroup Diskselector Diskselector
25001 * @ingroup Elementary
25003 * @image html img/widget/diskselector/preview-00.png
25004 * @image latex img/widget/diskselector/preview-00.eps
25006 * A diskselector is a kind of list widget. It scrolls horizontally,
25007 * and can contain label and icon objects. Three items are displayed
25008 * with the selected one in the middle.
25010 * It can act like a circular list with round mode and labels can be
25011 * reduced for a defined length for side items.
25013 * Smart callbacks one can listen to:
25014 * - "selected" - when item is selected, i.e. scroller stops.
25016 * Available styles for it:
25019 * List of examples:
25020 * @li @ref diskselector_example_01
25021 * @li @ref diskselector_example_02
25025 * @addtogroup Diskselector
25029 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(). */
25032 * Add a new diskselector widget to the given parent Elementary
25033 * (container) object.
25035 * @param parent The parent object.
25036 * @return a new diskselector widget handle or @c NULL, on errors.
25038 * This function inserts a new diskselector widget on the canvas.
25040 * @ingroup Diskselector
25042 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25045 * Enable or disable round mode.
25047 * @param obj The diskselector object.
25048 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25051 * Disabled by default. If round mode is enabled the items list will
25052 * work like a circle list, so when the user reaches the last item,
25053 * the first one will popup.
25055 * @see elm_diskselector_round_get()
25057 * @ingroup Diskselector
25059 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25062 * Get a value whether round mode is enabled or not.
25064 * @see elm_diskselector_round_set() for details.
25066 * @param obj The diskselector object.
25067 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25068 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25070 * @ingroup Diskselector
25072 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25075 * Get the side labels max length.
25077 * @deprecated use elm_diskselector_side_label_length_get() instead:
25079 * @param obj The diskselector object.
25080 * @return The max length defined for side labels, or 0 if not a valid
25083 * @ingroup Diskselector
25085 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25088 * Set the side labels max length.
25090 * @deprecated use elm_diskselector_side_label_length_set() instead:
25092 * @param obj The diskselector object.
25093 * @param len The max length defined for side labels.
25095 * @ingroup Diskselector
25097 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25100 * Get the side labels max length.
25102 * @see elm_diskselector_side_label_length_set() for details.
25104 * @param obj The diskselector object.
25105 * @return The max length defined for side labels, or 0 if not a valid
25108 * @ingroup Diskselector
25110 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25113 * Set the side labels max length.
25115 * @param obj The diskselector object.
25116 * @param len The max length defined for side labels.
25118 * Length is the number of characters of items' label that will be
25119 * visible when it's set on side positions. It will just crop
25120 * the string after defined size. E.g.:
25122 * An item with label "January" would be displayed on side position as
25123 * "Jan" if max length is set to 3, or "Janu", if this property
25126 * When it's selected, the entire label will be displayed, except for
25127 * width restrictions. In this case label will be cropped and "..."
25128 * will be concatenated.
25130 * Default side label max length is 3.
25132 * This property will be applyed over all items, included before or
25133 * later this function call.
25135 * @ingroup Diskselector
25137 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25140 * Set the number of items to be displayed.
25142 * @param obj The diskselector object.
25143 * @param num The number of items the diskselector will display.
25145 * Default value is 3, and also it's the minimun. If @p num is less
25146 * than 3, it will be set to 3.
25148 * Also, it can be set on theme, using data item @c display_item_num
25149 * on group "elm/diskselector/item/X", where X is style set.
25152 * group { name: "elm/diskselector/item/X";
25154 * item: "display_item_num" "5";
25157 * @ingroup Diskselector
25159 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25162 * Get the number of items in the diskselector object.
25164 * @param obj The diskselector object.
25166 * @ingroup Diskselector
25168 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25171 * Set bouncing behaviour when the scrolled content reaches an edge.
25173 * Tell the internal scroller object whether it should bounce or not
25174 * when it reaches the respective edges for each axis.
25176 * @param obj The diskselector object.
25177 * @param h_bounce Whether to bounce or not in the horizontal axis.
25178 * @param v_bounce Whether to bounce or not in the vertical axis.
25180 * @see elm_scroller_bounce_set()
25182 * @ingroup Diskselector
25184 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25187 * Get the bouncing behaviour of the internal scroller.
25189 * Get whether the internal scroller should bounce when the edge of each
25190 * axis is reached scrolling.
25192 * @param obj The diskselector object.
25193 * @param h_bounce Pointer where to store the bounce state of the horizontal
25195 * @param v_bounce Pointer where to store the bounce state of the vertical
25198 * @see elm_scroller_bounce_get()
25199 * @see elm_diskselector_bounce_set()
25201 * @ingroup Diskselector
25203 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25206 * Get the scrollbar policy.
25208 * @see elm_diskselector_scroller_policy_get() for details.
25210 * @param obj The diskselector object.
25211 * @param policy_h Pointer where to store horizontal scrollbar policy.
25212 * @param policy_v Pointer where to store vertical scrollbar policy.
25214 * @ingroup Diskselector
25216 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);
25219 * Set the scrollbar policy.
25221 * @param obj The diskselector object.
25222 * @param policy_h Horizontal scrollbar policy.
25223 * @param policy_v Vertical scrollbar policy.
25225 * This sets the scrollbar visibility policy for the given scroller.
25226 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25227 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25228 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25229 * This applies respectively for the horizontal and vertical scrollbars.
25231 * The both are disabled by default, i.e., are set to
25232 * #ELM_SCROLLER_POLICY_OFF.
25234 * @ingroup Diskselector
25236 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25239 * Remove all diskselector's items.
25241 * @param obj The diskselector object.
25243 * @see elm_diskselector_item_del()
25244 * @see elm_diskselector_item_append()
25246 * @ingroup Diskselector
25248 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25251 * Get a list of all the diskselector items.
25253 * @param obj The diskselector object.
25254 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25255 * or @c NULL on failure.
25257 * @see elm_diskselector_item_append()
25258 * @see elm_diskselector_item_del()
25259 * @see elm_diskselector_clear()
25261 * @ingroup Diskselector
25263 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25266 * Appends a new item to the diskselector object.
25268 * @param obj The diskselector object.
25269 * @param label The label of the diskselector item.
25270 * @param icon The icon object to use at left side of the item. An
25271 * icon can be any Evas object, but usually it is an icon created
25272 * with elm_icon_add().
25273 * @param func The function to call when the item is selected.
25274 * @param data The data to associate with the item for related callbacks.
25276 * @return The created item or @c NULL upon failure.
25278 * A new item will be created and appended to the diskselector, i.e., will
25279 * be set as last item. Also, if there is no selected item, it will
25280 * be selected. This will always happens for the first appended item.
25282 * If no icon is set, label will be centered on item position, otherwise
25283 * the icon will be placed at left of the label, that will be shifted
25286 * Items created with this method can be deleted with
25287 * elm_diskselector_item_del().
25289 * Associated @p data can be properly freed when item is deleted if a
25290 * callback function is set with elm_diskselector_item_del_cb_set().
25292 * If a function is passed as argument, it will be called everytime this item
25293 * is selected, i.e., the user stops the diskselector with this
25294 * item on center position. If such function isn't needed, just passing
25295 * @c NULL as @p func is enough. The same should be done for @p data.
25297 * Simple example (with no function callback or data associated):
25299 * disk = elm_diskselector_add(win);
25300 * ic = elm_icon_add(win);
25301 * elm_icon_file_set(ic, "path/to/image", NULL);
25302 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25303 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25306 * @see elm_diskselector_item_del()
25307 * @see elm_diskselector_item_del_cb_set()
25308 * @see elm_diskselector_clear()
25309 * @see elm_icon_add()
25311 * @ingroup Diskselector
25313 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);
25317 * Delete them item from the diskselector.
25319 * @param it The item of diskselector to be deleted.
25321 * If deleting all diskselector items is required, elm_diskselector_clear()
25322 * should be used instead of getting items list and deleting each one.
25324 * @see elm_diskselector_clear()
25325 * @see elm_diskselector_item_append()
25326 * @see elm_diskselector_item_del_cb_set()
25328 * @ingroup Diskselector
25330 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25333 * Set the function called when a diskselector item is freed.
25335 * @param it The item to set the callback on
25336 * @param func The function called
25338 * If there is a @p func, then it will be called prior item's memory release.
25339 * That will be called with the following arguments:
25341 * @li item's Evas object;
25344 * This way, a data associated to a diskselector item could be properly
25347 * @ingroup Diskselector
25349 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25352 * Get the data associated to the item.
25354 * @param it The diskselector item
25355 * @return The data associated to @p it
25357 * The return value is a pointer to data associated to @p item when it was
25358 * created, with function elm_diskselector_item_append(). If no data
25359 * was passed as argument, it will return @c NULL.
25361 * @see elm_diskselector_item_append()
25363 * @ingroup Diskselector
25365 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25368 * Set the icon associated to the item.
25370 * @param it The diskselector item
25371 * @param icon The icon object to associate with @p it
25373 * The icon object to use at left side of the item. An
25374 * icon can be any Evas object, but usually it is an icon created
25375 * with elm_icon_add().
25377 * Once the icon object is set, a previously set one will be deleted.
25378 * @warning Setting the same icon for two items will cause the icon to
25379 * dissapear from the first item.
25381 * If an icon was passed as argument on item creation, with function
25382 * elm_diskselector_item_append(), it will be already
25383 * associated to the item.
25385 * @see elm_diskselector_item_append()
25386 * @see elm_diskselector_item_icon_get()
25388 * @ingroup Diskselector
25390 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25393 * Get the icon associated to the item.
25395 * @param it The diskselector item
25396 * @return The icon associated to @p it
25398 * The return value is a pointer to the icon associated to @p item when it was
25399 * created, with function elm_diskselector_item_append(), or later
25400 * with function elm_diskselector_item_icon_set. If no icon
25401 * was passed as argument, it will return @c NULL.
25403 * @see elm_diskselector_item_append()
25404 * @see elm_diskselector_item_icon_set()
25406 * @ingroup Diskselector
25408 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25411 * Set the label of item.
25413 * @param it The item of diskselector.
25414 * @param label The label of item.
25416 * The label to be displayed by the item.
25418 * If no icon is set, label will be centered on item position, otherwise
25419 * the icon will be placed at left of the label, that will be shifted
25422 * An item with label "January" would be displayed on side position as
25423 * "Jan" if max length is set to 3 with function
25424 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25427 * When this @p item is selected, the entire label will be displayed,
25428 * except for width restrictions.
25429 * In this case label will be cropped and "..." will be concatenated,
25430 * but only for display purposes. It will keep the entire string, so
25431 * if diskselector is resized the remaining characters will be displayed.
25433 * If a label was passed as argument on item creation, with function
25434 * elm_diskselector_item_append(), it will be already
25435 * displayed by the item.
25437 * @see elm_diskselector_side_label_lenght_set()
25438 * @see elm_diskselector_item_label_get()
25439 * @see elm_diskselector_item_append()
25441 * @ingroup Diskselector
25443 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25446 * Get the label of item.
25448 * @param it The item of diskselector.
25449 * @return The label of item.
25451 * The return value is a pointer to the label associated to @p item when it was
25452 * created, with function elm_diskselector_item_append(), or later
25453 * with function elm_diskselector_item_label_set. If no label
25454 * was passed as argument, it will return @c NULL.
25456 * @see elm_diskselector_item_label_set() for more details.
25457 * @see elm_diskselector_item_append()
25459 * @ingroup Diskselector
25461 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25464 * Get the selected item.
25466 * @param obj The diskselector object.
25467 * @return The selected diskselector item.
25469 * The selected item can be unselected with function
25470 * elm_diskselector_item_selected_set(), and the first item of
25471 * diskselector will be selected.
25473 * The selected item always will be centered on diskselector, with
25474 * full label displayed, i.e., max lenght set to side labels won't
25475 * apply on the selected item. More details on
25476 * elm_diskselector_side_label_length_set().
25478 * @ingroup Diskselector
25480 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25483 * Set the selected state of an item.
25485 * @param it The diskselector item
25486 * @param selected The selected state
25488 * This sets the selected state of the given item @p it.
25489 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25491 * If a new item is selected the previosly selected will be unselected.
25492 * Previoulsy selected item can be get with function
25493 * elm_diskselector_selected_item_get().
25495 * If the item @p it is unselected, the first item of diskselector will
25498 * Selected items will be visible on center position of diskselector.
25499 * So if it was on another position before selected, or was invisible,
25500 * diskselector will animate items until the selected item reaches center
25503 * @see elm_diskselector_item_selected_get()
25504 * @see elm_diskselector_selected_item_get()
25506 * @ingroup Diskselector
25508 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25511 * Get whether the @p item is selected or not.
25513 * @param it The diskselector item.
25514 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25515 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25517 * @see elm_diskselector_selected_item_set() for details.
25518 * @see elm_diskselector_item_selected_get()
25520 * @ingroup Diskselector
25522 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25525 * Get the first item of the diskselector.
25527 * @param obj The diskselector object.
25528 * @return The first item, or @c NULL if none.
25530 * The list of items follows append order. So it will return the first
25531 * item appended to the widget that wasn't deleted.
25533 * @see elm_diskselector_item_append()
25534 * @see elm_diskselector_items_get()
25536 * @ingroup Diskselector
25538 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25541 * Get the last item of the diskselector.
25543 * @param obj The diskselector object.
25544 * @return The last item, or @c NULL if none.
25546 * The list of items follows append order. So it will return last first
25547 * item appended to the widget that wasn't deleted.
25549 * @see elm_diskselector_item_append()
25550 * @see elm_diskselector_items_get()
25552 * @ingroup Diskselector
25554 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25557 * Get the item before @p item in diskselector.
25559 * @param it The diskselector item.
25560 * @return The item before @p item, or @c NULL if none or on failure.
25562 * The list of items follows append order. So it will return item appended
25563 * just before @p item and that wasn't deleted.
25565 * If it is the first item, @c NULL will be returned.
25566 * First item can be get by elm_diskselector_first_item_get().
25568 * @see elm_diskselector_item_append()
25569 * @see elm_diskselector_items_get()
25571 * @ingroup Diskselector
25573 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25576 * Get the item after @p item in diskselector.
25578 * @param it The diskselector item.
25579 * @return The item after @p item, or @c NULL if none or on failure.
25581 * The list of items follows append order. So it will return item appended
25582 * just after @p item and that wasn't deleted.
25584 * If it is the last item, @c NULL will be returned.
25585 * Last item can be get by elm_diskselector_last_item_get().
25587 * @see elm_diskselector_item_append()
25588 * @see elm_diskselector_items_get()
25590 * @ingroup Diskselector
25592 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25595 * Set the text to be shown in the diskselector item.
25597 * @param item Target item
25598 * @param text The text to set in the content
25600 * Setup the text as tooltip to object. The item can have only one tooltip,
25601 * so any previous tooltip data is removed.
25603 * @see elm_object_tooltip_text_set() for more details.
25605 * @ingroup Diskselector
25607 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25610 * Set the content to be shown in the tooltip item.
25612 * Setup the tooltip to item. The item can have only one tooltip,
25613 * so any previous tooltip data is removed. @p func(with @p data) will
25614 * be called every time that need show the tooltip and it should
25615 * return a valid Evas_Object. This object is then managed fully by
25616 * tooltip system and is deleted when the tooltip is gone.
25618 * @param item the diskselector item being attached a tooltip.
25619 * @param func the function used to create the tooltip contents.
25620 * @param data what to provide to @a func as callback data/context.
25621 * @param del_cb called when data is not needed anymore, either when
25622 * another callback replaces @p func, the tooltip is unset with
25623 * elm_diskselector_item_tooltip_unset() or the owner @a item
25624 * dies. This callback receives as the first parameter the
25625 * given @a data, and @c event_info is the item.
25627 * @see elm_object_tooltip_content_cb_set() for more details.
25629 * @ingroup Diskselector
25631 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);
25634 * Unset tooltip from item.
25636 * @param item diskselector item to remove previously set tooltip.
25638 * Remove tooltip from item. The callback provided as del_cb to
25639 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25640 * it is not used anymore.
25642 * @see elm_object_tooltip_unset() for more details.
25643 * @see elm_diskselector_item_tooltip_content_cb_set()
25645 * @ingroup Diskselector
25647 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25651 * Sets a different style for this item tooltip.
25653 * @note before you set a style you should define a tooltip with
25654 * elm_diskselector_item_tooltip_content_cb_set() or
25655 * elm_diskselector_item_tooltip_text_set()
25657 * @param item diskselector item with tooltip already set.
25658 * @param style the theme style to use (default, transparent, ...)
25660 * @see elm_object_tooltip_style_set() for more details.
25662 * @ingroup Diskselector
25664 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25667 * Get the style for this item tooltip.
25669 * @param item diskselector item with tooltip already set.
25670 * @return style the theme style in use, defaults to "default". If the
25671 * object does not have a tooltip set, then NULL is returned.
25673 * @see elm_object_tooltip_style_get() for more details.
25674 * @see elm_diskselector_item_tooltip_style_set()
25676 * @ingroup Diskselector
25678 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25681 * Set the cursor to be shown when mouse is over the diskselector item
25683 * @param item Target item
25684 * @param cursor the cursor name to be used.
25686 * @see elm_object_cursor_set() for more details.
25688 * @ingroup Diskselector
25690 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
25693 * Get the cursor to be shown when mouse is over the diskselector item
25695 * @param item diskselector item with cursor already set.
25696 * @return the cursor name.
25698 * @see elm_object_cursor_get() for more details.
25699 * @see elm_diskselector_cursor_set()
25701 * @ingroup Diskselector
25703 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25707 * Unset the cursor to be shown when mouse is over the diskselector item
25709 * @param item Target item
25711 * @see elm_object_cursor_unset() for more details.
25712 * @see elm_diskselector_cursor_set()
25714 * @ingroup Diskselector
25716 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25719 * Sets a different style for this item cursor.
25721 * @note before you set a style you should define a cursor with
25722 * elm_diskselector_item_cursor_set()
25724 * @param item diskselector item with cursor already set.
25725 * @param style the theme style to use (default, transparent, ...)
25727 * @see elm_object_cursor_style_set() for more details.
25729 * @ingroup Diskselector
25731 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25735 * Get the style for this item cursor.
25737 * @param item diskselector item with cursor already set.
25738 * @return style the theme style in use, defaults to "default". If the
25739 * object does not have a cursor set, then @c NULL is returned.
25741 * @see elm_object_cursor_style_get() for more details.
25742 * @see elm_diskselector_item_cursor_style_set()
25744 * @ingroup Diskselector
25746 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25750 * Set if the cursor set should be searched on the theme or should use
25751 * the provided by the engine, only.
25753 * @note before you set if should look on theme you should define a cursor
25754 * with elm_diskselector_item_cursor_set().
25755 * By default it will only look for cursors provided by the engine.
25757 * @param item widget item with cursor already set.
25758 * @param engine_only boolean to define if cursors set with
25759 * elm_diskselector_item_cursor_set() should be searched only
25760 * between cursors provided by the engine or searched on widget's
25763 * @see elm_object_cursor_engine_only_set() for more details.
25765 * @ingroup Diskselector
25767 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
25770 * Get the cursor engine only usage for this item cursor.
25772 * @param item widget item with cursor already set.
25773 * @return engine_only boolean to define it cursors should be looked only
25774 * between the provided by the engine or searched on widget's theme as well.
25775 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
25777 * @see elm_object_cursor_engine_only_get() for more details.
25778 * @see elm_diskselector_item_cursor_engine_only_set()
25780 * @ingroup Diskselector
25782 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25789 * @defgroup Colorselector Colorselector
25793 * @image html img/widget/colorselector/preview-00.png
25794 * @image latex img/widget/colorselector/preview-00.eps
25796 * @brief Widget for user to select a color.
25798 * Signals that you can add callbacks for are:
25799 * "changed" - When the color value changes(event_info is NULL).
25801 * See @ref tutorial_colorselector.
25804 * @brief Add a new colorselector to the parent
25806 * @param parent The parent object
25807 * @return The new object or NULL if it cannot be created
25809 * @ingroup Colorselector
25811 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25813 * Set a color for the colorselector
25815 * @param obj Colorselector object
25816 * @param r r-value of color
25817 * @param g g-value of color
25818 * @param b b-value of color
25819 * @param a a-value of color
25821 * @ingroup Colorselector
25823 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
25825 * Get a color from the colorselector
25827 * @param obj Colorselector object
25828 * @param r integer pointer for r-value of color
25829 * @param g integer pointer for g-value of color
25830 * @param b integer pointer for b-value of color
25831 * @param a integer pointer for a-value of color
25833 * @ingroup Colorselector
25835 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
25841 * @defgroup Ctxpopup Ctxpopup
25843 * @image html img/widget/ctxpopup/preview-00.png
25844 * @image latex img/widget/ctxpopup/preview-00.eps
25846 * @brief Context popup widet.
25848 * A ctxpopup is a widget that, when shown, pops up a list of items.
25849 * It automatically chooses an area inside its parent object's view
25850 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
25851 * optimally fit into it. In the default theme, it will also point an
25852 * arrow to it's top left position at the time one shows it. Ctxpopup
25853 * items have a label and/or an icon. It is intended for a small
25854 * number of items (hence the use of list, not genlist).
25856 * @note Ctxpopup is a especialization of @ref Hover.
25858 * Signals that you can add callbacks for are:
25859 * "dismissed" - the ctxpopup was dismissed
25861 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
25864 typedef enum _Elm_Ctxpopup_Direction
25866 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25868 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25869 the clicked area */
25870 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25871 the clicked area */
25872 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25874 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25875 } Elm_Ctxpopup_Direction;
25878 * @brief Add a new Ctxpopup object to the parent.
25880 * @param parent Parent object
25881 * @return New object or @c NULL, if it cannot be created
25883 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25885 * @brief Set the Ctxpopup's parent
25887 * @param obj The ctxpopup object
25888 * @param area The parent to use
25890 * Set the parent object.
25892 * @note elm_ctxpopup_add() will automatically call this function
25893 * with its @c parent argument.
25895 * @see elm_ctxpopup_add()
25896 * @see elm_hover_parent_set()
25898 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25900 * @brief Get the Ctxpopup's parent
25902 * @param obj The ctxpopup object
25904 * @see elm_ctxpopup_hover_parent_set() for more information
25906 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25908 * @brief Clear all items in the given ctxpopup object.
25910 * @param obj Ctxpopup object
25912 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25914 * @brief Change the ctxpopup's orientation to horizontal or vertical.
25916 * @param obj Ctxpopup object
25917 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25919 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25921 * @brief Get the value of current ctxpopup object's orientation.
25923 * @param obj Ctxpopup object
25924 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25926 * @see elm_ctxpopup_horizontal_set()
25928 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25930 * @brief Add a new item to a ctxpopup object.
25932 * @param obj Ctxpopup object
25933 * @param icon Icon to be set on new item
25934 * @param label The Label of the new item
25935 * @param func Convenience function called when item selected
25936 * @param data Data passed to @p func
25937 * @return A handle to the item added or @c NULL, on errors
25939 * @warning Ctxpopup can't hold both an item list and a content at the same
25940 * time. When an item is added, any previous content will be removed.
25942 * @see elm_ctxpopup_content_set()
25944 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);
25946 * @brief Delete the given item in a ctxpopup object.
25948 * @param it Ctxpopup item to be deleted
25950 * @see elm_ctxpopup_item_append()
25952 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25954 * @brief Set the ctxpopup item's state as disabled or enabled.
25956 * @param it Ctxpopup item to be enabled/disabled
25957 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
25959 * When disabled the item is greyed out to indicate it's state.
25961 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25963 * @brief Get the ctxpopup item's disabled/enabled state.
25965 * @param it Ctxpopup item to be enabled/disabled
25966 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25968 * @see elm_ctxpopup_item_disabled_set()
25970 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25972 * @brief Get the icon object for the given ctxpopup item.
25974 * @param it Ctxpopup item
25975 * @return icon object or @c NULL, if the item does not have icon or an error
25978 * @see elm_ctxpopup_item_append()
25979 * @see elm_ctxpopup_item_icon_set()
25981 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25983 * @brief Sets the side icon associated with the ctxpopup item
25985 * @param it Ctxpopup item
25986 * @param icon Icon object to be set
25988 * Once the icon object is set, a previously set one will be deleted.
25989 * @warning Setting the same icon for two items will cause the icon to
25990 * dissapear from the first item.
25992 * @see elm_ctxpopup_item_append()
25994 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25996 * @brief Get the label for the given ctxpopup item.
25998 * @param it Ctxpopup item
25999 * @return label string or @c NULL, if the item does not have label or an
26002 * @see elm_ctxpopup_item_append()
26003 * @see elm_ctxpopup_item_label_set()
26005 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26007 * @brief (Re)set the label on the given ctxpopup item.
26009 * @param it Ctxpopup item
26010 * @param label String to set as label
26012 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26014 * @brief Set an elm widget as the content of the ctxpopup.
26016 * @param obj Ctxpopup object
26017 * @param content Content to be swallowed
26019 * If the content object is already set, a previous one will bedeleted. If
26020 * you want to keep that old content object, use the
26021 * elm_ctxpopup_content_unset() function.
26023 * @deprecated use elm_object_content_set()
26025 * @warning Ctxpopup can't hold both a item list and a content at the same
26026 * time. When a content is set, any previous items will be removed.
26028 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26030 * @brief Unset the ctxpopup content
26032 * @param obj Ctxpopup object
26033 * @return The content that was being used
26035 * Unparent and return the content object which was set for this widget.
26037 * @deprecated use elm_object_content_unset()
26039 * @see elm_ctxpopup_content_set()
26041 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26043 * @brief Set the direction priority of a ctxpopup.
26045 * @param obj Ctxpopup object
26046 * @param first 1st priority of direction
26047 * @param second 2nd priority of direction
26048 * @param third 3th priority of direction
26049 * @param fourth 4th priority of direction
26051 * This functions gives a chance to user to set the priority of ctxpopup
26052 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26053 * requested direction.
26055 * @see Elm_Ctxpopup_Direction
26057 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);
26059 * @brief Get the direction priority of a ctxpopup.
26061 * @param obj Ctxpopup object
26062 * @param first 1st priority of direction to be returned
26063 * @param second 2nd priority of direction to be returned
26064 * @param third 3th priority of direction to be returned
26065 * @param fourth 4th priority of direction to be returned
26067 * @see elm_ctxpopup_direction_priority_set() for more information.
26069 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);
26072 * @brief Get the current direction of a ctxpopup.
26074 * @param obj Ctxpopup object
26075 * @return current direction of a ctxpopup
26077 * @warning Once the ctxpopup showed up, the direction would be determined
26079 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26088 * @defgroup Transit Transit
26089 * @ingroup Elementary
26091 * Transit is designed to apply various animated transition effects to @c
26092 * Evas_Object, such like translation, rotation, etc. For using these
26093 * effects, create an @ref Elm_Transit and add the desired transition effects.
26095 * Once the effects are added into transit, they will be automatically
26096 * managed (their callback will be called until the duration is ended, and
26097 * they will be deleted on completion).
26101 * Elm_Transit *trans = elm_transit_add();
26102 * elm_transit_object_add(trans, obj);
26103 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26104 * elm_transit_duration_set(transit, 1);
26105 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26106 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26107 * elm_transit_repeat_times_set(transit, 3);
26110 * Some transition effects are used to change the properties of objects. They
26112 * @li @ref elm_transit_effect_translation_add
26113 * @li @ref elm_transit_effect_color_add
26114 * @li @ref elm_transit_effect_rotation_add
26115 * @li @ref elm_transit_effect_wipe_add
26116 * @li @ref elm_transit_effect_zoom_add
26117 * @li @ref elm_transit_effect_resizing_add
26119 * Other transition effects are used to make one object disappear and another
26120 * object appear on its old place. These effects are:
26122 * @li @ref elm_transit_effect_flip_add
26123 * @li @ref elm_transit_effect_resizable_flip_add
26124 * @li @ref elm_transit_effect_fade_add
26125 * @li @ref elm_transit_effect_blend_add
26127 * It's also possible to make a transition chain with @ref
26128 * elm_transit_chain_transit_add.
26130 * @warning We strongly recommend to use elm_transit just when edje can not do
26131 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26132 * animations can be manipulated inside the theme.
26134 * List of examples:
26135 * @li @ref transit_example_01_explained
26136 * @li @ref transit_example_02_explained
26137 * @li @ref transit_example_03_c
26138 * @li @ref transit_example_04_c
26144 * @enum Elm_Transit_Tween_Mode
26146 * The type of acceleration used in the transition.
26150 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26151 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26152 over time, then decrease again
26154 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26156 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26158 } Elm_Transit_Tween_Mode;
26161 * @enum Elm_Transit_Effect_Flip_Axis
26163 * The axis where flip effect should be applied.
26167 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26168 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26169 } Elm_Transit_Effect_Flip_Axis;
26171 * @enum Elm_Transit_Effect_Wipe_Dir
26173 * The direction where the wipe effect should occur.
26177 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26178 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26179 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26180 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26181 } Elm_Transit_Effect_Wipe_Dir;
26182 /** @enum Elm_Transit_Effect_Wipe_Type
26184 * Whether the wipe effect should show or hide the object.
26188 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26190 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26192 } Elm_Transit_Effect_Wipe_Type;
26195 * @typedef Elm_Transit
26197 * The Transit created with elm_transit_add(). This type has the information
26198 * about the objects which the transition will be applied, and the
26199 * transition effects that will be used. It also contains info about
26200 * duration, number of repetitions, auto-reverse, etc.
26202 typedef struct _Elm_Transit Elm_Transit;
26203 typedef void Elm_Transit_Effect;
26205 * @typedef Elm_Transit_Effect_Transition_Cb
26207 * Transition callback called for this effect on each transition iteration.
26209 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26211 * Elm_Transit_Effect_End_Cb
26213 * Transition callback called for this effect when the transition is over.
26215 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26218 * Elm_Transit_Del_Cb
26220 * A callback called when the transit is deleted.
26222 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26227 * @note Is not necessary to delete the transit object, it will be deleted at
26228 * the end of its operation.
26229 * @note The transit will start playing when the program enter in the main loop, is not
26230 * necessary to give a start to the transit.
26232 * @return The transit object.
26236 EAPI Elm_Transit *elm_transit_add(void);
26239 * Stops the animation and delete the @p transit object.
26241 * Call this function if you wants to stop the animation before the duration
26242 * time. Make sure the @p transit object is still alive with
26243 * elm_transit_del_cb_set() function.
26244 * All added effects will be deleted, calling its repective data_free_cb
26245 * functions. The function setted by elm_transit_del_cb_set() will be called.
26247 * @see elm_transit_del_cb_set()
26249 * @param transit The transit object to be deleted.
26252 * @warning Just call this function if you are sure the transit is alive.
26254 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26257 * Add a new effect to the transit.
26259 * @note The cb function and the data are the key to the effect. If you try to
26260 * add an already added effect, nothing is done.
26261 * @note After the first addition of an effect in @p transit, if its
26262 * effect list become empty again, the @p transit will be killed by
26263 * elm_transit_del(transit) function.
26267 * Elm_Transit *transit = elm_transit_add();
26268 * elm_transit_effect_add(transit,
26269 * elm_transit_effect_blend_op,
26270 * elm_transit_effect_blend_context_new(),
26271 * elm_transit_effect_blend_context_free);
26274 * @param transit The transit object.
26275 * @param transition_cb The operation function. It is called when the
26276 * animation begins, it is the function that actually performs the animation.
26277 * It is called with the @p data, @p transit and the time progression of the
26278 * animation (a double value between 0.0 and 1.0).
26279 * @param effect The context data of the effect.
26280 * @param end_cb The function to free the context data, it will be called
26281 * at the end of the effect, it must finalize the animation and free the
26285 * @warning The transit free the context data at the and of the transition with
26286 * the data_free_cb function, do not use the context data in another transit.
26288 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);
26291 * Delete an added effect.
26293 * This function will remove the effect from the @p transit, calling the
26294 * data_free_cb to free the @p data.
26296 * @see elm_transit_effect_add()
26298 * @note If the effect is not found, nothing is done.
26299 * @note If the effect list become empty, this function will call
26300 * elm_transit_del(transit), that is, it will kill the @p transit.
26302 * @param transit The transit object.
26303 * @param transition_cb The operation function.
26304 * @param effect The context data of the effect.
26308 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);
26311 * Add new object to apply the effects.
26313 * @note After the first addition of an object in @p transit, if its
26314 * object list become empty again, the @p transit will be killed by
26315 * elm_transit_del(transit) function.
26316 * @note If the @p obj belongs to another transit, the @p obj will be
26317 * removed from it and it will only belong to the @p transit. If the old
26318 * transit stays without objects, it will die.
26319 * @note When you add an object into the @p transit, its state from
26320 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26321 * transit ends, if you change this state whith evas_object_pass_events_set()
26322 * after add the object, this state will change again when @p transit stops to
26325 * @param transit The transit object.
26326 * @param obj Object to be animated.
26329 * @warning It is not allowed to add a new object after transit begins to go.
26331 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26334 * Removes an added object from the transit.
26336 * @note If the @p obj is not in the @p transit, nothing is done.
26337 * @note If the list become empty, this function will call
26338 * elm_transit_del(transit), that is, it will kill the @p transit.
26340 * @param transit The transit object.
26341 * @param obj Object to be removed from @p transit.
26344 * @warning It is not allowed to remove objects after transit begins to go.
26346 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26349 * Get the objects of the transit.
26351 * @param transit The transit object.
26352 * @return a Eina_List with the objects from the transit.
26356 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26359 * Enable/disable keeping up the objects states.
26360 * If it is not kept, the objects states will be reset when transition ends.
26362 * @note @p transit can not be NULL.
26363 * @note One state includes geometry, color, map data.
26365 * @param transit The transit object.
26366 * @param state_keep Keeping or Non Keeping.
26370 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26373 * Get a value whether the objects states will be reset or not.
26375 * @note @p transit can not be NULL
26377 * @see elm_transit_objects_final_state_keep_set()
26379 * @param transit The transit object.
26380 * @return EINA_TRUE means the states of the objects will be reset.
26381 * If @p transit is NULL, EINA_FALSE is returned
26385 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26388 * Set the event enabled when transit is operating.
26390 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26391 * events from mouse and keyboard during the animation.
26392 * @note When you add an object with elm_transit_object_add(), its state from
26393 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26394 * transit ends, if you change this state with evas_object_pass_events_set()
26395 * after adding the object, this state will change again when @p transit stops
26398 * @param transit The transit object.
26399 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26400 * ignored otherwise.
26404 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26407 * Get the value of event enabled status.
26409 * @see elm_transit_event_enabled_set()
26411 * @param transit The Transit object
26412 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26413 * EINA_FALSE is returned
26417 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26420 * Set the user-callback function when the transit is deleted.
26422 * @note Using this function twice will overwrite the first function setted.
26423 * @note the @p transit object will be deleted after call @p cb function.
26425 * @param transit The transit object.
26426 * @param cb Callback function pointer. This function will be called before
26427 * the deletion of the transit.
26428 * @param data Callback funtion user data. It is the @p op parameter.
26432 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26435 * Set reverse effect automatically.
26437 * If auto reverse is setted, after running the effects with the progress
26438 * parameter from 0 to 1, it will call the effecs again with the progress
26439 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26440 * where the duration was setted with the function elm_transit_add and
26441 * the repeat with the function elm_transit_repeat_times_set().
26443 * @param transit The transit object.
26444 * @param reverse EINA_TRUE means the auto_reverse is on.
26448 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26451 * Get if the auto reverse is on.
26453 * @see elm_transit_auto_reverse_set()
26455 * @param transit The transit object.
26456 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26457 * EINA_FALSE is returned
26461 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26464 * Set the transit repeat count. Effect will be repeated by repeat count.
26466 * This function sets the number of repetition the transit will run after
26467 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26468 * If the @p repeat is a negative number, it will repeat infinite times.
26470 * @note If this function is called during the transit execution, the transit
26471 * will run @p repeat times, ignoring the times it already performed.
26473 * @param transit The transit object
26474 * @param repeat Repeat count
26478 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26481 * Get the transit repeat count.
26483 * @see elm_transit_repeat_times_set()
26485 * @param transit The Transit object.
26486 * @return The repeat count. If @p transit is NULL
26491 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26494 * Set the transit animation acceleration type.
26496 * This function sets the tween mode of the transit that can be:
26497 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26498 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26499 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26500 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26502 * @param transit The transit object.
26503 * @param tween_mode The tween type.
26507 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26510 * Get the transit animation acceleration type.
26512 * @note @p transit can not be NULL
26514 * @param transit The transit object.
26515 * @return The tween type. If @p transit is NULL
26516 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26520 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26523 * Set the transit animation time
26525 * @note @p transit can not be NULL
26527 * @param transit The transit object.
26528 * @param duration The animation time.
26532 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26535 * Get the transit animation time
26537 * @note @p transit can not be NULL
26539 * @param transit The transit object.
26541 * @return The transit animation time.
26545 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26548 * Starts the transition.
26549 * Once this API is called, the transit begins to measure the time.
26551 * @note @p transit can not be NULL
26553 * @param transit The transit object.
26557 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26560 * Pause/Resume the transition.
26562 * If you call elm_transit_go again, the transit will be started from the
26563 * beginning, and will be unpaused.
26565 * @note @p transit can not be NULL
26567 * @param transit The transit object.
26568 * @param paused Whether the transition should be paused or not.
26572 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26575 * Get the value of paused status.
26577 * @see elm_transit_paused_set()
26579 * @note @p transit can not be NULL
26581 * @param transit The transit object.
26582 * @return EINA_TRUE means transition is paused. If @p transit is NULL
26583 * EINA_FALSE is returned
26587 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26590 * Get the time progression of the animation (a double value between 0.0 and 1.0).
26592 * The value returned is a fraction (current time / total time). It
26593 * represents the progression position relative to the total.
26595 * @note @p transit can not be NULL
26597 * @param transit The transit object.
26599 * @return The time progression value. If @p transit is NULL
26604 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26607 * Makes the chain relationship between two transits.
26609 * @note @p transit can not be NULL. Transit would have multiple chain transits.
26610 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26612 * @param transit The transit object.
26613 * @param chain_transit The chain transit object. This transit will be operated
26614 * after transit is done.
26616 * This function adds @p chain_transit transition to a chain after the @p
26617 * transit, and will be started as soon as @p transit ends. See @ref
26618 * transit_example_02_explained for a full example.
26622 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26625 * Cut off the chain relationship between two transits.
26627 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26628 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26630 * @param transit The transit object.
26631 * @param chain_transit The chain transit object.
26633 * This function remove the @p chain_transit transition from the @p transit.
26637 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26640 * Get the current chain transit list.
26642 * @note @p transit can not be NULL.
26644 * @param transit The transit object.
26645 * @return chain transit list.
26649 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
26652 * Add the Resizing Effect to Elm_Transit.
26654 * @note This API is one of the facades. It creates resizing effect context
26655 * and add it's required APIs to elm_transit_effect_add.
26657 * @see elm_transit_effect_add()
26659 * @param transit Transit object.
26660 * @param from_w Object width size when effect begins.
26661 * @param from_h Object height size when effect begins.
26662 * @param to_w Object width size when effect ends.
26663 * @param to_h Object height size when effect ends.
26664 * @return Resizing effect context data.
26668 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);
26671 * Add the Translation Effect to Elm_Transit.
26673 * @note This API is one of the facades. It creates translation effect context
26674 * and add it's required APIs to elm_transit_effect_add.
26676 * @see elm_transit_effect_add()
26678 * @param transit Transit object.
26679 * @param from_dx X Position variation when effect begins.
26680 * @param from_dy Y Position variation when effect begins.
26681 * @param to_dx X Position variation when effect ends.
26682 * @param to_dy Y Position variation when effect ends.
26683 * @return Translation effect context data.
26686 * @warning It is highly recommended just create a transit with this effect when
26687 * the window that the objects of the transit belongs has already been created.
26688 * This is because this effect needs the geometry information about the objects,
26689 * and if the window was not created yet, it can get a wrong information.
26691 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);
26694 * Add the Zoom Effect to Elm_Transit.
26696 * @note This API is one of the facades. It creates zoom effect context
26697 * and add it's required APIs to elm_transit_effect_add.
26699 * @see elm_transit_effect_add()
26701 * @param transit Transit object.
26702 * @param from_rate Scale rate when effect begins (1 is current rate).
26703 * @param to_rate Scale rate when effect ends.
26704 * @return Zoom effect context data.
26707 * @warning It is highly recommended just create a transit with this effect when
26708 * the window that the objects of the transit belongs has already been created.
26709 * This is because this effect needs the geometry information about the objects,
26710 * and if the window was not created yet, it can get a wrong information.
26712 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
26715 * Add the Flip Effect to Elm_Transit.
26717 * @note This API is one of the facades. It creates flip effect context
26718 * and add it's required APIs to elm_transit_effect_add.
26719 * @note This effect is applied to each pair of objects in the order they are listed
26720 * in the transit list of objects. The first object in the pair will be the
26721 * "front" object and the second will be the "back" object.
26723 * @see elm_transit_effect_add()
26725 * @param transit Transit object.
26726 * @param axis Flipping Axis(X or Y).
26727 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26728 * @return Flip effect context data.
26731 * @warning It is highly recommended just create a transit with this effect when
26732 * the window that the objects of the transit belongs has already been created.
26733 * This is because this effect needs the geometry information about the objects,
26734 * and if the window was not created yet, it can get a wrong information.
26736 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26739 * Add the Resizable Flip Effect to Elm_Transit.
26741 * @note This API is one of the facades. It creates resizable flip effect context
26742 * and add it's required APIs to elm_transit_effect_add.
26743 * @note This effect is applied to each pair of objects in the order they are listed
26744 * in the transit list of objects. The first object in the pair will be the
26745 * "front" object and the second will be the "back" object.
26747 * @see elm_transit_effect_add()
26749 * @param transit Transit object.
26750 * @param axis Flipping Axis(X or Y).
26751 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26752 * @return Resizable flip effect context data.
26755 * @warning It is highly recommended just create a transit with this effect when
26756 * the window that the objects of the transit belongs has already been created.
26757 * This is because this effect needs the geometry information about the objects,
26758 * and if the window was not created yet, it can get a wrong information.
26760 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26763 * Add the Wipe Effect to Elm_Transit.
26765 * @note This API is one of the facades. It creates wipe effect context
26766 * and add it's required APIs to elm_transit_effect_add.
26768 * @see elm_transit_effect_add()
26770 * @param transit Transit object.
26771 * @param type Wipe type. Hide or show.
26772 * @param dir Wipe Direction.
26773 * @return Wipe effect context data.
26776 * @warning It is highly recommended just create a transit with this effect when
26777 * the window that the objects of the transit belongs has already been created.
26778 * This is because this effect needs the geometry information about the objects,
26779 * and if the window was not created yet, it can get a wrong information.
26781 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
26784 * Add the Color Effect to Elm_Transit.
26786 * @note This API is one of the facades. It creates color effect context
26787 * and add it's required APIs to elm_transit_effect_add.
26789 * @see elm_transit_effect_add()
26791 * @param transit Transit object.
26792 * @param from_r RGB R when effect begins.
26793 * @param from_g RGB G when effect begins.
26794 * @param from_b RGB B when effect begins.
26795 * @param from_a RGB A when effect begins.
26796 * @param to_r RGB R when effect ends.
26797 * @param to_g RGB G when effect ends.
26798 * @param to_b RGB B when effect ends.
26799 * @param to_a RGB A when effect ends.
26800 * @return Color effect context data.
26804 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);
26807 * Add the Fade Effect to Elm_Transit.
26809 * @note This API is one of the facades. It creates fade effect context
26810 * and add it's required APIs to elm_transit_effect_add.
26811 * @note This effect is applied to each pair of objects in the order they are listed
26812 * in the transit list of objects. The first object in the pair will be the
26813 * "before" object and the second will be the "after" object.
26815 * @see elm_transit_effect_add()
26817 * @param transit Transit object.
26818 * @return Fade effect context data.
26821 * @warning It is highly recommended just create a transit with this effect when
26822 * the window that the objects of the transit belongs has already been created.
26823 * This is because this effect needs the color information about the objects,
26824 * and if the window was not created yet, it can get a wrong information.
26826 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
26829 * Add the Blend Effect to Elm_Transit.
26831 * @note This API is one of the facades. It creates blend effect context
26832 * and add it's required APIs to elm_transit_effect_add.
26833 * @note This effect is applied to each pair of objects in the order they are listed
26834 * in the transit list of objects. The first object in the pair will be the
26835 * "before" object and the second will be the "after" object.
26837 * @see elm_transit_effect_add()
26839 * @param transit Transit object.
26840 * @return Blend effect context data.
26843 * @warning It is highly recommended just create a transit with this effect when
26844 * the window that the objects of the transit belongs has already been created.
26845 * This is because this effect needs the color information about the objects,
26846 * and if the window was not created yet, it can get a wrong information.
26848 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
26851 * Add the Rotation Effect to Elm_Transit.
26853 * @note This API is one of the facades. It creates rotation effect context
26854 * and add it's required APIs to elm_transit_effect_add.
26856 * @see elm_transit_effect_add()
26858 * @param transit Transit object.
26859 * @param from_degree Degree when effect begins.
26860 * @param to_degree Degree when effect is ends.
26861 * @return Rotation effect context data.
26864 * @warning It is highly recommended just create a transit with this effect when
26865 * the window that the objects of the transit belongs has already been created.
26866 * This is because this effect needs the geometry information about the objects,
26867 * and if the window was not created yet, it can get a wrong information.
26869 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26872 * Add the ImageAnimation Effect to Elm_Transit.
26874 * @note This API is one of the facades. It creates image animation effect context
26875 * and add it's required APIs to elm_transit_effect_add.
26876 * The @p images parameter is a list images paths. This list and
26877 * its contents will be deleted at the end of the effect by
26878 * elm_transit_effect_image_animation_context_free() function.
26882 * char buf[PATH_MAX];
26883 * Eina_List *images = NULL;
26884 * Elm_Transit *transi = elm_transit_add();
26886 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26887 * images = eina_list_append(images, eina_stringshare_add(buf));
26889 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26890 * images = eina_list_append(images, eina_stringshare_add(buf));
26891 * elm_transit_effect_image_animation_add(transi, images);
26895 * @see elm_transit_effect_add()
26897 * @param transit Transit object.
26898 * @param images Eina_List of images file paths. This list and
26899 * its contents will be deleted at the end of the effect by
26900 * elm_transit_effect_image_animation_context_free() function.
26901 * @return Image Animation effect context data.
26905 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26910 typedef struct _Elm_Store Elm_Store;
26911 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
26912 typedef struct _Elm_Store_Item Elm_Store_Item;
26913 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
26914 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
26915 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26916 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
26917 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
26918 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
26919 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
26920 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
26922 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26923 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26924 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26925 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26929 ELM_STORE_ITEM_MAPPING_NONE = 0,
26930 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26931 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26932 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26933 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26934 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26935 // can add more here as needed by common apps
26936 ELM_STORE_ITEM_MAPPING_LAST
26937 } Elm_Store_Item_Mapping_Type;
26939 struct _Elm_Store_Item_Mapping_Icon
26941 // FIXME: allow edje file icons
26943 Elm_Icon_Lookup_Order lookup_order;
26944 Eina_Bool standard_name : 1;
26945 Eina_Bool no_scale : 1;
26946 Eina_Bool smooth : 1;
26947 Eina_Bool scale_up : 1;
26948 Eina_Bool scale_down : 1;
26951 struct _Elm_Store_Item_Mapping_Empty
26956 struct _Elm_Store_Item_Mapping_Photo
26961 struct _Elm_Store_Item_Mapping_Custom
26963 Elm_Store_Item_Mapping_Cb func;
26966 struct _Elm_Store_Item_Mapping
26968 Elm_Store_Item_Mapping_Type type;
26973 Elm_Store_Item_Mapping_Empty empty;
26974 Elm_Store_Item_Mapping_Icon icon;
26975 Elm_Store_Item_Mapping_Photo photo;
26976 Elm_Store_Item_Mapping_Custom custom;
26977 // add more types here
26981 struct _Elm_Store_Item_Info
26983 Elm_Genlist_Item_Class *item_class;
26984 const Elm_Store_Item_Mapping *mapping;
26989 struct _Elm_Store_Item_Info_Filesystem
26991 Elm_Store_Item_Info base;
26995 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26996 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26998 EAPI void elm_store_free(Elm_Store *st);
27000 EAPI Elm_Store *elm_store_filesystem_new(void);
27001 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27002 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27003 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27005 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27007 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27008 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27009 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27010 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27011 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27012 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27014 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27015 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27016 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27017 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27018 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27019 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27020 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27023 * @defgroup SegmentControl SegmentControl
27024 * @ingroup Elementary
27026 * @image html img/widget/segment_control/preview-00.png
27027 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27029 * @image html img/segment_control.png
27030 * @image latex img/segment_control.eps width=\textwidth
27032 * Segment control widget is a horizontal control made of multiple segment
27033 * items, each segment item functioning similar to discrete two state button.
27034 * A segment control groups the items together and provides compact
27035 * single button with multiple equal size segments.
27037 * Segment item size is determined by base widget
27038 * size and the number of items added.
27039 * Only one segment item can be at selected state. A segment item can display
27040 * combination of Text and any Evas_Object like Images or other widget.
27042 * Smart callbacks one can listen to:
27043 * - "changed" - When the user clicks on a segment item which is not
27044 * previously selected and get selected. The event_info parameter is the
27045 * segment item index.
27047 * Available styles for it:
27050 * Here is an example on its usage:
27051 * @li @ref segment_control_example
27055 * @addtogroup SegmentControl
27059 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27062 * Add a new segment control widget to the given parent Elementary
27063 * (container) object.
27065 * @param parent The parent object.
27066 * @return a new segment control widget handle or @c NULL, on errors.
27068 * This function inserts a new segment control widget on the canvas.
27070 * @ingroup SegmentControl
27072 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27075 * Append a new item to the segment control object.
27077 * @param obj The segment control object.
27078 * @param icon The icon object to use for the left side of the item. An
27079 * icon can be any Evas object, but usually it is an icon created
27080 * with elm_icon_add().
27081 * @param label The label of the item.
27082 * Note that, NULL is different from empty string "".
27083 * @return The created item or @c NULL upon failure.
27085 * A new item will be created and appended to the segment control, i.e., will
27086 * be set as @b last item.
27088 * If it should be inserted at another position,
27089 * elm_segment_control_item_insert_at() should be used instead.
27091 * Items created with this function can be deleted with function
27092 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27094 * @note @p label set to @c NULL is different from empty string "".
27096 * only has icon, it will be displayed bigger and centered. If it has
27097 * icon and label, even that an empty string, icon will be smaller and
27098 * positioned at left.
27102 * sc = elm_segment_control_add(win);
27103 * ic = elm_icon_add(win);
27104 * elm_icon_file_set(ic, "path/to/image", NULL);
27105 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27106 * elm_segment_control_item_add(sc, ic, "label");
27107 * evas_object_show(sc);
27110 * @see elm_segment_control_item_insert_at()
27111 * @see elm_segment_control_item_del()
27113 * @ingroup SegmentControl
27115 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27118 * Insert a new item to the segment control object at specified position.
27120 * @param obj The segment control object.
27121 * @param icon The icon object to use for the left side of the item. An
27122 * icon can be any Evas object, but usually it is an icon created
27123 * with elm_icon_add().
27124 * @param label The label of the item.
27125 * @param index Item position. Value should be between 0 and items count.
27126 * @return The created item or @c NULL upon failure.
27128 * Index values must be between @c 0, when item will be prepended to
27129 * segment control, and items count, that can be get with
27130 * elm_segment_control_item_count_get(), case when item will be appended
27131 * to segment control, just like elm_segment_control_item_add().
27133 * Items created with this function can be deleted with function
27134 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27136 * @note @p label set to @c NULL is different from empty string "".
27138 * only has icon, it will be displayed bigger and centered. If it has
27139 * icon and label, even that an empty string, icon will be smaller and
27140 * positioned at left.
27142 * @see elm_segment_control_item_add()
27143 * @see elm_segment_control_item_count_get()
27144 * @see elm_segment_control_item_del()
27146 * @ingroup SegmentControl
27148 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);
27151 * Remove a segment control item from its parent, deleting it.
27153 * @param it The item to be removed.
27155 * Items can be added with elm_segment_control_item_add() or
27156 * elm_segment_control_item_insert_at().
27158 * @ingroup SegmentControl
27160 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27163 * Remove a segment control item at given index from its parent,
27166 * @param obj The segment control object.
27167 * @param index The position of the segment control item to be deleted.
27169 * Items can be added with elm_segment_control_item_add() or
27170 * elm_segment_control_item_insert_at().
27172 * @ingroup SegmentControl
27174 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27177 * Get the Segment items count from segment control.
27179 * @param obj The segment control object.
27180 * @return Segment items count.
27182 * It will just return the number of items added to segment control @p obj.
27184 * @ingroup SegmentControl
27186 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27189 * Get the item placed at specified index.
27191 * @param obj The segment control object.
27192 * @param index The index of the segment item.
27193 * @return The segment control item or @c NULL on failure.
27195 * Index is the position of an item in segment control widget. Its
27196 * range is from @c 0 to <tt> count - 1 </tt>.
27197 * Count is the number of items, that can be get with
27198 * elm_segment_control_item_count_get().
27200 * @ingroup SegmentControl
27202 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27205 * Get the label of item.
27207 * @param obj The segment control object.
27208 * @param index The index of the segment item.
27209 * @return The label of the item at @p index.
27211 * The return value is a pointer to the label associated to the item when
27212 * it was created, with function elm_segment_control_item_add(), or later
27213 * with function elm_segment_control_item_label_set. If no label
27214 * was passed as argument, it will return @c NULL.
27216 * @see elm_segment_control_item_label_set() for more details.
27217 * @see elm_segment_control_item_add()
27219 * @ingroup SegmentControl
27221 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27224 * Set the label of item.
27226 * @param it The item of segment control.
27227 * @param text The label of item.
27229 * The label to be displayed by the item.
27230 * Label will be at right of the icon (if set).
27232 * If a label was passed as argument on item creation, with function
27233 * elm_control_segment_item_add(), it will be already
27234 * displayed by the item.
27236 * @see elm_segment_control_item_label_get()
27237 * @see elm_segment_control_item_add()
27239 * @ingroup SegmentControl
27241 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27244 * Get the icon associated to the item.
27246 * @param obj The segment control object.
27247 * @param index The index of the segment item.
27248 * @return The left side icon associated to the item at @p index.
27250 * The return value is a pointer to the icon associated to the item when
27251 * it was created, with function elm_segment_control_item_add(), or later
27252 * with function elm_segment_control_item_icon_set(). If no icon
27253 * was passed as argument, it will return @c NULL.
27255 * @see elm_segment_control_item_add()
27256 * @see elm_segment_control_item_icon_set()
27258 * @ingroup SegmentControl
27260 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27263 * Set the icon associated to the item.
27265 * @param it The segment control item.
27266 * @param icon The icon object to associate with @p it.
27268 * The icon object to use at left side of the item. An
27269 * icon can be any Evas object, but usually it is an icon created
27270 * with elm_icon_add().
27272 * Once the icon object is set, a previously set one will be deleted.
27273 * @warning Setting the same icon for two items will cause the icon to
27274 * dissapear from the first item.
27276 * If an icon was passed as argument on item creation, with function
27277 * elm_segment_control_item_add(), it will be already
27278 * associated to the item.
27280 * @see elm_segment_control_item_add()
27281 * @see elm_segment_control_item_icon_get()
27283 * @ingroup SegmentControl
27285 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27288 * Get the index of an item.
27290 * @param it The segment control item.
27291 * @return The position of item in segment control widget.
27293 * Index is the position of an item in segment control widget. Its
27294 * range is from @c 0 to <tt> count - 1 </tt>.
27295 * Count is the number of items, that can be get with
27296 * elm_segment_control_item_count_get().
27298 * @ingroup SegmentControl
27300 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27303 * Get the base object of the item.
27305 * @param it The segment control item.
27306 * @return The base object associated with @p it.
27308 * Base object is the @c Evas_Object that represents that item.
27310 * @ingroup SegmentControl
27312 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27315 * Get the selected item.
27317 * @param obj The segment control object.
27318 * @return The selected item or @c NULL if none of segment items is
27321 * The selected item can be unselected with function
27322 * elm_segment_control_item_selected_set().
27324 * The selected item always will be highlighted on segment control.
27326 * @ingroup SegmentControl
27328 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27331 * Set the selected state of an item.
27333 * @param it The segment control item
27334 * @param select The selected state
27336 * This sets the selected state of the given item @p it.
27337 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27339 * If a new item is selected the previosly selected will be unselected.
27340 * Previoulsy selected item can be get with function
27341 * elm_segment_control_item_selected_get().
27343 * The selected item always will be highlighted on segment control.
27345 * @see elm_segment_control_item_selected_get()
27347 * @ingroup SegmentControl
27349 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27356 * @defgroup Grid Grid
27358 * The grid is a grid layout widget that lays out a series of children as a
27359 * fixed "grid" of widgets using a given percentage of the grid width and
27360 * height each using the child object.
27362 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27363 * widgets size itself. The default is 100 x 100, so that means the
27364 * position and sizes of children will effectively be percentages (0 to 100)
27365 * of the width or height of the grid widget
27371 * Add a new grid to the parent
27373 * @param parent The parent object
27374 * @return The new object or NULL if it cannot be created
27378 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27381 * Set the virtual size of the grid
27383 * @param obj The grid object
27384 * @param w The virtual width of the grid
27385 * @param h The virtual height of the grid
27389 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27392 * Get the virtual size of the grid
27394 * @param obj The grid object
27395 * @param w Pointer to integer to store the virtual width of the grid
27396 * @param h Pointer to integer to store the virtual height of the grid
27400 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27403 * Pack child at given position and size
27405 * @param obj The grid object
27406 * @param subobj The child to pack
27407 * @param x The virtual x coord at which to pack it
27408 * @param y The virtual y coord at which to pack it
27409 * @param w The virtual width at which to pack it
27410 * @param h The virtual height at which to pack it
27414 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27417 * Unpack a child from a grid object
27419 * @param obj The grid object
27420 * @param subobj The child to unpack
27424 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27427 * Faster way to remove all child objects from a grid object.
27429 * @param obj The grid object
27430 * @param clear If true, it will delete just removed children
27434 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27437 * Set packing of an existing child at to position and size
27439 * @param subobj The child to set packing of
27440 * @param x The virtual x coord at which to pack it
27441 * @param y The virtual y coord at which to pack it
27442 * @param w The virtual width at which to pack it
27443 * @param h The virtual height at which to pack it
27447 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27450 * get packing of a child
27452 * @param subobj The child to query
27453 * @param x Pointer to integer to store the virtual x coord
27454 * @param y Pointer to integer to store the virtual y coord
27455 * @param w Pointer to integer to store the virtual width
27456 * @param h Pointer to integer to store the virtual height
27460 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27466 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27467 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27468 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27469 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27470 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
27471 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
27474 * @defgroup Video Video
27476 * This object display an player that let you control an Elm_Video
27477 * object. It take care of updating it's content according to what is
27478 * going on inside the Emotion object. It does activate the remember
27479 * function on the linked Elm_Video object.
27481 * Signals that you can add callback for are :
27483 * "forward,clicked" - the user clicked the forward button.
27484 * "info,clicked" - the user clicked the info button.
27485 * "next,clicked" - the user clicked the next button.
27486 * "pause,clicked" - the user clicked the pause button.
27487 * "play,clicked" - the user clicked the play button.
27488 * "prev,clicked" - the user clicked the prev button.
27489 * "rewind,clicked" - the user clicked the rewind button.
27490 * "stop,clicked" - the user clicked the stop button.
27492 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27493 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27494 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27495 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27496 EAPI void elm_video_play(Evas_Object *video);
27497 EAPI void elm_video_pause(Evas_Object *video);
27498 EAPI void elm_video_stop(Evas_Object *video);
27499 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27500 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27501 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27502 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27503 EAPI double elm_video_audio_level_get(Evas_Object *video);
27504 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27505 EAPI double elm_video_play_position_get(Evas_Object *video);
27506 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27507 EAPI double elm_video_play_length_get(Evas_Object *video);
27508 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27509 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27510 EAPI const char *elm_video_title_get(Evas_Object *video);
27512 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27513 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27516 * @defgroup Naviframe Naviframe
27518 * @brief Naviframe is a kind of view manager for the applications.
27520 * Naviframe provides functions to switch different pages with stack
27521 * mechanism. It means if one page(item) needs to be changed to the new one,
27522 * then naviframe would push the new page to it's internal stack. Of course,
27523 * it can be back to the previous page by popping the top page. Naviframe
27524 * provides some transition effect while the pages are switching (same as
27527 * Since each item could keep the different styles, users could keep the
27528 * same look & feel for the pages or different styles for the items in it's
27531 * Signals that you can add callback for are:
27533 * @li "transition,finished" - When the transition is finished in changing
27535 * @li "title,clicked" - User clicked title area
27537 * Default contents parts for the naviframe items that you can use for are:
27539 * @li "elm.swallow.content" - The main content of the page
27540 * @li "elm.swallow.prev_btn" - The button to go to the previous page
27541 * @li "elm.swallow.next_btn" - The button to go to the next page
27543 * Default text parts of naviframe items that you can be used are:
27545 * @li "elm.text.title" - The title label in the title area
27547 * @ref tutorial_naviframe gives a good overview of the usage of the API.
27551 * @brief Add a new Naviframe object to the parent.
27553 * @param parent Parent object
27554 * @return New object or @c NULL, if it cannot be created
27556 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27558 * @brief Push a new item to the top of the naviframe stack (and show it).
27560 * @param obj The naviframe object
27561 * @param title_label The label in the title area. The name of the title
27562 * label part is "elm.text.title"
27563 * @param prev_btn The button to go to the previous item. If it is NULL,
27564 * then naviframe will create a back button automatically. The name of
27565 * the prev_btn part is "elm.swallow.prev_btn"
27566 * @param next_btn The button to go to the next item. Or It could be just an
27567 * extra function button. The name of the next_btn part is
27568 * "elm.swallow.next_btn"
27569 * @param content The main content object. The name of content part is
27570 * "elm.swallow.content"
27571 * @param item_style The current item style name. @c NULL would be default.
27572 * @return The created item or @c NULL upon failure.
27574 * The item pushed becomes one page of the naviframe, this item will be
27575 * deleted when it is popped.
27577 * @see also elm_naviframe_item_style_set()
27579 * The following styles are available for this item:
27582 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);
27584 * @brief Pop an item that is on top of the stack
27586 * @param obj The naviframe object
27587 * @return @c NULL or the content object(if the
27588 * elm_naviframe_content_preserve_on_pop_get is true).
27590 * This pops an item that is on the top(visible) of the naviframe, makes it
27591 * disappear, then deletes the item. The item that was underneath it on the
27592 * stack will become visible.
27594 * @see also elm_naviframe_content_preserve_on_pop_get()
27596 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
27598 * @brief Pop the items between the top and the above one on the given item.
27600 * @param it The naviframe item
27602 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27604 * @brief preserve the content objects when items are popped.
27606 * @param obj The naviframe object
27607 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
27609 * @see also elm_naviframe_content_preserve_on_pop_get()
27611 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
27613 * @brief Get a value whether preserve mode is enabled or not.
27615 * @param obj The naviframe object
27616 * @return If @c EINA_TRUE, preserve mode is enabled
27618 * @see also elm_naviframe_content_preserve_on_pop_set()
27620 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27622 * @brief Get a top item on the naviframe stack
27624 * @param obj The naviframe object
27625 * @return The top item on the naviframe stack or @c NULL, if the stack is
27628 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27630 * @brief Get a bottom item on the naviframe stack
27632 * @param obj The naviframe object
27633 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
27636 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27638 * @brief Set an item style
27640 * @param obj The naviframe item
27641 * @param item_style The current item style name. @c NULL would be default
27643 * The following styles are available for this item:
27646 * @see also elm_naviframe_item_style_get()
27648 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
27650 * @brief Get an item style
27652 * @param obj The naviframe item
27653 * @return The current item style name
27655 * @see also elm_naviframe_item_style_set()
27657 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27659 * @brief Show/Hide the title area
27661 * @param it The naviframe item
27662 * @param visible If @c EINA_TRUE, title area will be visible, hidden
27665 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
27667 * @see also elm_naviframe_item_title_visible_get()
27669 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
27671 * @brief Get a value whether title area is visible or not.
27673 * @param it The naviframe item
27674 * @return If @c EINA_TRUE, title area is visible
27676 * @see also elm_naviframe_item_title_visible_set()
27678 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);