3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when any Elementary's policy value is changed.
488 EAPI extern int ELM_EVENT_POLICY_CHANGED;
491 * @typedef Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498 * @struct _Elm_Event_Policy_Changed
500 * Data on the event when an Elementary policy has changed
502 struct _Elm_Event_Policy_Changed
504 unsigned int policy; /**< the policy identifier */
505 int new_value; /**< value the policy had before the change */
506 int old_value; /**< new value the policy got */
510 * Policy identifiers.
512 typedef enum _Elm_Policy
514 ELM_POLICY_QUIT, /**< under which circumstances the application
515 * should quit automatically. @see
519 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
522 typedef enum _Elm_Policy_Quit
524 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
526 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
528 * window is closed */
529 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
531 typedef enum _Elm_Focus_Direction
535 } Elm_Focus_Direction;
537 typedef enum _Elm_Text_Format
539 ELM_TEXT_FORMAT_PLAIN_UTF8,
540 ELM_TEXT_FORMAT_MARKUP_UTF8
544 * Line wrapping types.
546 typedef enum _Elm_Wrap_Type
548 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
558 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
559 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
560 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
561 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
562 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
563 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
565 ELM_INPUT_PANEL_LAYOUT_INVALID
566 } Elm_Input_Panel_Layout;
570 ELM_AUTOCAPITAL_TYPE_NONE,
571 ELM_AUTOCAPITAL_TYPE_WORD,
572 ELM_AUTOCAPITAL_TYPE_SENTENCE,
573 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
574 } Elm_Autocapital_Type;
577 * @typedef Elm_Object_Item
578 * An Elementary Object item handle.
581 typedef struct _Elm_Object_Item Elm_Object_Item;
585 * Called back when a widget's tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
589 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
592 * Called back when a widget's item tooltip is activated and needs content.
593 * @param data user-data given to elm_object_tooltip_content_cb_set()
594 * @param obj owner widget.
595 * @param item context dependent item. As an example, if tooltip was
596 * set on Elm_List_Item, then it is of this type.
598 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
600 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
602 #ifndef ELM_LIB_QUICKLAUNCH
603 #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 */
605 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
608 /**************************************************************************/
612 * Initialize Elementary
614 * @param[in] argc System's argument count value
615 * @param[in] argv System's pointer to array of argument strings
616 * @return The init counter value.
618 * This function initializes Elementary and increments a counter of
619 * the number of calls to it. It returns the new counter's value.
621 * @warning This call is exported only for use by the @c ELM_MAIN()
622 * macro. There is no need to use this if you use this macro (which
623 * is highly advisable). An elm_main() should contain the entry
624 * point code for your application, having the same prototype as
625 * elm_init(), and @b not being static (putting the @c EAPI symbol
626 * in front of its type declaration is advisable). The @c
627 * ELM_MAIN() call should be placed just after it.
630 * @dontinclude bg_example_01.c
634 * See the full @ref bg_example_01_c "example".
636 * @see elm_shutdown().
639 EAPI int elm_init(int argc, char **argv);
642 * Shut down Elementary
644 * @return The init counter value.
646 * This should be called at the end of your application, just
647 * before it ceases to do any more processing. This will clean up
648 * any permanent resources your application may have allocated via
649 * Elementary that would otherwise persist.
651 * @see elm_init() for an example
655 EAPI int elm_shutdown(void);
658 * Run Elementary's main loop
660 * This call should be issued just after all initialization is
661 * completed. This function will not return until elm_exit() is
662 * called. It will keep looping, running the main
663 * (event/processing) loop for Elementary.
665 * @see elm_init() for an example
669 EAPI void elm_run(void);
672 * Exit Elementary's main loop
674 * If this call is issued, it will flag the main loop to cease
675 * processing and return back to its parent function (usually your
676 * elm_main() function).
678 * @see elm_init() for an example. There, just after a request to
679 * close the window comes, the main loop will be left.
681 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
682 * applications, you'll be able to get this function called automatically for you.
686 EAPI void elm_exit(void);
689 * Provide information in order to make Elementary determine the @b
690 * run time location of the software in question, so other data files
691 * such as images, sound files, executable utilities, libraries,
692 * modules and locale files can be found.
694 * @param mainfunc This is your application's main function name,
695 * whose binary's location is to be found. Providing @c NULL
696 * will make Elementary not to use it
697 * @param dom This will be used as the application's "domain", in the
698 * form of a prefix to any environment variables that may
699 * override prefix detection and the directory name, inside the
700 * standard share or data directories, where the software's
701 * data files will be looked for.
702 * @param checkfile This is an (optional) magic file's path to check
703 * for existence (and it must be located in the data directory,
704 * under the share directory provided above). Its presence will
705 * help determine the prefix found was correct. Pass @c NULL if
706 * the check is not to be done.
708 * This function allows one to re-locate the application somewhere
709 * else after compilation, if the developer wishes for easier
710 * distribution of pre-compiled binaries.
712 * The prefix system is designed to locate where the given software is
713 * installed (under a common path prefix) at run time and then report
714 * specific locations of this prefix and common directories inside
715 * this prefix like the binary, library, data and locale directories,
716 * through the @c elm_app_*_get() family of functions.
718 * Call elm_app_info_set() early on before you change working
719 * directory or anything about @c argv[0], so it gets accurate
722 * It will then try and trace back which file @p mainfunc comes from,
723 * if provided, to determine the application's prefix directory.
725 * The @p dom parameter provides a string prefix to prepend before
726 * environment variables, allowing a fallback to @b specific
727 * environment variables to locate the software. You would most
728 * probably provide a lowercase string there, because it will also
729 * serve as directory domain, explained next. For environment
730 * variables purposes, this string is made uppercase. For example if
731 * @c "myapp" is provided as the prefix, then the program would expect
732 * @c "MYAPP_PREFIX" as a master environment variable to specify the
733 * exact install prefix for the software, or more specific environment
734 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
735 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
736 * the user or scripts before launching. If not provided (@c NULL),
737 * environment variables will not be used to override compiled-in
738 * defaults or auto detections.
740 * The @p dom string also provides a subdirectory inside the system
741 * shared data directory for data files. For example, if the system
742 * directory is @c /usr/local/share, then this directory name is
743 * appended, creating @c /usr/local/share/myapp, if it @p was @c
744 * "myapp". It is expected that the application installs data files in
747 * The @p checkfile is a file name or path of something inside the
748 * share or data directory to be used to test that the prefix
749 * detection worked. For example, your app will install a wallpaper
750 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
751 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
754 * @see elm_app_compile_bin_dir_set()
755 * @see elm_app_compile_lib_dir_set()
756 * @see elm_app_compile_data_dir_set()
757 * @see elm_app_compile_locale_set()
758 * @see elm_app_prefix_dir_get()
759 * @see elm_app_bin_dir_get()
760 * @see elm_app_lib_dir_get()
761 * @see elm_app_data_dir_get()
762 * @see elm_app_locale_dir_get()
764 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
767 * Provide information on the @b fallback application's binaries
768 * directory, in scenarios where they get overriden by
769 * elm_app_info_set().
771 * @param dir The path to the default binaries directory (compile time
774 * @note Elementary will as well use this path to determine actual
775 * names of binaries' directory paths, maybe changing it to be @c
776 * something/local/bin instead of @c something/bin, only, for
779 * @warning You should call this function @b before
780 * elm_app_info_set().
782 EAPI void elm_app_compile_bin_dir_set(const char *dir);
785 * Provide information on the @b fallback application's libraries
786 * directory, on scenarios where they get overriden by
787 * elm_app_info_set().
789 * @param dir The path to the default libraries directory (compile
792 * @note Elementary will as well use this path to determine actual
793 * names of libraries' directory paths, maybe changing it to be @c
794 * something/lib32 or @c something/lib64 instead of @c something/lib,
797 * @warning You should call this function @b before
798 * elm_app_info_set().
800 EAPI void elm_app_compile_lib_dir_set(const char *dir);
803 * Provide information on the @b fallback application's data
804 * directory, on scenarios where they get overriden by
805 * elm_app_info_set().
807 * @param dir The path to the default data directory (compile time
810 * @note Elementary will as well use this path to determine actual
811 * names of data directory paths, maybe changing it to be @c
812 * something/local/share instead of @c something/share, only, for
815 * @warning You should call this function @b before
816 * elm_app_info_set().
818 EAPI void elm_app_compile_data_dir_set(const char *dir);
821 * Provide information on the @b fallback application's locale
822 * directory, on scenarios where they get overriden by
823 * elm_app_info_set().
825 * @param dir The path to the default locale directory (compile time
828 * @warning You should call this function @b before
829 * elm_app_info_set().
831 EAPI void elm_app_compile_locale_set(const char *dir);
834 * Retrieve the application's run time prefix directory, as set by
835 * elm_app_info_set() and the way (environment) the application was
838 * @return The directory prefix the application is actually using.
840 EAPI const char *elm_app_prefix_dir_get(void);
843 * Retrieve the application's run time binaries prefix directory, as
844 * set by elm_app_info_set() and the way (environment) the application
847 * @return The binaries directory prefix the application is actually
850 EAPI const char *elm_app_bin_dir_get(void);
853 * Retrieve the application's run time libraries prefix directory, as
854 * set by elm_app_info_set() and the way (environment) the application
857 * @return The libraries directory prefix the application is actually
860 EAPI const char *elm_app_lib_dir_get(void);
863 * Retrieve the application's run time data prefix directory, as
864 * set by elm_app_info_set() and the way (environment) the application
867 * @return The data directory prefix the application is actually
870 EAPI const char *elm_app_data_dir_get(void);
873 * Retrieve the application's run time locale prefix directory, as
874 * set by elm_app_info_set() and the way (environment) the application
877 * @return The locale directory prefix the application is actually
880 EAPI const char *elm_app_locale_dir_get(void);
882 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
883 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
884 EAPI int elm_quicklaunch_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
886 EAPI int elm_quicklaunch_sub_shutdown(void);
887 EAPI int elm_quicklaunch_shutdown(void);
888 EAPI void elm_quicklaunch_seed(void);
889 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
890 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
891 EAPI void elm_quicklaunch_cleanup(void);
892 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
893 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
895 EAPI Eina_Bool elm_need_efreet(void);
896 EAPI Eina_Bool elm_need_e_dbus(void);
899 * This must be called before any other function that deals with
900 * elm_thumb objects or ethumb_client instances.
904 EAPI Eina_Bool elm_need_ethumb(void);
907 * This must be called before any other function that deals with
908 * elm_web objects or ewk_view instances.
912 EAPI Eina_Bool elm_need_web(void);
915 * Set a new policy's value (for a given policy group/identifier).
917 * @param policy policy identifier, as in @ref Elm_Policy.
918 * @param value policy value, which depends on the identifier
920 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
922 * Elementary policies define applications' behavior,
923 * somehow. These behaviors are divided in policy groups (see
924 * #Elm_Policy enumeration). This call will emit the Ecore event
925 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
926 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
929 * @note Currently, we have only one policy identifier/group
930 * (#ELM_POLICY_QUIT), which has two possible values.
934 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
937 * Gets the policy value for given policy identifier.
939 * @param policy policy identifier, as in #Elm_Policy.
940 * @return The currently set policy value, for that
941 * identifier. Will be @c 0 if @p policy passed is invalid.
945 EAPI int elm_policy_get(unsigned int policy);
948 * Change the language of the current application
950 * The @p lang passed must be the full name of the locale to use, for
951 * example "en_US.utf8" or "es_ES@euro".
953 * Changing language with this function will make Elementary run through
954 * all its widgets, translating strings set with
955 * elm_object_domain_translatable_text_part_set(). This way, an entire
956 * UI can have its language changed without having to restart the program.
958 * For more complex cases, like having formatted strings that need
959 * translation, widgets will also emit a "language,changed" signal that
960 * the user can listen to to manually translate the text.
962 * @param lang Language to set, must be the full name of the locale
966 EAPI void elm_language_set(const char *lang);
969 * Set a label of an object
971 * @param obj The Elementary object
972 * @param part The text part name to set (NULL for the default label)
973 * @param label The new text of the label
975 * @note Elementary objects may have many labels (e.g. Action Slider)
976 * @deprecated Use elm_object_part_text_set() instead.
979 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
982 * Set a label of an object
984 * @param obj The Elementary object
985 * @param part The text part name to set (NULL for the default label)
986 * @param label The new text of the label
988 * @note Elementary objects may have many labels (e.g. Action Slider)
992 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
994 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
997 * Get a label of an object
999 * @param obj The Elementary object
1000 * @param part The text part name to get (NULL for the default label)
1001 * @return text of the label or NULL for any error
1003 * @note Elementary objects may have many labels (e.g. Action Slider)
1004 * @deprecated Use elm_object_part_text_get() instead.
1007 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1010 * Get a label of an object
1012 * @param obj The Elementary object
1013 * @param part The text part name to get (NULL for the default label)
1014 * @return text of the label or NULL for any error
1016 * @note Elementary objects may have many labels (e.g. Action Slider)
1020 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1022 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1025 * Set the text for an objects' part, marking it as translatable.
1027 * The string to set as @p text must be the original one. Do not pass the
1028 * return of @c gettext() here. Elementary will translate the string
1029 * internally and set it on the object using elm_object_part_text_set(),
1030 * also storing the original string so that it can be automatically
1031 * translated when the language is changed with elm_language_set().
1033 * The @p domain will be stored along to find the translation in the
1034 * correct catalog. It can be NULL, in which case it will use whatever
1035 * domain was set by the application with @c textdomain(). This is useful
1036 * in case you are building a library on top of Elementary that will have
1037 * its own translatable strings, that should not be mixed with those of
1038 * programs using the library.
1040 * @param obj The object containing the text part
1041 * @param part The name of the part to set
1042 * @param domain The translation domain to use
1043 * @param text The original, non-translated text to set
1047 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1049 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1051 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1054 * Gets the original string set as translatable for an object
1056 * When setting translated strings, the function elm_object_part_text_get()
1057 * will return the translation returned by @c gettext(). To get the
1058 * original string use this function.
1060 * @param obj The object
1061 * @param part The name of the part that was set
1063 * @return The original, untranslated string
1067 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1069 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1072 * Set a content of an object
1074 * @param obj The Elementary object
1075 * @param part The content part name to set (NULL for the default content)
1076 * @param content The new content of the object
1078 * @note Elementary objects may have many contents
1082 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1084 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1087 * Get a content of an object
1089 * @param obj The Elementary object
1090 * @param item The content part name to get (NULL for the default content)
1091 * @return content of the object or NULL for any error
1093 * @note Elementary objects may have many contents
1097 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1099 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1102 * Unset a content of an object
1104 * @param obj The Elementary object
1105 * @param item The content part name to unset (NULL for the default content)
1107 * @note Elementary objects may have many contents
1111 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1113 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1116 * Get the widget object's handle which contains a given item
1118 * @param item The Elementary object item
1119 * @return The widget object
1121 * @note This returns the widget object itself that an item belongs to.
1125 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1128 * Set a content of an object item
1130 * @param it The Elementary object item
1131 * @param part The content part name to set (NULL for the default content)
1132 * @param content The new content of the object item
1134 * @note Elementary object items may have many contents
1138 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1140 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1143 * Get a content of an object item
1145 * @param it The Elementary object item
1146 * @param part The content part name to unset (NULL for the default content)
1147 * @return content of the object item or NULL for any error
1149 * @note Elementary object items may have many contents
1153 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1155 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1158 * Unset a content of an object item
1160 * @param it The Elementary object item
1161 * @param part The content part name to unset (NULL for the default content)
1163 * @note Elementary object items may have many contents
1167 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1169 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1172 * Set a label of an object item
1174 * @param it The Elementary object item
1175 * @param part The text part name to set (NULL for the default label)
1176 * @param label The new text of the label
1178 * @note Elementary object items may have many labels
1182 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1184 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1187 * Get a label of an object item
1189 * @param it The Elementary object item
1190 * @param part The text part name to get (NULL for the default label)
1191 * @return text of the label or NULL for any error
1193 * @note Elementary object items may have many labels
1197 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1200 * Set the text to read out when in accessibility mode
1202 * @param obj The object which is to be described
1203 * @param txt The text that describes the widget to people with poor or no vision
1207 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1210 * Set the text to read out when in accessibility mode
1212 * @param it The object item which is to be described
1213 * @param txt The text that describes the widget to people with poor or no vision
1217 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1220 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1223 * Set the text to read out when in accessibility mode
1225 * @param obj The object which is to be described
1226 * @param txt The text that describes the widget to people with poor or no vision
1230 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1233 * Set the text to read out when in accessibility mode
1235 * @param it The object item which is to be described
1236 * @param txt The text that describes the widget to people with poor or no vision
1240 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1243 * Get the data associated with an object item
1244 * @param it The Elementary object item
1245 * @return The data associated with @p it
1249 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1252 * Set the data associated with an object item
1253 * @param it The Elementary object item
1254 * @param data The data to be associated with @p it
1258 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1261 * Send a signal to the edje object of the widget item.
1263 * This function sends a signal to the edje object of the obj item. An
1264 * edje program can respond to a signal by specifying matching
1265 * 'signal' and 'source' fields.
1267 * @param it The Elementary object item
1268 * @param emission The signal's name.
1269 * @param source The signal's source.
1272 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1279 * @defgroup Caches Caches
1281 * These are functions which let one fine-tune some cache values for
1282 * Elementary applications, thus allowing for performance adjustments.
1288 * @brief Flush all caches.
1290 * Frees all data that was in cache and is not currently being used to reduce
1291 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1292 * to calling all of the following functions:
1293 * @li edje_file_cache_flush()
1294 * @li edje_collection_cache_flush()
1295 * @li eet_clearcache()
1296 * @li evas_image_cache_flush()
1297 * @li evas_font_cache_flush()
1298 * @li evas_render_dump()
1299 * @note Evas caches are flushed for every canvas associated with a window.
1303 EAPI void elm_all_flush(void);
1306 * Get the configured cache flush interval time
1308 * This gets the globally configured cache flush interval time, in
1311 * @return The cache flush interval time
1314 * @see elm_all_flush()
1316 EAPI int elm_cache_flush_interval_get(void);
1319 * Set the configured cache flush interval time
1321 * This sets the globally configured cache flush interval time, in ticks
1323 * @param size The cache flush interval time
1326 * @see elm_all_flush()
1328 EAPI void elm_cache_flush_interval_set(int size);
1331 * Set the configured cache flush interval time for all applications on the
1334 * This sets the globally configured cache flush interval time -- in ticks
1335 * -- for all applications on the display.
1337 * @param size The cache flush interval time
1340 EAPI void elm_cache_flush_interval_all_set(int size);
1343 * Get the configured cache flush enabled state
1345 * This gets the globally configured cache flush state - if it is enabled
1346 * or not. When cache flushing is enabled, elementary will regularly
1347 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1348 * memory and allow usage to re-seed caches and data in memory where it
1349 * can do so. An idle application will thus minimise its memory usage as
1350 * data will be freed from memory and not be re-loaded as it is idle and
1351 * not rendering or doing anything graphically right now.
1353 * @return The cache flush state
1356 * @see elm_all_flush()
1358 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1361 * Set the configured cache flush enabled state
1363 * This sets the globally configured cache flush enabled state.
1365 * @param size The cache flush enabled state
1368 * @see elm_all_flush()
1370 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1373 * Set the configured cache flush enabled state for all applications on the
1376 * This sets the globally configured cache flush enabled state for all
1377 * applications on the display.
1379 * @param size The cache flush enabled state
1382 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1385 * Get the configured font cache size
1387 * This gets the globally configured font cache size, in bytes.
1389 * @return The font cache size
1392 EAPI int elm_font_cache_get(void);
1395 * Set the configured font cache size
1397 * This sets the globally configured font cache size, in bytes
1399 * @param size The font cache size
1402 EAPI void elm_font_cache_set(int size);
1405 * Set the configured font cache size for all applications on the
1408 * This sets the globally configured font cache size -- in bytes
1409 * -- for all applications on the display.
1411 * @param size The font cache size
1414 EAPI void elm_font_cache_all_set(int size);
1417 * Get the configured image cache size
1419 * This gets the globally configured image cache size, in bytes
1421 * @return The image cache size
1424 EAPI int elm_image_cache_get(void);
1427 * Set the configured image cache size
1429 * This sets the globally configured image cache size, in bytes
1431 * @param size The image cache size
1434 EAPI void elm_image_cache_set(int size);
1437 * Set the configured image cache size for all applications on the
1440 * This sets the globally configured image cache size -- in bytes
1441 * -- for all applications on the display.
1443 * @param size The image cache size
1446 EAPI void elm_image_cache_all_set(int size);
1449 * Get the configured edje file cache size.
1451 * This gets the globally configured edje file cache size, in number
1454 * @return The edje file cache size
1457 EAPI int elm_edje_file_cache_get(void);
1460 * Set the configured edje file cache size
1462 * This sets the globally configured edje file cache size, in number
1465 * @param size The edje file cache size
1468 EAPI void elm_edje_file_cache_set(int size);
1471 * Set the configured edje file cache size for all applications on the
1474 * This sets the globally configured edje file cache size -- in number
1475 * of files -- for all applications on the display.
1477 * @param size The edje file cache size
1480 EAPI void elm_edje_file_cache_all_set(int size);
1483 * Get the configured edje collections (groups) cache size.
1485 * This gets the globally configured edje collections cache size, in
1486 * number of collections.
1488 * @return The edje collections cache size
1491 EAPI int elm_edje_collection_cache_get(void);
1494 * Set the configured edje collections (groups) cache size
1496 * This sets the globally configured edje collections cache size, in
1497 * number of collections.
1499 * @param size The edje collections cache size
1502 EAPI void elm_edje_collection_cache_set(int size);
1505 * Set the configured edje collections (groups) cache size for all
1506 * applications on the display
1508 * This sets the globally configured edje collections cache size -- in
1509 * number of collections -- for all applications on the display.
1511 * @param size The edje collections cache size
1514 EAPI void elm_edje_collection_cache_all_set(int size);
1521 * @defgroup Scaling Widget Scaling
1523 * Different widgets can be scaled independently. These functions
1524 * allow you to manipulate this scaling on a per-widget basis. The
1525 * object and all its children get their scaling factors multiplied
1526 * by the scale factor set. This is multiplicative, in that if a
1527 * child also has a scale size set it is in turn multiplied by its
1528 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1529 * double size, @c 0.5 is half, etc.
1531 * @ref general_functions_example_page "This" example contemplates
1532 * some of these functions.
1536 * Get the global scaling factor
1538 * This gets the globally configured scaling factor that is applied to all
1541 * @return The scaling factor
1544 EAPI double elm_scale_get(void);
1547 * Set the global scaling factor
1549 * This sets the globally configured scaling factor that is applied to all
1552 * @param scale The scaling factor to set
1555 EAPI void elm_scale_set(double scale);
1558 * Set the global scaling factor for all applications on the display
1560 * This sets the globally configured scaling factor that is applied to all
1561 * objects for all applications.
1562 * @param scale The scaling factor to set
1565 EAPI void elm_scale_all_set(double scale);
1568 * Set the scaling factor for a given Elementary object
1570 * @param obj The Elementary to operate on
1571 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1576 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1579 * Get the scaling factor for a given Elementary object
1581 * @param obj The object
1582 * @return The scaling factor set by elm_object_scale_set()
1586 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1589 * @defgroup Password_last_show Password last input show
1591 * Last show feature of password mode enables user to view
1592 * the last input entered for few seconds before masking it.
1593 * These functions allow to set this feature in password mode
1594 * of entry widget and also allow to manipulate the duration
1595 * for which the input has to be visible.
1601 * Get show last setting of password mode.
1603 * This gets the show last input setting of password mode which might be
1604 * enabled or disabled.
1606 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1608 * @ingroup Password_last_show
1610 EAPI Eina_Bool elm_password_show_last_get(void);
1613 * Set show last setting in password mode.
1615 * This enables or disables show last setting of password mode.
1617 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1618 * @see elm_password_show_last_timeout_set()
1619 * @ingroup Password_last_show
1621 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1624 * Get's the timeout value in last show password mode.
1626 * This gets the time out value for which the last input entered in password
1627 * mode will be visible.
1629 * @return The timeout value of last show password mode.
1630 * @ingroup Password_last_show
1632 EAPI double elm_password_show_last_timeout_get(void);
1635 * Set's the timeout value in last show password mode.
1637 * This sets the time out value for which the last input entered in password
1638 * mode will be visible.
1640 * @param password_show_last_timeout The timeout value.
1641 * @see elm_password_show_last_set()
1642 * @ingroup Password_last_show
1644 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1651 * @defgroup UI-Mirroring Selective Widget mirroring
1653 * These functions allow you to set ui-mirroring on specific
1654 * widgets or the whole interface. Widgets can be in one of two
1655 * modes, automatic and manual. Automatic means they'll be changed
1656 * according to the system mirroring mode and manual means only
1657 * explicit changes will matter. You are not supposed to change
1658 * mirroring state of a widget set to automatic, will mostly work,
1659 * but the behavior is not really defined.
1664 EAPI Eina_Bool elm_mirrored_get(void);
1665 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1668 * Get the system mirrored mode. This determines the default mirrored mode
1671 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1673 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1676 * Set the system mirrored mode. This determines the default mirrored mode
1679 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1681 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1684 * Returns the widget's mirrored mode setting.
1686 * @param obj The widget.
1687 * @return mirrored mode setting of the object.
1690 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1693 * Sets the widget's mirrored mode setting.
1694 * When widget in automatic mode, it follows the system mirrored mode set by
1695 * elm_mirrored_set().
1696 * @param obj The widget.
1697 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1699 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1706 * Set the style to use by a widget
1708 * Sets the style name that will define the appearance of a widget. Styles
1709 * vary from widget to widget and may also be defined by other themes
1710 * by means of extensions and overlays.
1712 * @param obj The Elementary widget to style
1713 * @param style The style name to use
1715 * @see elm_theme_extension_add()
1716 * @see elm_theme_extension_del()
1717 * @see elm_theme_overlay_add()
1718 * @see elm_theme_overlay_del()
1722 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1724 * Get the style used by the widget
1726 * This gets the style being used for that widget. Note that the string
1727 * pointer is only valid as longas the object is valid and the style doesn't
1730 * @param obj The Elementary widget to query for its style
1731 * @return The style name used
1733 * @see elm_object_style_set()
1737 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1740 * @defgroup Styles Styles
1742 * Widgets can have different styles of look. These generic API's
1743 * set styles of widgets, if they support them (and if the theme(s)
1746 * @ref general_functions_example_page "This" example contemplates
1747 * some of these functions.
1751 * Set the disabled state of an Elementary object.
1753 * @param obj The Elementary object to operate on
1754 * @param disabled The state to put in in: @c EINA_TRUE for
1755 * disabled, @c EINA_FALSE for enabled
1757 * Elementary objects can be @b disabled, in which state they won't
1758 * receive input and, in general, will be themed differently from
1759 * their normal state, usually greyed out. Useful for contexts
1760 * where you don't want your users to interact with some of the
1761 * parts of you interface.
1763 * This sets the state for the widget, either disabling it or
1768 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1771 * Get the disabled state of an Elementary object.
1773 * @param obj The Elementary object to operate on
1774 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1775 * if it's enabled (or on errors)
1777 * This gets the state of the widget, which might be enabled or disabled.
1781 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1784 * @defgroup WidgetNavigation Widget Tree Navigation.
1786 * How to check if an Evas Object is an Elementary widget? How to
1787 * get the first elementary widget that is parent of the given
1788 * object? These are all covered in widget tree navigation.
1790 * @ref general_functions_example_page "This" example contemplates
1791 * some of these functions.
1795 * Check if the given Evas Object is an Elementary widget.
1797 * @param obj the object to query.
1798 * @return @c EINA_TRUE if it is an elementary widget variant,
1799 * @c EINA_FALSE otherwise
1800 * @ingroup WidgetNavigation
1802 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1805 * Get the first parent of the given object that is an Elementary
1808 * @param obj the Elementary object to query parent from.
1809 * @return the parent object that is an Elementary widget, or @c
1810 * NULL, if it was not found.
1812 * Use this to query for an object's parent widget.
1814 * @note Most of Elementary users wouldn't be mixing non-Elementary
1815 * smart objects in the objects tree of an application, as this is
1816 * an advanced usage of Elementary with Evas. So, except for the
1817 * application's window, which is the root of that tree, all other
1818 * objects would have valid Elementary widget parents.
1820 * @ingroup WidgetNavigation
1822 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1825 * Get the top level parent of an Elementary widget.
1827 * @param obj The object to query.
1828 * @return The top level Elementary widget, or @c NULL if parent cannot be
1830 * @ingroup WidgetNavigation
1832 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1835 * Get the string that represents this Elementary widget.
1837 * @note Elementary is weird and exposes itself as a single
1838 * Evas_Object_Smart_Class of type "elm_widget", so
1839 * evas_object_type_get() always return that, making debug and
1840 * language bindings hard. This function tries to mitigate this
1841 * problem, but the solution is to change Elementary to use
1842 * proper inheritance.
1844 * @param obj the object to query.
1845 * @return Elementary widget name, or @c NULL if not a valid widget.
1846 * @ingroup WidgetNavigation
1848 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1851 * @defgroup Config Elementary Config
1853 * Elementary configuration is formed by a set options bounded to a
1854 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1855 * "finger size", etc. These are functions with which one syncronizes
1856 * changes made to those values to the configuration storing files, de
1857 * facto. You most probably don't want to use the functions in this
1858 * group unlees you're writing an elementary configuration manager.
1864 * Save back Elementary's configuration, so that it will persist on
1867 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1870 * This function will take effect -- thus, do I/O -- immediately. Use
1871 * it when you want to apply all configuration changes at once. The
1872 * current configuration set will get saved onto the current profile
1873 * configuration file.
1876 EAPI Eina_Bool elm_config_save(void);
1879 * Reload Elementary's configuration, bounded to current selected
1882 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1885 * Useful when you want to force reloading of configuration values for
1886 * a profile. If one removes user custom configuration directories,
1887 * for example, it will force a reload with system values instead.
1890 EAPI void elm_config_reload(void);
1897 * @defgroup Profile Elementary Profile
1899 * Profiles are pre-set options that affect the whole look-and-feel of
1900 * Elementary-based applications. There are, for example, profiles
1901 * aimed at desktop computer applications and others aimed at mobile,
1902 * touchscreen-based ones. You most probably don't want to use the
1903 * functions in this group unlees you're writing an elementary
1904 * configuration manager.
1910 * Get Elementary's profile in use.
1912 * This gets the global profile that is applied to all Elementary
1915 * @return The profile's name
1918 EAPI const char *elm_profile_current_get(void);
1921 * Get an Elementary's profile directory path in the filesystem. One
1922 * may want to fetch a system profile's dir or an user one (fetched
1925 * @param profile The profile's name
1926 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1927 * or a system one (@c EINA_FALSE)
1928 * @return The profile's directory path.
1931 * @note You must free it with elm_profile_dir_free().
1933 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1936 * Free an Elementary's profile directory path, as returned by
1937 * elm_profile_dir_get().
1939 * @param p_dir The profile's path
1943 EAPI void elm_profile_dir_free(const char *p_dir);
1946 * Get Elementary's list of available profiles.
1948 * @return The profiles list. List node data are the profile name
1952 * @note One must free this list, after usage, with the function
1953 * elm_profile_list_free().
1955 EAPI Eina_List *elm_profile_list_get(void);
1958 * Free Elementary's list of available profiles.
1960 * @param l The profiles list, as returned by elm_profile_list_get().
1964 EAPI void elm_profile_list_free(Eina_List *l);
1967 * Set Elementary's profile.
1969 * This sets the global profile that is applied to Elementary
1970 * applications. Just the process the call comes from will be
1973 * @param profile The profile's name
1977 EAPI void elm_profile_set(const char *profile);
1980 * Set Elementary's profile.
1982 * This sets the global profile that is applied to all Elementary
1983 * applications. All running Elementary windows will be affected.
1985 * @param profile The profile's name
1989 EAPI void elm_profile_all_set(const char *profile);
1996 * @defgroup Engine Elementary Engine
1998 * These are functions setting and querying which rendering engine
1999 * Elementary will use for drawing its windows' pixels.
2001 * The following are the available engines:
2002 * @li "software_x11"
2005 * @li "software_16_x11"
2006 * @li "software_8_x11"
2009 * @li "software_gdi"
2010 * @li "software_16_wince_gdi"
2012 * @li "software_16_sdl"
2016 * @li "opengl_cocoa"
2023 * @brief Get Elementary's rendering engine in use.
2025 * @return The rendering engine's name
2026 * @note there's no need to free the returned string, here.
2028 * This gets the global rendering engine that is applied to all Elementary
2031 * @see elm_engine_set()
2033 EAPI const char *elm_engine_current_get(void);
2036 * @brief Set Elementary's rendering engine for use.
2038 * @param engine The rendering engine's name
2040 * This sets global rendering engine that is applied to all Elementary
2041 * applications. Note that it will take effect only to Elementary windows
2042 * created after this is called.
2044 * @see elm_win_add()
2046 EAPI void elm_engine_set(const char *engine);
2053 * @defgroup Fonts Elementary Fonts
2055 * These are functions dealing with font rendering, selection and the
2056 * like for Elementary applications. One might fetch which system
2057 * fonts are there to use and set custom fonts for individual classes
2058 * of UI items containing text (text classes).
2063 typedef struct _Elm_Text_Class
2069 typedef struct _Elm_Font_Overlay
2071 const char *text_class;
2073 Evas_Font_Size size;
2076 typedef struct _Elm_Font_Properties
2080 } Elm_Font_Properties;
2083 * Get Elementary's list of supported text classes.
2085 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2088 * Release the list with elm_text_classes_list_free().
2090 EAPI const Eina_List *elm_text_classes_list_get(void);
2093 * Free Elementary's list of supported text classes.
2097 * @see elm_text_classes_list_get().
2099 EAPI void elm_text_classes_list_free(const Eina_List *list);
2102 * Get Elementary's list of font overlays, set with
2103 * elm_font_overlay_set().
2105 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2110 * For each text class, one can set a <b>font overlay</b> for it,
2111 * overriding the default font properties for that class coming from
2112 * the theme in use. There is no need to free this list.
2114 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2116 EAPI const Eina_List *elm_font_overlay_list_get(void);
2119 * Set a font overlay for a given Elementary text class.
2121 * @param text_class Text class name
2122 * @param font Font name and style string
2123 * @param size Font size
2127 * @p font has to be in the format returned by
2128 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2129 * and elm_font_overlay_unset().
2131 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2134 * Unset a font overlay for a given Elementary text class.
2136 * @param text_class Text class name
2140 * This will bring back text elements belonging to text class
2141 * @p text_class back to their default font settings.
2143 EAPI void elm_font_overlay_unset(const char *text_class);
2146 * Apply the changes made with elm_font_overlay_set() and
2147 * elm_font_overlay_unset() on the current Elementary window.
2151 * This applies all font overlays set to all objects in the UI.
2153 EAPI void elm_font_overlay_apply(void);
2156 * Apply the changes made with elm_font_overlay_set() and
2157 * elm_font_overlay_unset() on all Elementary application windows.
2161 * This applies all font overlays set to all objects in the UI.
2163 EAPI void elm_font_overlay_all_apply(void);
2166 * Translate a font (family) name string in fontconfig's font names
2167 * syntax into an @c Elm_Font_Properties struct.
2169 * @param font The font name and styles string
2170 * @return the font properties struct
2174 * @note The reverse translation can be achived with
2175 * elm_font_fontconfig_name_get(), for one style only (single font
2176 * instance, not family).
2178 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2181 * Free font properties return by elm_font_properties_get().
2183 * @param efp the font properties struct
2187 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2190 * Translate a font name, bound to a style, into fontconfig's font names
2193 * @param name The font (family) name
2194 * @param style The given style (may be @c NULL)
2196 * @return the font name and style string
2200 * @note The reverse translation can be achived with
2201 * elm_font_properties_get(), for one style only (single font
2202 * instance, not family).
2204 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2207 * Free the font string return by elm_font_fontconfig_name_get().
2209 * @param efp the font properties struct
2213 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2216 * Create a font hash table of available system fonts.
2218 * One must call it with @p list being the return value of
2219 * evas_font_available_list(). The hash will be indexed by font
2220 * (family) names, being its values @c Elm_Font_Properties blobs.
2222 * @param list The list of available system fonts, as returned by
2223 * evas_font_available_list().
2224 * @return the font hash.
2228 * @note The user is supposed to get it populated at least with 3
2229 * default font families (Sans, Serif, Monospace), which should be
2230 * present on most systems.
2232 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2235 * Free the hash return by elm_font_available_hash_add().
2237 * @param hash the hash to be freed.
2241 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2248 * @defgroup Fingers Fingers
2250 * Elementary is designed to be finger-friendly for touchscreens,
2251 * and so in addition to scaling for display resolution, it can
2252 * also scale based on finger "resolution" (or size). You can then
2253 * customize the granularity of the areas meant to receive clicks
2256 * Different profiles may have pre-set values for finger sizes.
2258 * @ref general_functions_example_page "This" example contemplates
2259 * some of these functions.
2265 * Get the configured "finger size"
2267 * @return The finger size
2269 * This gets the globally configured finger size, <b>in pixels</b>
2273 EAPI Evas_Coord elm_finger_size_get(void);
2276 * Set the configured finger size
2278 * This sets the globally configured finger size in pixels
2280 * @param size The finger size
2283 EAPI void elm_finger_size_set(Evas_Coord size);
2286 * Set the configured finger size for all applications on the display
2288 * This sets the globally configured finger size in pixels for all
2289 * applications on the display
2291 * @param size The finger size
2294 EAPI void elm_finger_size_all_set(Evas_Coord size);
2301 * @defgroup Focus Focus
2303 * An Elementary application has, at all times, one (and only one)
2304 * @b focused object. This is what determines where the input
2305 * events go to within the application's window. Also, focused
2306 * objects can be decorated differently, in order to signal to the
2307 * user where the input is, at a given moment.
2309 * Elementary applications also have the concept of <b>focus
2310 * chain</b>: one can cycle through all the windows' focusable
2311 * objects by input (tab key) or programmatically. The default
2312 * focus chain for an application is the one define by the order in
2313 * which the widgets where added in code. One will cycle through
2314 * top level widgets, and, for each one containg sub-objects, cycle
2315 * through them all, before returning to the level
2316 * above. Elementary also allows one to set @b custom focus chains
2317 * for their applications.
2319 * Besides the focused decoration a widget may exhibit, when it
2320 * gets focus, Elementary has a @b global focus highlight object
2321 * that can be enabled for a window. If one chooses to do so, this
2322 * extra highlight effect will surround the current focused object,
2325 * @note Some Elementary widgets are @b unfocusable, after
2326 * creation, by their very nature: they are not meant to be
2327 * interacted with input events, but are there just for visual
2330 * @ref general_functions_example_page "This" example contemplates
2331 * some of these functions.
2335 * Get the enable status of the focus highlight
2337 * This gets whether the highlight on focused objects is enabled or not
2340 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2343 * Set the enable status of the focus highlight
2345 * Set whether to show or not the highlight on focused objects
2346 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2349 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2352 * Get the enable status of the highlight animation
2354 * Get whether the focus highlight, if enabled, will animate its switch from
2355 * one object to the next
2358 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2361 * Set the enable status of the highlight animation
2363 * Set whether the focus highlight, if enabled, will animate its switch from
2364 * one object to the next
2365 * @param animate Enable animation if EINA_TRUE, disable otherwise
2368 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2371 * Get the whether an Elementary object has the focus or not.
2373 * @param obj The Elementary object to get the information from
2374 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2375 * not (and on errors).
2377 * @see elm_object_focus_set()
2381 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2384 * Set/unset focus to a given Elementary object.
2386 * @param obj The Elementary object to operate on.
2387 * @param enable @c EINA_TRUE Set focus to a given object,
2388 * @c EINA_FALSE Unset focus to a given object.
2390 * @note When you set focus to this object, if it can handle focus, will
2391 * take the focus away from the one who had it previously and will, for
2392 * now on, be the one receiving input events. Unsetting focus will remove
2393 * the focus from @p obj, passing it back to the previous element in the
2396 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2400 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2403 * Make a given Elementary object the focused one.
2405 * @param obj The Elementary object to make focused.
2407 * @note This object, if it can handle focus, will take the focus
2408 * away from the one who had it previously and will, for now on, be
2409 * the one receiving input events.
2411 * @see elm_object_focus_get()
2415 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2418 * Remove the focus from an Elementary object
2420 * @param obj The Elementary to take focus from
2422 * This removes the focus from @p obj, passing it back to the
2423 * previous element in the focus chain list.
2425 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2429 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2432 * Set the ability for an Element object to be focused
2434 * @param obj The Elementary object to operate on
2435 * @param enable @c EINA_TRUE if the object can be focused, @c
2436 * EINA_FALSE if not (and on errors)
2438 * This sets whether the object @p obj is able to take focus or
2439 * not. Unfocusable objects do nothing when programmatically
2440 * focused, being the nearest focusable parent object the one
2441 * really getting focus. Also, when they receive mouse input, they
2442 * will get the event, but not take away the focus from where it
2447 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2450 * Get whether an Elementary object is focusable or not
2452 * @param obj The Elementary object to operate on
2453 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2454 * EINA_FALSE if not (and on errors)
2456 * @note Objects which are meant to be interacted with by input
2457 * events are created able to be focused, by default. All the
2462 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2465 * Set custom focus chain.
2467 * This function overwrites any previous custom focus chain within
2468 * the list of objects. The previous list will be deleted and this list
2469 * will be managed by elementary. After it is set, don't modify it.
2471 * @note On focus cycle, only will be evaluated children of this container.
2473 * @param obj The container object
2474 * @param objs Chain of objects to pass focus
2477 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2480 * Unset a custom focus chain on a given Elementary widget
2482 * @param obj The container object to remove focus chain from
2484 * Any focus chain previously set on @p obj (for its child objects)
2485 * is removed entirely after this call.
2489 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2492 * Get custom focus chain
2494 * @param obj The container object
2497 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2500 * Append object to custom focus chain.
2502 * @note If relative_child equal to NULL or not in custom chain, the object
2503 * will be added in end.
2505 * @note On focus cycle, only will be evaluated children of this container.
2507 * @param obj The container object
2508 * @param child The child to be added in custom chain
2509 * @param relative_child The relative object to position the child
2512 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2515 * Prepend object to custom focus chain.
2517 * @note If relative_child equal to NULL or not in custom chain, the object
2518 * will be added in begin.
2520 * @note On focus cycle, only will be evaluated children of this container.
2522 * @param obj The container object
2523 * @param child The child to be added in custom chain
2524 * @param relative_child The relative object to position the child
2527 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2530 * Give focus to next object in object tree.
2532 * Give focus to next object in focus chain of one object sub-tree.
2533 * If the last object of chain already have focus, the focus will go to the
2534 * first object of chain.
2536 * @param obj The object root of sub-tree
2537 * @param dir Direction to cycle the focus
2541 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2544 * Give focus to near object in one direction.
2546 * Give focus to near object in direction of one object.
2547 * If none focusable object in given direction, the focus will not change.
2549 * @param obj The reference object
2550 * @param x Horizontal component of direction to focus
2551 * @param y Vertical component of direction to focus
2555 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2558 * Make the elementary object and its children to be unfocusable
2561 * @param obj The Elementary object to operate on
2562 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2563 * @c EINA_FALSE for focusable.
2565 * This sets whether the object @p obj and its children objects
2566 * are able to take focus or not. If the tree is set as unfocusable,
2567 * newest focused object which is not in this tree will get focus.
2568 * This API can be helpful for an object to be deleted.
2569 * When an object will be deleted soon, it and its children may not
2570 * want to get focus (by focus reverting or by other focus controls).
2571 * Then, just use this API before deleting.
2573 * @see elm_object_tree_unfocusable_get()
2577 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2580 * Get whether an Elementary object and its children are unfocusable or not.
2582 * @param obj The Elementary object to get the information from
2583 * @return @c EINA_TRUE, if the tree is unfocussable,
2584 * @c EINA_FALSE if not (and on errors).
2586 * @see elm_object_tree_unfocusable_set()
2590 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2593 * @defgroup Scrolling Scrolling
2595 * These are functions setting how scrollable views in Elementary
2596 * widgets should behave on user interaction.
2602 * Get whether scrollers should bounce when they reach their
2603 * viewport's edge during a scroll.
2605 * @return the thumb scroll bouncing state
2607 * This is the default behavior for touch screens, in general.
2608 * @ingroup Scrolling
2610 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2613 * Set whether scrollers should bounce when they reach their
2614 * viewport's edge during a scroll.
2616 * @param enabled the thumb scroll bouncing state
2618 * @see elm_thumbscroll_bounce_enabled_get()
2619 * @ingroup Scrolling
2621 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2624 * Set whether scrollers should bounce when they reach their
2625 * viewport's edge during a scroll, for all Elementary application
2628 * @param enabled the thumb scroll bouncing state
2630 * @see elm_thumbscroll_bounce_enabled_get()
2631 * @ingroup Scrolling
2633 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2636 * Get the amount of inertia a scroller will impose at bounce
2639 * @return the thumb scroll bounce friction
2641 * @ingroup Scrolling
2643 EAPI double elm_scroll_bounce_friction_get(void);
2646 * Set the amount of inertia a scroller will impose at bounce
2649 * @param friction the thumb scroll bounce friction
2651 * @see elm_thumbscroll_bounce_friction_get()
2652 * @ingroup Scrolling
2654 EAPI void elm_scroll_bounce_friction_set(double friction);
2657 * Set the amount of inertia a scroller will impose at bounce
2658 * animations, for all Elementary application windows.
2660 * @param friction the thumb scroll bounce friction
2662 * @see elm_thumbscroll_bounce_friction_get()
2663 * @ingroup Scrolling
2665 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2668 * Get the amount of inertia a <b>paged</b> scroller will impose at
2669 * page fitting animations.
2671 * @return the page scroll friction
2673 * @ingroup Scrolling
2675 EAPI double elm_scroll_page_scroll_friction_get(void);
2678 * Set the amount of inertia a <b>paged</b> scroller will impose at
2679 * page fitting animations.
2681 * @param friction the page scroll friction
2683 * @see elm_thumbscroll_page_scroll_friction_get()
2684 * @ingroup Scrolling
2686 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2689 * Set the amount of inertia a <b>paged</b> scroller will impose at
2690 * page fitting animations, for all Elementary application windows.
2692 * @param friction the page scroll friction
2694 * @see elm_thumbscroll_page_scroll_friction_get()
2695 * @ingroup Scrolling
2697 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2700 * Get the amount of inertia a scroller will impose at region bring
2703 * @return the bring in scroll friction
2705 * @ingroup Scrolling
2707 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2710 * Set the amount of inertia a scroller will impose at region bring
2713 * @param friction the bring in scroll friction
2715 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2716 * @ingroup Scrolling
2718 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2721 * Set the amount of inertia a scroller will impose at region bring
2722 * animations, for all Elementary application windows.
2724 * @param friction the bring in scroll friction
2726 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2727 * @ingroup Scrolling
2729 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2732 * Get the amount of inertia scrollers will impose at animations
2733 * triggered by Elementary widgets' zooming API.
2735 * @return the zoom friction
2737 * @ingroup Scrolling
2739 EAPI double elm_scroll_zoom_friction_get(void);
2742 * Set the amount of inertia scrollers will impose at animations
2743 * triggered by Elementary widgets' zooming API.
2745 * @param friction the zoom friction
2747 * @see elm_thumbscroll_zoom_friction_get()
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_zoom_friction_set(double friction);
2753 * Set the amount of inertia scrollers will impose at animations
2754 * triggered by Elementary widgets' zooming API, for all Elementary
2755 * application windows.
2757 * @param friction the zoom friction
2759 * @see elm_thumbscroll_zoom_friction_get()
2760 * @ingroup Scrolling
2762 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2765 * Get whether scrollers should be draggable from any point in their
2768 * @return the thumb scroll state
2770 * @note This is the default behavior for touch screens, in general.
2771 * @note All other functions namespaced with "thumbscroll" will only
2772 * have effect if this mode is enabled.
2774 * @ingroup Scrolling
2776 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2779 * Set whether scrollers should be draggable from any point in their
2782 * @param enabled the thumb scroll state
2784 * @see elm_thumbscroll_enabled_get()
2785 * @ingroup Scrolling
2787 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2790 * Set whether scrollers should be draggable from any point in their
2791 * views, for all Elementary application windows.
2793 * @param enabled the thumb scroll state
2795 * @see elm_thumbscroll_enabled_get()
2796 * @ingroup Scrolling
2798 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2801 * Get the number of pixels one should travel while dragging a
2802 * scroller's view to actually trigger scrolling.
2804 * @return the thumb scroll threshould
2806 * One would use higher values for touch screens, in general, because
2807 * of their inherent imprecision.
2808 * @ingroup Scrolling
2810 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2813 * Set the number of pixels one should travel while dragging a
2814 * scroller's view to actually trigger scrolling.
2816 * @param threshold the thumb scroll threshould
2818 * @see elm_thumbscroll_threshould_get()
2819 * @ingroup Scrolling
2821 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2824 * Set the number of pixels one should travel while dragging a
2825 * scroller's view to actually trigger scrolling, for all Elementary
2826 * application windows.
2828 * @param threshold the thumb scroll threshould
2830 * @see elm_thumbscroll_threshould_get()
2831 * @ingroup Scrolling
2833 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2836 * Get the minimum speed of mouse cursor movement which will trigger
2837 * list self scrolling animation after a mouse up event
2840 * @return the thumb scroll momentum threshould
2842 * @ingroup Scrolling
2844 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2847 * Set the minimum speed of mouse cursor movement which will trigger
2848 * list self scrolling animation after a mouse up event
2851 * @param threshold the thumb scroll momentum threshould
2853 * @see elm_thumbscroll_momentum_threshould_get()
2854 * @ingroup Scrolling
2856 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2859 * Set the minimum speed of mouse cursor movement which will trigger
2860 * list self scrolling animation after a mouse up event
2861 * (pixels/second), for all Elementary application windows.
2863 * @param threshold the thumb scroll momentum threshould
2865 * @see elm_thumbscroll_momentum_threshould_get()
2866 * @ingroup Scrolling
2868 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2871 * Get the amount of inertia a scroller will impose at self scrolling
2874 * @return the thumb scroll friction
2876 * @ingroup Scrolling
2878 EAPI double elm_scroll_thumbscroll_friction_get(void);
2881 * Set the amount of inertia a scroller will impose at self scrolling
2884 * @param friction the thumb scroll friction
2886 * @see elm_thumbscroll_friction_get()
2887 * @ingroup Scrolling
2889 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2892 * Set the amount of inertia a scroller will impose at self scrolling
2893 * animations, for all Elementary application windows.
2895 * @param friction the thumb scroll friction
2897 * @see elm_thumbscroll_friction_get()
2898 * @ingroup Scrolling
2900 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2903 * Get the amount of lag between your actual mouse cursor dragging
2904 * movement and a scroller's view movement itself, while pushing it
2905 * into bounce state manually.
2907 * @return the thumb scroll border friction
2909 * @ingroup Scrolling
2911 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2914 * Set the amount of lag between your actual mouse cursor dragging
2915 * movement and a scroller's view movement itself, while pushing it
2916 * into bounce state manually.
2918 * @param friction the thumb scroll border friction. @c 0.0 for
2919 * perfect synchrony between two movements, @c 1.0 for maximum
2922 * @see elm_thumbscroll_border_friction_get()
2923 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2925 * @ingroup Scrolling
2927 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2930 * Set the amount of lag between your actual mouse cursor dragging
2931 * movement and a scroller's view movement itself, while pushing it
2932 * into bounce state manually, for all Elementary application windows.
2934 * @param friction the thumb scroll border friction. @c 0.0 for
2935 * perfect synchrony between two movements, @c 1.0 for maximum
2938 * @see elm_thumbscroll_border_friction_get()
2939 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2941 * @ingroup Scrolling
2943 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2946 * Get the sensitivity amount which is be multiplied by the length of
2949 * @return the thumb scroll sensitivity friction
2951 * @ingroup Scrolling
2953 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2956 * Set the sensitivity amount which is be multiplied by the length of
2959 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2960 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2963 * @see elm_thumbscroll_sensitivity_friction_get()
2964 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2966 * @ingroup Scrolling
2968 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2971 * Set the sensitivity amount which is be multiplied by the length of
2972 * mouse dragging, for all Elementary application windows.
2974 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2975 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2978 * @see elm_thumbscroll_sensitivity_friction_get()
2979 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2981 * @ingroup Scrolling
2983 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2990 * @defgroup Scrollhints Scrollhints
2992 * Objects when inside a scroller can scroll, but this may not always be
2993 * desirable in certain situations. This allows an object to hint to itself
2994 * and parents to "not scroll" in one of 2 ways. If any child object of a
2995 * scroller has pushed a scroll freeze or hold then it affects all parent
2996 * scrollers until all children have released them.
2998 * 1. To hold on scrolling. This means just flicking and dragging may no
2999 * longer scroll, but pressing/dragging near an edge of the scroller will
3000 * still scroll. This is automatically used by the entry object when
3003 * 2. To totally freeze scrolling. This means it stops. until
3010 * Push the scroll hold by 1
3012 * This increments the scroll hold count by one. If it is more than 0 it will
3013 * take effect on the parents of the indicated object.
3015 * @param obj The object
3016 * @ingroup Scrollhints
3018 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3021 * Pop the scroll hold by 1
3023 * This decrements the scroll hold count by one. If it is more than 0 it will
3024 * take effect on the parents of the indicated object.
3026 * @param obj The object
3027 * @ingroup Scrollhints
3029 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3032 * Push the scroll freeze by 1
3034 * This increments the scroll freeze count by one. If it is more
3035 * than 0 it will take effect on the parents of the indicated
3038 * @param obj The object
3039 * @ingroup Scrollhints
3041 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3044 * Pop the scroll freeze by 1
3046 * This decrements the scroll freeze count by one. If it is more
3047 * than 0 it will take effect on the parents of the indicated
3050 * @param obj The object
3051 * @ingroup Scrollhints
3053 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3056 * Lock the scrolling of the given widget (and thus all parents)
3058 * This locks the given object from scrolling in the X axis (and implicitly
3059 * also locks all parent scrollers too from doing the same).
3061 * @param obj The object
3062 * @param lock The lock state (1 == locked, 0 == unlocked)
3063 * @ingroup Scrollhints
3065 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3068 * Lock the scrolling of the given widget (and thus all parents)
3070 * This locks the given object from scrolling in the Y axis (and implicitly
3071 * also locks all parent scrollers too from doing the same).
3073 * @param obj The object
3074 * @param lock The lock state (1 == locked, 0 == unlocked)
3075 * @ingroup Scrollhints
3077 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3080 * Get the scrolling lock of the given widget
3082 * This gets the lock for X axis scrolling.
3084 * @param obj The object
3085 * @ingroup Scrollhints
3087 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3090 * Get the scrolling lock of the given widget
3092 * This gets the lock for X axis scrolling.
3094 * @param obj The object
3095 * @ingroup Scrollhints
3097 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3104 * Send a signal to the widget edje object.
3106 * This function sends a signal to the edje object of the obj. An
3107 * edje program can respond to a signal by specifying matching
3108 * 'signal' and 'source' fields.
3110 * @param obj The object
3111 * @param emission The signal's name.
3112 * @param source The signal's source.
3115 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3118 * Add a callback for a signal emitted by widget edje object.
3120 * This function connects a callback function to a signal emitted by the
3121 * edje object of the obj.
3122 * Globs can occur in either the emission or source name.
3124 * @param obj The object
3125 * @param emission The signal's name.
3126 * @param source The signal's source.
3127 * @param func The callback function to be executed when the signal is
3129 * @param data A pointer to data to pass in to the callback function.
3132 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);
3135 * Remove a signal-triggered callback from a widget edje object.
3137 * This function removes a callback, previoulsy attached to a
3138 * signal emitted by the edje object of the obj. The parameters
3139 * emission, source and func must match exactly those passed to a
3140 * previous call to elm_object_signal_callback_add(). The data
3141 * pointer that was passed to this call will be returned.
3143 * @param obj The object
3144 * @param emission The signal's name.
3145 * @param source The signal's source.
3146 * @param func The callback function to be executed when the signal is
3148 * @return The data pointer
3151 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);
3154 * Add a callback for input events (key up, key down, mouse wheel)
3155 * on a given Elementary widget
3157 * @param obj The widget to add an event callback on
3158 * @param func The callback function to be executed when the event
3160 * @param data Data to pass in to @p func
3162 * Every widget in an Elementary interface set to receive focus,
3163 * with elm_object_focus_allow_set(), will propagate @b all of its
3164 * key up, key down and mouse wheel input events up to its parent
3165 * object, and so on. All of the focusable ones in this chain which
3166 * had an event callback set, with this call, will be able to treat
3167 * those events. There are two ways of making the propagation of
3168 * these event upwards in the tree of widgets to @b cease:
3169 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3170 * the event was @b not processed, so the propagation will go on.
3171 * - The @c event_info pointer passed to @p func will contain the
3172 * event's structure and, if you OR its @c event_flags inner
3173 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3174 * one has already handled it, thus killing the event's
3177 * @note Your event callback will be issued on those events taking
3178 * place only if no other child widget of @obj has consumed the
3181 * @note Not to be confused with @c
3182 * evas_object_event_callback_add(), which will add event callbacks
3183 * per type on general Evas objects (no event propagation
3184 * infrastructure taken in account).
3186 * @note Not to be confused with @c
3187 * elm_object_signal_callback_add(), which will add callbacks to @b
3188 * signals coming from a widget's theme, not input events.
3190 * @note Not to be confused with @c
3191 * edje_object_signal_callback_add(), which does the same as
3192 * elm_object_signal_callback_add(), but directly on an Edje
3195 * @note Not to be confused with @c
3196 * evas_object_smart_callback_add(), which adds callbacks to smart
3197 * objects' <b>smart events</b>, and not input events.
3199 * @see elm_object_event_callback_del()
3203 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3206 * Remove an event callback from a widget.
3208 * This function removes a callback, previoulsy attached to event emission
3210 * The parameters func and data must match exactly those passed to
3211 * a previous call to elm_object_event_callback_add(). The data pointer that
3212 * was passed to this call will be returned.
3214 * @param obj The object
3215 * @param func The callback function to be executed when the event is
3217 * @param data Data to pass in to the callback function.
3218 * @return The data pointer
3221 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3224 * Adjust size of an element for finger usage.
3226 * @param times_w How many fingers should fit horizontally
3227 * @param w Pointer to the width size to adjust
3228 * @param times_h How many fingers should fit vertically
3229 * @param h Pointer to the height size to adjust
3231 * This takes width and height sizes (in pixels) as input and a
3232 * size multiple (which is how many fingers you want to place
3233 * within the area, being "finger" the size set by
3234 * elm_finger_size_set()), and adjusts the size to be large enough
3235 * to accommodate the resulting size -- if it doesn't already
3236 * accommodate it. On return the @p w and @p h sizes pointed to by
3237 * these parameters will be modified, on those conditions.
3239 * @note This is kind of a low level Elementary call, most useful
3240 * on size evaluation times for widgets. An external user wouldn't
3241 * be calling, most of the time.
3245 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3248 * Get the duration for occuring long press event.
3250 * @return Timeout for long press event
3251 * @ingroup Longpress
3253 EAPI double elm_longpress_timeout_get(void);
3256 * Set the duration for occuring long press event.
3258 * @param lonpress_timeout Timeout for long press event
3259 * @ingroup Longpress
3261 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3264 * @defgroup Debug Debug
3265 * don't use it unless you are sure
3271 * Print Tree object hierarchy in stdout
3273 * @param obj The root object
3276 EAPI void elm_object_tree_dump(const Evas_Object *top);
3277 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3279 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3280 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3282 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3284 * @param obj The root object
3285 * @param file The path of output file
3288 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3295 * @defgroup Theme Theme
3297 * Elementary uses Edje to theme its widgets, naturally. But for the most
3298 * part this is hidden behind a simpler interface that lets the user set
3299 * extensions and choose the style of widgets in a much easier way.
3301 * Instead of thinking in terms of paths to Edje files and their groups
3302 * each time you want to change the appearance of a widget, Elementary
3303 * works so you can add any theme file with extensions or replace the
3304 * main theme at one point in the application, and then just set the style
3305 * of widgets with elm_object_style_set() and related functions. Elementary
3306 * will then look in its list of themes for a matching group and apply it,
3307 * and when the theme changes midway through the application, all widgets
3308 * will be updated accordingly.
3310 * There are three concepts you need to know to understand how Elementary
3311 * theming works: default theme, extensions and overlays.
3313 * Default theme, obviously enough, is the one that provides the default
3314 * look of all widgets. End users can change the theme used by Elementary
3315 * by setting the @c ELM_THEME environment variable before running an
3316 * application, or globally for all programs using the @c elementary_config
3317 * utility. Applications can change the default theme using elm_theme_set(),
3318 * but this can go against the user wishes, so it's not an adviced practice.
3320 * Ideally, applications should find everything they need in the already
3321 * provided theme, but there may be occasions when that's not enough and
3322 * custom styles are required to correctly express the idea. For this
3323 * cases, Elementary has extensions.
3325 * Extensions allow the application developer to write styles of its own
3326 * to apply to some widgets. This requires knowledge of how each widget
3327 * is themed, as extensions will always replace the entire group used by
3328 * the widget, so important signals and parts need to be there for the
3329 * object to behave properly (see documentation of Edje for details).
3330 * Once the theme for the extension is done, the application needs to add
3331 * it to the list of themes Elementary will look into, using
3332 * elm_theme_extension_add(), and set the style of the desired widgets as
3333 * he would normally with elm_object_style_set().
3335 * Overlays, on the other hand, can replace the look of all widgets by
3336 * overriding the default style. Like extensions, it's up to the application
3337 * developer to write the theme for the widgets it wants, the difference
3338 * being that when looking for the theme, Elementary will check first the
3339 * list of overlays, then the set theme and lastly the list of extensions,
3340 * so with overlays it's possible to replace the default view and every
3341 * widget will be affected. This is very much alike to setting the whole
3342 * theme for the application and will probably clash with the end user
3343 * options, not to mention the risk of ending up with not matching styles
3344 * across the program. Unless there's a very special reason to use them,
3345 * overlays should be avoided for the resons exposed before.
3347 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3348 * keeps one default internally and every function that receives one of
3349 * these can be called with NULL to refer to this default (except for
3350 * elm_theme_free()). It's possible to create a new instance of a
3351 * ::Elm_Theme to set other theme for a specific widget (and all of its
3352 * children), but this is as discouraged, if not even more so, than using
3353 * overlays. Don't use this unless you really know what you are doing.
3355 * But to be less negative about things, you can look at the following
3357 * @li @ref theme_example_01 "Using extensions"
3358 * @li @ref theme_example_02 "Using overlays"
3363 * @typedef Elm_Theme
3365 * Opaque handler for the list of themes Elementary looks for when
3366 * rendering widgets.
3368 * Stay out of this unless you really know what you are doing. For most
3369 * cases, sticking to the default is all a developer needs.
3371 typedef struct _Elm_Theme Elm_Theme;
3374 * Create a new specific theme
3376 * This creates an empty specific theme that only uses the default theme. A
3377 * specific theme has its own private set of extensions and overlays too
3378 * (which are empty by default). Specific themes do not fall back to themes
3379 * of parent objects. They are not intended for this use. Use styles, overlays
3380 * and extensions when needed, but avoid specific themes unless there is no
3381 * other way (example: you want to have a preview of a new theme you are
3382 * selecting in a "theme selector" window. The preview is inside a scroller
3383 * and should display what the theme you selected will look like, but not
3384 * actually apply it yet. The child of the scroller will have a specific
3385 * theme set to show this preview before the user decides to apply it to all
3388 EAPI Elm_Theme *elm_theme_new(void);
3390 * Free a specific theme
3392 * @param th The theme to free
3394 * This frees a theme created with elm_theme_new().
3396 EAPI void elm_theme_free(Elm_Theme *th);
3398 * Copy the theme fom the source to the destination theme
3400 * @param th The source theme to copy from
3401 * @param thdst The destination theme to copy data to
3403 * This makes a one-time static copy of all the theme config, extensions
3404 * and overlays from @p th to @p thdst. If @p th references a theme, then
3405 * @p thdst is also set to reference it, with all the theme settings,
3406 * overlays and extensions that @p th had.
3408 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3410 * Tell the source theme to reference the ref theme
3412 * @param th The theme that will do the referencing
3413 * @param thref The theme that is the reference source
3415 * This clears @p th to be empty and then sets it to refer to @p thref
3416 * so @p th acts as an override to @p thref, but where its overrides
3417 * don't apply, it will fall through to @p thref for configuration.
3419 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3421 * Return the theme referred to
3423 * @param th The theme to get the reference from
3424 * @return The referenced theme handle
3426 * This gets the theme set as the reference theme by elm_theme_ref_set().
3427 * If no theme is set as a reference, NULL is returned.
3429 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3431 * Return the default theme
3433 * @return The default theme handle
3435 * This returns the internal default theme setup handle that all widgets
3436 * use implicitly unless a specific theme is set. This is also often use
3437 * as a shorthand of NULL.
3439 EAPI Elm_Theme *elm_theme_default_get(void);
3441 * Prepends a theme overlay to the list of overlays
3443 * @param th The theme to add to, or if NULL, the default theme
3444 * @param item The Edje file path to be used
3446 * Use this if your application needs to provide some custom overlay theme
3447 * (An Edje file that replaces some default styles of widgets) where adding
3448 * new styles, or changing system theme configuration is not possible. Do
3449 * NOT use this instead of a proper system theme configuration. Use proper
3450 * configuration files, profiles, environment variables etc. to set a theme
3451 * so that the theme can be altered by simple confiugration by a user. Using
3452 * this call to achieve that effect is abusing the API and will create lots
3455 * @see elm_theme_extension_add()
3457 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3459 * Delete a theme overlay from the list of overlays
3461 * @param th The theme to delete from, or if NULL, the default theme
3462 * @param item The name of the theme overlay
3464 * @see elm_theme_overlay_add()
3466 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3468 * Appends a theme extension to the list of extensions.
3470 * @param th The theme to add to, or if NULL, the default theme
3471 * @param item The Edje file path to be used
3473 * This is intended when an application needs more styles of widgets or new
3474 * widget themes that the default does not provide (or may not provide). The
3475 * application has "extended" usage by coming up with new custom style names
3476 * for widgets for specific uses, but as these are not "standard", they are
3477 * not guaranteed to be provided by a default theme. This means the
3478 * application is required to provide these extra elements itself in specific
3479 * Edje files. This call adds one of those Edje files to the theme search
3480 * path to be search after the default theme. The use of this call is
3481 * encouraged when default styles do not meet the needs of the application.
3482 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3484 * @see elm_object_style_set()
3486 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3488 * Deletes a theme extension from the list of extensions.
3490 * @param th The theme to delete from, or if NULL, the default theme
3491 * @param item The name of the theme extension
3493 * @see elm_theme_extension_add()
3495 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3497 * Set the theme search order for the given theme
3499 * @param th The theme to set the search order, or if NULL, the default theme
3500 * @param theme Theme search string
3502 * This sets the search string for the theme in path-notation from first
3503 * theme to search, to last, delimited by the : character. Example:
3505 * "shiny:/path/to/file.edj:default"
3507 * See the ELM_THEME environment variable for more information.
3509 * @see elm_theme_get()
3510 * @see elm_theme_list_get()
3512 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3514 * Return the theme search order
3516 * @param th The theme to get the search order, or if NULL, the default theme
3517 * @return The internal search order path
3519 * This function returns a colon separated string of theme elements as
3520 * returned by elm_theme_list_get().
3522 * @see elm_theme_set()
3523 * @see elm_theme_list_get()
3525 EAPI const char *elm_theme_get(Elm_Theme *th);
3527 * Return a list of theme elements to be used in a theme.
3529 * @param th Theme to get the list of theme elements from.
3530 * @return The internal list of theme elements
3532 * This returns the internal list of theme elements (will only be valid as
3533 * long as the theme is not modified by elm_theme_set() or theme is not
3534 * freed by elm_theme_free(). This is a list of strings which must not be
3535 * altered as they are also internal. If @p th is NULL, then the default
3536 * theme element list is returned.
3538 * A theme element can consist of a full or relative path to a .edj file,
3539 * or a name, without extension, for a theme to be searched in the known
3540 * theme paths for Elemementary.
3542 * @see elm_theme_set()
3543 * @see elm_theme_get()
3545 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3547 * Return the full patrh for a theme element
3549 * @param f The theme element name
3550 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3551 * @return The full path to the file found.
3553 * This returns a string you should free with free() on success, NULL on
3554 * failure. This will search for the given theme element, and if it is a
3555 * full or relative path element or a simple searchable name. The returned
3556 * path is the full path to the file, if searched, and the file exists, or it
3557 * is simply the full path given in the element or a resolved path if
3558 * relative to home. The @p in_search_path boolean pointed to is set to
3559 * EINA_TRUE if the file was a searchable file andis in the search path,
3560 * and EINA_FALSE otherwise.
3562 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3564 * Flush the current theme.
3566 * @param th Theme to flush
3568 * This flushes caches that let elementary know where to find theme elements
3569 * in the given theme. If @p th is NULL, then the default theme is flushed.
3570 * Call this function if source theme data has changed in such a way as to
3571 * make any caches Elementary kept invalid.
3573 EAPI void elm_theme_flush(Elm_Theme *th);
3575 * This flushes all themes (default and specific ones).
3577 * This will flush all themes in the current application context, by calling
3578 * elm_theme_flush() on each of them.
3580 EAPI void elm_theme_full_flush(void);
3582 * Set the theme for all elementary using applications on the current display
3584 * @param theme The name of the theme to use. Format same as the ELM_THEME
3585 * environment variable.
3587 EAPI void elm_theme_all_set(const char *theme);
3589 * Return a list of theme elements in the theme search path
3591 * @return A list of strings that are the theme element names.
3593 * This lists all available theme files in the standard Elementary search path
3594 * for theme elements, and returns them in alphabetical order as theme
3595 * element names in a list of strings. Free this with
3596 * elm_theme_name_available_list_free() when you are done with the list.
3598 EAPI Eina_List *elm_theme_name_available_list_new(void);
3600 * Free the list returned by elm_theme_name_available_list_new()
3602 * This frees the list of themes returned by
3603 * elm_theme_name_available_list_new(). Once freed the list should no longer
3604 * be used. a new list mys be created.
3606 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3608 * Set a specific theme to be used for this object and its children
3610 * @param obj The object to set the theme on
3611 * @param th The theme to set
3613 * This sets a specific theme that will be used for the given object and any
3614 * child objects it has. If @p th is NULL then the theme to be used is
3615 * cleared and the object will inherit its theme from its parent (which
3616 * ultimately will use the default theme if no specific themes are set).
3618 * Use special themes with great care as this will annoy users and make
3619 * configuration difficult. Avoid any custom themes at all if it can be
3622 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3624 * Get the specific theme to be used
3626 * @param obj The object to get the specific theme from
3627 * @return The specifc theme set.
3629 * This will return a specific theme set, or NULL if no specific theme is
3630 * set on that object. It will not return inherited themes from parents, only
3631 * the specific theme set for that specific object. See elm_object_theme_set()
3632 * for more information.
3634 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3637 * Get a data item from a theme
3639 * @param th The theme, or NULL for default theme
3640 * @param key The data key to search with
3641 * @return The data value, or NULL on failure
3643 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3644 * It works the same way as edje_file_data_get() except that the return is stringshared.
3646 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3652 /** @defgroup Win Win
3654 * @image html img/widget/win/preview-00.png
3655 * @image latex img/widget/win/preview-00.eps
3657 * The window class of Elementary. Contains functions to manipulate
3658 * windows. The Evas engine used to render the window contents is specified
3659 * in the system or user elementary config files (whichever is found last),
3660 * and can be overridden with the ELM_ENGINE environment variable for
3661 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3662 * compilation setup and modules actually installed at runtime) are (listed
3663 * in order of best supported and most likely to be complete and work to
3666 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3667 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3669 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3671 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3673 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3675 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3676 * rendering using SDL as the buffer)
3677 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3678 * GDI with software)
3679 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3680 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3681 * grayscale using dedicated 8bit software engine in X11)
3682 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3683 * X11 using 16bit software engine)
3684 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3685 * (Windows CE rendering via GDI with 16bit software renderer)
3686 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3687 * buffer with 16bit software renderer)
3688 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3689 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3690 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3692 * All engines use a simple string to select the engine to render, EXCEPT
3693 * the "shot" engine. This actually encodes the output of the virtual
3694 * screenshot and how long to delay in the engine string. The engine string
3695 * is encoded in the following way:
3697 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3699 * Where options are separated by a ":" char if more than one option is
3700 * given, with delay, if provided being the first option and file the last
3701 * (order is important). The delay specifies how long to wait after the
3702 * window is shown before doing the virtual "in memory" rendering and then
3703 * save the output to the file specified by the file option (and then exit).
3704 * If no delay is given, the default is 0.5 seconds. If no file is given the
3705 * default output file is "out.png". Repeat option is for continous
3706 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3707 * fixed to "out001.png" Some examples of using the shot engine:
3709 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3710 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3711 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3712 * ELM_ENGINE="shot:delay=2.0" elementary_test
3713 * ELM_ENGINE="shot:" elementary_test
3715 * Signals that you can add callbacks for are:
3717 * @li "delete,request": the user requested to close the window. See
3718 * elm_win_autodel_set().
3719 * @li "focus,in": window got focus
3720 * @li "focus,out": window lost focus
3721 * @li "moved": window that holds the canvas was moved
3724 * @li @ref win_example_01
3729 * Defines the types of window that can be created
3731 * These are hints set on the window so that a running Window Manager knows
3732 * how the window should be handled and/or what kind of decorations it
3735 * Currently, only the X11 backed engines use them.
3737 typedef enum _Elm_Win_Type
3739 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3740 window. Almost every window will be created with this
3742 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3743 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3744 window holding desktop icons. */
3745 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3746 be kept on top of any other window by the Window
3748 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3750 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3751 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3753 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3754 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3755 entry in a menubar is clicked. Typically used
3756 with elm_win_override_set(). This hint exists
3757 for completion only, as the EFL way of
3758 implementing a menu would not normally use a
3759 separate window for its contents. */
3760 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3761 triggered by right-clicking an object. */
3762 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3763 explanatory text that typically appear after the
3764 mouse cursor hovers over an object for a while.
3765 Typically used with elm_win_override_set() and also
3766 not very commonly used in the EFL. */
3767 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3768 battery life or a new E-Mail received. */
3769 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3770 usually used in the EFL. */
3771 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3772 object being dragged across different windows, or even
3773 applications. Typically used with
3774 elm_win_override_set(). */
3775 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3776 buffer. No actual window is created for this
3777 type, instead the window and all of its
3778 contents will be rendered to an image buffer.
3779 This allows to have children window inside a
3780 parent one just like any other object would
3781 be, and do other things like applying @c
3782 Evas_Map effects to it. This is the only type
3783 of window that requires the @c parent
3784 parameter of elm_win_add() to be a valid @c
3789 * The differents layouts that can be requested for the virtual keyboard.
3791 * When the application window is being managed by Illume, it may request
3792 * any of the following layouts for the virtual keyboard.
3794 typedef enum _Elm_Win_Keyboard_Mode
3796 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3797 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3798 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3799 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3800 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3801 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3802 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3803 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3804 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3805 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3806 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3807 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3808 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3809 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3810 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3811 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3812 } Elm_Win_Keyboard_Mode;
3815 * Available commands that can be sent to the Illume manager.
3817 * When running under an Illume session, a window may send commands to the
3818 * Illume manager to perform different actions.
3820 typedef enum _Elm_Illume_Command
3822 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3824 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3826 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3828 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3829 } Elm_Illume_Command;
3832 * Adds a window object. If this is the first window created, pass NULL as
3835 * @param parent Parent object to add the window to, or NULL
3836 * @param name The name of the window
3837 * @param type The window type, one of #Elm_Win_Type.
3839 * The @p parent paramter can be @c NULL for every window @p type except
3840 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3841 * which the image object will be created.
3843 * @return The created object, or NULL on failure
3845 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3847 * Adds a window object with standard setup
3849 * @param name The name of the window
3850 * @param title The title for the window
3852 * This creates a window like elm_win_add() but also puts in a standard
3853 * background with elm_bg_add(), as well as setting the window title to
3854 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3855 * as the parent widget.
3857 * @return The created object, or NULL on failure
3859 * @see elm_win_add()
3861 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3863 * Add @p subobj as a resize object of window @p obj.
3866 * Setting an object as a resize object of the window means that the
3867 * @p subobj child's size and position will be controlled by the window
3868 * directly. That is, the object will be resized to match the window size
3869 * and should never be moved or resized manually by the developer.
3871 * In addition, resize objects of the window control what the minimum size
3872 * of it will be, as well as whether it can or not be resized by the user.
3874 * For the end user to be able to resize a window by dragging the handles
3875 * or borders provided by the Window Manager, or using any other similar
3876 * mechanism, all of the resize objects in the window should have their
3877 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3879 * @param obj The window object
3880 * @param subobj The resize object to add
3882 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3884 * Delete @p subobj as a resize object of window @p obj.
3886 * This function removes the object @p subobj from the resize objects of
3887 * the window @p obj. It will not delete the object itself, which will be
3888 * left unmanaged and should be deleted by the developer, manually handled
3889 * or set as child of some other container.
3891 * @param obj The window object
3892 * @param subobj The resize object to add
3894 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3896 * Set the title of the window
3898 * @param obj The window object
3899 * @param title The title to set
3901 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3903 * Get the title of the window
3905 * The returned string is an internal one and should not be freed or
3906 * modified. It will also be rendered invalid if a new title is set or if
3907 * the window is destroyed.
3909 * @param obj The window object
3912 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3914 * Set the window's autodel state.
3916 * When closing the window in any way outside of the program control, like
3917 * pressing the X button in the titlebar or using a command from the
3918 * Window Manager, a "delete,request" signal is emitted to indicate that
3919 * this event occurred and the developer can take any action, which may
3920 * include, or not, destroying the window object.
3922 * When the @p autodel parameter is set, the window will be automatically
3923 * destroyed when this event occurs, after the signal is emitted.
3924 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3925 * and is up to the program to do so when it's required.
3927 * @param obj The window object
3928 * @param autodel If true, the window will automatically delete itself when
3931 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3933 * Get the window's autodel state.
3935 * @param obj The window object
3936 * @return If the window will automatically delete itself when closed
3938 * @see elm_win_autodel_set()
3940 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3942 * Activate a window object.
3944 * This function sends a request to the Window Manager to activate the
3945 * window pointed by @p obj. If honored by the WM, the window will receive
3946 * the keyboard focus.
3948 * @note This is just a request that a Window Manager may ignore, so calling
3949 * this function does not ensure in any way that the window will be the
3950 * active one after it.
3952 * @param obj The window object
3954 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3956 * Lower a window object.
3958 * Places the window pointed by @p obj at the bottom of the stack, so that
3959 * no other window is covered by it.
3961 * If elm_win_override_set() is not set, the Window Manager may ignore this
3964 * @param obj The window object
3966 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3968 * Raise a window object.
3970 * Places the window pointed by @p obj at the top of the stack, so that it's
3971 * not covered by any other window.
3973 * If elm_win_override_set() is not set, the Window Manager may ignore this
3976 * @param obj The window object
3978 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3980 * Set the borderless state of a window.
3982 * This function requests the Window Manager to not draw any decoration
3983 * around the window.
3985 * @param obj The window object
3986 * @param borderless If true, the window is borderless
3988 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3990 * Get the borderless state of a window.
3992 * @param obj The window object
3993 * @return If true, the window is borderless
3995 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3997 * Set the shaped state of a window.
3999 * Shaped windows, when supported, will render the parts of the window that
4000 * has no content, transparent.
4002 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4003 * background object or cover the entire window in any other way, or the
4004 * parts of the canvas that have no data will show framebuffer artifacts.
4006 * @param obj The window object
4007 * @param shaped If true, the window is shaped
4009 * @see elm_win_alpha_set()
4011 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4013 * Get the shaped state of a window.
4015 * @param obj The window object
4016 * @return If true, the window is shaped
4018 * @see elm_win_shaped_set()
4020 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4022 * Set the alpha channel state of a window.
4024 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4025 * possibly making parts of the window completely or partially transparent.
4026 * This is also subject to the underlying system supporting it, like for
4027 * example, running under a compositing manager. If no compositing is
4028 * available, enabling this option will instead fallback to using shaped
4029 * windows, with elm_win_shaped_set().
4031 * @param obj The window object
4032 * @param alpha If true, the window has an alpha channel
4034 * @see elm_win_alpha_set()
4036 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4038 * Get the transparency state of a window.
4040 * @param obj The window object
4041 * @return If true, the window is transparent
4043 * @see elm_win_transparent_set()
4045 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4047 * Set the transparency state of a window.
4049 * Use elm_win_alpha_set() instead.
4051 * @param obj The window object
4052 * @param transparent If true, the window is transparent
4054 * @see elm_win_alpha_set()
4056 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4058 * Get the alpha channel state of a window.
4060 * @param obj The window object
4061 * @return If true, the window has an alpha channel
4063 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4065 * Set the override state of a window.
4067 * A window with @p override set to EINA_TRUE will not be managed by the
4068 * Window Manager. This means that no decorations of any kind will be shown
4069 * for it, moving and resizing must be handled by the application, as well
4070 * as the window visibility.
4072 * This should not be used for normal windows, and even for not so normal
4073 * ones, it should only be used when there's a good reason and with a lot
4074 * of care. Mishandling override windows may result situations that
4075 * disrupt the normal workflow of the end user.
4077 * @param obj The window object
4078 * @param override If true, the window is overridden
4080 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4082 * Get the override state of a window.
4084 * @param obj The window object
4085 * @return If true, the window is overridden
4087 * @see elm_win_override_set()
4089 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4091 * Set the fullscreen state of a window.
4093 * @param obj The window object
4094 * @param fullscreen If true, the window is fullscreen
4096 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4098 * Get the fullscreen state of a window.
4100 * @param obj The window object
4101 * @return If true, the window is fullscreen
4103 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4105 * Set the maximized state of a window.
4107 * @param obj The window object
4108 * @param maximized If true, the window is maximized
4110 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4112 * Get the maximized state of a window.
4114 * @param obj The window object
4115 * @return If true, the window is maximized
4117 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4119 * Set the iconified state of a window.
4121 * @param obj The window object
4122 * @param iconified If true, the window is iconified
4124 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4126 * Get the iconified state of a window.
4128 * @param obj The window object
4129 * @return If true, the window is iconified
4131 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4133 * Set the layer of the window.
4135 * What this means exactly will depend on the underlying engine used.
4137 * In the case of X11 backed engines, the value in @p layer has the
4138 * following meanings:
4139 * @li < 3: The window will be placed below all others.
4140 * @li > 5: The window will be placed above all others.
4141 * @li other: The window will be placed in the default layer.
4143 * @param obj The window object
4144 * @param layer The layer of the window
4146 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4148 * Get the layer of the window.
4150 * @param obj The window object
4151 * @return The layer of the window
4153 * @see elm_win_layer_set()
4155 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4157 * Set the rotation of the window.
4159 * Most engines only work with multiples of 90.
4161 * This function is used to set the orientation of the window @p obj to
4162 * match that of the screen. The window itself will be resized to adjust
4163 * to the new geometry of its contents. If you want to keep the window size,
4164 * see elm_win_rotation_with_resize_set().
4166 * @param obj The window object
4167 * @param rotation The rotation of the window, in degrees (0-360),
4168 * counter-clockwise.
4170 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4172 * Rotates the window and resizes it.
4174 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4175 * that they fit inside the current window geometry.
4177 * @param obj The window object
4178 * @param layer The rotation of the window in degrees (0-360),
4179 * counter-clockwise.
4181 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4183 * Get the rotation of the window.
4185 * @param obj The window object
4186 * @return The rotation of the window in degrees (0-360)
4188 * @see elm_win_rotation_set()
4189 * @see elm_win_rotation_with_resize_set()
4191 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4193 * Set the sticky state of the window.
4195 * Hints the Window Manager that the window in @p obj should be left fixed
4196 * at its position even when the virtual desktop it's on moves or changes.
4198 * @param obj The window object
4199 * @param sticky If true, the window's sticky state is enabled
4201 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4203 * Get the sticky state of the window.
4205 * @param obj The window object
4206 * @return If true, the window's sticky state is enabled
4208 * @see elm_win_sticky_set()
4210 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4212 * Set if this window is an illume conformant window
4214 * @param obj The window object
4215 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4217 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4219 * Get if this window is an illume conformant window
4221 * @param obj The window object
4222 * @return A boolean if this window is illume conformant or not
4224 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4226 * Set a window to be an illume quickpanel window
4228 * By default window objects are not quickpanel windows.
4230 * @param obj The window object
4231 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4233 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4235 * Get if this window is a quickpanel or not
4237 * @param obj The window object
4238 * @return A boolean if this window is a quickpanel or not
4240 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4242 * Set the major priority of a quickpanel window
4244 * @param obj The window object
4245 * @param priority The major priority for this quickpanel
4247 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4249 * Get the major priority of a quickpanel window
4251 * @param obj The window object
4252 * @return The major priority of this quickpanel
4254 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4256 * Set the minor priority of a quickpanel window
4258 * @param obj The window object
4259 * @param priority The minor priority for this quickpanel
4261 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4263 * Get the minor priority of a quickpanel window
4265 * @param obj The window object
4266 * @return The minor priority of this quickpanel
4268 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4270 * Set which zone this quickpanel should appear in
4272 * @param obj The window object
4273 * @param zone The requested zone for this quickpanel
4275 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4277 * Get which zone this quickpanel should appear in
4279 * @param obj The window object
4280 * @return The requested zone for this quickpanel
4282 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4284 * Set the window to be skipped by keyboard focus
4286 * This sets the window to be skipped by normal keyboard input. This means
4287 * a window manager will be asked to not focus this window as well as omit
4288 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4290 * Call this and enable it on a window BEFORE you show it for the first time,
4291 * otherwise it may have no effect.
4293 * Use this for windows that have only output information or might only be
4294 * interacted with by the mouse or fingers, and never for typing input.
4295 * Be careful that this may have side-effects like making the window
4296 * non-accessible in some cases unless the window is specially handled. Use
4299 * @param obj The window object
4300 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4302 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4304 * Send a command to the windowing environment
4306 * This is intended to work in touchscreen or small screen device
4307 * environments where there is a more simplistic window management policy in
4308 * place. This uses the window object indicated to select which part of the
4309 * environment to control (the part that this window lives in), and provides
4310 * a command and an optional parameter structure (use NULL for this if not
4313 * @param obj The window object that lives in the environment to control
4314 * @param command The command to send
4315 * @param params Optional parameters for the command
4317 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4319 * Get the inlined image object handle
4321 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4322 * then the window is in fact an evas image object inlined in the parent
4323 * canvas. You can get this object (be careful to not manipulate it as it
4324 * is under control of elementary), and use it to do things like get pixel
4325 * data, save the image to a file, etc.
4327 * @param obj The window object to get the inlined image from
4328 * @return The inlined image object, or NULL if none exists
4330 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4332 * Set the enabled status for the focus highlight in a window
4334 * This function will enable or disable the focus highlight only for the
4335 * given window, regardless of the global setting for it
4337 * @param obj The window where to enable the highlight
4338 * @param enabled The enabled value for the highlight
4340 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4342 * Get the enabled value of the focus highlight for this window
4344 * @param obj The window in which to check if the focus highlight is enabled
4346 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4348 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4350 * Set the style for the focus highlight on this window
4352 * Sets the style to use for theming the highlight of focused objects on
4353 * the given window. If @p style is NULL, the default will be used.
4355 * @param obj The window where to set the style
4356 * @param style The style to set
4358 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4360 * Get the style set for the focus highlight object
4362 * Gets the style set for this windows highilght object, or NULL if none
4365 * @param obj The window to retrieve the highlights style from
4367 * @return The style set or NULL if none was. Default is used in that case.
4369 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4370 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4371 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4373 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4374 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4375 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4376 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4377 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4378 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4379 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4381 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4382 * (blank mouse, private mouse obj, defaultmouse)
4386 * Sets the keyboard mode of the window.
4388 * @param obj The window object
4389 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4391 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4393 * Gets the keyboard mode of the window.
4395 * @param obj The window object
4396 * @return The mode, one of #Elm_Win_Keyboard_Mode
4398 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4400 * Sets whether the window is a keyboard.
4402 * @param obj The window object
4403 * @param is_keyboard If true, the window is a virtual keyboard
4405 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4407 * Gets whether the window is a keyboard.
4409 * @param obj The window object
4410 * @return If the window is a virtual keyboard
4412 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4415 * Get the screen position of a window.
4417 * @param obj The window object
4418 * @param x The int to store the x coordinate to
4419 * @param y The int to store the y coordinate to
4421 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4427 * @defgroup Inwin Inwin
4429 * @image html img/widget/inwin/preview-00.png
4430 * @image latex img/widget/inwin/preview-00.eps
4431 * @image html img/widget/inwin/preview-01.png
4432 * @image latex img/widget/inwin/preview-01.eps
4433 * @image html img/widget/inwin/preview-02.png
4434 * @image latex img/widget/inwin/preview-02.eps
4436 * An inwin is a window inside a window that is useful for a quick popup.
4437 * It does not hover.
4439 * It works by creating an object that will occupy the entire window, so it
4440 * must be created using an @ref Win "elm_win" as parent only. The inwin
4441 * object can be hidden or restacked below every other object if it's
4442 * needed to show what's behind it without destroying it. If this is done,
4443 * the elm_win_inwin_activate() function can be used to bring it back to
4444 * full visibility again.
4446 * There are three styles available in the default theme. These are:
4447 * @li default: The inwin is sized to take over most of the window it's
4449 * @li minimal: The size of the inwin will be the minimum necessary to show
4451 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4452 * possible, but it's sized vertically the most it needs to fit its\
4455 * Some examples of Inwin can be found in the following:
4456 * @li @ref inwin_example_01
4461 * Adds an inwin to the current window
4463 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4464 * Never call this function with anything other than the top-most window
4465 * as its parameter, unless you are fond of undefined behavior.
4467 * After creating the object, the widget will set itself as resize object
4468 * for the window with elm_win_resize_object_add(), so when shown it will
4469 * appear to cover almost the entire window (how much of it depends on its
4470 * content and the style used). It must not be added into other container
4471 * objects and it needs not be moved or resized manually.
4473 * @param parent The parent object
4474 * @return The new object or NULL if it cannot be created
4476 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4478 * Activates an inwin object, ensuring its visibility
4480 * This function will make sure that the inwin @p obj is completely visible
4481 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4482 * to the front. It also sets the keyboard focus to it, which will be passed
4485 * The object's theme will also receive the signal "elm,action,show" with
4488 * @param obj The inwin to activate
4490 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4492 * Set the content of an inwin object.
4494 * Once the content object is set, a previously set one will be deleted.
4495 * If you want to keep that old content object, use the
4496 * elm_win_inwin_content_unset() function.
4498 * @param obj The inwin object
4499 * @param content The object to set as content
4501 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4503 * Get the content of an inwin object.
4505 * Return the content object which is set for this widget.
4507 * The returned object is valid as long as the inwin is still alive and no
4508 * other content is set on it. Deleting the object will notify the inwin
4509 * about it and this one will be left empty.
4511 * If you need to remove an inwin's content to be reused somewhere else,
4512 * see elm_win_inwin_content_unset().
4514 * @param obj The inwin object
4515 * @return The content that is being used
4517 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4519 * Unset the content of an inwin object.
4521 * Unparent and return the content object which was set for this widget.
4523 * @param obj The inwin object
4524 * @return The content that was being used
4526 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4530 /* X specific calls - won't work on non-x engines (return 0) */
4533 * Get the Ecore_X_Window of an Evas_Object
4535 * @param obj The object
4537 * @return The Ecore_X_Window of @p obj
4541 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4543 /* smart callbacks called:
4544 * "delete,request" - the user requested to delete the window
4545 * "focus,in" - window got focus
4546 * "focus,out" - window lost focus
4547 * "moved" - window that holds the canvas was moved
4553 * @image html img/widget/bg/preview-00.png
4554 * @image latex img/widget/bg/preview-00.eps
4556 * @brief Background object, used for setting a solid color, image or Edje
4557 * group as background to a window or any container object.
4559 * The bg object is used for setting a solid background to a window or
4560 * packing into any container object. It works just like an image, but has
4561 * some properties useful to a background, like setting it to tiled,
4562 * centered, scaled or stretched.
4564 * Default contents parts of the bg widget that you can use for are:
4565 * @li "overlay" - overlay of the bg
4567 * Here is some sample code using it:
4568 * @li @ref bg_01_example_page
4569 * @li @ref bg_02_example_page
4570 * @li @ref bg_03_example_page
4574 typedef enum _Elm_Bg_Option
4576 ELM_BG_OPTION_CENTER, /**< center the background */
4577 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4578 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4579 ELM_BG_OPTION_TILE /**< tile background at its original size */
4583 * Add a new background to the parent
4585 * @param parent The parent object
4586 * @return The new object or NULL if it cannot be created
4590 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4593 * Set the file (image or edje) used for the background
4595 * @param obj The bg object
4596 * @param file The file path
4597 * @param group Optional key (group in Edje) within the file
4599 * This sets the image file used in the background object. The image (or edje)
4600 * will be stretched (retaining aspect if its an image file) to completely fill
4601 * the bg object. This may mean some parts are not visible.
4603 * @note Once the image of @p obj is set, a previously set one will be deleted,
4604 * even if @p file is NULL.
4608 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4611 * Get the file (image or edje) used for the background
4613 * @param obj The bg object
4614 * @param file The file path
4615 * @param group Optional key (group in Edje) within the file
4619 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4622 * Set the option used for the background image
4624 * @param obj The bg object
4625 * @param option The desired background option (TILE, SCALE)
4627 * This sets the option used for manipulating the display of the background
4628 * image. The image can be tiled or scaled.
4632 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4635 * Get the option used for the background image
4637 * @param obj The bg object
4638 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4642 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4644 * Set the option used for the background color
4646 * @param obj The bg object
4651 * This sets the color used for the background rectangle. Its range goes
4656 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4658 * Get the option used for the background color
4660 * @param obj The bg object
4667 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4670 * Set the overlay object used for the background object.
4672 * @param obj The bg object
4673 * @param overlay The overlay object
4675 * This provides a way for elm_bg to have an 'overlay' that will be on top
4676 * of the bg. Once the over object is set, a previously set one will be
4677 * deleted, even if you set the new one to NULL. If you want to keep that
4678 * old content object, use the elm_bg_overlay_unset() function.
4680 * @deprecated use elm_object_content_part_set() instead
4685 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4688 * Get the overlay object used for the background object.
4690 * @param obj The bg object
4691 * @return The content that is being used
4693 * Return the content object which is set for this widget
4695 * @deprecated use elm_object_part_content_get() instead
4699 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4702 * Get the overlay object used for the background object.
4704 * @param obj The bg object
4705 * @return The content that was being used
4707 * Unparent and return the overlay object which was set for this widget
4709 * @deprecated use elm_object_content_part_unset() instead
4713 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4716 * Set the size of the pixmap representation of the image.
4718 * This option just makes sense if an image is going to be set in the bg.
4720 * @param obj The bg object
4721 * @param w The new width of the image pixmap representation.
4722 * @param h The new height of the image pixmap representation.
4724 * This function sets a new size for pixmap representation of the given bg
4725 * image. It allows the image to be loaded already in the specified size,
4726 * reducing the memory usage and load time when loading a big image with load
4727 * size set to a smaller size.
4729 * NOTE: this is just a hint, the real size of the pixmap may differ
4730 * depending on the type of image being loaded, being bigger than requested.
4734 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4735 /* smart callbacks called:
4739 * @defgroup Icon Icon
4741 * @image html img/widget/icon/preview-00.png
4742 * @image latex img/widget/icon/preview-00.eps
4744 * An object that provides standard icon images (delete, edit, arrows, etc.)
4745 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4747 * The icon image requested can be in the elementary theme, or in the
4748 * freedesktop.org paths. It's possible to set the order of preference from
4749 * where the image will be used.
4751 * This API is very similar to @ref Image, but with ready to use images.
4753 * Default images provided by the theme are described below.
4755 * The first list contains icons that were first intended to be used in
4756 * toolbars, but can be used in many other places too:
4772 * Now some icons that were designed to be used in menus (but again, you can
4773 * use them anywhere else):
4778 * @li menu/arrow_down
4779 * @li menu/arrow_left
4780 * @li menu/arrow_right
4789 * And here we have some media player specific icons:
4790 * @li media_player/forward
4791 * @li media_player/info
4792 * @li media_player/next
4793 * @li media_player/pause
4794 * @li media_player/play
4795 * @li media_player/prev
4796 * @li media_player/rewind
4797 * @li media_player/stop
4799 * Signals that you can add callbacks for are:
4801 * "clicked" - This is called when a user has clicked the icon
4803 * An example of usage for this API follows:
4804 * @li @ref tutorial_icon
4812 typedef enum _Elm_Icon_Type
4819 * @enum _Elm_Icon_Lookup_Order
4820 * @typedef Elm_Icon_Lookup_Order
4822 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4823 * theme, FDO paths, or both?
4827 typedef enum _Elm_Icon_Lookup_Order
4829 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4830 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4831 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4832 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4833 } Elm_Icon_Lookup_Order;
4836 * Add a new icon object to the parent.
4838 * @param parent The parent object
4839 * @return The new object or NULL if it cannot be created
4841 * @see elm_icon_file_set()
4845 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4847 * Set the file that will be used as icon.
4849 * @param obj The icon object
4850 * @param file The path to file that will be used as icon image
4851 * @param group The group that the icon belongs to an edje file
4853 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4855 * @note The icon image set by this function can be changed by
4856 * elm_icon_standard_set().
4858 * @see elm_icon_file_get()
4862 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4864 * Set a location in memory to be used as an icon
4866 * @param obj The icon object
4867 * @param img The binary data that will be used as an image
4868 * @param size The size of binary data @p img
4869 * @param format Optional format of @p img to pass to the image loader
4870 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4872 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4874 * @note The icon image set by this function can be changed by
4875 * elm_icon_standard_set().
4879 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);
4881 * Get the file that will be used as icon.
4883 * @param obj The icon object
4884 * @param file The path to file that will be used as the icon image
4885 * @param group The group that the icon belongs to, in edje file
4887 * @see elm_icon_file_set()
4891 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4892 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4894 * Set the icon by icon standards names.
4896 * @param obj The icon object
4897 * @param name The icon name
4899 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4901 * For example, freedesktop.org defines standard icon names such as "home",
4902 * "network", etc. There can be different icon sets to match those icon
4903 * keys. The @p name given as parameter is one of these "keys", and will be
4904 * used to look in the freedesktop.org paths and elementary theme. One can
4905 * change the lookup order with elm_icon_order_lookup_set().
4907 * If name is not found in any of the expected locations and it is the
4908 * absolute path of an image file, this image will be used.
4910 * @note The icon image set by this function can be changed by
4911 * elm_icon_file_set().
4913 * @see elm_icon_standard_get()
4914 * @see elm_icon_file_set()
4918 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4920 * Get the icon name set by icon standard names.
4922 * @param obj The icon object
4923 * @return The icon name
4925 * If the icon image was set using elm_icon_file_set() instead of
4926 * elm_icon_standard_set(), then this function will return @c NULL.
4928 * @see elm_icon_standard_set()
4932 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4934 * Set the smooth scaling for an icon object.
4936 * @param obj The icon object
4937 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4938 * otherwise. Default is @c EINA_TRUE.
4940 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4941 * scaling provides a better resulting image, but is slower.
4943 * The smooth scaling should be disabled when making animations that change
4944 * the icon size, since they will be faster. Animations that don't require
4945 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4946 * is already scaled, since the scaled icon image will be cached).
4948 * @see elm_icon_smooth_get()
4952 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4954 * Get whether smooth scaling is enabled for an icon object.
4956 * @param obj The icon object
4957 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4959 * @see elm_icon_smooth_set()
4963 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4965 * Disable scaling of this object.
4967 * @param obj The icon object.
4968 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4969 * otherwise. Default is @c EINA_FALSE.
4971 * This function disables scaling of the icon object through the function
4972 * elm_object_scale_set(). However, this does not affect the object
4973 * size/resize in any way. For that effect, take a look at
4974 * elm_icon_scale_set().
4976 * @see elm_icon_no_scale_get()
4977 * @see elm_icon_scale_set()
4978 * @see elm_object_scale_set()
4982 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4984 * Get whether scaling is disabled on the object.
4986 * @param obj The icon object
4987 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4989 * @see elm_icon_no_scale_set()
4993 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4995 * Set if the object is (up/down) resizable.
4997 * @param obj The icon object
4998 * @param scale_up A bool to set if the object is resizable up. Default is
5000 * @param scale_down A bool to set if the object is resizable down. Default
5003 * This function limits the icon object resize ability. If @p scale_up is set to
5004 * @c EINA_FALSE, the object can't have its height or width resized to a value
5005 * higher than the original icon size. Same is valid for @p scale_down.
5007 * @see elm_icon_scale_get()
5011 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5013 * Get if the object is (up/down) resizable.
5015 * @param obj The icon object
5016 * @param scale_up A bool to set if the object is resizable up
5017 * @param scale_down A bool to set if the object is resizable down
5019 * @see elm_icon_scale_set()
5023 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5025 * Get the object's image size
5027 * @param obj The icon object
5028 * @param w A pointer to store the width in
5029 * @param h A pointer to store the height in
5033 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5035 * Set if the icon fill the entire object area.
5037 * @param obj The icon object
5038 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5039 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5041 * When the icon object is resized to a different aspect ratio from the
5042 * original icon image, the icon image will still keep its aspect. This flag
5043 * tells how the image should fill the object's area. They are: keep the
5044 * entire icon inside the limits of height and width of the object (@p
5045 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5046 * of the object, and the icon will fill the entire object (@p fill_outside
5049 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5050 * retain property to false. Thus, the icon image will always keep its
5051 * original aspect ratio.
5053 * @see elm_icon_fill_outside_get()
5054 * @see elm_image_fill_outside_set()
5058 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5060 * Get if the object is filled outside.
5062 * @param obj The icon object
5063 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5065 * @see elm_icon_fill_outside_set()
5069 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5071 * Set the prescale size for the icon.
5073 * @param obj The icon object
5074 * @param size The prescale size. This value is used for both width and
5077 * This function sets a new size for pixmap representation of the given
5078 * icon. It allows the icon to be loaded already in the specified size,
5079 * reducing the memory usage and load time when loading a big icon with load
5080 * size set to a smaller size.
5082 * It's equivalent to the elm_bg_load_size_set() function for bg.
5084 * @note this is just a hint, the real size of the pixmap may differ
5085 * depending on the type of icon being loaded, being bigger than requested.
5087 * @see elm_icon_prescale_get()
5088 * @see elm_bg_load_size_set()
5092 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5094 * Get the prescale size for the icon.
5096 * @param obj The icon object
5097 * @return The prescale size
5099 * @see elm_icon_prescale_set()
5103 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5105 * Gets the image object of the icon. DO NOT MODIFY THIS.
5107 * @param obj The icon object
5108 * @return The internal icon object
5112 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5114 * Sets the icon lookup order used by elm_icon_standard_set().
5116 * @param obj The icon object
5117 * @param order The icon lookup order (can be one of
5118 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5119 * or ELM_ICON_LOOKUP_THEME)
5121 * @see elm_icon_order_lookup_get()
5122 * @see Elm_Icon_Lookup_Order
5126 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5128 * Gets the icon lookup order.
5130 * @param obj The icon object
5131 * @return The icon lookup order
5133 * @see elm_icon_order_lookup_set()
5134 * @see Elm_Icon_Lookup_Order
5138 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5140 * Enable or disable preloading of the icon
5142 * @param obj The icon object
5143 * @param disable If EINA_TRUE, preloading will be disabled
5146 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5148 * Get if the icon supports animation or not.
5150 * @param obj The icon object
5151 * @return @c EINA_TRUE if the icon supports animation,
5152 * @c EINA_FALSE otherwise.
5154 * Return if this elm icon's image can be animated. Currently Evas only
5155 * supports gif animation. If the return value is EINA_FALSE, other
5156 * elm_icon_animated_XXX APIs won't work.
5159 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5161 * Set animation mode of the icon.
5163 * @param obj The icon object
5164 * @param anim @c EINA_TRUE if the object do animation job,
5165 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5167 * Since the default animation mode is set to EINA_FALSE,
5168 * the icon is shown without animation.
5169 * This might be desirable when the application developer wants to show
5170 * a snapshot of the animated icon.
5171 * Set it to EINA_TRUE when the icon needs to be animated.
5174 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5176 * Get animation mode of the icon.
5178 * @param obj The icon object
5179 * @return The animation mode of the icon object
5180 * @see elm_icon_animated_set
5183 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5185 * Set animation play mode of the icon.
5187 * @param obj The icon object
5188 * @param play @c EINA_TRUE the object play animation images,
5189 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5191 * To play elm icon's animation, set play to EINA_TURE.
5192 * For example, you make gif player using this set/get API and click event.
5194 * 1. Click event occurs
5195 * 2. Check play flag using elm_icon_animaged_play_get
5196 * 3. If elm icon was playing, set play to EINA_FALSE.
5197 * Then animation will be stopped and vice versa
5200 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5202 * Get animation play mode of the icon.
5204 * @param obj The icon object
5205 * @return The play mode of the icon object
5207 * @see elm_icon_animated_play_get
5210 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5212 /* compatibility code to avoid API and ABI breaks */
5213 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5215 elm_icon_animated_set(obj, animated);
5218 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5220 return elm_icon_animated_get(obj);
5223 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5225 elm_icon_animated_play_set(obj, play);
5228 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5230 return elm_icon_animated_play_get(obj);
5238 * @defgroup Image Image
5240 * @image html img/widget/image/preview-00.png
5241 * @image latex img/widget/image/preview-00.eps
5244 * An object that allows one to load an image file to it. It can be used
5245 * anywhere like any other elementary widget.
5247 * This widget provides most of the functionality provided from @ref Bg or @ref
5248 * Icon, but with a slightly different API (use the one that fits better your
5251 * The features not provided by those two other image widgets are:
5252 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5253 * @li change the object orientation with elm_image_orient_set();
5254 * @li and turning the image editable with elm_image_editable_set().
5256 * Signals that you can add callbacks for are:
5258 * @li @c "clicked" - This is called when a user has clicked the image
5260 * An example of usage for this API follows:
5261 * @li @ref tutorial_image
5270 * @enum _Elm_Image_Orient
5271 * @typedef Elm_Image_Orient
5273 * Possible orientation options for elm_image_orient_set().
5275 * @image html elm_image_orient_set.png
5276 * @image latex elm_image_orient_set.eps width=\textwidth
5280 typedef enum _Elm_Image_Orient
5282 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5283 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5284 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5285 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5286 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5287 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5288 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5289 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5293 * Add a new image to the parent.
5295 * @param parent The parent object
5296 * @return The new object or NULL if it cannot be created
5298 * @see elm_image_file_set()
5302 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5304 * Set the file that will be used as image.
5306 * @param obj The image object
5307 * @param file The path to file that will be used as image
5308 * @param group The group that the image belongs in edje file (if it's an
5311 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5313 * @see elm_image_file_get()
5317 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5319 * Get the file that will be used as image.
5321 * @param obj The image object
5322 * @param file The path to file
5323 * @param group The group that the image belongs in edje file
5325 * @see elm_image_file_set()
5329 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5331 * Set the smooth effect for an image.
5333 * @param obj The image object
5334 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5335 * otherwise. Default is @c EINA_TRUE.
5337 * Set the scaling algorithm to be used when scaling the image. Smooth
5338 * scaling provides a better resulting image, but is slower.
5340 * The smooth scaling should be disabled when making animations that change
5341 * the image size, since it will be faster. Animations that don't require
5342 * resizing of the image can keep the smooth scaling enabled (even if the
5343 * image is already scaled, since the scaled image will be cached).
5345 * @see elm_image_smooth_get()
5349 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5351 * Get the smooth effect for an image.
5353 * @param obj The image object
5354 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5356 * @see elm_image_smooth_get()
5360 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5363 * Gets the current size of the image.
5365 * @param obj The image object.
5366 * @param w Pointer to store width, or NULL.
5367 * @param h Pointer to store height, or NULL.
5369 * This is the real size of the image, not the size of the object.
5371 * On error, neither w or h will be written.
5375 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5377 * Disable scaling of this object.
5379 * @param obj The image object.
5380 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5381 * otherwise. Default is @c EINA_FALSE.
5383 * This function disables scaling of the elm_image widget through the
5384 * function elm_object_scale_set(). However, this does not affect the widget
5385 * size/resize in any way. For that effect, take a look at
5386 * elm_image_scale_set().
5388 * @see elm_image_no_scale_get()
5389 * @see elm_image_scale_set()
5390 * @see elm_object_scale_set()
5394 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5396 * Get whether scaling is disabled on the object.
5398 * @param obj The image object
5399 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5401 * @see elm_image_no_scale_set()
5405 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5407 * Set if the object is (up/down) resizable.
5409 * @param obj The image object
5410 * @param scale_up A bool to set if the object is resizable up. Default is
5412 * @param scale_down A bool to set if the object is resizable down. Default
5415 * This function limits the image resize ability. If @p scale_up is set to
5416 * @c EINA_FALSE, the object can't have its height or width resized to a value
5417 * higher than the original image size. Same is valid for @p scale_down.
5419 * @see elm_image_scale_get()
5423 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5425 * Get if the object is (up/down) resizable.
5427 * @param obj The image object
5428 * @param scale_up A bool to set if the object is resizable up
5429 * @param scale_down A bool to set if the object is resizable down
5431 * @see elm_image_scale_set()
5435 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5437 * Set if the image fills the entire object area, when keeping the aspect ratio.
5439 * @param obj The image object
5440 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5441 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5443 * When the image should keep its aspect ratio even if resized to another
5444 * aspect ratio, there are two possibilities to resize it: keep the entire
5445 * image inside the limits of height and width of the object (@p fill_outside
5446 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5447 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5449 * @note This option will have no effect if
5450 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5452 * @see elm_image_fill_outside_get()
5453 * @see elm_image_aspect_ratio_retained_set()
5457 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5459 * Get if the object is filled outside
5461 * @param obj The image object
5462 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5464 * @see elm_image_fill_outside_set()
5468 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5470 * Set the prescale size for the image
5472 * @param obj The image object
5473 * @param size The prescale size. This value is used for both width and
5476 * This function sets a new size for pixmap representation of the given
5477 * image. It allows the image to be loaded already in the specified size,
5478 * reducing the memory usage and load time when loading a big image with load
5479 * size set to a smaller size.
5481 * It's equivalent to the elm_bg_load_size_set() function for bg.
5483 * @note this is just a hint, the real size of the pixmap may differ
5484 * depending on the type of image being loaded, being bigger than requested.
5486 * @see elm_image_prescale_get()
5487 * @see elm_bg_load_size_set()
5491 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5493 * Get the prescale size for the image
5495 * @param obj The image object
5496 * @return The prescale size
5498 * @see elm_image_prescale_set()
5502 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5504 * Set the image orientation.
5506 * @param obj The image object
5507 * @param orient The image orientation @ref Elm_Image_Orient
5508 * Default is #ELM_IMAGE_ORIENT_NONE.
5510 * This function allows to rotate or flip the given image.
5512 * @see elm_image_orient_get()
5513 * @see @ref Elm_Image_Orient
5517 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5519 * Get the image orientation.
5521 * @param obj The image object
5522 * @return The image orientation @ref Elm_Image_Orient
5524 * @see elm_image_orient_set()
5525 * @see @ref Elm_Image_Orient
5529 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5531 * Make the image 'editable'.
5533 * @param obj Image object.
5534 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5536 * This means the image is a valid drag target for drag and drop, and can be
5537 * cut or pasted too.
5541 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5543 * Check if the image 'editable'.
5545 * @param obj Image object.
5546 * @return Editability.
5548 * A return value of EINA_TRUE means the image is a valid drag target
5549 * for drag and drop, and can be cut or pasted too.
5553 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5555 * Get the basic Evas_Image object from this object (widget).
5557 * @param obj The image object to get the inlined image from
5558 * @return The inlined image object, or NULL if none exists
5560 * This function allows one to get the underlying @c Evas_Object of type
5561 * Image from this elementary widget. It can be useful to do things like get
5562 * the pixel data, save the image to a file, etc.
5564 * @note Be careful to not manipulate it, as it is under control of
5569 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5571 * Set whether the original aspect ratio of the image should be kept on resize.
5573 * @param obj The image object.
5574 * @param retained @c EINA_TRUE if the image should retain the aspect,
5575 * @c EINA_FALSE otherwise.
5577 * The original aspect ratio (width / height) of the image is usually
5578 * distorted to match the object's size. Enabling this option will retain
5579 * this original aspect, and the way that the image is fit into the object's
5580 * area depends on the option set by elm_image_fill_outside_set().
5582 * @see elm_image_aspect_ratio_retained_get()
5583 * @see elm_image_fill_outside_set()
5587 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5589 * Get if the object retains the original aspect ratio.
5591 * @param obj The image object.
5592 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5597 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5604 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5606 /* old API compatibility */
5607 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5609 typedef enum _Elm_GLView_Mode
5611 ELM_GLVIEW_ALPHA = 1,
5612 ELM_GLVIEW_DEPTH = 2,
5613 ELM_GLVIEW_STENCIL = 4
5617 * Defines a policy for the glview resizing.
5619 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5621 typedef enum _Elm_GLView_Resize_Policy
5623 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5624 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5625 } Elm_GLView_Resize_Policy;
5627 typedef enum _Elm_GLView_Render_Policy
5629 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5630 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5631 } Elm_GLView_Render_Policy;
5636 * A simple GLView widget that allows GL rendering.
5638 * Signals that you can add callbacks for are:
5644 * Add a new glview to the parent
5646 * @param parent The parent object
5647 * @return The new object or NULL if it cannot be created
5651 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5654 * Sets the size of the glview
5656 * @param obj The glview object
5657 * @param width width of the glview object
5658 * @param height height of the glview object
5662 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5665 * Gets the size of the glview.
5667 * @param obj The glview object
5668 * @param width width of the glview object
5669 * @param height height of the glview object
5671 * Note that this function returns the actual image size of the
5672 * glview. This means that when the scale policy is set to
5673 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5678 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5681 * Gets the gl api struct for gl rendering
5683 * @param obj The glview object
5684 * @return The api object or NULL if it cannot be created
5688 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5691 * Set the mode of the GLView. Supports Three simple modes.
5693 * @param obj The glview object
5694 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5695 * @return True if set properly.
5699 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5702 * Set the resize policy for the glview object.
5704 * @param obj The glview object.
5705 * @param policy The scaling policy.
5707 * By default, the resize policy is set to
5708 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5709 * destroys the previous surface and recreates the newly specified
5710 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5711 * however, glview only scales the image object and not the underlying
5716 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5719 * Set the render policy for the glview object.
5721 * @param obj The glview object.
5722 * @param policy The render policy.
5724 * By default, the render policy is set to
5725 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5726 * that during the render loop, glview is only redrawn if it needs
5727 * to be redrawn. (i.e. When it is visible) If the policy is set to
5728 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5729 * whether it is visible/need redrawing or not.
5733 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5736 * Set the init function that runs once in the main loop.
5738 * @param obj The glview object.
5739 * @param func The init function to be registered.
5741 * The registered init function gets called once during the render loop.
5745 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5748 * Set the render function that runs in the main loop.
5750 * @param obj The glview object.
5751 * @param func The delete function to be registered.
5753 * The registered del function gets called when GLView object is deleted.
5757 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5760 * Set the resize function that gets called when resize happens.
5762 * @param obj The glview object.
5763 * @param func The resize function to be registered.
5767 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5770 * Set the render function that runs in the main loop.
5772 * @param obj The glview object.
5773 * @param func The render function to be registered.
5777 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5780 * Notifies that there has been changes in the GLView.
5782 * @param obj The glview object.
5786 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5796 * @image html img/widget/box/preview-00.png
5797 * @image latex img/widget/box/preview-00.eps width=\textwidth
5799 * @image html img/box.png
5800 * @image latex img/box.eps width=\textwidth
5802 * A box arranges objects in a linear fashion, governed by a layout function
5803 * that defines the details of this arrangement.
5805 * By default, the box will use an internal function to set the layout to
5806 * a single row, either vertical or horizontal. This layout is affected
5807 * by a number of parameters, such as the homogeneous flag set by
5808 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5809 * elm_box_align_set() and the hints set to each object in the box.
5811 * For this default layout, it's possible to change the orientation with
5812 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5813 * placing its elements ordered from top to bottom. When horizontal is set,
5814 * the order will go from left to right. If the box is set to be
5815 * homogeneous, every object in it will be assigned the same space, that
5816 * of the largest object. Padding can be used to set some spacing between
5817 * the cell given to each object. The alignment of the box, set with
5818 * elm_box_align_set(), determines how the bounding box of all the elements
5819 * will be placed within the space given to the box widget itself.
5821 * The size hints of each object also affect how they are placed and sized
5822 * within the box. evas_object_size_hint_min_set() will give the minimum
5823 * size the object can have, and the box will use it as the basis for all
5824 * latter calculations. Elementary widgets set their own minimum size as
5825 * needed, so there's rarely any need to use it manually.
5827 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5828 * used to tell whether the object will be allocated the minimum size it
5829 * needs or if the space given to it should be expanded. It's important
5830 * to realize that expanding the size given to the object is not the same
5831 * thing as resizing the object. It could very well end being a small
5832 * widget floating in a much larger empty space. If not set, the weight
5833 * for objects will normally be 0.0 for both axis, meaning the widget will
5834 * not be expanded. To take as much space possible, set the weight to
5835 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5837 * Besides how much space each object is allocated, it's possible to control
5838 * how the widget will be placed within that space using
5839 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5840 * for both axis, meaning the object will be centered, but any value from
5841 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5842 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5843 * is -1.0, means the object will be resized to fill the entire space it
5846 * In addition, customized functions to define the layout can be set, which
5847 * allow the application developer to organize the objects within the box
5848 * in any number of ways.
5850 * The special elm_box_layout_transition() function can be used
5851 * to switch from one layout to another, animating the motion of the
5852 * children of the box.
5854 * @note Objects should not be added to box objects using _add() calls.
5856 * Some examples on how to use boxes follow:
5857 * @li @ref box_example_01
5858 * @li @ref box_example_02
5863 * @typedef Elm_Box_Transition
5865 * Opaque handler containing the parameters to perform an animated
5866 * transition of the layout the box uses.
5868 * @see elm_box_transition_new()
5869 * @see elm_box_layout_set()
5870 * @see elm_box_layout_transition()
5872 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5875 * Add a new box to the parent
5877 * By default, the box will be in vertical mode and non-homogeneous.
5879 * @param parent The parent object
5880 * @return The new object or NULL if it cannot be created
5882 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5884 * Set the horizontal orientation
5886 * By default, box object arranges their contents vertically from top to
5888 * By calling this function with @p horizontal as EINA_TRUE, the box will
5889 * become horizontal, arranging contents from left to right.
5891 * @note This flag is ignored if a custom layout function is set.
5893 * @param obj The box object
5894 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5895 * EINA_FALSE = vertical)
5897 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5899 * Get the horizontal orientation
5901 * @param obj The box object
5902 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5904 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5906 * Set the box to arrange its children homogeneously
5908 * If enabled, homogeneous layout makes all items the same size, according
5909 * to the size of the largest of its children.
5911 * @note This flag is ignored if a custom layout function is set.
5913 * @param obj The box object
5914 * @param homogeneous The homogeneous flag
5916 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5918 * Get whether the box is using homogeneous mode or not
5920 * @param obj The box object
5921 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5923 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5924 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5925 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5927 * Add an object to the beginning of the pack list
5929 * Pack @p subobj into the box @p obj, placing it first in the list of
5930 * children objects. The actual position the object will get on screen
5931 * depends on the layout used. If no custom layout is set, it will be at
5932 * the top or left, depending if the box is vertical or horizontal,
5935 * @param obj The box object
5936 * @param subobj The object to add to the box
5938 * @see elm_box_pack_end()
5939 * @see elm_box_pack_before()
5940 * @see elm_box_pack_after()
5941 * @see elm_box_unpack()
5942 * @see elm_box_unpack_all()
5943 * @see elm_box_clear()
5945 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5947 * Add an object at the end of the pack list
5949 * Pack @p subobj into the box @p obj, placing it last in the list of
5950 * children objects. The actual position the object will get on screen
5951 * depends on the layout used. If no custom layout is set, it will be at
5952 * the bottom or right, depending if the box is vertical or horizontal,
5955 * @param obj The box object
5956 * @param subobj The object to add to the box
5958 * @see elm_box_pack_start()
5959 * @see elm_box_pack_before()
5960 * @see elm_box_pack_after()
5961 * @see elm_box_unpack()
5962 * @see elm_box_unpack_all()
5963 * @see elm_box_clear()
5965 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5967 * Adds an object to the box before the indicated object
5969 * This will add the @p subobj to the box indicated before the object
5970 * indicated with @p before. If @p before is not already in the box, results
5971 * are undefined. Before means either to the left of the indicated object or
5972 * above it depending on orientation.
5974 * @param obj The box object
5975 * @param subobj The object to add to the box
5976 * @param before The object before which to add it
5978 * @see elm_box_pack_start()
5979 * @see elm_box_pack_end()
5980 * @see elm_box_pack_after()
5981 * @see elm_box_unpack()
5982 * @see elm_box_unpack_all()
5983 * @see elm_box_clear()
5985 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5987 * Adds an object to the box after the indicated object
5989 * This will add the @p subobj to the box indicated after the object
5990 * indicated with @p after. If @p after is not already in the box, results
5991 * are undefined. After means either to the right of the indicated object or
5992 * below it depending on orientation.
5994 * @param obj The box object
5995 * @param subobj The object to add to the box
5996 * @param after The object after which to add it
5998 * @see elm_box_pack_start()
5999 * @see elm_box_pack_end()
6000 * @see elm_box_pack_before()
6001 * @see elm_box_unpack()
6002 * @see elm_box_unpack_all()
6003 * @see elm_box_clear()
6005 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6007 * Clear the box of all children
6009 * Remove all the elements contained by the box, deleting the respective
6012 * @param obj The box object
6014 * @see elm_box_unpack()
6015 * @see elm_box_unpack_all()
6017 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6021 * Remove the object given by @p subobj from the box @p obj without
6024 * @param obj The box object
6026 * @see elm_box_unpack_all()
6027 * @see elm_box_clear()
6029 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6031 * Remove all items from the box, without deleting them
6033 * Clear the box from all children, but don't delete the respective objects.
6034 * If no other references of the box children exist, the objects will never
6035 * be deleted, and thus the application will leak the memory. Make sure
6036 * when using this function that you hold a reference to all the objects
6037 * in the box @p obj.
6039 * @param obj The box object
6041 * @see elm_box_clear()
6042 * @see elm_box_unpack()
6044 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6046 * Retrieve a list of the objects packed into the box
6048 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6049 * The order of the list corresponds to the packing order the box uses.
6051 * You must free this list with eina_list_free() once you are done with it.
6053 * @param obj The box object
6055 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6057 * Set the space (padding) between the box's elements.
6059 * Extra space in pixels that will be added between a box child and its
6060 * neighbors after its containing cell has been calculated. This padding
6061 * is set for all elements in the box, besides any possible padding that
6062 * individual elements may have through their size hints.
6064 * @param obj The box object
6065 * @param horizontal The horizontal space between elements
6066 * @param vertical The vertical space between elements
6068 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6070 * Get the space (padding) between the box's elements.
6072 * @param obj The box object
6073 * @param horizontal The horizontal space between elements
6074 * @param vertical The vertical space between elements
6076 * @see elm_box_padding_set()
6078 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6080 * Set the alignment of the whole bouding box of contents.
6082 * Sets how the bounding box containing all the elements of the box, after
6083 * their sizes and position has been calculated, will be aligned within
6084 * the space given for the whole box widget.
6086 * @param obj The box object
6087 * @param horizontal The horizontal alignment of elements
6088 * @param vertical The vertical alignment of elements
6090 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6092 * Get the alignment of the whole bouding box of contents.
6094 * @param obj The box object
6095 * @param horizontal The horizontal alignment of elements
6096 * @param vertical The vertical alignment of elements
6098 * @see elm_box_align_set()
6100 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6103 * Force the box to recalculate its children packing.
6105 * If any children was added or removed, box will not calculate the
6106 * values immediately rather leaving it to the next main loop
6107 * iteration. While this is great as it would save lots of
6108 * recalculation, whenever you need to get the position of a just
6109 * added item you must force recalculate before doing so.
6111 * @param obj The box object.
6113 EAPI void elm_box_recalculate(Evas_Object *obj);
6116 * Set the layout defining function to be used by the box
6118 * Whenever anything changes that requires the box in @p obj to recalculate
6119 * the size and position of its elements, the function @p cb will be called
6120 * to determine what the layout of the children will be.
6122 * Once a custom function is set, everything about the children layout
6123 * is defined by it. The flags set by elm_box_horizontal_set() and
6124 * elm_box_homogeneous_set() no longer have any meaning, and the values
6125 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6126 * layout function to decide if they are used and how. These last two
6127 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6128 * passed to @p cb. The @c Evas_Object the function receives is not the
6129 * Elementary widget, but the internal Evas Box it uses, so none of the
6130 * functions described here can be used on it.
6132 * Any of the layout functions in @c Evas can be used here, as well as the
6133 * special elm_box_layout_transition().
6135 * The final @p data argument received by @p cb is the same @p data passed
6136 * here, and the @p free_data function will be called to free it
6137 * whenever the box is destroyed or another layout function is set.
6139 * Setting @p cb to NULL will revert back to the default layout function.
6141 * @param obj The box object
6142 * @param cb The callback function used for layout
6143 * @param data Data that will be passed to layout function
6144 * @param free_data Function called to free @p data
6146 * @see elm_box_layout_transition()
6148 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);
6150 * Special layout function that animates the transition from one layout to another
6152 * Normally, when switching the layout function for a box, this will be
6153 * reflected immediately on screen on the next render, but it's also
6154 * possible to do this through an animated transition.
6156 * This is done by creating an ::Elm_Box_Transition and setting the box
6157 * layout to this function.
6161 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6162 * evas_object_box_layout_vertical, // start
6163 * NULL, // data for initial layout
6164 * NULL, // free function for initial data
6165 * evas_object_box_layout_horizontal, // end
6166 * NULL, // data for final layout
6167 * NULL, // free function for final data
6168 * anim_end, // will be called when animation ends
6169 * NULL); // data for anim_end function\
6170 * elm_box_layout_set(box, elm_box_layout_transition, t,
6171 * elm_box_transition_free);
6174 * @note This function can only be used with elm_box_layout_set(). Calling
6175 * it directly will not have the expected results.
6177 * @see elm_box_transition_new
6178 * @see elm_box_transition_free
6179 * @see elm_box_layout_set
6181 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6183 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6185 * If you want to animate the change from one layout to another, you need
6186 * to set the layout function of the box to elm_box_layout_transition(),
6187 * passing as user data to it an instance of ::Elm_Box_Transition with the
6188 * necessary information to perform this animation. The free function to
6189 * set for the layout is elm_box_transition_free().
6191 * The parameters to create an ::Elm_Box_Transition sum up to how long
6192 * will it be, in seconds, a layout function to describe the initial point,
6193 * another for the final position of the children and one function to be
6194 * called when the whole animation ends. This last function is useful to
6195 * set the definitive layout for the box, usually the same as the end
6196 * layout for the animation, but could be used to start another transition.
6198 * @param start_layout The layout function that will be used to start the animation
6199 * @param start_layout_data The data to be passed the @p start_layout function
6200 * @param start_layout_free_data Function to free @p start_layout_data
6201 * @param end_layout The layout function that will be used to end the animation
6202 * @param end_layout_free_data The data to be passed the @p end_layout function
6203 * @param end_layout_free_data Function to free @p end_layout_data
6204 * @param transition_end_cb Callback function called when animation ends
6205 * @param transition_end_data Data to be passed to @p transition_end_cb
6206 * @return An instance of ::Elm_Box_Transition
6208 * @see elm_box_transition_new
6209 * @see elm_box_layout_transition
6211 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);
6213 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6215 * This function is mostly useful as the @c free_data parameter in
6216 * elm_box_layout_set() when elm_box_layout_transition().
6218 * @param data The Elm_Box_Transition instance to be freed.
6220 * @see elm_box_transition_new
6221 * @see elm_box_layout_transition
6223 EAPI void elm_box_transition_free(void *data);
6230 * @defgroup Button Button
6232 * @image html img/widget/button/preview-00.png
6233 * @image latex img/widget/button/preview-00.eps
6234 * @image html img/widget/button/preview-01.png
6235 * @image latex img/widget/button/preview-01.eps
6236 * @image html img/widget/button/preview-02.png
6237 * @image latex img/widget/button/preview-02.eps
6239 * This is a push-button. Press it and run some function. It can contain
6240 * a simple label and icon object and it also has an autorepeat feature.
6242 * This widgets emits the following signals:
6243 * @li "clicked": the user clicked the button (press/release).
6244 * @li "repeated": the user pressed the button without releasing it.
6245 * @li "pressed": button was pressed.
6246 * @li "unpressed": button was released after being pressed.
6247 * In all three cases, the @c event parameter of the callback will be
6250 * Also, defined in the default theme, the button has the following styles
6252 * @li default: a normal button.
6253 * @li anchor: Like default, but the button fades away when the mouse is not
6254 * over it, leaving only the text or icon.
6255 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6256 * continuous look across its options.
6257 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6259 * Default contents parts of the button widget that you can use for are:
6260 * @li "icon" - A icon of the button
6262 * Default text parts of the button widget that you can use for are:
6263 * @li "default" - Label of the button
6265 * Follow through a complete example @ref button_example_01 "here".
6271 UIControlStateDefault,
6272 UIControlStateHighlighted,
6273 UIControlStateDisabled,
6274 UIControlStateFocused,
6275 UIControlStateReserved
6279 * Add a new button to the parent's canvas
6281 * @param parent The parent object
6282 * @return The new object or NULL if it cannot be created
6284 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6286 * Set the label used in the button
6288 * The passed @p label can be NULL to clean any existing text in it and
6289 * leave the button as an icon only object.
6291 * @param obj The button object
6292 * @param label The text will be written on the button
6293 * @deprecated use elm_object_text_set() instead.
6295 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6297 * Get the label set for the button
6299 * The string returned is an internal pointer and should not be freed or
6300 * altered. It will also become invalid when the button is destroyed.
6301 * The string returned, if not NULL, is a stringshare, so if you need to
6302 * keep it around even after the button is destroyed, you can use
6303 * eina_stringshare_ref().
6305 * @param obj The button object
6306 * @return The text set to the label, or NULL if nothing is set
6307 * @deprecated use elm_object_text_set() instead.
6309 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6311 * Set the label for each state of button
6313 * The passed @p label can be NULL to clean any existing text in it and
6314 * leave the button as an icon only object for the state.
6316 * @param obj The button object
6317 * @param label The text will be written on the button
6318 * @param state The state of button
6322 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6324 * Get the label of button for each state
6326 * The string returned is an internal pointer and should not be freed or
6327 * altered. It will also become invalid when the button is destroyed.
6328 * The string returned, if not NULL, is a stringshare, so if you need to
6329 * keep it around even after the button is destroyed, you can use
6330 * eina_stringshare_ref().
6332 * @param obj The button object
6333 * @param state The state of button
6334 * @return The title of button for state
6338 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6340 * Set the icon used for the button
6342 * Setting a new icon will delete any other that was previously set, making
6343 * any reference to them invalid. If you need to maintain the previous
6344 * object alive, unset it first with elm_button_icon_unset().
6346 * @param obj The button object
6347 * @param icon The icon object for the button
6348 * @deprecated use elm_object_content_part_set() instead.
6350 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6352 * Get the icon used for the button
6354 * Return the icon object which is set for this widget. If the button is
6355 * destroyed or another icon is set, the returned object will be deleted
6356 * and any reference to it will be invalid.
6358 * @param obj The button object
6359 * @return The icon object that is being used
6361 * @deprecated use elm_object_content_part_get() instead
6363 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6365 * Remove the icon set without deleting it and return the object
6367 * This function drops the reference the button holds of the icon object
6368 * and returns this last object. It is used in case you want to remove any
6369 * icon, or set another one, without deleting the actual object. The button
6370 * will be left without an icon set.
6372 * @param obj The button object
6373 * @return The icon object that was being used
6374 * @deprecated use elm_object_content_part_unset() instead.
6376 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6378 * Turn on/off the autorepeat event generated when the button is kept pressed
6380 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6381 * signal when they are clicked.
6383 * When on, keeping a button pressed will continuously emit a @c repeated
6384 * signal until the button is released. The time it takes until it starts
6385 * emitting the signal is given by
6386 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6387 * new emission by elm_button_autorepeat_gap_timeout_set().
6389 * @param obj The button object
6390 * @param on A bool to turn on/off the event
6392 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6394 * Get whether the autorepeat feature is enabled
6396 * @param obj The button object
6397 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6399 * @see elm_button_autorepeat_set()
6401 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6403 * Set the initial timeout before the autorepeat event is generated
6405 * Sets the timeout, in seconds, since the button is pressed until the
6406 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6407 * won't be any delay and the even will be fired the moment the button is
6410 * @param obj The button object
6411 * @param t Timeout in seconds
6413 * @see elm_button_autorepeat_set()
6414 * @see elm_button_autorepeat_gap_timeout_set()
6416 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6418 * Get the initial timeout before the autorepeat event is generated
6420 * @param obj The button object
6421 * @return Timeout in seconds
6423 * @see elm_button_autorepeat_initial_timeout_set()
6425 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6427 * Set the interval between each generated autorepeat event
6429 * After the first @c repeated event is fired, all subsequent ones will
6430 * follow after a delay of @p t seconds for each.
6432 * @param obj The button object
6433 * @param t Interval in seconds
6435 * @see elm_button_autorepeat_initial_timeout_set()
6437 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6439 * Get the interval between each generated autorepeat event
6441 * @param obj The button object
6442 * @return Interval in seconds
6444 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6450 * @defgroup File_Selector_Button File Selector Button
6452 * @image html img/widget/fileselector_button/preview-00.png
6453 * @image latex img/widget/fileselector_button/preview-00.eps
6454 * @image html img/widget/fileselector_button/preview-01.png
6455 * @image latex img/widget/fileselector_button/preview-01.eps
6456 * @image html img/widget/fileselector_button/preview-02.png
6457 * @image latex img/widget/fileselector_button/preview-02.eps
6459 * This is a button that, when clicked, creates an Elementary
6460 * window (or inner window) <b> with a @ref Fileselector "file
6461 * selector widget" within</b>. When a file is chosen, the (inner)
6462 * window is closed and the button emits a signal having the
6463 * selected file as it's @c event_info.
6465 * This widget encapsulates operations on its internal file
6466 * selector on its own API. There is less control over its file
6467 * selector than that one would have instatiating one directly.
6469 * The following styles are available for this button:
6472 * @li @c "hoversel_vertical"
6473 * @li @c "hoversel_vertical_entry"
6475 * Smart callbacks one can register to:
6476 * - @c "file,chosen" - the user has selected a path, whose string
6477 * pointer comes as the @c event_info data (a stringshared
6480 * Here is an example on its usage:
6481 * @li @ref fileselector_button_example
6483 * @see @ref File_Selector_Entry for a similar widget.
6488 * Add a new file selector button widget to the given parent
6489 * Elementary (container) object
6491 * @param parent The parent object
6492 * @return a new file selector button widget handle or @c NULL, on
6495 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6498 * Set the label for a given file selector button widget
6500 * @param obj The file selector button widget
6501 * @param label The text label to be displayed on @p obj
6503 * @deprecated use elm_object_text_set() instead.
6505 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6508 * Get the label set for a given file selector button widget
6510 * @param obj The file selector button widget
6511 * @return The button label
6513 * @deprecated use elm_object_text_set() instead.
6515 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6518 * Set the icon on a given file selector button widget
6520 * @param obj The file selector button widget
6521 * @param icon The icon object for the button
6523 * Once the icon object is set, a previously set one will be
6524 * deleted. If you want to keep the latter, use the
6525 * elm_fileselector_button_icon_unset() function.
6527 * @see elm_fileselector_button_icon_get()
6529 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6532 * Get the icon set for a given file selector button widget
6534 * @param obj The file selector button widget
6535 * @return The icon object currently set on @p obj or @c NULL, if
6538 * @see elm_fileselector_button_icon_set()
6540 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6543 * Unset the icon used in a given file selector button widget
6545 * @param obj The file selector button widget
6546 * @return The icon object that was being used on @p obj or @c
6549 * Unparent and return the icon object which was set for this
6552 * @see elm_fileselector_button_icon_set()
6554 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6557 * Set the title for a given file selector button widget's window
6559 * @param obj The file selector button widget
6560 * @param title The title string
6562 * This will change the window's title, when the file selector pops
6563 * out after a click on the button. Those windows have the default
6564 * (unlocalized) value of @c "Select a file" as titles.
6566 * @note It will only take any effect if the file selector
6567 * button widget is @b not under "inwin mode".
6569 * @see elm_fileselector_button_window_title_get()
6571 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6574 * Get the title set for a given file selector button widget's
6577 * @param obj The file selector button widget
6578 * @return Title of the file selector button's window
6580 * @see elm_fileselector_button_window_title_get() for more details
6582 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6585 * Set the size of a given file selector button widget's window,
6586 * holding the file selector itself.
6588 * @param obj The file selector button widget
6589 * @param width The window's width
6590 * @param height The window's height
6592 * @note it will only take any effect if the file selector button
6593 * widget is @b not under "inwin mode". The default size for the
6594 * window (when applicable) is 400x400 pixels.
6596 * @see elm_fileselector_button_window_size_get()
6598 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6601 * Get the size of a given file selector button widget's window,
6602 * holding the file selector itself.
6604 * @param obj The file selector button widget
6605 * @param width Pointer into which to store the width value
6606 * @param height Pointer into which to store the height value
6608 * @note Use @c NULL pointers on the size values you're not
6609 * interested in: they'll be ignored by the function.
6611 * @see elm_fileselector_button_window_size_set(), for more details
6613 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6616 * Set the initial file system path for a given file selector
6619 * @param obj The file selector button widget
6620 * @param path The path string
6622 * It must be a <b>directory</b> path, which will have the contents
6623 * displayed initially in the file selector's view, when invoked
6624 * from @p obj. The default initial path is the @c "HOME"
6625 * environment variable's value.
6627 * @see elm_fileselector_button_path_get()
6629 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6632 * Get the initial file system path set for a given file selector
6635 * @param obj The file selector button widget
6636 * @return path The path string
6638 * @see elm_fileselector_button_path_set() for more details
6640 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6643 * Enable/disable a tree view in the given file selector button
6644 * widget's internal file selector
6646 * @param obj The file selector button widget
6647 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6650 * This has the same effect as elm_fileselector_expandable_set(),
6651 * but now applied to a file selector button's internal file
6654 * @note There's no way to put a file selector button's internal
6655 * file selector in "grid mode", as one may do with "pure" file
6658 * @see elm_fileselector_expandable_get()
6660 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6663 * Get whether tree view is enabled for the given file selector
6664 * button widget's internal file selector
6666 * @param obj The file selector button widget
6667 * @return @c EINA_TRUE if @p obj widget's internal file selector
6668 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6670 * @see elm_fileselector_expandable_set() for more details
6672 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6675 * Set whether a given file selector button widget's internal file
6676 * selector is to display folders only or the directory contents,
6679 * @param obj The file selector button widget
6680 * @param only @c EINA_TRUE to make @p obj widget's internal file
6681 * selector only display directories, @c EINA_FALSE to make files
6682 * to be displayed in it too
6684 * This has the same effect as elm_fileselector_folder_only_set(),
6685 * but now applied to a file selector button's internal file
6688 * @see elm_fileselector_folder_only_get()
6690 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6693 * Get whether a given file selector button widget's internal file
6694 * selector is displaying folders only or the directory contents,
6697 * @param obj The file selector button widget
6698 * @return @c EINA_TRUE if @p obj widget's internal file
6699 * selector is only displaying directories, @c EINA_FALSE if files
6700 * are being displayed in it too (and on errors)
6702 * @see elm_fileselector_button_folder_only_set() for more details
6704 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6707 * Enable/disable the file name entry box where the user can type
6708 * in a name for a file, in a given file selector button widget's
6709 * internal file selector.
6711 * @param obj The file selector button widget
6712 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6713 * file selector a "saving dialog", @c EINA_FALSE otherwise
6715 * This has the same effect as elm_fileselector_is_save_set(),
6716 * but now applied to a file selector button's internal file
6719 * @see elm_fileselector_is_save_get()
6721 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6724 * Get whether the given file selector button widget's internal
6725 * file selector is in "saving dialog" mode
6727 * @param obj The file selector button widget
6728 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6729 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6732 * @see elm_fileselector_button_is_save_set() for more details
6734 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 * Set whether a given file selector button widget's internal file
6738 * selector will raise an Elementary "inner window", instead of a
6739 * dedicated Elementary window. By default, it won't.
6741 * @param obj The file selector button widget
6742 * @param value @c EINA_TRUE to make it use an inner window, @c
6743 * EINA_TRUE to make it use a dedicated window
6745 * @see elm_win_inwin_add() for more information on inner windows
6746 * @see elm_fileselector_button_inwin_mode_get()
6748 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6751 * Get whether a given file selector button widget's internal file
6752 * selector will raise an Elementary "inner window", instead of a
6753 * dedicated Elementary window.
6755 * @param obj The file selector button widget
6756 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6757 * if it will use a dedicated window
6759 * @see elm_fileselector_button_inwin_mode_set() for more details
6761 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6768 * @defgroup File_Selector_Entry File Selector Entry
6770 * @image html img/widget/fileselector_entry/preview-00.png
6771 * @image latex img/widget/fileselector_entry/preview-00.eps
6773 * This is an entry made to be filled with or display a <b>file
6774 * system path string</b>. Besides the entry itself, the widget has
6775 * a @ref File_Selector_Button "file selector button" on its side,
6776 * which will raise an internal @ref Fileselector "file selector widget",
6777 * when clicked, for path selection aided by file system
6780 * This file selector may appear in an Elementary window or in an
6781 * inner window. When a file is chosen from it, the (inner) window
6782 * is closed and the selected file's path string is exposed both as
6783 * an smart event and as the new text on the entry.
6785 * This widget encapsulates operations on its internal file
6786 * selector on its own API. There is less control over its file
6787 * selector than that one would have instatiating one directly.
6789 * Smart callbacks one can register to:
6790 * - @c "changed" - The text within the entry was changed
6791 * - @c "activated" - The entry has had editing finished and
6792 * changes are to be "committed"
6793 * - @c "press" - The entry has been clicked
6794 * - @c "longpressed" - The entry has been clicked (and held) for a
6796 * - @c "clicked" - The entry has been clicked
6797 * - @c "clicked,double" - The entry has been double clicked
6798 * - @c "focused" - The entry has received focus
6799 * - @c "unfocused" - The entry has lost focus
6800 * - @c "selection,paste" - A paste action has occurred on the
6802 * - @c "selection,copy" - A copy action has occurred on the entry
6803 * - @c "selection,cut" - A cut action has occurred on the entry
6804 * - @c "unpressed" - The file selector entry's button was released
6805 * after being pressed.
6806 * - @c "file,chosen" - The user has selected a path via the file
6807 * selector entry's internal file selector, whose string pointer
6808 * comes as the @c event_info data (a stringshared string)
6810 * Here is an example on its usage:
6811 * @li @ref fileselector_entry_example
6813 * @see @ref File_Selector_Button for a similar widget.
6818 * Add a new file selector entry widget to the given parent
6819 * Elementary (container) object
6821 * @param parent The parent object
6822 * @return a new file selector entry widget handle or @c NULL, on
6825 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6828 * Set the label for a given file selector entry widget's button
6830 * @param obj The file selector entry widget
6831 * @param label The text label to be displayed on @p obj widget's
6834 * @deprecated use elm_object_text_set() instead.
6836 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6839 * Get the label set for a given file selector entry widget's button
6841 * @param obj The file selector entry widget
6842 * @return The widget button's label
6844 * @deprecated use elm_object_text_set() instead.
6846 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6849 * Set the icon on a given file selector entry widget's button
6851 * @param obj The file selector entry widget
6852 * @param icon The icon object for the entry's button
6854 * Once the icon object is set, a previously set one will be
6855 * deleted. If you want to keep the latter, use the
6856 * elm_fileselector_entry_button_icon_unset() function.
6858 * @see elm_fileselector_entry_button_icon_get()
6860 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6863 * Get the icon set for a given file selector entry widget's button
6865 * @param obj The file selector entry widget
6866 * @return The icon object currently set on @p obj widget's button
6867 * or @c NULL, if none is
6869 * @see elm_fileselector_entry_button_icon_set()
6871 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6874 * Unset the icon used in a given file selector entry widget's
6877 * @param obj The file selector entry widget
6878 * @return The icon object that was being used on @p obj widget's
6879 * button or @c NULL, on errors
6881 * Unparent and return the icon object which was set for this
6884 * @see elm_fileselector_entry_button_icon_set()
6886 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6889 * Set the title for a given file selector entry widget's window
6891 * @param obj The file selector entry widget
6892 * @param title The title string
6894 * This will change the window's title, when the file selector pops
6895 * out after a click on the entry's button. Those windows have the
6896 * default (unlocalized) value of @c "Select a file" as titles.
6898 * @note It will only take any effect if the file selector
6899 * entry widget is @b not under "inwin mode".
6901 * @see elm_fileselector_entry_window_title_get()
6903 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6906 * Get the title set for a given file selector entry widget's
6909 * @param obj The file selector entry widget
6910 * @return Title of the file selector entry's window
6912 * @see elm_fileselector_entry_window_title_get() for more details
6914 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6917 * Set the size of a given file selector entry widget's window,
6918 * holding the file selector itself.
6920 * @param obj The file selector entry widget
6921 * @param width The window's width
6922 * @param height The window's height
6924 * @note it will only take any effect if the file selector entry
6925 * widget is @b not under "inwin mode". The default size for the
6926 * window (when applicable) is 400x400 pixels.
6928 * @see elm_fileselector_entry_window_size_get()
6930 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6933 * Get the size of a given file selector entry widget's window,
6934 * holding the file selector itself.
6936 * @param obj The file selector entry widget
6937 * @param width Pointer into which to store the width value
6938 * @param height Pointer into which to store the height value
6940 * @note Use @c NULL pointers on the size values you're not
6941 * interested in: they'll be ignored by the function.
6943 * @see elm_fileselector_entry_window_size_set(), for more details
6945 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6948 * Set the initial file system path and the entry's path string for
6949 * a given file selector entry widget
6951 * @param obj The file selector entry widget
6952 * @param path The path string
6954 * It must be a <b>directory</b> path, which will have the contents
6955 * displayed initially in the file selector's view, when invoked
6956 * from @p obj. The default initial path is the @c "HOME"
6957 * environment variable's value.
6959 * @see elm_fileselector_entry_path_get()
6961 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6964 * Get the entry's path string for a given file selector entry
6967 * @param obj The file selector entry widget
6968 * @return path The path string
6970 * @see elm_fileselector_entry_path_set() for more details
6972 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6975 * Enable/disable a tree view in the given file selector entry
6976 * widget's internal file selector
6978 * @param obj The file selector entry widget
6979 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6982 * This has the same effect as elm_fileselector_expandable_set(),
6983 * but now applied to a file selector entry's internal file
6986 * @note There's no way to put a file selector entry's internal
6987 * file selector in "grid mode", as one may do with "pure" file
6990 * @see elm_fileselector_expandable_get()
6992 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6995 * Get whether tree view is enabled for the given file selector
6996 * entry widget's internal file selector
6998 * @param obj The file selector entry widget
6999 * @return @c EINA_TRUE if @p obj widget's internal file selector
7000 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7002 * @see elm_fileselector_expandable_set() for more details
7004 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7007 * Set whether a given file selector entry widget's internal file
7008 * selector is to display folders only or the directory contents,
7011 * @param obj The file selector entry widget
7012 * @param only @c EINA_TRUE to make @p obj widget's internal file
7013 * selector only display directories, @c EINA_FALSE to make files
7014 * to be displayed in it too
7016 * This has the same effect as elm_fileselector_folder_only_set(),
7017 * but now applied to a file selector entry's internal file
7020 * @see elm_fileselector_folder_only_get()
7022 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7025 * Get whether a given file selector entry widget's internal file
7026 * selector is displaying folders only or the directory contents,
7029 * @param obj The file selector entry widget
7030 * @return @c EINA_TRUE if @p obj widget's internal file
7031 * selector is only displaying directories, @c EINA_FALSE if files
7032 * are being displayed in it too (and on errors)
7034 * @see elm_fileselector_entry_folder_only_set() for more details
7036 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7039 * Enable/disable the file name entry box where the user can type
7040 * in a name for a file, in a given file selector entry widget's
7041 * internal file selector.
7043 * @param obj The file selector entry widget
7044 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7045 * file selector a "saving dialog", @c EINA_FALSE otherwise
7047 * This has the same effect as elm_fileselector_is_save_set(),
7048 * but now applied to a file selector entry's internal file
7051 * @see elm_fileselector_is_save_get()
7053 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7056 * Get whether the given file selector entry widget's internal
7057 * file selector is in "saving dialog" mode
7059 * @param obj The file selector entry widget
7060 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7061 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7064 * @see elm_fileselector_entry_is_save_set() for more details
7066 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7069 * Set whether a given file selector entry widget's internal file
7070 * selector will raise an Elementary "inner window", instead of a
7071 * dedicated Elementary window. By default, it won't.
7073 * @param obj The file selector entry widget
7074 * @param value @c EINA_TRUE to make it use an inner window, @c
7075 * EINA_TRUE to make it use a dedicated window
7077 * @see elm_win_inwin_add() for more information on inner windows
7078 * @see elm_fileselector_entry_inwin_mode_get()
7080 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7083 * Get whether a given file selector entry widget's internal file
7084 * selector will raise an Elementary "inner window", instead of a
7085 * dedicated Elementary window.
7087 * @param obj The file selector entry widget
7088 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7089 * if it will use a dedicated window
7091 * @see elm_fileselector_entry_inwin_mode_set() for more details
7093 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7096 * Set the initial file system path for a given file selector entry
7099 * @param obj The file selector entry widget
7100 * @param path The path string
7102 * It must be a <b>directory</b> path, which will have the contents
7103 * displayed initially in the file selector's view, when invoked
7104 * from @p obj. The default initial path is the @c "HOME"
7105 * environment variable's value.
7107 * @see elm_fileselector_entry_path_get()
7109 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7112 * Get the parent directory's path to the latest file selection on
7113 * a given filer selector entry widget
7115 * @param obj The file selector object
7116 * @return The (full) path of the directory of the last selection
7117 * on @p obj widget, a @b stringshared string
7119 * @see elm_fileselector_entry_path_set()
7121 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7128 * @defgroup Scroller Scroller
7130 * A scroller holds a single object and "scrolls it around". This means that
7131 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7132 * region around, allowing to move through a much larger object that is
7133 * contained in the scroller. The scroller will always have a small minimum
7134 * size by default as it won't be limited by the contents of the scroller.
7136 * Signals that you can add callbacks for are:
7137 * @li "edge,left" - the left edge of the content has been reached
7138 * @li "edge,right" - the right edge of the content has been reached
7139 * @li "edge,top" - the top edge of the content has been reached
7140 * @li "edge,bottom" - the bottom edge of the content has been reached
7141 * @li "scroll" - the content has been scrolled (moved)
7142 * @li "scroll,anim,start" - scrolling animation has started
7143 * @li "scroll,anim,stop" - scrolling animation has stopped
7144 * @li "scroll,drag,start" - dragging the contents around has started
7145 * @li "scroll,drag,stop" - dragging the contents around has stopped
7146 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7149 * @note When Elemementary is in embedded mode the scrollbars will not be
7150 * dragable, they appear merely as indicators of how much has been scrolled.
7151 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7152 * fingerscroll) won't work.
7154 * Default contents parts of the scroller widget that you can use for are:
7155 * @li "default" - A content of the scroller
7157 * In @ref tutorial_scroller you'll find an example of how to use most of
7162 * @brief Type that controls when scrollbars should appear.
7164 * @see elm_scroller_policy_set()
7166 typedef enum _Elm_Scroller_Policy
7168 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7169 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7170 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7171 ELM_SCROLLER_POLICY_LAST
7172 } Elm_Scroller_Policy;
7174 * @brief Add a new scroller to the parent
7176 * @param parent The parent object
7177 * @return The new object or NULL if it cannot be created
7179 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7181 * @brief Set the content of the scroller widget (the object to be scrolled around).
7183 * @param obj The scroller object
7184 * @param content The new content object
7186 * Once the content object is set, a previously set one will be deleted.
7187 * If you want to keep that old content object, use the
7188 * elm_scroller_content_unset() function.
7189 * @deprecated use elm_object_content_set() instead
7191 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7193 * @brief Get the content of the scroller widget
7195 * @param obj The slider object
7196 * @return The content that is being used
7198 * Return the content object which is set for this widget
7200 * @see elm_scroller_content_set()
7201 * @deprecated use elm_object_content_get() instead.
7203 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7205 * @brief Unset the content of the scroller widget
7207 * @param obj The slider object
7208 * @return The content that was being used
7210 * Unparent and return the content object which was set for this widget
7212 * @see elm_scroller_content_set()
7213 * @deprecated use elm_object_content_unset() instead.
7215 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7217 * @brief Set custom theme elements for the scroller
7219 * @param obj The scroller object
7220 * @param widget The widget name to use (default is "scroller")
7221 * @param base The base name to use (default is "base")
7223 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7225 * @brief Make the scroller minimum size limited to the minimum size of the content
7227 * @param obj The scroller object
7228 * @param w Enable limiting minimum size horizontally
7229 * @param h Enable limiting minimum size vertically
7231 * By default the scroller will be as small as its design allows,
7232 * irrespective of its content. This will make the scroller minimum size the
7233 * right size horizontally and/or vertically to perfectly fit its content in
7236 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7238 * @brief Show a specific virtual region within the scroller content object
7240 * @param obj The scroller object
7241 * @param x X coordinate of the region
7242 * @param y Y coordinate of the region
7243 * @param w Width of the region
7244 * @param h Height of the region
7246 * This will ensure all (or part if it does not fit) of the designated
7247 * region in the virtual content object (0, 0 starting at the top-left of the
7248 * virtual content object) is shown within the scroller.
7250 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);
7252 * @brief Set the scrollbar visibility policy
7254 * @param obj The scroller object
7255 * @param policy_h Horizontal scrollbar policy
7256 * @param policy_v Vertical scrollbar policy
7258 * This sets the scrollbar visibility policy for the given scroller.
7259 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7260 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7261 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7262 * respectively for the horizontal and vertical scrollbars.
7264 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7266 * @brief Gets scrollbar visibility policy
7268 * @param obj The scroller object
7269 * @param policy_h Horizontal scrollbar policy
7270 * @param policy_v Vertical scrollbar policy
7272 * @see elm_scroller_policy_set()
7274 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7276 * @brief Get the currently visible content region
7278 * @param obj The scroller object
7279 * @param x X coordinate of the region
7280 * @param y Y coordinate of the region
7281 * @param w Width of the region
7282 * @param h Height of the region
7284 * This gets the current region in the content object that is visible through
7285 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7286 * w, @p h values pointed to.
7288 * @note All coordinates are relative to the content.
7290 * @see elm_scroller_region_show()
7292 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);
7294 * @brief Get the size of the content object
7296 * @param obj The scroller object
7297 * @param w Width of the content object.
7298 * @param h Height of the content object.
7300 * This gets the size of the content object of the scroller.
7302 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7304 * @brief Set bouncing behavior
7306 * @param obj The scroller object
7307 * @param h_bounce Allow bounce horizontally
7308 * @param v_bounce Allow bounce vertically
7310 * When scrolling, the scroller may "bounce" when reaching an edge of the
7311 * content object. This is a visual way to indicate the end has been reached.
7312 * This is enabled by default for both axis. This API will set if it is enabled
7313 * for the given axis with the boolean parameters for each axis.
7315 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7317 * @brief Get the bounce behaviour
7319 * @param obj The Scroller object
7320 * @param h_bounce Will the scroller bounce horizontally or not
7321 * @param v_bounce Will the scroller bounce vertically or not
7323 * @see elm_scroller_bounce_set()
7325 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7327 * @brief Set scroll page size relative to viewport size.
7329 * @param obj The scroller object
7330 * @param h_pagerel The horizontal page relative size
7331 * @param v_pagerel The vertical page relative size
7333 * The scroller is capable of limiting scrolling by the user to "pages". That
7334 * is to jump by and only show a "whole page" at a time as if the continuous
7335 * area of the scroller content is split into page sized pieces. This sets
7336 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7337 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7338 * axis. This is mutually exclusive with page size
7339 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7340 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7341 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7344 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7346 * @brief Set scroll page size.
7348 * @param obj The scroller object
7349 * @param h_pagesize The horizontal page size
7350 * @param v_pagesize The vertical page size
7352 * This sets the page size to an absolute fixed value, with 0 turning it off
7355 * @see elm_scroller_page_relative_set()
7357 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7359 * @brief Get scroll current page number.
7361 * @param obj The scroller object
7362 * @param h_pagenumber The horizontal page number
7363 * @param v_pagenumber The vertical page number
7365 * The page number starts from 0. 0 is the first page.
7366 * Current page means the page which meets the top-left of the viewport.
7367 * If there are two or more pages in the viewport, it returns the number of the page
7368 * which meets the top-left of the viewport.
7370 * @see elm_scroller_last_page_get()
7371 * @see elm_scroller_page_show()
7372 * @see elm_scroller_page_brint_in()
7374 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7376 * @brief Get scroll last page number.
7378 * @param obj The scroller object
7379 * @param h_pagenumber The horizontal page number
7380 * @param v_pagenumber The vertical page number
7382 * The page number starts from 0. 0 is the first page.
7383 * This returns the last page number among the pages.
7385 * @see elm_scroller_current_page_get()
7386 * @see elm_scroller_page_show()
7387 * @see elm_scroller_page_brint_in()
7389 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7391 * Show a specific virtual region within the scroller content object by page number.
7393 * @param obj The scroller object
7394 * @param h_pagenumber The horizontal page number
7395 * @param v_pagenumber The vertical page number
7397 * 0, 0 of the indicated page is located at the top-left of the viewport.
7398 * This will jump to the page directly without animation.
7403 * sc = elm_scroller_add(win);
7404 * elm_scroller_content_set(sc, content);
7405 * elm_scroller_page_relative_set(sc, 1, 0);
7406 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7407 * elm_scroller_page_show(sc, h_page + 1, v_page);
7410 * @see elm_scroller_page_bring_in()
7412 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7414 * Show a specific virtual region within the scroller content object by page number.
7416 * @param obj The scroller object
7417 * @param h_pagenumber The horizontal page number
7418 * @param v_pagenumber The vertical page number
7420 * 0, 0 of the indicated page is located at the top-left of the viewport.
7421 * This will slide to the page with animation.
7426 * sc = elm_scroller_add(win);
7427 * elm_scroller_content_set(sc, content);
7428 * elm_scroller_page_relative_set(sc, 1, 0);
7429 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7430 * elm_scroller_page_bring_in(sc, h_page, v_page);
7433 * @see elm_scroller_page_show()
7435 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7437 * @brief Show a specific virtual region within the scroller content object.
7439 * @param obj The scroller object
7440 * @param x X coordinate of the region
7441 * @param y Y coordinate of the region
7442 * @param w Width of the region
7443 * @param h Height of the region
7445 * This will ensure all (or part if it does not fit) of the designated
7446 * region in the virtual content object (0, 0 starting at the top-left of the
7447 * virtual content object) is shown within the scroller. Unlike
7448 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7449 * to this location (if configuration in general calls for transitions). It
7450 * may not jump immediately to the new location and make take a while and
7451 * show other content along the way.
7453 * @see elm_scroller_region_show()
7455 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);
7457 * @brief Set event propagation on a scroller
7459 * @param obj The scroller object
7460 * @param propagation If propagation is enabled or not
7462 * This enables or disabled event propagation from the scroller content to
7463 * the scroller and its parent. By default event propagation is disabled.
7465 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7467 * @brief Get event propagation for a scroller
7469 * @param obj The scroller object
7470 * @return The propagation state
7472 * This gets the event propagation for a scroller.
7474 * @see elm_scroller_propagate_events_set()
7476 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7478 * @brief Set scrolling gravity on a scroller
7480 * @param obj The scroller object
7481 * @param x The scrolling horizontal gravity
7482 * @param y The scrolling vertical gravity
7484 * The gravity, defines how the scroller will adjust its view
7485 * when the size of the scroller contents increase.
7487 * The scroller will adjust the view to glue itself as follows.
7489 * x=0.0, for showing the left most region of the content.
7490 * x=1.0, for showing the right most region of the content.
7491 * y=0.0, for showing the bottom most region of the content.
7492 * y=1.0, for showing the top most region of the content.
7494 * Default values for x and y are 0.0
7496 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7498 * @brief Get scrolling gravity values for a scroller
7500 * @param obj The scroller object
7501 * @param x The scrolling horizontal gravity
7502 * @param y The scrolling vertical gravity
7504 * This gets gravity values for a scroller.
7506 * @see elm_scroller_gravity_set()
7509 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7515 * @defgroup Label Label
7517 * @image html img/widget/label/preview-00.png
7518 * @image latex img/widget/label/preview-00.eps
7520 * @brief Widget to display text, with simple html-like markup.
7522 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7523 * text doesn't fit the geometry of the label it will be ellipsized or be
7524 * cut. Elementary provides several themes for this widget:
7525 * @li default - No animation
7526 * @li marker - Centers the text in the label and make it bold by default
7527 * @li slide_long - The entire text appears from the right of the screen and
7528 * slides until it disappears in the left of the screen(reappering on the
7530 * @li slide_short - The text appears in the left of the label and slides to
7531 * the right to show the overflow. When all of the text has been shown the
7532 * position is reset.
7533 * @li slide_bounce - The text appears in the left of the label and slides to
7534 * the right to show the overflow. When all of the text has been shown the
7535 * animation reverses, moving the text to the left.
7537 * Custom themes can of course invent new markup tags and style them any way
7540 * The following signals may be emitted by the label widget:
7541 * @li "language,changed": The program's language changed.
7543 * See @ref tutorial_label for a demonstration of how to use a label widget.
7547 * @brief Add a new label to the parent
7549 * @param parent The parent object
7550 * @return The new object or NULL if it cannot be created
7552 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7554 * @brief Set the label on the label object
7556 * @param obj The label object
7557 * @param label The label will be used on the label object
7558 * @deprecated See elm_object_text_set()
7560 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 */
7562 * @brief Get the label used on the label object
7564 * @param obj The label object
7565 * @return The string inside the label
7566 * @deprecated See elm_object_text_get()
7568 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7570 * @brief Set the wrapping behavior of the label
7572 * @param obj The label object
7573 * @param wrap To wrap text or not
7575 * By default no wrapping is done. Possible values for @p wrap are:
7576 * @li ELM_WRAP_NONE - No wrapping
7577 * @li ELM_WRAP_CHAR - wrap between characters
7578 * @li ELM_WRAP_WORD - wrap between words
7579 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7581 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7583 * @brief Get the wrapping behavior of the label
7585 * @param obj The label object
7588 * @see elm_label_line_wrap_set()
7590 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7592 * @brief Set wrap width of the label
7594 * @param obj The label object
7595 * @param w The wrap width in pixels at a minimum where words need to wrap
7597 * This function sets the maximum width size hint of the label.
7599 * @warning This is only relevant if the label is inside a container.
7601 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7603 * @brief Get wrap width of the label
7605 * @param obj The label object
7606 * @return The wrap width in pixels at a minimum where words need to wrap
7608 * @see elm_label_wrap_width_set()
7610 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7612 * @brief Set wrap height of the label
7614 * @param obj The label object
7615 * @param h The wrap height in pixels at a minimum where words need to wrap
7617 * This function sets the maximum height size hint of the label.
7619 * @warning This is only relevant if the label is inside a container.
7621 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7623 * @brief get wrap width of the label
7625 * @param obj The label object
7626 * @return The wrap height in pixels at a minimum where words need to wrap
7628 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7630 * @brief Set the font size on the label object.
7632 * @param obj The label object
7633 * @param size font size
7635 * @warning NEVER use this. It is for hyper-special cases only. use styles
7636 * instead. e.g. "big", "medium", "small" - or better name them by use:
7637 * "title", "footnote", "quote" etc.
7639 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7641 * @brief Set the text color on the label object
7643 * @param obj The label object
7644 * @param r Red property background color of The label object
7645 * @param g Green property background color of The label object
7646 * @param b Blue property background color of The label object
7647 * @param a Alpha property background color of The label object
7649 * @warning NEVER use this. It is for hyper-special cases only. use styles
7650 * instead. e.g. "big", "medium", "small" - or better name them by use:
7651 * "title", "footnote", "quote" etc.
7653 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);
7655 * @brief Set the text align on the label object
7657 * @param obj The label object
7658 * @param align align mode ("left", "center", "right")
7660 * @warning NEVER use this. It is for hyper-special cases only. use styles
7661 * instead. e.g. "big", "medium", "small" - or better name them by use:
7662 * "title", "footnote", "quote" etc.
7664 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7666 * @brief Set background color of the label
7668 * @param obj The label object
7669 * @param r Red property background color of The label object
7670 * @param g Green property background color of The label object
7671 * @param b Blue property background color of The label object
7672 * @param a Alpha property background alpha of The label object
7674 * @warning NEVER use this. It is for hyper-special cases only. use styles
7675 * instead. e.g. "big", "medium", "small" - or better name them by use:
7676 * "title", "footnote", "quote" etc.
7678 EAPI void elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7680 * @brief Set the ellipsis behavior of the label
7682 * @param obj The label object
7683 * @param ellipsis To ellipsis text or not
7685 * If set to true and the text doesn't fit in the label an ellipsis("...")
7686 * will be shown at the end of the widget.
7688 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7689 * choosen wrap method was ELM_WRAP_WORD.
7691 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7692 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7694 * @brief Set the text slide of the label
7696 * @param obj The label object
7697 * @param slide To start slide or stop
7699 * If set to true, the text of the label will slide/scroll through the length of
7702 * @warning This only works with the themes "slide_short", "slide_long" and
7705 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7707 * @brief Get the text slide mode of the label
7709 * @param obj The label object
7710 * @return slide slide mode value
7712 * @see elm_label_slide_set()
7714 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7716 * @brief Set the slide duration(speed) of the label
7718 * @param obj The label object
7719 * @return The duration in seconds in moving text from slide begin position
7720 * to slide end position
7722 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7724 * @brief Get the slide duration(speed) of the label
7726 * @param obj The label object
7727 * @return The duration time in moving text from slide begin position to slide end position
7729 * @see elm_label_slide_duration_set()
7731 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7737 * @defgroup Frame Frame
7739 * @image html img/widget/frame/preview-00.png
7740 * @image latex img/widget/frame/preview-00.eps
7742 * @brief Frame is a widget that holds some content and has a title.
7744 * The default look is a frame with a title, but Frame supports multple
7752 * @li outdent_bottom
7754 * Of all this styles only default shows the title. Frame emits no signals.
7756 * Default contents parts of the frame widget that you can use for are:
7757 * @li "default" - A content of the frame
7759 * Default text parts of the frame widget that you can use for are:
7760 * @li "elm.text" - Label of the frame
7762 * For a detailed example see the @ref tutorial_frame.
7767 * @brief Add a new frame to the parent
7769 * @param parent The parent object
7770 * @return The new object or NULL if it cannot be created
7772 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7774 * @brief Set the frame label
7776 * @param obj The frame object
7777 * @param label The label of this frame object
7779 * @deprecated use elm_object_text_set() instead.
7781 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7783 * @brief Get the frame label
7785 * @param obj The frame object
7787 * @return The label of this frame objet or NULL if unable to get frame
7789 * @deprecated use elm_object_text_get() instead.
7791 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7793 * @brief Set the content of the frame widget
7795 * Once the content object is set, a previously set one will be deleted.
7796 * If you want to keep that old content object, use the
7797 * elm_frame_content_unset() function.
7799 * @param obj The frame object
7800 * @param content The content will be filled in this frame object
7802 * @deprecated use elm_object_content_set() instead.
7804 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7806 * @brief Get the content of the frame widget
7808 * Return the content object which is set for this widget
7810 * @param obj The frame object
7811 * @return The content that is being used
7813 * @deprecated use elm_object_content_get() instead.
7815 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7817 * @brief Unset the content of the frame widget
7819 * Unparent and return the content object which was set for this widget
7821 * @param obj The frame object
7822 * @return The content that was being used
7824 * @deprecated use elm_object_content_unset() instead.
7826 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7832 * @defgroup Table Table
7834 * A container widget to arrange other widgets in a table where items can
7835 * also span multiple columns or rows - even overlap (and then be raised or
7836 * lowered accordingly to adjust stacking if they do overlap).
7838 * For a Table widget the row/column count is not fixed.
7839 * The table widget adjusts itself when subobjects are added to it dynamically.
7841 * The followin are examples of how to use a table:
7842 * @li @ref tutorial_table_01
7843 * @li @ref tutorial_table_02
7848 * @brief Add a new table to the parent
7850 * @param parent The parent object
7851 * @return The new object or NULL if it cannot be created
7853 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7855 * @brief Set the homogeneous layout in the table
7857 * @param obj The layout object
7858 * @param homogeneous A boolean to set if the layout is homogeneous in the
7859 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7861 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7863 * @brief Get the current table homogeneous mode.
7865 * @param obj The table object
7866 * @return A boolean to indicating if the layout is homogeneous in the table
7867 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7869 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7871 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7873 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7875 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7877 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7879 * @brief Set padding between cells.
7881 * @param obj The layout object.
7882 * @param horizontal set the horizontal padding.
7883 * @param vertical set the vertical padding.
7885 * Default value is 0.
7887 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7889 * @brief Get padding between cells.
7891 * @param obj The layout object.
7892 * @param horizontal set the horizontal padding.
7893 * @param vertical set the vertical padding.
7895 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7897 * @brief Add a subobject on the table with the coordinates passed
7899 * @param obj The table object
7900 * @param subobj The subobject to be added to the table
7901 * @param x Row number
7902 * @param y Column number
7906 * @note All positioning inside the table is relative to rows and columns, so
7907 * a value of 0 for x and y, means the top left cell of the table, and a
7908 * value of 1 for w and h means @p subobj only takes that 1 cell.
7910 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7912 * @brief Remove child from table.
7914 * @param obj The table object
7915 * @param subobj The subobject
7917 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7919 * @brief Faster way to remove all child objects from a table object.
7921 * @param obj The table object
7922 * @param clear If true, will delete children, else just remove from table.
7924 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7926 * @brief Set the packing location of an existing child of the table
7928 * @param subobj The subobject to be modified in the table
7929 * @param x Row number
7930 * @param y Column number
7934 * Modifies the position of an object already in the table.
7936 * @note All positioning inside the table is relative to rows and columns, so
7937 * a value of 0 for x and y, means the top left cell of the table, and a
7938 * value of 1 for w and h means @p subobj only takes that 1 cell.
7940 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7942 * @brief Get the packing location of an existing child of the table
7944 * @param subobj The subobject to be modified in the table
7945 * @param x Row number
7946 * @param y Column number
7950 * @see elm_table_pack_set()
7952 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7958 * @defgroup Gengrid Gengrid (Generic grid)
7960 * This widget aims to position objects in a grid layout while
7961 * actually creating and rendering only the visible ones, using the
7962 * same idea as the @ref Genlist "genlist": the user defines a @b
7963 * class for each item, specifying functions that will be called at
7964 * object creation, deletion, etc. When those items are selected by
7965 * the user, a callback function is issued. Users may interact with
7966 * a gengrid via the mouse (by clicking on items to select them and
7967 * clicking on the grid's viewport and swiping to pan the whole
7968 * view) or via the keyboard, navigating through item with the
7971 * @section Gengrid_Layouts Gengrid layouts
7973 * Gengrid may layout its items in one of two possible layouts:
7977 * When in "horizontal mode", items will be placed in @b columns,
7978 * from top to bottom and, when the space for a column is filled,
7979 * another one is started on the right, thus expanding the grid
7980 * horizontally, making for horizontal scrolling. When in "vertical
7981 * mode" , though, items will be placed in @b rows, from left to
7982 * right and, when the space for a row is filled, another one is
7983 * started below, thus expanding the grid vertically (and making
7984 * for vertical scrolling).
7986 * @section Gengrid_Items Gengrid items
7988 * An item in a gengrid can have 0 or more text labels (they can be
7989 * regular text or textblock Evas objects - that's up to the style
7990 * to determine), 0 or more icons (which are simply objects
7991 * swallowed into the gengrid item's theming Edje object) and 0 or
7992 * more <b>boolean states</b>, which have the behavior left to the
7993 * user to define. The Edje part names for each of these properties
7994 * will be looked up, in the theme file for the gengrid, under the
7995 * Edje (string) data items named @c "labels", @c "icons" and @c
7996 * "states", respectively. For each of those properties, if more
7997 * than one part is provided, they must have names listed separated
7998 * by spaces in the data fields. For the default gengrid item
7999 * theme, we have @b one label part (@c "elm.text"), @b two icon
8000 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8003 * A gengrid item may be at one of several styles. Elementary
8004 * provides one by default - "default", but this can be extended by
8005 * system or application custom themes/overlays/extensions (see
8006 * @ref Theme "themes" for more details).
8008 * @section Gengrid_Item_Class Gengrid item classes
8010 * In order to have the ability to add and delete items on the fly,
8011 * gengrid implements a class (callback) system where the
8012 * application provides a structure with information about that
8013 * type of item (gengrid may contain multiple different items with
8014 * different classes, states and styles). Gengrid will call the
8015 * functions in this struct (methods) when an item is "realized"
8016 * (i.e., created dynamically, while the user is scrolling the
8017 * grid). All objects will simply be deleted when no longer needed
8018 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8019 * contains the following members:
8020 * - @c item_style - This is a constant string and simply defines
8021 * the name of the item style. It @b must be specified and the
8022 * default should be @c "default".
8023 * - @c func.label_get - This function is called when an item
8024 * object is actually created. The @c data parameter will point to
8025 * the same data passed to elm_gengrid_item_append() and related
8026 * item creation functions. The @c obj parameter is the gengrid
8027 * object itself, while the @c part one is the name string of one
8028 * of the existing text parts in the Edje group implementing the
8029 * item's theme. This function @b must return a strdup'()ed string,
8030 * as the caller will free() it when done. See
8031 * #Elm_Gengrid_Item_Label_Get_Cb.
8032 * - @c func.content_get - This function is called when an item object
8033 * is actually created. The @c data parameter will point to the
8034 * same data passed to elm_gengrid_item_append() and related item
8035 * creation functions. The @c obj parameter is the gengrid object
8036 * itself, while the @c part one is the name string of one of the
8037 * existing (content) swallow parts in the Edje group implementing the
8038 * item's theme. It must return @c NULL, when no content is desired,
8039 * or a valid object handle, otherwise. The object will be deleted
8040 * by the gengrid on its deletion or when the item is "unrealized".
8041 * See #Elm_Gengrid_Item_Content_Get_Cb.
8042 * - @c func.state_get - This function is called when an item
8043 * object is actually created. The @c data parameter will point to
8044 * the same data passed to elm_gengrid_item_append() and related
8045 * item creation functions. The @c obj parameter is the gengrid
8046 * object itself, while the @c part one is the name string of one
8047 * of the state parts in the Edje group implementing the item's
8048 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8049 * true/on. Gengrids will emit a signal to its theming Edje object
8050 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8051 * "source" arguments, respectively, when the state is true (the
8052 * default is false), where @c XXX is the name of the (state) part.
8053 * See #Elm_Gengrid_Item_State_Get_Cb.
8054 * - @c func.del - This is called when elm_gengrid_item_del() is
8055 * called on an item or elm_gengrid_clear() is called on the
8056 * gengrid. This is intended for use when gengrid items are
8057 * deleted, so any data attached to the item (e.g. its data
8058 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8060 * @section Gengrid_Usage_Hints Usage hints
8062 * If the user wants to have multiple items selected at the same
8063 * time, elm_gengrid_multi_select_set() will permit it. If the
8064 * gengrid is single-selection only (the default), then
8065 * elm_gengrid_select_item_get() will return the selected item or
8066 * @c NULL, if none is selected. If the gengrid is under
8067 * multi-selection, then elm_gengrid_selected_items_get() will
8068 * return a list (that is only valid as long as no items are
8069 * modified (added, deleted, selected or unselected) of child items
8072 * If an item changes (internal (boolean) state, label or content
8073 * changes), then use elm_gengrid_item_update() to have gengrid
8074 * update the item with the new state. A gengrid will re-"realize"
8075 * the item, thus calling the functions in the
8076 * #Elm_Gengrid_Item_Class set for that item.
8078 * To programmatically (un)select an item, use
8079 * elm_gengrid_item_selected_set(). To get its selected state use
8080 * elm_gengrid_item_selected_get(). To make an item disabled
8081 * (unable to be selected and appear differently) use
8082 * elm_gengrid_item_disabled_set() to set this and
8083 * elm_gengrid_item_disabled_get() to get the disabled state.
8085 * Grid cells will only have their selection smart callbacks called
8086 * when firstly getting selected. Any further clicks will do
8087 * nothing, unless you enable the "always select mode", with
8088 * elm_gengrid_always_select_mode_set(), thus making every click to
8089 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8090 * turn off the ability to select items entirely in the widget and
8091 * they will neither appear selected nor call the selection smart
8094 * Remember that you can create new styles and add your own theme
8095 * augmentation per application with elm_theme_extension_add(). If
8096 * you absolutely must have a specific style that overrides any
8097 * theme the user or system sets up you can use
8098 * elm_theme_overlay_add() to add such a file.
8100 * @section Gengrid_Smart_Events Gengrid smart events
8102 * Smart events that you can add callbacks for are:
8103 * - @c "activated" - The user has double-clicked or pressed
8104 * (enter|return|spacebar) on an item. The @c event_info parameter
8105 * is the gengrid item that was activated.
8106 * - @c "clicked,double" - The user has double-clicked an item.
8107 * The @c event_info parameter is the gengrid item that was double-clicked.
8108 * - @c "longpressed" - This is called when the item is pressed for a certain
8109 * amount of time. By default it's 1 second.
8110 * - @c "selected" - The user has made an item selected. The
8111 * @c event_info parameter is the gengrid item that was selected.
8112 * - @c "unselected" - The user has made an item unselected. The
8113 * @c event_info parameter is the gengrid item that was unselected.
8114 * - @c "realized" - This is called when the item in the gengrid
8115 * has its implementing Evas object instantiated, de facto. @c
8116 * event_info is the gengrid item that was created. The object
8117 * may be deleted at any time, so it is highly advised to the
8118 * caller @b not to use the object pointer returned from
8119 * elm_gengrid_item_object_get(), because it may point to freed
8121 * - @c "unrealized" - This is called when the implementing Evas
8122 * object for this item is deleted. @c event_info is the gengrid
8123 * item that was deleted.
8124 * - @c "changed" - Called when an item is added, removed, resized
8125 * or moved and when the gengrid is resized or gets "horizontal"
8127 * - @c "scroll,anim,start" - This is called when scrolling animation has
8129 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8131 * - @c "drag,start,up" - Called when the item in the gengrid has
8132 * been dragged (not scrolled) up.
8133 * - @c "drag,start,down" - Called when the item in the gengrid has
8134 * been dragged (not scrolled) down.
8135 * - @c "drag,start,left" - Called when the item in the gengrid has
8136 * been dragged (not scrolled) left.
8137 * - @c "drag,start,right" - Called when the item in the gengrid has
8138 * been dragged (not scrolled) right.
8139 * - @c "drag,stop" - Called when the item in the gengrid has
8140 * stopped being dragged.
8141 * - @c "drag" - Called when the item in the gengrid is being
8143 * - @c "scroll" - called when the content has been scrolled
8145 * - @c "scroll,drag,start" - called when dragging the content has
8147 * - @c "scroll,drag,stop" - called when dragging the content has
8149 * - @c "edge,top" - This is called when the gengrid is scrolled until
8151 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8152 * until the bottom edge.
8153 * - @c "edge,left" - This is called when the gengrid is scrolled
8154 * until the left edge.
8155 * - @c "edge,right" - This is called when the gengrid is scrolled
8156 * until the right edge.
8158 * List of gengrid examples:
8159 * @li @ref gengrid_example
8163 * @addtogroup Gengrid
8167 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8168 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8169 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8170 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8171 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8172 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. */
8173 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8175 /* temporary compatibility code */
8176 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8177 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8178 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8179 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8182 * @struct _Elm_Gengrid_Item_Class
8184 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8187 struct _Elm_Gengrid_Item_Class
8189 const char *item_style;
8190 struct _Elm_Gengrid_Item_Class_Func
8192 Elm_Gengrid_Item_Label_Get_Cb label_get;
8193 union { /* temporary compatibility code */
8194 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8195 Elm_Gengrid_Item_Content_Get_Cb content_get;
8197 Elm_Gengrid_Item_State_Get_Cb state_get;
8198 Elm_Gengrid_Item_Del_Cb del;
8200 }; /**< #Elm_Gengrid_Item_Class member definitions */
8202 * Add a new gengrid widget to the given parent Elementary
8203 * (container) object
8205 * @param parent The parent object
8206 * @return a new gengrid widget handle or @c NULL, on errors
8208 * This function inserts a new gengrid widget on the canvas.
8210 * @see elm_gengrid_item_size_set()
8211 * @see elm_gengrid_group_item_size_set()
8212 * @see elm_gengrid_horizontal_set()
8213 * @see elm_gengrid_item_append()
8214 * @see elm_gengrid_item_del()
8215 * @see elm_gengrid_clear()
8219 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8222 * Set the size for the items of a given gengrid widget
8224 * @param obj The gengrid object.
8225 * @param w The items' width.
8226 * @param h The items' height;
8228 * A gengrid, after creation, has still no information on the size
8229 * to give to each of its cells. So, you most probably will end up
8230 * with squares one @ref Fingers "finger" wide, the default
8231 * size. Use this function to force a custom size for you items,
8232 * making them as big as you wish.
8234 * @see elm_gengrid_item_size_get()
8238 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8241 * Get the size set for the items of a given gengrid widget
8243 * @param obj The gengrid object.
8244 * @param w Pointer to a variable where to store the items' width.
8245 * @param h Pointer to a variable where to store the items' height.
8247 * @note Use @c NULL pointers on the size values you're not
8248 * interested in: they'll be ignored by the function.
8250 * @see elm_gengrid_item_size_get() for more details
8254 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8257 * Set the items grid's alignment within a given gengrid widget
8259 * @param obj The gengrid object.
8260 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8261 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8263 * This sets the alignment of the whole grid of items of a gengrid
8264 * within its given viewport. By default, those values are both
8265 * 0.5, meaning that the gengrid will have its items grid placed
8266 * exactly in the middle of its viewport.
8268 * @note If given alignment values are out of the cited ranges,
8269 * they'll be changed to the nearest boundary values on the valid
8272 * @see elm_gengrid_align_get()
8276 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8279 * Get the items grid's alignment values within a given gengrid
8282 * @param obj The gengrid object.
8283 * @param align_x Pointer to a variable where to store the
8284 * horizontal alignment.
8285 * @param align_y Pointer to a variable where to store the vertical
8288 * @note Use @c NULL pointers on the alignment values you're not
8289 * interested in: they'll be ignored by the function.
8291 * @see elm_gengrid_align_set() for more details
8295 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8298 * Set whether a given gengrid widget is or not able have items
8301 * @param obj The gengrid object
8302 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8303 * @c EINA_FALSE to turn it off
8305 * If a gengrid is set to allow reordering, a click held for more
8306 * than 0.5 over a given item will highlight it specially,
8307 * signalling the gengrid has entered the reordering state. From
8308 * that time on, the user will be able to, while still holding the
8309 * mouse button down, move the item freely in the gengrid's
8310 * viewport, replacing to said item to the locations it goes to.
8311 * The replacements will be animated and, whenever the user
8312 * releases the mouse button, the item being replaced gets a new
8313 * definitive place in the grid.
8315 * @see elm_gengrid_reorder_mode_get()
8319 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8322 * Get whether a given gengrid widget is or not able have items
8325 * @param obj The gengrid object
8326 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8329 * @see elm_gengrid_reorder_mode_set() for more details
8333 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8336 * Append a new item in a given gengrid widget.
8338 * @param obj The gengrid object.
8339 * @param gic The item class for the item.
8340 * @param data The item data.
8341 * @param func Convenience function called when the item is
8343 * @param func_data Data to be passed to @p func.
8344 * @return A handle to the item added or @c NULL, on errors.
8346 * This adds an item to the beginning of the gengrid.
8348 * @see elm_gengrid_item_prepend()
8349 * @see elm_gengrid_item_insert_before()
8350 * @see elm_gengrid_item_insert_after()
8351 * @see elm_gengrid_item_del()
8355 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);
8358 * Prepend a new item in a given gengrid widget.
8360 * @param obj The gengrid object.
8361 * @param gic The item class for the item.
8362 * @param data The item data.
8363 * @param func Convenience function called when the item is
8365 * @param func_data Data to be passed to @p func.
8366 * @return A handle to the item added or @c NULL, on errors.
8368 * This adds an item to the end of the gengrid.
8370 * @see elm_gengrid_item_append()
8371 * @see elm_gengrid_item_insert_before()
8372 * @see elm_gengrid_item_insert_after()
8373 * @see elm_gengrid_item_del()
8377 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);
8380 * Insert an item before another in a gengrid widget
8382 * @param obj The gengrid object.
8383 * @param gic The item class for the item.
8384 * @param data The item data.
8385 * @param relative The item to place this new one before.
8386 * @param func Convenience function called when the item is
8388 * @param func_data Data to be passed to @p func.
8389 * @return A handle to the item added or @c NULL, on errors.
8391 * This inserts an item before another in the gengrid.
8393 * @see elm_gengrid_item_append()
8394 * @see elm_gengrid_item_prepend()
8395 * @see elm_gengrid_item_insert_after()
8396 * @see elm_gengrid_item_del()
8400 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);
8403 * Insert an item after another in a gengrid widget
8405 * @param obj The gengrid object.
8406 * @param gic The item class for the item.
8407 * @param data The item data.
8408 * @param relative The item to place this new one after.
8409 * @param func Convenience function called when the item is
8411 * @param func_data Data to be passed to @p func.
8412 * @return A handle to the item added or @c NULL, on errors.
8414 * This inserts an item after another in the gengrid.
8416 * @see elm_gengrid_item_append()
8417 * @see elm_gengrid_item_prepend()
8418 * @see elm_gengrid_item_insert_after()
8419 * @see elm_gengrid_item_del()
8423 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);
8426 * Insert an item in a gengrid widget using a user-defined sort function.
8428 * @param obj The gengrid object.
8429 * @param gic The item class for the item.
8430 * @param data The item data.
8431 * @param comp User defined comparison function that defines the sort order based on
8432 * Elm_Gen_Item and its data param.
8433 * @param func Convenience function called when the item is selected.
8434 * @param func_data Data to be passed to @p func.
8435 * @return A handle to the item added or @c NULL, on errors.
8437 * This inserts an item in the gengrid based on user defined comparison function.
8439 * @see elm_gengrid_item_append()
8440 * @see elm_gengrid_item_prepend()
8441 * @see elm_gengrid_item_insert_after()
8442 * @see elm_gengrid_item_del()
8443 * @see elm_gengrid_item_direct_sorted_insert()
8447 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);
8450 * Insert an item in a gengrid widget using a user-defined sort function.
8452 * @param obj The gengrid object.
8453 * @param gic The item class for the item.
8454 * @param data The item data.
8455 * @param comp User defined comparison function that defines the sort order based on
8457 * @param func Convenience function called when the item is selected.
8458 * @param func_data Data to be passed to @p func.
8459 * @return A handle to the item added or @c NULL, on errors.
8461 * This inserts an item in the gengrid based on user defined comparison function.
8463 * @see elm_gengrid_item_append()
8464 * @see elm_gengrid_item_prepend()
8465 * @see elm_gengrid_item_insert_after()
8466 * @see elm_gengrid_item_del()
8467 * @see elm_gengrid_item_sorted_insert()
8471 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);
8474 * Set whether items on a given gengrid widget are to get their
8475 * selection callbacks issued for @b every subsequent selection
8476 * click on them or just for the first click.
8478 * @param obj The gengrid object
8479 * @param always_select @c EINA_TRUE to make items "always
8480 * selected", @c EINA_FALSE, otherwise
8482 * By default, grid items will only call their selection callback
8483 * function when firstly getting selected, any subsequent further
8484 * clicks will do nothing. With this call, you make those
8485 * subsequent clicks also to issue the selection callbacks.
8487 * @note <b>Double clicks</b> will @b always be reported on items.
8489 * @see elm_gengrid_always_select_mode_get()
8493 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8496 * Get whether items on a given gengrid widget have their selection
8497 * callbacks issued for @b every subsequent selection click on them
8498 * or just for the first click.
8500 * @param obj The gengrid object.
8501 * @return @c EINA_TRUE if the gengrid items are "always selected",
8502 * @c EINA_FALSE, otherwise
8504 * @see elm_gengrid_always_select_mode_set() for more details
8508 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8511 * Set whether items on a given gengrid widget can be selected or not.
8513 * @param obj The gengrid object
8514 * @param no_select @c EINA_TRUE to make items selectable,
8515 * @c EINA_FALSE otherwise
8517 * This will make items in @p obj selectable or not. In the latter
8518 * case, any user interaction on the gengrid items will neither make
8519 * them appear selected nor them call their selection callback
8522 * @see elm_gengrid_no_select_mode_get()
8526 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8529 * Get whether items on a given gengrid widget can be selected or
8532 * @param obj The gengrid object
8533 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8536 * @see elm_gengrid_no_select_mode_set() for more details
8540 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8543 * Enable or disable multi-selection in a given gengrid widget
8545 * @param obj The gengrid object.
8546 * @param multi @c EINA_TRUE, to enable multi-selection,
8547 * @c EINA_FALSE to disable it.
8549 * Multi-selection is the ability to have @b more than one
8550 * item selected, on a given gengrid, simultaneously. When it is
8551 * enabled, a sequence of clicks on different items will make them
8552 * all selected, progressively. A click on an already selected item
8553 * will unselect it. If interacting via the keyboard,
8554 * multi-selection is enabled while holding the "Shift" key.
8556 * @note By default, multi-selection is @b disabled on gengrids
8558 * @see elm_gengrid_multi_select_get()
8562 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8565 * Get whether multi-selection is enabled or disabled for a given
8568 * @param obj The gengrid object.
8569 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8570 * EINA_FALSE otherwise
8572 * @see elm_gengrid_multi_select_set() for more details
8576 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8579 * Enable or disable bouncing effect for a given gengrid widget
8581 * @param obj The gengrid object
8582 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8583 * @c EINA_FALSE to disable it
8584 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8585 * @c EINA_FALSE to disable it
8587 * The bouncing effect occurs whenever one reaches the gengrid's
8588 * edge's while panning it -- it will scroll past its limits a
8589 * little bit and return to the edge again, in a animated for,
8592 * @note By default, gengrids have bouncing enabled on both axis
8594 * @see elm_gengrid_bounce_get()
8598 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8601 * Get whether bouncing effects are enabled or disabled, for a
8602 * given gengrid widget, on each axis
8604 * @param obj The gengrid object
8605 * @param h_bounce Pointer to a variable where to store the
8606 * horizontal bouncing flag.
8607 * @param v_bounce Pointer to a variable where to store the
8608 * vertical bouncing flag.
8610 * @see elm_gengrid_bounce_set() for more details
8614 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8617 * Set a given gengrid widget's scrolling page size, relative to
8618 * its viewport size.
8620 * @param obj The gengrid object
8621 * @param h_pagerel The horizontal page (relative) size
8622 * @param v_pagerel The vertical page (relative) size
8624 * The gengrid's scroller is capable of binding scrolling by the
8625 * user to "pages". It means that, while scrolling and, specially
8626 * after releasing the mouse button, the grid will @b snap to the
8627 * nearest displaying page's area. When page sizes are set, the
8628 * grid's continuous content area is split into (equal) page sized
8631 * This function sets the size of a page <b>relatively to the
8632 * viewport dimensions</b> of the gengrid, for each axis. A value
8633 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8634 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8635 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8636 * 1.0. Values beyond those will make it behave behave
8637 * inconsistently. If you only want one axis to snap to pages, use
8638 * the value @c 0.0 for the other one.
8640 * There is a function setting page size values in @b absolute
8641 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8642 * is mutually exclusive to this one.
8644 * @see elm_gengrid_page_relative_get()
8648 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8651 * Get a given gengrid widget's scrolling page size, relative to
8652 * its viewport size.
8654 * @param obj The gengrid object
8655 * @param h_pagerel Pointer to a variable where to store the
8656 * horizontal page (relative) size
8657 * @param v_pagerel Pointer to a variable where to store the
8658 * vertical page (relative) size
8660 * @see elm_gengrid_page_relative_set() for more details
8664 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8667 * Set a given gengrid widget's scrolling page size
8669 * @param obj The gengrid object
8670 * @param h_pagerel The horizontal page size, in pixels
8671 * @param v_pagerel The vertical page size, in pixels
8673 * The gengrid's scroller is capable of binding scrolling by the
8674 * user to "pages". It means that, while scrolling and, specially
8675 * after releasing the mouse button, the grid will @b snap to the
8676 * nearest displaying page's area. When page sizes are set, the
8677 * grid's continuous content area is split into (equal) page sized
8680 * This function sets the size of a page of the gengrid, in pixels,
8681 * for each axis. Sane usable values are, between @c 0 and the
8682 * dimensions of @p obj, for each axis. Values beyond those will
8683 * make it behave behave inconsistently. If you only want one axis
8684 * to snap to pages, use the value @c 0 for the other one.
8686 * There is a function setting page size values in @b relative
8687 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8688 * use is mutually exclusive to this one.
8692 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8695 * Set the direction in which a given gengrid widget will expand while
8696 * placing its items.
8698 * @param obj The gengrid object.
8699 * @param setting @c EINA_TRUE to make the gengrid expand
8700 * horizontally, @c EINA_FALSE to expand vertically.
8702 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8703 * in @b columns, from top to bottom and, when the space for a
8704 * column is filled, another one is started on the right, thus
8705 * expanding the grid horizontally. When in "vertical mode"
8706 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8707 * to right and, when the space for a row is filled, another one is
8708 * started below, thus expanding the grid vertically.
8710 * @see elm_gengrid_horizontal_get()
8714 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8717 * Get for what direction a given gengrid widget will expand while
8718 * placing its items.
8720 * @param obj The gengrid object.
8721 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8722 * @c EINA_FALSE if it's set to expand vertically.
8724 * @see elm_gengrid_horizontal_set() for more detais
8728 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8731 * Get the first item in a given gengrid widget
8733 * @param obj The gengrid object
8734 * @return The first item's handle or @c NULL, if there are no
8735 * items in @p obj (and on errors)
8737 * This returns the first item in the @p obj's internal list of
8740 * @see elm_gengrid_last_item_get()
8744 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8747 * Get the last item in a given gengrid widget
8749 * @param obj The gengrid object
8750 * @return The last item's handle or @c NULL, if there are no
8751 * items in @p obj (and on errors)
8753 * This returns the last item in the @p obj's internal list of
8756 * @see elm_gengrid_first_item_get()
8760 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8763 * Get the @b next item in a gengrid widget's internal list of items,
8764 * given a handle to one of those items.
8766 * @param item The gengrid item to fetch next from
8767 * @return The item after @p item, or @c NULL if there's none (and
8770 * This returns the item placed after the @p item, on the container
8773 * @see elm_gengrid_item_prev_get()
8777 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8780 * Get the @b previous item in a gengrid widget's internal list of items,
8781 * given a handle to one of those items.
8783 * @param item The gengrid item to fetch previous from
8784 * @return The item before @p item, or @c NULL if there's none (and
8787 * This returns the item placed before the @p item, on the container
8790 * @see elm_gengrid_item_next_get()
8794 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8797 * Get the gengrid object's handle which contains a given gengrid
8800 * @param item The item to fetch the container from
8801 * @return The gengrid (parent) object
8803 * This returns the gengrid object itself that an item belongs to.
8807 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8810 * Remove a gengrid item from its parent, deleting it.
8812 * @param item The item to be removed.
8813 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8815 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8820 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8823 * Update the contents of a given gengrid item
8825 * @param item The gengrid item
8827 * This updates an item by calling all the item class functions
8828 * again to get the contents, labels and states. Use this when the
8829 * original item data has changed and you want the changes to be
8834 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8837 * Get the Gengrid Item class for the given Gengrid Item.
8839 * @param item The gengrid item
8841 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8842 * the function pointers and item_style.
8846 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8849 * Get the Gengrid Item class for the given Gengrid Item.
8851 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8852 * the function pointers and item_style.
8854 * @param item The gengrid item
8855 * @param gic The gengrid item class describing the function pointers and the item style.
8859 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8862 * Return the data associated to a given gengrid item
8864 * @param item The gengrid item.
8865 * @return the data associated with this item.
8867 * This returns the @c data value passed on the
8868 * elm_gengrid_item_append() and related item addition calls.
8870 * @see elm_gengrid_item_append()
8871 * @see elm_gengrid_item_data_set()
8875 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8878 * Set the data associated with a given gengrid item
8880 * @param item The gengrid item
8881 * @param data The data pointer to set on it
8883 * This @b overrides the @c data value passed on the
8884 * elm_gengrid_item_append() and related item addition calls. This
8885 * function @b won't call elm_gengrid_item_update() automatically,
8886 * so you'd issue it afterwards if you want to have the item
8887 * updated to reflect the new data.
8889 * @see elm_gengrid_item_data_get()
8890 * @see elm_gengrid_item_update()
8894 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8897 * Get a given gengrid item's position, relative to the whole
8898 * gengrid's grid area.
8900 * @param item The Gengrid item.
8901 * @param x Pointer to variable to store the item's <b>row number</b>.
8902 * @param y Pointer to variable to store the item's <b>column number</b>.
8904 * This returns the "logical" position of the item within the
8905 * gengrid. For example, @c (0, 1) would stand for first row,
8910 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8913 * Set whether a given gengrid item is selected or not
8915 * @param item The gengrid item
8916 * @param selected Use @c EINA_TRUE, to make it selected, @c
8917 * EINA_FALSE to make it unselected
8919 * This sets the selected state of an item. If multi-selection is
8920 * not enabled on the containing gengrid and @p selected is @c
8921 * EINA_TRUE, any other previously selected items will get
8922 * unselected in favor of this new one.
8924 * @see elm_gengrid_item_selected_get()
8928 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8931 * Get whether a given gengrid item is selected or not
8933 * @param item The gengrid item
8934 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8936 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8938 * @see elm_gengrid_item_selected_set() for more details
8942 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8945 * Get the real Evas object created to implement the view of a
8946 * given gengrid item
8948 * @param item The gengrid item.
8949 * @return the Evas object implementing this item's view.
8951 * This returns the actual Evas object used to implement the
8952 * specified gengrid item's view. This may be @c NULL, as it may
8953 * not have been created or may have been deleted, at any time, by
8954 * the gengrid. <b>Do not modify this object</b> (move, resize,
8955 * show, hide, etc.), as the gengrid is controlling it. This
8956 * function is for querying, emitting custom signals or hooking
8957 * lower level callbacks for events on that object. Do not delete
8958 * this object under any circumstances.
8960 * @see elm_gengrid_item_data_get()
8964 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8967 * Show the portion of a gengrid's internal grid containing a given
8968 * item, @b immediately.
8970 * @param item The item to display
8972 * This causes gengrid to @b redraw its viewport's contents to the
8973 * region contining the given @p item item, if it is not fully
8976 * @see elm_gengrid_item_bring_in()
8980 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8983 * Animatedly bring in, to the visible area of a gengrid, a given
8986 * @param item The gengrid item to display
8988 * This causes gengrid to jump to the given @p item and show
8989 * it (by scrolling), if it is not fully visible. This will use
8990 * animation to do so and take a period of time to complete.
8992 * @see elm_gengrid_item_show()
8996 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8999 * Set whether a given gengrid item is disabled or not.
9001 * @param item The gengrid item
9002 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9003 * to enable it back.
9005 * A disabled item cannot be selected or unselected. It will also
9006 * change its appearance, to signal the user it's disabled.
9008 * @see elm_gengrid_item_disabled_get()
9012 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9015 * Get whether a given gengrid item is disabled or not.
9017 * @param item The gengrid item
9018 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9021 * @see elm_gengrid_item_disabled_set() for more details
9025 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9028 * Set the text to be shown in a given gengrid item's tooltips.
9030 * @param item The gengrid item
9031 * @param text The text to set in the content
9033 * This call will setup the text to be used as tooltip to that item
9034 * (analogous to elm_object_tooltip_text_set(), but being item
9035 * tooltips with higher precedence than object tooltips). It can
9036 * have only one tooltip at a time, so any previous tooltip data
9041 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9044 * Set the content to be shown in a given gengrid item's tooltip
9046 * @param item The gengrid item.
9047 * @param func The function returning the tooltip contents.
9048 * @param data What to provide to @a func as callback data/context.
9049 * @param del_cb Called when data is not needed anymore, either when
9050 * another callback replaces @p func, the tooltip is unset with
9051 * elm_gengrid_item_tooltip_unset() or the owner @p item
9052 * dies. This callback receives as its first parameter the
9053 * given @p data, being @c event_info the item handle.
9055 * This call will setup the tooltip's contents to @p item
9056 * (analogous to elm_object_tooltip_content_cb_set(), but being
9057 * item tooltips with higher precedence than object tooltips). It
9058 * can have only one tooltip at a time, so any previous tooltip
9059 * content will get removed. @p func (with @p data) will be called
9060 * every time Elementary needs to show the tooltip and it should
9061 * return a valid Evas object, which will be fully managed by the
9062 * tooltip system, getting deleted when the tooltip is gone.
9066 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);
9069 * Unset a tooltip from a given gengrid item
9071 * @param item gengrid item to remove a previously set tooltip from.
9073 * This call removes any tooltip set on @p item. The callback
9074 * provided as @c del_cb to
9075 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9076 * notify it is not used anymore (and have resources cleaned, if
9079 * @see elm_gengrid_item_tooltip_content_cb_set()
9083 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9086 * Set a different @b style for a given gengrid item's tooltip.
9088 * @param item gengrid item with tooltip set
9089 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9090 * "default", @c "transparent", etc)
9092 * Tooltips can have <b>alternate styles</b> to be displayed on,
9093 * which are defined by the theme set on Elementary. This function
9094 * works analogously as elm_object_tooltip_style_set(), but here
9095 * applied only to gengrid item objects. The default style for
9096 * tooltips is @c "default".
9098 * @note before you set a style you should define a tooltip with
9099 * elm_gengrid_item_tooltip_content_cb_set() or
9100 * elm_gengrid_item_tooltip_text_set()
9102 * @see elm_gengrid_item_tooltip_style_get()
9106 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9109 * Get the style set a given gengrid item's tooltip.
9111 * @param item gengrid item with tooltip already set on.
9112 * @return style the theme style in use, which defaults to
9113 * "default". If the object does not have a tooltip set,
9114 * then @c NULL is returned.
9116 * @see elm_gengrid_item_tooltip_style_set() for more details
9120 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9122 * Set the type of mouse pointer/cursor decoration to be shown,
9123 * when the mouse pointer is over the given gengrid widget item
9125 * @param item gengrid item to customize cursor on
9126 * @param cursor the cursor type's name
9128 * This function works analogously as elm_object_cursor_set(), but
9129 * here the cursor's changing area is restricted to the item's
9130 * area, and not the whole widget's. Note that that item cursors
9131 * have precedence over widget cursors, so that a mouse over @p
9132 * item will always show cursor @p type.
9134 * If this function is called twice for an object, a previously set
9135 * cursor will be unset on the second call.
9137 * @see elm_object_cursor_set()
9138 * @see elm_gengrid_item_cursor_get()
9139 * @see elm_gengrid_item_cursor_unset()
9143 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9146 * Get the type of mouse pointer/cursor decoration set to be shown,
9147 * when the mouse pointer is over the given gengrid widget item
9149 * @param item gengrid item with custom cursor set
9150 * @return the cursor type's name or @c NULL, if no custom cursors
9151 * were set to @p item (and on errors)
9153 * @see elm_object_cursor_get()
9154 * @see elm_gengrid_item_cursor_set() for more details
9155 * @see elm_gengrid_item_cursor_unset()
9159 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9162 * Unset any custom mouse pointer/cursor decoration set to be
9163 * shown, when the mouse pointer is over the given gengrid widget
9164 * item, thus making it show the @b default cursor again.
9166 * @param item a gengrid item
9168 * Use this call to undo any custom settings on this item's cursor
9169 * decoration, bringing it back to defaults (no custom style set).
9171 * @see elm_object_cursor_unset()
9172 * @see elm_gengrid_item_cursor_set() for more details
9176 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9179 * Set a different @b style for a given custom cursor set for a
9182 * @param item gengrid item with custom cursor set
9183 * @param style the <b>theme style</b> to use (e.g. @c "default",
9184 * @c "transparent", etc)
9186 * This function only makes sense when one is using custom mouse
9187 * cursor decorations <b>defined in a theme file</b> , which can
9188 * have, given a cursor name/type, <b>alternate styles</b> on
9189 * it. It works analogously as elm_object_cursor_style_set(), but
9190 * here applied only to gengrid item objects.
9192 * @warning Before you set a cursor style you should have defined a
9193 * custom cursor previously on the item, with
9194 * elm_gengrid_item_cursor_set()
9196 * @see elm_gengrid_item_cursor_engine_only_set()
9197 * @see elm_gengrid_item_cursor_style_get()
9201 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9204 * Get the current @b style set for a given gengrid item's custom
9207 * @param item gengrid item with custom cursor set.
9208 * @return style the cursor style in use. If the object does not
9209 * have a cursor set, then @c NULL is returned.
9211 * @see elm_gengrid_item_cursor_style_set() for more details
9215 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9218 * Set if the (custom) cursor for a given gengrid item should be
9219 * searched in its theme, also, or should only rely on the
9222 * @param item item with custom (custom) cursor already set on
9223 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9224 * only on those provided by the rendering engine, @c EINA_FALSE to
9225 * have them searched on the widget's theme, as well.
9227 * @note This call is of use only if you've set a custom cursor
9228 * for gengrid items, with elm_gengrid_item_cursor_set().
9230 * @note By default, cursors will only be looked for between those
9231 * provided by the rendering engine.
9235 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9238 * Get if the (custom) cursor for a given gengrid item is being
9239 * searched in its theme, also, or is only relying on the rendering
9242 * @param item a gengrid item
9243 * @return @c EINA_TRUE, if cursors are being looked for only on
9244 * those provided by the rendering engine, @c EINA_FALSE if they
9245 * are being searched on the widget's theme, as well.
9247 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9251 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9254 * Remove all items from a given gengrid widget
9256 * @param obj The gengrid object.
9258 * This removes (and deletes) all items in @p obj, leaving it
9261 * @see elm_gengrid_item_del(), to remove just one item.
9265 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9268 * Get the selected item in a given gengrid widget
9270 * @param obj The gengrid object.
9271 * @return The selected item's handleor @c NULL, if none is
9272 * selected at the moment (and on errors)
9274 * This returns the selected item in @p obj. If multi selection is
9275 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9276 * the first item in the list is selected, which might not be very
9277 * useful. For that case, see elm_gengrid_selected_items_get().
9281 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9284 * Get <b>a list</b> of selected items in a given gengrid
9286 * @param obj The gengrid object.
9287 * @return The list of selected items or @c NULL, if none is
9288 * selected at the moment (and on errors)
9290 * This returns a list of the selected items, in the order that
9291 * they appear in the grid. This list is only valid as long as no
9292 * more items are selected or unselected (or unselected implictly
9293 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9296 * @see elm_gengrid_selected_item_get()
9300 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9307 * @defgroup Clock Clock
9309 * @image html img/widget/clock/preview-00.png
9310 * @image latex img/widget/clock/preview-00.eps
9312 * This is a @b digital clock widget. In its default theme, it has a
9313 * vintage "flipping numbers clock" appearance, which will animate
9314 * sheets of individual algarisms individually as time goes by.
9316 * A newly created clock will fetch system's time (already
9317 * considering local time adjustments) to start with, and will tick
9318 * accondingly. It may or may not show seconds.
9320 * Clocks have an @b edition mode. When in it, the sheets will
9321 * display extra arrow indications on the top and bottom and the
9322 * user may click on them to raise or lower the time values. After
9323 * it's told to exit edition mode, it will keep ticking with that
9324 * new time set (it keeps the difference from local time).
9326 * Also, when under edition mode, user clicks on the cited arrows
9327 * which are @b held for some time will make the clock to flip the
9328 * sheet, thus editing the time, continuosly and automatically for
9329 * the user. The interval between sheet flips will keep growing in
9330 * time, so that it helps the user to reach a time which is distant
9333 * The time display is, by default, in military mode (24h), but an
9334 * am/pm indicator may be optionally shown, too, when it will
9337 * Smart callbacks one can register to:
9338 * - "changed" - the clock's user changed the time
9340 * Here is an example on its usage:
9341 * @li @ref clock_example
9350 * Identifiers for which clock digits should be editable, when a
9351 * clock widget is in edition mode. Values may be ORed together to
9352 * make a mask, naturally.
9354 * @see elm_clock_edit_set()
9355 * @see elm_clock_digit_edit_set()
9357 typedef enum _Elm_Clock_Digedit
9359 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9360 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9361 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9362 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9363 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9364 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9365 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9366 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9367 } Elm_Clock_Digedit;
9370 * Add a new clock widget to the given parent Elementary
9371 * (container) object
9373 * @param parent The parent object
9374 * @return a new clock widget handle or @c NULL, on errors
9376 * This function inserts a new clock widget on the canvas.
9380 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9383 * Set a clock widget's time, programmatically
9385 * @param obj The clock widget object
9386 * @param hrs The hours to set
9387 * @param min The minutes to set
9388 * @param sec The secondes to set
9390 * This function updates the time that is showed by the clock
9393 * Values @b must be set within the following ranges:
9394 * - 0 - 23, for hours
9395 * - 0 - 59, for minutes
9396 * - 0 - 59, for seconds,
9398 * even if the clock is not in "military" mode.
9400 * @warning The behavior for values set out of those ranges is @b
9405 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9408 * Get a clock widget's time values
9410 * @param obj The clock object
9411 * @param[out] hrs Pointer to the variable to get the hours value
9412 * @param[out] min Pointer to the variable to get the minutes value
9413 * @param[out] sec Pointer to the variable to get the seconds value
9415 * This function gets the time set for @p obj, returning
9416 * it on the variables passed as the arguments to function
9418 * @note Use @c NULL pointers on the time values you're not
9419 * interested in: they'll be ignored by the function.
9423 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9426 * Set whether a given clock widget is under <b>edition mode</b> or
9427 * under (default) displaying-only mode.
9429 * @param obj The clock object
9430 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9431 * put it back to "displaying only" mode
9433 * This function makes a clock's time to be editable or not <b>by
9434 * user interaction</b>. When in edition mode, clocks @b stop
9435 * ticking, until one brings them back to canonical mode. The
9436 * elm_clock_digit_edit_set() function will influence which digits
9437 * of the clock will be editable. By default, all of them will be
9438 * (#ELM_CLOCK_NONE).
9440 * @note am/pm sheets, if being shown, will @b always be editable
9441 * under edition mode.
9443 * @see elm_clock_edit_get()
9447 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9450 * Retrieve whether a given clock widget is under <b>edition
9451 * mode</b> or under (default) displaying-only mode.
9453 * @param obj The clock object
9454 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9457 * This function retrieves whether the clock's time can be edited
9458 * or not by user interaction.
9460 * @see elm_clock_edit_set() for more details
9464 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9467 * Set what digits of the given clock widget should be editable
9468 * when in edition mode.
9470 * @param obj The clock object
9471 * @param digedit Bit mask indicating the digits to be editable
9472 * (values in #Elm_Clock_Digedit).
9474 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9475 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9478 * @see elm_clock_digit_edit_get()
9482 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9485 * Retrieve what digits of the given clock widget should be
9486 * editable when in edition mode.
9488 * @param obj The clock object
9489 * @return Bit mask indicating the digits to be editable
9490 * (values in #Elm_Clock_Digedit).
9492 * @see elm_clock_digit_edit_set() for more details
9496 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9499 * Set if the given clock widget must show hours in military or
9502 * @param obj The clock object
9503 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9506 * This function sets if the clock must show hours in military or
9507 * am/pm mode. In some countries like Brazil the military mode
9508 * (00-24h-format) is used, in opposition to the USA, where the
9509 * am/pm mode is more commonly used.
9511 * @see elm_clock_show_am_pm_get()
9515 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9518 * Get if the given clock widget shows hours in military or am/pm
9521 * @param obj The clock object
9522 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9525 * This function gets if the clock shows hours in military or am/pm
9528 * @see elm_clock_show_am_pm_set() for more details
9532 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9535 * Set if the given clock widget must show time with seconds or not
9537 * @param obj The clock object
9538 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9540 * This function sets if the given clock must show or not elapsed
9541 * seconds. By default, they are @b not shown.
9543 * @see elm_clock_show_seconds_get()
9547 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9550 * Get whether the given clock widget is showing time with seconds
9553 * @param obj The clock object
9554 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9556 * This function gets whether @p obj is showing or not the elapsed
9559 * @see elm_clock_show_seconds_set()
9563 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9566 * Set the interval on time updates for an user mouse button hold
9567 * on clock widgets' time edition.
9569 * @param obj The clock object
9570 * @param interval The (first) interval value in seconds
9572 * This interval value is @b decreased while the user holds the
9573 * mouse pointer either incrementing or decrementing a given the
9574 * clock digit's value.
9576 * This helps the user to get to a given time distant from the
9577 * current one easier/faster, as it will start to flip quicker and
9578 * quicker on mouse button holds.
9580 * The calculation for the next flip interval value, starting from
9581 * the one set with this call, is the previous interval divided by
9582 * 1.05, so it decreases a little bit.
9584 * The default starting interval value for automatic flips is
9587 * @see elm_clock_interval_get()
9591 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9594 * Get the interval on time updates for an user mouse button hold
9595 * on clock widgets' time edition.
9597 * @param obj The clock object
9598 * @return The (first) interval value, in seconds, set on it
9600 * @see elm_clock_interval_set() for more details
9604 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9611 * @defgroup Layout Layout
9613 * @image html img/widget/layout/preview-00.png
9614 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9616 * @image html img/layout-predefined.png
9617 * @image latex img/layout-predefined.eps width=\textwidth
9619 * This is a container widget that takes a standard Edje design file and
9620 * wraps it very thinly in a widget.
9622 * An Edje design (theme) file has a very wide range of possibilities to
9623 * describe the behavior of elements added to the Layout. Check out the Edje
9624 * documentation and the EDC reference to get more information about what can
9625 * be done with Edje.
9627 * Just like @ref List, @ref Box, and other container widgets, any
9628 * object added to the Layout will become its child, meaning that it will be
9629 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9631 * The Layout widget can contain as many Contents, Boxes or Tables as
9632 * described in its theme file. For instance, objects can be added to
9633 * different Tables by specifying the respective Table part names. The same
9634 * is valid for Content and Box.
9636 * The objects added as child of the Layout will behave as described in the
9637 * part description where they were added. There are 3 possible types of
9638 * parts where a child can be added:
9640 * @section secContent Content (SWALLOW part)
9642 * Only one object can be added to the @c SWALLOW part (but you still can
9643 * have many @c SWALLOW parts and one object on each of them). Use the @c
9644 * elm_object_content_set/get/unset functions to set, retrieve and unset
9645 * objects as content of the @c SWALLOW. After being set to this part, the
9646 * object size, position, visibility, clipping and other description
9647 * properties will be totally controled by the description of the given part
9648 * (inside the Edje theme file).
9650 * One can use @c evas_object_size_hint_* functions on the child to have some
9651 * kind of control over its behavior, but the resulting behavior will still
9652 * depend heavily on the @c SWALLOW part description.
9654 * The Edje theme also can change the part description, based on signals or
9655 * scripts running inside the theme. This change can also be animated. All of
9656 * this will affect the child object set as content accordingly. The object
9657 * size will be changed if the part size is changed, it will animate move if
9658 * the part is moving, and so on.
9660 * The following picture demonstrates a Layout widget with a child object
9661 * added to its @c SWALLOW:
9663 * @image html layout_swallow.png
9664 * @image latex layout_swallow.eps width=\textwidth
9666 * @section secBox Box (BOX part)
9668 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9669 * allows one to add objects to the box and have them distributed along its
9670 * area, accordingly to the specified @a layout property (now by @a layout we
9671 * mean the chosen layouting design of the Box, not the Layout widget
9674 * A similar effect for having a box with its position, size and other things
9675 * controled by the Layout theme would be to create an Elementary @ref Box
9676 * widget and add it as a Content in the @c SWALLOW part.
9678 * The main difference of using the Layout Box is that its behavior, the box
9679 * properties like layouting format, padding, align, etc. will be all
9680 * controled by the theme. This means, for example, that a signal could be
9681 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9682 * handled the signal by changing the box padding, or align, or both. Using
9683 * the Elementary @ref Box widget is not necessarily harder or easier, it
9684 * just depends on the circunstances and requirements.
9686 * The Layout Box can be used through the @c elm_layout_box_* set of
9689 * The following picture demonstrates a Layout widget with many child objects
9690 * added to its @c BOX part:
9692 * @image html layout_box.png
9693 * @image latex layout_box.eps width=\textwidth
9695 * @section secTable Table (TABLE part)
9697 * Just like the @ref secBox, the Layout Table is very similar to the
9698 * Elementary @ref Table widget. It allows one to add objects to the Table
9699 * specifying the row and column where the object should be added, and any
9700 * column or row span if necessary.
9702 * Again, we could have this design by adding a @ref Table widget to the @c
9703 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9704 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9705 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9707 * The Layout Table can be used through the @c elm_layout_table_* set of
9710 * The following picture demonstrates a Layout widget with many child objects
9711 * added to its @c TABLE part:
9713 * @image html layout_table.png
9714 * @image latex layout_table.eps width=\textwidth
9716 * @section secPredef Predefined Layouts
9718 * Another interesting thing about the Layout widget is that it offers some
9719 * predefined themes that come with the default Elementary theme. These
9720 * themes can be set by the call elm_layout_theme_set(), and provide some
9721 * basic functionality depending on the theme used.
9723 * Most of them already send some signals, some already provide a toolbar or
9724 * back and next buttons.
9726 * These are available predefined theme layouts. All of them have class = @c
9727 * layout, group = @c application, and style = one of the following options:
9729 * @li @c toolbar-content - application with toolbar and main content area
9730 * @li @c toolbar-content-back - application with toolbar and main content
9731 * area with a back button and title area
9732 * @li @c toolbar-content-back-next - application with toolbar and main
9733 * content area with a back and next buttons and title area
9734 * @li @c content-back - application with a main content area with a back
9735 * button and title area
9736 * @li @c content-back-next - application with a main content area with a
9737 * back and next buttons and title area
9738 * @li @c toolbar-vbox - application with toolbar and main content area as a
9740 * @li @c toolbar-table - application with toolbar and main content area as a
9743 * @section secExamples Examples
9745 * Some examples of the Layout widget can be found here:
9746 * @li @ref layout_example_01
9747 * @li @ref layout_example_02
9748 * @li @ref layout_example_03
9749 * @li @ref layout_example_edc
9754 * Add a new layout to the parent
9756 * @param parent The parent object
9757 * @return The new object or NULL if it cannot be created
9759 * @see elm_layout_file_set()
9760 * @see elm_layout_theme_set()
9764 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9766 * Set the file that will be used as layout
9768 * @param obj The layout object
9769 * @param file The path to file (edj) that will be used as layout
9770 * @param group The group that the layout belongs in edje file
9772 * @return (1 = success, 0 = error)
9776 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9778 * Set the edje group from the elementary theme that will be used as layout
9780 * @param obj The layout object
9781 * @param clas the clas of the group
9782 * @param group the group
9783 * @param style the style to used
9785 * @return (1 = success, 0 = error)
9789 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9791 * Set the layout content.
9793 * @param obj The layout object
9794 * @param swallow The swallow part name in the edje file
9795 * @param content The child that will be added in this layout object
9797 * Once the content object is set, a previously set one will be deleted.
9798 * If you want to keep that old content object, use the
9799 * elm_object_part_content_unset() function.
9801 * @note In an Edje theme, the part used as a content container is called @c
9802 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9803 * expected to be a part name just like the second parameter of
9804 * elm_layout_box_append().
9806 * @see elm_layout_box_append()
9807 * @see elm_object_content_part_get()
9808 * @see elm_object_content_part_unset()
9813 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9815 * Get the child object in the given content part.
9817 * @param obj The layout object
9818 * @param swallow The SWALLOW part to get its content
9820 * @return The swallowed object or NULL if none or an error occurred
9822 * @see elm_object_content_part_set()
9826 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9828 * Unset the layout content.
9830 * @param obj The layout object
9831 * @param swallow The swallow part name in the edje file
9832 * @return The content that was being used
9834 * Unparent and return the content object which was set for this part.
9836 * @see elm_object_content_part_set()
9840 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9842 * Set the text of the given part
9844 * @param obj The layout object
9845 * @param part The TEXT part where to set the text
9846 * @param text The text to set
9849 * @deprecated use elm_object_part_text_set() instead.
9851 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9853 * Get the text set in the given part
9855 * @param obj The layout object
9856 * @param part The TEXT part to retrieve the text off
9858 * @return The text set in @p part
9861 * @deprecated use elm_object_part_text_get() instead.
9863 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9865 * Append child to layout box part.
9867 * @param obj the layout object
9868 * @param part the box part to which the object will be appended.
9869 * @param child the child object to append to box.
9871 * Once the object is appended, it will become child of the layout. Its
9872 * lifetime will be bound to the layout, whenever the layout dies the child
9873 * will be deleted automatically. One should use elm_layout_box_remove() to
9874 * make this layout forget about the object.
9876 * @see elm_layout_box_prepend()
9877 * @see elm_layout_box_insert_before()
9878 * @see elm_layout_box_insert_at()
9879 * @see elm_layout_box_remove()
9883 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9885 * Prepend child to layout box part.
9887 * @param obj the layout object
9888 * @param part the box part to prepend.
9889 * @param child the child object to prepend to box.
9891 * Once the object is prepended, it will become child of the layout. Its
9892 * lifetime will be bound to the layout, whenever the layout dies the child
9893 * will be deleted automatically. One should use elm_layout_box_remove() to
9894 * make this layout forget about the object.
9896 * @see elm_layout_box_append()
9897 * @see elm_layout_box_insert_before()
9898 * @see elm_layout_box_insert_at()
9899 * @see elm_layout_box_remove()
9903 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9905 * Insert child to layout box part before a reference object.
9907 * @param obj the layout object
9908 * @param part the box part to insert.
9909 * @param child the child object to insert into box.
9910 * @param reference another reference object to insert before in box.
9912 * Once the object is inserted, it will become child of the layout. Its
9913 * lifetime will be bound to the layout, whenever the layout dies the child
9914 * will be deleted automatically. One should use elm_layout_box_remove() to
9915 * make this layout forget about the object.
9917 * @see elm_layout_box_append()
9918 * @see elm_layout_box_prepend()
9919 * @see elm_layout_box_insert_before()
9920 * @see elm_layout_box_remove()
9924 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9926 * Insert child to layout box part at a given position.
9928 * @param obj the layout object
9929 * @param part the box part to insert.
9930 * @param child the child object to insert into box.
9931 * @param pos the numeric position >=0 to insert the child.
9933 * Once the object is inserted, it will become child of the layout. Its
9934 * lifetime will be bound to the layout, whenever the layout dies the child
9935 * will be deleted automatically. One should use elm_layout_box_remove() to
9936 * make this layout forget about the object.
9938 * @see elm_layout_box_append()
9939 * @see elm_layout_box_prepend()
9940 * @see elm_layout_box_insert_before()
9941 * @see elm_layout_box_remove()
9945 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9947 * Remove a child of the given part box.
9949 * @param obj The layout object
9950 * @param part The box part name to remove child.
9951 * @param child The object to remove from box.
9952 * @return The object that was being used, or NULL if not found.
9954 * The object will be removed from the box part and its lifetime will
9955 * not be handled by the layout anymore. This is equivalent to
9956 * elm_object_part_content_unset() for box.
9958 * @see elm_layout_box_append()
9959 * @see elm_layout_box_remove_all()
9963 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9965 * Remove all child of the given part box.
9967 * @param obj The layout object
9968 * @param part The box part name to remove child.
9969 * @param clear If EINA_TRUE, then all objects will be deleted as
9970 * well, otherwise they will just be removed and will be
9971 * dangling on the canvas.
9973 * The objects will be removed from the box part and their lifetime will
9974 * not be handled by the layout anymore. This is equivalent to
9975 * elm_layout_box_remove() for all box children.
9977 * @see elm_layout_box_append()
9978 * @see elm_layout_box_remove()
9982 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9984 * Insert child to layout table part.
9986 * @param obj the layout object
9987 * @param part the box part to pack child.
9988 * @param child_obj the child object to pack into table.
9989 * @param col the column to which the child should be added. (>= 0)
9990 * @param row the row to which the child should be added. (>= 0)
9991 * @param colspan how many columns should be used to store this object. (>=
9993 * @param rowspan how many rows should be used to store this object. (>= 1)
9995 * Once the object is inserted, it will become child of the table. Its
9996 * lifetime will be bound to the layout, and whenever the layout dies the
9997 * child will be deleted automatically. One should use
9998 * elm_layout_table_remove() to make this layout forget about the object.
10000 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10001 * more space than a single cell. For instance, the following code:
10003 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10006 * Would result in an object being added like the following picture:
10008 * @image html layout_colspan.png
10009 * @image latex layout_colspan.eps width=\textwidth
10011 * @see elm_layout_table_unpack()
10012 * @see elm_layout_table_clear()
10016 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);
10018 * Unpack (remove) a child of the given part table.
10020 * @param obj The layout object
10021 * @param part The table part name to remove child.
10022 * @param child_obj The object to remove from table.
10023 * @return The object that was being used, or NULL if not found.
10025 * The object will be unpacked from the table part and its lifetime
10026 * will not be handled by the layout anymore. This is equivalent to
10027 * elm_object_part_content_unset() for table.
10029 * @see elm_layout_table_pack()
10030 * @see elm_layout_table_clear()
10034 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10036 * Remove all child of the given part table.
10038 * @param obj The layout object
10039 * @param part The table part name to remove child.
10040 * @param clear If EINA_TRUE, then all objects will be deleted as
10041 * well, otherwise they will just be removed and will be
10042 * dangling on the canvas.
10044 * The objects will be removed from the table part and their lifetime will
10045 * not be handled by the layout anymore. This is equivalent to
10046 * elm_layout_table_unpack() for all table children.
10048 * @see elm_layout_table_pack()
10049 * @see elm_layout_table_unpack()
10053 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10055 * Get the edje layout
10057 * @param obj The layout object
10059 * @return A Evas_Object with the edje layout settings loaded
10060 * with function elm_layout_file_set
10062 * This returns the edje object. It is not expected to be used to then
10063 * swallow objects via edje_object_part_swallow() for example. Use
10064 * elm_object_part_content_set() instead so child object handling and sizing is
10067 * @note This function should only be used if you really need to call some
10068 * low level Edje function on this edje object. All the common stuff (setting
10069 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10070 * with proper elementary functions.
10072 * @see elm_object_signal_callback_add()
10073 * @see elm_object_signal_emit()
10074 * @see elm_object_part_text_set()
10075 * @see elm_object_content_part_set()
10076 * @see elm_layout_box_append()
10077 * @see elm_layout_table_pack()
10078 * @see elm_layout_data_get()
10082 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10084 * Get the edje data from the given layout
10086 * @param obj The layout object
10087 * @param key The data key
10089 * @return The edje data string
10091 * This function fetches data specified inside the edje theme of this layout.
10092 * This function return NULL if data is not found.
10094 * In EDC this comes from a data block within the group block that @p
10095 * obj was loaded from. E.g.
10102 * item: "key1" "value1";
10103 * item: "key2" "value2";
10111 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10115 * @param obj The layout object
10117 * Manually forces a sizing re-evaluation. This is useful when the minimum
10118 * size required by the edje theme of this layout has changed. The change on
10119 * the minimum size required by the edje theme is not immediately reported to
10120 * the elementary layout, so one needs to call this function in order to tell
10121 * the widget (layout) that it needs to reevaluate its own size.
10123 * The minimum size of the theme is calculated based on minimum size of
10124 * parts, the size of elements inside containers like box and table, etc. All
10125 * of this can change due to state changes, and that's when this function
10126 * should be called.
10128 * Also note that a standard signal of "size,eval" "elm" emitted from the
10129 * edje object will cause this to happen too.
10133 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10136 * Sets a specific cursor for an edje part.
10138 * @param obj The layout object.
10139 * @param part_name a part from loaded edje group.
10140 * @param cursor cursor name to use, see Elementary_Cursor.h
10142 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10143 * part not exists or it has "mouse_events: 0".
10147 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10150 * Get the cursor to be shown when mouse is over an edje part
10152 * @param obj The layout object.
10153 * @param part_name a part from loaded edje group.
10154 * @return the cursor name.
10158 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10161 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10163 * @param obj The layout object.
10164 * @param part_name a part from loaded edje group, that had a cursor set
10165 * with elm_layout_part_cursor_set().
10169 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10172 * Sets a specific cursor style for an edje part.
10174 * @param obj The layout object.
10175 * @param part_name a part from loaded edje group.
10176 * @param style the theme style to use (default, transparent, ...)
10178 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10179 * part not exists or it did not had a cursor set.
10183 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10186 * Gets a specific cursor style for an edje part.
10188 * @param obj The layout object.
10189 * @param part_name a part from loaded edje group.
10191 * @return the theme style in use, defaults to "default". If the
10192 * object does not have a cursor set, then NULL is returned.
10196 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10199 * Sets if the cursor set should be searched on the theme or should use
10200 * the provided by the engine, only.
10202 * @note before you set if should look on theme you should define a
10203 * cursor with elm_layout_part_cursor_set(). By default it will only
10204 * look for cursors provided by the engine.
10206 * @param obj The layout object.
10207 * @param part_name a part from loaded edje group.
10208 * @param engine_only if cursors should be just provided by the engine
10209 * or should also search on widget's theme as well
10211 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10212 * part not exists or it did not had a cursor set.
10216 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);
10219 * Gets a specific cursor engine_only for an edje part.
10221 * @param obj The layout object.
10222 * @param part_name a part from loaded edje group.
10224 * @return whenever the cursor is just provided by engine or also from theme.
10228 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10231 * @def elm_layout_icon_set
10232 * Convienience macro to set the icon object in a layout that follows the
10233 * Elementary naming convention for its parts.
10237 #define elm_layout_icon_set(_ly, _obj) \
10240 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10241 if ((_obj)) sig = "elm,state,icon,visible"; \
10242 else sig = "elm,state,icon,hidden"; \
10243 elm_object_signal_emit((_ly), sig, "elm"); \
10247 * @def elm_layout_icon_get
10248 * Convienience macro to get the icon object from a layout that follows the
10249 * Elementary naming convention for its parts.
10253 #define elm_layout_icon_get(_ly) \
10254 elm_object_content_part_get((_ly), "elm.swallow.icon")
10257 * @def elm_layout_end_set
10258 * Convienience macro to set the end object in a layout that follows the
10259 * Elementary naming convention for its parts.
10263 #define elm_layout_end_set(_ly, _obj) \
10266 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10267 if ((_obj)) sig = "elm,state,end,visible"; \
10268 else sig = "elm,state,end,hidden"; \
10269 elm_object_signal_emit((_ly), sig, "elm"); \
10273 * @def elm_layout_end_get
10274 * Convienience macro to get the end object in a layout that follows the
10275 * Elementary naming convention for its parts.
10279 #define elm_layout_end_get(_ly) \
10280 elm_object_content_part_get((_ly), "elm.swallow.end")
10283 * @def elm_layout_label_set
10284 * Convienience macro to set the label in a layout that follows the
10285 * Elementary naming convention for its parts.
10288 * @deprecated use elm_object_text_set() instead.
10290 #define elm_layout_label_set(_ly, _txt) \
10291 elm_layout_text_set((_ly), "elm.text", (_txt))
10294 * @def elm_layout_label_get
10295 * Convenience macro to get the label in a layout that follows the
10296 * Elementary naming convention for its parts.
10299 * @deprecated use elm_object_text_set() instead.
10301 #define elm_layout_label_get(_ly) \
10302 elm_layout_text_get((_ly), "elm.text")
10304 /* smart callbacks called:
10305 * "theme,changed" - when elm theme is changed.
10309 * @defgroup Notify Notify
10311 * @image html img/widget/notify/preview-00.png
10312 * @image latex img/widget/notify/preview-00.eps
10314 * Display a container in a particular region of the parent(top, bottom,
10315 * etc). A timeout can be set to automatically hide the notify. This is so
10316 * that, after an evas_object_show() on a notify object, if a timeout was set
10317 * on it, it will @b automatically get hidden after that time.
10319 * Signals that you can add callbacks for are:
10320 * @li "timeout" - when timeout happens on notify and it's hidden
10321 * @li "block,clicked" - when a click outside of the notify happens
10323 * Default contents parts of the notify widget that you can use for are:
10324 * @li "default" - A content of the notify
10326 * @ref tutorial_notify show usage of the API.
10331 * @brief Possible orient values for notify.
10333 * This values should be used in conjunction to elm_notify_orient_set() to
10334 * set the position in which the notify should appear(relative to its parent)
10335 * and in conjunction with elm_notify_orient_get() to know where the notify
10338 typedef enum _Elm_Notify_Orient
10340 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10341 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10342 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10343 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10344 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10345 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10346 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10347 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10348 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10349 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10350 } Elm_Notify_Orient;
10352 * @brief Add a new notify to the parent
10354 * @param parent The parent object
10355 * @return The new object or NULL if it cannot be created
10357 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10359 * @brief Set the content of the notify widget
10361 * @param obj The notify object
10362 * @param content The content will be filled in this notify object
10364 * Once the content object is set, a previously set one will be deleted. If
10365 * you want to keep that old content object, use the
10366 * elm_notify_content_unset() function.
10368 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10370 * @brief Unset the content of the notify widget
10372 * @param obj The notify object
10373 * @return The content that was being used
10375 * Unparent and return the content object which was set for this widget
10377 * @see elm_notify_content_set()
10379 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10381 * @brief Return the content of the notify widget
10383 * @param obj The notify object
10384 * @return The content that is being used
10386 * @see elm_notify_content_set()
10388 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10390 * @brief Set the notify parent
10392 * @param obj The notify object
10393 * @param content The new parent
10395 * Once the parent object is set, a previously set one will be disconnected
10398 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10400 * @brief Get the notify parent
10402 * @param obj The notify object
10403 * @return The parent
10405 * @see elm_notify_parent_set()
10407 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10409 * @brief Set the orientation
10411 * @param obj The notify object
10412 * @param orient The new orientation
10414 * Sets the position in which the notify will appear in its parent.
10416 * @see @ref Elm_Notify_Orient for possible values.
10418 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10420 * @brief Return the orientation
10421 * @param obj The notify object
10422 * @return The orientation of the notification
10424 * @see elm_notify_orient_set()
10425 * @see Elm_Notify_Orient
10427 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10429 * @brief Set the time interval after which the notify window is going to be
10432 * @param obj The notify object
10433 * @param time The timeout in seconds
10435 * This function sets a timeout and starts the timer controlling when the
10436 * notify is hidden. Since calling evas_object_show() on a notify restarts
10437 * the timer controlling when the notify is hidden, setting this before the
10438 * notify is shown will in effect mean starting the timer when the notify is
10441 * @note Set a value <= 0.0 to disable a running timer.
10443 * @note If the value > 0.0 and the notify is previously visible, the
10444 * timer will be started with this value, canceling any running timer.
10446 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10448 * @brief Return the timeout value (in seconds)
10449 * @param obj the notify object
10451 * @see elm_notify_timeout_set()
10453 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10455 * @brief Sets whether events should be passed to by a click outside
10458 * @param obj The notify object
10459 * @param repeats EINA_TRUE Events are repeats, else no
10461 * When true if the user clicks outside the window the events will be caught
10462 * by the others widgets, else the events are blocked.
10464 * @note The default value is EINA_TRUE.
10466 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10468 * @brief Return true if events are repeat below the notify object
10469 * @param obj the notify object
10471 * @see elm_notify_repeat_events_set()
10473 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10479 * @defgroup Hover Hover
10481 * @image html img/widget/hover/preview-00.png
10482 * @image latex img/widget/hover/preview-00.eps
10484 * A Hover object will hover over its @p parent object at the @p target
10485 * location. Anything in the background will be given a darker coloring to
10486 * indicate that the hover object is on top (at the default theme). When the
10487 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10488 * clicked that @b doesn't cause the hover to be dismissed.
10490 * A Hover object has two parents. One parent that owns it during creation
10491 * and the other parent being the one over which the hover object spans.
10494 * @note The hover object will take up the entire space of @p target
10497 * Elementary has the following styles for the hover widget:
10501 * @li hoversel_vertical
10503 * The following are the available position for content:
10515 * Signals that you can add callbacks for are:
10516 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10517 * @li "smart,changed" - a content object placed under the "smart"
10518 * policy was replaced to a new slot direction.
10520 * See @ref tutorial_hover for more information.
10524 typedef enum _Elm_Hover_Axis
10526 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10527 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10528 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10529 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10532 * @brief Adds a hover object to @p parent
10534 * @param parent The parent object
10535 * @return The hover object or NULL if one could not be created
10537 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10539 * @brief Sets the target object for the hover.
10541 * @param obj The hover object
10542 * @param target The object to center the hover onto. The hover
10544 * This function will cause the hover to be centered on the target object.
10546 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10548 * @brief Gets the target object for the hover.
10550 * @param obj The hover object
10551 * @param parent The object to locate the hover over.
10553 * @see elm_hover_target_set()
10555 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10557 * @brief Sets the parent object for the hover.
10559 * @param obj The hover object
10560 * @param parent The object to locate the hover over.
10562 * This function will cause the hover to take up the entire space that the
10563 * parent object fills.
10565 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10567 * @brief Gets the parent object for the hover.
10569 * @param obj The hover object
10570 * @return The parent object to locate the hover over.
10572 * @see elm_hover_parent_set()
10574 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10576 * @brief Sets the content of the hover object and the direction in which it
10579 * @param obj The hover object
10580 * @param swallow The direction that the object will be displayed
10581 * at. Accepted values are "left", "top-left", "top", "top-right",
10582 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10584 * @param content The content to place at @p swallow
10586 * Once the content object is set for a given direction, a previously
10587 * set one (on the same direction) will be deleted. If you want to
10588 * keep that old content object, use the elm_hover_content_unset()
10591 * All directions may have contents at the same time, except for
10592 * "smart". This is a special placement hint and its use case
10593 * independs of the calculations coming from
10594 * elm_hover_best_content_location_get(). Its use is for cases when
10595 * one desires only one hover content, but with a dinamic special
10596 * placement within the hover area. The content's geometry, whenever
10597 * it changes, will be used to decide on a best location not
10598 * extrapolating the hover's parent object view to show it in (still
10599 * being the hover's target determinant of its medium part -- move and
10600 * resize it to simulate finger sizes, for example). If one of the
10601 * directions other than "smart" are used, a previously content set
10602 * using it will be deleted, and vice-versa.
10604 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10606 * @brief Get the content of the hover object, in a given direction.
10608 * Return the content object which was set for this widget in the
10609 * @p swallow direction.
10611 * @param obj The hover object
10612 * @param swallow The direction that the object was display at.
10613 * @return The content that was being used
10615 * @see elm_hover_content_set()
10617 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10619 * @brief Unset the content of the hover object, in a given direction.
10621 * Unparent and return the content object set at @p swallow direction.
10623 * @param obj The hover object
10624 * @param swallow The direction that the object was display at.
10625 * @return The content that was being used.
10627 * @see elm_hover_content_set()
10629 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10631 * @brief Returns the best swallow location for content in the hover.
10633 * @param obj The hover object
10634 * @param pref_axis The preferred orientation axis for the hover object to use
10635 * @return The edje location to place content into the hover or @c
10638 * Best is defined here as the location at which there is the most available
10641 * @p pref_axis may be one of
10642 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10643 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10644 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10645 * - @c ELM_HOVER_AXIS_BOTH -- both
10647 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10648 * nescessarily be along the horizontal axis("left" or "right"). If
10649 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10650 * be along the vertical axis("top" or "bottom"). Chossing
10651 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10652 * returned position may be in either axis.
10654 * @see elm_hover_content_set()
10656 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10663 * @defgroup Entry Entry
10665 * @image html img/widget/entry/preview-00.png
10666 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10667 * @image html img/widget/entry/preview-01.png
10668 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10669 * @image html img/widget/entry/preview-02.png
10670 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10671 * @image html img/widget/entry/preview-03.png
10672 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10674 * An entry is a convenience widget which shows a box that the user can
10675 * enter text into. Entries by default don't scroll, so they grow to
10676 * accomodate the entire text, resizing the parent window as needed. This
10677 * can be changed with the elm_entry_scrollable_set() function.
10679 * They can also be single line or multi line (the default) and when set
10680 * to multi line mode they support text wrapping in any of the modes
10681 * indicated by #Elm_Wrap_Type.
10683 * Other features include password mode, filtering of inserted text with
10684 * elm_entry_text_filter_append() and related functions, inline "items" and
10685 * formatted markup text.
10687 * @section entry-markup Formatted text
10689 * The markup tags supported by the Entry are defined by the theme, but
10690 * even when writing new themes or extensions it's a good idea to stick to
10691 * a sane default, to maintain coherency and avoid application breakages.
10692 * Currently defined by the default theme are the following tags:
10693 * @li \<br\>: Inserts a line break.
10694 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10696 * @li \<tab\>: Inserts a tab.
10697 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10699 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10700 * @li \<link\>...\</link\>: Underlines the enclosed text.
10701 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10703 * @section entry-special Special markups
10705 * Besides those used to format text, entries support two special markup
10706 * tags used to insert clickable portions of text or items inlined within
10709 * @subsection entry-anchors Anchors
10711 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10712 * \</a\> tags and an event will be generated when this text is clicked,
10716 * This text is outside <a href=anc-01>but this one is an anchor</a>
10719 * The @c href attribute in the opening tag gives the name that will be
10720 * used to identify the anchor and it can be any valid utf8 string.
10722 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10723 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10724 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10725 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10728 * @subsection entry-items Items
10730 * Inlined in the text, any other @c Evas_Object can be inserted by using
10731 * \<item\> tags this way:
10734 * <item size=16x16 vsize=full href=emoticon/haha></item>
10737 * Just like with anchors, the @c href identifies each item, but these need,
10738 * in addition, to indicate their size, which is done using any one of
10739 * @c size, @c absize or @c relsize attributes. These attributes take their
10740 * value in the WxH format, where W is the width and H the height of the
10743 * @li absize: Absolute pixel size for the item. Whatever value is set will
10744 * be the item's size regardless of any scale value the object may have
10745 * been set to. The final line height will be adjusted to fit larger items.
10746 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10748 * @li relsize: Size is adjusted for the item to fit within the current
10751 * Besides their size, items are specificed a @c vsize value that affects
10752 * how their final size and position are calculated. The possible values
10754 * @li ascent: Item will be placed within the line's baseline and its
10755 * ascent. That is, the height between the line where all characters are
10756 * positioned and the highest point in the line. For @c size and @c absize
10757 * items, the descent value will be added to the total line height to make
10758 * them fit. @c relsize items will be adjusted to fit within this space.
10759 * @li full: Items will be placed between the descent and ascent, or the
10760 * lowest point in the line and its highest.
10762 * The next image shows different configurations of items and how they
10763 * are the previously mentioned options affect their sizes. In all cases,
10764 * the green line indicates the ascent, blue for the baseline and red for
10767 * @image html entry_item.png
10768 * @image latex entry_item.eps width=\textwidth
10770 * And another one to show how size differs from absize. In the first one,
10771 * the scale value is set to 1.0, while the second one is using one of 2.0.
10773 * @image html entry_item_scale.png
10774 * @image latex entry_item_scale.eps width=\textwidth
10776 * After the size for an item is calculated, the entry will request an
10777 * object to place in its space. For this, the functions set with
10778 * elm_entry_item_provider_append() and related functions will be called
10779 * in order until one of them returns a @c non-NULL value. If no providers
10780 * are available, or all of them return @c NULL, then the entry falls back
10781 * to one of the internal defaults, provided the name matches with one of
10784 * All of the following are currently supported:
10787 * - emoticon/angry-shout
10788 * - emoticon/crazy-laugh
10789 * - emoticon/evil-laugh
10791 * - emoticon/goggle-smile
10792 * - emoticon/grumpy
10793 * - emoticon/grumpy-smile
10794 * - emoticon/guilty
10795 * - emoticon/guilty-smile
10797 * - emoticon/half-smile
10798 * - emoticon/happy-panting
10800 * - emoticon/indifferent
10802 * - emoticon/knowing-grin
10804 * - emoticon/little-bit-sorry
10805 * - emoticon/love-lots
10807 * - emoticon/minimal-smile
10808 * - emoticon/not-happy
10809 * - emoticon/not-impressed
10811 * - emoticon/opensmile
10814 * - emoticon/squint-laugh
10815 * - emoticon/surprised
10816 * - emoticon/suspicious
10817 * - emoticon/tongue-dangling
10818 * - emoticon/tongue-poke
10820 * - emoticon/unhappy
10821 * - emoticon/very-sorry
10824 * - emoticon/worried
10827 * Alternatively, an item may reference an image by its path, using
10828 * the URI form @c file:///path/to/an/image.png and the entry will then
10829 * use that image for the item.
10831 * @section entry-files Loading and saving files
10833 * Entries have convinience functions to load text from a file and save
10834 * changes back to it after a short delay. The automatic saving is enabled
10835 * by default, but can be disabled with elm_entry_autosave_set() and files
10836 * can be loaded directly as plain text or have any markup in them
10837 * recognized. See elm_entry_file_set() for more details.
10839 * @section entry-signals Emitted signals
10841 * This widget emits the following signals:
10843 * @li "changed": The text within the entry was changed.
10844 * @li "changed,user": The text within the entry was changed because of user interaction.
10845 * @li "activated": The enter key was pressed on a single line entry.
10846 * @li "press": A mouse button has been pressed on the entry.
10847 * @li "longpressed": A mouse button has been pressed and held for a couple
10849 * @li "clicked": The entry has been clicked (mouse press and release).
10850 * @li "clicked,double": The entry has been double clicked.
10851 * @li "clicked,triple": The entry has been triple clicked.
10852 * @li "focused": The entry has received focus.
10853 * @li "unfocused": The entry has lost focus.
10854 * @li "selection,paste": A paste of the clipboard contents was requested.
10855 * @li "selection,copy": A copy of the selected text into the clipboard was
10857 * @li "selection,cut": A cut of the selected text into the clipboard was
10859 * @li "selection,start": A selection has begun and no previous selection
10861 * @li "selection,changed": The current selection has changed.
10862 * @li "selection,cleared": The current selection has been cleared.
10863 * @li "cursor,changed": The cursor has changed position.
10864 * @li "anchor,clicked": An anchor has been clicked. The event_info
10865 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10866 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10867 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10868 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10869 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10870 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10871 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10872 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10873 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10874 * @li "preedit,changed": The preedit string has changed.
10875 * @li "language,changed": Program language changed.
10877 * @section entry-examples
10879 * An overview of the Entry API can be seen in @ref entry_example_01
10884 * @typedef Elm_Entry_Anchor_Info
10886 * The info sent in the callback for the "anchor,clicked" signals emitted
10889 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10891 * @struct _Elm_Entry_Anchor_Info
10893 * The info sent in the callback for the "anchor,clicked" signals emitted
10896 struct _Elm_Entry_Anchor_Info
10898 const char *name; /**< The name of the anchor, as stated in its href */
10899 int button; /**< The mouse button used to click on it */
10900 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10901 y, /**< Anchor geometry, relative to canvas */
10902 w, /**< Anchor geometry, relative to canvas */
10903 h; /**< Anchor geometry, relative to canvas */
10906 * @typedef Elm_Entry_Filter_Cb
10907 * This callback type is used by entry filters to modify text.
10908 * @param data The data specified as the last param when adding the filter
10909 * @param entry The entry object
10910 * @param text A pointer to the location of the text being filtered. This data can be modified,
10911 * but any additional allocations must be managed by the user.
10912 * @see elm_entry_text_filter_append
10913 * @see elm_entry_text_filter_prepend
10915 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10918 * This adds an entry to @p parent object.
10920 * By default, entries are:
10924 * @li autosave is enabled
10926 * @param parent The parent object
10927 * @return The new object or NULL if it cannot be created
10929 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10931 * Sets the entry to single line mode.
10933 * In single line mode, entries don't ever wrap when the text reaches the
10934 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10935 * key will generate an @c "activate" event instead of adding a new line.
10937 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10938 * and pressing enter will break the text into a different line
10939 * without generating any events.
10941 * @param obj The entry object
10942 * @param single_line If true, the text in the entry
10943 * will be on a single line.
10945 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10947 * Gets whether the entry is set to be single line.
10949 * @param obj The entry object
10950 * @return single_line If true, the text in the entry is set to display
10951 * on a single line.
10953 * @see elm_entry_single_line_set()
10955 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10957 * Sets the entry to password mode.
10959 * In password mode, entries are implicitly single line and the display of
10960 * any text in them is replaced with asterisks (*).
10962 * @param obj The entry object
10963 * @param password If true, password mode is enabled.
10965 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10967 * Gets whether the entry is set to password mode.
10969 * @param obj The entry object
10970 * @return If true, the entry is set to display all characters
10971 * as asterisks (*).
10973 * @see elm_entry_password_set()
10975 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10977 * This sets the text displayed within the entry to @p entry.
10979 * @param obj The entry object
10980 * @param entry The text to be displayed
10982 * @deprecated Use elm_object_text_set() instead.
10983 * @note Using this function bypasses text filters
10985 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10987 * This returns the text currently shown in object @p entry.
10988 * See also elm_entry_entry_set().
10990 * @param obj The entry object
10991 * @return The currently displayed text or NULL on failure
10993 * @deprecated Use elm_object_text_get() instead.
10995 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10997 * Appends @p entry to the text of the entry.
10999 * Adds the text in @p entry to the end of any text already present in the
11002 * The appended text is subject to any filters set for the widget.
11004 * @param obj The entry object
11005 * @param entry The text to be displayed
11007 * @see elm_entry_text_filter_append()
11009 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11011 * Gets whether the entry is empty.
11013 * Empty means no text at all. If there are any markup tags, like an item
11014 * tag for which no provider finds anything, and no text is displayed, this
11015 * function still returns EINA_FALSE.
11017 * @param obj The entry object
11018 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11020 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * Gets any selected text within the entry.
11024 * If there's any selected text in the entry, this function returns it as
11025 * a string in markup format. NULL is returned if no selection exists or
11026 * if an error occurred.
11028 * The returned value points to an internal string and should not be freed
11029 * or modified in any way. If the @p entry object is deleted or its
11030 * contents are changed, the returned pointer should be considered invalid.
11032 * @param obj The entry object
11033 * @return The selected text within the entry or NULL on failure
11035 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11037 * Inserts the given text into the entry at the current cursor position.
11039 * This inserts text at the cursor position as if it was typed
11040 * by the user (note that this also allows markup which a user
11041 * can't just "type" as it would be converted to escaped text, so this
11042 * call can be used to insert things like emoticon items or bold push/pop
11043 * tags, other font and color change tags etc.)
11045 * If any selection exists, it will be replaced by the inserted text.
11047 * The inserted text is subject to any filters set for the widget.
11049 * @param obj The entry object
11050 * @param entry The text to insert
11052 * @see elm_entry_text_filter_append()
11054 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11056 * Set the line wrap type to use on multi-line entries.
11058 * Sets the wrap type used by the entry to any of the specified in
11059 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11060 * line (without inserting a line break or paragraph separator) when it
11061 * reaches the far edge of the widget.
11063 * Note that this only makes sense for multi-line entries. A widget set
11064 * to be single line will never wrap.
11066 * @param obj The entry object
11067 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11069 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11070 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11072 * Gets the wrap mode the entry was set to use.
11074 * @param obj The entry object
11075 * @return Wrap type
11077 * @see also elm_entry_line_wrap_set()
11079 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11081 * Sets if the entry is to be editable or not.
11083 * By default, entries are editable and when focused, any text input by the
11084 * user will be inserted at the current cursor position. But calling this
11085 * function with @p editable as EINA_FALSE will prevent the user from
11086 * inputting text into the entry.
11088 * The only way to change the text of a non-editable entry is to use
11089 * elm_object_text_set(), elm_entry_entry_insert() and other related
11092 * @param obj The entry object
11093 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11094 * if not, the entry is read-only and no user input is allowed.
11096 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11098 * Gets whether the entry is editable or not.
11100 * @param obj The entry object
11101 * @return If true, the entry is editable by the user.
11102 * If false, it is not editable by the user
11104 * @see elm_entry_editable_set()
11106 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11108 * This drops any existing text selection within the entry.
11110 * @param obj The entry object
11112 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11114 * This selects all text within the entry.
11116 * @param obj The entry object
11118 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11120 * This moves the cursor one place to the right within the entry.
11122 * @param obj The entry object
11123 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11125 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11127 * This moves the cursor one place to the left within the entry.
11129 * @param obj The entry object
11130 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11132 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11134 * This moves the cursor one line up within the entry.
11136 * @param obj The entry object
11137 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11139 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11141 * This moves the cursor one line down within the entry.
11143 * @param obj The entry object
11144 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11146 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11148 * This moves the cursor to the beginning of the entry.
11150 * @param obj The entry object
11152 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11154 * This moves the cursor to the end of the entry.
11156 * @param obj The entry object
11158 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11160 * This moves the cursor to the beginning of the current line.
11162 * @param obj The entry object
11164 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11166 * This moves the cursor to the end of the current line.
11168 * @param obj The entry object
11170 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11172 * This begins a selection within the entry as though
11173 * the user were holding down the mouse button to make a selection.
11175 * @param obj The entry object
11177 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11179 * This ends a selection within the entry as though
11180 * the user had just released the mouse button while making a selection.
11182 * @param obj The entry object
11184 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11186 * Gets whether a format node exists at the current cursor position.
11188 * A format node is anything that defines how the text is rendered. It can
11189 * be a visible format node, such as a line break or a paragraph separator,
11190 * or an invisible one, such as bold begin or end tag.
11191 * This function returns whether any format node exists at the current
11194 * @param obj The entry object
11195 * @return EINA_TRUE if the current cursor position contains a format node,
11196 * EINA_FALSE otherwise.
11198 * @see elm_entry_cursor_is_visible_format_get()
11200 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11202 * Gets if the current cursor position holds a visible format node.
11204 * @param obj The entry object
11205 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11206 * if it's an invisible one or no format exists.
11208 * @see elm_entry_cursor_is_format_get()
11210 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11212 * Gets the character pointed by the cursor at its current position.
11214 * This function returns a string with the utf8 character stored at the
11215 * current cursor position.
11216 * Only the text is returned, any format that may exist will not be part
11217 * of the return value.
11219 * @param obj The entry object
11220 * @return The text pointed by the cursors.
11222 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11224 * This function returns the geometry of the cursor.
11226 * It's useful if you want to draw something on the cursor (or where it is),
11227 * or for example in the case of scrolled entry where you want to show the
11230 * @param obj The entry object
11231 * @param x returned geometry
11232 * @param y returned geometry
11233 * @param w returned geometry
11234 * @param h returned geometry
11235 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11237 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);
11239 * Sets the cursor position in the entry to the given value
11241 * The value in @p pos is the index of the character position within the
11242 * contents of the string as returned by elm_entry_cursor_pos_get().
11244 * @param obj The entry object
11245 * @param pos The position of the cursor
11247 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11249 * Retrieves the current position of the cursor in the entry
11251 * @param obj The entry object
11252 * @return The cursor position
11254 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11256 * This executes a "cut" action on the selected text in the entry.
11258 * @param obj The entry object
11260 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11262 * This executes a "copy" action on the selected text in the entry.
11264 * @param obj The entry object
11266 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11268 * This executes a "paste" action in the entry.
11270 * @param obj The entry object
11272 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11274 * This clears and frees the items in a entry's contextual (longpress)
11277 * @param obj The entry object
11279 * @see elm_entry_context_menu_item_add()
11281 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11283 * This adds an item to the entry's contextual menu.
11285 * A longpress on an entry will make the contextual menu show up, if this
11286 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11287 * By default, this menu provides a few options like enabling selection mode,
11288 * which is useful on embedded devices that need to be explicit about it,
11289 * and when a selection exists it also shows the copy and cut actions.
11291 * With this function, developers can add other options to this menu to
11292 * perform any action they deem necessary.
11294 * @param obj The entry object
11295 * @param label The item's text label
11296 * @param icon_file The item's icon file
11297 * @param icon_type The item's icon type
11298 * @param func The callback to execute when the item is clicked
11299 * @param data The data to associate with the item for related functions
11301 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);
11303 * This disables the entry's contextual (longpress) menu.
11305 * @param obj The entry object
11306 * @param disabled If true, the menu is disabled
11308 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11310 * This returns whether the entry's contextual (longpress) menu is
11313 * @param obj The entry object
11314 * @return If true, the menu is disabled
11316 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11318 * This appends a custom item provider to the list for that entry
11320 * This appends the given callback. The list is walked from beginning to end
11321 * with each function called given the item href string in the text. If the
11322 * function returns an object handle other than NULL (it should create an
11323 * object to do this), then this object is used to replace that item. If
11324 * not the next provider is called until one provides an item object, or the
11325 * default provider in entry does.
11327 * @param obj The entry object
11328 * @param func The function called to provide the item object
11329 * @param data The data passed to @p func
11331 * @see @ref entry-items
11333 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);
11335 * This prepends a custom item provider to the list for that entry
11337 * This prepends the given callback. See elm_entry_item_provider_append() for
11340 * @param obj The entry object
11341 * @param func The function called to provide the item object
11342 * @param data The data passed to @p func
11344 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);
11346 * This removes a custom item provider to the list for that entry
11348 * This removes the given callback. See elm_entry_item_provider_append() for
11351 * @param obj The entry object
11352 * @param func The function called to provide the item object
11353 * @param data The data passed to @p func
11355 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);
11357 * Append a filter function for text inserted in the entry
11359 * Append the given callback to the list. This functions will be called
11360 * whenever any text is inserted into the entry, with the text to be inserted
11361 * as a parameter. The callback function is free to alter the text in any way
11362 * it wants, but it must remember to free the given pointer and update it.
11363 * If the new text is to be discarded, the function can free it and set its
11364 * text parameter to NULL. This will also prevent any following filters from
11367 * @param obj The entry object
11368 * @param func The function to use as text filter
11369 * @param data User data to pass to @p func
11371 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11373 * Prepend a filter function for text insdrted in the entry
11375 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11376 * for more information
11378 * @param obj The entry object
11379 * @param func The function to use as text filter
11380 * @param data User data to pass to @p func
11382 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11384 * Remove a filter from the list
11386 * Removes the given callback from the filter list. See
11387 * elm_entry_text_filter_append() for more information.
11389 * @param obj The entry object
11390 * @param func The filter function to remove
11391 * @param data The user data passed when adding the function
11393 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11395 * This converts a markup (HTML-like) string into UTF-8.
11397 * The returned string is a malloc'ed buffer and it should be freed when
11398 * not needed anymore.
11400 * @param s The string (in markup) to be converted
11401 * @return The converted string (in UTF-8). It should be freed.
11403 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11405 * This converts a UTF-8 string into markup (HTML-like).
11407 * The returned string is a malloc'ed buffer and it should be freed when
11408 * not needed anymore.
11410 * @param s The string (in UTF-8) to be converted
11411 * @return The converted string (in markup). It should be freed.
11413 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11415 * This sets the file (and implicitly loads it) for the text to display and
11416 * then edit. All changes are written back to the file after a short delay if
11417 * the entry object is set to autosave (which is the default).
11419 * If the entry had any other file set previously, any changes made to it
11420 * will be saved if the autosave feature is enabled, otherwise, the file
11421 * will be silently discarded and any non-saved changes will be lost.
11423 * @param obj The entry object
11424 * @param file The path to the file to load and save
11425 * @param format The file format
11427 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11429 * Gets the file being edited by the entry.
11431 * This function can be used to retrieve any file set on the entry for
11432 * edition, along with the format used to load and save it.
11434 * @param obj The entry object
11435 * @param file The path to the file to load and save
11436 * @param format The file format
11438 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11440 * This function writes any changes made to the file set with
11441 * elm_entry_file_set()
11443 * @param obj The entry object
11445 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11447 * This sets the entry object to 'autosave' the loaded text file or not.
11449 * @param obj The entry object
11450 * @param autosave Autosave the loaded file or not
11452 * @see elm_entry_file_set()
11454 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11456 * This gets the entry object's 'autosave' status.
11458 * @param obj The entry object
11459 * @return Autosave the loaded file or not
11461 * @see elm_entry_file_set()
11463 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11465 * Control pasting of text and images for the widget.
11467 * Normally the entry allows both text and images to be pasted. By setting
11468 * textonly to be true, this prevents images from being pasted.
11470 * Note this only changes the behaviour of text.
11472 * @param obj The entry object
11473 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11474 * text+image+other.
11476 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11478 * Getting elm_entry text paste/drop mode.
11480 * In textonly mode, only text may be pasted or dropped into the widget.
11482 * @param obj The entry object
11483 * @return If the widget only accepts text from pastes.
11485 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11487 * Enable or disable scrolling in entry
11489 * Normally the entry is not scrollable unless you enable it with this call.
11491 * @param obj The entry object
11492 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11494 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11496 * Get the scrollable state of the entry
11498 * Normally the entry is not scrollable. This gets the scrollable state
11499 * of the entry. See elm_entry_scrollable_set() for more information.
11501 * @param obj The entry object
11502 * @return The scrollable state
11504 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11506 * This sets a widget to be displayed to the left of a scrolled entry.
11508 * @param obj The scrolled entry object
11509 * @param icon The widget to display on the left side of the scrolled
11512 * @note A previously set widget will be destroyed.
11513 * @note If the object being set does not have minimum size hints set,
11514 * it won't get properly displayed.
11516 * @see elm_entry_end_set()
11518 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11520 * Gets the leftmost widget of the scrolled entry. This object is
11521 * owned by the scrolled entry and should not be modified.
11523 * @param obj The scrolled entry object
11524 * @return the left widget inside the scroller
11526 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11528 * Unset the leftmost widget of the scrolled entry, unparenting and
11531 * @param obj The scrolled entry object
11532 * @return the previously set icon sub-object of this entry, on
11535 * @see elm_entry_icon_set()
11537 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11539 * Sets the visibility of the left-side widget of the scrolled entry,
11540 * set by elm_entry_icon_set().
11542 * @param obj The scrolled entry object
11543 * @param setting EINA_TRUE if the object should be displayed,
11544 * EINA_FALSE if not.
11546 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11548 * This sets a widget to be displayed to the end of a scrolled entry.
11550 * @param obj The scrolled entry object
11551 * @param end The widget to display on the right side of the scrolled
11554 * @note A previously set widget will be destroyed.
11555 * @note If the object being set does not have minimum size hints set,
11556 * it won't get properly displayed.
11558 * @see elm_entry_icon_set
11560 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11562 * Gets the endmost widget of the scrolled entry. This object is owned
11563 * by the scrolled entry and should not be modified.
11565 * @param obj The scrolled entry object
11566 * @return the right widget inside the scroller
11568 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11570 * Unset the endmost widget of the scrolled entry, unparenting and
11573 * @param obj The scrolled entry object
11574 * @return the previously set icon sub-object of this entry, on
11577 * @see elm_entry_icon_set()
11579 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11581 * Sets the visibility of the end widget of the scrolled entry, set by
11582 * elm_entry_end_set().
11584 * @param obj The scrolled entry object
11585 * @param setting EINA_TRUE if the object should be displayed,
11586 * EINA_FALSE if not.
11588 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11590 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11593 * Setting an entry to single-line mode with elm_entry_single_line_set()
11594 * will automatically disable the display of scrollbars when the entry
11595 * moves inside its scroller.
11597 * @param obj The scrolled entry object
11598 * @param h The horizontal scrollbar policy to apply
11599 * @param v The vertical scrollbar policy to apply
11601 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11603 * This enables/disables bouncing within the entry.
11605 * This function sets whether the entry will bounce when scrolling reaches
11606 * the end of the contained entry.
11608 * @param obj The scrolled entry object
11609 * @param h The horizontal bounce state
11610 * @param v The vertical bounce state
11612 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11614 * Get the bounce mode
11616 * @param obj The Entry object
11617 * @param h_bounce Allow bounce horizontally
11618 * @param v_bounce Allow bounce vertically
11620 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11622 /* pre-made filters for entries */
11624 * @typedef Elm_Entry_Filter_Limit_Size
11626 * Data for the elm_entry_filter_limit_size() entry filter.
11628 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11630 * @struct _Elm_Entry_Filter_Limit_Size
11632 * Data for the elm_entry_filter_limit_size() entry filter.
11634 struct _Elm_Entry_Filter_Limit_Size
11636 int max_char_count; /**< The maximum number of characters allowed. */
11637 int max_byte_count; /**< The maximum number of bytes allowed*/
11640 * Filter inserted text based on user defined character and byte limits
11642 * Add this filter to an entry to limit the characters that it will accept
11643 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11644 * The funtion works on the UTF-8 representation of the string, converting
11645 * it from the set markup, thus not accounting for any format in it.
11647 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11648 * it as data when setting the filter. In it, it's possible to set limits
11649 * by character count or bytes (any of them is disabled if 0), and both can
11650 * be set at the same time. In that case, it first checks for characters,
11653 * The function will cut the inserted text in order to allow only the first
11654 * number of characters that are still allowed. The cut is made in
11655 * characters, even when limiting by bytes, in order to always contain
11656 * valid ones and avoid half unicode characters making it in.
11658 * This filter, like any others, does not apply when setting the entry text
11659 * directly with elm_object_text_set() (or the deprecated
11660 * elm_entry_entry_set()).
11662 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11664 * @typedef Elm_Entry_Filter_Accept_Set
11666 * Data for the elm_entry_filter_accept_set() entry filter.
11668 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11670 * @struct _Elm_Entry_Filter_Accept_Set
11672 * Data for the elm_entry_filter_accept_set() entry filter.
11674 struct _Elm_Entry_Filter_Accept_Set
11676 const char *accepted; /**< Set of characters accepted in the entry. */
11677 const char *rejected; /**< Set of characters rejected from the entry. */
11680 * Filter inserted text based on accepted or rejected sets of characters
11682 * Add this filter to an entry to restrict the set of accepted characters
11683 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11684 * This structure contains both accepted and rejected sets, but they are
11685 * mutually exclusive.
11687 * The @c accepted set takes preference, so if it is set, the filter will
11688 * only work based on the accepted characters, ignoring anything in the
11689 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11691 * In both cases, the function filters by matching utf8 characters to the
11692 * raw markup text, so it can be used to remove formatting tags.
11694 * This filter, like any others, does not apply when setting the entry text
11695 * directly with elm_object_text_set() (or the deprecated
11696 * elm_entry_entry_set()).
11698 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11700 * Set the input panel layout of the entry
11702 * @param obj The entry object
11703 * @param layout layout type
11705 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11707 * Get the input panel layout of the entry
11709 * @param obj The entry object
11710 * @return layout type
11712 * @see elm_entry_input_panel_layout_set
11714 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11716 * Set the autocapitalization type on the immodule.
11718 * @param obj The entry object
11719 * @param autocapital_type The type of autocapitalization
11721 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11723 * Retrieve the autocapitalization type on the immodule.
11725 * @param obj The entry object
11726 * @return autocapitalization type
11728 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11730 * Sets the attribute to show the input panel automatically.
11732 * @param obj The entry object
11733 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11735 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11737 * Retrieve the attribute to show the input panel automatically.
11739 * @param obj The entry object
11740 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11742 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11744 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11745 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11746 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11747 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11748 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11749 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11750 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11752 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11753 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11754 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11755 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11756 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11762 /* composite widgets - these basically put together basic widgets above
11763 * in convenient packages that do more than basic stuff */
11767 * @defgroup Anchorview Anchorview
11769 * @image html img/widget/anchorview/preview-00.png
11770 * @image latex img/widget/anchorview/preview-00.eps
11772 * Anchorview is for displaying text that contains markup with anchors
11773 * like <c>\<a href=1234\>something\</\></c> in it.
11775 * Besides being styled differently, the anchorview widget provides the
11776 * necessary functionality so that clicking on these anchors brings up a
11777 * popup with user defined content such as "call", "add to contacts" or
11778 * "open web page". This popup is provided using the @ref Hover widget.
11780 * This widget is very similar to @ref Anchorblock, so refer to that
11781 * widget for an example. The only difference Anchorview has is that the
11782 * widget is already provided with scrolling functionality, so if the
11783 * text set to it is too large to fit in the given space, it will scroll,
11784 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11785 * text can be displayed.
11787 * This widget emits the following signals:
11788 * @li "anchor,clicked": will be called when an anchor is clicked. The
11789 * @p event_info parameter on the callback will be a pointer of type
11790 * ::Elm_Entry_Anchorview_Info.
11792 * See @ref Anchorblock for an example on how to use both of them.
11801 * @typedef Elm_Entry_Anchorview_Info
11803 * The info sent in the callback for "anchor,clicked" signals emitted by
11804 * the Anchorview widget.
11806 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11808 * @struct _Elm_Entry_Anchorview_Info
11810 * The info sent in the callback for "anchor,clicked" signals emitted by
11811 * the Anchorview widget.
11813 struct _Elm_Entry_Anchorview_Info
11815 const char *name; /**< Name of the anchor, as indicated in its href
11817 int button; /**< The mouse button used to click on it */
11818 Evas_Object *hover; /**< The hover object to use for the popup */
11820 Evas_Coord x, y, w, h;
11821 } anchor, /**< Geometry selection of text used as anchor */
11822 hover_parent; /**< Geometry of the object used as parent by the
11824 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11825 for content on the left side of
11826 the hover. Before calling the
11827 callback, the widget will make the
11828 necessary calculations to check
11829 which sides are fit to be set with
11830 content, based on the position the
11831 hover is activated and its distance
11832 to the edges of its parent object
11834 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11835 the right side of the hover.
11836 See @ref hover_left */
11837 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11838 of the hover. See @ref hover_left */
11839 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11840 below the hover. See @ref
11844 * Add a new Anchorview object
11846 * @param parent The parent object
11847 * @return The new object or NULL if it cannot be created
11849 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11851 * Set the text to show in the anchorview
11853 * Sets the text of the anchorview to @p text. This text can include markup
11854 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11855 * text that will be specially styled and react to click events, ended with
11856 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11857 * "anchor,clicked" signal that you can attach a callback to with
11858 * evas_object_smart_callback_add(). The name of the anchor given in the
11859 * event info struct will be the one set in the href attribute, in this
11860 * case, anchorname.
11862 * Other markup can be used to style the text in different ways, but it's
11863 * up to the style defined in the theme which tags do what.
11864 * @deprecated use elm_object_text_set() instead.
11866 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11868 * Get the markup text set for the anchorview
11870 * Retrieves the text set on the anchorview, with markup tags included.
11872 * @param obj The anchorview object
11873 * @return The markup text set or @c NULL if nothing was set or an error
11875 * @deprecated use elm_object_text_set() instead.
11877 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11879 * Set the parent of the hover popup
11881 * Sets the parent object to use by the hover created by the anchorview
11882 * when an anchor is clicked. See @ref Hover for more details on this.
11883 * If no parent is set, the same anchorview object will be used.
11885 * @param obj The anchorview object
11886 * @param parent The object to use as parent for the hover
11888 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11890 * Get the parent of the hover popup
11892 * Get the object used as parent for the hover created by the anchorview
11893 * widget. See @ref Hover for more details on this.
11895 * @param obj The anchorview object
11896 * @return The object used as parent for the hover, NULL if none is set.
11898 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11900 * Set the style that the hover should use
11902 * When creating the popup hover, anchorview will request that it's
11903 * themed according to @p style.
11905 * @param obj The anchorview object
11906 * @param style The style to use for the underlying hover
11908 * @see elm_object_style_set()
11910 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11912 * Get the style that the hover should use
11914 * Get the style the hover created by anchorview will use.
11916 * @param obj The anchorview object
11917 * @return The style to use by the hover. NULL means the default is used.
11919 * @see elm_object_style_set()
11921 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11923 * Ends the hover popup in the anchorview
11925 * When an anchor is clicked, the anchorview widget will create a hover
11926 * object to use as a popup with user provided content. This function
11927 * terminates this popup, returning the anchorview to its normal state.
11929 * @param obj The anchorview object
11931 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11933 * Set bouncing behaviour when the scrolled content reaches an edge
11935 * Tell the internal scroller object whether it should bounce or not
11936 * when it reaches the respective edges for each axis.
11938 * @param obj The anchorview object
11939 * @param h_bounce Whether to bounce or not in the horizontal axis
11940 * @param v_bounce Whether to bounce or not in the vertical axis
11942 * @see elm_scroller_bounce_set()
11944 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11946 * Get the set bouncing behaviour of the internal scroller
11948 * Get whether the internal scroller should bounce when the edge of each
11949 * axis is reached scrolling.
11951 * @param obj The anchorview object
11952 * @param h_bounce Pointer where to store the bounce state of the horizontal
11954 * @param v_bounce Pointer where to store the bounce state of the vertical
11957 * @see elm_scroller_bounce_get()
11959 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11961 * Appends a custom item provider to the given anchorview
11963 * Appends the given function to the list of items providers. This list is
11964 * called, one function at a time, with the given @p data pointer, the
11965 * anchorview object and, in the @p item parameter, the item name as
11966 * referenced in its href string. Following functions in the list will be
11967 * called in order until one of them returns something different to NULL,
11968 * which should be an Evas_Object which will be used in place of the item
11971 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11972 * href=item/name\>\</item\>
11974 * @param obj The anchorview object
11975 * @param func The function to add to the list of providers
11976 * @param data User data that will be passed to the callback function
11978 * @see elm_entry_item_provider_append()
11980 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);
11982 * Prepend a custom item provider to the given anchorview
11984 * Like elm_anchorview_item_provider_append(), but it adds the function
11985 * @p func to the beginning of the list, instead of the end.
11987 * @param obj The anchorview object
11988 * @param func The function to add to the list of providers
11989 * @param data User data that will be passed to the callback function
11991 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);
11993 * Remove a custom item provider from the list of the given anchorview
11995 * Removes the function and data pairing that matches @p func and @p data.
11996 * That is, unless the same function and same user data are given, the
11997 * function will not be removed from the list. This allows us to add the
11998 * same callback several times, with different @p data pointers and be
11999 * able to remove them later without conflicts.
12001 * @param obj The anchorview object
12002 * @param func The function to remove from the list
12003 * @param data The data matching the function to remove from the list
12005 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);
12012 * @defgroup Anchorblock Anchorblock
12014 * @image html img/widget/anchorblock/preview-00.png
12015 * @image latex img/widget/anchorblock/preview-00.eps
12017 * Anchorblock is for displaying text that contains markup with anchors
12018 * like <c>\<a href=1234\>something\</\></c> in it.
12020 * Besides being styled differently, the anchorblock widget provides the
12021 * necessary functionality so that clicking on these anchors brings up a
12022 * popup with user defined content such as "call", "add to contacts" or
12023 * "open web page". This popup is provided using the @ref Hover widget.
12025 * This widget emits the following signals:
12026 * @li "anchor,clicked": will be called when an anchor is clicked. The
12027 * @p event_info parameter on the callback will be a pointer of type
12028 * ::Elm_Entry_Anchorblock_Info.
12034 * Since examples are usually better than plain words, we might as well
12035 * try @ref tutorial_anchorblock_example "one".
12038 * @addtogroup Anchorblock
12042 * @typedef Elm_Entry_Anchorblock_Info
12044 * The info sent in the callback for "anchor,clicked" signals emitted by
12045 * the Anchorblock widget.
12047 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12049 * @struct _Elm_Entry_Anchorblock_Info
12051 * The info sent in the callback for "anchor,clicked" signals emitted by
12052 * the Anchorblock widget.
12054 struct _Elm_Entry_Anchorblock_Info
12056 const char *name; /**< Name of the anchor, as indicated in its href
12058 int button; /**< The mouse button used to click on it */
12059 Evas_Object *hover; /**< The hover object to use for the popup */
12061 Evas_Coord x, y, w, h;
12062 } anchor, /**< Geometry selection of text used as anchor */
12063 hover_parent; /**< Geometry of the object used as parent by the
12065 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12066 for content on the left side of
12067 the hover. Before calling the
12068 callback, the widget will make the
12069 necessary calculations to check
12070 which sides are fit to be set with
12071 content, based on the position the
12072 hover is activated and its distance
12073 to the edges of its parent object
12075 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12076 the right side of the hover.
12077 See @ref hover_left */
12078 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12079 of the hover. See @ref hover_left */
12080 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12081 below the hover. See @ref
12085 * Add a new Anchorblock object
12087 * @param parent The parent object
12088 * @return The new object or NULL if it cannot be created
12090 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12092 * Set the text to show in the anchorblock
12094 * Sets the text of the anchorblock to @p text. This text can include markup
12095 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12096 * of text that will be specially styled and react to click events, ended
12097 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12098 * "anchor,clicked" signal that you can attach a callback to with
12099 * evas_object_smart_callback_add(). The name of the anchor given in the
12100 * event info struct will be the one set in the href attribute, in this
12101 * case, anchorname.
12103 * Other markup can be used to style the text in different ways, but it's
12104 * up to the style defined in the theme which tags do what.
12105 * @deprecated use elm_object_text_set() instead.
12107 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12109 * Get the markup text set for the anchorblock
12111 * Retrieves the text set on the anchorblock, with markup tags included.
12113 * @param obj The anchorblock object
12114 * @return The markup text set or @c NULL if nothing was set or an error
12116 * @deprecated use elm_object_text_set() instead.
12118 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12120 * Set the parent of the hover popup
12122 * Sets the parent object to use by the hover created by the anchorblock
12123 * when an anchor is clicked. See @ref Hover for more details on this.
12125 * @param obj The anchorblock object
12126 * @param parent The object to use as parent for the hover
12128 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12130 * Get the parent of the hover popup
12132 * Get the object used as parent for the hover created by the anchorblock
12133 * widget. See @ref Hover for more details on this.
12134 * If no parent is set, the same anchorblock object will be used.
12136 * @param obj The anchorblock object
12137 * @return The object used as parent for the hover, NULL if none is set.
12139 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12141 * Set the style that the hover should use
12143 * When creating the popup hover, anchorblock will request that it's
12144 * themed according to @p style.
12146 * @param obj The anchorblock object
12147 * @param style The style to use for the underlying hover
12149 * @see elm_object_style_set()
12151 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12153 * Get the style that the hover should use
12155 * Get the style, the hover created by anchorblock will use.
12157 * @param obj The anchorblock object
12158 * @return The style to use by the hover. NULL means the default is used.
12160 * @see elm_object_style_set()
12162 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12164 * Ends the hover popup in the anchorblock
12166 * When an anchor is clicked, the anchorblock widget will create a hover
12167 * object to use as a popup with user provided content. This function
12168 * terminates this popup, returning the anchorblock to its normal state.
12170 * @param obj The anchorblock object
12172 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12174 * Appends a custom item provider to the given anchorblock
12176 * Appends the given function to the list of items providers. This list is
12177 * called, one function at a time, with the given @p data pointer, the
12178 * anchorblock object and, in the @p item parameter, the item name as
12179 * referenced in its href string. Following functions in the list will be
12180 * called in order until one of them returns something different to NULL,
12181 * which should be an Evas_Object which will be used in place of the item
12184 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12185 * href=item/name\>\</item\>
12187 * @param obj The anchorblock object
12188 * @param func The function to add to the list of providers
12189 * @param data User data that will be passed to the callback function
12191 * @see elm_entry_item_provider_append()
12193 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);
12195 * Prepend a custom item provider to the given anchorblock
12197 * Like elm_anchorblock_item_provider_append(), but it adds the function
12198 * @p func to the beginning of the list, instead of the end.
12200 * @param obj The anchorblock object
12201 * @param func The function to add to the list of providers
12202 * @param data User data that will be passed to the callback function
12204 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);
12206 * Remove a custom item provider from the list of the given anchorblock
12208 * Removes the function and data pairing that matches @p func and @p data.
12209 * That is, unless the same function and same user data are given, the
12210 * function will not be removed from the list. This allows us to add the
12211 * same callback several times, with different @p data pointers and be
12212 * able to remove them later without conflicts.
12214 * @param obj The anchorblock object
12215 * @param func The function to remove from the list
12216 * @param data The data matching the function to remove from the list
12218 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);
12224 * @defgroup Bubble Bubble
12226 * @image html img/widget/bubble/preview-00.png
12227 * @image latex img/widget/bubble/preview-00.eps
12228 * @image html img/widget/bubble/preview-01.png
12229 * @image latex img/widget/bubble/preview-01.eps
12230 * @image html img/widget/bubble/preview-02.png
12231 * @image latex img/widget/bubble/preview-02.eps
12233 * @brief The Bubble is a widget to show text similar to how speech is
12234 * represented in comics.
12236 * The bubble widget contains 5 important visual elements:
12237 * @li The frame is a rectangle with rounded edjes and an "arrow".
12238 * @li The @p icon is an image to which the frame's arrow points to.
12239 * @li The @p label is a text which appears to the right of the icon if the
12240 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12242 * @li The @p info is a text which appears to the right of the label. Info's
12243 * font is of a ligther color than label.
12244 * @li The @p content is an evas object that is shown inside the frame.
12246 * The position of the arrow, icon, label and info depends on which corner is
12247 * selected. The four available corners are:
12248 * @li "top_left" - Default
12250 * @li "bottom_left"
12251 * @li "bottom_right"
12253 * Signals that you can add callbacks for are:
12254 * @li "clicked" - This is called when a user has clicked the bubble.
12256 * Default contents parts of the bubble that you can use for are:
12257 * @li "default" - A content of the bubble
12258 * @li "icon" - An icon of the bubble
12260 * Default text parts of the button widget that you can use for are:
12261 * @li NULL - Label of the bubble
12263 * For an example of using a buble see @ref bubble_01_example_page "this".
12269 * Add a new bubble to the parent
12271 * @param parent The parent object
12272 * @return The new object or NULL if it cannot be created
12274 * This function adds a text bubble to the given parent evas object.
12276 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12278 * Set the label of the bubble
12280 * @param obj The bubble object
12281 * @param label The string to set in the label
12283 * This function sets the title of the bubble. Where this appears depends on
12284 * the selected corner.
12285 * @deprecated use elm_object_text_set() instead.
12287 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12289 * Get the label of the bubble
12291 * @param obj The bubble object
12292 * @return The string of set in the label
12294 * This function gets the title of the bubble.
12295 * @deprecated use elm_object_text_get() instead.
12297 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12299 * Set the info of the bubble
12301 * @param obj The bubble object
12302 * @param info The given info about the bubble
12304 * This function sets the info of the bubble. Where this appears depends on
12305 * the selected corner.
12306 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12308 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12310 * Get the info of the bubble
12312 * @param obj The bubble object
12314 * @return The "info" string of the bubble
12316 * This function gets the info text.
12317 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12319 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12321 * Set the content to be shown in the bubble
12323 * Once the content object is set, a previously set one will be deleted.
12324 * If you want to keep the old content object, use the
12325 * elm_bubble_content_unset() function.
12327 * @param obj The bubble object
12328 * @param content The given content of the bubble
12330 * This function sets the content shown on the middle of the bubble.
12332 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12334 * Get the content shown in the bubble
12336 * Return the content object which is set for this widget.
12338 * @param obj The bubble object
12339 * @return The content that is being used
12341 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12343 * Unset the content shown in the bubble
12345 * Unparent and return the content object which was set for this widget.
12347 * @param obj The bubble object
12348 * @return The content that was being used
12350 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12352 * Set the icon of the bubble
12354 * Once the icon object is set, a previously set one will be deleted.
12355 * If you want to keep the old content object, use the
12356 * elm_icon_content_unset() function.
12358 * @param obj The bubble object
12359 * @param icon The given icon for the bubble
12361 * @deprecated use elm_object_part_content_set() instead
12364 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12366 * Get the icon of the bubble
12368 * @param obj The bubble object
12369 * @return The icon for the bubble
12371 * This function gets the icon shown on the top left of bubble.
12373 * @deprecated use elm_object_part_content_get() instead
12376 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12378 * Unset the icon of the bubble
12380 * Unparent and return the icon object which was set for this widget.
12382 * @param obj The bubble object
12383 * @return The icon that was being used
12385 * @deprecated use elm_object_part_content_unset() instead
12388 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12390 * Set the corner of the bubble
12392 * @param obj The bubble object.
12393 * @param corner The given corner for the bubble.
12395 * This function sets the corner of the bubble. The corner will be used to
12396 * determine where the arrow in the frame points to and where label, icon and
12399 * Possible values for corner are:
12400 * @li "top_left" - Default
12402 * @li "bottom_left"
12403 * @li "bottom_right"
12405 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12407 * Get the corner of the bubble
12409 * @param obj The bubble object.
12410 * @return The given corner for the bubble.
12412 * This function gets the selected corner of the bubble.
12414 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12416 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12417 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12424 * @defgroup Photo Photo
12426 * For displaying the photo of a person (contact). Simple, yet
12427 * with a very specific purpose.
12429 * Signals that you can add callbacks for are:
12431 * "clicked" - This is called when a user has clicked the photo
12432 * "drag,start" - Someone started dragging the image out of the object
12433 * "drag,end" - Dragged item was dropped (somewhere)
12439 * Add a new photo to the parent
12441 * @param parent The parent object
12442 * @return The new object or NULL if it cannot be created
12446 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12449 * Set the file that will be used as photo
12451 * @param obj The photo object
12452 * @param file The path to file that will be used as photo
12454 * @return (1 = success, 0 = error)
12458 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12461 * Set the file that will be used as thumbnail in the photo.
12463 * @param obj The photo object.
12464 * @param file The path to file that will be used as thumb.
12465 * @param group The key used in case of an EET file.
12469 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12472 * Set the size that will be used on the photo
12474 * @param obj The photo object
12475 * @param size The size that the photo will be
12479 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12482 * Set if the photo should be completely visible or not.
12484 * @param obj The photo object
12485 * @param fill if true the photo will be completely visible
12489 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12492 * Set editability of the photo.
12494 * An editable photo can be dragged to or from, and can be cut or
12495 * pasted too. Note that pasting an image or dropping an item on
12496 * the image will delete the existing content.
12498 * @param obj The photo object.
12499 * @param set To set of clear editablity.
12501 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12507 /* gesture layer */
12509 * @defgroup Elm_Gesture_Layer Gesture Layer
12510 * Gesture Layer Usage:
12512 * Use Gesture Layer to detect gestures.
12513 * The advantage is that you don't have to implement
12514 * gesture detection, just set callbacks of gesture state.
12515 * By using gesture layer we make standard interface.
12517 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12518 * with a parent object parameter.
12519 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12520 * call. Usually with same object as target (2nd parameter).
12522 * Now you need to tell gesture layer what gestures you follow.
12523 * This is done with @ref elm_gesture_layer_cb_set call.
12524 * By setting the callback you actually saying to gesture layer:
12525 * I would like to know when the gesture @ref Elm_Gesture_Types
12526 * switches to state @ref Elm_Gesture_State.
12528 * Next, you need to implement the actual action that follows the input
12529 * in your callback.
12531 * Note that if you like to stop being reported about a gesture, just set
12532 * all callbacks referring this gesture to NULL.
12533 * (again with @ref elm_gesture_layer_cb_set)
12535 * The information reported by gesture layer to your callback is depending
12536 * on @ref Elm_Gesture_Types:
12537 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12538 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12539 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12541 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12542 * @ref ELM_GESTURE_MOMENTUM.
12544 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12545 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12546 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12547 * Note that we consider a flick as a line-gesture that should be completed
12548 * in flick-time-limit as defined in @ref Config.
12550 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12552 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12555 * Gesture Layer Tweaks:
12557 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12558 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12560 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12561 * so gesture starts when user touches (a *DOWN event) touch-surface
12562 * and ends when no fingers touches surface (a *UP event).
12566 * @enum _Elm_Gesture_Types
12567 * Enum of supported gesture types.
12568 * @ingroup Elm_Gesture_Layer
12570 enum _Elm_Gesture_Types
12572 ELM_GESTURE_FIRST = 0,
12574 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12575 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12576 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12577 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12579 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12581 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12582 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12584 ELM_GESTURE_ZOOM, /**< Zoom */
12585 ELM_GESTURE_ROTATE, /**< Rotate */
12591 * @typedef Elm_Gesture_Types
12592 * gesture types enum
12593 * @ingroup Elm_Gesture_Layer
12595 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12598 * @enum _Elm_Gesture_State
12599 * Enum of gesture states.
12600 * @ingroup Elm_Gesture_Layer
12602 enum _Elm_Gesture_State
12604 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12605 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12606 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12607 ELM_GESTURE_STATE_END, /**< Gesture completed */
12608 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12612 * @typedef Elm_Gesture_State
12613 * gesture states enum
12614 * @ingroup Elm_Gesture_Layer
12616 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12619 * @struct _Elm_Gesture_Taps_Info
12620 * Struct holds taps info for user
12621 * @ingroup Elm_Gesture_Layer
12623 struct _Elm_Gesture_Taps_Info
12625 Evas_Coord x, y; /**< Holds center point between fingers */
12626 unsigned int n; /**< Number of fingers tapped */
12627 unsigned int timestamp; /**< event timestamp */
12631 * @typedef Elm_Gesture_Taps_Info
12632 * holds taps info for user
12633 * @ingroup Elm_Gesture_Layer
12635 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12638 * @struct _Elm_Gesture_Momentum_Info
12639 * Struct holds momentum info for user
12640 * x1 and y1 are not necessarily in sync
12641 * x1 holds x value of x direction starting point
12642 * and same holds for y1.
12643 * This is noticeable when doing V-shape movement
12644 * @ingroup Elm_Gesture_Layer
12646 struct _Elm_Gesture_Momentum_Info
12647 { /* Report line ends, timestamps, and momentum computed */
12648 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12649 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12650 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12651 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12653 unsigned int tx; /**< Timestamp of start of final x-swipe */
12654 unsigned int ty; /**< Timestamp of start of final y-swipe */
12656 Evas_Coord mx; /**< Momentum on X */
12657 Evas_Coord my; /**< Momentum on Y */
12659 unsigned int n; /**< Number of fingers */
12663 * @typedef Elm_Gesture_Momentum_Info
12664 * holds momentum info for user
12665 * @ingroup Elm_Gesture_Layer
12667 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12670 * @struct _Elm_Gesture_Line_Info
12671 * Struct holds line info for user
12672 * @ingroup Elm_Gesture_Layer
12674 struct _Elm_Gesture_Line_Info
12675 { /* Report line ends, timestamps, and momentum computed */
12676 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12677 double angle; /**< Angle (direction) of lines */
12681 * @typedef Elm_Gesture_Line_Info
12682 * Holds line info for user
12683 * @ingroup Elm_Gesture_Layer
12685 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12688 * @struct _Elm_Gesture_Zoom_Info
12689 * Struct holds zoom info for user
12690 * @ingroup Elm_Gesture_Layer
12692 struct _Elm_Gesture_Zoom_Info
12694 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12695 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12696 double zoom; /**< Zoom value: 1.0 means no zoom */
12697 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12701 * @typedef Elm_Gesture_Zoom_Info
12702 * Holds zoom info for user
12703 * @ingroup Elm_Gesture_Layer
12705 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12708 * @struct _Elm_Gesture_Rotate_Info
12709 * Struct holds rotation info for user
12710 * @ingroup Elm_Gesture_Layer
12712 struct _Elm_Gesture_Rotate_Info
12714 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12715 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12716 double base_angle; /**< Holds start-angle */
12717 double angle; /**< Rotation value: 0.0 means no rotation */
12718 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12722 * @typedef Elm_Gesture_Rotate_Info
12723 * Holds rotation info for user
12724 * @ingroup Elm_Gesture_Layer
12726 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12729 * @typedef Elm_Gesture_Event_Cb
12730 * User callback used to stream gesture info from gesture layer
12731 * @param data user data
12732 * @param event_info gesture report info
12733 * Returns a flag field to be applied on the causing event.
12734 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12735 * upon the event, in an irreversible way.
12737 * @ingroup Elm_Gesture_Layer
12739 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12742 * Use function to set callbacks to be notified about
12743 * change of state of gesture.
12744 * When a user registers a callback with this function
12745 * this means this gesture has to be tested.
12747 * When ALL callbacks for a gesture are set to NULL
12748 * it means user isn't interested in gesture-state
12749 * and it will not be tested.
12751 * @param obj Pointer to gesture-layer.
12752 * @param idx The gesture you would like to track its state.
12753 * @param cb callback function pointer.
12754 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12755 * @param data user info to be sent to callback (usually, Smart Data)
12757 * @ingroup Elm_Gesture_Layer
12759 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);
12762 * Call this function to get repeat-events settings.
12764 * @param obj Pointer to gesture-layer.
12766 * @return repeat events settings.
12767 * @see elm_gesture_layer_hold_events_set()
12768 * @ingroup Elm_Gesture_Layer
12770 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12773 * This function called in order to make gesture-layer repeat events.
12774 * Set this of you like to get the raw events only if gestures were not detected.
12775 * Clear this if you like gesture layer to fwd events as testing gestures.
12777 * @param obj Pointer to gesture-layer.
12778 * @param r Repeat: TRUE/FALSE
12780 * @ingroup Elm_Gesture_Layer
12782 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12785 * This function sets step-value for zoom action.
12786 * Set step to any positive value.
12787 * Cancel step setting by setting to 0.0
12789 * @param obj Pointer to gesture-layer.
12790 * @param s new zoom step value.
12792 * @ingroup Elm_Gesture_Layer
12794 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12797 * This function sets step-value for rotate action.
12798 * Set step to any positive value.
12799 * Cancel step setting by setting to 0.0
12801 * @param obj Pointer to gesture-layer.
12802 * @param s new roatate step value.
12804 * @ingroup Elm_Gesture_Layer
12806 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12809 * This function called to attach gesture-layer to an Evas_Object.
12810 * @param obj Pointer to gesture-layer.
12811 * @param t Pointer to underlying object (AKA Target)
12813 * @return TRUE, FALSE on success, failure.
12815 * @ingroup Elm_Gesture_Layer
12817 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12820 * Call this function to construct a new gesture-layer object.
12821 * This does not activate the gesture layer. You have to
12822 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12824 * @param parent the parent object.
12826 * @return Pointer to new gesture-layer object.
12828 * @ingroup Elm_Gesture_Layer
12830 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12833 * @defgroup Thumb Thumb
12835 * @image html img/widget/thumb/preview-00.png
12836 * @image latex img/widget/thumb/preview-00.eps
12838 * A thumb object is used for displaying the thumbnail of an image or video.
12839 * You must have compiled Elementary with Ethumb_Client support and the DBus
12840 * service must be present and auto-activated in order to have thumbnails to
12843 * Once the thumbnail object becomes visible, it will check if there is a
12844 * previously generated thumbnail image for the file set on it. If not, it
12845 * will start generating this thumbnail.
12847 * Different config settings will cause different thumbnails to be generated
12848 * even on the same file.
12850 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12851 * Ethumb documentation to change this path, and to see other configuration
12854 * Signals that you can add callbacks for are:
12856 * - "clicked" - This is called when a user has clicked the thumb without dragging
12858 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12859 * - "press" - This is called when a user has pressed down the thumb.
12860 * - "generate,start" - The thumbnail generation started.
12861 * - "generate,stop" - The generation process stopped.
12862 * - "generate,error" - The generation failed.
12863 * - "load,error" - The thumbnail image loading failed.
12865 * available styles:
12869 * An example of use of thumbnail:
12871 * - @ref thumb_example_01
12875 * @addtogroup Thumb
12880 * @enum _Elm_Thumb_Animation_Setting
12881 * @typedef Elm_Thumb_Animation_Setting
12883 * Used to set if a video thumbnail is animating or not.
12887 typedef enum _Elm_Thumb_Animation_Setting
12889 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12890 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12891 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12892 ELM_THUMB_ANIMATION_LAST
12893 } Elm_Thumb_Animation_Setting;
12896 * Add a new thumb object to the parent.
12898 * @param parent The parent object.
12899 * @return The new object or NULL if it cannot be created.
12901 * @see elm_thumb_file_set()
12902 * @see elm_thumb_ethumb_client_get()
12906 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12908 * Reload thumbnail if it was generated before.
12910 * @param obj The thumb object to reload
12912 * This is useful if the ethumb client configuration changed, like its
12913 * size, aspect or any other property one set in the handle returned
12914 * by elm_thumb_ethumb_client_get().
12916 * If the options didn't change, the thumbnail won't be generated again, but
12917 * the old one will still be used.
12919 * @see elm_thumb_file_set()
12923 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12925 * Set the file that will be used as thumbnail.
12927 * @param obj The thumb object.
12928 * @param file The path to file that will be used as thumb.
12929 * @param key The key used in case of an EET file.
12931 * The file can be an image or a video (in that case, acceptable extensions are:
12932 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12933 * function elm_thumb_animate().
12935 * @see elm_thumb_file_get()
12936 * @see elm_thumb_reload()
12937 * @see elm_thumb_animate()
12941 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12943 * Get the image or video path and key used to generate the thumbnail.
12945 * @param obj The thumb object.
12946 * @param file Pointer to filename.
12947 * @param key Pointer to key.
12949 * @see elm_thumb_file_set()
12950 * @see elm_thumb_path_get()
12954 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12956 * Get the path and key to the image or video generated by ethumb.
12958 * One just need to make sure that the thumbnail was generated before getting
12959 * its path; otherwise, the path will be NULL. One way to do that is by asking
12960 * for the path when/after the "generate,stop" smart callback is called.
12962 * @param obj The thumb object.
12963 * @param file Pointer to thumb path.
12964 * @param key Pointer to thumb key.
12966 * @see elm_thumb_file_get()
12970 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12972 * Set the animation state for the thumb object. If its content is an animated
12973 * video, you may start/stop the animation or tell it to play continuously and
12976 * @param obj The thumb object.
12977 * @param setting The animation setting.
12979 * @see elm_thumb_file_set()
12983 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12985 * Get the animation state for the thumb object.
12987 * @param obj The thumb object.
12988 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12991 * @see elm_thumb_animate_set()
12995 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12997 * Get the ethumb_client handle so custom configuration can be made.
12999 * @return Ethumb_Client instance or NULL.
13001 * This must be called before the objects are created to be sure no object is
13002 * visible and no generation started.
13004 * Example of usage:
13007 * #include <Elementary.h>
13008 * #ifndef ELM_LIB_QUICKLAUNCH
13010 * elm_main(int argc, char **argv)
13012 * Ethumb_Client *client;
13014 * elm_need_ethumb();
13018 * client = elm_thumb_ethumb_client_get();
13021 * ERR("could not get ethumb_client");
13024 * ethumb_client_size_set(client, 100, 100);
13025 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13028 * // Create elm_thumb objects here
13038 * @note There's only one client handle for Ethumb, so once a configuration
13039 * change is done to it, any other request for thumbnails (for any thumbnail
13040 * object) will use that configuration. Thus, this configuration is global.
13044 EAPI void *elm_thumb_ethumb_client_get(void);
13046 * Get the ethumb_client connection state.
13048 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13051 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13053 * Make the thumbnail 'editable'.
13055 * @param obj Thumb object.
13056 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13058 * This means the thumbnail is a valid drag target for drag and drop, and can be
13059 * cut or pasted too.
13061 * @see elm_thumb_editable_get()
13065 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13066 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13068 * Make the thumbnail 'editable'.
13070 * @param obj Thumb object.
13071 * @return Editability.
13073 * This means the thumbnail is a valid drag target for drag and drop, and can be
13074 * cut or pasted too.
13076 * @see elm_thumb_editable_set()
13080 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13087 * @defgroup Web Web
13089 * @image html img/widget/web/preview-00.png
13090 * @image latex img/widget/web/preview-00.eps
13092 * A web object is used for displaying web pages (HTML/CSS/JS)
13093 * using WebKit-EFL. You must have compiled Elementary with
13096 * Signals that you can add callbacks for are:
13097 * @li "download,request": A file download has been requested. Event info is
13098 * a pointer to a Elm_Web_Download
13099 * @li "editorclient,contents,changed": Editor client's contents changed
13100 * @li "editorclient,selection,changed": Editor client's selection changed
13101 * @li "frame,created": A new frame was created. Event info is an
13102 * Evas_Object which can be handled with WebKit's ewk_frame API
13103 * @li "icon,received": An icon was received by the main frame
13104 * @li "inputmethod,changed": Input method changed. Event info is an
13105 * Eina_Bool indicating whether it's enabled or not
13106 * @li "js,windowobject,clear": JS window object has been cleared
13107 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13108 * is a char *link[2], where the first string contains the URL the link
13109 * points to, and the second one the title of the link
13110 * @li "link,hover,out": Mouse cursor left the link
13111 * @li "load,document,finished": Loading of a document finished. Event info
13112 * is the frame that finished loading
13113 * @li "load,error": Load failed. Event info is a pointer to
13114 * Elm_Web_Frame_Load_Error
13115 * @li "load,finished": Load finished. Event info is NULL on success, on
13116 * error it's a pointer to Elm_Web_Frame_Load_Error
13117 * @li "load,newwindow,show": A new window was created and is ready to be
13119 * @li "load,progress": Overall load progress. Event info is a pointer to
13120 * a double containing a value between 0.0 and 1.0
13121 * @li "load,provisional": Started provisional load
13122 * @li "load,started": Loading of a document started
13123 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13124 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13125 * the menubar is visible, or EINA_FALSE in case it's not
13126 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13127 * an Eina_Bool indicating the visibility
13128 * @li "popup,created": A dropdown widget was activated, requesting its
13129 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13130 * @li "popup,willdelete": The web object is ready to destroy the popup
13131 * object created. Event info is a pointer to Elm_Web_Menu
13132 * @li "ready": Page is fully loaded
13133 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13134 * info is a pointer to Eina_Bool where the visibility state should be set
13135 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13136 * is an Eina_Bool with the visibility state set
13137 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13138 * a string with the new text
13139 * @li "statusbar,visible,get": Queries visibility of the status bar.
13140 * Event info is a pointer to Eina_Bool where the visibility state should be
13142 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13143 * an Eina_Bool with the visibility value
13144 * @li "title,changed": Title of the main frame changed. Event info is a
13145 * string with the new title
13146 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13147 * is a pointer to Eina_Bool where the visibility state should be set
13148 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13149 * info is an Eina_Bool with the visibility state
13150 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13151 * a string with the text to show
13152 * @li "uri,changed": URI of the main frame changed. Event info is a string
13154 * @li "view,resized": The web object internal's view changed sized
13155 * @li "windows,close,request": A JavaScript request to close the current
13156 * window was requested
13157 * @li "zoom,animated,end": Animated zoom finished
13159 * available styles:
13162 * An example of use of web:
13164 * - @ref web_example_01 TBD
13173 * Structure used to report load errors.
13175 * Load errors are reported as signal by elm_web. All the strings are
13176 * temporary references and should @b not be used after the signal
13177 * callback returns. If it's required, make copies with strdup() or
13178 * eina_stringshare_add() (they are not even guaranteed to be
13179 * stringshared, so must use eina_stringshare_add() and not
13180 * eina_stringshare_ref()).
13182 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13184 * Structure used to report load errors.
13186 * Load errors are reported as signal by elm_web. All the strings are
13187 * temporary references and should @b not be used after the signal
13188 * callback returns. If it's required, make copies with strdup() or
13189 * eina_stringshare_add() (they are not even guaranteed to be
13190 * stringshared, so must use eina_stringshare_add() and not
13191 * eina_stringshare_ref()).
13193 struct _Elm_Web_Frame_Load_Error
13195 int code; /**< Numeric error code */
13196 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13197 const char *domain; /**< Error domain name */
13198 const char *description; /**< Error description (already localized) */
13199 const char *failing_url; /**< The URL that failed to load */
13200 Evas_Object *frame; /**< Frame object that produced the error */
13204 * The possibles types that the items in a menu can be
13206 typedef enum _Elm_Web_Menu_Item_Type
13208 ELM_WEB_MENU_SEPARATOR,
13209 ELM_WEB_MENU_GROUP,
13210 ELM_WEB_MENU_OPTION
13211 } Elm_Web_Menu_Item_Type;
13214 * Structure describing the items in a menu
13216 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13218 * Structure describing the items in a menu
13220 struct _Elm_Web_Menu_Item
13222 const char *text; /**< The text for the item */
13223 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13227 * Structure describing the menu of a popup
13229 * This structure will be passed as the @c event_info for the "popup,create"
13230 * signal, which is emitted when a dropdown menu is opened. Users wanting
13231 * to handle these popups by themselves should listen to this signal and
13232 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13233 * property as @c EINA_FALSE means that the user will not handle the popup
13234 * and the default implementation will be used.
13236 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13237 * will be emitted to notify the user that it can destroy any objects and
13238 * free all data related to it.
13240 * @see elm_web_popup_selected_set()
13241 * @see elm_web_popup_destroy()
13243 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13245 * Structure describing the menu of a popup
13247 * This structure will be passed as the @c event_info for the "popup,create"
13248 * signal, which is emitted when a dropdown menu is opened. Users wanting
13249 * to handle these popups by themselves should listen to this signal and
13250 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13251 * property as @c EINA_FALSE means that the user will not handle the popup
13252 * and the default implementation will be used.
13254 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13255 * will be emitted to notify the user that it can destroy any objects and
13256 * free all data related to it.
13258 * @see elm_web_popup_selected_set()
13259 * @see elm_web_popup_destroy()
13261 struct _Elm_Web_Menu
13263 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13264 int x; /**< The X position of the popup, relative to the elm_web object */
13265 int y; /**< The Y position of the popup, relative to the elm_web object */
13266 int width; /**< Width of the popup menu */
13267 int height; /**< Height of the popup menu */
13269 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. */
13272 typedef struct _Elm_Web_Download Elm_Web_Download;
13273 struct _Elm_Web_Download
13279 * Types of zoom available.
13281 typedef enum _Elm_Web_Zoom_Mode
13283 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13284 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13285 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13286 ELM_WEB_ZOOM_MODE_LAST
13287 } Elm_Web_Zoom_Mode;
13289 * Opaque handler containing the features (such as statusbar, menubar, etc)
13290 * that are to be set on a newly requested window.
13292 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13294 * Callback type for the create_window hook.
13296 * The function parameters are:
13297 * @li @p data User data pointer set when setting the hook function
13298 * @li @p obj The elm_web object requesting the new window
13299 * @li @p js Set to @c EINA_TRUE if the request was originated from
13300 * JavaScript. @c EINA_FALSE otherwise.
13301 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13302 * the features requested for the new window.
13304 * The returned value of the function should be the @c elm_web widget where
13305 * the request will be loaded. That is, if a new window or tab is created,
13306 * the elm_web widget in it should be returned, and @b NOT the window
13308 * Returning @c NULL should cancel the request.
13310 * @see elm_web_window_create_hook_set()
13312 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13314 * Callback type for the JS alert hook.
13316 * The function parameters are:
13317 * @li @p data User data pointer set when setting the hook function
13318 * @li @p obj The elm_web object requesting the new window
13319 * @li @p message The message to show in the alert dialog
13321 * The function should return the object representing the alert dialog.
13322 * Elm_Web will run a second main loop to handle the dialog and normal
13323 * flow of the application will be restored when the object is deleted, so
13324 * the user should handle the popup properly in order to delete the object
13325 * when the action is finished.
13326 * If the function returns @c NULL the popup will be ignored.
13328 * @see elm_web_dialog_alert_hook_set()
13330 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13332 * Callback type for the JS confirm hook.
13334 * The function parameters are:
13335 * @li @p data User data pointer set when setting the hook function
13336 * @li @p obj The elm_web object requesting the new window
13337 * @li @p message The message to show in the confirm dialog
13338 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13339 * the user selected @c Ok, @c EINA_FALSE otherwise.
13341 * The function should return the object representing the confirm dialog.
13342 * Elm_Web will run a second main loop to handle the dialog and normal
13343 * flow of the application will be restored when the object is deleted, so
13344 * the user should handle the popup properly in order to delete the object
13345 * when the action is finished.
13346 * If the function returns @c NULL the popup will be ignored.
13348 * @see elm_web_dialog_confirm_hook_set()
13350 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13352 * Callback type for the JS prompt hook.
13354 * The function parameters are:
13355 * @li @p data User data pointer set when setting the hook function
13356 * @li @p obj The elm_web object requesting the new window
13357 * @li @p message The message to show in the prompt dialog
13358 * @li @p def_value The default value to present the user in the entry
13359 * @li @p value Pointer where to store the value given by the user. Must
13360 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13361 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13362 * the user selected @c Ok, @c EINA_FALSE otherwise.
13364 * The function should return the object representing the prompt dialog.
13365 * Elm_Web will run a second main loop to handle the dialog and normal
13366 * flow of the application will be restored when the object is deleted, so
13367 * the user should handle the popup properly in order to delete the object
13368 * when the action is finished.
13369 * If the function returns @c NULL the popup will be ignored.
13371 * @see elm_web_dialog_prompt_hook_set()
13373 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13375 * Callback type for the JS file selector hook.
13377 * The function parameters are:
13378 * @li @p data User data pointer set when setting the hook function
13379 * @li @p obj The elm_web object requesting the new window
13380 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13381 * @li @p accept_types Mime types accepted
13382 * @li @p selected Pointer where to store the list of malloc'ed strings
13383 * containing the path to each file selected. Must be @c NULL if the file
13384 * dialog is cancelled
13385 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13386 * the user selected @c Ok, @c EINA_FALSE otherwise.
13388 * The function should return the object representing the file selector
13390 * Elm_Web will run a second main loop to handle the dialog and normal
13391 * flow of the application will be restored when the object is deleted, so
13392 * the user should handle the popup properly in order to delete the object
13393 * when the action is finished.
13394 * If the function returns @c NULL the popup will be ignored.
13396 * @see elm_web_dialog_file selector_hook_set()
13398 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13400 * Callback type for the JS console message hook.
13402 * When a console message is added from JavaScript, any set function to the
13403 * console message hook will be called for the user to handle. There is no
13404 * default implementation of this hook.
13406 * The function parameters are:
13407 * @li @p data User data pointer set when setting the hook function
13408 * @li @p obj The elm_web object that originated the message
13409 * @li @p message The message sent
13410 * @li @p line_number The line number
13411 * @li @p source_id Source id
13413 * @see elm_web_console_message_hook_set()
13415 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13417 * Add a new web object to the parent.
13419 * @param parent The parent object.
13420 * @return The new object or NULL if it cannot be created.
13422 * @see elm_web_uri_set()
13423 * @see elm_web_webkit_view_get()
13425 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13428 * Get internal ewk_view object from web object.
13430 * Elementary may not provide some low level features of EWebKit,
13431 * instead of cluttering the API with proxy methods we opted to
13432 * return the internal reference. Be careful using it as it may
13433 * interfere with elm_web behavior.
13435 * @param obj The web object.
13436 * @return The internal ewk_view object or NULL if it does not
13437 * exist. (Failure to create or Elementary compiled without
13440 * @see elm_web_add()
13442 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13445 * Sets the function to call when a new window is requested
13447 * This hook will be called when a request to create a new window is
13448 * issued from the web page loaded.
13449 * There is no default implementation for this feature, so leaving this
13450 * unset or passing @c NULL in @p func will prevent new windows from
13453 * @param obj The web object where to set the hook function
13454 * @param func The hook function to be called when a window is requested
13455 * @param data User data
13457 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13459 * Sets the function to call when an alert dialog
13461 * This hook will be called when a JavaScript alert dialog is requested.
13462 * If no function is set or @c NULL is passed in @p func, the default
13463 * implementation will take place.
13465 * @param obj The web object where to set the hook function
13466 * @param func The callback function to be used
13467 * @param data User data
13469 * @see elm_web_inwin_mode_set()
13471 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13473 * Sets the function to call when an confirm dialog
13475 * This hook will be called when a JavaScript confirm dialog is requested.
13476 * If no function is set or @c NULL is passed in @p func, the default
13477 * implementation will take place.
13479 * @param obj The web object where to set the hook function
13480 * @param func The callback function to be used
13481 * @param data User data
13483 * @see elm_web_inwin_mode_set()
13485 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13487 * Sets the function to call when an prompt dialog
13489 * This hook will be called when a JavaScript prompt dialog is requested.
13490 * If no function is set or @c NULL is passed in @p func, the default
13491 * implementation will take place.
13493 * @param obj The web object where to set the hook function
13494 * @param func The callback function to be used
13495 * @param data User data
13497 * @see elm_web_inwin_mode_set()
13499 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13501 * Sets the function to call when an file selector dialog
13503 * This hook will be called when a JavaScript file selector dialog is
13505 * If no function is set or @c NULL is passed in @p func, the default
13506 * implementation will take place.
13508 * @param obj The web object where to set the hook function
13509 * @param func The callback function to be used
13510 * @param data User data
13512 * @see elm_web_inwin_mode_set()
13514 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13516 * Sets the function to call when a console message is emitted from JS
13518 * This hook will be called when a console message is emitted from
13519 * JavaScript. There is no default implementation for this feature.
13521 * @param obj The web object where to set the hook function
13522 * @param func The callback function to be used
13523 * @param data User data
13525 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13527 * Gets the status of the tab propagation
13529 * @param obj The web object to query
13530 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13532 * @see elm_web_tab_propagate_set()
13534 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13536 * Sets whether to use tab propagation
13538 * If tab propagation is enabled, whenever the user presses the Tab key,
13539 * Elementary will handle it and switch focus to the next widget.
13540 * The default value is disabled, where WebKit will handle the Tab key to
13541 * cycle focus though its internal objects, jumping to the next widget
13542 * only when that cycle ends.
13544 * @param obj The web object
13545 * @param propagate Whether to propagate Tab keys to Elementary or not
13547 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13549 * Sets the URI for the web object
13551 * It must be a full URI, with resource included, in the form
13552 * http://www.enlightenment.org or file:///tmp/something.html
13554 * @param obj The web object
13555 * @param uri The URI to set
13556 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13558 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13560 * Gets the current URI for the object
13562 * The returned string must not be freed and is guaranteed to be
13565 * @param obj The web object
13566 * @return A stringshared internal string with the current URI, or NULL on
13569 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13571 * Gets the current title
13573 * The returned string must not be freed and is guaranteed to be
13576 * @param obj The web object
13577 * @return A stringshared internal string with the current title, or NULL on
13580 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13582 * Sets the background color to be used by the web object
13584 * This is the color that will be used by default when the loaded page
13585 * does not set it's own. Color values are pre-multiplied.
13587 * @param obj The web object
13588 * @param r Red component
13589 * @param g Green component
13590 * @param b Blue component
13591 * @param a Alpha component
13593 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13595 * Gets the background color to be used by the web object
13597 * This is the color that will be used by default when the loaded page
13598 * does not set it's own. Color values are pre-multiplied.
13600 * @param obj The web object
13601 * @param r Red component
13602 * @param g Green component
13603 * @param b Blue component
13604 * @param a Alpha component
13606 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13608 * Gets a copy of the currently selected text
13610 * The string returned must be freed by the user when it's done with it.
13612 * @param obj The web object
13613 * @return A newly allocated string, or NULL if nothing is selected or an
13616 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13618 * Tells the web object which index in the currently open popup was selected
13620 * When the user handles the popup creation from the "popup,created" signal,
13621 * it needs to tell the web object which item was selected by calling this
13622 * function with the index corresponding to the item.
13624 * @param obj The web object
13625 * @param index The index selected
13627 * @see elm_web_popup_destroy()
13629 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13631 * Dismisses an open dropdown popup
13633 * When the popup from a dropdown widget is to be dismissed, either after
13634 * selecting an option or to cancel it, this function must be called, which
13635 * will later emit an "popup,willdelete" signal to notify the user that
13636 * any memory and objects related to this popup can be freed.
13638 * @param obj The web object
13639 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13640 * if there was no menu to destroy
13642 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13644 * Searches the given string in a document.
13646 * @param obj The web object where to search the text
13647 * @param string String to search
13648 * @param case_sensitive If search should be case sensitive or not
13649 * @param forward If search is from cursor and on or backwards
13650 * @param wrap If search should wrap at the end
13652 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13655 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13657 * Marks matches of the given string in a document.
13659 * @param obj The web object where to search text
13660 * @param string String to match
13661 * @param case_sensitive If match should be case sensitive or not
13662 * @param highlight If matches should be highlighted
13663 * @param limit Maximum amount of matches, or zero to unlimited
13665 * @return number of matched @a string
13667 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13669 * Clears all marked matches in the document
13671 * @param obj The web object
13673 * @return EINA_TRUE on success, EINA_FALSE otherwise
13675 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13677 * Sets whether to highlight the matched marks
13679 * If enabled, marks set with elm_web_text_matches_mark() will be
13682 * @param obj The web object
13683 * @param highlight Whether to highlight the marks or not
13685 * @return EINA_TRUE on success, EINA_FALSE otherwise
13687 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13689 * Gets whether highlighting marks is enabled
13691 * @param The web object
13693 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13696 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13698 * Gets the overall loading progress of the page
13700 * Returns the estimated loading progress of the page, with a value between
13701 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13702 * included in the page.
13704 * @param The web object
13706 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13709 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13711 * Stops loading the current page
13713 * Cancels the loading of the current page in the web object. This will
13714 * cause a "load,error" signal to be emitted, with the is_cancellation
13715 * flag set to EINA_TRUE.
13717 * @param obj The web object
13719 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13721 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13723 * Requests a reload of the current document in the object
13725 * @param obj The web object
13727 * @return EINA_TRUE on success, EINA_FALSE otherwise
13729 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13731 * Requests a reload of the current document, avoiding any existing caches
13733 * @param obj The web object
13735 * @return EINA_TRUE on success, EINA_FALSE otherwise
13737 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13739 * Goes back one step in the browsing history
13741 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13743 * @param obj The web object
13745 * @return EINA_TRUE on success, EINA_FALSE otherwise
13747 * @see elm_web_history_enable_set()
13748 * @see elm_web_back_possible()
13749 * @see elm_web_forward()
13750 * @see elm_web_navigate()
13752 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13754 * Goes forward one step in the browsing history
13756 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13758 * @param obj The web object
13760 * @return EINA_TRUE on success, EINA_FALSE otherwise
13762 * @see elm_web_history_enable_set()
13763 * @see elm_web_forward_possible()
13764 * @see elm_web_back()
13765 * @see elm_web_navigate()
13767 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13769 * Jumps the given number of steps in the browsing history
13771 * The @p steps value can be a negative integer to back in history, or a
13772 * positive to move forward.
13774 * @param obj The web object
13775 * @param steps The number of steps to jump
13777 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13778 * history exists to jump the given number of steps
13780 * @see elm_web_history_enable_set()
13781 * @see elm_web_navigate_possible()
13782 * @see elm_web_back()
13783 * @see elm_web_forward()
13785 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13787 * Queries whether it's possible to go back in history
13789 * @param obj The web object
13791 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13794 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13796 * Queries whether it's possible to go forward in history
13798 * @param obj The web object
13800 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13803 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13805 * Queries whether it's possible to jump the given number of steps
13807 * The @p steps value can be a negative integer to back in history, or a
13808 * positive to move forward.
13810 * @param obj The web object
13811 * @param steps The number of steps to check for
13813 * @return EINA_TRUE if enough history exists to perform the given jump,
13814 * EINA_FALSE otherwise
13816 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13818 * Gets whether browsing history is enabled for the given object
13820 * @param obj The web object
13822 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13824 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13826 * Enables or disables the browsing history
13828 * @param obj The web object
13829 * @param enable Whether to enable or disable the browsing history
13831 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13833 * Sets the zoom level of the web object
13835 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13836 * values meaning zoom in and lower meaning zoom out. This function will
13837 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13838 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13840 * @param obj The web object
13841 * @param zoom The zoom level to set
13843 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13845 * Gets the current zoom level set on the web object
13847 * Note that this is the zoom level set on the web object and not that
13848 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13849 * the two zoom levels should match, but for the other two modes the
13850 * Webkit zoom is calculated internally to match the chosen mode without
13851 * changing the zoom level set for the web object.
13853 * @param obj The web object
13855 * @return The zoom level set on the object
13857 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13859 * Sets the zoom mode to use
13861 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13862 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13864 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13865 * with the elm_web_zoom_set() function.
13866 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13867 * make sure the entirety of the web object's contents are shown.
13868 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13869 * fit the contents in the web object's size, without leaving any space
13872 * @param obj The web object
13873 * @param mode The mode to set
13875 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13877 * Gets the currently set zoom mode
13879 * @param obj The web object
13881 * @return The current zoom mode set for the object, or
13882 * ::ELM_WEB_ZOOM_MODE_LAST on error
13884 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13886 * Shows the given region in the web object
13888 * @param obj The web object
13889 * @param x The x coordinate of the region to show
13890 * @param y The y coordinate of the region to show
13891 * @param w The width of the region to show
13892 * @param h The height of the region to show
13894 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13896 * Brings in the region to the visible area
13898 * Like elm_web_region_show(), but it animates the scrolling of the object
13901 * @param obj The web object
13902 * @param x The x coordinate of the region to show
13903 * @param y The y coordinate of the region to show
13904 * @param w The width of the region to show
13905 * @param h The height of the region to show
13907 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13909 * Sets the default dialogs to use an Inwin instead of a normal window
13911 * If set, then the default implementation for the JavaScript dialogs and
13912 * file selector will be opened in an Inwin. Otherwise they will use a
13913 * normal separated window.
13915 * @param obj The web object
13916 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13918 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13920 * Gets whether Inwin mode is set for the current object
13922 * @param obj The web object
13924 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13926 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13928 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13929 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13930 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);
13931 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13938 * @defgroup Hoversel Hoversel
13940 * @image html img/widget/hoversel/preview-00.png
13941 * @image latex img/widget/hoversel/preview-00.eps
13943 * A hoversel is a button that pops up a list of items (automatically
13944 * choosing the direction to display) that have a label and, optionally, an
13945 * icon to select from. It is a convenience widget to avoid the need to do
13946 * all the piecing together yourself. It is intended for a small number of
13947 * items in the hoversel menu (no more than 8), though is capable of many
13950 * Signals that you can add callbacks for are:
13951 * "clicked" - the user clicked the hoversel button and popped up the sel
13952 * "selected" - an item in the hoversel list is selected. event_info is the item
13953 * "dismissed" - the hover is dismissed
13955 * See @ref tutorial_hoversel for an example.
13958 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13960 * @brief Add a new Hoversel object
13962 * @param parent The parent object
13963 * @return The new object or NULL if it cannot be created
13965 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13967 * @brief This sets the hoversel to expand horizontally.
13969 * @param obj The hoversel object
13970 * @param horizontal If true, the hover will expand horizontally to the
13973 * @note The initial button will display horizontally regardless of this
13976 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13978 * @brief This returns whether the hoversel is set to expand horizontally.
13980 * @param obj The hoversel object
13981 * @return If true, the hover will expand horizontally to the right.
13983 * @see elm_hoversel_horizontal_set()
13985 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13987 * @brief Set the Hover parent
13989 * @param obj The hoversel object
13990 * @param parent The parent to use
13992 * Sets the hover parent object, the area that will be darkened when the
13993 * hoversel is clicked. Should probably be the window that the hoversel is
13994 * in. See @ref Hover objects for more information.
13996 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13998 * @brief Get the Hover parent
14000 * @param obj The hoversel object
14001 * @return The used parent
14003 * Gets the hover parent object.
14005 * @see elm_hoversel_hover_parent_set()
14007 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14009 * @brief Set the hoversel button label
14011 * @param obj The hoversel object
14012 * @param label The label text.
14014 * This sets the label of the button that is always visible (before it is
14015 * clicked and expanded).
14017 * @deprecated elm_object_text_set()
14019 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14021 * @brief Get the hoversel button label
14023 * @param obj The hoversel object
14024 * @return The label text.
14026 * @deprecated elm_object_text_get()
14028 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14030 * @brief Set the icon of the hoversel button
14032 * @param obj The hoversel object
14033 * @param icon The icon object
14035 * Sets the icon of the button that is always visible (before it is clicked
14036 * and expanded). Once the icon object is set, a previously set one will be
14037 * deleted, if you want to keep that old content object, use the
14038 * elm_hoversel_icon_unset() function.
14040 * @see elm_object_content_set() for the button widget
14042 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14044 * @brief Get the icon of the hoversel button
14046 * @param obj The hoversel object
14047 * @return The icon object
14049 * Get the icon of the button that is always visible (before it is clicked
14050 * and expanded). Also see elm_object_content_get() for the button widget.
14052 * @see elm_hoversel_icon_set()
14054 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14056 * @brief Get and unparent the icon of the hoversel button
14058 * @param obj The hoversel object
14059 * @return The icon object that was being used
14061 * Unparent and return the icon of the button that is always visible
14062 * (before it is clicked and expanded).
14064 * @see elm_hoversel_icon_set()
14065 * @see elm_object_content_unset() for the button widget
14067 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14069 * @brief This triggers the hoversel popup from code, the same as if the user
14070 * had clicked the button.
14072 * @param obj The hoversel object
14074 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14076 * @brief This dismisses the hoversel popup as if the user had clicked
14077 * outside the hover.
14079 * @param obj The hoversel object
14081 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14083 * @brief Returns whether the hoversel is expanded.
14085 * @param obj The hoversel object
14086 * @return This will return EINA_TRUE if the hoversel is expanded or
14087 * EINA_FALSE if it is not expanded.
14089 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14091 * @brief This will remove all the children items from the hoversel.
14093 * @param obj The hoversel object
14095 * @warning Should @b not be called while the hoversel is active; use
14096 * elm_hoversel_expanded_get() to check first.
14098 * @see elm_hoversel_item_del_cb_set()
14099 * @see elm_hoversel_item_del()
14101 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14103 * @brief Get the list of items within the given hoversel.
14105 * @param obj The hoversel object
14106 * @return Returns a list of Elm_Hoversel_Item*
14108 * @see elm_hoversel_item_add()
14110 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14112 * @brief Add an item to the hoversel button
14114 * @param obj The hoversel object
14115 * @param label The text label to use for the item (NULL if not desired)
14116 * @param icon_file An image file path on disk to use for the icon or standard
14117 * icon name (NULL if not desired)
14118 * @param icon_type The icon type if relevant
14119 * @param func Convenience function to call when this item is selected
14120 * @param data Data to pass to item-related functions
14121 * @return A handle to the item added.
14123 * This adds an item to the hoversel to show when it is clicked. Note: if you
14124 * need to use an icon from an edje file then use
14125 * elm_hoversel_item_icon_set() right after the this function, and set
14126 * icon_file to NULL here.
14128 * For more information on what @p icon_file and @p icon_type are see the
14129 * @ref Icon "icon documentation".
14131 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);
14133 * @brief Delete an item from the hoversel
14135 * @param item The item to delete
14137 * This deletes the item from the hoversel (should not be called while the
14138 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14140 * @see elm_hoversel_item_add()
14141 * @see elm_hoversel_item_del_cb_set()
14143 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14145 * @brief Set the function to be called when an item from the hoversel is
14148 * @param item The item to set the callback on
14149 * @param func The function called
14151 * That function will receive these parameters:
14152 * @li void *item_data
14153 * @li Evas_Object *the_item_object
14154 * @li Elm_Hoversel_Item *the_object_struct
14156 * @see elm_hoversel_item_add()
14158 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14160 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14161 * that will be passed to associated function callbacks.
14163 * @param item The item to get the data from
14164 * @return The data pointer set with elm_hoversel_item_add()
14166 * @see elm_hoversel_item_add()
14168 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14170 * @brief This returns the label text of the given hoversel item.
14172 * @param item The item to get the label
14173 * @return The label text of the hoversel item
14175 * @see elm_hoversel_item_add()
14177 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14179 * @brief This sets the icon for the given hoversel item.
14181 * @param item The item to set the icon
14182 * @param icon_file An image file path on disk to use for the icon or standard
14184 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14185 * to NULL if the icon is not an edje file
14186 * @param icon_type The icon type
14188 * The icon can be loaded from the standard set, from an image file, or from
14191 * @see elm_hoversel_item_add()
14193 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);
14195 * @brief Get the icon object of the hoversel item
14197 * @param item The item to get the icon from
14198 * @param icon_file The image file path on disk used for the icon or standard
14200 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14201 * if the icon is not an edje file
14202 * @param icon_type The icon type
14204 * @see elm_hoversel_item_icon_set()
14205 * @see elm_hoversel_item_add()
14207 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);
14213 * @defgroup Toolbar Toolbar
14214 * @ingroup Elementary
14216 * @image html img/widget/toolbar/preview-00.png
14217 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14219 * @image html img/toolbar.png
14220 * @image latex img/toolbar.eps width=\textwidth
14222 * A toolbar is a widget that displays a list of items inside
14223 * a box. It can be scrollable, show a menu with items that don't fit
14224 * to toolbar size or even crop them.
14226 * Only one item can be selected at a time.
14228 * Items can have multiple states, or show menus when selected by the user.
14230 * Smart callbacks one can listen to:
14231 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14232 * - "language,changed" - when the program language changes
14234 * Available styles for it:
14236 * - @c "transparent" - no background or shadow, just show the content
14238 * List of examples:
14239 * @li @ref toolbar_example_01
14240 * @li @ref toolbar_example_02
14241 * @li @ref toolbar_example_03
14245 * @addtogroup Toolbar
14250 * @enum _Elm_Toolbar_Shrink_Mode
14251 * @typedef Elm_Toolbar_Shrink_Mode
14253 * Set toolbar's items display behavior, it can be scrollabel,
14254 * show a menu with exceeding items, or simply hide them.
14256 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14259 * Values <b> don't </b> work as bitmask, only one can be choosen.
14261 * @see elm_toolbar_mode_shrink_set()
14262 * @see elm_toolbar_mode_shrink_get()
14266 typedef enum _Elm_Toolbar_Shrink_Mode
14268 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14269 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14270 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14271 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14272 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14273 } Elm_Toolbar_Shrink_Mode;
14275 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(). */
14277 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(). */
14280 * Add a new toolbar widget to the given parent Elementary
14281 * (container) object.
14283 * @param parent The parent object.
14284 * @return a new toolbar widget handle or @c NULL, on errors.
14286 * This function inserts a new toolbar widget on the canvas.
14290 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14293 * Set the icon size, in pixels, to be used by toolbar items.
14295 * @param obj The toolbar object
14296 * @param icon_size The icon size in pixels
14298 * @note Default value is @c 32. It reads value from elm config.
14300 * @see elm_toolbar_icon_size_get()
14304 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14307 * Get the icon size, in pixels, to be used by toolbar items.
14309 * @param obj The toolbar object.
14310 * @return The icon size in pixels.
14312 * @see elm_toolbar_icon_size_set() for details.
14316 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14319 * Sets icon lookup order, for toolbar items' icons.
14321 * @param obj The toolbar object.
14322 * @param order The icon lookup order.
14324 * Icons added before calling this function will not be affected.
14325 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14327 * @see elm_toolbar_icon_order_lookup_get()
14331 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14334 * Gets the icon lookup order.
14336 * @param obj The toolbar object.
14337 * @return The icon lookup order.
14339 * @see elm_toolbar_icon_order_lookup_set() for details.
14343 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14346 * Set whether the toolbar should always have an item selected.
14348 * @param obj The toolbar object.
14349 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14352 * This will cause the toolbar to always have an item selected, and clicking
14353 * the selected item will not cause a selected event to be emitted. Enabling this mode
14354 * will immediately select the first toolbar item.
14356 * Always-selected is disabled by default.
14358 * @see elm_toolbar_always_select_mode_get().
14362 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14365 * Get whether the toolbar should always have an item selected.
14367 * @param obj The toolbar object.
14368 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14369 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14371 * @see elm_toolbar_always_select_mode_set() for details.
14375 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14378 * Set whether the toolbar items' should be selected by the user or not.
14380 * @param obj The toolbar object.
14381 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14384 * This will turn off the ability to select items entirely and they will
14385 * neither appear selected nor emit selected signals. The clicked
14386 * callback function will still be called.
14388 * Selection is enabled by default.
14390 * @see elm_toolbar_no_select_mode_get().
14394 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14397 * Set whether the toolbar items' should be selected by the user or not.
14399 * @param obj The toolbar object.
14400 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14401 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14403 * @see elm_toolbar_no_select_mode_set() for details.
14407 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14410 * Append item to the toolbar.
14412 * @param obj The toolbar object.
14413 * @param icon A string with icon name or the absolute path of an image file.
14414 * @param label The label of the item.
14415 * @param func The function to call when the item is clicked.
14416 * @param data The data to associate with the item for related callbacks.
14417 * @return The created item or @c NULL upon failure.
14419 * A new item will be created and appended to the toolbar, i.e., will
14420 * be set as @b last item.
14422 * Items created with this method can be deleted with
14423 * elm_toolbar_item_del().
14425 * Associated @p data can be properly freed when item is deleted if a
14426 * callback function is set with elm_toolbar_item_del_cb_set().
14428 * If a function is passed as argument, it will be called everytime this item
14429 * is selected, i.e., the user clicks over an unselected item.
14430 * If such function isn't needed, just passing
14431 * @c NULL as @p func is enough. The same should be done for @p data.
14433 * Toolbar will load icon image from fdo or current theme.
14434 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14435 * If an absolute path is provided it will load it direct from a file.
14437 * @see elm_toolbar_item_icon_set()
14438 * @see elm_toolbar_item_del()
14439 * @see elm_toolbar_item_del_cb_set()
14443 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);
14446 * Prepend item to the toolbar.
14448 * @param obj The toolbar object.
14449 * @param icon A string with icon name or the absolute path of an image file.
14450 * @param label The label of the item.
14451 * @param func The function to call when the item is clicked.
14452 * @param data The data to associate with the item for related callbacks.
14453 * @return The created item or @c NULL upon failure.
14455 * A new item will be created and prepended to the toolbar, i.e., will
14456 * be set as @b first item.
14458 * Items created with this method can be deleted with
14459 * elm_toolbar_item_del().
14461 * Associated @p data can be properly freed when item is deleted if a
14462 * callback function is set with elm_toolbar_item_del_cb_set().
14464 * If a function is passed as argument, it will be called everytime this item
14465 * is selected, i.e., the user clicks over an unselected item.
14466 * If such function isn't needed, just passing
14467 * @c NULL as @p func is enough. The same should be done for @p data.
14469 * Toolbar will load icon image from fdo or current theme.
14470 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14471 * If an absolute path is provided it will load it direct from a file.
14473 * @see elm_toolbar_item_icon_set()
14474 * @see elm_toolbar_item_del()
14475 * @see elm_toolbar_item_del_cb_set()
14479 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);
14482 * Insert a new item into the toolbar object before item @p before.
14484 * @param obj The toolbar object.
14485 * @param before The toolbar item to insert before.
14486 * @param icon A string with icon name or the absolute path of an image file.
14487 * @param label The label of the item.
14488 * @param func The function to call when the item is clicked.
14489 * @param data The data to associate with the item for related callbacks.
14490 * @return The created item or @c NULL upon failure.
14492 * A new item will be created and added to the toolbar. Its position in
14493 * this toolbar will be just before item @p before.
14495 * Items created with this method can be deleted with
14496 * elm_toolbar_item_del().
14498 * Associated @p data can be properly freed when item is deleted if a
14499 * callback function is set with elm_toolbar_item_del_cb_set().
14501 * If a function is passed as argument, it will be called everytime this item
14502 * is selected, i.e., the user clicks over an unselected item.
14503 * If such function isn't needed, just passing
14504 * @c NULL as @p func is enough. The same should be done for @p data.
14506 * Toolbar will load icon image from fdo or current theme.
14507 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14508 * If an absolute path is provided it will load it direct from a file.
14510 * @see elm_toolbar_item_icon_set()
14511 * @see elm_toolbar_item_del()
14512 * @see elm_toolbar_item_del_cb_set()
14516 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);
14519 * Insert a new item into the toolbar object after item @p after.
14521 * @param obj The toolbar object.
14522 * @param after The toolbar item to insert after.
14523 * @param icon A string with icon name or the absolute path of an image file.
14524 * @param label The label of the item.
14525 * @param func The function to call when the item is clicked.
14526 * @param data The data to associate with the item for related callbacks.
14527 * @return The created item or @c NULL upon failure.
14529 * A new item will be created and added to the toolbar. Its position in
14530 * this toolbar will be just after item @p after.
14532 * Items created with this method can be deleted with
14533 * elm_toolbar_item_del().
14535 * Associated @p data can be properly freed when item is deleted if a
14536 * callback function is set with elm_toolbar_item_del_cb_set().
14538 * If a function is passed as argument, it will be called everytime this item
14539 * is selected, i.e., the user clicks over an unselected item.
14540 * If such function isn't needed, just passing
14541 * @c NULL as @p func is enough. The same should be done for @p data.
14543 * Toolbar will load icon image from fdo or current theme.
14544 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14545 * If an absolute path is provided it will load it direct from a file.
14547 * @see elm_toolbar_item_icon_set()
14548 * @see elm_toolbar_item_del()
14549 * @see elm_toolbar_item_del_cb_set()
14553 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);
14556 * Get the first item in the given toolbar widget's list of
14559 * @param obj The toolbar object
14560 * @return The first item or @c NULL, if it has no items (and on
14563 * @see elm_toolbar_item_append()
14564 * @see elm_toolbar_last_item_get()
14568 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14571 * Get the last item in the given toolbar widget's list of
14574 * @param obj The toolbar object
14575 * @return The last item or @c NULL, if it has no items (and on
14578 * @see elm_toolbar_item_prepend()
14579 * @see elm_toolbar_first_item_get()
14583 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14586 * Get the item after @p item in toolbar.
14588 * @param item The toolbar item.
14589 * @return The item after @p item, or @c NULL if none or on failure.
14591 * @note If it is the last item, @c NULL will be returned.
14593 * @see elm_toolbar_item_append()
14597 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14600 * Get the item before @p item in toolbar.
14602 * @param item The toolbar item.
14603 * @return The item before @p item, or @c NULL if none or on failure.
14605 * @note If it is the first item, @c NULL will be returned.
14607 * @see elm_toolbar_item_prepend()
14611 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14614 * Get the toolbar object from an item.
14616 * @param item The item.
14617 * @return The toolbar object.
14619 * This returns the toolbar object itself that an item belongs to.
14623 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14626 * Set the priority of a toolbar item.
14628 * @param item The toolbar item.
14629 * @param priority The item priority. The default is zero.
14631 * This is used only when the toolbar shrink mode is set to
14632 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14633 * When space is less than required, items with low priority
14634 * will be removed from the toolbar and added to a dynamically-created menu,
14635 * while items with higher priority will remain on the toolbar,
14636 * with the same order they were added.
14638 * @see elm_toolbar_item_priority_get()
14642 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14645 * Get the priority of a toolbar item.
14647 * @param item The toolbar item.
14648 * @return The @p item priority, or @c 0 on failure.
14650 * @see elm_toolbar_item_priority_set() for details.
14654 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14657 * Get the label of item.
14659 * @param item The item of toolbar.
14660 * @return The label of item.
14662 * The return value is a pointer to the label associated to @p item when
14663 * it was created, with function elm_toolbar_item_append() or similar,
14665 * with function elm_toolbar_item_label_set. If no label
14666 * was passed as argument, it will return @c NULL.
14668 * @see elm_toolbar_item_label_set() for more details.
14669 * @see elm_toolbar_item_append()
14673 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14676 * Set the label of item.
14678 * @param item The item of toolbar.
14679 * @param text The label of item.
14681 * The label to be displayed by the item.
14682 * Label will be placed at icons bottom (if set).
14684 * If a label was passed as argument on item creation, with function
14685 * elm_toolbar_item_append() or similar, it will be already
14686 * displayed by the item.
14688 * @see elm_toolbar_item_label_get()
14689 * @see elm_toolbar_item_append()
14693 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14696 * Return the data associated with a given toolbar widget item.
14698 * @param item The toolbar widget item handle.
14699 * @return The data associated with @p item.
14701 * @see elm_toolbar_item_data_set()
14705 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14708 * Set the data associated with a given toolbar widget item.
14710 * @param item The toolbar widget item handle.
14711 * @param data The new data pointer to set to @p item.
14713 * This sets new item data on @p item.
14715 * @warning The old data pointer won't be touched by this function, so
14716 * the user had better to free that old data himself/herself.
14720 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14723 * Returns a pointer to a toolbar item by its label.
14725 * @param obj The toolbar object.
14726 * @param label The label of the item to find.
14728 * @return The pointer to the toolbar item matching @p label or @c NULL
14733 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14736 * Get whether the @p item is selected or not.
14738 * @param item The toolbar item.
14739 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14740 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14742 * @see elm_toolbar_selected_item_set() for details.
14743 * @see elm_toolbar_item_selected_get()
14747 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14750 * Set the selected state of an item.
14752 * @param item The toolbar item
14753 * @param selected The selected state
14755 * This sets the selected state of the given item @p it.
14756 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14758 * If a new item is selected the previosly selected will be unselected.
14759 * Previoulsy selected item can be get with function
14760 * elm_toolbar_selected_item_get().
14762 * Selected items will be highlighted.
14764 * @see elm_toolbar_item_selected_get()
14765 * @see elm_toolbar_selected_item_get()
14769 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14772 * Get the selected item.
14774 * @param obj The toolbar object.
14775 * @return The selected toolbar item.
14777 * The selected item can be unselected with function
14778 * elm_toolbar_item_selected_set().
14780 * The selected item always will be highlighted on toolbar.
14782 * @see elm_toolbar_selected_items_get()
14786 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14789 * Set the icon associated with @p item.
14791 * @param obj The parent of this item.
14792 * @param item The toolbar item.
14793 * @param icon A string with icon name or the absolute path of an image file.
14795 * Toolbar will load icon image from fdo or current theme.
14796 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14797 * If an absolute path is provided it will load it direct from a file.
14799 * @see elm_toolbar_icon_order_lookup_set()
14800 * @see elm_toolbar_icon_order_lookup_get()
14804 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14807 * Get the string used to set the icon of @p item.
14809 * @param item The toolbar item.
14810 * @return The string associated with the icon object.
14812 * @see elm_toolbar_item_icon_set() for details.
14816 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14819 * Get the object of @p item.
14821 * @param item The toolbar item.
14822 * @return The object
14826 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14829 * Get the icon object of @p item.
14831 * @param item The toolbar item.
14832 * @return The icon object
14834 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14838 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14841 * Set the icon associated with @p item to an image in a binary buffer.
14843 * @param item The toolbar item.
14844 * @param img The binary data that will be used as an image
14845 * @param size The size of binary data @p img
14846 * @param format Optional format of @p img to pass to the image loader
14847 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14849 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14851 * @note The icon image set by this function can be changed by
14852 * elm_toolbar_item_icon_set().
14856 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);
14859 * Delete them item from the toolbar.
14861 * @param item The item of toolbar to be deleted.
14863 * @see elm_toolbar_item_append()
14864 * @see elm_toolbar_item_del_cb_set()
14868 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14871 * Set the function called when a toolbar item is freed.
14873 * @param item The item to set the callback on.
14874 * @param func The function called.
14876 * If there is a @p func, then it will be called prior item's memory release.
14877 * That will be called with the following arguments:
14879 * @li item's Evas object;
14882 * This way, a data associated to a toolbar item could be properly freed.
14886 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14889 * Get a value whether toolbar item is disabled or not.
14891 * @param item The item.
14892 * @return The disabled state.
14894 * @see elm_toolbar_item_disabled_set() for more details.
14898 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14901 * Sets the disabled/enabled state of a toolbar item.
14903 * @param item The item.
14904 * @param disabled The disabled state.
14906 * A disabled item cannot be selected or unselected. It will also
14907 * change its appearance (generally greyed out). This sets the
14908 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14913 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14916 * Set or unset item as a separator.
14918 * @param item The toolbar item.
14919 * @param setting @c EINA_TRUE to set item @p item as separator or
14920 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14922 * Items aren't set as separator by default.
14924 * If set as separator it will display separator theme, so won't display
14927 * @see elm_toolbar_item_separator_get()
14931 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14934 * Get a value whether item is a separator or not.
14936 * @param item The toolbar item.
14937 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14938 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14940 * @see elm_toolbar_item_separator_set() for details.
14944 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14947 * Set the shrink state of toolbar @p obj.
14949 * @param obj The toolbar object.
14950 * @param shrink_mode Toolbar's items display behavior.
14952 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14953 * but will enforce a minimun size so all the items will fit, won't scroll
14954 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14955 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14956 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14960 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14963 * Get the shrink mode of toolbar @p obj.
14965 * @param obj The toolbar object.
14966 * @return Toolbar's items display behavior.
14968 * @see elm_toolbar_mode_shrink_set() for details.
14972 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14975 * Enable/disable homogenous mode.
14977 * @param obj The toolbar object
14978 * @param homogeneous Assume the items within the toolbar are of the
14979 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14981 * This will enable the homogeneous mode where items are of the same size.
14982 * @see elm_toolbar_homogeneous_get()
14986 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14989 * Get whether the homogenous mode is enabled.
14991 * @param obj The toolbar object.
14992 * @return Assume the items within the toolbar are of the same height
14993 * and width (EINA_TRUE = on, EINA_FALSE = off).
14995 * @see elm_toolbar_homogeneous_set()
14999 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15002 * Enable/disable homogenous mode.
15004 * @param obj The toolbar object
15005 * @param homogeneous Assume the items within the toolbar are of the
15006 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15008 * This will enable the homogeneous mode where items are of the same size.
15009 * @see elm_toolbar_homogeneous_get()
15011 * @deprecated use elm_toolbar_homogeneous_set() instead.
15015 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15018 * Get whether the homogenous mode is enabled.
15020 * @param obj The toolbar object.
15021 * @return Assume the items within the toolbar are of the same height
15022 * and width (EINA_TRUE = on, EINA_FALSE = off).
15024 * @see elm_toolbar_homogeneous_set()
15025 * @deprecated use elm_toolbar_homogeneous_get() instead.
15029 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15032 * Set the parent object of the toolbar items' menus.
15034 * @param obj The toolbar object.
15035 * @param parent The parent of the menu objects.
15037 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15039 * For more details about setting the parent for toolbar menus, see
15040 * elm_menu_parent_set().
15042 * @see elm_menu_parent_set() for details.
15043 * @see elm_toolbar_item_menu_set() for details.
15047 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15050 * Get the parent object of the toolbar items' menus.
15052 * @param obj The toolbar object.
15053 * @return The parent of the menu objects.
15055 * @see elm_toolbar_menu_parent_set() for details.
15059 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15062 * Set the alignment of the items.
15064 * @param obj The toolbar object.
15065 * @param align The new alignment, a float between <tt> 0.0 </tt>
15066 * and <tt> 1.0 </tt>.
15068 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15069 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15072 * Centered items by default.
15074 * @see elm_toolbar_align_get()
15078 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15081 * Get the alignment of the items.
15083 * @param obj The toolbar object.
15084 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15087 * @see elm_toolbar_align_set() for details.
15091 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15094 * Set whether the toolbar item opens a menu.
15096 * @param item The toolbar item.
15097 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15099 * A toolbar item can be set to be a menu, using this function.
15101 * Once it is set to be a menu, it can be manipulated through the
15102 * menu-like function elm_toolbar_menu_parent_set() and the other
15103 * elm_menu functions, using the Evas_Object @c menu returned by
15104 * elm_toolbar_item_menu_get().
15106 * So, items to be displayed in this item's menu should be added with
15107 * elm_menu_item_add().
15109 * The following code exemplifies the most basic usage:
15111 * tb = elm_toolbar_add(win)
15112 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15113 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15114 * elm_toolbar_menu_parent_set(tb, win);
15115 * menu = elm_toolbar_item_menu_get(item);
15116 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15117 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15121 * @see elm_toolbar_item_menu_get()
15125 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15128 * Get toolbar item's menu.
15130 * @param item The toolbar item.
15131 * @return Item's menu object or @c NULL on failure.
15133 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15134 * this function will set it.
15136 * @see elm_toolbar_item_menu_set() for details.
15140 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15143 * Add a new state to @p item.
15145 * @param item The item.
15146 * @param icon A string with icon name or the absolute path of an image file.
15147 * @param label The label of the new state.
15148 * @param func The function to call when the item is clicked when this
15149 * state is selected.
15150 * @param data The data to associate with the state.
15151 * @return The toolbar item state, or @c NULL upon failure.
15153 * Toolbar will load icon image from fdo or current theme.
15154 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15155 * If an absolute path is provided it will load it direct from a file.
15157 * States created with this function can be removed with
15158 * elm_toolbar_item_state_del().
15160 * @see elm_toolbar_item_state_del()
15161 * @see elm_toolbar_item_state_sel()
15162 * @see elm_toolbar_item_state_get()
15166 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);
15169 * Delete a previoulsy added state to @p item.
15171 * @param item The toolbar item.
15172 * @param state The state to be deleted.
15173 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15175 * @see elm_toolbar_item_state_add()
15177 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15180 * Set @p state as the current state of @p it.
15182 * @param it The item.
15183 * @param state The state to use.
15184 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15186 * If @p state is @c NULL, it won't select any state and the default item's
15187 * icon and label will be used. It's the same behaviour than
15188 * elm_toolbar_item_state_unser().
15190 * @see elm_toolbar_item_state_unset()
15194 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15197 * Unset the state of @p it.
15199 * @param it The item.
15201 * The default icon and label from this item will be displayed.
15203 * @see elm_toolbar_item_state_set() for more details.
15207 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15210 * Get the current state of @p it.
15212 * @param item The item.
15213 * @return The selected state or @c NULL if none is selected or on failure.
15215 * @see elm_toolbar_item_state_set() for details.
15216 * @see elm_toolbar_item_state_unset()
15217 * @see elm_toolbar_item_state_add()
15221 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15224 * Get the state after selected state in toolbar's @p item.
15226 * @param it The toolbar item to change state.
15227 * @return The state after current state, or @c NULL on failure.
15229 * If last state is selected, this function will return first state.
15231 * @see elm_toolbar_item_state_set()
15232 * @see elm_toolbar_item_state_add()
15236 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15239 * Get the state before selected state in toolbar's @p item.
15241 * @param it The toolbar item to change state.
15242 * @return The state before current state, or @c NULL on failure.
15244 * If first state is selected, this function will return last state.
15246 * @see elm_toolbar_item_state_set()
15247 * @see elm_toolbar_item_state_add()
15251 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15254 * Set the text to be shown in a given toolbar item's tooltips.
15256 * @param item Target item.
15257 * @param text The text to set in the content.
15259 * Setup the text as tooltip to object. The item can have only one tooltip,
15260 * so any previous tooltip data - set with this function or
15261 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15263 * @see elm_object_tooltip_text_set() for more details.
15267 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15270 * Set the content to be shown in the tooltip item.
15272 * Setup the tooltip to item. The item can have only one tooltip,
15273 * so any previous tooltip data is removed. @p func(with @p data) will
15274 * be called every time that need show the tooltip and it should
15275 * return a valid Evas_Object. This object is then managed fully by
15276 * tooltip system and is deleted when the tooltip is gone.
15278 * @param item the toolbar item being attached a tooltip.
15279 * @param func the function used to create the tooltip contents.
15280 * @param data what to provide to @a func as callback data/context.
15281 * @param del_cb called when data is not needed anymore, either when
15282 * another callback replaces @a func, the tooltip is unset with
15283 * elm_toolbar_item_tooltip_unset() or the owner @a item
15284 * dies. This callback receives as the first parameter the
15285 * given @a data, and @c event_info is the item.
15287 * @see elm_object_tooltip_content_cb_set() for more details.
15291 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);
15294 * Unset tooltip from item.
15296 * @param item toolbar item to remove previously set tooltip.
15298 * Remove tooltip from item. The callback provided as del_cb to
15299 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15300 * it is not used anymore.
15302 * @see elm_object_tooltip_unset() for more details.
15303 * @see elm_toolbar_item_tooltip_content_cb_set()
15307 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15310 * Sets a different style for this item tooltip.
15312 * @note before you set a style you should define a tooltip with
15313 * elm_toolbar_item_tooltip_content_cb_set() or
15314 * elm_toolbar_item_tooltip_text_set()
15316 * @param item toolbar item with tooltip already set.
15317 * @param style the theme style to use (default, transparent, ...)
15319 * @see elm_object_tooltip_style_set() for more details.
15323 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15326 * Get the style for this item tooltip.
15328 * @param item toolbar item with tooltip already set.
15329 * @return style the theme style in use, defaults to "default". If the
15330 * object does not have a tooltip set, then NULL is returned.
15332 * @see elm_object_tooltip_style_get() for more details.
15333 * @see elm_toolbar_item_tooltip_style_set()
15337 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15340 * Set the type of mouse pointer/cursor decoration to be shown,
15341 * when the mouse pointer is over the given toolbar widget item
15343 * @param item toolbar item to customize cursor on
15344 * @param cursor the cursor type's name
15346 * This function works analogously as elm_object_cursor_set(), but
15347 * here the cursor's changing area is restricted to the item's
15348 * area, and not the whole widget's. Note that that item cursors
15349 * have precedence over widget cursors, so that a mouse over an
15350 * item with custom cursor set will always show @b that cursor.
15352 * If this function is called twice for an object, a previously set
15353 * cursor will be unset on the second call.
15355 * @see elm_object_cursor_set()
15356 * @see elm_toolbar_item_cursor_get()
15357 * @see elm_toolbar_item_cursor_unset()
15361 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15364 * Get the type of mouse pointer/cursor decoration set to be shown,
15365 * when the mouse pointer is over the given toolbar widget item
15367 * @param item toolbar item with custom cursor set
15368 * @return the cursor type's name or @c NULL, if no custom cursors
15369 * were set to @p item (and on errors)
15371 * @see elm_object_cursor_get()
15372 * @see elm_toolbar_item_cursor_set()
15373 * @see elm_toolbar_item_cursor_unset()
15377 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15380 * Unset any custom mouse pointer/cursor decoration set to be
15381 * shown, when the mouse pointer is over the given toolbar widget
15382 * item, thus making it show the @b default cursor again.
15384 * @param item a toolbar item
15386 * Use this call to undo any custom settings on this item's cursor
15387 * decoration, bringing it back to defaults (no custom style set).
15389 * @see elm_object_cursor_unset()
15390 * @see elm_toolbar_item_cursor_set()
15394 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15397 * Set a different @b style for a given custom cursor set for a
15400 * @param item toolbar item with custom cursor set
15401 * @param style the <b>theme style</b> to use (e.g. @c "default",
15402 * @c "transparent", etc)
15404 * This function only makes sense when one is using custom mouse
15405 * cursor decorations <b>defined in a theme file</b>, which can have,
15406 * given a cursor name/type, <b>alternate styles</b> on it. It
15407 * works analogously as elm_object_cursor_style_set(), but here
15408 * applyed only to toolbar item objects.
15410 * @warning Before you set a cursor style you should have definen a
15411 * custom cursor previously on the item, with
15412 * elm_toolbar_item_cursor_set()
15414 * @see elm_toolbar_item_cursor_engine_only_set()
15415 * @see elm_toolbar_item_cursor_style_get()
15419 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15422 * Get the current @b style set for a given toolbar item's custom
15425 * @param item toolbar item with custom cursor set.
15426 * @return style the cursor style in use. If the object does not
15427 * have a cursor set, then @c NULL is returned.
15429 * @see elm_toolbar_item_cursor_style_set() for more details
15433 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15436 * Set if the (custom)cursor for a given toolbar item should be
15437 * searched in its theme, also, or should only rely on the
15438 * rendering engine.
15440 * @param item item with custom (custom) cursor already set on
15441 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15442 * only on those provided by the rendering engine, @c EINA_FALSE to
15443 * have them searched on the widget's theme, as well.
15445 * @note This call is of use only if you've set a custom cursor
15446 * for toolbar items, with elm_toolbar_item_cursor_set().
15448 * @note By default, cursors will only be looked for between those
15449 * provided by the rendering engine.
15453 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15456 * Get if the (custom) cursor for a given toolbar item is being
15457 * searched in its theme, also, or is only relying on the rendering
15460 * @param item a toolbar item
15461 * @return @c EINA_TRUE, if cursors are being looked for only on
15462 * those provided by the rendering engine, @c EINA_FALSE if they
15463 * are being searched on the widget's theme, as well.
15465 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15469 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15472 * Change a toolbar's orientation
15473 * @param obj The toolbar object
15474 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15475 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15477 * @deprecated use elm_toolbar_horizontal_set() instead.
15479 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15482 * Change a toolbar's orientation
15483 * @param obj The toolbar object
15484 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15485 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15488 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15491 * Get a toolbar's orientation
15492 * @param obj The toolbar object
15493 * @return If @c EINA_TRUE, the toolbar is vertical
15494 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15496 * @deprecated use elm_toolbar_horizontal_get() instead.
15498 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15501 * Get a toolbar's orientation
15502 * @param obj The toolbar object
15503 * @return If @c EINA_TRUE, the toolbar is horizontal
15504 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15507 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15513 * @defgroup Tooltips Tooltips
15515 * The Tooltip is an (internal, for now) smart object used to show a
15516 * content in a frame on mouse hover of objects(or widgets), with
15517 * tips/information about them.
15522 EAPI double elm_tooltip_delay_get(void);
15523 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15524 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15525 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15526 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15527 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15528 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15529 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);
15530 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15531 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15532 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15535 * @defgroup Cursors Cursors
15537 * The Elementary cursor is an internal smart object used to
15538 * customize the mouse cursor displayed over objects (or
15539 * widgets). In the most common scenario, the cursor decoration
15540 * comes from the graphical @b engine Elementary is running
15541 * on. Those engines may provide different decorations for cursors,
15542 * and Elementary provides functions to choose them (think of X11
15543 * cursors, as an example).
15545 * There's also the possibility of, besides using engine provided
15546 * cursors, also use ones coming from Edje theming files. Both
15547 * globally and per widget, Elementary makes it possible for one to
15548 * make the cursors lookup to be held on engines only or on
15549 * Elementary's theme file, too. To set cursor's hot spot,
15550 * two data items should be added to cursor's theme: "hot_x" and
15551 * "hot_y", that are the offset from upper-left corner of the cursor
15552 * (coordinates 0,0).
15558 * Set the cursor to be shown when mouse is over the object
15560 * Set the cursor that will be displayed when mouse is over the
15561 * object. The object can have only one cursor set to it, so if
15562 * this function is called twice for an object, the previous set
15564 * If using X cursors, a definition of all the valid cursor names
15565 * is listed on Elementary_Cursors.h. If an invalid name is set
15566 * the default cursor will be used.
15568 * @param obj the object being set a cursor.
15569 * @param cursor the cursor name to be used.
15573 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15576 * Get the cursor to be shown when mouse is over the object
15578 * @param obj an object with cursor already set.
15579 * @return the cursor name.
15583 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15586 * Unset cursor for object
15588 * Unset cursor for object, and set the cursor to default if the mouse
15589 * was over this object.
15591 * @param obj Target object
15592 * @see elm_object_cursor_set()
15596 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15599 * Sets a different style for this object cursor.
15601 * @note before you set a style you should define a cursor with
15602 * elm_object_cursor_set()
15604 * @param obj an object with cursor already set.
15605 * @param style the theme style to use (default, transparent, ...)
15609 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15612 * Get the style for this object cursor.
15614 * @param obj an object with cursor already set.
15615 * @return style the theme style in use, defaults to "default". If the
15616 * object does not have a cursor set, then NULL is returned.
15620 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15623 * Set if the cursor set should be searched on the theme or should use
15624 * the provided by the engine, only.
15626 * @note before you set if should look on theme you should define a cursor
15627 * with elm_object_cursor_set(). By default it will only look for cursors
15628 * provided by the engine.
15630 * @param obj an object with cursor already set.
15631 * @param engine_only boolean to define it cursors should be looked only
15632 * between the provided by the engine or searched on widget's theme as well.
15636 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15639 * Get the cursor engine only usage for this object cursor.
15641 * @param obj an object with cursor already set.
15642 * @return engine_only boolean to define it cursors should be
15643 * looked only between the provided by the engine or searched on
15644 * widget's theme as well. If the object does not have a cursor
15645 * set, then EINA_FALSE is returned.
15649 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15652 * Get the configured cursor engine only usage
15654 * This gets the globally configured exclusive usage of engine cursors.
15656 * @return 1 if only engine cursors should be used
15659 EAPI int elm_cursor_engine_only_get(void);
15662 * Set the configured cursor engine only usage
15664 * This sets the globally configured exclusive usage of engine cursors.
15665 * It won't affect cursors set before changing this value.
15667 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15668 * look for them on theme before.
15669 * @return EINA_TRUE if value is valid and setted (0 or 1)
15672 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15679 * @defgroup Menu Menu
15681 * @image html img/widget/menu/preview-00.png
15682 * @image latex img/widget/menu/preview-00.eps
15684 * A menu is a list of items displayed above its parent. When the menu is
15685 * showing its parent is darkened. Each item can have a sub-menu. The menu
15686 * object can be used to display a menu on a right click event, in a toolbar,
15689 * Signals that you can add callbacks for are:
15690 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15691 * event_info is NULL.
15693 * @see @ref tutorial_menu
15696 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15698 * @brief Add a new menu to the parent
15700 * @param parent The parent object.
15701 * @return The new object or NULL if it cannot be created.
15703 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15705 * @brief Set the parent for the given menu widget
15707 * @param obj The menu object.
15708 * @param parent The new parent.
15710 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15712 * @brief Get the parent for the given menu widget
15714 * @param obj The menu object.
15715 * @return The parent.
15717 * @see elm_menu_parent_set()
15719 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15721 * @brief Move the menu to a new position
15723 * @param obj The menu object.
15724 * @param x The new position.
15725 * @param y The new position.
15727 * Sets the top-left position of the menu to (@p x,@p y).
15729 * @note @p x and @p y coordinates are relative to parent.
15731 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15733 * @brief Close a opened menu
15735 * @param obj the menu object
15738 * Hides the menu and all it's sub-menus.
15740 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15742 * @brief Returns a list of @p item's items.
15744 * @param obj The menu object
15745 * @return An Eina_List* of @p item's items
15747 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15749 * @brief Get the Evas_Object of an Elm_Menu_Item
15751 * @param item The menu item object.
15752 * @return The edje object containing the swallowed content
15754 * @warning Don't manipulate this object!
15756 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15758 * @brief Add an item at the end of the given menu widget
15760 * @param obj The menu object.
15761 * @param parent The parent menu item (optional)
15762 * @param icon A icon display on the item. The icon will be destryed by the menu.
15763 * @param label The label of the item.
15764 * @param func Function called when the user select the item.
15765 * @param data Data sent by the callback.
15766 * @return Returns the new item.
15768 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);
15770 * @brief Add an object swallowed in an item at the end of the given menu
15773 * @param obj The menu object.
15774 * @param parent The parent menu item (optional)
15775 * @param subobj The object to swallow
15776 * @param func Function called when the user select the item.
15777 * @param data Data sent by the callback.
15778 * @return Returns the new item.
15780 * Add an evas object as an item to the menu.
15782 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);
15784 * @brief Set the label of a menu item
15786 * @param item The menu item object.
15787 * @param label The label to set for @p item
15789 * @warning Don't use this funcion on items created with
15790 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15792 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15794 * @brief Get the label of a menu item
15796 * @param item The menu item object.
15797 * @return The label of @p item
15799 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15801 * @brief Set the icon of a menu item to the standard icon with name @p icon
15803 * @param item The menu item object.
15804 * @param icon The icon object to set for the content of @p item
15806 * Once this icon is set, any previously set icon will be deleted.
15808 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15810 * @brief Get the string representation from the icon of a menu item
15812 * @param item The menu item object.
15813 * @return The string representation of @p item's icon or NULL
15815 * @see elm_menu_item_object_icon_name_set()
15817 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15819 * @brief Set the content object of a menu item
15821 * @param item The menu item object
15822 * @param The content object or NULL
15823 * @return EINA_TRUE on success, else EINA_FALSE
15825 * Use this function to change the object swallowed by a menu item, deleting
15826 * any previously swallowed object.
15828 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15830 * @brief Get the content object of a menu item
15832 * @param item The menu item object
15833 * @return The content object or NULL
15834 * @note If @p item was added with elm_menu_item_add_object, this
15835 * function will return the object passed, else it will return the
15838 * @see elm_menu_item_object_content_set()
15840 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15842 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15844 elm_menu_item_object_icon_name_set(item, icon);
15847 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15849 return elm_menu_item_object_content_get(item);
15852 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15854 return elm_menu_item_object_icon_name_get(item);
15858 * @brief Set the selected state of @p item.
15860 * @param item The menu item object.
15861 * @param selected The selected/unselected state of the item
15863 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15865 * @brief Get the selected state of @p item.
15867 * @param item The menu item object.
15868 * @return The selected/unselected state of the item
15870 * @see elm_menu_item_selected_set()
15872 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15874 * @brief Set the disabled state of @p item.
15876 * @param item The menu item object.
15877 * @param disabled The enabled/disabled state of the item
15879 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15881 * @brief Get the disabled state of @p item.
15883 * @param item The menu item object.
15884 * @return The enabled/disabled state of the item
15886 * @see elm_menu_item_disabled_set()
15888 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15890 * @brief Add a separator item to menu @p obj under @p parent.
15892 * @param obj The menu object
15893 * @param parent The item to add the separator under
15894 * @return The created item or NULL on failure
15896 * This is item is a @ref Separator.
15898 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15900 * @brief Returns whether @p item is a separator.
15902 * @param item The item to check
15903 * @return If true, @p item is a separator
15905 * @see elm_menu_item_separator_add()
15907 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15909 * @brief Deletes an item from the menu.
15911 * @param item The item to delete.
15913 * @see elm_menu_item_add()
15915 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15917 * @brief Set the function called when a menu item is deleted.
15919 * @param item The item to set the callback on
15920 * @param func The function called
15922 * @see elm_menu_item_add()
15923 * @see elm_menu_item_del()
15925 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15927 * @brief Returns the data associated with menu item @p item.
15929 * @param item The item
15930 * @return The data associated with @p item or NULL if none was set.
15932 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15934 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15936 * @brief Sets the data to be associated with menu item @p item.
15938 * @param item The item
15939 * @param data The data to be associated with @p item
15941 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15943 * @brief Returns a list of @p item's subitems.
15945 * @param item The item
15946 * @return An Eina_List* of @p item's subitems
15948 * @see elm_menu_add()
15950 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15952 * @brief Get the position of a menu item
15954 * @param item The menu item
15955 * @return The item's index
15957 * This function returns the index position of a menu item in a menu.
15958 * For a sub-menu, this number is relative to the first item in the sub-menu.
15960 * @note Index values begin with 0
15962 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15964 * @brief @brief Return a menu item's owner menu
15966 * @param item The menu item
15967 * @return The menu object owning @p item, or NULL on failure
15969 * Use this function to get the menu object owning an item.
15971 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15973 * @brief Get the selected item in the menu
15975 * @param obj The menu object
15976 * @return The selected item, or NULL if none
15978 * @see elm_menu_item_selected_get()
15979 * @see elm_menu_item_selected_set()
15981 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15983 * @brief Get the last item in the menu
15985 * @param obj The menu object
15986 * @return The last item, or NULL if none
15988 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15990 * @brief Get the first item in the menu
15992 * @param obj The menu object
15993 * @return The first item, or NULL if none
15995 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15997 * @brief Get the next item in the menu.
15999 * @param item The menu item object.
16000 * @return The item after it, or NULL if none
16002 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16004 * @brief Get the previous item in the menu.
16006 * @param item The menu item object.
16007 * @return The item before it, or NULL if none
16009 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16015 * @defgroup List List
16016 * @ingroup Elementary
16018 * @image html img/widget/list/preview-00.png
16019 * @image latex img/widget/list/preview-00.eps width=\textwidth
16021 * @image html img/list.png
16022 * @image latex img/list.eps width=\textwidth
16024 * A list widget is a container whose children are displayed vertically or
16025 * horizontally, in order, and can be selected.
16026 * The list can accept only one or multiple items selection. Also has many
16027 * modes of items displaying.
16029 * A list is a very simple type of list widget. For more robust
16030 * lists, @ref Genlist should probably be used.
16032 * Smart callbacks one can listen to:
16033 * - @c "activated" - The user has double-clicked or pressed
16034 * (enter|return|spacebar) on an item. The @c event_info parameter
16035 * is the item that was activated.
16036 * - @c "clicked,double" - The user has double-clicked an item.
16037 * The @c event_info parameter is the item that was double-clicked.
16038 * - "selected" - when the user selected an item
16039 * - "unselected" - when the user unselected an item
16040 * - "longpressed" - an item in the list is long-pressed
16041 * - "edge,top" - the list is scrolled until the top edge
16042 * - "edge,bottom" - the list is scrolled until the bottom edge
16043 * - "edge,left" - the list is scrolled until the left edge
16044 * - "edge,right" - the list is scrolled until the right edge
16045 * - "language,changed" - the program's language changed
16047 * Available styles for it:
16050 * List of examples:
16051 * @li @ref list_example_01
16052 * @li @ref list_example_02
16053 * @li @ref list_example_03
16062 * @enum _Elm_List_Mode
16063 * @typedef Elm_List_Mode
16065 * Set list's resize behavior, transverse axis scroll and
16066 * items cropping. See each mode's description for more details.
16068 * @note Default value is #ELM_LIST_SCROLL.
16070 * Values <b> don't </b> work as bitmask, only one can be choosen.
16072 * @see elm_list_mode_set()
16073 * @see elm_list_mode_get()
16077 typedef enum _Elm_List_Mode
16079 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. */
16080 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). */
16081 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. */
16082 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. */
16083 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16086 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(). */
16089 * Add a new list widget to the given parent Elementary
16090 * (container) object.
16092 * @param parent The parent object.
16093 * @return a new list widget handle or @c NULL, on errors.
16095 * This function inserts a new list widget on the canvas.
16099 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16104 * @param obj The list object
16106 * @note Call before running show() on the list object.
16107 * @warning If not called, it won't display the list properly.
16110 * li = elm_list_add(win);
16111 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16112 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16114 * evas_object_show(li);
16119 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16122 * Enable or disable multiple items selection on the list object.
16124 * @param obj The list object
16125 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16128 * Disabled by default. If disabled, the user can select a single item of
16129 * the list each time. Selected items are highlighted on list.
16130 * If enabled, many items can be selected.
16132 * If a selected item is selected again, it will be unselected.
16134 * @see elm_list_multi_select_get()
16138 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16141 * Get a value whether multiple items selection is enabled or not.
16143 * @see elm_list_multi_select_set() for details.
16145 * @param obj The list object.
16146 * @return @c EINA_TRUE means multiple items selection is enabled.
16147 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16148 * @c EINA_FALSE is returned.
16152 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16155 * Set which mode to use for the list object.
16157 * @param obj The list object
16158 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16159 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16161 * Set list's resize behavior, transverse axis scroll and
16162 * items cropping. See each mode's description for more details.
16164 * @note Default value is #ELM_LIST_SCROLL.
16166 * Only one can be set, if a previous one was set, it will be changed
16167 * by the new mode set. Bitmask won't work as well.
16169 * @see elm_list_mode_get()
16173 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16176 * Get the mode the list is at.
16178 * @param obj The list object
16179 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16180 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16182 * @note see elm_list_mode_set() for more information.
16186 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16189 * Enable or disable horizontal mode on the list object.
16191 * @param obj The list object.
16192 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16193 * disable it, i.e., to enable vertical mode.
16195 * @note Vertical mode is set by default.
16197 * On horizontal mode items are displayed on list from left to right,
16198 * instead of from top to bottom. Also, the list will scroll horizontally.
16199 * Each item will presents left icon on top and right icon, or end, at
16202 * @see elm_list_horizontal_get()
16206 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16209 * Get a value whether horizontal mode is enabled or not.
16211 * @param obj The list object.
16212 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16213 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16214 * @c EINA_FALSE is returned.
16216 * @see elm_list_horizontal_set() for details.
16220 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16223 * Enable or disable always select mode on the list object.
16225 * @param obj The list object
16226 * @param always_select @c EINA_TRUE to enable always select mode or
16227 * @c EINA_FALSE to disable it.
16229 * @note Always select mode is disabled by default.
16231 * Default behavior of list items is to only call its callback function
16232 * the first time it's pressed, i.e., when it is selected. If a selected
16233 * item is pressed again, and multi-select is disabled, it won't call
16234 * this function (if multi-select is enabled it will unselect the item).
16236 * If always select is enabled, it will call the callback function
16237 * everytime a item is pressed, so it will call when the item is selected,
16238 * and again when a selected item is pressed.
16240 * @see elm_list_always_select_mode_get()
16241 * @see elm_list_multi_select_set()
16245 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16248 * Get a value whether always select mode is enabled or not, meaning that
16249 * an item will always call its callback function, even if already selected.
16251 * @param obj The list object
16252 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16253 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16254 * @c EINA_FALSE is returned.
16256 * @see elm_list_always_select_mode_set() for details.
16260 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16263 * Set bouncing behaviour when the scrolled content reaches an edge.
16265 * Tell the internal scroller object whether it should bounce or not
16266 * when it reaches the respective edges for each axis.
16268 * @param obj The list object
16269 * @param h_bounce Whether to bounce or not in the horizontal axis.
16270 * @param v_bounce Whether to bounce or not in the vertical axis.
16272 * @see elm_scroller_bounce_set()
16276 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16279 * Get the bouncing behaviour of the internal scroller.
16281 * Get whether the internal scroller should bounce when the edge of each
16282 * axis is reached scrolling.
16284 * @param obj The list object.
16285 * @param h_bounce Pointer where to store the bounce state of the horizontal
16287 * @param v_bounce Pointer where to store the bounce state of the vertical
16290 * @see elm_scroller_bounce_get()
16291 * @see elm_list_bounce_set()
16295 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16298 * Set the scrollbar policy.
16300 * @param obj The list object
16301 * @param policy_h Horizontal scrollbar policy.
16302 * @param policy_v Vertical scrollbar policy.
16304 * This sets the scrollbar visibility policy for the given scroller.
16305 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16306 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16307 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16308 * This applies respectively for the horizontal and vertical scrollbars.
16310 * The both are disabled by default, i.e., are set to
16311 * #ELM_SCROLLER_POLICY_OFF.
16315 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16318 * Get the scrollbar policy.
16320 * @see elm_list_scroller_policy_get() for details.
16322 * @param obj The list object.
16323 * @param policy_h Pointer where to store horizontal scrollbar policy.
16324 * @param policy_v Pointer where to store vertical scrollbar policy.
16328 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);
16331 * Append a new item to the list object.
16333 * @param obj The list object.
16334 * @param label The label of the list item.
16335 * @param icon The icon object to use for the left side of the item. An
16336 * icon can be any Evas object, but usually it is an icon created
16337 * with elm_icon_add().
16338 * @param end The icon object to use for the right side of the item. An
16339 * icon can be any Evas object.
16340 * @param func The function to call when the item is clicked.
16341 * @param data The data to associate with the item for related callbacks.
16343 * @return The created item or @c NULL upon failure.
16345 * A new item will be created and appended to the list, i.e., will
16346 * be set as @b last item.
16348 * Items created with this method can be deleted with
16349 * elm_list_item_del().
16351 * Associated @p data can be properly freed when item is deleted if a
16352 * callback function is set with elm_list_item_del_cb_set().
16354 * If a function is passed as argument, it will be called everytime this item
16355 * is selected, i.e., the user clicks over an unselected item.
16356 * If always select is enabled it will call this function every time
16357 * user clicks over an item (already selected or not).
16358 * If such function isn't needed, just passing
16359 * @c NULL as @p func is enough. The same should be done for @p data.
16361 * Simple example (with no function callback or data associated):
16363 * li = elm_list_add(win);
16364 * ic = elm_icon_add(win);
16365 * elm_icon_file_set(ic, "path/to/image", NULL);
16366 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16367 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16369 * evas_object_show(li);
16372 * @see elm_list_always_select_mode_set()
16373 * @see elm_list_item_del()
16374 * @see elm_list_item_del_cb_set()
16375 * @see elm_list_clear()
16376 * @see elm_icon_add()
16380 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);
16383 * Prepend a new item to the list object.
16385 * @param obj The list object.
16386 * @param label The label of the list item.
16387 * @param icon The icon object to use for the left side of the item. An
16388 * icon can be any Evas object, but usually it is an icon created
16389 * with elm_icon_add().
16390 * @param end The icon object to use for the right side of the item. An
16391 * icon can be any Evas object.
16392 * @param func The function to call when the item is clicked.
16393 * @param data The data to associate with the item for related callbacks.
16395 * @return The created item or @c NULL upon failure.
16397 * A new item will be created and prepended to the list, i.e., will
16398 * be set as @b first item.
16400 * Items created with this method can be deleted with
16401 * elm_list_item_del().
16403 * Associated @p data can be properly freed when item is deleted if a
16404 * callback function is set with elm_list_item_del_cb_set().
16406 * If a function is passed as argument, it will be called everytime this item
16407 * is selected, i.e., the user clicks over an unselected item.
16408 * If always select is enabled it will call this function every time
16409 * user clicks over an item (already selected or not).
16410 * If such function isn't needed, just passing
16411 * @c NULL as @p func is enough. The same should be done for @p data.
16413 * @see elm_list_item_append() for a simple code example.
16414 * @see elm_list_always_select_mode_set()
16415 * @see elm_list_item_del()
16416 * @see elm_list_item_del_cb_set()
16417 * @see elm_list_clear()
16418 * @see elm_icon_add()
16422 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);
16425 * Insert a new item into the list object before item @p before.
16427 * @param obj The list object.
16428 * @param before The list item to insert before.
16429 * @param label The label of the list item.
16430 * @param icon The icon object to use for the left side of the item. An
16431 * icon can be any Evas object, but usually it is an icon created
16432 * with elm_icon_add().
16433 * @param end The icon object to use for the right side of the item. An
16434 * icon can be any Evas object.
16435 * @param func The function to call when the item is clicked.
16436 * @param data The data to associate with the item for related callbacks.
16438 * @return The created item or @c NULL upon failure.
16440 * A new item will be created and added to the list. Its position in
16441 * this list will be just before item @p before.
16443 * Items created with this method can be deleted with
16444 * elm_list_item_del().
16446 * Associated @p data can be properly freed when item is deleted if a
16447 * callback function is set with elm_list_item_del_cb_set().
16449 * If a function is passed as argument, it will be called everytime this item
16450 * is selected, i.e., the user clicks over an unselected item.
16451 * If always select is enabled it will call this function every time
16452 * user clicks over an item (already selected or not).
16453 * If such function isn't needed, just passing
16454 * @c NULL as @p func is enough. The same should be done for @p data.
16456 * @see elm_list_item_append() for a simple code example.
16457 * @see elm_list_always_select_mode_set()
16458 * @see elm_list_item_del()
16459 * @see elm_list_item_del_cb_set()
16460 * @see elm_list_clear()
16461 * @see elm_icon_add()
16465 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);
16468 * Insert a new item into the list object after item @p after.
16470 * @param obj The list object.
16471 * @param after The list item to insert after.
16472 * @param label The label of the list item.
16473 * @param icon The icon object to use for the left side of the item. An
16474 * icon can be any Evas object, but usually it is an icon created
16475 * with elm_icon_add().
16476 * @param end The icon object to use for the right side of the item. An
16477 * icon can be any Evas object.
16478 * @param func The function to call when the item is clicked.
16479 * @param data The data to associate with the item for related callbacks.
16481 * @return The created item or @c NULL upon failure.
16483 * A new item will be created and added to the list. Its position in
16484 * this list will be just after item @p after.
16486 * Items created with this method can be deleted with
16487 * elm_list_item_del().
16489 * Associated @p data can be properly freed when item is deleted if a
16490 * callback function is set with elm_list_item_del_cb_set().
16492 * If a function is passed as argument, it will be called everytime this item
16493 * is selected, i.e., the user clicks over an unselected item.
16494 * If always select is enabled it will call this function every time
16495 * user clicks over an item (already selected or not).
16496 * If such function isn't needed, just passing
16497 * @c NULL as @p func is enough. The same should be done for @p data.
16499 * @see elm_list_item_append() for a simple code example.
16500 * @see elm_list_always_select_mode_set()
16501 * @see elm_list_item_del()
16502 * @see elm_list_item_del_cb_set()
16503 * @see elm_list_clear()
16504 * @see elm_icon_add()
16508 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);
16511 * Insert a new item into the sorted list object.
16513 * @param obj The list object.
16514 * @param label The label of the list item.
16515 * @param icon The icon object to use for the left side of the item. An
16516 * icon can be any Evas object, but usually it is an icon created
16517 * with elm_icon_add().
16518 * @param end The icon object to use for the right side of the item. An
16519 * icon can be any Evas object.
16520 * @param func The function to call when the item is clicked.
16521 * @param data The data to associate with the item for related callbacks.
16522 * @param cmp_func The comparing function to be used to sort list
16523 * items <b>by #Elm_List_Item item handles</b>. This function will
16524 * receive two items and compare them, returning a non-negative integer
16525 * if the second item should be place after the first, or negative value
16526 * if should be placed before.
16528 * @return The created item or @c NULL upon failure.
16530 * @note This function inserts values into a list object assuming it was
16531 * sorted and the result will be sorted.
16533 * A new item will be created and added to the list. Its position in
16534 * this list will be found comparing the new item with previously inserted
16535 * items using function @p cmp_func.
16537 * Items created with this method can be deleted with
16538 * elm_list_item_del().
16540 * Associated @p data can be properly freed when item is deleted if a
16541 * callback function is set with elm_list_item_del_cb_set().
16543 * If a function is passed as argument, it will be called everytime this item
16544 * is selected, i.e., the user clicks over an unselected item.
16545 * If always select is enabled it will call this function every time
16546 * user clicks over an item (already selected or not).
16547 * If such function isn't needed, just passing
16548 * @c NULL as @p func is enough. The same should be done for @p data.
16550 * @see elm_list_item_append() for a simple code example.
16551 * @see elm_list_always_select_mode_set()
16552 * @see elm_list_item_del()
16553 * @see elm_list_item_del_cb_set()
16554 * @see elm_list_clear()
16555 * @see elm_icon_add()
16559 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);
16562 * Remove all list's items.
16564 * @param obj The list object
16566 * @see elm_list_item_del()
16567 * @see elm_list_item_append()
16571 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16574 * Get a list of all the list items.
16576 * @param obj The list object
16577 * @return An @c Eina_List of list items, #Elm_List_Item,
16578 * or @c NULL on failure.
16580 * @see elm_list_item_append()
16581 * @see elm_list_item_del()
16582 * @see elm_list_clear()
16586 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16589 * Get the selected item.
16591 * @param obj The list object.
16592 * @return The selected list item.
16594 * The selected item can be unselected with function
16595 * elm_list_item_selected_set().
16597 * The selected item always will be highlighted on list.
16599 * @see elm_list_selected_items_get()
16603 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16606 * Return a list of the currently selected list items.
16608 * @param obj The list object.
16609 * @return An @c Eina_List of list items, #Elm_List_Item,
16610 * or @c NULL on failure.
16612 * Multiple items can be selected if multi select is enabled. It can be
16613 * done with elm_list_multi_select_set().
16615 * @see elm_list_selected_item_get()
16616 * @see elm_list_multi_select_set()
16620 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16623 * Set the selected state of an item.
16625 * @param item The list item
16626 * @param selected The selected state
16628 * This sets the selected state of the given item @p it.
16629 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16631 * If a new item is selected the previosly selected will be unselected,
16632 * unless multiple selection is enabled with elm_list_multi_select_set().
16633 * Previoulsy selected item can be get with function
16634 * elm_list_selected_item_get().
16636 * Selected items will be highlighted.
16638 * @see elm_list_item_selected_get()
16639 * @see elm_list_selected_item_get()
16640 * @see elm_list_multi_select_set()
16644 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16647 * Get whether the @p item is selected or not.
16649 * @param item The list item.
16650 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16651 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16653 * @see elm_list_selected_item_set() for details.
16654 * @see elm_list_item_selected_get()
16658 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16661 * Set or unset item as a separator.
16663 * @param it The list item.
16664 * @param setting @c EINA_TRUE to set item @p it as separator or
16665 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16667 * Items aren't set as separator by default.
16669 * If set as separator it will display separator theme, so won't display
16672 * @see elm_list_item_separator_get()
16676 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16679 * Get a value whether item is a separator or not.
16681 * @see elm_list_item_separator_set() for details.
16683 * @param it The list item.
16684 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16685 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16689 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16692 * Show @p item in the list view.
16694 * @param item The list item to be shown.
16696 * It won't animate list until item is visible. If such behavior is wanted,
16697 * use elm_list_bring_in() intead.
16701 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16704 * Bring in the given item to list view.
16706 * @param item The item.
16708 * This causes list to jump to the given item @p item and show it
16709 * (by scrolling), if it is not fully visible.
16711 * This may use animation to do so and take a period of time.
16713 * If animation isn't wanted, elm_list_item_show() can be used.
16717 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16720 * Delete them item from the list.
16722 * @param item The item of list to be deleted.
16724 * If deleting all list items is required, elm_list_clear()
16725 * should be used instead of getting items list and deleting each one.
16727 * @see elm_list_clear()
16728 * @see elm_list_item_append()
16729 * @see elm_list_item_del_cb_set()
16733 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16736 * Set the function called when a list item is freed.
16738 * @param item The item to set the callback on
16739 * @param func The function called
16741 * If there is a @p func, then it will be called prior item's memory release.
16742 * That will be called with the following arguments:
16744 * @li item's Evas object;
16747 * This way, a data associated to a list item could be properly freed.
16751 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16754 * Get the data associated to the item.
16756 * @param item The list item
16757 * @return The data associated to @p item
16759 * The return value is a pointer to data associated to @p item when it was
16760 * created, with function elm_list_item_append() or similar. If no data
16761 * was passed as argument, it will return @c NULL.
16763 * @see elm_list_item_append()
16767 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16770 * Get the left side icon associated to the item.
16772 * @param item The list item
16773 * @return The left side icon associated to @p item
16775 * The return value is a pointer to the icon associated to @p item when
16777 * created, with function elm_list_item_append() or similar, or later
16778 * with function elm_list_item_icon_set(). If no icon
16779 * was passed as argument, it will return @c NULL.
16781 * @see elm_list_item_append()
16782 * @see elm_list_item_icon_set()
16786 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16789 * Set the left side icon associated to the item.
16791 * @param item The list item
16792 * @param icon The left side icon object to associate with @p item
16794 * The icon object to use at left side of the item. An
16795 * icon can be any Evas object, but usually it is an icon created
16796 * with elm_icon_add().
16798 * Once the icon object is set, a previously set one will be deleted.
16799 * @warning Setting the same icon for two items will cause the icon to
16800 * dissapear from the first item.
16802 * If an icon was passed as argument on item creation, with function
16803 * elm_list_item_append() or similar, it will be already
16804 * associated to the item.
16806 * @see elm_list_item_append()
16807 * @see elm_list_item_icon_get()
16811 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16814 * Get the right side icon associated to the item.
16816 * @param item The list item
16817 * @return The right side icon associated to @p item
16819 * The return value is a pointer to the icon associated to @p item when
16821 * created, with function elm_list_item_append() or similar, or later
16822 * with function elm_list_item_icon_set(). If no icon
16823 * was passed as argument, it will return @c NULL.
16825 * @see elm_list_item_append()
16826 * @see elm_list_item_icon_set()
16830 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16833 * Set the right side icon associated to the item.
16835 * @param item The list item
16836 * @param end The right side icon object to associate with @p item
16838 * The icon object to use at right side of the item. An
16839 * icon can be any Evas object, but usually it is an icon created
16840 * with elm_icon_add().
16842 * Once the icon object is set, a previously set one will be deleted.
16843 * @warning Setting the same icon for two items will cause the icon to
16844 * dissapear from the first item.
16846 * If an icon was passed as argument on item creation, with function
16847 * elm_list_item_append() or similar, it will be already
16848 * associated to the item.
16850 * @see elm_list_item_append()
16851 * @see elm_list_item_end_get()
16855 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16856 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16859 * Gets the base object of the item.
16861 * @param item The list item
16862 * @return The base object associated with @p item
16864 * Base object is the @c Evas_Object that represents that item.
16868 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16871 * Get the label of item.
16873 * @param item The item of list.
16874 * @return The label of item.
16876 * The return value is a pointer to the label associated to @p item when
16877 * it was created, with function elm_list_item_append(), or later
16878 * with function elm_list_item_label_set. If no label
16879 * was passed as argument, it will return @c NULL.
16881 * @see elm_list_item_label_set() for more details.
16882 * @see elm_list_item_append()
16886 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16889 * Set the label of item.
16891 * @param item The item of list.
16892 * @param text The label of item.
16894 * The label to be displayed by the item.
16895 * Label will be placed between left and right side icons (if set).
16897 * If a label was passed as argument on item creation, with function
16898 * elm_list_item_append() or similar, it will be already
16899 * displayed by the item.
16901 * @see elm_list_item_label_get()
16902 * @see elm_list_item_append()
16906 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16910 * Get the item before @p it in list.
16912 * @param it The list item.
16913 * @return The item before @p it, or @c NULL if none or on failure.
16915 * @note If it is the first item, @c NULL will be returned.
16917 * @see elm_list_item_append()
16918 * @see elm_list_items_get()
16922 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16925 * Get the item after @p it in list.
16927 * @param it The list item.
16928 * @return The item after @p it, or @c NULL if none or on failure.
16930 * @note If it is the last item, @c NULL will be returned.
16932 * @see elm_list_item_append()
16933 * @see elm_list_items_get()
16937 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16940 * Sets the disabled/enabled state of a list item.
16942 * @param it The item.
16943 * @param disabled The disabled state.
16945 * A disabled item cannot be selected or unselected. It will also
16946 * change its appearance (generally greyed out). This sets the
16947 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16952 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16955 * Get a value whether list item is disabled or not.
16957 * @param it The item.
16958 * @return The disabled state.
16960 * @see elm_list_item_disabled_set() for more details.
16964 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16967 * Set the text to be shown in a given list item's tooltips.
16969 * @param item Target item.
16970 * @param text The text to set in the content.
16972 * Setup the text as tooltip to object. The item can have only one tooltip,
16973 * so any previous tooltip data - set with this function or
16974 * elm_list_item_tooltip_content_cb_set() - is removed.
16976 * @see elm_object_tooltip_text_set() for more details.
16980 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16984 * @brief Disable size restrictions on an object's tooltip
16985 * @param item The tooltip's anchor object
16986 * @param disable If EINA_TRUE, size restrictions are disabled
16987 * @return EINA_FALSE on failure, EINA_TRUE on success
16989 * This function allows a tooltip to expand beyond its parant window's canvas.
16990 * It will instead be limited only by the size of the display.
16992 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16994 * @brief Retrieve size restriction state of an object's tooltip
16995 * @param obj The tooltip's anchor object
16996 * @return If EINA_TRUE, size restrictions are disabled
16998 * This function returns whether a tooltip is allowed to expand beyond
16999 * its parant window's canvas.
17000 * It will instead be limited only by the size of the display.
17002 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17005 * Set the content to be shown in the tooltip item.
17007 * Setup the tooltip to item. The item can have only one tooltip,
17008 * so any previous tooltip data is removed. @p func(with @p data) will
17009 * be called every time that need show the tooltip and it should
17010 * return a valid Evas_Object. This object is then managed fully by
17011 * tooltip system and is deleted when the tooltip is gone.
17013 * @param item the list item being attached a tooltip.
17014 * @param func the function used to create the tooltip contents.
17015 * @param data what to provide to @a func as callback data/context.
17016 * @param del_cb called when data is not needed anymore, either when
17017 * another callback replaces @a func, the tooltip is unset with
17018 * elm_list_item_tooltip_unset() or the owner @a item
17019 * dies. This callback receives as the first parameter the
17020 * given @a data, and @c event_info is the item.
17022 * @see elm_object_tooltip_content_cb_set() for more details.
17026 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);
17029 * Unset tooltip from item.
17031 * @param item list item to remove previously set tooltip.
17033 * Remove tooltip from item. The callback provided as del_cb to
17034 * elm_list_item_tooltip_content_cb_set() will be called to notify
17035 * it is not used anymore.
17037 * @see elm_object_tooltip_unset() for more details.
17038 * @see elm_list_item_tooltip_content_cb_set()
17042 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17045 * Sets a different style for this item tooltip.
17047 * @note before you set a style you should define a tooltip with
17048 * elm_list_item_tooltip_content_cb_set() or
17049 * elm_list_item_tooltip_text_set()
17051 * @param item list item with tooltip already set.
17052 * @param style the theme style to use (default, transparent, ...)
17054 * @see elm_object_tooltip_style_set() for more details.
17058 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17061 * Get the style for this item tooltip.
17063 * @param item list item with tooltip already set.
17064 * @return style the theme style in use, defaults to "default". If the
17065 * object does not have a tooltip set, then NULL is returned.
17067 * @see elm_object_tooltip_style_get() for more details.
17068 * @see elm_list_item_tooltip_style_set()
17072 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17075 * Set the type of mouse pointer/cursor decoration to be shown,
17076 * when the mouse pointer is over the given list widget item
17078 * @param item list item to customize cursor on
17079 * @param cursor the cursor type's name
17081 * This function works analogously as elm_object_cursor_set(), but
17082 * here the cursor's changing area is restricted to the item's
17083 * area, and not the whole widget's. Note that that item cursors
17084 * have precedence over widget cursors, so that a mouse over an
17085 * item with custom cursor set will always show @b that cursor.
17087 * If this function is called twice for an object, a previously set
17088 * cursor will be unset on the second call.
17090 * @see elm_object_cursor_set()
17091 * @see elm_list_item_cursor_get()
17092 * @see elm_list_item_cursor_unset()
17096 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17099 * Get the type of mouse pointer/cursor decoration set to be shown,
17100 * when the mouse pointer is over the given list widget item
17102 * @param item list item with custom cursor set
17103 * @return the cursor type's name or @c NULL, if no custom cursors
17104 * were set to @p item (and on errors)
17106 * @see elm_object_cursor_get()
17107 * @see elm_list_item_cursor_set()
17108 * @see elm_list_item_cursor_unset()
17112 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17115 * Unset any custom mouse pointer/cursor decoration set to be
17116 * shown, when the mouse pointer is over the given list widget
17117 * item, thus making it show the @b default cursor again.
17119 * @param item a list item
17121 * Use this call to undo any custom settings on this item's cursor
17122 * decoration, bringing it back to defaults (no custom style set).
17124 * @see elm_object_cursor_unset()
17125 * @see elm_list_item_cursor_set()
17129 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17132 * Set a different @b style for a given custom cursor set for a
17135 * @param item list item with custom cursor set
17136 * @param style the <b>theme style</b> to use (e.g. @c "default",
17137 * @c "transparent", etc)
17139 * This function only makes sense when one is using custom mouse
17140 * cursor decorations <b>defined in a theme file</b>, which can have,
17141 * given a cursor name/type, <b>alternate styles</b> on it. It
17142 * works analogously as elm_object_cursor_style_set(), but here
17143 * applyed only to list item objects.
17145 * @warning Before you set a cursor style you should have definen a
17146 * custom cursor previously on the item, with
17147 * elm_list_item_cursor_set()
17149 * @see elm_list_item_cursor_engine_only_set()
17150 * @see elm_list_item_cursor_style_get()
17154 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17157 * Get the current @b style set for a given list item's custom
17160 * @param item list item with custom cursor set.
17161 * @return style the cursor style in use. If the object does not
17162 * have a cursor set, then @c NULL is returned.
17164 * @see elm_list_item_cursor_style_set() for more details
17168 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17171 * Set if the (custom)cursor for a given list item should be
17172 * searched in its theme, also, or should only rely on the
17173 * rendering engine.
17175 * @param item item with custom (custom) cursor already set on
17176 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17177 * only on those provided by the rendering engine, @c EINA_FALSE to
17178 * have them searched on the widget's theme, as well.
17180 * @note This call is of use only if you've set a custom cursor
17181 * for list items, with elm_list_item_cursor_set().
17183 * @note By default, cursors will only be looked for between those
17184 * provided by the rendering engine.
17188 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17191 * Get if the (custom) cursor for a given list item is being
17192 * searched in its theme, also, or is only relying on the rendering
17195 * @param item a list item
17196 * @return @c EINA_TRUE, if cursors are being looked for only on
17197 * those provided by the rendering engine, @c EINA_FALSE if they
17198 * are being searched on the widget's theme, as well.
17200 * @see elm_list_item_cursor_engine_only_set(), for more details
17204 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17211 * @defgroup Slider Slider
17212 * @ingroup Elementary
17214 * @image html img/widget/slider/preview-00.png
17215 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17217 * The slider adds a dragable āsliderā widget for selecting the value of
17218 * something within a range.
17220 * A slider can be horizontal or vertical. It can contain an Icon and has a
17221 * primary label as well as a units label (that is formatted with floating
17222 * point values and thus accepts a printf-style format string, like
17223 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17224 * else (like on the slider itself) that also accepts a format string like
17225 * units. Label, Icon Unit and Indicator strings/objects are optional.
17227 * A slider may be inverted which means values invert, with high vales being
17228 * on the left or top and low values on the right or bottom (as opposed to
17229 * normally being low on the left or top and high on the bottom and right).
17231 * The slider should have its minimum and maximum values set by the
17232 * application with elm_slider_min_max_set() and value should also be set by
17233 * the application before use with elm_slider_value_set(). The span of the
17234 * slider is its length (horizontally or vertically). This will be scaled by
17235 * the object or applications scaling factor. At any point code can query the
17236 * slider for its value with elm_slider_value_get().
17238 * Smart callbacks one can listen to:
17239 * - "changed" - Whenever the slider value is changed by the user.
17240 * - "slider,drag,start" - dragging the slider indicator around has started.
17241 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17242 * - "delay,changed" - A short time after the value is changed by the user.
17243 * This will be called only when the user stops dragging for
17244 * a very short period or when they release their
17245 * finger/mouse, so it avoids possibly expensive reactions to
17246 * the value change.
17248 * Available styles for it:
17251 * Default contents parts of the slider widget that you can use for are:
17252 * @li "icon" - A icon of the slider
17253 * @li "end" - A end part content of the slider
17255 * Default text parts of the silder widget that you can use for are:
17256 * @li "default" - Label of the silder
17257 * Here is an example on its usage:
17258 * @li @ref slider_example
17262 * @addtogroup Slider
17267 * Add a new slider widget to the given parent Elementary
17268 * (container) object.
17270 * @param parent The parent object.
17271 * @return a new slider widget handle or @c NULL, on errors.
17273 * This function inserts a new slider widget on the canvas.
17277 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17280 * Set the label of a given slider widget
17282 * @param obj The progress bar object
17283 * @param label The text label string, in UTF-8
17286 * @deprecated use elm_object_text_set() instead.
17288 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17291 * Get the label of a given slider widget
17293 * @param obj The progressbar object
17294 * @return The text label string, in UTF-8
17297 * @deprecated use elm_object_text_get() instead.
17299 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17302 * Set the icon object of the slider object.
17304 * @param obj The slider object.
17305 * @param icon The icon object.
17307 * On horizontal mode, icon is placed at left, and on vertical mode,
17310 * @note Once the icon object is set, a previously set one will be deleted.
17311 * If you want to keep that old content object, use the
17312 * elm_slider_icon_unset() function.
17314 * @warning If the object being set does not have minimum size hints set,
17315 * it won't get properly displayed.
17318 * @deprecated use elm_object_content_part_set() instead.
17320 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17323 * Unset an icon set on a given slider widget.
17325 * @param obj The slider object.
17326 * @return The icon object that was being used, if any was set, or
17327 * @c NULL, otherwise (and on errors).
17329 * On horizontal mode, icon is placed at left, and on vertical mode,
17332 * This call will unparent and return the icon object which was set
17333 * for this widget, previously, on success.
17335 * @see elm_slider_icon_set() for more details
17336 * @see elm_slider_icon_get()
17337 * @deprecated use elm_object_content_part_unset() instead.
17341 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17344 * Retrieve the icon object set for a given slider widget.
17346 * @param obj The slider object.
17347 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17348 * otherwise (and on errors).
17350 * On horizontal mode, icon is placed at left, and on vertical mode,
17353 * @see elm_slider_icon_set() for more details
17354 * @see elm_slider_icon_unset()
17356 * @deprecated use elm_object_content_part_get() instead.
17360 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17363 * Set the end object of the slider object.
17365 * @param obj The slider object.
17366 * @param end The end object.
17368 * On horizontal mode, end is placed at left, and on vertical mode,
17369 * placed at bottom.
17371 * @note Once the icon object is set, a previously set one will be deleted.
17372 * If you want to keep that old content object, use the
17373 * elm_slider_end_unset() function.
17375 * @warning If the object being set does not have minimum size hints set,
17376 * it won't get properly displayed.
17378 * @deprecated use elm_object_content_part_set() instead.
17382 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17385 * Unset an end object set on a given slider widget.
17387 * @param obj The slider object.
17388 * @return The end object that was being used, if any was set, or
17389 * @c NULL, otherwise (and on errors).
17391 * On horizontal mode, end is placed at left, and on vertical mode,
17392 * placed at bottom.
17394 * This call will unparent and return the icon object which was set
17395 * for this widget, previously, on success.
17397 * @see elm_slider_end_set() for more details.
17398 * @see elm_slider_end_get()
17400 * @deprecated use elm_object_content_part_unset() instead
17405 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17408 * Retrieve the end object set for a given slider widget.
17410 * @param obj The slider object.
17411 * @return The end object's handle, if @p obj had one set, or @c NULL,
17412 * otherwise (and on errors).
17414 * On horizontal mode, icon is placed at right, and on vertical mode,
17415 * placed at bottom.
17417 * @see elm_slider_end_set() for more details.
17418 * @see elm_slider_end_unset()
17421 * @deprecated use elm_object_content_part_get() instead
17426 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17429 * Set the (exact) length of the bar region of a given slider widget.
17431 * @param obj The slider object.
17432 * @param size The length of the slider's bar region.
17434 * This sets the minimum width (when in horizontal mode) or height
17435 * (when in vertical mode) of the actual bar area of the slider
17436 * @p obj. This in turn affects the object's minimum size. Use
17437 * this when you're not setting other size hints expanding on the
17438 * given direction (like weight and alignment hints) and you would
17439 * like it to have a specific size.
17441 * @note Icon, end, label, indicator and unit text around @p obj
17442 * will require their
17443 * own space, which will make @p obj to require more the @p size,
17446 * @see elm_slider_span_size_get()
17450 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17453 * Get the length set for the bar region of a given slider widget
17455 * @param obj The slider object.
17456 * @return The length of the slider's bar region.
17458 * If that size was not set previously, with
17459 * elm_slider_span_size_set(), this call will return @c 0.
17463 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17466 * Set the format string for the unit label.
17468 * @param obj The slider object.
17469 * @param format The format string for the unit display.
17471 * Unit label is displayed all the time, if set, after slider's bar.
17472 * In horizontal mode, at right and in vertical mode, at bottom.
17474 * If @c NULL, unit label won't be visible. If not it sets the format
17475 * string for the label text. To the label text is provided a floating point
17476 * value, so the label text can display up to 1 floating point value.
17477 * Note that this is optional.
17479 * Use a format string such as "%1.2f meters" for example, and it will
17480 * display values like: "3.14 meters" for a value equal to 3.14159.
17482 * Default is unit label disabled.
17484 * @see elm_slider_indicator_format_get()
17488 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17491 * Get the unit label format of the slider.
17493 * @param obj The slider object.
17494 * @return The unit label format string in UTF-8.
17496 * Unit label is displayed all the time, if set, after slider's bar.
17497 * In horizontal mode, at right and in vertical mode, at bottom.
17499 * @see elm_slider_unit_format_set() for more
17500 * information on how this works.
17504 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17507 * Set the format string for the indicator label.
17509 * @param obj The slider object.
17510 * @param indicator The format string for the indicator display.
17512 * The slider may display its value somewhere else then unit label,
17513 * for example, above the slider knob that is dragged around. This function
17514 * sets the format string used for this.
17516 * If @c NULL, indicator label won't be visible. If not it sets the format
17517 * string for the label text. To the label text is provided a floating point
17518 * value, so the label text can display up to 1 floating point value.
17519 * Note that this is optional.
17521 * Use a format string such as "%1.2f meters" for example, and it will
17522 * display values like: "3.14 meters" for a value equal to 3.14159.
17524 * Default is indicator label disabled.
17526 * @see elm_slider_indicator_format_get()
17530 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17533 * Get the indicator label format of the slider.
17535 * @param obj The slider object.
17536 * @return The indicator label format string in UTF-8.
17538 * The slider may display its value somewhere else then unit label,
17539 * for example, above the slider knob that is dragged around. This function
17540 * gets the format string used for this.
17542 * @see elm_slider_indicator_format_set() for more
17543 * information on how this works.
17547 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17550 * Set the format function pointer for the indicator label
17552 * @param obj The slider object.
17553 * @param func The indicator format function.
17554 * @param free_func The freeing function for the format string.
17556 * Set the callback function to format the indicator string.
17558 * @see elm_slider_indicator_format_set() for more info on how this works.
17562 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);
17565 * Set the format function pointer for the units label
17567 * @param obj The slider object.
17568 * @param func The units format function.
17569 * @param free_func The freeing function for the format string.
17571 * Set the callback function to format the indicator string.
17573 * @see elm_slider_units_format_set() for more info on how this works.
17577 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);
17580 * Set the orientation of a given slider widget.
17582 * @param obj The slider object.
17583 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17584 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17586 * Use this function to change how your slider is to be
17587 * disposed: vertically or horizontally.
17589 * By default it's displayed horizontally.
17591 * @see elm_slider_horizontal_get()
17595 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17598 * Retrieve the orientation of a given slider widget
17600 * @param obj The slider object.
17601 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17602 * @c EINA_FALSE if it's @b vertical (and on errors).
17604 * @see elm_slider_horizontal_set() for more details.
17608 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17611 * Set the minimum and maximum values for the slider.
17613 * @param obj The slider object.
17614 * @param min The minimum value.
17615 * @param max The maximum value.
17617 * Define the allowed range of values to be selected by the user.
17619 * If actual value is less than @p min, it will be updated to @p min. If it
17620 * is bigger then @p max, will be updated to @p max. Actual value can be
17621 * get with elm_slider_value_get().
17623 * By default, min is equal to 0.0, and max is equal to 1.0.
17625 * @warning Maximum must be greater than minimum, otherwise behavior
17628 * @see elm_slider_min_max_get()
17632 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17635 * Get the minimum and maximum values of the slider.
17637 * @param obj The slider object.
17638 * @param min Pointer where to store the minimum value.
17639 * @param max Pointer where to store the maximum value.
17641 * @note If only one value is needed, the other pointer can be passed
17644 * @see elm_slider_min_max_set() for details.
17648 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17651 * Set the value the slider displays.
17653 * @param obj The slider object.
17654 * @param val The value to be displayed.
17656 * Value will be presented on the unit label following format specified with
17657 * elm_slider_unit_format_set() and on indicator with
17658 * elm_slider_indicator_format_set().
17660 * @warning The value must to be between min and max values. This values
17661 * are set by elm_slider_min_max_set().
17663 * @see elm_slider_value_get()
17664 * @see elm_slider_unit_format_set()
17665 * @see elm_slider_indicator_format_set()
17666 * @see elm_slider_min_max_set()
17670 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17673 * Get the value displayed by the spinner.
17675 * @param obj The spinner object.
17676 * @return The value displayed.
17678 * @see elm_spinner_value_set() for details.
17682 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17685 * Invert a given slider widget's displaying values order
17687 * @param obj The slider object.
17688 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17689 * @c EINA_FALSE to bring it back to default, non-inverted values.
17691 * A slider may be @b inverted, in which state it gets its
17692 * values inverted, with high vales being on the left or top and
17693 * low values on the right or bottom, as opposed to normally have
17694 * the low values on the former and high values on the latter,
17695 * respectively, for horizontal and vertical modes.
17697 * @see elm_slider_inverted_get()
17701 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17704 * Get whether a given slider widget's displaying values are
17707 * @param obj The slider object.
17708 * @return @c EINA_TRUE, if @p obj has inverted values,
17709 * @c EINA_FALSE otherwise (and on errors).
17711 * @see elm_slider_inverted_set() for more details.
17715 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17718 * Set whether to enlarge slider indicator (augmented knob) or not.
17720 * @param obj The slider object.
17721 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17722 * let the knob always at default size.
17724 * By default, indicator will be bigger while dragged by the user.
17726 * @warning It won't display values set with
17727 * elm_slider_indicator_format_set() if you disable indicator.
17731 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17734 * Get whether a given slider widget's enlarging indicator or not.
17736 * @param obj The slider object.
17737 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17738 * @c EINA_FALSE otherwise (and on errors).
17740 * @see elm_slider_indicator_show_set() for details.
17744 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17751 * @addtogroup Actionslider Actionslider
17753 * @image html img/widget/actionslider/preview-00.png
17754 * @image latex img/widget/actionslider/preview-00.eps
17756 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17757 * properties. The user drags and releases the indicator, to choose a label.
17759 * Labels occupy the following positions.
17764 * Positions can be enabled or disabled.
17766 * Magnets can be set on the above positions.
17768 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17770 * @note By default all positions are set as enabled.
17772 * Signals that you can add callbacks for are:
17774 * "selected" - when user selects an enabled position (the label is passed
17777 * "pos_changed" - when the indicator reaches any of the positions("left",
17778 * "right" or "center").
17780 * See an example of actionslider usage @ref actionslider_example_page "here"
17784 typedef enum _Elm_Actionslider_Indicator_Pos
17786 ELM_ACTIONSLIDER_INDICATOR_NONE,
17787 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17788 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17789 ELM_ACTIONSLIDER_INDICATOR_CENTER
17790 } Elm_Actionslider_Indicator_Pos;
17792 typedef enum _Elm_Actionslider_Magnet_Pos
17794 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17795 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17796 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17797 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17798 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17799 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17800 } Elm_Actionslider_Magnet_Pos;
17802 typedef enum _Elm_Actionslider_Label_Pos
17804 ELM_ACTIONSLIDER_LABEL_LEFT,
17805 ELM_ACTIONSLIDER_LABEL_RIGHT,
17806 ELM_ACTIONSLIDER_LABEL_CENTER,
17807 ELM_ACTIONSLIDER_LABEL_BUTTON
17808 } Elm_Actionslider_Label_Pos;
17810 /* smart callbacks called:
17811 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17815 * Add a new actionslider to the parent.
17817 * @param parent The parent object
17818 * @return The new actionslider object or NULL if it cannot be created
17820 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17823 * Set actionslider label.
17825 * @param[in] obj The actionslider object
17826 * @param[in] pos The position of the label.
17827 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17828 * @param label The label which is going to be set.
17830 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17832 * Get actionslider labels.
17834 * @param obj The actionslider object
17835 * @param left_label A char** to place the left_label of @p obj into.
17836 * @param center_label A char** to place the center_label of @p obj into.
17837 * @param right_label A char** to place the right_label of @p obj into.
17839 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);
17841 * Get actionslider selected label.
17843 * @param obj The actionslider object
17844 * @return The selected label
17846 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17848 * Set actionslider indicator position.
17850 * @param obj The actionslider object.
17851 * @param pos The position of the indicator.
17853 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17855 * Get actionslider indicator position.
17857 * @param obj The actionslider object.
17858 * @return The position of the indicator.
17860 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17862 * Set actionslider magnet position. To make multiple positions magnets @c or
17863 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17865 * @param obj The actionslider object.
17866 * @param pos Bit mask indicating the magnet positions.
17868 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17870 * Get actionslider magnet position.
17872 * @param obj The actionslider object.
17873 * @return The positions with magnet property.
17875 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17877 * Set actionslider enabled position. To set multiple positions as enabled @c or
17878 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17880 * @note All the positions are enabled by default.
17882 * @param obj The actionslider object.
17883 * @param pos Bit mask indicating the enabled positions.
17885 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17887 * Get actionslider enabled position.
17889 * @param obj The actionslider object.
17890 * @return The enabled positions.
17892 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17894 * Set the label used on the indicator.
17896 * @param obj The actionslider object
17897 * @param label The label to be set on the indicator.
17898 * @deprecated use elm_object_text_set() instead.
17900 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17902 * Get the label used on the indicator object.
17904 * @param obj The actionslider object
17905 * @return The indicator label
17906 * @deprecated use elm_object_text_get() instead.
17908 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17914 * @defgroup Genlist Genlist
17916 * @image html img/widget/genlist/preview-00.png
17917 * @image latex img/widget/genlist/preview-00.eps
17918 * @image html img/genlist.png
17919 * @image latex img/genlist.eps
17921 * This widget aims to have more expansive list than the simple list in
17922 * Elementary that could have more flexible items and allow many more entries
17923 * while still being fast and low on memory usage. At the same time it was
17924 * also made to be able to do tree structures. But the price to pay is more
17925 * complexity when it comes to usage. If all you want is a simple list with
17926 * icons and a single label, use the normal @ref List object.
17928 * Genlist has a fairly large API, mostly because it's relatively complex,
17929 * trying to be both expansive, powerful and efficient. First we will begin
17930 * an overview on the theory behind genlist.
17932 * @section Genlist_Item_Class Genlist item classes - creating items
17934 * In order to have the ability to add and delete items on the fly, genlist
17935 * implements a class (callback) system where the application provides a
17936 * structure with information about that type of item (genlist may contain
17937 * multiple different items with different classes, states and styles).
17938 * Genlist will call the functions in this struct (methods) when an item is
17939 * "realized" (i.e., created dynamically, while the user is scrolling the
17940 * grid). All objects will simply be deleted when no longer needed with
17941 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17942 * following members:
17943 * - @c item_style - This is a constant string and simply defines the name
17944 * of the item style. It @b must be specified and the default should be @c
17947 * - @c func - A struct with pointers to functions that will be called when
17948 * an item is going to be actually created. All of them receive a @c data
17949 * parameter that will point to the same data passed to
17950 * elm_genlist_item_append() and related item creation functions, and a @c
17951 * obj parameter that points to the genlist object itself.
17953 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17954 * state_get and @c del. The 3 first functions also receive a @c part
17955 * parameter described below. A brief description of these functions follows:
17957 * - @c label_get - The @c part parameter is the name string of one of the
17958 * existing text parts in the Edje group implementing the item's theme.
17959 * This function @b must return a strdup'()ed string, as the caller will
17960 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17961 * - @c content_get - The @c part parameter is the name string of one of the
17962 * existing (content) swallow parts in the Edje group implementing the item's
17963 * theme. It must return @c NULL, when no content is desired, or a valid
17964 * object handle, otherwise. The object will be deleted by the genlist on
17965 * its deletion or when the item is "unrealized". See
17966 * #Elm_Genlist_Item_Icon_Get_Cb.
17967 * - @c func.state_get - The @c part parameter is the name string of one of
17968 * the state parts in the Edje group implementing the item's theme. Return
17969 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17970 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17971 * and @c "elm" as "emission" and "source" arguments, respectively, when
17972 * the state is true (the default is false), where @c XXX is the name of
17973 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17974 * - @c func.del - This is intended for use when genlist items are deleted,
17975 * so any data attached to the item (e.g. its data parameter on creation)
17976 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17978 * available item styles:
17980 * - default_style - The text part is a textblock
17982 * @image html img/widget/genlist/preview-04.png
17983 * @image latex img/widget/genlist/preview-04.eps
17987 * @image html img/widget/genlist/preview-01.png
17988 * @image latex img/widget/genlist/preview-01.eps
17990 * - icon_top_text_bottom
17992 * @image html img/widget/genlist/preview-02.png
17993 * @image latex img/widget/genlist/preview-02.eps
17997 * @image html img/widget/genlist/preview-03.png
17998 * @image latex img/widget/genlist/preview-03.eps
18000 * @section Genlist_Items Structure of items
18002 * An item in a genlist can have 0 or more text labels (they can be regular
18003 * text or textblock Evas objects - that's up to the style to determine), 0
18004 * or more contents (which are simply objects swallowed into the genlist item's
18005 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18006 * behavior left to the user to define. The Edje part names for each of
18007 * these properties will be looked up, in the theme file for the genlist,
18008 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18009 * "states", respectively. For each of those properties, if more than one
18010 * part is provided, they must have names listed separated by spaces in the
18011 * data fields. For the default genlist item theme, we have @b one label
18012 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18013 * "elm.swallow.end") and @b no state parts.
18015 * A genlist item may be at one of several styles. Elementary provides one
18016 * by default - "default", but this can be extended by system or application
18017 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18020 * @section Genlist_Manipulation Editing and Navigating
18022 * Items can be added by several calls. All of them return a @ref
18023 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18024 * They all take a data parameter that is meant to be used for a handle to
18025 * the applications internal data (eg the struct with the original item
18026 * data). The parent parameter is the parent genlist item this belongs to if
18027 * it is a tree or an indexed group, and NULL if there is no parent. The
18028 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18029 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18030 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18031 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18032 * is set then this item is group index item that is displayed at the top
18033 * until the next group comes. The func parameter is a convenience callback
18034 * that is called when the item is selected and the data parameter will be
18035 * the func_data parameter, obj be the genlist object and event_info will be
18036 * the genlist item.
18038 * elm_genlist_item_append() adds an item to the end of the list, or if
18039 * there is a parent, to the end of all the child items of the parent.
18040 * elm_genlist_item_prepend() is the same but adds to the beginning of
18041 * the list or children list. elm_genlist_item_insert_before() inserts at
18042 * item before another item and elm_genlist_item_insert_after() inserts after
18043 * the indicated item.
18045 * The application can clear the list with elm_gen_clear() which deletes
18046 * all the items in the list and elm_genlist_item_del() will delete a specific
18047 * item. elm_genlist_item_subitems_clear() will clear all items that are
18048 * children of the indicated parent item.
18050 * To help inspect list items you can jump to the item at the top of the list
18051 * with elm_genlist_first_item_get() which will return the item pointer, and
18052 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18053 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18054 * and previous items respectively relative to the indicated item. Using
18055 * these calls you can walk the entire item list/tree. Note that as a tree
18056 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18057 * let you know which item is the parent (and thus know how to skip them if
18060 * @section Genlist_Muti_Selection Multi-selection
18062 * If the application wants multiple items to be able to be selected,
18063 * elm_genlist_multi_select_set() can enable this. If the list is
18064 * single-selection only (the default), then elm_genlist_selected_item_get()
18065 * will return the selected item, if any, or NULL I none is selected. If the
18066 * list is multi-select then elm_genlist_selected_items_get() will return a
18067 * list (that is only valid as long as no items are modified (added, deleted,
18068 * selected or unselected)).
18070 * @section Genlist_Usage_Hints Usage hints
18072 * There are also convenience functions. elm_gen_item_genlist_get() will
18073 * return the genlist object the item belongs to. elm_genlist_item_show()
18074 * will make the scroller scroll to show that specific item so its visible.
18075 * elm_genlist_item_data_get() returns the data pointer set by the item
18076 * creation functions.
18078 * If an item changes (state of boolean changes, label or contents change),
18079 * then use elm_genlist_item_update() to have genlist update the item with
18080 * the new state. Genlist will re-realize the item thus call the functions
18081 * in the _Elm_Genlist_Item_Class for that item.
18083 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18084 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18085 * to expand/contract an item and get its expanded state, use
18086 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18087 * again to make an item disabled (unable to be selected and appear
18088 * differently) use elm_genlist_item_disabled_set() to set this and
18089 * elm_genlist_item_disabled_get() to get the disabled state.
18091 * In general to indicate how the genlist should expand items horizontally to
18092 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18093 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18094 * mode means that if items are too wide to fit, the scroller will scroll
18095 * horizontally. Otherwise items are expanded to fill the width of the
18096 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18097 * to the viewport width and limited to that size. This can be combined with
18098 * a different style that uses edjes' ellipsis feature (cutting text off like
18101 * Items will only call their selection func and callback when first becoming
18102 * selected. Any further clicks will do nothing, unless you enable always
18103 * select with elm_gen_always_select_mode_set(). This means even if
18104 * selected, every click will make the selected callbacks be called.
18105 * elm_genlist_no_select_mode_set() will turn off the ability to select
18106 * items entirely and they will neither appear selected nor call selected
18107 * callback functions.
18109 * Remember that you can create new styles and add your own theme augmentation
18110 * per application with elm_theme_extension_add(). If you absolutely must
18111 * have a specific style that overrides any theme the user or system sets up
18112 * you can use elm_theme_overlay_add() to add such a file.
18114 * @section Genlist_Implementation Implementation
18116 * Evas tracks every object you create. Every time it processes an event
18117 * (mouse move, down, up etc.) it needs to walk through objects and find out
18118 * what event that affects. Even worse every time it renders display updates,
18119 * in order to just calculate what to re-draw, it needs to walk through many
18120 * many many objects. Thus, the more objects you keep active, the more
18121 * overhead Evas has in just doing its work. It is advisable to keep your
18122 * active objects to the minimum working set you need. Also remember that
18123 * object creation and deletion carries an overhead, so there is a
18124 * middle-ground, which is not easily determined. But don't keep massive lists
18125 * of objects you can't see or use. Genlist does this with list objects. It
18126 * creates and destroys them dynamically as you scroll around. It groups them
18127 * into blocks so it can determine the visibility etc. of a whole block at
18128 * once as opposed to having to walk the whole list. This 2-level list allows
18129 * for very large numbers of items to be in the list (tests have used up to
18130 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18131 * may be different sizes, every item added needs to be calculated as to its
18132 * size and thus this presents a lot of overhead on populating the list, this
18133 * genlist employs a queue. Any item added is queued and spooled off over
18134 * time, actually appearing some time later, so if your list has many members
18135 * you may find it takes a while for them to all appear, with your process
18136 * consuming a lot of CPU while it is busy spooling.
18138 * Genlist also implements a tree structure, but it does so with callbacks to
18139 * the application, with the application filling in tree structures when
18140 * requested (allowing for efficient building of a very deep tree that could
18141 * even be used for file-management). See the above smart signal callbacks for
18144 * @section Genlist_Smart_Events Genlist smart events
18146 * Signals that you can add callbacks for are:
18147 * - @c "activated" - The user has double-clicked or pressed
18148 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18149 * item that was activated.
18150 * - @c "clicked,double" - The user has double-clicked an item. The @c
18151 * event_info parameter is the item that was double-clicked.
18152 * - @c "selected" - This is called when a user has made an item selected.
18153 * The event_info parameter is the genlist item that was selected.
18154 * - @c "unselected" - This is called when a user has made an item
18155 * unselected. The event_info parameter is the genlist item that was
18157 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18158 * called and the item is now meant to be expanded. The event_info
18159 * parameter is the genlist item that was indicated to expand. It is the
18160 * job of this callback to then fill in the child items.
18161 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18162 * called and the item is now meant to be contracted. The event_info
18163 * parameter is the genlist item that was indicated to contract. It is the
18164 * job of this callback to then delete the child items.
18165 * - @c "expand,request" - This is called when a user has indicated they want
18166 * to expand a tree branch item. The callback should decide if the item can
18167 * expand (has any children) and then call elm_genlist_item_expanded_set()
18168 * appropriately to set the state. The event_info parameter is the genlist
18169 * item that was indicated to expand.
18170 * - @c "contract,request" - This is called when a user has indicated they
18171 * want to contract a tree branch item. The callback should decide if the
18172 * item can contract (has any children) and then call
18173 * elm_genlist_item_expanded_set() appropriately to set the state. The
18174 * event_info parameter is the genlist item that was indicated to contract.
18175 * - @c "realized" - This is called when the item in the list is created as a
18176 * real evas object. event_info parameter is the genlist item that was
18177 * created. The object may be deleted at any time, so it is up to the
18178 * caller to not use the object pointer from elm_genlist_item_object_get()
18179 * in a way where it may point to freed objects.
18180 * - @c "unrealized" - This is called just before an item is unrealized.
18181 * After this call content objects provided will be deleted and the item
18182 * object itself delete or be put into a floating cache.
18183 * - @c "drag,start,up" - This is called when the item in the list has been
18184 * dragged (not scrolled) up.
18185 * - @c "drag,start,down" - This is called when the item in the list has been
18186 * dragged (not scrolled) down.
18187 * - @c "drag,start,left" - This is called when the item in the list has been
18188 * dragged (not scrolled) left.
18189 * - @c "drag,start,right" - This is called when the item in the list has
18190 * been dragged (not scrolled) right.
18191 * - @c "drag,stop" - This is called when the item in the list has stopped
18193 * - @c "drag" - This is called when the item in the list is being dragged.
18194 * - @c "longpressed" - This is called when the item is pressed for a certain
18195 * amount of time. By default it's 1 second.
18196 * - @c "scroll,anim,start" - This is called when scrolling animation has
18198 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18200 * - @c "scroll,drag,start" - This is called when dragging the content has
18202 * - @c "scroll,drag,stop" - This is called when dragging the content has
18204 * - @c "edge,top" - This is called when the genlist is scrolled until
18206 * - @c "edge,bottom" - This is called when the genlist is scrolled
18207 * until the bottom edge.
18208 * - @c "edge,left" - This is called when the genlist is scrolled
18209 * until the left edge.
18210 * - @c "edge,right" - This is called when the genlist is scrolled
18211 * until the right edge.
18212 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18214 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18216 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18218 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18220 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18221 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18222 * multi-touch pinched in.
18223 * - @c "swipe" - This is called when the genlist is swiped.
18224 * - @c "moved" - This is called when a genlist item is moved.
18225 * - @c "language,changed" - This is called when the program's language is
18228 * @section Genlist_Examples Examples
18230 * Here is a list of examples that use the genlist, trying to show some of
18231 * its capabilities:
18232 * - @ref genlist_example_01
18233 * - @ref genlist_example_02
18234 * - @ref genlist_example_03
18235 * - @ref genlist_example_04
18236 * - @ref genlist_example_05
18240 * @addtogroup Genlist
18245 * @enum _Elm_Genlist_Item_Flags
18246 * @typedef Elm_Genlist_Item_Flags
18248 * Defines if the item is of any special type (has subitems or it's the
18249 * index of a group), or is just a simple item.
18253 typedef enum _Elm_Genlist_Item_Flags
18255 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18256 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18257 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18258 } Elm_Genlist_Item_Flags;
18259 typedef enum _Elm_Genlist_Item_Field_Flags
18261 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18262 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18263 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18264 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18265 } Elm_Genlist_Item_Field_Flags;
18266 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18267 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18268 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18269 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18270 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18271 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18272 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18273 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18276 * @struct _Elm_Genlist_Item_Class
18278 * Genlist item class definition structs.
18280 * This struct contains the style and fetching functions that will define the
18281 * contents of each item.
18283 * @see @ref Genlist_Item_Class
18285 struct _Elm_Genlist_Item_Class
18287 const char *item_style;
18289 GenlistItemLabelGetFunc label_get;
18290 GenlistItemIconGetFunc icon_get;
18291 GenlistItemStateGetFunc state_get;
18292 GenlistItemDelFunc del;
18293 GenlistItemMovedFunc moved;
18295 const char *edit_item_style;
18296 const char *mode_item_style;
18298 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18300 * Add a new genlist widget to the given parent Elementary
18301 * (container) object
18303 * @param parent The parent object
18304 * @return a new genlist widget handle or @c NULL, on errors
18306 * This function inserts a new genlist widget on the canvas.
18308 * @see elm_genlist_item_append()
18309 * @see elm_genlist_item_del()
18310 * @see elm_gen_clear()
18314 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18316 * Remove all items from a given genlist widget.
18318 * @param obj The genlist object
18320 * This removes (and deletes) all items in @p obj, leaving it empty.
18322 * @see elm_genlist_item_del(), to remove just one item.
18326 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18328 * Enable or disable multi-selection in the genlist
18330 * @param obj The genlist object
18331 * @param multi Multi-select enable/disable. Default is disabled.
18333 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18334 * the list. This allows more than 1 item to be selected. To retrieve the list
18335 * of selected items, use elm_genlist_selected_items_get().
18337 * @see elm_genlist_selected_items_get()
18338 * @see elm_genlist_multi_select_get()
18342 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18344 * Gets if multi-selection in genlist is enabled or disabled.
18346 * @param obj The genlist object
18347 * @return Multi-select enabled/disabled
18348 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18350 * @see elm_genlist_multi_select_set()
18354 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18356 * This sets the horizontal stretching mode.
18358 * @param obj The genlist object
18359 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18361 * This sets the mode used for sizing items horizontally. Valid modes
18362 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18363 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18364 * the scroller will scroll horizontally. Otherwise items are expanded
18365 * to fill the width of the viewport of the scroller. If it is
18366 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18367 * limited to that size.
18369 * @see elm_genlist_horizontal_get()
18373 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18375 * Gets the horizontal stretching mode.
18377 * @param obj The genlist object
18378 * @return The mode to use
18379 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18381 * @see elm_genlist_horizontal_set()
18385 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18387 * Set the always select mode.
18389 * @param obj The genlist object
18390 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18391 * EINA_FALSE = off). Default is @c EINA_FALSE.
18393 * Items will only call their selection func and callback when first
18394 * becoming selected. Any further clicks will do nothing, unless you
18395 * enable always select with elm_genlist_always_select_mode_set().
18396 * This means that, even if selected, every click will make the selected
18397 * callbacks be called.
18399 * @see elm_genlist_always_select_mode_get()
18403 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18405 * Get the always select mode.
18407 * @param obj The genlist object
18408 * @return The always select mode
18409 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18411 * @see elm_genlist_always_select_mode_set()
18415 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18417 * Enable/disable the no select mode.
18419 * @param obj The genlist object
18420 * @param no_select The no select mode
18421 * (EINA_TRUE = on, EINA_FALSE = off)
18423 * This will turn off the ability to select items entirely and they
18424 * will neither appear selected nor call selected callback functions.
18426 * @see elm_genlist_no_select_mode_get()
18430 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18432 * Gets whether the no select mode is enabled.
18434 * @param obj The genlist object
18435 * @return The no select mode
18436 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18438 * @see elm_genlist_no_select_mode_set()
18442 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18444 * Enable/disable compress mode.
18446 * @param obj The genlist object
18447 * @param compress The compress mode
18448 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18450 * This will enable the compress mode where items are "compressed"
18451 * horizontally to fit the genlist scrollable viewport width. This is
18452 * special for genlist. Do not rely on
18453 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18454 * work as genlist needs to handle it specially.
18456 * @see elm_genlist_compress_mode_get()
18460 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18462 * Get whether the compress mode is enabled.
18464 * @param obj The genlist object
18465 * @return The compress mode
18466 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18468 * @see elm_genlist_compress_mode_set()
18472 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18474 * Enable/disable height-for-width mode.
18476 * @param obj The genlist object
18477 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18478 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18480 * With height-for-width mode the item width will be fixed (restricted
18481 * to a minimum of) to the list width when calculating its size in
18482 * order to allow the height to be calculated based on it. This allows,
18483 * for instance, text block to wrap lines if the Edje part is
18484 * configured with "text.min: 0 1".
18486 * @note This mode will make list resize slower as it will have to
18487 * recalculate every item height again whenever the list width
18490 * @note When height-for-width mode is enabled, it also enables
18491 * compress mode (see elm_genlist_compress_mode_set()) and
18492 * disables homogeneous (see elm_genlist_homogeneous_set()).
18496 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18498 * Get whether the height-for-width mode is enabled.
18500 * @param obj The genlist object
18501 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18506 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18508 * Enable/disable horizontal and vertical bouncing effect.
18510 * @param obj The genlist object
18511 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18512 * EINA_FALSE = off). Default is @c EINA_FALSE.
18513 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18514 * EINA_FALSE = off). Default is @c EINA_TRUE.
18516 * This will enable or disable the scroller bouncing effect for the
18517 * genlist. See elm_scroller_bounce_set() for details.
18519 * @see elm_scroller_bounce_set()
18520 * @see elm_genlist_bounce_get()
18524 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18526 * Get whether the horizontal and vertical bouncing effect is enabled.
18528 * @param obj The genlist object
18529 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18531 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18534 * @see elm_genlist_bounce_set()
18538 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18540 * Enable/disable homogenous mode.
18542 * @param obj The genlist object
18543 * @param homogeneous Assume the items within the genlist are of the
18544 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18547 * This will enable the homogeneous mode where items are of the same
18548 * height and width so that genlist may do the lazy-loading at its
18549 * maximum (which increases the performance for scrolling the list). This
18550 * implies 'compressed' mode.
18552 * @see elm_genlist_compress_mode_set()
18553 * @see elm_genlist_homogeneous_get()
18557 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18559 * Get whether the homogenous mode is enabled.
18561 * @param obj The genlist object
18562 * @return Assume the items within the genlist are of the same height
18563 * and width (EINA_TRUE = on, EINA_FALSE = off)
18565 * @see elm_genlist_homogeneous_set()
18569 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18571 * Set the maximum number of items within an item block
18573 * @param obj The genlist object
18574 * @param n Maximum number of items within an item block. Default is 32.
18576 * This will configure the block count to tune to the target with
18577 * particular performance matrix.
18579 * A block of objects will be used to reduce the number of operations due to
18580 * many objects in the screen. It can determine the visibility, or if the
18581 * object has changed, it theme needs to be updated, etc. doing this kind of
18582 * calculation to the entire block, instead of per object.
18584 * The default value for the block count is enough for most lists, so unless
18585 * you know you will have a lot of objects visible in the screen at the same
18586 * time, don't try to change this.
18588 * @see elm_genlist_block_count_get()
18589 * @see @ref Genlist_Implementation
18593 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18595 * Get the maximum number of items within an item block
18597 * @param obj The genlist object
18598 * @return Maximum number of items within an item block
18600 * @see elm_genlist_block_count_set()
18604 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18606 * Set the timeout in seconds for the longpress event.
18608 * @param obj The genlist object
18609 * @param timeout timeout in seconds. Default is 1.
18611 * This option will change how long it takes to send an event "longpressed"
18612 * after the mouse down signal is sent to the list. If this event occurs, no
18613 * "clicked" event will be sent.
18615 * @see elm_genlist_longpress_timeout_set()
18619 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18621 * Get the timeout in seconds for the longpress event.
18623 * @param obj The genlist object
18624 * @return timeout in seconds
18626 * @see elm_genlist_longpress_timeout_get()
18630 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18632 * Append a new item in a given genlist widget.
18634 * @param obj The genlist object
18635 * @param itc The item class for the item
18636 * @param data The item data
18637 * @param parent The parent item, or NULL if none
18638 * @param flags Item flags
18639 * @param func Convenience function called when the item is selected
18640 * @param func_data Data passed to @p func above.
18641 * @return A handle to the item added or @c NULL if not possible
18643 * This adds the given item to the end of the list or the end of
18644 * the children list if the @p parent is given.
18646 * @see elm_genlist_item_prepend()
18647 * @see elm_genlist_item_insert_before()
18648 * @see elm_genlist_item_insert_after()
18649 * @see elm_genlist_item_del()
18653 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);
18655 * Prepend a new item in a given genlist widget.
18657 * @param obj The genlist object
18658 * @param itc The item class for the item
18659 * @param data The item data
18660 * @param parent The parent item, or NULL if none
18661 * @param flags Item flags
18662 * @param func Convenience function called when the item is selected
18663 * @param func_data Data passed to @p func above.
18664 * @return A handle to the item added or NULL if not possible
18666 * This adds an item to the beginning of the list or beginning of the
18667 * children of the parent if given.
18669 * @see elm_genlist_item_append()
18670 * @see elm_genlist_item_insert_before()
18671 * @see elm_genlist_item_insert_after()
18672 * @see elm_genlist_item_del()
18676 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);
18678 * Insert an item before another in a genlist widget
18680 * @param obj The genlist object
18681 * @param itc The item class for the item
18682 * @param data The item data
18683 * @param before The item to place this new one before.
18684 * @param flags Item flags
18685 * @param func Convenience function called when the item is selected
18686 * @param func_data Data passed to @p func above.
18687 * @return A handle to the item added or @c NULL if not possible
18689 * This inserts an item before another in the list. It will be in the
18690 * same tree level or group as the item it is inserted before.
18692 * @see elm_genlist_item_append()
18693 * @see elm_genlist_item_prepend()
18694 * @see elm_genlist_item_insert_after()
18695 * @see elm_genlist_item_del()
18699 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);
18701 * Insert an item after another in a genlist widget
18703 * @param obj The genlist object
18704 * @param itc The item class for the item
18705 * @param data The item data
18706 * @param after The item to place this new one after.
18707 * @param flags Item flags
18708 * @param func Convenience function called when the item is selected
18709 * @param func_data Data passed to @p func above.
18710 * @return A handle to the item added or @c NULL if not possible
18712 * This inserts an item after another in the list. It will be in the
18713 * same tree level or group as the item it is inserted after.
18715 * @see elm_genlist_item_append()
18716 * @see elm_genlist_item_prepend()
18717 * @see elm_genlist_item_insert_before()
18718 * @see elm_genlist_item_del()
18722 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);
18724 * Insert a new item into the sorted genlist object
18726 * @param obj The genlist object
18727 * @param itc The item class for the item
18728 * @param data The item data
18729 * @param parent The parent item, or NULL if none
18730 * @param flags Item flags
18731 * @param comp The function called for the sort
18732 * @param func Convenience function called when item selected
18733 * @param func_data Data passed to @p func above.
18734 * @return A handle to the item added or NULL if not possible
18738 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);
18739 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);
18740 /* operations to retrieve existing items */
18742 * Get the selectd item in the genlist.
18744 * @param obj The genlist object
18745 * @return The selected item, or NULL if none is selected.
18747 * This gets the selected item in the list (if multi-selection is enabled, only
18748 * the item that was first selected in the list is returned - which is not very
18749 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18752 * If no item is selected, NULL is returned.
18754 * @see elm_genlist_selected_items_get()
18758 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18760 * Get a list of selected items in the genlist.
18762 * @param obj The genlist object
18763 * @return The list of selected items, or NULL if none are selected.
18765 * It returns a list of the selected items. This list pointer is only valid so
18766 * long as the selection doesn't change (no items are selected or unselected, or
18767 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18768 * pointers. The order of the items in this list is the order which they were
18769 * selected, i.e. the first item in this list is the first item that was
18770 * selected, and so on.
18772 * @note If not in multi-select mode, consider using function
18773 * elm_genlist_selected_item_get() instead.
18775 * @see elm_genlist_multi_select_set()
18776 * @see elm_genlist_selected_item_get()
18780 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18782 * Get the mode item style of items in the genlist
18783 * @param obj The genlist object
18784 * @return The mode item style string, or NULL if none is specified
18786 * This is a constant string and simply defines the name of the
18787 * style that will be used for mode animations. It can be
18788 * @c NULL if you don't plan to use Genlist mode. See
18789 * elm_genlist_item_mode_set() for more info.
18793 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18795 * Set the mode item style of items in the genlist
18796 * @param obj The genlist object
18797 * @param style The mode item style string, or NULL if none is desired
18799 * This is a constant string and simply defines the name of the
18800 * style that will be used for mode animations. It can be
18801 * @c NULL if you don't plan to use Genlist mode. See
18802 * elm_genlist_item_mode_set() for more info.
18806 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18808 * Get a list of realized items in genlist
18810 * @param obj The genlist object
18811 * @return The list of realized items, nor NULL if none are realized.
18813 * This returns a list of the realized items in the genlist. The list
18814 * contains Elm_Genlist_Item pointers. The list must be freed by the
18815 * caller when done with eina_list_free(). The item pointers in the
18816 * list are only valid so long as those items are not deleted or the
18817 * genlist is not deleted.
18819 * @see elm_genlist_realized_items_update()
18823 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18825 * Get the item that is at the x, y canvas coords.
18827 * @param obj The gelinst object.
18828 * @param x The input x coordinate
18829 * @param y The input y coordinate
18830 * @param posret The position relative to the item returned here
18831 * @return The item at the coordinates or NULL if none
18833 * This returns the item at the given coordinates (which are canvas
18834 * relative, not object-relative). If an item is at that coordinate,
18835 * that item handle is returned, and if @p posret is not NULL, the
18836 * integer pointed to is set to a value of -1, 0 or 1, depending if
18837 * the coordinate is on the upper portion of that item (-1), on the
18838 * middle section (0) or on the lower part (1). If NULL is returned as
18839 * an item (no item found there), then posret may indicate -1 or 1
18840 * based if the coordinate is above or below all items respectively in
18845 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);
18847 * Get the first item in the genlist
18849 * This returns the first item in the list.
18851 * @param obj The genlist object
18852 * @return The first item, or NULL if none
18856 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18858 * Get the last item in the genlist
18860 * This returns the last item in the list.
18862 * @return The last item, or NULL if none
18866 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18868 * Set the scrollbar policy
18870 * @param obj The genlist object
18871 * @param policy_h Horizontal scrollbar policy.
18872 * @param policy_v Vertical scrollbar policy.
18874 * This sets the scrollbar visibility policy for the given genlist
18875 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18876 * made visible if it is needed, and otherwise kept hidden.
18877 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18878 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18879 * respectively for the horizontal and vertical scrollbars. Default is
18880 * #ELM_SMART_SCROLLER_POLICY_AUTO
18882 * @see elm_genlist_scroller_policy_get()
18886 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18888 * Get the scrollbar policy
18890 * @param obj The genlist object
18891 * @param policy_h Pointer to store the horizontal scrollbar policy.
18892 * @param policy_v Pointer to store the vertical scrollbar policy.
18894 * @see elm_genlist_scroller_policy_set()
18898 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);
18900 * Get the @b next item in a genlist widget's internal list of items,
18901 * given a handle to one of those items.
18903 * @param item The genlist item to fetch next from
18904 * @return The item after @p item, or @c NULL if there's none (and
18907 * This returns the item placed after the @p item, on the container
18910 * @see elm_genlist_item_prev_get()
18914 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18916 * Get the @b previous item in a genlist widget's internal list of items,
18917 * given a handle to one of those items.
18919 * @param item The genlist item to fetch previous from
18920 * @return The item before @p item, or @c NULL if there's none (and
18923 * This returns the item placed before the @p item, on the container
18926 * @see elm_genlist_item_next_get()
18930 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18932 * Get the genlist object's handle which contains a given genlist
18935 * @param item The item to fetch the container from
18936 * @return The genlist (parent) object
18938 * This returns the genlist object itself that an item belongs to.
18942 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18944 * Get the parent item of the given item
18946 * @param it The item
18947 * @return The parent of the item or @c NULL if it has no parent.
18949 * This returns the item that was specified as parent of the item @p it on
18950 * elm_genlist_item_append() and insertion related functions.
18954 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18956 * Remove all sub-items (children) of the given item
18958 * @param it The item
18960 * This removes all items that are children (and their descendants) of the
18961 * given item @p it.
18963 * @see elm_genlist_clear()
18964 * @see elm_genlist_item_del()
18968 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18970 * Set whether a given genlist item is selected or not
18972 * @param it The item
18973 * @param selected Use @c EINA_TRUE, to make it selected, @c
18974 * EINA_FALSE to make it unselected
18976 * This sets the selected state of an item. If multi selection is
18977 * not enabled on the containing genlist and @p selected is @c
18978 * EINA_TRUE, any other previously selected items will get
18979 * unselected in favor of this new one.
18981 * @see elm_genlist_item_selected_get()
18985 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18987 * Get whether a given genlist item is selected or not
18989 * @param it The item
18990 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18992 * @see elm_genlist_item_selected_set() for more details
18996 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18998 * Sets the expanded state of an item.
19000 * @param it The item
19001 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19003 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19006 * The theme will respond to this change visually, and a signal "expanded" or
19007 * "contracted" will be sent from the genlist with a pointer to the item that
19008 * has been expanded/contracted.
19010 * Calling this function won't show or hide any child of this item (if it is
19011 * a parent). You must manually delete and create them on the callbacks fo
19012 * the "expanded" or "contracted" signals.
19014 * @see elm_genlist_item_expanded_get()
19018 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19020 * Get the expanded state of an item
19022 * @param it The item
19023 * @return The expanded state
19025 * This gets the expanded state of an item.
19027 * @see elm_genlist_item_expanded_set()
19031 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19033 * Get the depth of expanded item
19035 * @param it The genlist item object
19036 * @return The depth of expanded item
19040 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19042 * Set whether a given genlist item is disabled or not.
19044 * @param it The item
19045 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19046 * to enable it back.
19048 * A disabled item cannot be selected or unselected. It will also
19049 * change its appearance, to signal the user it's disabled.
19051 * @see elm_genlist_item_disabled_get()
19055 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19057 * Get whether a given genlist item is disabled or not.
19059 * @param it The item
19060 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19063 * @see elm_genlist_item_disabled_set() for more details
19067 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19069 * Sets the display only state of an item.
19071 * @param it The item
19072 * @param display_only @c EINA_TRUE if the item is display only, @c
19073 * EINA_FALSE otherwise.
19075 * A display only item cannot be selected or unselected. It is for
19076 * display only and not selecting or otherwise clicking, dragging
19077 * etc. by the user, thus finger size rules will not be applied to
19080 * It's good to set group index items to display only state.
19082 * @see elm_genlist_item_display_only_get()
19086 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19088 * Get the display only state of an item
19090 * @param it The item
19091 * @return @c EINA_TRUE if the item is display only, @c
19092 * EINA_FALSE otherwise.
19094 * @see elm_genlist_item_display_only_set()
19098 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19100 * Show the portion of a genlist's internal list containing a given
19101 * item, immediately.
19103 * @param it The item to display
19105 * This causes genlist to jump to the given item @p it and show it (by
19106 * immediately scrolling to that position), if it is not fully visible.
19108 * @see elm_genlist_item_bring_in()
19109 * @see elm_genlist_item_top_show()
19110 * @see elm_genlist_item_middle_show()
19114 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19116 * Animatedly bring in, to the visible are of a genlist, a given
19119 * @param it The item to display
19121 * This causes genlist to jump to the given item @p it and show it (by
19122 * animatedly scrolling), if it is not fully visible. This may use animation
19123 * to do so and take a period of time
19125 * @see elm_genlist_item_show()
19126 * @see elm_genlist_item_top_bring_in()
19127 * @see elm_genlist_item_middle_bring_in()
19131 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19133 * Show the portion of a genlist's internal list containing a given
19134 * item, immediately.
19136 * @param it The item to display
19138 * This causes genlist to jump to the given item @p it and show it (by
19139 * immediately scrolling to that position), if it is not fully visible.
19141 * The item will be positioned at the top of the genlist viewport.
19143 * @see elm_genlist_item_show()
19144 * @see elm_genlist_item_top_bring_in()
19148 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19150 * Animatedly bring in, to the visible are of a genlist, a given
19153 * @param it The item
19155 * This causes genlist to jump to the given item @p it and show it (by
19156 * animatedly scrolling), if it is not fully visible. This may use animation
19157 * to do so and take a period of time
19159 * The item will be positioned at the top of the genlist viewport.
19161 * @see elm_genlist_item_bring_in()
19162 * @see elm_genlist_item_top_show()
19166 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19168 * Show the portion of a genlist's internal list containing a given
19169 * item, immediately.
19171 * @param it The item to display
19173 * This causes genlist to jump to the given item @p it and show it (by
19174 * immediately scrolling to that position), if it is not fully visible.
19176 * The item will be positioned at the middle of the genlist viewport.
19178 * @see elm_genlist_item_show()
19179 * @see elm_genlist_item_middle_bring_in()
19183 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19185 * Animatedly bring in, to the visible are of a genlist, a given
19188 * @param it The item
19190 * This causes genlist to jump to the given item @p it and show it (by
19191 * animatedly scrolling), if it is not fully visible. This may use animation
19192 * to do so and take a period of time
19194 * The item will be positioned at the middle of the genlist viewport.
19196 * @see elm_genlist_item_bring_in()
19197 * @see elm_genlist_item_middle_show()
19201 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19203 * Remove a genlist item from the its parent, deleting it.
19205 * @param item The item to be removed.
19206 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19208 * @see elm_genlist_clear(), to remove all items in a genlist at
19213 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19215 * Return the data associated to a given genlist item
19217 * @param item The genlist item.
19218 * @return the data associated to this item.
19220 * This returns the @c data value passed on the
19221 * elm_genlist_item_append() and related item addition calls.
19223 * @see elm_genlist_item_append()
19224 * @see elm_genlist_item_data_set()
19228 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19230 * Set the data associated to a given genlist item
19232 * @param item The genlist item
19233 * @param data The new data pointer to set on it
19235 * This @b overrides the @c data value passed on the
19236 * elm_genlist_item_append() and related item addition calls. This
19237 * function @b won't call elm_genlist_item_update() automatically,
19238 * so you'd issue it afterwards if you want to hove the item
19239 * updated to reflect the that new data.
19241 * @see elm_genlist_item_data_get()
19245 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19247 * Tells genlist to "orphan" icons fetchs by the item class
19249 * @param it The item
19251 * This instructs genlist to release references to icons in the item,
19252 * meaning that they will no longer be managed by genlist and are
19253 * floating "orphans" that can be re-used elsewhere if the user wants
19258 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19259 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19261 * Get the real Evas object created to implement the view of a
19262 * given genlist item
19264 * @param item The genlist item.
19265 * @return the Evas object implementing this item's view.
19267 * This returns the actual Evas object used to implement the
19268 * specified genlist item's view. This may be @c NULL, as it may
19269 * not have been created or may have been deleted, at any time, by
19270 * the genlist. <b>Do not modify this object</b> (move, resize,
19271 * show, hide, etc.), as the genlist is controlling it. This
19272 * function is for querying, emitting custom signals or hooking
19273 * lower level callbacks for events on that object. Do not delete
19274 * this object under any circumstances.
19276 * @see elm_genlist_item_data_get()
19280 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19282 * Update the contents of an item
19284 * @param it The item
19286 * This updates an item by calling all the item class functions again
19287 * to get the icons, labels and states. Use this when the original
19288 * item data has changed and the changes are desired to be reflected.
19290 * Use elm_genlist_realized_items_update() to update all already realized
19293 * @see elm_genlist_realized_items_update()
19297 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19298 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19300 * Update the item class of an item
19302 * @param it The item
19303 * @param itc The item class for the item
19305 * This sets another class fo the item, changing the way that it is
19306 * displayed. After changing the item class, elm_genlist_item_update() is
19307 * called on the item @p it.
19311 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19312 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19314 * Set the text to be shown in a given genlist item's tooltips.
19316 * @param item The genlist item
19317 * @param text The text to set in the content
19319 * This call will setup the text to be used as tooltip to that item
19320 * (analogous to elm_object_tooltip_text_set(), but being item
19321 * tooltips with higher precedence than object tooltips). It can
19322 * have only one tooltip at a time, so any previous tooltip data
19323 * will get removed.
19325 * In order to set an icon or something else as a tooltip, look at
19326 * elm_genlist_item_tooltip_content_cb_set().
19330 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19332 * Set the content to be shown in a given genlist item's tooltips
19334 * @param item The genlist item.
19335 * @param func The function returning the tooltip contents.
19336 * @param data What to provide to @a func as callback data/context.
19337 * @param del_cb Called when data is not needed anymore, either when
19338 * another callback replaces @p func, the tooltip is unset with
19339 * elm_genlist_item_tooltip_unset() or the owner @p item
19340 * dies. This callback receives as its first parameter the
19341 * given @p data, being @c event_info the item handle.
19343 * This call will setup the tooltip's contents to @p item
19344 * (analogous to elm_object_tooltip_content_cb_set(), but being
19345 * item tooltips with higher precedence than object tooltips). It
19346 * can have only one tooltip at a time, so any previous tooltip
19347 * content will get removed. @p func (with @p data) will be called
19348 * every time Elementary needs to show the tooltip and it should
19349 * return a valid Evas object, which will be fully managed by the
19350 * tooltip system, getting deleted when the tooltip is gone.
19352 * In order to set just a text as a tooltip, look at
19353 * elm_genlist_item_tooltip_text_set().
19357 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);
19359 * Unset a tooltip from a given genlist item
19361 * @param item genlist item to remove a previously set tooltip from.
19363 * This call removes any tooltip set on @p item. The callback
19364 * provided as @c del_cb to
19365 * elm_genlist_item_tooltip_content_cb_set() will be called to
19366 * notify it is not used anymore (and have resources cleaned, if
19369 * @see elm_genlist_item_tooltip_content_cb_set()
19373 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19375 * Set a different @b style for a given genlist item's tooltip.
19377 * @param item genlist item with tooltip set
19378 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19379 * "default", @c "transparent", etc)
19381 * Tooltips can have <b>alternate styles</b> to be displayed on,
19382 * which are defined by the theme set on Elementary. This function
19383 * works analogously as elm_object_tooltip_style_set(), but here
19384 * applied only to genlist item objects. The default style for
19385 * tooltips is @c "default".
19387 * @note before you set a style you should define a tooltip with
19388 * elm_genlist_item_tooltip_content_cb_set() or
19389 * elm_genlist_item_tooltip_text_set()
19391 * @see elm_genlist_item_tooltip_style_get()
19395 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19397 * Get the style set a given genlist item's tooltip.
19399 * @param item genlist item with tooltip already set on.
19400 * @return style the theme style in use, which defaults to
19401 * "default". If the object does not have a tooltip set,
19402 * then @c NULL is returned.
19404 * @see elm_genlist_item_tooltip_style_set() for more details
19408 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19410 * Set the type of mouse pointer/cursor decoration to be shown,
19411 * when the mouse pointer is over the given genlist widget item
19413 * @param item genlist item to customize cursor on
19414 * @param cursor the cursor type's name
19416 * This function works analogously as elm_object_cursor_set(), but
19417 * here the cursor's changing area is restricted to the item's
19418 * area, and not the whole widget's. Note that that item cursors
19419 * have precedence over widget cursors, so that a mouse over @p
19420 * item will always show cursor @p type.
19422 * If this function is called twice for an object, a previously set
19423 * cursor will be unset on the second call.
19425 * @see elm_object_cursor_set()
19426 * @see elm_genlist_item_cursor_get()
19427 * @see elm_genlist_item_cursor_unset()
19431 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19433 * Get the type of mouse pointer/cursor decoration set to be shown,
19434 * when the mouse pointer is over the given genlist widget item
19436 * @param item genlist item with custom cursor set
19437 * @return the cursor type's name or @c NULL, if no custom cursors
19438 * were set to @p item (and on errors)
19440 * @see elm_object_cursor_get()
19441 * @see elm_genlist_item_cursor_set() for more details
19442 * @see elm_genlist_item_cursor_unset()
19446 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19448 * Unset any custom mouse pointer/cursor decoration set to be
19449 * shown, when the mouse pointer is over the given genlist widget
19450 * item, thus making it show the @b default cursor again.
19452 * @param item a genlist item
19454 * Use this call to undo any custom settings on this item's cursor
19455 * decoration, bringing it back to defaults (no custom style set).
19457 * @see elm_object_cursor_unset()
19458 * @see elm_genlist_item_cursor_set() for more details
19462 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19464 * Set a different @b style for a given custom cursor set for a
19467 * @param item genlist item with custom cursor set
19468 * @param style the <b>theme style</b> to use (e.g. @c "default",
19469 * @c "transparent", etc)
19471 * This function only makes sense when one is using custom mouse
19472 * cursor decorations <b>defined in a theme file</b> , which can
19473 * have, given a cursor name/type, <b>alternate styles</b> on
19474 * it. It works analogously as elm_object_cursor_style_set(), but
19475 * here applied only to genlist item objects.
19477 * @warning Before you set a cursor style you should have defined a
19478 * custom cursor previously on the item, with
19479 * elm_genlist_item_cursor_set()
19481 * @see elm_genlist_item_cursor_engine_only_set()
19482 * @see elm_genlist_item_cursor_style_get()
19486 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19488 * Get the current @b style set for a given genlist item's custom
19491 * @param item genlist item with custom cursor set.
19492 * @return style the cursor style in use. If the object does not
19493 * have a cursor set, then @c NULL is returned.
19495 * @see elm_genlist_item_cursor_style_set() for more details
19499 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19501 * Set if the (custom) cursor for a given genlist item should be
19502 * searched in its theme, also, or should only rely on the
19503 * rendering engine.
19505 * @param item item with custom (custom) cursor already set on
19506 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19507 * only on those provided by the rendering engine, @c EINA_FALSE to
19508 * have them searched on the widget's theme, as well.
19510 * @note This call is of use only if you've set a custom cursor
19511 * for genlist items, with elm_genlist_item_cursor_set().
19513 * @note By default, cursors will only be looked for between those
19514 * provided by the rendering engine.
19518 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19520 * Get if the (custom) cursor for a given genlist item is being
19521 * searched in its theme, also, or is only relying on the rendering
19524 * @param item a genlist item
19525 * @return @c EINA_TRUE, if cursors are being looked for only on
19526 * those provided by the rendering engine, @c EINA_FALSE if they
19527 * are being searched on the widget's theme, as well.
19529 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19533 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19535 * Update the contents of all realized items.
19537 * @param obj The genlist object.
19539 * This updates all realized items by calling all the item class functions again
19540 * to get the icons, labels and states. Use this when the original
19541 * item data has changed and the changes are desired to be reflected.
19543 * To update just one item, use elm_genlist_item_update().
19545 * @see elm_genlist_realized_items_get()
19546 * @see elm_genlist_item_update()
19550 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19552 * Activate a genlist mode on an item
19554 * @param item The genlist item
19555 * @param mode Mode name
19556 * @param mode_set Boolean to define set or unset mode.
19558 * A genlist mode is a different way of selecting an item. Once a mode is
19559 * activated on an item, any other selected item is immediately unselected.
19560 * This feature provides an easy way of implementing a new kind of animation
19561 * for selecting an item, without having to entirely rewrite the item style
19562 * theme. However, the elm_genlist_selected_* API can't be used to get what
19563 * item is activate for a mode.
19565 * The current item style will still be used, but applying a genlist mode to
19566 * an item will select it using a different kind of animation.
19568 * The current active item for a mode can be found by
19569 * elm_genlist_mode_item_get().
19571 * The characteristics of genlist mode are:
19572 * - Only one mode can be active at any time, and for only one item.
19573 * - Genlist handles deactivating other items when one item is activated.
19574 * - A mode is defined in the genlist theme (edc), and more modes can easily
19576 * - A mode style and the genlist item style are different things. They
19577 * can be combined to provide a default style to the item, with some kind
19578 * of animation for that item when the mode is activated.
19580 * When a mode is activated on an item, a new view for that item is created.
19581 * The theme of this mode defines the animation that will be used to transit
19582 * the item from the old view to the new view. This second (new) view will be
19583 * active for that item while the mode is active on the item, and will be
19584 * destroyed after the mode is totally deactivated from that item.
19586 * @see elm_genlist_mode_get()
19587 * @see elm_genlist_mode_item_get()
19591 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19593 * Get the last (or current) genlist mode used.
19595 * @param obj The genlist object
19597 * This function just returns the name of the last used genlist mode. It will
19598 * be the current mode if it's still active.
19600 * @see elm_genlist_item_mode_set()
19601 * @see elm_genlist_mode_item_get()
19605 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19607 * Get active genlist mode item
19609 * @param obj The genlist object
19610 * @return The active item for that current mode. Or @c NULL if no item is
19611 * activated with any mode.
19613 * This function returns the item that was activated with a mode, by the
19614 * function elm_genlist_item_mode_set().
19616 * @see elm_genlist_item_mode_set()
19617 * @see elm_genlist_mode_get()
19621 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19626 * @param obj The genlist object
19627 * @param reorder_mode The reorder mode
19628 * (EINA_TRUE = on, EINA_FALSE = off)
19632 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19635 * Get the reorder mode
19637 * @param obj The genlist object
19638 * @return The reorder mode
19639 * (EINA_TRUE = on, EINA_FALSE = off)
19643 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19645 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19646 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19647 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19648 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19649 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19650 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19651 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19652 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19653 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19654 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19661 * @defgroup Check Check
19663 * @image html img/widget/check/preview-00.png
19664 * @image latex img/widget/check/preview-00.eps
19665 * @image html img/widget/check/preview-01.png
19666 * @image latex img/widget/check/preview-01.eps
19667 * @image html img/widget/check/preview-02.png
19668 * @image latex img/widget/check/preview-02.eps
19670 * @brief The check widget allows for toggling a value between true and
19673 * Check objects are a lot like radio objects in layout and functionality
19674 * except they do not work as a group, but independently and only toggle the
19675 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19676 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19677 * returns the current state. For convenience, like the radio objects, you
19678 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19679 * for it to modify.
19681 * Signals that you can add callbacks for are:
19682 * "changed" - This is called whenever the user changes the state of one of
19683 * the check object(event_info is NULL).
19685 * Default contents parts of the check widget that you can use for are:
19686 * @li "icon" - A icon of the check
19688 * Default text parts of the check widget that you can use for are:
19689 * @li "elm.text" - Label of the check
19691 * @ref tutorial_check should give you a firm grasp of how to use this widget
19696 * @brief Add a new Check object
19698 * @param parent The parent object
19699 * @return The new object or NULL if it cannot be created
19701 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19703 * @brief Set the text label of the check object
19705 * @param obj The check object
19706 * @param label The text label string in UTF-8
19708 * @deprecated use elm_object_text_set() instead.
19710 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19712 * @brief Get the text label of the check object
19714 * @param obj The check object
19715 * @return The text label string in UTF-8
19717 * @deprecated use elm_object_text_get() instead.
19719 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19721 * @brief Set the icon object of the check object
19723 * @param obj The check object
19724 * @param icon The icon object
19726 * Once the icon object is set, a previously set one will be deleted.
19727 * If you want to keep that old content object, use the
19728 * elm_object_content_unset() function.
19730 * @deprecated use elm_object_content_part_set() instead.
19733 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19735 * @brief Get the icon object of the check object
19737 * @param obj The check object
19738 * @return The icon object
19740 * @deprecated use elm_object_content_part_get() instead.
19743 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19745 * @brief Unset the icon used for the check object
19747 * @param obj The check object
19748 * @return The icon object that was being used
19750 * Unparent and return the icon object which was set for this widget.
19752 * @deprecated use elm_object_content_part_unset() instead.
19755 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19757 * @brief Set the on/off state of the check object
19759 * @param obj The check object
19760 * @param state The state to use (1 == on, 0 == off)
19762 * This sets the state of the check. If set
19763 * with elm_check_state_pointer_set() the state of that variable is also
19764 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19766 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19768 * @brief Get the state of the check object
19770 * @param obj The check object
19771 * @return The boolean state
19773 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19775 * @brief Set a convenience pointer to a boolean to change
19777 * @param obj The check object
19778 * @param statep Pointer to the boolean to modify
19780 * This sets a pointer to a boolean, that, in addition to the check objects
19781 * state will also be modified directly. To stop setting the object pointed
19782 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19783 * then when this is called, the check objects state will also be modified to
19784 * reflect the value of the boolean @p statep points to, just like calling
19785 * elm_check_state_set().
19787 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19792 /* compatibility code for toggle controls */
19794 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
19798 obj = elm_check_add(parent);
19799 elm_object_style_set(obj, "toggle");
19800 elm_object_part_text_set(obj, "on", "ON");
19801 elm_object_part_text_set(obj, "off", "OFF");
19805 EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
19807 elm_object_text_set(obj, label);
19810 EINA_DEPRECATED EAPI extern inline const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19812 return elm_object_text_get(obj);
19815 EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
19817 elm_object_content_set(obj, icon);
19820 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19822 return elm_object_content_get(obj);
19825 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
19827 return elm_object_content_unset(obj);
19830 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
19832 elm_object_part_text_set(obj, "on", onlabel);
19833 elm_object_part_text_set(obj, "off", offlabel);
19836 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1)
19838 if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
19839 if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
19842 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
19844 elm_check_state_set(obj, state);
19847 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19849 return elm_check_state_get(obj);
19852 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
19854 elm_check_state_pointer_set(obj, statep);
19858 * @defgroup Radio Radio
19860 * @image html img/widget/radio/preview-00.png
19861 * @image latex img/widget/radio/preview-00.eps
19863 * @brief Radio is a widget that allows for 1 or more options to be displayed
19864 * and have the user choose only 1 of them.
19866 * A radio object contains an indicator, an optional Label and an optional
19867 * icon object. While it's possible to have a group of only one radio they,
19868 * are normally used in groups of 2 or more. To add a radio to a group use
19869 * elm_radio_group_add(). The radio object(s) will select from one of a set
19870 * of integer values, so any value they are configuring needs to be mapped to
19871 * a set of integers. To configure what value that radio object represents,
19872 * use elm_radio_state_value_set() to set the integer it represents. To set
19873 * the value the whole group(which one is currently selected) is to indicate
19874 * use elm_radio_value_set() on any group member, and to get the groups value
19875 * use elm_radio_value_get(). For convenience the radio objects are also able
19876 * to directly set an integer(int) to the value that is selected. To specify
19877 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19878 * The radio objects will modify this directly. That implies the pointer must
19879 * point to valid memory for as long as the radio objects exist.
19881 * Signals that you can add callbacks for are:
19882 * @li changed - This is called whenever the user changes the state of one of
19883 * the radio objects within the group of radio objects that work together.
19885 * Default contents parts of the radio widget that you can use for are:
19886 * @li "icon" - A icon of the radio
19888 * @ref tutorial_radio show most of this API in action.
19892 * @brief Add a new radio to the parent
19894 * @param parent The parent object
19895 * @return The new object or NULL if it cannot be created
19897 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19899 * @brief Set the text label of the radio object
19901 * @param obj The radio object
19902 * @param label The text label string in UTF-8
19904 * @deprecated use elm_object_text_set() instead.
19906 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19908 * @brief Get the text label of the radio object
19910 * @param obj The radio object
19911 * @return The text label string in UTF-8
19913 * @deprecated use elm_object_text_set() instead.
19915 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19917 * @brief Set the icon object of the radio object
19919 * @param obj The radio object
19920 * @param icon The icon object
19922 * Once the icon object is set, a previously set one will be deleted. If you
19923 * want to keep that old content object, use the elm_radio_icon_unset()
19926 * @deprecated use elm_object_content_part_set() instead.
19929 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19931 * @brief Get the icon object of the radio object
19933 * @param obj The radio object
19934 * @return The icon object
19936 * @see elm_radio_icon_set()
19938 * @deprecated use elm_object_content_part_get() instead.
19941 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19943 * @brief Unset the icon used for the radio object
19945 * @param obj The radio object
19946 * @return The icon object that was being used
19948 * Unparent and return the icon object which was set for this widget.
19950 * @see elm_radio_icon_set()
19951 * @deprecated use elm_object_content_part_unset() instead.
19954 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19956 * @brief Add this radio to a group of other radio objects
19958 * @param obj The radio object
19959 * @param group Any object whose group the @p obj is to join.
19961 * Radio objects work in groups. Each member should have a different integer
19962 * value assigned. In order to have them work as a group, they need to know
19963 * about each other. This adds the given radio object to the group of which
19964 * the group object indicated is a member.
19966 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19968 * @brief Set the integer value that this radio object represents
19970 * @param obj The radio object
19971 * @param value The value to use if this radio object is selected
19973 * This sets the value of the radio.
19975 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19977 * @brief Get the integer value that this radio object represents
19979 * @param obj The radio object
19980 * @return The value used if this radio object is selected
19982 * This gets the value of the radio.
19984 * @see elm_radio_value_set()
19986 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19988 * @brief Set the value of the radio.
19990 * @param obj The radio object
19991 * @param value The value to use for the group
19993 * This sets the value of the radio group and will also set the value if
19994 * pointed to, to the value supplied, but will not call any callbacks.
19996 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19998 * @brief Get the state of the radio object
20000 * @param obj The radio object
20001 * @return The integer state
20003 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20005 * @brief Set a convenience pointer to a integer to change
20007 * @param obj The radio object
20008 * @param valuep Pointer to the integer to modify
20010 * This sets a pointer to a integer, that, in addition to the radio objects
20011 * state will also be modified directly. To stop setting the object pointed
20012 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20013 * when this is called, the radio objects state will also be modified to
20014 * reflect the value of the integer valuep points to, just like calling
20015 * elm_radio_value_set().
20017 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20023 * @defgroup Pager Pager
20025 * @image html img/widget/pager/preview-00.png
20026 * @image latex img/widget/pager/preview-00.eps
20028 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20030 * The flipping between āpagesā of objects is animated. All content in pager
20031 * is kept in a stack, the last content to be added will be on the top of the
20032 * stack(be visible).
20034 * Objects can be pushed or popped from the stack or deleted as normal.
20035 * Pushes and pops will animate (and a pop will delete the object once the
20036 * animation is finished). Any object already in the pager can be promoted to
20037 * the top(from its current stacking position) through the use of
20038 * elm_pager_content_promote(). Objects are pushed to the top with
20039 * elm_pager_content_push() and when the top item is no longer wanted, simply
20040 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20041 * object is no longer needed and is not the top item, just delete it as
20042 * normal. You can query which objects are the top and bottom with
20043 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20045 * Signals that you can add callbacks for are:
20046 * "hide,finished" - when the previous page is hided
20048 * This widget has the following styles available:
20051 * @li fade_translucide
20052 * @li fade_invisible
20053 * @note This styles affect only the flipping animations, the appearance when
20054 * not animating is unaffected by styles.
20056 * @ref tutorial_pager gives a good overview of the usage of the API.
20060 * Add a new pager to the parent
20062 * @param parent The parent object
20063 * @return The new object or NULL if it cannot be created
20067 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20069 * @brief Push an object to the top of the pager stack (and show it).
20071 * @param obj The pager object
20072 * @param content The object to push
20074 * The object pushed becomes a child of the pager, it will be controlled and
20075 * deleted when the pager is deleted.
20077 * @note If the content is already in the stack use
20078 * elm_pager_content_promote().
20079 * @warning Using this function on @p content already in the stack results in
20080 * undefined behavior.
20082 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20084 * @brief Pop the object that is on top of the stack
20086 * @param obj The pager object
20088 * This pops the object that is on the top(visible) of the pager, makes it
20089 * disappear, then deletes the object. The object that was underneath it on
20090 * the stack will become visible.
20092 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20094 * @brief Moves an object already in the pager stack to the top of the stack.
20096 * @param obj The pager object
20097 * @param content The object to promote
20099 * This will take the @p content and move it to the top of the stack as
20100 * if it had been pushed there.
20102 * @note If the content isn't already in the stack use
20103 * elm_pager_content_push().
20104 * @warning Using this function on @p content not already in the stack
20105 * results in undefined behavior.
20107 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20109 * @brief Return the object at the bottom of the pager stack
20111 * @param obj The pager object
20112 * @return The bottom object or NULL if none
20114 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20116 * @brief Return the object at the top of the pager stack
20118 * @param obj The pager object
20119 * @return The top object or NULL if none
20121 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20123 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20124 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20131 * @defgroup Slideshow Slideshow
20133 * @image html img/widget/slideshow/preview-00.png
20134 * @image latex img/widget/slideshow/preview-00.eps
20136 * This widget, as the name indicates, is a pre-made image
20137 * slideshow panel, with API functions acting on (child) image
20138 * items presentation. Between those actions, are:
20139 * - advance to next/previous image
20140 * - select the style of image transition animation
20141 * - set the exhibition time for each image
20142 * - start/stop the slideshow
20144 * The transition animations are defined in the widget's theme,
20145 * consequently new animations can be added without having to
20146 * update the widget's code.
20148 * @section Slideshow_Items Slideshow items
20150 * For slideshow items, just like for @ref Genlist "genlist" ones,
20151 * the user defines a @b classes, specifying functions that will be
20152 * called on the item's creation and deletion times.
20154 * The #Elm_Slideshow_Item_Class structure contains the following
20157 * - @c func.get - When an item is displayed, this function is
20158 * called, and it's where one should create the item object, de
20159 * facto. For example, the object can be a pure Evas image object
20160 * or an Elementary @ref Photocam "photocam" widget. See
20161 * #SlideshowItemGetFunc.
20162 * - @c func.del - When an item is no more displayed, this function
20163 * is called, where the user must delete any data associated to
20164 * the item. See #SlideshowItemDelFunc.
20166 * @section Slideshow_Caching Slideshow caching
20168 * The slideshow provides facilities to have items adjacent to the
20169 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20170 * you, so that the system does not have to decode image data
20171 * anymore at the time it has to actually switch images on its
20172 * viewport. The user is able to set the numbers of items to be
20173 * cached @b before and @b after the current item, in the widget's
20176 * Smart events one can add callbacks for are:
20178 * - @c "changed" - when the slideshow switches its view to a new
20181 * List of examples for the slideshow widget:
20182 * @li @ref slideshow_example
20186 * @addtogroup Slideshow
20190 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20191 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20192 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20193 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20194 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20197 * @struct _Elm_Slideshow_Item_Class
20199 * Slideshow item class definition. See @ref Slideshow_Items for
20202 struct _Elm_Slideshow_Item_Class
20204 struct _Elm_Slideshow_Item_Class_Func
20206 SlideshowItemGetFunc get;
20207 SlideshowItemDelFunc del;
20209 }; /**< #Elm_Slideshow_Item_Class member definitions */
20212 * Add a new slideshow widget to the given parent Elementary
20213 * (container) object
20215 * @param parent The parent object
20216 * @return A new slideshow widget handle or @c NULL, on errors
20218 * This function inserts a new slideshow widget on the canvas.
20220 * @ingroup Slideshow
20222 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20225 * Add (append) a new item in a given slideshow widget.
20227 * @param obj The slideshow object
20228 * @param itc The item class for the item
20229 * @param data The item's data
20230 * @return A handle to the item added or @c NULL, on errors
20232 * Add a new item to @p obj's internal list of items, appending it.
20233 * The item's class must contain the function really fetching the
20234 * image object to show for this item, which could be an Evas image
20235 * object or an Elementary photo, for example. The @p data
20236 * parameter is going to be passed to both class functions of the
20239 * @see #Elm_Slideshow_Item_Class
20240 * @see elm_slideshow_item_sorted_insert()
20242 * @ingroup Slideshow
20244 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20247 * Insert a new item into the given slideshow widget, using the @p func
20248 * function to sort items (by item handles).
20250 * @param obj The slideshow object
20251 * @param itc The item class for the item
20252 * @param data The item's data
20253 * @param func The comparing function to be used to sort slideshow
20254 * items <b>by #Elm_Slideshow_Item item handles</b>
20255 * @return Returns The slideshow item handle, on success, or
20256 * @c NULL, on errors
20258 * Add a new item to @p obj's internal list of items, in a position
20259 * determined by the @p func comparing function. The item's class
20260 * must contain the function really fetching the image object to
20261 * show for this item, which could be an Evas image object or an
20262 * Elementary photo, for example. The @p data parameter is going to
20263 * be passed to both class functions of the item.
20265 * @see #Elm_Slideshow_Item_Class
20266 * @see elm_slideshow_item_add()
20268 * @ingroup Slideshow
20270 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);
20273 * Display a given slideshow widget's item, programmatically.
20275 * @param obj The slideshow object
20276 * @param item The item to display on @p obj's viewport
20278 * The change between the current item and @p item will use the
20279 * transition @p obj is set to use (@see
20280 * elm_slideshow_transition_set()).
20282 * @ingroup Slideshow
20284 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20287 * Slide to the @b next item, in a given slideshow widget
20289 * @param obj The slideshow object
20291 * The sliding animation @p obj is set to use will be the
20292 * transition effect used, after this call is issued.
20294 * @note If the end of the slideshow's internal list of items is
20295 * reached, it'll wrap around to the list's beginning, again.
20297 * @ingroup Slideshow
20299 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20302 * Slide to the @b previous item, in a given slideshow widget
20304 * @param obj The slideshow object
20306 * The sliding animation @p obj is set to use will be the
20307 * transition effect used, after this call is issued.
20309 * @note If the beginning of the slideshow's internal list of items
20310 * is reached, it'll wrap around to the list's end, again.
20312 * @ingroup Slideshow
20314 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20317 * Returns the list of sliding transition/effect names available, for a
20318 * given slideshow widget.
20320 * @param obj The slideshow object
20321 * @return The list of transitions (list of @b stringshared strings
20324 * The transitions, which come from @p obj's theme, must be an EDC
20325 * data item named @c "transitions" on the theme file, with (prefix)
20326 * names of EDC programs actually implementing them.
20328 * The available transitions for slideshows on the default theme are:
20329 * - @c "fade" - the current item fades out, while the new one
20330 * fades in to the slideshow's viewport.
20331 * - @c "black_fade" - the current item fades to black, and just
20332 * then, the new item will fade in.
20333 * - @c "horizontal" - the current item slides horizontally, until
20334 * it gets out of the slideshow's viewport, while the new item
20335 * comes from the left to take its place.
20336 * - @c "vertical" - the current item slides vertically, until it
20337 * gets out of the slideshow's viewport, while the new item comes
20338 * from the bottom to take its place.
20339 * - @c "square" - the new item starts to appear from the middle of
20340 * the current one, but with a tiny size, growing until its
20341 * target (full) size and covering the old one.
20343 * @warning The stringshared strings get no new references
20344 * exclusive to the user grabbing the list, here, so if you'd like
20345 * to use them out of this call's context, you'd better @c
20346 * eina_stringshare_ref() them.
20348 * @see elm_slideshow_transition_set()
20350 * @ingroup Slideshow
20352 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20355 * Set the current slide transition/effect in use for a given
20358 * @param obj The slideshow object
20359 * @param transition The new transition's name string
20361 * If @p transition is implemented in @p obj's theme (i.e., is
20362 * contained in the list returned by
20363 * elm_slideshow_transitions_get()), this new sliding effect will
20364 * be used on the widget.
20366 * @see elm_slideshow_transitions_get() for more details
20368 * @ingroup Slideshow
20370 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20373 * Get the current slide transition/effect in use for a given
20376 * @param obj The slideshow object
20377 * @return The current transition's name
20379 * @see elm_slideshow_transition_set() for more details
20381 * @ingroup Slideshow
20383 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20386 * Set the interval between each image transition on a given
20387 * slideshow widget, <b>and start the slideshow, itself</b>
20389 * @param obj The slideshow object
20390 * @param timeout The new displaying timeout for images
20392 * After this call, the slideshow widget will start cycling its
20393 * view, sequentially and automatically, with the images of the
20394 * items it has. The time between each new image displayed is going
20395 * to be @p timeout, in @b seconds. If a different timeout was set
20396 * previously and an slideshow was in progress, it will continue
20397 * with the new time between transitions, after this call.
20399 * @note A value less than or equal to 0 on @p timeout will disable
20400 * the widget's internal timer, thus halting any slideshow which
20401 * could be happening on @p obj.
20403 * @see elm_slideshow_timeout_get()
20405 * @ingroup Slideshow
20407 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20410 * Get the interval set for image transitions on a given slideshow
20413 * @param obj The slideshow object
20414 * @return Returns the timeout set on it
20416 * @see elm_slideshow_timeout_set() for more details
20418 * @ingroup Slideshow
20420 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20423 * Set if, after a slideshow is started, for a given slideshow
20424 * widget, its items should be displayed cyclically or not.
20426 * @param obj The slideshow object
20427 * @param loop Use @c EINA_TRUE to make it cycle through items or
20428 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20431 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20432 * ignore what is set by this functions, i.e., they'll @b always
20433 * cycle through items. This affects only the "automatic"
20434 * slideshow, as set by elm_slideshow_timeout_set().
20436 * @see elm_slideshow_loop_get()
20438 * @ingroup Slideshow
20440 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20443 * Get if, after a slideshow is started, for a given slideshow
20444 * widget, its items are to be displayed cyclically or not.
20446 * @param obj The slideshow object
20447 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20448 * through or @c EINA_FALSE, otherwise
20450 * @see elm_slideshow_loop_set() for more details
20452 * @ingroup Slideshow
20454 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20457 * Remove all items from a given slideshow widget
20459 * @param obj The slideshow object
20461 * This removes (and deletes) all items in @p obj, leaving it
20464 * @see elm_slideshow_item_del(), to remove just one item.
20466 * @ingroup Slideshow
20468 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20471 * Get the internal list of items in a given slideshow widget.
20473 * @param obj The slideshow object
20474 * @return The list of items (#Elm_Slideshow_Item as data) or
20475 * @c NULL on errors.
20477 * This list is @b not to be modified in any way and must not be
20478 * freed. Use the list members with functions like
20479 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20481 * @warning This list is only valid until @p obj object's internal
20482 * items list is changed. It should be fetched again with another
20483 * call to this function when changes happen.
20485 * @ingroup Slideshow
20487 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20490 * Delete a given item from a slideshow widget.
20492 * @param item The slideshow item
20494 * @ingroup Slideshow
20496 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20499 * Return the data associated with a given slideshow item
20501 * @param item The slideshow item
20502 * @return Returns the data associated to this item
20504 * @ingroup Slideshow
20506 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20509 * Returns the currently displayed item, in a given slideshow widget
20511 * @param obj The slideshow object
20512 * @return A handle to the item being displayed in @p obj or
20513 * @c NULL, if none is (and on errors)
20515 * @ingroup Slideshow
20517 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20520 * Get the real Evas object created to implement the view of a
20521 * given slideshow item
20523 * @param item The slideshow item.
20524 * @return the Evas object implementing this item's view.
20526 * This returns the actual Evas object used to implement the
20527 * specified slideshow item's view. This may be @c NULL, as it may
20528 * not have been created or may have been deleted, at any time, by
20529 * the slideshow. <b>Do not modify this object</b> (move, resize,
20530 * show, hide, etc.), as the slideshow is controlling it. This
20531 * function is for querying, emitting custom signals or hooking
20532 * lower level callbacks for events on that object. Do not delete
20533 * this object under any circumstances.
20535 * @see elm_slideshow_item_data_get()
20537 * @ingroup Slideshow
20539 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20542 * Get the the item, in a given slideshow widget, placed at
20543 * position @p nth, in its internal items list
20545 * @param obj The slideshow object
20546 * @param nth The number of the item to grab a handle to (0 being
20548 * @return The item stored in @p obj at position @p nth or @c NULL,
20549 * if there's no item with that index (and on errors)
20551 * @ingroup Slideshow
20553 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20556 * Set the current slide layout in use for a given slideshow widget
20558 * @param obj The slideshow object
20559 * @param layout The new layout's name string
20561 * If @p layout is implemented in @p obj's theme (i.e., is contained
20562 * in the list returned by elm_slideshow_layouts_get()), this new
20563 * images layout will be used on the widget.
20565 * @see elm_slideshow_layouts_get() for more details
20567 * @ingroup Slideshow
20569 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20572 * Get the current slide layout in use for a given slideshow widget
20574 * @param obj The slideshow object
20575 * @return The current layout's name
20577 * @see elm_slideshow_layout_set() for more details
20579 * @ingroup Slideshow
20581 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20584 * Returns the list of @b layout names available, for a given
20585 * slideshow widget.
20587 * @param obj The slideshow object
20588 * @return The list of layouts (list of @b stringshared strings
20591 * Slideshow layouts will change how the widget is to dispose each
20592 * image item in its viewport, with regard to cropping, scaling,
20595 * The layouts, which come from @p obj's theme, must be an EDC
20596 * data item name @c "layouts" on the theme file, with (prefix)
20597 * names of EDC programs actually implementing them.
20599 * The available layouts for slideshows on the default theme are:
20600 * - @c "fullscreen" - item images with original aspect, scaled to
20601 * touch top and down slideshow borders or, if the image's heigh
20602 * is not enough, left and right slideshow borders.
20603 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20604 * one, but always leaving 10% of the slideshow's dimensions of
20605 * distance between the item image's borders and the slideshow
20606 * borders, for each axis.
20608 * @warning The stringshared strings get no new references
20609 * exclusive to the user grabbing the list, here, so if you'd like
20610 * to use them out of this call's context, you'd better @c
20611 * eina_stringshare_ref() them.
20613 * @see elm_slideshow_layout_set()
20615 * @ingroup Slideshow
20617 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20620 * Set the number of items to cache, on a given slideshow widget,
20621 * <b>before the current item</b>
20623 * @param obj The slideshow object
20624 * @param count Number of items to cache before the current one
20626 * The default value for this property is @c 2. See
20627 * @ref Slideshow_Caching "slideshow caching" for more details.
20629 * @see elm_slideshow_cache_before_get()
20631 * @ingroup Slideshow
20633 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20636 * Retrieve the number of items to cache, on a given slideshow widget,
20637 * <b>before the current item</b>
20639 * @param obj The slideshow object
20640 * @return The number of items set to be cached before the current one
20642 * @see elm_slideshow_cache_before_set() for more details
20644 * @ingroup Slideshow
20646 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20649 * Set the number of items to cache, on a given slideshow widget,
20650 * <b>after the current item</b>
20652 * @param obj The slideshow object
20653 * @param count Number of items to cache after the current one
20655 * The default value for this property is @c 2. See
20656 * @ref Slideshow_Caching "slideshow caching" for more details.
20658 * @see elm_slideshow_cache_after_get()
20660 * @ingroup Slideshow
20662 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20665 * Retrieve the number of items to cache, on a given slideshow widget,
20666 * <b>after the current item</b>
20668 * @param obj The slideshow object
20669 * @return The number of items set to be cached after the current one
20671 * @see elm_slideshow_cache_after_set() for more details
20673 * @ingroup Slideshow
20675 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20678 * Get the number of items stored in a given slideshow widget
20680 * @param obj The slideshow object
20681 * @return The number of items on @p obj, at the moment of this call
20683 * @ingroup Slideshow
20685 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20692 * @defgroup Fileselector File Selector
20694 * @image html img/widget/fileselector/preview-00.png
20695 * @image latex img/widget/fileselector/preview-00.eps
20697 * A file selector is a widget that allows a user to navigate
20698 * through a file system, reporting file selections back via its
20701 * It contains shortcut buttons for home directory (@c ~) and to
20702 * jump one directory upwards (..), as well as cancel/ok buttons to
20703 * confirm/cancel a given selection. After either one of those two
20704 * former actions, the file selector will issue its @c "done" smart
20707 * There's a text entry on it, too, showing the name of the current
20708 * selection. There's the possibility of making it editable, so it
20709 * is useful on file saving dialogs on applications, where one
20710 * gives a file name to save contents to, in a given directory in
20711 * the system. This custom file name will be reported on the @c
20712 * "done" smart callback (explained in sequence).
20714 * Finally, it has a view to display file system items into in two
20719 * If Elementary is built with support of the Ethumb thumbnailing
20720 * library, the second form of view will display preview thumbnails
20721 * of files which it supports.
20723 * Smart callbacks one can register to:
20725 * - @c "selected" - the user has clicked on a file (when not in
20726 * folders-only mode) or directory (when in folders-only mode)
20727 * - @c "directory,open" - the list has been populated with new
20728 * content (@c event_info is a pointer to the directory's
20729 * path, a @b stringshared string)
20730 * - @c "done" - the user has clicked on the "ok" or "cancel"
20731 * buttons (@c event_info is a pointer to the selection's
20732 * path, a @b stringshared string)
20734 * Here is an example on its usage:
20735 * @li @ref fileselector_example
20739 * @addtogroup Fileselector
20744 * Defines how a file selector widget is to layout its contents
20745 * (file system entries).
20747 typedef enum _Elm_Fileselector_Mode
20749 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20750 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20751 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20752 } Elm_Fileselector_Mode;
20755 * Add a new file selector widget to the given parent Elementary
20756 * (container) object
20758 * @param parent The parent object
20759 * @return a new file selector widget handle or @c NULL, on errors
20761 * This function inserts a new file selector widget on the canvas.
20763 * @ingroup Fileselector
20765 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20768 * Enable/disable the file name entry box where the user can type
20769 * in a name for a file, in a given file selector widget
20771 * @param obj The file selector object
20772 * @param is_save @c EINA_TRUE to make the file selector a "saving
20773 * dialog", @c EINA_FALSE otherwise
20775 * Having the entry editable is useful on file saving dialogs on
20776 * applications, where one gives a file name to save contents to,
20777 * in a given directory in the system. This custom file name will
20778 * be reported on the @c "done" smart callback.
20780 * @see elm_fileselector_is_save_get()
20782 * @ingroup Fileselector
20784 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20787 * Get whether the given file selector is in "saving dialog" mode
20789 * @param obj The file selector object
20790 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20791 * mode, @c EINA_FALSE otherwise (and on errors)
20793 * @see elm_fileselector_is_save_set() for more details
20795 * @ingroup Fileselector
20797 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20800 * Enable/disable folder-only view for a given file selector widget
20802 * @param obj The file selector object
20803 * @param only @c EINA_TRUE to make @p obj only display
20804 * directories, @c EINA_FALSE to make files to be displayed in it
20807 * If enabled, the widget's view will only display folder items,
20810 * @see elm_fileselector_folder_only_get()
20812 * @ingroup Fileselector
20814 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20817 * Get whether folder-only view is set for a given file selector
20820 * @param obj The file selector object
20821 * @return only @c EINA_TRUE if @p obj is only displaying
20822 * directories, @c EINA_FALSE if files are being displayed in it
20823 * too (and on errors)
20825 * @see elm_fileselector_folder_only_get()
20827 * @ingroup Fileselector
20829 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20832 * Enable/disable the "ok" and "cancel" buttons on a given file
20835 * @param obj The file selector object
20836 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20838 * @note A file selector without those buttons will never emit the
20839 * @c "done" smart event, and is only usable if one is just hooking
20840 * to the other two events.
20842 * @see elm_fileselector_buttons_ok_cancel_get()
20844 * @ingroup Fileselector
20846 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20849 * Get whether the "ok" and "cancel" buttons on a given file
20850 * selector widget are being shown.
20852 * @param obj The file selector object
20853 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20854 * otherwise (and on errors)
20856 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20858 * @ingroup Fileselector
20860 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20863 * Enable/disable a tree view in the given file selector widget,
20864 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20866 * @param obj The file selector object
20867 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20870 * In a tree view, arrows are created on the sides of directories,
20871 * allowing them to expand in place.
20873 * @note If it's in other mode, the changes made by this function
20874 * will only be visible when one switches back to "list" mode.
20876 * @see elm_fileselector_expandable_get()
20878 * @ingroup Fileselector
20880 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20883 * Get whether tree view is enabled for the given file selector
20886 * @param obj The file selector object
20887 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20888 * otherwise (and or errors)
20890 * @see elm_fileselector_expandable_set() for more details
20892 * @ingroup Fileselector
20894 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20897 * Set, programmatically, the @b directory that a given file
20898 * selector widget will display contents from
20900 * @param obj The file selector object
20901 * @param path The path to display in @p obj
20903 * This will change the @b directory that @p obj is displaying. It
20904 * will also clear the text entry area on the @p obj object, which
20905 * displays select files' names.
20907 * @see elm_fileselector_path_get()
20909 * @ingroup Fileselector
20911 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20914 * Get the parent directory's path that a given file selector
20915 * widget is displaying
20917 * @param obj The file selector object
20918 * @return The (full) path of the directory the file selector is
20919 * displaying, a @b stringshared string
20921 * @see elm_fileselector_path_set()
20923 * @ingroup Fileselector
20925 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20928 * Set, programmatically, the currently selected file/directory in
20929 * the given file selector widget
20931 * @param obj The file selector object
20932 * @param path The (full) path to a file or directory
20933 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20934 * latter case occurs if the directory or file pointed to do not
20937 * @see elm_fileselector_selected_get()
20939 * @ingroup Fileselector
20941 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20944 * Get the currently selected item's (full) path, in the given file
20947 * @param obj The file selector object
20948 * @return The absolute path of the selected item, a @b
20949 * stringshared string
20951 * @note Custom editions on @p obj object's text entry, if made,
20952 * will appear on the return string of this function, naturally.
20954 * @see elm_fileselector_selected_set() for more details
20956 * @ingroup Fileselector
20958 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20961 * Set the mode in which a given file selector widget will display
20962 * (layout) file system entries in its view
20964 * @param obj The file selector object
20965 * @param mode The mode of the fileselector, being it one of
20966 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20967 * first one, naturally, will display the files in a list. The
20968 * latter will make the widget to display its entries in a grid
20971 * @note By using elm_fileselector_expandable_set(), the user may
20972 * trigger a tree view for that list.
20974 * @note If Elementary is built with support of the Ethumb
20975 * thumbnailing library, the second form of view will display
20976 * preview thumbnails of files which it supports. You must have
20977 * elm_need_ethumb() called in your Elementary for thumbnailing to
20980 * @see elm_fileselector_expandable_set().
20981 * @see elm_fileselector_mode_get().
20983 * @ingroup Fileselector
20985 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20988 * Get the mode in which a given file selector widget is displaying
20989 * (layouting) file system entries in its view
20991 * @param obj The fileselector object
20992 * @return The mode in which the fileselector is at
20994 * @see elm_fileselector_mode_set() for more details
20996 * @ingroup Fileselector
20998 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21005 * @defgroup Progressbar Progress bar
21007 * The progress bar is a widget for visually representing the
21008 * progress status of a given job/task.
21010 * A progress bar may be horizontal or vertical. It may display an
21011 * icon besides it, as well as primary and @b units labels. The
21012 * former is meant to label the widget as a whole, while the
21013 * latter, which is formatted with floating point values (and thus
21014 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21015 * units"</c>), is meant to label the widget's <b>progress
21016 * value</b>. Label, icon and unit strings/objects are @b optional
21017 * for progress bars.
21019 * A progress bar may be @b inverted, in which state it gets its
21020 * values inverted, with high values being on the left or top and
21021 * low values on the right or bottom, as opposed to normally have
21022 * the low values on the former and high values on the latter,
21023 * respectively, for horizontal and vertical modes.
21025 * The @b span of the progress, as set by
21026 * elm_progressbar_span_size_set(), is its length (horizontally or
21027 * vertically), unless one puts size hints on the widget to expand
21028 * on desired directions, by any container. That length will be
21029 * scaled by the object or applications scaling factor. At any
21030 * point code can query the progress bar for its value with
21031 * elm_progressbar_value_get().
21033 * Available widget styles for progress bars:
21035 * - @c "wheel" (simple style, no text, no progression, only
21036 * "pulse" effect is available)
21038 * Default contents parts of the progressbar widget that you can use for are:
21039 * @li "icon" - A icon of the progressbar
21041 * Here is an example on its usage:
21042 * @li @ref progressbar_example
21046 * Add a new progress bar widget to the given parent Elementary
21047 * (container) object
21049 * @param parent The parent object
21050 * @return a new progress bar widget handle or @c NULL, on errors
21052 * This function inserts a new progress bar widget on the canvas.
21054 * @ingroup Progressbar
21056 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21059 * Set whether a given progress bar widget is at "pulsing mode" or
21062 * @param obj The progress bar object
21063 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21064 * @c EINA_FALSE to put it back to its default one
21066 * By default, progress bars will display values from the low to
21067 * high value boundaries. There are, though, contexts in which the
21068 * state of progression of a given task is @b unknown. For those,
21069 * one can set a progress bar widget to a "pulsing state", to give
21070 * the user an idea that some computation is being held, but
21071 * without exact progress values. In the default theme it will
21072 * animate its bar with the contents filling in constantly and back
21073 * to non-filled, in a loop. To start and stop this pulsing
21074 * animation, one has to explicitly call elm_progressbar_pulse().
21076 * @see elm_progressbar_pulse_get()
21077 * @see elm_progressbar_pulse()
21079 * @ingroup Progressbar
21081 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21084 * Get whether a given progress bar widget is at "pulsing mode" or
21087 * @param obj The progress bar object
21088 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21089 * if it's in the default one (and on errors)
21091 * @ingroup Progressbar
21093 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21096 * Start/stop a given progress bar "pulsing" animation, if its
21099 * @param obj The progress bar object
21100 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21101 * @c EINA_FALSE to @b stop it
21103 * @note This call won't do anything if @p obj is not under "pulsing mode".
21105 * @see elm_progressbar_pulse_set() for more details.
21107 * @ingroup Progressbar
21109 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21112 * Set the progress value (in percentage) on a given progress bar
21115 * @param obj The progress bar object
21116 * @param val The progress value (@b must be between @c 0.0 and @c
21119 * Use this call to set progress bar levels.
21121 * @note If you passes a value out of the specified range for @p
21122 * val, it will be interpreted as the @b closest of the @b boundary
21123 * values in the range.
21125 * @ingroup Progressbar
21127 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21130 * Get the progress value (in percentage) on a given progress bar
21133 * @param obj The progress bar object
21134 * @return The value of the progressbar
21136 * @see elm_progressbar_value_set() for more details
21138 * @ingroup Progressbar
21140 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21143 * Set the label of a given progress bar widget
21145 * @param obj The progress bar object
21146 * @param label The text label string, in UTF-8
21148 * @ingroup Progressbar
21149 * @deprecated use elm_object_text_set() instead.
21151 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21154 * Get the label of a given progress bar widget
21156 * @param obj The progressbar object
21157 * @return The text label string, in UTF-8
21159 * @ingroup Progressbar
21160 * @deprecated use elm_object_text_set() instead.
21162 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21165 * Set the icon object of a given progress bar widget
21167 * @param obj The progress bar object
21168 * @param icon The icon object
21170 * Use this call to decorate @p obj with an icon next to it.
21172 * @note Once the icon object is set, a previously set one will be
21173 * deleted. If you want to keep that old content object, use the
21174 * elm_progressbar_icon_unset() function.
21176 * @see elm_progressbar_icon_get()
21177 * @deprecated use elm_object_content_part_set() instead.
21179 * @ingroup Progressbar
21181 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21184 * Retrieve the icon object set for a given progress bar widget
21186 * @param obj The progress bar object
21187 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21188 * otherwise (and on errors)
21190 * @see elm_progressbar_icon_set() for more details
21191 * @deprecated use elm_object_content_part_get() instead.
21193 * @ingroup Progressbar
21195 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21198 * Unset an icon set on a given progress bar widget
21200 * @param obj The progress bar object
21201 * @return The icon object that was being used, if any was set, or
21202 * @c NULL, otherwise (and on errors)
21204 * This call will unparent and return the icon object which was set
21205 * for this widget, previously, on success.
21207 * @see elm_progressbar_icon_set() for more details
21208 * @deprecated use elm_object_content_part_unset() instead.
21210 * @ingroup Progressbar
21212 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21215 * Set the (exact) length of the bar region of a given progress bar
21218 * @param obj The progress bar object
21219 * @param size The length of the progress bar's bar region
21221 * This sets the minimum width (when in horizontal mode) or height
21222 * (when in vertical mode) of the actual bar area of the progress
21223 * bar @p obj. This in turn affects the object's minimum size. Use
21224 * this when you're not setting other size hints expanding on the
21225 * given direction (like weight and alignment hints) and you would
21226 * like it to have a specific size.
21228 * @note Icon, label and unit text around @p obj will require their
21229 * own space, which will make @p obj to require more the @p size,
21232 * @see elm_progressbar_span_size_get()
21234 * @ingroup Progressbar
21236 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21239 * Get the length set for the bar region of a given progress bar
21242 * @param obj The progress bar object
21243 * @return The length of the progress bar's bar region
21245 * If that size was not set previously, with
21246 * elm_progressbar_span_size_set(), this call will return @c 0.
21248 * @ingroup Progressbar
21250 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21253 * Set the format string for a given progress bar widget's units
21256 * @param obj The progress bar object
21257 * @param format The format string for @p obj's units label
21259 * If @c NULL is passed on @p format, it will make @p obj's units
21260 * area to be hidden completely. If not, it'll set the <b>format
21261 * string</b> for the units label's @b text. The units label is
21262 * provided a floating point value, so the units text is up display
21263 * at most one floating point falue. Note that the units label is
21264 * optional. Use a format string such as "%1.2f meters" for
21267 * @note The default format string for a progress bar is an integer
21268 * percentage, as in @c "%.0f %%".
21270 * @see elm_progressbar_unit_format_get()
21272 * @ingroup Progressbar
21274 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21277 * Retrieve the format string set for a given progress bar widget's
21280 * @param obj The progress bar object
21281 * @return The format set string for @p obj's units label or
21282 * @c NULL, if none was set (and on errors)
21284 * @see elm_progressbar_unit_format_set() for more details
21286 * @ingroup Progressbar
21288 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21291 * Set the orientation of a given progress bar widget
21293 * @param obj The progress bar object
21294 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21295 * @b horizontal, @c EINA_FALSE to make it @b vertical
21297 * Use this function to change how your progress bar is to be
21298 * disposed: vertically or horizontally.
21300 * @see elm_progressbar_horizontal_get()
21302 * @ingroup Progressbar
21304 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21307 * Retrieve the orientation of a given progress bar widget
21309 * @param obj The progress bar object
21310 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21311 * @c EINA_FALSE if it's @b vertical (and on errors)
21313 * @see elm_progressbar_horizontal_set() for more details
21315 * @ingroup Progressbar
21317 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21320 * Invert a given progress bar widget's displaying values order
21322 * @param obj The progress bar object
21323 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21324 * @c EINA_FALSE to bring it back to default, non-inverted values.
21326 * A progress bar may be @b inverted, in which state it gets its
21327 * values inverted, with high values being on the left or top and
21328 * low values on the right or bottom, as opposed to normally have
21329 * the low values on the former and high values on the latter,
21330 * respectively, for horizontal and vertical modes.
21332 * @see elm_progressbar_inverted_get()
21334 * @ingroup Progressbar
21336 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21339 * Get whether a given progress bar widget's displaying values are
21342 * @param obj The progress bar object
21343 * @return @c EINA_TRUE, if @p obj has inverted values,
21344 * @c EINA_FALSE otherwise (and on errors)
21346 * @see elm_progressbar_inverted_set() for more details
21348 * @ingroup Progressbar
21350 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21353 * @defgroup Separator Separator
21355 * @brief Separator is a very thin object used to separate other objects.
21357 * A separator can be vertical or horizontal.
21359 * @ref tutorial_separator is a good example of how to use a separator.
21363 * @brief Add a separator object to @p parent
21365 * @param parent The parent object
21367 * @return The separator object, or NULL upon failure
21369 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21371 * @brief Set the horizontal mode of a separator object
21373 * @param obj The separator object
21374 * @param horizontal If true, the separator is horizontal
21376 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21378 * @brief Get the horizontal mode of a separator object
21380 * @param obj The separator object
21381 * @return If true, the separator is horizontal
21383 * @see elm_separator_horizontal_set()
21385 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21391 * @defgroup Spinner Spinner
21392 * @ingroup Elementary
21394 * @image html img/widget/spinner/preview-00.png
21395 * @image latex img/widget/spinner/preview-00.eps
21397 * A spinner is a widget which allows the user to increase or decrease
21398 * numeric values using arrow buttons, or edit values directly, clicking
21399 * over it and typing the new value.
21401 * By default the spinner will not wrap and has a label
21402 * of "%.0f" (just showing the integer value of the double).
21404 * A spinner has a label that is formatted with floating
21405 * point values and thus accepts a printf-style format string, like
21406 * ā%1.2f unitsā.
21408 * It also allows specific values to be replaced by pre-defined labels.
21410 * Smart callbacks one can register to:
21412 * - "changed" - Whenever the spinner value is changed.
21413 * - "delay,changed" - A short time after the value is changed by the user.
21414 * This will be called only when the user stops dragging for a very short
21415 * period or when they release their finger/mouse, so it avoids possibly
21416 * expensive reactions to the value change.
21418 * Available styles for it:
21420 * - @c "vertical": up/down buttons at the right side and text left aligned.
21422 * Here is an example on its usage:
21423 * @ref spinner_example
21427 * @addtogroup Spinner
21432 * Add a new spinner widget to the given parent Elementary
21433 * (container) object.
21435 * @param parent The parent object.
21436 * @return a new spinner widget handle or @c NULL, on errors.
21438 * This function inserts a new spinner widget on the canvas.
21443 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21446 * Set the format string of the displayed label.
21448 * @param obj The spinner object.
21449 * @param fmt The format string for the label display.
21451 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21452 * string for the label text. The label text is provided a floating point
21453 * value, so the label text can display up to 1 floating point value.
21454 * Note that this is optional.
21456 * Use a format string such as "%1.2f meters" for example, and it will
21457 * display values like: "3.14 meters" for a value equal to 3.14159.
21459 * Default is "%0.f".
21461 * @see elm_spinner_label_format_get()
21465 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21468 * Get the label format of the spinner.
21470 * @param obj The spinner object.
21471 * @return The text label format string in UTF-8.
21473 * @see elm_spinner_label_format_set() for details.
21477 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21480 * Set the minimum and maximum values for the spinner.
21482 * @param obj The spinner object.
21483 * @param min The minimum value.
21484 * @param max The maximum value.
21486 * Define the allowed range of values to be selected by the user.
21488 * If actual value is less than @p min, it will be updated to @p min. If it
21489 * is bigger then @p max, will be updated to @p max. Actual value can be
21490 * get with elm_spinner_value_get().
21492 * By default, min is equal to 0, and max is equal to 100.
21494 * @warning Maximum must be greater than minimum.
21496 * @see elm_spinner_min_max_get()
21500 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21503 * Get the minimum and maximum values of the spinner.
21505 * @param obj The spinner object.
21506 * @param min Pointer where to store the minimum value.
21507 * @param max Pointer where to store the maximum value.
21509 * @note If only one value is needed, the other pointer can be passed
21512 * @see elm_spinner_min_max_set() for details.
21516 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21519 * Set the step used to increment or decrement the spinner value.
21521 * @param obj The spinner object.
21522 * @param step The step value.
21524 * This value will be incremented or decremented to the displayed value.
21525 * It will be incremented while the user keep right or top arrow pressed,
21526 * and will be decremented while the user keep left or bottom arrow pressed.
21528 * The interval to increment / decrement can be set with
21529 * elm_spinner_interval_set().
21531 * By default step value is equal to 1.
21533 * @see elm_spinner_step_get()
21537 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21540 * Get the step used to increment or decrement the spinner value.
21542 * @param obj The spinner object.
21543 * @return The step value.
21545 * @see elm_spinner_step_get() for more details.
21549 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21552 * Set the value the spinner displays.
21554 * @param obj The spinner object.
21555 * @param val The value to be displayed.
21557 * Value will be presented on the label following format specified with
21558 * elm_spinner_format_set().
21560 * @warning The value must to be between min and max values. This values
21561 * are set by elm_spinner_min_max_set().
21563 * @see elm_spinner_value_get().
21564 * @see elm_spinner_format_set().
21565 * @see elm_spinner_min_max_set().
21569 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21572 * Get the value displayed by the spinner.
21574 * @param obj The spinner object.
21575 * @return The value displayed.
21577 * @see elm_spinner_value_set() for details.
21581 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21584 * Set whether the spinner should wrap when it reaches its
21585 * minimum or maximum value.
21587 * @param obj The spinner object.
21588 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21591 * Disabled by default. If disabled, when the user tries to increment the
21593 * but displayed value plus step value is bigger than maximum value,
21595 * won't allow it. The same happens when the user tries to decrement it,
21596 * but the value less step is less than minimum value.
21598 * When wrap is enabled, in such situations it will allow these changes,
21599 * but will get the value that would be less than minimum and subtracts
21600 * from maximum. Or add the value that would be more than maximum to
21604 * @li min value = 10
21605 * @li max value = 50
21606 * @li step value = 20
21607 * @li displayed value = 20
21609 * When the user decrement value (using left or bottom arrow), it will
21610 * displays @c 40, because max - (min - (displayed - step)) is
21611 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21613 * @see elm_spinner_wrap_get().
21617 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21620 * Get whether the spinner should wrap when it reaches its
21621 * minimum or maximum value.
21623 * @param obj The spinner object
21624 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21625 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21627 * @see elm_spinner_wrap_set() for details.
21631 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21634 * Set whether the spinner can be directly edited by the user or not.
21636 * @param obj The spinner object.
21637 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21638 * don't allow users to edit it directly.
21640 * Spinner objects can have edition @b disabled, in which state they will
21641 * be changed only by arrows.
21642 * Useful for contexts
21643 * where you don't want your users to interact with it writting the value.
21645 * when using special values, the user can see real value instead
21646 * of special label on edition.
21648 * It's enabled by default.
21650 * @see elm_spinner_editable_get()
21654 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21657 * Get whether the spinner can be directly edited by the user or not.
21659 * @param obj The spinner object.
21660 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21661 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21663 * @see elm_spinner_editable_set() for details.
21667 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21670 * Set a special string to display in the place of the numerical value.
21672 * @param obj The spinner object.
21673 * @param value The value to be replaced.
21674 * @param label The label to be used.
21676 * It's useful for cases when a user should select an item that is
21677 * better indicated by a label than a value. For example, weekdays or months.
21681 * sp = elm_spinner_add(win);
21682 * elm_spinner_min_max_set(sp, 1, 3);
21683 * elm_spinner_special_value_add(sp, 1, "January");
21684 * elm_spinner_special_value_add(sp, 2, "February");
21685 * elm_spinner_special_value_add(sp, 3, "March");
21686 * evas_object_show(sp);
21691 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21694 * Set the interval on time updates for an user mouse button hold
21695 * on spinner widgets' arrows.
21697 * @param obj The spinner object.
21698 * @param interval The (first) interval value in seconds.
21700 * This interval value is @b decreased while the user holds the
21701 * mouse pointer either incrementing or decrementing spinner's value.
21703 * This helps the user to get to a given value distant from the
21704 * current one easier/faster, as it will start to change quicker and
21705 * quicker on mouse button holds.
21707 * The calculation for the next change interval value, starting from
21708 * the one set with this call, is the previous interval divided by
21709 * @c 1.05, so it decreases a little bit.
21711 * The default starting interval value for automatic changes is
21714 * @see elm_spinner_interval_get()
21718 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21721 * Get the interval on time updates for an user mouse button hold
21722 * on spinner widgets' arrows.
21724 * @param obj The spinner object.
21725 * @return The (first) interval value, in seconds, set on it.
21727 * @see elm_spinner_interval_set() for more details.
21731 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21738 * @defgroup Index Index
21740 * @image html img/widget/index/preview-00.png
21741 * @image latex img/widget/index/preview-00.eps
21743 * An index widget gives you an index for fast access to whichever
21744 * group of other UI items one might have. It's a list of text
21745 * items (usually letters, for alphabetically ordered access).
21747 * Index widgets are by default hidden and just appear when the
21748 * user clicks over it's reserved area in the canvas. In its
21749 * default theme, it's an area one @ref Fingers "finger" wide on
21750 * the right side of the index widget's container.
21752 * When items on the index are selected, smart callbacks get
21753 * called, so that its user can make other container objects to
21754 * show a given area or child object depending on the index item
21755 * selected. You'd probably be using an index together with @ref
21756 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21759 * Smart events one can add callbacks for are:
21760 * - @c "changed" - When the selected index item changes. @c
21761 * event_info is the selected item's data pointer.
21762 * - @c "delay,changed" - When the selected index item changes, but
21763 * after a small idling period. @c event_info is the selected
21764 * item's data pointer.
21765 * - @c "selected" - When the user releases a mouse button and
21766 * selects an item. @c event_info is the selected item's data
21768 * - @c "level,up" - when the user moves a finger from the first
21769 * level to the second level
21770 * - @c "level,down" - when the user moves a finger from the second
21771 * level to the first level
21773 * The @c "delay,changed" event is so that it'll wait a small time
21774 * before actually reporting those events and, moreover, just the
21775 * last event happening on those time frames will actually be
21778 * Here are some examples on its usage:
21779 * @li @ref index_example_01
21780 * @li @ref index_example_02
21784 * @addtogroup Index
21788 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21791 * Add a new index widget to the given parent Elementary
21792 * (container) object
21794 * @param parent The parent object
21795 * @return a new index widget handle or @c NULL, on errors
21797 * This function inserts a new index widget on the canvas.
21801 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21804 * Set whether a given index widget is or not visible,
21807 * @param obj The index object
21808 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21810 * Not to be confused with visible as in @c evas_object_show() --
21811 * visible with regard to the widget's auto hiding feature.
21813 * @see elm_index_active_get()
21817 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21820 * Get whether a given index widget is currently visible or not.
21822 * @param obj The index object
21823 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21825 * @see elm_index_active_set() for more details
21829 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21832 * Set the items level for a given index widget.
21834 * @param obj The index object.
21835 * @param level @c 0 or @c 1, the currently implemented levels.
21837 * @see elm_index_item_level_get()
21841 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21844 * Get the items level set for a given index widget.
21846 * @param obj The index object.
21847 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21849 * @see elm_index_item_level_set() for more information
21853 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21856 * Returns the last selected item's data, for a given index widget.
21858 * @param obj The index object.
21859 * @return The item @b data associated to the last selected item on
21860 * @p obj (or @c NULL, on errors).
21862 * @warning The returned value is @b not an #Elm_Index_Item item
21863 * handle, but the data associated to it (see the @c item parameter
21864 * in elm_index_item_append(), as an example).
21868 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21871 * Append a new item on a given index widget.
21873 * @param obj The index object.
21874 * @param letter Letter under which the item should be indexed
21875 * @param item The item data to set for the index's item
21877 * Despite the most common usage of the @p letter argument is for
21878 * single char strings, one could use arbitrary strings as index
21881 * @c item will be the pointer returned back on @c "changed", @c
21882 * "delay,changed" and @c "selected" smart events.
21886 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21889 * Prepend a new item on a given index widget.
21891 * @param obj The index object.
21892 * @param letter Letter under which the item should be indexed
21893 * @param item The item data to set for the index's item
21895 * Despite the most common usage of the @p letter argument is for
21896 * single char strings, one could use arbitrary strings as index
21899 * @c item will be the pointer returned back on @c "changed", @c
21900 * "delay,changed" and @c "selected" smart events.
21904 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21907 * Append a new item, on a given index widget, <b>after the item
21908 * having @p relative as data</b>.
21910 * @param obj The index object.
21911 * @param letter Letter under which the item should be indexed
21912 * @param item The item data to set for the index's item
21913 * @param relative The item data of the index item to be the
21914 * predecessor of this new one
21916 * Despite the most common usage of the @p letter argument is for
21917 * single char strings, one could use arbitrary strings as index
21920 * @c item will be the pointer returned back on @c "changed", @c
21921 * "delay,changed" and @c "selected" smart events.
21923 * @note If @p relative is @c NULL or if it's not found to be data
21924 * set on any previous item on @p obj, this function will behave as
21925 * elm_index_item_append().
21929 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21932 * Prepend a new item, on a given index widget, <b>after the item
21933 * having @p relative as data</b>.
21935 * @param obj The index object.
21936 * @param letter Letter under which the item should be indexed
21937 * @param item The item data to set for the index's item
21938 * @param relative The item data of the index item to be the
21939 * successor of this new one
21941 * Despite the most common usage of the @p letter argument is for
21942 * single char strings, one could use arbitrary strings as index
21945 * @c item will be the pointer returned back on @c "changed", @c
21946 * "delay,changed" and @c "selected" smart events.
21948 * @note If @p relative is @c NULL or if it's not found to be data
21949 * set on any previous item on @p obj, this function will behave as
21950 * elm_index_item_prepend().
21954 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21957 * Insert a new item into the given index widget, using @p cmp_func
21958 * function to sort items (by item handles).
21960 * @param obj The index object.
21961 * @param letter Letter under which the item should be indexed
21962 * @param item The item data to set for the index's item
21963 * @param cmp_func The comparing function to be used to sort index
21964 * items <b>by #Elm_Index_Item item handles</b>
21965 * @param cmp_data_func A @b fallback function to be called for the
21966 * sorting of index items <b>by item data</b>). It will be used
21967 * when @p cmp_func returns @c 0 (equality), which means an index
21968 * item with provided item data already exists. To decide which
21969 * data item should be pointed to by the index item in question, @p
21970 * cmp_data_func will be used. If @p cmp_data_func returns a
21971 * non-negative value, the previous index item data will be
21972 * replaced by the given @p item pointer. If the previous data need
21973 * to be freed, it should be done by the @p cmp_data_func function,
21974 * because all references to it will be lost. If this function is
21975 * not provided (@c NULL is given), index items will be @b
21976 * duplicated, if @p cmp_func returns @c 0.
21978 * Despite the most common usage of the @p letter argument is for
21979 * single char strings, one could use arbitrary strings as index
21982 * @c item will be the pointer returned back on @c "changed", @c
21983 * "delay,changed" and @c "selected" smart events.
21987 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);
21990 * Remove an item from a given index widget, <b>to be referenced by
21991 * it's data value</b>.
21993 * @param obj The index object
21994 * @param item The item's data pointer for the item to be removed
21997 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21998 * that callback function will be called by this one.
22000 * @warning The item to be removed from @p obj will be found via
22001 * its item data pointer, and not by an #Elm_Index_Item handle.
22005 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22008 * Find a given index widget's item, <b>using item data</b>.
22010 * @param obj The index object
22011 * @param item The item data pointed to by the desired index item
22012 * @return The index item handle, if found, or @c NULL otherwise
22016 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22019 * Removes @b all items from a given index widget.
22021 * @param obj The index object.
22023 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22024 * that callback function will be called for each item in @p obj.
22028 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22031 * Go to a given items level on a index widget
22033 * @param obj The index object
22034 * @param level The index level (one of @c 0 or @c 1)
22038 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22041 * Return the data associated with a given index widget item
22043 * @param it The index widget item handle
22044 * @return The data associated with @p it
22046 * @see elm_index_item_data_set()
22050 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22053 * Set the data associated with a given index widget item
22055 * @param it The index widget item handle
22056 * @param data The new data pointer to set to @p it
22058 * This sets new item data on @p it.
22060 * @warning The old data pointer won't be touched by this function, so
22061 * the user had better to free that old data himself/herself.
22065 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22068 * Set the function to be called when a given index widget item is freed.
22070 * @param it The item to set the callback on
22071 * @param func The function to call on the item's deletion
22073 * When called, @p func will have both @c data and @c event_info
22074 * arguments with the @p it item's data value and, naturally, the
22075 * @c obj argument with a handle to the parent index widget.
22079 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22082 * Get the letter (string) set on a given index widget item.
22084 * @param it The index item handle
22085 * @return The letter string set on @p it
22089 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22093 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22100 * @defgroup Photocam Photocam
22102 * @image html img/widget/photocam/preview-00.png
22103 * @image latex img/widget/photocam/preview-00.eps
22105 * This is a widget specifically for displaying high-resolution digital
22106 * camera photos giving speedy feedback (fast load), low memory footprint
22107 * and zooming and panning as well as fitting logic. It is entirely focused
22108 * on jpeg images, and takes advantage of properties of the jpeg format (via
22109 * evas loader features in the jpeg loader).
22111 * Signals that you can add callbacks for are:
22112 * @li "clicked" - This is called when a user has clicked the photo without
22114 * @li "press" - This is called when a user has pressed down on the photo.
22115 * @li "longpressed" - This is called when a user has pressed down on the
22116 * photo for a long time without dragging around.
22117 * @li "clicked,double" - This is called when a user has double-clicked the
22119 * @li "load" - Photo load begins.
22120 * @li "loaded" - This is called when the image file load is complete for the
22121 * first view (low resolution blurry version).
22122 * @li "load,detail" - Photo detailed data load begins.
22123 * @li "loaded,detail" - This is called when the image file load is complete
22124 * for the detailed image data (full resolution needed).
22125 * @li "zoom,start" - Zoom animation started.
22126 * @li "zoom,stop" - Zoom animation stopped.
22127 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22128 * @li "scroll" - the content has been scrolled (moved)
22129 * @li "scroll,anim,start" - scrolling animation has started
22130 * @li "scroll,anim,stop" - scrolling animation has stopped
22131 * @li "scroll,drag,start" - dragging the contents around has started
22132 * @li "scroll,drag,stop" - dragging the contents around has stopped
22134 * @ref tutorial_photocam shows the API in action.
22138 * @brief Types of zoom available.
22140 typedef enum _Elm_Photocam_Zoom_Mode
22142 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22143 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22144 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22145 ELM_PHOTOCAM_ZOOM_MODE_LAST
22146 } Elm_Photocam_Zoom_Mode;
22148 * @brief Add a new Photocam object
22150 * @param parent The parent object
22151 * @return The new object or NULL if it cannot be created
22153 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22155 * @brief Set the photo file to be shown
22157 * @param obj The photocam object
22158 * @param file The photo file
22159 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22161 * This sets (and shows) the specified file (with a relative or absolute
22162 * path) and will return a load error (same error that
22163 * evas_object_image_load_error_get() will return). The image will change and
22164 * adjust its size at this point and begin a background load process for this
22165 * photo that at some time in the future will be displayed at the full
22168 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22170 * @brief Returns the path of the current image file
22172 * @param obj The photocam object
22173 * @return Returns the path
22175 * @see elm_photocam_file_set()
22177 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22179 * @brief Set the zoom level of the photo
22181 * @param obj The photocam object
22182 * @param zoom The zoom level to set
22184 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22185 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22186 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22187 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22190 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22192 * @brief Get the zoom level of the photo
22194 * @param obj The photocam object
22195 * @return The current zoom level
22197 * This returns the current zoom level of the photocam object. Note that if
22198 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22199 * (which is the default), the zoom level may be changed at any time by the
22200 * photocam object itself to account for photo size and photocam viewpoer
22203 * @see elm_photocam_zoom_set()
22204 * @see elm_photocam_zoom_mode_set()
22206 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22208 * @brief Set the zoom mode
22210 * @param obj The photocam object
22211 * @param mode The desired mode
22213 * This sets the zoom mode to manual or one of several automatic levels.
22214 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22215 * elm_photocam_zoom_set() and will stay at that level until changed by code
22216 * or until zoom mode is changed. This is the default mode. The Automatic
22217 * modes will allow the photocam object to automatically adjust zoom mode
22218 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22219 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22220 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22221 * pixels within the frame are left unfilled.
22223 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22225 * @brief Get the zoom mode
22227 * @param obj The photocam object
22228 * @return The current zoom mode
22230 * This gets the current zoom mode of the photocam object.
22232 * @see elm_photocam_zoom_mode_set()
22234 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22236 * @brief Get the current image pixel width and height
22238 * @param obj The photocam object
22239 * @param w A pointer to the width return
22240 * @param h A pointer to the height return
22242 * This gets the current photo pixel width and height (for the original).
22243 * The size will be returned in the integers @p w and @p h that are pointed
22246 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22248 * @brief Get the area of the image that is currently shown
22251 * @param x A pointer to the X-coordinate of region
22252 * @param y A pointer to the Y-coordinate of region
22253 * @param w A pointer to the width
22254 * @param h A pointer to the height
22256 * @see elm_photocam_image_region_show()
22257 * @see elm_photocam_image_region_bring_in()
22259 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22261 * @brief Set the viewed portion of the image
22263 * @param obj The photocam object
22264 * @param x X-coordinate of region in image original pixels
22265 * @param y Y-coordinate of region in image original pixels
22266 * @param w Width of region in image original pixels
22267 * @param h Height of region in image original pixels
22269 * This shows the region of the image without using animation.
22271 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22273 * @brief Bring in the viewed portion of the image
22275 * @param obj The photocam object
22276 * @param x X-coordinate of region in image original pixels
22277 * @param y Y-coordinate of region in image original pixels
22278 * @param w Width of region in image original pixels
22279 * @param h Height of region in image original pixels
22281 * This shows the region of the image using animation.
22283 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22285 * @brief Set the paused state for photocam
22287 * @param obj The photocam object
22288 * @param paused The pause state to set
22290 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22291 * photocam. The default is off. This will stop zooming using animation on
22292 * zoom levels changes and change instantly. This will stop any existing
22293 * animations that are running.
22295 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22297 * @brief Get the paused state for photocam
22299 * @param obj The photocam object
22300 * @return The current paused state
22302 * This gets the current paused state for the photocam object.
22304 * @see elm_photocam_paused_set()
22306 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22308 * @brief Get the internal low-res image used for photocam
22310 * @param obj The photocam object
22311 * @return The internal image object handle, or NULL if none exists
22313 * This gets the internal image object inside photocam. Do not modify it. It
22314 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22315 * deleted at any time as well.
22317 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22319 * @brief Set the photocam scrolling bouncing.
22321 * @param obj The photocam object
22322 * @param h_bounce bouncing for horizontal
22323 * @param v_bounce bouncing for vertical
22325 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22327 * @brief Get the photocam scrolling bouncing.
22329 * @param obj The photocam object
22330 * @param h_bounce bouncing for horizontal
22331 * @param v_bounce bouncing for vertical
22333 * @see elm_photocam_bounce_set()
22335 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22341 * @defgroup Map Map
22342 * @ingroup Elementary
22344 * @image html img/widget/map/preview-00.png
22345 * @image latex img/widget/map/preview-00.eps
22347 * This is a widget specifically for displaying a map. It uses basically
22348 * OpenStreetMap provider http://www.openstreetmap.org/,
22349 * but custom providers can be added.
22351 * It supports some basic but yet nice features:
22352 * @li zoom and scroll
22353 * @li markers with content to be displayed when user clicks over it
22354 * @li group of markers
22357 * Smart callbacks one can listen to:
22359 * - "clicked" - This is called when a user has clicked the map without
22361 * - "press" - This is called when a user has pressed down on the map.
22362 * - "longpressed" - This is called when a user has pressed down on the map
22363 * for a long time without dragging around.
22364 * - "clicked,double" - This is called when a user has double-clicked
22366 * - "load,detail" - Map detailed data load begins.
22367 * - "loaded,detail" - This is called when all currently visible parts of
22368 * the map are loaded.
22369 * - "zoom,start" - Zoom animation started.
22370 * - "zoom,stop" - Zoom animation stopped.
22371 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22372 * - "scroll" - the content has been scrolled (moved).
22373 * - "scroll,anim,start" - scrolling animation has started.
22374 * - "scroll,anim,stop" - scrolling animation has stopped.
22375 * - "scroll,drag,start" - dragging the contents around has started.
22376 * - "scroll,drag,stop" - dragging the contents around has stopped.
22377 * - "downloaded" - This is called when all currently required map images
22379 * - "route,load" - This is called when route request begins.
22380 * - "route,loaded" - This is called when route request ends.
22381 * - "name,load" - This is called when name request begins.
22382 * - "name,loaded- This is called when name request ends.
22384 * Available style for map widget:
22387 * Available style for markers:
22392 * Available style for marker bubble:
22395 * List of examples:
22396 * @li @ref map_example_01
22397 * @li @ref map_example_02
22398 * @li @ref map_example_03
22407 * @enum _Elm_Map_Zoom_Mode
22408 * @typedef Elm_Map_Zoom_Mode
22410 * Set map's zoom behavior. It can be set to manual or automatic.
22412 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22414 * Values <b> don't </b> work as bitmask, only one can be choosen.
22416 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22417 * than the scroller view.
22419 * @see elm_map_zoom_mode_set()
22420 * @see elm_map_zoom_mode_get()
22424 typedef enum _Elm_Map_Zoom_Mode
22426 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22427 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22428 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22429 ELM_MAP_ZOOM_MODE_LAST
22430 } Elm_Map_Zoom_Mode;
22433 * @enum _Elm_Map_Route_Sources
22434 * @typedef Elm_Map_Route_Sources
22436 * Set route service to be used. By default used source is
22437 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22439 * @see elm_map_route_source_set()
22440 * @see elm_map_route_source_get()
22444 typedef enum _Elm_Map_Route_Sources
22446 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22447 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. */
22448 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22449 ELM_MAP_ROUTE_SOURCE_LAST
22450 } Elm_Map_Route_Sources;
22452 typedef enum _Elm_Map_Name_Sources
22454 ELM_MAP_NAME_SOURCE_NOMINATIM,
22455 ELM_MAP_NAME_SOURCE_LAST
22456 } Elm_Map_Name_Sources;
22459 * @enum _Elm_Map_Route_Type
22460 * @typedef Elm_Map_Route_Type
22462 * Set type of transport used on route.
22464 * @see elm_map_route_add()
22468 typedef enum _Elm_Map_Route_Type
22470 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22471 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22472 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22473 ELM_MAP_ROUTE_TYPE_LAST
22474 } Elm_Map_Route_Type;
22477 * @enum _Elm_Map_Route_Method
22478 * @typedef Elm_Map_Route_Method
22480 * Set the routing method, what should be priorized, time or distance.
22482 * @see elm_map_route_add()
22486 typedef enum _Elm_Map_Route_Method
22488 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22489 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22490 ELM_MAP_ROUTE_METHOD_LAST
22491 } Elm_Map_Route_Method;
22493 typedef enum _Elm_Map_Name_Method
22495 ELM_MAP_NAME_METHOD_SEARCH,
22496 ELM_MAP_NAME_METHOD_REVERSE,
22497 ELM_MAP_NAME_METHOD_LAST
22498 } Elm_Map_Name_Method;
22500 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(). */
22501 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(). */
22502 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(). */
22503 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(). */
22504 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22505 typedef struct _Elm_Map_Track Elm_Map_Track;
22507 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. */
22508 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22509 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22510 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22512 typedef char *(*ElmMapModuleSourceFunc) (void);
22513 typedef int (*ElmMapModuleZoomMinFunc) (void);
22514 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22515 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22516 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22517 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22518 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22519 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22520 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22523 * Add a new map widget to the given parent Elementary (container) object.
22525 * @param parent The parent object.
22526 * @return a new map widget handle or @c NULL, on errors.
22528 * This function inserts a new map widget on the canvas.
22532 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22535 * Set the zoom level of the map.
22537 * @param obj The map object.
22538 * @param zoom The zoom level to set.
22540 * This sets the zoom level.
22542 * It will respect limits defined by elm_map_source_zoom_min_set() and
22543 * elm_map_source_zoom_max_set().
22545 * By default these values are 0 (world map) and 18 (maximum zoom).
22547 * This function should be used when zoom mode is set to
22548 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22549 * with elm_map_zoom_mode_set().
22551 * @see elm_map_zoom_mode_set().
22552 * @see elm_map_zoom_get().
22556 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22559 * Get the zoom level of the map.
22561 * @param obj The map object.
22562 * @return The current zoom level.
22564 * This returns the current zoom level of the map object.
22566 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22567 * (which is the default), the zoom level may be changed at any time by the
22568 * map object itself to account for map size and map viewport size.
22570 * @see elm_map_zoom_set() for details.
22574 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22577 * Set the zoom mode used by the map object.
22579 * @param obj The map object.
22580 * @param mode The zoom mode of the map, being it one of
22581 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22582 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22584 * This sets the zoom mode to manual or one of the automatic levels.
22585 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22586 * elm_map_zoom_set() and will stay at that level until changed by code
22587 * or until zoom mode is changed. This is the default mode.
22589 * The Automatic modes will allow the map object to automatically
22590 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22591 * adjust zoom so the map fits inside the scroll frame with no pixels
22592 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22593 * ensure no pixels within the frame are left unfilled. Do not forget that
22594 * the valid sizes are 2^zoom, consequently the map may be smaller than
22595 * the scroller view.
22597 * @see elm_map_zoom_set()
22601 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22604 * Get the zoom mode used by the map object.
22606 * @param obj The map object.
22607 * @return The zoom mode of the map, being it one of
22608 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22609 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22611 * This function returns the current zoom mode used by the map object.
22613 * @see elm_map_zoom_mode_set() for more details.
22617 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22620 * Get the current coordinates of the map.
22622 * @param obj The map object.
22623 * @param lon Pointer where to store longitude.
22624 * @param lat Pointer where to store latitude.
22626 * This gets the current center coordinates of the map object. It can be
22627 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22629 * @see elm_map_geo_region_bring_in()
22630 * @see elm_map_geo_region_show()
22634 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22637 * Animatedly bring in given coordinates to the center of the map.
22639 * @param obj The map object.
22640 * @param lon Longitude to center at.
22641 * @param lat Latitude to center at.
22643 * This causes map to jump to the given @p lat and @p lon coordinates
22644 * and show it (by scrolling) in the center of the viewport, if it is not
22645 * already centered. This will use animation to do so and take a period
22646 * of time to complete.
22648 * @see elm_map_geo_region_show() for a function to avoid animation.
22649 * @see elm_map_geo_region_get()
22653 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22656 * Show the given coordinates at the center of the map, @b immediately.
22658 * @param obj The map object.
22659 * @param lon Longitude to center at.
22660 * @param lat Latitude to center at.
22662 * This causes map to @b redraw its viewport's contents to the
22663 * region contining the given @p lat and @p lon, that will be moved to the
22664 * center of the map.
22666 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22667 * @see elm_map_geo_region_get()
22671 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22674 * Pause or unpause the map.
22676 * @param obj The map object.
22677 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22680 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22683 * The default is off.
22685 * This will stop zooming using animation, changing zoom levels will
22686 * change instantly. This will stop any existing animations that are running.
22688 * @see elm_map_paused_get()
22692 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22695 * Get a value whether map is paused or not.
22697 * @param obj The map object.
22698 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22699 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22701 * This gets the current paused state for the map object.
22703 * @see elm_map_paused_set() for details.
22707 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22710 * Set to show markers during zoom level changes or not.
22712 * @param obj The map object.
22713 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22716 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22719 * The default is off.
22721 * This will stop zooming using animation, changing zoom levels will
22722 * change instantly. This will stop any existing animations that are running.
22724 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22727 * The default is off.
22729 * Enabling it will force the map to stop displaying the markers during
22730 * zoom level changes. Set to on if you have a large number of markers.
22732 * @see elm_map_paused_markers_get()
22736 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22739 * Get a value whether markers will be displayed on zoom level changes or not
22741 * @param obj The map object.
22742 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22743 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22745 * This gets the current markers paused state for the map object.
22747 * @see elm_map_paused_markers_set() for details.
22751 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22754 * Get the information of downloading status.
22756 * @param obj The map object.
22757 * @param try_num Pointer where to store number of tiles being downloaded.
22758 * @param finish_num Pointer where to store number of tiles successfully
22761 * This gets the current downloading status for the map object, the number
22762 * of tiles being downloaded and the number of tiles already downloaded.
22766 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22769 * Convert a pixel coordinate (x,y) into a geographic coordinate
22770 * (longitude, latitude).
22772 * @param obj The map object.
22773 * @param x the coordinate.
22774 * @param y the coordinate.
22775 * @param size the size in pixels of the map.
22776 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22777 * @param lon Pointer where to store the longitude that correspond to x.
22778 * @param lat Pointer where to store the latitude that correspond to y.
22780 * @note Origin pixel point is the top left corner of the viewport.
22781 * Map zoom and size are taken on account.
22783 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22787 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);
22790 * Convert a geographic coordinate (longitude, latitude) into a pixel
22791 * coordinate (x, y).
22793 * @param obj The map object.
22794 * @param lon the longitude.
22795 * @param lat the latitude.
22796 * @param size the size in pixels of the map. The map is a square
22797 * and generally his size is : pow(2.0, zoom)*256.
22798 * @param x Pointer where to store the horizontal pixel coordinate that
22799 * correspond to the longitude.
22800 * @param y Pointer where to store the vertical pixel coordinate that
22801 * correspond to the latitude.
22803 * @note Origin pixel point is the top left corner of the viewport.
22804 * Map zoom and size are taken on account.
22806 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22810 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);
22813 * Convert a geographic coordinate (longitude, latitude) into a name
22816 * @param obj The map object.
22817 * @param lon the longitude.
22818 * @param lat the latitude.
22819 * @return name A #Elm_Map_Name handle for this coordinate.
22821 * To get the string for this address, elm_map_name_address_get()
22824 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22828 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22831 * Convert a name (address) into a geographic coordinate
22832 * (longitude, latitude).
22834 * @param obj The map object.
22835 * @param name The address.
22836 * @return name A #Elm_Map_Name handle for this address.
22838 * To get the longitude and latitude, elm_map_name_region_get()
22841 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22845 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22848 * Convert a pixel coordinate into a rotated pixel coordinate.
22850 * @param obj The map object.
22851 * @param x horizontal coordinate of the point to rotate.
22852 * @param y vertical coordinate of the point to rotate.
22853 * @param cx rotation's center horizontal position.
22854 * @param cy rotation's center vertical position.
22855 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22856 * @param xx Pointer where to store rotated x.
22857 * @param yy Pointer where to store rotated y.
22861 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);
22864 * Add a new marker to the map object.
22866 * @param obj The map object.
22867 * @param lon The longitude of the marker.
22868 * @param lat The latitude of the marker.
22869 * @param clas The class, to use when marker @b isn't grouped to others.
22870 * @param clas_group The class group, to use when marker is grouped to others
22871 * @param data The data passed to the callbacks.
22873 * @return The created marker or @c NULL upon failure.
22875 * A marker will be created and shown in a specific point of the map, defined
22876 * by @p lon and @p lat.
22878 * It will be displayed using style defined by @p class when this marker
22879 * is displayed alone (not grouped). A new class can be created with
22880 * elm_map_marker_class_new().
22882 * If the marker is grouped to other markers, it will be displayed with
22883 * style defined by @p class_group. Markers with the same group are grouped
22884 * if they are close. A new group class can be created with
22885 * elm_map_marker_group_class_new().
22887 * Markers created with this method can be deleted with
22888 * elm_map_marker_remove().
22890 * A marker can have associated content to be displayed by a bubble,
22891 * when a user click over it, as well as an icon. These objects will
22892 * be fetch using class' callback functions.
22894 * @see elm_map_marker_class_new()
22895 * @see elm_map_marker_group_class_new()
22896 * @see elm_map_marker_remove()
22900 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);
22903 * Set the maximum numbers of markers' content to be displayed in a group.
22905 * @param obj The map object.
22906 * @param max The maximum numbers of items displayed in a bubble.
22908 * A bubble will be displayed when the user clicks over the group,
22909 * and will place the content of markers that belong to this group
22912 * A group can have a long list of markers, consequently the creation
22913 * of the content of the bubble can be very slow.
22915 * In order to avoid this, a maximum number of items is displayed
22918 * By default this number is 30.
22920 * Marker with the same group class are grouped if they are close.
22922 * @see elm_map_marker_add()
22926 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22929 * Remove a marker from the map.
22931 * @param marker The marker to remove.
22933 * @see elm_map_marker_add()
22937 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22940 * Get the current coordinates of the marker.
22942 * @param marker marker.
22943 * @param lat Pointer where to store the marker's latitude.
22944 * @param lon Pointer where to store the marker's longitude.
22946 * These values are set when adding markers, with function
22947 * elm_map_marker_add().
22949 * @see elm_map_marker_add()
22953 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22956 * Animatedly bring in given marker to the center of the map.
22958 * @param marker The marker to center at.
22960 * This causes map to jump to the given @p marker's coordinates
22961 * and show it (by scrolling) in the center of the viewport, if it is not
22962 * already centered. This will use animation to do so and take a period
22963 * of time to complete.
22965 * @see elm_map_marker_show() for a function to avoid animation.
22966 * @see elm_map_marker_region_get()
22970 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22973 * Show the given marker at the center of the map, @b immediately.
22975 * @param marker The marker to center at.
22977 * This causes map to @b redraw its viewport's contents to the
22978 * region contining the given @p marker's coordinates, that will be
22979 * moved to the center of the map.
22981 * @see elm_map_marker_bring_in() for a function to move with animation.
22982 * @see elm_map_markers_list_show() if more than one marker need to be
22984 * @see elm_map_marker_region_get()
22988 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22991 * Move and zoom the map to display a list of markers.
22993 * @param markers A list of #Elm_Map_Marker handles.
22995 * The map will be centered on the center point of the markers in the list.
22996 * Then the map will be zoomed in order to fit the markers using the maximum
22997 * zoom which allows display of all the markers.
22999 * @warning All the markers should belong to the same map object.
23001 * @see elm_map_marker_show() to show a single marker.
23002 * @see elm_map_marker_bring_in()
23006 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23009 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23011 * @param marker The marker wich content should be returned.
23012 * @return Return the evas object if it exists, else @c NULL.
23014 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23015 * elm_map_marker_class_get_cb_set() should be used.
23017 * This content is what will be inside the bubble that will be displayed
23018 * when an user clicks over the marker.
23020 * This returns the actual Evas object used to be placed inside
23021 * the bubble. This may be @c NULL, as it may
23022 * not have been created or may have been deleted, at any time, by
23023 * the map. <b>Do not modify this object</b> (move, resize,
23024 * show, hide, etc.), as the map is controlling it. This
23025 * function is for querying, emitting custom signals or hooking
23026 * lower level callbacks for events on that object. Do not delete
23027 * this object under any circumstances.
23031 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23034 * Update the marker
23036 * @param marker The marker to be updated.
23038 * If a content is set to this marker, it will call function to delete it,
23039 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23040 * #ElmMapMarkerGetFunc.
23042 * These functions are set for the marker class with
23043 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23047 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23050 * Close all the bubbles opened by the user.
23052 * @param obj The map object.
23054 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23055 * when the user clicks on a marker.
23057 * This functions is set for the marker class with
23058 * elm_map_marker_class_get_cb_set().
23062 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23065 * Create a new group class.
23067 * @param obj The map object.
23068 * @return Returns the new group class.
23070 * Each marker must be associated to a group class. Markers in the same
23071 * group are grouped if they are close.
23073 * The group class defines the style of the marker when a marker is grouped
23074 * to others markers. When it is alone, another class will be used.
23076 * A group class will need to be provided when creating a marker with
23077 * elm_map_marker_add().
23079 * Some properties and functions can be set by class, as:
23080 * - style, with elm_map_group_class_style_set()
23081 * - data - to be associated to the group class. It can be set using
23082 * elm_map_group_class_data_set().
23083 * - min zoom to display markers, set with
23084 * elm_map_group_class_zoom_displayed_set().
23085 * - max zoom to group markers, set using
23086 * elm_map_group_class_zoom_grouped_set().
23087 * - visibility - set if markers will be visible or not, set with
23088 * elm_map_group_class_hide_set().
23089 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23090 * It can be set using elm_map_group_class_icon_cb_set().
23092 * @see elm_map_marker_add()
23093 * @see elm_map_group_class_style_set()
23094 * @see elm_map_group_class_data_set()
23095 * @see elm_map_group_class_zoom_displayed_set()
23096 * @see elm_map_group_class_zoom_grouped_set()
23097 * @see elm_map_group_class_hide_set()
23098 * @see elm_map_group_class_icon_cb_set()
23102 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23105 * Set the marker's style of a group class.
23107 * @param clas The group class.
23108 * @param style The style to be used by markers.
23110 * Each marker must be associated to a group class, and will use the style
23111 * defined by such class when grouped to other markers.
23113 * The following styles are provided by default theme:
23114 * @li @c radio - blue circle
23115 * @li @c radio2 - green circle
23118 * @see elm_map_group_class_new() for more details.
23119 * @see elm_map_marker_add()
23123 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23126 * Set the icon callback function of a group class.
23128 * @param clas The group class.
23129 * @param icon_get The callback function that will return the icon.
23131 * Each marker must be associated to a group class, and it can display a
23132 * custom icon. The function @p icon_get must return this icon.
23134 * @see elm_map_group_class_new() for more details.
23135 * @see elm_map_marker_add()
23139 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23142 * Set the data associated to the group class.
23144 * @param clas The group class.
23145 * @param data The new user data.
23147 * This data will be passed for callback functions, like icon get callback,
23148 * that can be set with elm_map_group_class_icon_cb_set().
23150 * If a data was previously set, the object will lose the pointer for it,
23151 * so if needs to be freed, you must do it yourself.
23153 * @see elm_map_group_class_new() for more details.
23154 * @see elm_map_group_class_icon_cb_set()
23155 * @see elm_map_marker_add()
23159 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23162 * Set the minimum zoom from where the markers are displayed.
23164 * @param clas The group class.
23165 * @param zoom The minimum zoom.
23167 * Markers only will be displayed when the map is displayed at @p zoom
23170 * @see elm_map_group_class_new() for more details.
23171 * @see elm_map_marker_add()
23175 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23178 * Set the zoom from where the markers are no more grouped.
23180 * @param clas The group class.
23181 * @param zoom The maximum zoom.
23183 * Markers only will be grouped when the map is displayed at
23184 * less than @p zoom.
23186 * @see elm_map_group_class_new() for more details.
23187 * @see elm_map_marker_add()
23191 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23194 * Set if the markers associated to the group class @clas are hidden or not.
23196 * @param clas The group class.
23197 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23200 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23205 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23208 * Create a new marker class.
23210 * @param obj The map object.
23211 * @return Returns the new group class.
23213 * Each marker must be associated to a class.
23215 * The marker class defines the style of the marker when a marker is
23216 * displayed alone, i.e., not grouped to to others markers. When grouped
23217 * it will use group class style.
23219 * A marker class will need to be provided when creating a marker with
23220 * elm_map_marker_add().
23222 * Some properties and functions can be set by class, as:
23223 * - style, with elm_map_marker_class_style_set()
23224 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23225 * It can be set using elm_map_marker_class_icon_cb_set().
23226 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23227 * Set using elm_map_marker_class_get_cb_set().
23228 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23229 * Set using elm_map_marker_class_del_cb_set().
23231 * @see elm_map_marker_add()
23232 * @see elm_map_marker_class_style_set()
23233 * @see elm_map_marker_class_icon_cb_set()
23234 * @see elm_map_marker_class_get_cb_set()
23235 * @see elm_map_marker_class_del_cb_set()
23239 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23242 * Set the marker's style of a marker class.
23244 * @param clas The marker class.
23245 * @param style The style to be used by markers.
23247 * Each marker must be associated to a marker class, and will use the style
23248 * defined by such class when alone, i.e., @b not grouped to other markers.
23250 * The following styles are provided by default theme:
23255 * @see elm_map_marker_class_new() for more details.
23256 * @see elm_map_marker_add()
23260 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23263 * Set the icon callback function of a marker class.
23265 * @param clas The marker class.
23266 * @param icon_get The callback function that will return the icon.
23268 * Each marker must be associated to a marker class, and it can display a
23269 * custom icon. The function @p icon_get must return this icon.
23271 * @see elm_map_marker_class_new() for more details.
23272 * @see elm_map_marker_add()
23276 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23279 * Set the bubble content callback function of a marker class.
23281 * @param clas The marker class.
23282 * @param get The callback function that will return the content.
23284 * Each marker must be associated to a marker class, and it can display a
23285 * a content on a bubble that opens when the user click over the marker.
23286 * The function @p get must return this content object.
23288 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23291 * @see elm_map_marker_class_new() for more details.
23292 * @see elm_map_marker_class_del_cb_set()
23293 * @see elm_map_marker_add()
23297 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23300 * Set the callback function used to delete bubble content of a marker class.
23302 * @param clas The marker class.
23303 * @param del The callback function that will delete the content.
23305 * Each marker must be associated to a marker class, and it can display a
23306 * a content on a bubble that opens when the user click over the marker.
23307 * The function to return such content can be set with
23308 * elm_map_marker_class_get_cb_set().
23310 * If this content must be freed, a callback function need to be
23311 * set for that task with this function.
23313 * If this callback is defined it will have to delete (or not) the
23314 * object inside, but if the callback is not defined the object will be
23315 * destroyed with evas_object_del().
23317 * @see elm_map_marker_class_new() for more details.
23318 * @see elm_map_marker_class_get_cb_set()
23319 * @see elm_map_marker_add()
23323 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23326 * Get the list of available sources.
23328 * @param obj The map object.
23329 * @return The source names list.
23331 * It will provide a list with all available sources, that can be set as
23332 * current source with elm_map_source_name_set(), or get with
23333 * elm_map_source_name_get().
23335 * Available sources:
23341 * @see elm_map_source_name_set() for more details.
23342 * @see elm_map_source_name_get()
23346 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23349 * Set the source of the map.
23351 * @param obj The map object.
23352 * @param source The source to be used.
23354 * Map widget retrieves images that composes the map from a web service.
23355 * This web service can be set with this method.
23357 * A different service can return a different maps with different
23358 * information and it can use different zoom values.
23360 * The @p source_name need to match one of the names provided by
23361 * elm_map_source_names_get().
23363 * The current source can be get using elm_map_source_name_get().
23365 * @see elm_map_source_names_get()
23366 * @see elm_map_source_name_get()
23371 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23374 * Get the name of currently used source.
23376 * @param obj The map object.
23377 * @return Returns the name of the source in use.
23379 * @see elm_map_source_name_set() for more details.
23383 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23386 * Set the source of the route service to be used by the map.
23388 * @param obj The map object.
23389 * @param source The route service to be used, being it one of
23390 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23391 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23393 * Each one has its own algorithm, so the route retrieved may
23394 * differ depending on the source route. Now, only the default is working.
23396 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23397 * http://www.yournavigation.org/.
23399 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23400 * assumptions. Its routing core is based on Contraction Hierarchies.
23402 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23404 * @see elm_map_route_source_get().
23408 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23411 * Get the current route source.
23413 * @param obj The map object.
23414 * @return The source of the route service used by the map.
23416 * @see elm_map_route_source_set() for details.
23420 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23423 * Set the minimum zoom of the source.
23425 * @param obj The map object.
23426 * @param zoom New minimum zoom value to be used.
23428 * By default, it's 0.
23432 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23435 * Get the minimum zoom of the source.
23437 * @param obj The map object.
23438 * @return Returns the minimum zoom of the source.
23440 * @see elm_map_source_zoom_min_set() for details.
23444 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23447 * Set the maximum zoom of the source.
23449 * @param obj The map object.
23450 * @param zoom New maximum zoom value to be used.
23452 * By default, it's 18.
23456 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23459 * Get the maximum zoom of the source.
23461 * @param obj The map object.
23462 * @return Returns the maximum zoom of the source.
23464 * @see elm_map_source_zoom_min_set() for details.
23468 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23471 * Set the user agent used by the map object to access routing services.
23473 * @param obj The map object.
23474 * @param user_agent The user agent to be used by the map.
23476 * User agent is a client application implementing a network protocol used
23477 * in communications within a clientāserver distributed computing system
23479 * The @p user_agent identification string will transmitted in a header
23480 * field @c User-Agent.
23482 * @see elm_map_user_agent_get()
23486 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23489 * Get the user agent used by the map object.
23491 * @param obj The map object.
23492 * @return The user agent identification string used by the map.
23494 * @see elm_map_user_agent_set() for details.
23498 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23501 * Add a new route to the map object.
23503 * @param obj The map object.
23504 * @param type The type of transport to be considered when tracing a route.
23505 * @param method The routing method, what should be priorized.
23506 * @param flon The start longitude.
23507 * @param flat The start latitude.
23508 * @param tlon The destination longitude.
23509 * @param tlat The destination latitude.
23511 * @return The created route or @c NULL upon failure.
23513 * A route will be traced by point on coordinates (@p flat, @p flon)
23514 * to point on coordinates (@p tlat, @p tlon), using the route service
23515 * set with elm_map_route_source_set().
23517 * It will take @p type on consideration to define the route,
23518 * depending if the user will be walking or driving, the route may vary.
23519 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23520 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23522 * Another parameter is what the route should priorize, the minor distance
23523 * or the less time to be spend on the route. So @p method should be one
23524 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23526 * Routes created with this method can be deleted with
23527 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23528 * and distance can be get with elm_map_route_distance_get().
23530 * @see elm_map_route_remove()
23531 * @see elm_map_route_color_set()
23532 * @see elm_map_route_distance_get()
23533 * @see elm_map_route_source_set()
23537 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);
23540 * Remove a route from the map.
23542 * @param route The route to remove.
23544 * @see elm_map_route_add()
23548 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23551 * Set the route color.
23553 * @param route The route object.
23554 * @param r Red channel value, from 0 to 255.
23555 * @param g Green channel value, from 0 to 255.
23556 * @param b Blue channel value, from 0 to 255.
23557 * @param a Alpha channel value, from 0 to 255.
23559 * It uses an additive color model, so each color channel represents
23560 * how much of each primary colors must to be used. 0 represents
23561 * ausence of this color, so if all of the three are set to 0,
23562 * the color will be black.
23564 * These component values should be integers in the range 0 to 255,
23565 * (single 8-bit byte).
23567 * This sets the color used for the route. By default, it is set to
23568 * solid red (r = 255, g = 0, b = 0, a = 255).
23570 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23572 * @see elm_map_route_color_get()
23576 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23579 * Get the route color.
23581 * @param route The route object.
23582 * @param r Pointer where to store the red channel value.
23583 * @param g Pointer where to store the green channel value.
23584 * @param b Pointer where to store the blue channel value.
23585 * @param a Pointer where to store the alpha channel value.
23587 * @see elm_map_route_color_set() for details.
23591 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23594 * Get the route distance in kilometers.
23596 * @param route The route object.
23597 * @return The distance of route (unit : km).
23601 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23604 * Get the information of route nodes.
23606 * @param route The route object.
23607 * @return Returns a string with the nodes of route.
23611 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23614 * Get the information of route waypoint.
23616 * @param route the route object.
23617 * @return Returns a string with information about waypoint of route.
23621 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23624 * Get the address of the name.
23626 * @param name The name handle.
23627 * @return Returns the address string of @p name.
23629 * This gets the coordinates of the @p name, created with one of the
23630 * conversion functions.
23632 * @see elm_map_utils_convert_name_into_coord()
23633 * @see elm_map_utils_convert_coord_into_name()
23637 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23640 * Get the current coordinates of the name.
23642 * @param name The name handle.
23643 * @param lat Pointer where to store the latitude.
23644 * @param lon Pointer where to store The longitude.
23646 * This gets the coordinates of the @p name, created with one of the
23647 * conversion functions.
23649 * @see elm_map_utils_convert_name_into_coord()
23650 * @see elm_map_utils_convert_coord_into_name()
23654 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23657 * Remove a name from the map.
23659 * @param name The name to remove.
23661 * Basically the struct handled by @p name will be freed, so convertions
23662 * between address and coordinates will be lost.
23664 * @see elm_map_utils_convert_name_into_coord()
23665 * @see elm_map_utils_convert_coord_into_name()
23669 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23674 * @param obj The map object.
23675 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23676 * @param cx Rotation's center horizontal position.
23677 * @param cy Rotation's center vertical position.
23679 * @see elm_map_rotate_get()
23683 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23686 * Get the rotate degree of the map
23688 * @param obj The map object
23689 * @param degree Pointer where to store degrees from 0.0 to 360.0
23690 * to rotate arount Z axis.
23691 * @param cx Pointer where to store rotation's center horizontal position.
23692 * @param cy Pointer where to store rotation's center vertical position.
23694 * @see elm_map_rotate_set() to set map rotation.
23698 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);
23701 * Enable or disable mouse wheel to be used to zoom in / out the map.
23703 * @param obj The map object.
23704 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23707 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23709 * It's disabled by default.
23711 * @see elm_map_wheel_disabled_get()
23715 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23718 * Get a value whether mouse wheel is enabled or not.
23720 * @param obj The map object.
23721 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23722 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23724 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23726 * @see elm_map_wheel_disabled_set() for details.
23730 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23734 * Add a track on the map
23736 * @param obj The map object.
23737 * @param emap The emap route object.
23738 * @return The route object. This is an elm object of type Route.
23740 * @see elm_route_add() for details.
23744 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23748 * Remove a track from the map
23750 * @param obj The map object.
23751 * @param route The track to remove.
23755 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23762 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23764 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23766 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23767 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23768 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23769 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23773 * @defgroup Panel Panel
23775 * @image html img/widget/panel/preview-00.png
23776 * @image latex img/widget/panel/preview-00.eps
23778 * @brief A panel is a type of animated container that contains subobjects.
23779 * It can be expanded or contracted by clicking the button on it's edge.
23781 * Orientations are as follows:
23782 * @li ELM_PANEL_ORIENT_TOP
23783 * @li ELM_PANEL_ORIENT_LEFT
23784 * @li ELM_PANEL_ORIENT_RIGHT
23786 * Default contents parts of the panel widget that you can use for are:
23787 * @li "default" - A content of the panel
23789 * @ref tutorial_panel shows one way to use this widget.
23792 typedef enum _Elm_Panel_Orient
23794 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23795 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23796 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23797 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23798 } Elm_Panel_Orient;
23800 * @brief Adds a panel object
23802 * @param parent The parent object
23804 * @return The panel object, or NULL on failure
23806 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23808 * @brief Sets the orientation of the panel
23810 * @param parent The parent object
23811 * @param orient The panel orientation. Can be one of the following:
23812 * @li ELM_PANEL_ORIENT_TOP
23813 * @li ELM_PANEL_ORIENT_LEFT
23814 * @li ELM_PANEL_ORIENT_RIGHT
23816 * Sets from where the panel will (dis)appear.
23818 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23820 * @brief Get the orientation of the panel.
23822 * @param obj The panel object
23823 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23825 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23827 * @brief Set the content of the panel.
23829 * @param obj The panel object
23830 * @param content The panel content
23832 * Once the content object is set, a previously set one will be deleted.
23833 * If you want to keep that old content object, use the
23834 * elm_panel_content_unset() function.
23836 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23838 * @brief Get the content of the panel.
23840 * @param obj The panel object
23841 * @return The content that is being used
23843 * Return the content object which is set for this widget.
23845 * @see elm_panel_content_set()
23847 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23849 * @brief Unset the content of the panel.
23851 * @param obj The panel object
23852 * @return The content that was being used
23854 * Unparent and return the content object which was set for this widget.
23856 * @see elm_panel_content_set()
23858 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23860 * @brief Set the state of the panel.
23862 * @param obj The panel object
23863 * @param hidden If true, the panel will run the animation to contract
23865 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23867 * @brief Get the state of the panel.
23869 * @param obj The panel object
23870 * @param hidden If true, the panel is in the "hide" state
23872 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23874 * @brief Toggle the hidden state of the panel from code
23876 * @param obj The panel object
23878 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23884 * @defgroup Panes Panes
23885 * @ingroup Elementary
23887 * @image html img/widget/panes/preview-00.png
23888 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23890 * @image html img/panes.png
23891 * @image latex img/panes.eps width=\textwidth
23893 * The panes adds a dragable bar between two contents. When dragged
23894 * this bar will resize contents size.
23896 * Panes can be displayed vertically or horizontally, and contents
23897 * size proportion can be customized (homogeneous by default).
23899 * Smart callbacks one can listen to:
23900 * - "press" - The panes has been pressed (button wasn't released yet).
23901 * - "unpressed" - The panes was released after being pressed.
23902 * - "clicked" - The panes has been clicked>
23903 * - "clicked,double" - The panes has been double clicked
23905 * Available styles for it:
23908 * Default contents parts of the panes widget that you can use for are:
23909 * @li "left" - A leftside content of the panes
23910 * @li "right" - A rightside content of the panes
23912 * If panes is displayed vertically, left content will be displayed at
23915 * Here is an example on its usage:
23916 * @li @ref panes_example
23920 * @addtogroup Panes
23925 * Add a new panes widget to the given parent Elementary
23926 * (container) object.
23928 * @param parent The parent object.
23929 * @return a new panes widget handle or @c NULL, on errors.
23931 * This function inserts a new panes widget on the canvas.
23935 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23938 * Set the left content of the panes widget.
23940 * @param obj The panes object.
23941 * @param content The new left content object.
23943 * Once the content object is set, a previously set one will be deleted.
23944 * If you want to keep that old content object, use the
23945 * elm_panes_content_left_unset() function.
23947 * If panes is displayed vertically, left content will be displayed at
23950 * @see elm_panes_content_left_get()
23951 * @see elm_panes_content_right_set() to set content on the other side.
23955 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23958 * Set the right content of the panes widget.
23960 * @param obj The panes object.
23961 * @param content The new right content object.
23963 * Once the content object is set, a previously set one will be deleted.
23964 * If you want to keep that old content object, use the
23965 * elm_panes_content_right_unset() function.
23967 * If panes is displayed vertically, left content will be displayed at
23970 * @see elm_panes_content_right_get()
23971 * @see elm_panes_content_left_set() to set content on the other side.
23975 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23978 * Get the left content of the panes.
23980 * @param obj The panes object.
23981 * @return The left content object that is being used.
23983 * Return the left content object which is set for this widget.
23985 * @see elm_panes_content_left_set() for details.
23989 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23992 * Get the right content of the panes.
23994 * @param obj The panes object
23995 * @return The right content object that is being used
23997 * Return the right content object which is set for this widget.
23999 * @see elm_panes_content_right_set() for details.
24003 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24006 * Unset the left content used for the panes.
24008 * @param obj The panes object.
24009 * @return The left content object that was being used.
24011 * Unparent and return the left content object which was set for this widget.
24013 * @see elm_panes_content_left_set() for details.
24014 * @see elm_panes_content_left_get().
24018 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24021 * Unset the right content used for the panes.
24023 * @param obj The panes object.
24024 * @return The right content object that was being used.
24026 * Unparent and return the right content object which was set for this
24029 * @see elm_panes_content_right_set() for details.
24030 * @see elm_panes_content_right_get().
24034 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24037 * Get the size proportion of panes widget's left side.
24039 * @param obj The panes object.
24040 * @return float value between 0.0 and 1.0 representing size proportion
24043 * @see elm_panes_content_left_size_set() for more details.
24047 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24050 * Set the size proportion of panes widget's left side.
24052 * @param obj The panes object.
24053 * @param size Value between 0.0 and 1.0 representing size proportion
24056 * By default it's homogeneous, i.e., both sides have the same size.
24058 * If something different is required, it can be set with this function.
24059 * For example, if the left content should be displayed over
24060 * 75% of the panes size, @p size should be passed as @c 0.75.
24061 * This way, right content will be resized to 25% of panes size.
24063 * If displayed vertically, left content is displayed at top, and
24064 * right content at bottom.
24066 * @note This proportion will change when user drags the panes bar.
24068 * @see elm_panes_content_left_size_get()
24072 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24075 * Set the orientation of a given panes widget.
24077 * @param obj The panes object.
24078 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24079 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24081 * Use this function to change how your panes is to be
24082 * disposed: vertically or horizontally.
24084 * By default it's displayed horizontally.
24086 * @see elm_panes_horizontal_get()
24090 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24093 * Retrieve the orientation of a given panes widget.
24095 * @param obj The panes object.
24096 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24097 * @c EINA_FALSE if it's @b vertical (and on errors).
24099 * @see elm_panes_horizontal_set() for more details.
24103 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24104 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24105 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24112 * @defgroup Flip Flip
24114 * @image html img/widget/flip/preview-00.png
24115 * @image latex img/widget/flip/preview-00.eps
24117 * This widget holds 2 content objects(Evas_Object): one on the front and one
24118 * on the back. It allows you to flip from front to back and vice-versa using
24119 * various animations.
24121 * If either the front or back contents are not set the flip will treat that
24122 * as transparent. So if you wore to set the front content but not the back,
24123 * and then call elm_flip_go() you would see whatever is below the flip.
24125 * For a list of supported animations see elm_flip_go().
24127 * Signals that you can add callbacks for are:
24128 * "animate,begin" - when a flip animation was started
24129 * "animate,done" - when a flip animation is finished
24131 * @ref tutorial_flip show how to use most of the API.
24135 typedef enum _Elm_Flip_Mode
24137 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24138 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24139 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24140 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24141 ELM_FLIP_CUBE_LEFT,
24142 ELM_FLIP_CUBE_RIGHT,
24144 ELM_FLIP_CUBE_DOWN,
24145 ELM_FLIP_PAGE_LEFT,
24146 ELM_FLIP_PAGE_RIGHT,
24150 typedef enum _Elm_Flip_Interaction
24152 ELM_FLIP_INTERACTION_NONE,
24153 ELM_FLIP_INTERACTION_ROTATE,
24154 ELM_FLIP_INTERACTION_CUBE,
24155 ELM_FLIP_INTERACTION_PAGE
24156 } Elm_Flip_Interaction;
24157 typedef enum _Elm_Flip_Direction
24159 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24160 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24161 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24162 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24163 } Elm_Flip_Direction;
24165 * @brief Add a new flip to the parent
24167 * @param parent The parent object
24168 * @return The new object or NULL if it cannot be created
24170 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24172 * @brief Set the front content of the flip widget.
24174 * @param obj The flip object
24175 * @param content The new front content object
24177 * Once the content object is set, a previously set one will be deleted.
24178 * If you want to keep that old content object, use the
24179 * elm_flip_content_front_unset() function.
24181 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24183 * @brief Set the back content of the flip widget.
24185 * @param obj The flip object
24186 * @param content The new back content object
24188 * Once the content object is set, a previously set one will be deleted.
24189 * If you want to keep that old content object, use the
24190 * elm_flip_content_back_unset() function.
24192 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24194 * @brief Get the front content used for the flip
24196 * @param obj The flip object
24197 * @return The front content object that is being used
24199 * Return the front content object which is set for this widget.
24201 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24203 * @brief Get the back content used for the flip
24205 * @param obj The flip object
24206 * @return The back content object that is being used
24208 * Return the back content object which is set for this widget.
24210 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24212 * @brief Unset the front content used for the flip
24214 * @param obj The flip object
24215 * @return The front content object that was being used
24217 * Unparent and return the front content object which was set for this widget.
24219 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24221 * @brief Unset the back content used for the flip
24223 * @param obj The flip object
24224 * @return The back content object that was being used
24226 * Unparent and return the back content object which was set for this widget.
24228 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24230 * @brief Get flip front visibility state
24232 * @param obj The flip objct
24233 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24236 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24238 * @brief Set flip perspective
24240 * @param obj The flip object
24241 * @param foc The coordinate to set the focus on
24242 * @param x The X coordinate
24243 * @param y The Y coordinate
24245 * @warning This function currently does nothing.
24247 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24249 * @brief Runs the flip animation
24251 * @param obj The flip object
24252 * @param mode The mode type
24254 * Flips the front and back contents using the @p mode animation. This
24255 * efectively hides the currently visible content and shows the hidden one.
24257 * There a number of possible animations to use for the flipping:
24258 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24259 * around a horizontal axis in the middle of its height, the other content
24260 * is shown as the other side of the flip.
24261 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24262 * around a vertical axis in the middle of its width, the other content is
24263 * shown as the other side of the flip.
24264 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24265 * around a diagonal axis in the middle of its width, the other content is
24266 * shown as the other side of the flip.
24267 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24268 * around a diagonal axis in the middle of its height, the other content is
24269 * shown as the other side of the flip.
24270 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24271 * as if the flip was a cube, the other content is show as the right face of
24273 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24274 * right as if the flip was a cube, the other content is show as the left
24275 * face of the cube.
24276 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24277 * flip was a cube, the other content is show as the bottom face of the cube.
24278 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24279 * the flip was a cube, the other content is show as the upper face of the
24281 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24282 * if the flip was a book, the other content is shown as the page below that.
24283 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24284 * as if the flip was a book, the other content is shown as the page below
24286 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24287 * flip was a book, the other content is shown as the page below that.
24288 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24289 * flip was a book, the other content is shown as the page below that.
24291 * @image html elm_flip.png
24292 * @image latex elm_flip.eps width=\textwidth
24294 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24296 * @brief Set the interactive flip mode
24298 * @param obj The flip object
24299 * @param mode The interactive flip mode to use
24301 * This sets if the flip should be interactive (allow user to click and
24302 * drag a side of the flip to reveal the back page and cause it to flip).
24303 * By default a flip is not interactive. You may also need to set which
24304 * sides of the flip are "active" for flipping and how much space they use
24305 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24306 * and elm_flip_interacton_direction_hitsize_set()
24308 * The four avilable mode of interaction are:
24309 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24310 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24311 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24312 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24314 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24315 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24316 * happen, those can only be acheived with elm_flip_go();
24318 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24320 * @brief Get the interactive flip mode
24322 * @param obj The flip object
24323 * @return The interactive flip mode
24325 * Returns the interactive flip mode set by elm_flip_interaction_set()
24327 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24329 * @brief Set which directions of the flip respond to interactive flip
24331 * @param obj The flip object
24332 * @param dir The direction to change
24333 * @param enabled If that direction is enabled or not
24335 * By default all directions are disabled, so you may want to enable the
24336 * desired directions for flipping if you need interactive flipping. You must
24337 * call this function once for each direction that should be enabled.
24339 * @see elm_flip_interaction_set()
24341 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24343 * @brief Get the enabled state of that flip direction
24345 * @param obj The flip object
24346 * @param dir The direction to check
24347 * @return If that direction is enabled or not
24349 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24351 * @see elm_flip_interaction_set()
24353 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24355 * @brief Set the amount of the flip that is sensitive to interactive flip
24357 * @param obj The flip object
24358 * @param dir The direction to modify
24359 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24361 * Set the amount of the flip that is sensitive to interactive flip, with 0
24362 * representing no area in the flip and 1 representing the entire flip. There
24363 * is however a consideration to be made in that the area will never be
24364 * smaller than the finger size set(as set in your Elementary configuration).
24366 * @see elm_flip_interaction_set()
24368 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24370 * @brief Get the amount of the flip that is sensitive to interactive flip
24372 * @param obj The flip object
24373 * @param dir The direction to check
24374 * @return The size set for that direction
24376 * Returns the amount os sensitive area set by
24377 * elm_flip_interacton_direction_hitsize_set().
24379 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24384 /* scrolledentry */
24385 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24386 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24387 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24388 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24389 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24390 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24391 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24392 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24393 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24394 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24395 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24396 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24397 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24398 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24399 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24400 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24401 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24402 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24403 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24404 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24405 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24406 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24407 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24408 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24409 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24410 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24411 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24412 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24413 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24414 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24415 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24416 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24417 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24418 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24419 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24420 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);
24421 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24422 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24423 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);
24424 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24425 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);
24426 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24427 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24428 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24429 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24430 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24431 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24432 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24433 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24434 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);
24435 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);
24436 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);
24437 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);
24438 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);
24439 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);
24440 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24441 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24442 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24443 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24444 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24445 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24446 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24447 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24448 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24449 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24450 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24451 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24452 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24455 * @defgroup Conformant Conformant
24456 * @ingroup Elementary
24458 * @image html img/widget/conformant/preview-00.png
24459 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24461 * @image html img/conformant.png
24462 * @image latex img/conformant.eps width=\textwidth
24464 * The aim is to provide a widget that can be used in elementary apps to
24465 * account for space taken up by the indicator, virtual keypad & softkey
24466 * windows when running the illume2 module of E17.
24468 * So conformant content will be sized and positioned considering the
24469 * space required for such stuff, and when they popup, as a keyboard
24470 * shows when an entry is selected, conformant content won't change.
24472 * Available styles for it:
24475 * Default contents parts of the conformant widget that you can use for are:
24476 * @li "default" - A content of the conformant
24478 * See how to use this widget in this example:
24479 * @ref conformant_example
24483 * @addtogroup Conformant
24488 * Add a new conformant widget to the given parent Elementary
24489 * (container) object.
24491 * @param parent The parent object.
24492 * @return A new conformant widget handle or @c NULL, on errors.
24494 * This function inserts a new conformant widget on the canvas.
24496 * @ingroup Conformant
24498 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24501 * Set the content of the conformant widget.
24503 * @param obj The conformant object.
24504 * @param content The content to be displayed by the conformant.
24506 * Content will be sized and positioned considering the space required
24507 * to display a virtual keyboard. So it won't fill all the conformant
24508 * size. This way is possible to be sure that content won't resize
24509 * or be re-positioned after the keyboard is displayed.
24511 * Once the content object is set, a previously set one will be deleted.
24512 * If you want to keep that old content object, use the
24513 * elm_object_content_unset() function.
24515 * @see elm_object_content_unset()
24516 * @see elm_object_content_get()
24518 * @ingroup Conformant
24520 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24523 * Get the content of the conformant widget.
24525 * @param obj The conformant object.
24526 * @return The content that is being used.
24528 * Return the content object which is set for this widget.
24529 * It won't be unparent from conformant. For that, use
24530 * elm_object_content_unset().
24532 * @see elm_object_content_set().
24533 * @see elm_object_content_unset()
24535 * @ingroup Conformant
24537 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24540 * Unset the content of the conformant widget.
24542 * @param obj The conformant object.
24543 * @return The content that was being used.
24545 * Unparent and return the content object which was set for this widget.
24547 * @see elm_object_content_set().
24549 * @ingroup Conformant
24551 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24554 * Returns the Evas_Object that represents the content area.
24556 * @param obj The conformant object.
24557 * @return The content area of the widget.
24559 * @ingroup Conformant
24561 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24568 * @defgroup Mapbuf Mapbuf
24569 * @ingroup Elementary
24571 * @image html img/widget/mapbuf/preview-00.png
24572 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24574 * This holds one content object and uses an Evas Map of transformation
24575 * points to be later used with this content. So the content will be
24576 * moved, resized, etc as a single image. So it will improve performance
24577 * when you have a complex interafce, with a lot of elements, and will
24578 * need to resize or move it frequently (the content object and its
24581 * Default contents parts of the mapbuf widget that you can use for are:
24582 * @li "default" - A content of the mapbuf
24584 * To enable map, elm_mapbuf_enabled_set() should be used.
24586 * See how to use this widget in this example:
24587 * @ref mapbuf_example
24591 * @addtogroup Mapbuf
24596 * Add a new mapbuf widget to the given parent Elementary
24597 * (container) object.
24599 * @param parent The parent object.
24600 * @return A new mapbuf widget handle or @c NULL, on errors.
24602 * This function inserts a new mapbuf widget on the canvas.
24606 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24609 * Set the content of the mapbuf.
24611 * @param obj The mapbuf object.
24612 * @param content The content that will be filled in this mapbuf object.
24614 * Once the content object is set, a previously set one will be deleted.
24615 * If you want to keep that old content object, use the
24616 * elm_mapbuf_content_unset() function.
24618 * To enable map, elm_mapbuf_enabled_set() should be used.
24622 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24625 * Get the content of the mapbuf.
24627 * @param obj The mapbuf object.
24628 * @return The content that is being used.
24630 * Return the content object which is set for this widget.
24632 * @see elm_mapbuf_content_set() for details.
24636 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24639 * Unset the content of the mapbuf.
24641 * @param obj The mapbuf object.
24642 * @return The content that was being used.
24644 * Unparent and return the content object which was set for this widget.
24646 * @see elm_mapbuf_content_set() for details.
24650 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24653 * Enable or disable the map.
24655 * @param obj The mapbuf object.
24656 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24658 * This enables the map that is set or disables it. On enable, the object
24659 * geometry will be saved, and the new geometry will change (position and
24660 * size) to reflect the map geometry set.
24662 * Also, when enabled, alpha and smooth states will be used, so if the
24663 * content isn't solid, alpha should be enabled, for example, otherwise
24664 * a black retangle will fill the content.
24666 * When disabled, the stored map will be freed and geometry prior to
24667 * enabling the map will be restored.
24669 * It's disabled by default.
24671 * @see elm_mapbuf_alpha_set()
24672 * @see elm_mapbuf_smooth_set()
24676 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24679 * Get a value whether map is enabled or not.
24681 * @param obj The mapbuf object.
24682 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24683 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24685 * @see elm_mapbuf_enabled_set() for details.
24689 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24692 * Enable or disable smooth map rendering.
24694 * @param obj The mapbuf object.
24695 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24698 * This sets smoothing for map rendering. If the object is a type that has
24699 * its own smoothing settings, then both the smooth settings for this object
24700 * and the map must be turned off.
24702 * By default smooth maps are enabled.
24706 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24709 * Get a value whether smooth map rendering is enabled or not.
24711 * @param obj The mapbuf object.
24712 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24713 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24715 * @see elm_mapbuf_smooth_set() for details.
24719 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24722 * Set or unset alpha flag for map rendering.
24724 * @param obj The mapbuf object.
24725 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24728 * This sets alpha flag for map rendering. If the object is a type that has
24729 * its own alpha settings, then this will take precedence. Only image objects
24730 * have this currently. It stops alpha blending of the map area, and is
24731 * useful if you know the object and/or all sub-objects is 100% solid.
24733 * Alpha is enabled by default.
24737 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24740 * Get a value whether alpha blending is enabled or not.
24742 * @param obj The mapbuf object.
24743 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24744 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24746 * @see elm_mapbuf_alpha_set() for details.
24750 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24757 * @defgroup Flipselector Flip Selector
24759 * @image html img/widget/flipselector/preview-00.png
24760 * @image latex img/widget/flipselector/preview-00.eps
24762 * A flip selector is a widget to show a set of @b text items, one
24763 * at a time, with the same sheet switching style as the @ref Clock
24764 * "clock" widget, when one changes the current displaying sheet
24765 * (thus, the "flip" in the name).
24767 * User clicks to flip sheets which are @b held for some time will
24768 * make the flip selector to flip continuosly and automatically for
24769 * the user. The interval between flips will keep growing in time,
24770 * so that it helps the user to reach an item which is distant from
24771 * the current selection.
24773 * Smart callbacks one can register to:
24774 * - @c "selected" - when the widget's selected text item is changed
24775 * - @c "overflowed" - when the widget's current selection is changed
24776 * from the first item in its list to the last
24777 * - @c "underflowed" - when the widget's current selection is changed
24778 * from the last item in its list to the first
24780 * Available styles for it:
24783 * To set/get the label of the flipselector item, you can use
24784 * elm_object_item_text_set/get APIs.
24785 * Once the text is set, a previously set one will be deleted.
24787 * Here is an example on its usage:
24788 * @li @ref flipselector_example
24792 * @addtogroup Flipselector
24796 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24799 * Add a new flip selector widget to the given parent Elementary
24800 * (container) widget
24802 * @param parent The parent object
24803 * @return a new flip selector widget handle or @c NULL, on errors
24805 * This function inserts a new flip selector widget on the canvas.
24807 * @ingroup Flipselector
24809 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24812 * Programmatically select the next item of a flip selector widget
24814 * @param obj The flipselector object
24816 * @note The selection will be animated. Also, if it reaches the
24817 * end of its list of member items, it will continue with the first
24820 * @ingroup Flipselector
24822 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24825 * Programmatically select the previous item of a flip selector
24828 * @param obj The flipselector object
24830 * @note The selection will be animated. Also, if it reaches the
24831 * beginning of its list of member items, it will continue with the
24832 * last one backwards.
24834 * @ingroup Flipselector
24836 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24839 * Append a (text) item to a flip selector widget
24841 * @param obj The flipselector object
24842 * @param label The (text) label of the new item
24843 * @param func Convenience callback function to take place when
24845 * @param data Data passed to @p func, above
24846 * @return A handle to the item added or @c NULL, on errors
24848 * The widget's list of labels to show will be appended with the
24849 * given value. If the user wishes so, a callback function pointer
24850 * can be passed, which will get called when this same item is
24853 * @note The current selection @b won't be modified by appending an
24854 * element to the list.
24856 * @note The maximum length of the text label is going to be
24857 * determined <b>by the widget's theme</b>. Strings larger than
24858 * that value are going to be @b truncated.
24860 * @ingroup Flipselector
24862 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24865 * Prepend a (text) item to a flip selector widget
24867 * @param obj The flipselector object
24868 * @param label The (text) label of the new item
24869 * @param func Convenience callback function to take place when
24871 * @param data Data passed to @p func, above
24872 * @return A handle to the item added or @c NULL, on errors
24874 * The widget's list of labels to show will be prepended with the
24875 * given value. If the user wishes so, a callback function pointer
24876 * can be passed, which will get called when this same item is
24879 * @note The current selection @b won't be modified by prepending
24880 * an element to the list.
24882 * @note The maximum length of the text label is going to be
24883 * determined <b>by the widget's theme</b>. Strings larger than
24884 * that value are going to be @b truncated.
24886 * @ingroup Flipselector
24888 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24891 * Get the internal list of items in a given flip selector widget.
24893 * @param obj The flipselector object
24894 * @return The list of items (#Elm_Flipselector_Item as data) or
24895 * @c NULL on errors.
24897 * This list is @b not to be modified in any way and must not be
24898 * freed. Use the list members with functions like
24899 * elm_flipselector_item_label_set(),
24900 * elm_flipselector_item_label_get(),
24901 * elm_flipselector_item_del(),
24902 * elm_flipselector_item_selected_get(),
24903 * elm_flipselector_item_selected_set().
24905 * @warning This list is only valid until @p obj object's internal
24906 * items list is changed. It should be fetched again with another
24907 * call to this function when changes happen.
24909 * @ingroup Flipselector
24911 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24914 * Get the first item in the given flip selector widget's list of
24917 * @param obj The flipselector object
24918 * @return The first item or @c NULL, if it has no items (and on
24921 * @see elm_flipselector_item_append()
24922 * @see elm_flipselector_last_item_get()
24924 * @ingroup Flipselector
24926 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24929 * Get the last item in the given flip selector widget's list of
24932 * @param obj The flipselector object
24933 * @return The last item or @c NULL, if it has no items (and on
24936 * @see elm_flipselector_item_prepend()
24937 * @see elm_flipselector_first_item_get()
24939 * @ingroup Flipselector
24941 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24944 * Get the currently selected item in a flip selector widget.
24946 * @param obj The flipselector object
24947 * @return The selected item or @c NULL, if the widget has no items
24950 * @ingroup Flipselector
24952 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24955 * Set whether a given flip selector widget's item should be the
24956 * currently selected one.
24958 * @param item The flip selector item
24959 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24961 * This sets whether @p item is or not the selected (thus, under
24962 * display) one. If @p item is different than one under display,
24963 * the latter will be unselected. If the @p item is set to be
24964 * unselected, on the other hand, the @b first item in the widget's
24965 * internal members list will be the new selected one.
24967 * @see elm_flipselector_item_selected_get()
24969 * @ingroup Flipselector
24971 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24974 * Get whether a given flip selector widget's item is the currently
24977 * @param item The flip selector item
24978 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24981 * @see elm_flipselector_item_selected_set()
24983 * @ingroup Flipselector
24985 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24988 * Delete a given item from a flip selector widget.
24990 * @param item The item to delete
24992 * @ingroup Flipselector
24994 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24997 * Get the label of a given flip selector widget's item.
24999 * @param item The item to get label from
25000 * @return The text label of @p item or @c NULL, on errors
25002 * @see elm_flipselector_item_label_set()
25004 * @ingroup Flipselector
25006 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25009 * Set the label of a given flip selector widget's item.
25011 * @param item The item to set label on
25012 * @param label The text label string, in UTF-8 encoding
25014 * @see elm_flipselector_item_label_get()
25016 * @ingroup Flipselector
25018 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25021 * Gets the item before @p item in a flip selector widget's
25022 * internal list of items.
25024 * @param item The item to fetch previous from
25025 * @return The item before the @p item, in its parent's list. If
25026 * there is no previous item for @p item or there's an
25027 * error, @c NULL is returned.
25029 * @see elm_flipselector_item_next_get()
25031 * @ingroup Flipselector
25033 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25036 * Gets the item after @p item in a flip selector widget's
25037 * internal list of items.
25039 * @param item The item to fetch next from
25040 * @return The item after the @p item, in its parent's list. If
25041 * there is no next item for @p item or there's an
25042 * error, @c NULL is returned.
25044 * @see elm_flipselector_item_next_get()
25046 * @ingroup Flipselector
25048 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25051 * Set the interval on time updates for an user mouse button hold
25052 * on a flip selector widget.
25054 * @param obj The flip selector object
25055 * @param interval The (first) interval value in seconds
25057 * This interval value is @b decreased while the user holds the
25058 * mouse pointer either flipping up or flipping doww a given flip
25061 * This helps the user to get to a given item distant from the
25062 * current one easier/faster, as it will start to flip quicker and
25063 * quicker on mouse button holds.
25065 * The calculation for the next flip interval value, starting from
25066 * the one set with this call, is the previous interval divided by
25067 * 1.05, so it decreases a little bit.
25069 * The default starting interval value for automatic flips is
25072 * @see elm_flipselector_interval_get()
25074 * @ingroup Flipselector
25076 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25079 * Get the interval on time updates for an user mouse button hold
25080 * on a flip selector widget.
25082 * @param obj The flip selector object
25083 * @return The (first) interval value, in seconds, set on it
25085 * @see elm_flipselector_interval_set() for more details
25087 * @ingroup Flipselector
25089 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25095 * @addtogroup Calendar
25100 * @enum _Elm_Calendar_Mark_Repeat
25101 * @typedef Elm_Calendar_Mark_Repeat
25103 * Event periodicity, used to define if a mark should be repeated
25104 * @b beyond event's day. It's set when a mark is added.
25106 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25107 * there will be marks every week after this date. Marks will be displayed
25108 * at 13th, 20th, 27th, 3rd June ...
25110 * Values don't work as bitmask, only one can be choosen.
25112 * @see elm_calendar_mark_add()
25114 * @ingroup Calendar
25116 typedef enum _Elm_Calendar_Mark_Repeat
25118 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25119 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25120 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25121 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*/
25122 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. */
25123 } Elm_Calendar_Mark_Repeat;
25125 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(). */
25128 * Add a new calendar widget to the given parent Elementary
25129 * (container) object.
25131 * @param parent The parent object.
25132 * @return a new calendar widget handle or @c NULL, on errors.
25134 * This function inserts a new calendar widget on the canvas.
25136 * @ref calendar_example_01
25138 * @ingroup Calendar
25140 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25143 * Get weekdays names displayed by the calendar.
25145 * @param obj The calendar object.
25146 * @return Array of seven strings to be used as weekday names.
25148 * By default, weekdays abbreviations get from system are displayed:
25149 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25150 * The first string is related to Sunday, the second to Monday...
25152 * @see elm_calendar_weekdays_name_set()
25154 * @ref calendar_example_05
25156 * @ingroup Calendar
25158 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25161 * Set weekdays names to be displayed by the calendar.
25163 * @param obj The calendar object.
25164 * @param weekdays Array of seven strings to be used as weekday names.
25165 * @warning It must have 7 elements, or it will access invalid memory.
25166 * @warning The strings must be NULL terminated ('@\0').
25168 * By default, weekdays abbreviations get from system are displayed:
25169 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25171 * The first string should be related to Sunday, the second to Monday...
25173 * The usage should be like this:
25175 * const char *weekdays[] =
25177 * "Sunday", "Monday", "Tuesday", "Wednesday",
25178 * "Thursday", "Friday", "Saturday"
25180 * elm_calendar_weekdays_names_set(calendar, weekdays);
25183 * @see elm_calendar_weekdays_name_get()
25185 * @ref calendar_example_02
25187 * @ingroup Calendar
25189 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25192 * Set the minimum and maximum values for the year
25194 * @param obj The calendar object
25195 * @param min The minimum year, greater than 1901;
25196 * @param max The maximum year;
25198 * Maximum must be greater than minimum, except if you don't wan't to set
25200 * Default values are 1902 and -1.
25202 * If the maximum year is a negative value, it will be limited depending
25203 * on the platform architecture (year 2037 for 32 bits);
25205 * @see elm_calendar_min_max_year_get()
25207 * @ref calendar_example_03
25209 * @ingroup Calendar
25211 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25214 * Get the minimum and maximum values for the year
25216 * @param obj The calendar object.
25217 * @param min The minimum year.
25218 * @param max The maximum year.
25220 * Default values are 1902 and -1.
25222 * @see elm_calendar_min_max_year_get() for more details.
25224 * @ref calendar_example_05
25226 * @ingroup Calendar
25228 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25231 * Enable or disable day selection
25233 * @param obj The calendar object.
25234 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25237 * Enabled by default. If disabled, the user still can select months,
25238 * but not days. Selected days are highlighted on calendar.
25239 * It should be used if you won't need such selection for the widget usage.
25241 * When a day is selected, or month is changed, smart callbacks for
25242 * signal "changed" will be called.
25244 * @see elm_calendar_day_selection_enable_get()
25246 * @ref calendar_example_04
25248 * @ingroup Calendar
25250 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25253 * Get a value whether day selection is enabled or not.
25255 * @see elm_calendar_day_selection_enable_set() for details.
25257 * @param obj The calendar object.
25258 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25259 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25261 * @ref calendar_example_05
25263 * @ingroup Calendar
25265 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25269 * Set selected date to be highlighted on calendar.
25271 * @param obj The calendar object.
25272 * @param selected_time A @b tm struct to represent the selected date.
25274 * Set the selected date, changing the displayed month if needed.
25275 * Selected date changes when the user goes to next/previous month or
25276 * select a day pressing over it on calendar.
25278 * @see elm_calendar_selected_time_get()
25280 * @ref calendar_example_04
25282 * @ingroup Calendar
25284 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25287 * Get selected date.
25289 * @param obj The calendar object
25290 * @param selected_time A @b tm struct to point to selected date
25291 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25294 * Get date selected by the user or set by function
25295 * elm_calendar_selected_time_set().
25296 * Selected date changes when the user goes to next/previous month or
25297 * select a day pressing over it on calendar.
25299 * @see elm_calendar_selected_time_get()
25301 * @ref calendar_example_05
25303 * @ingroup Calendar
25305 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25308 * Set a function to format the string that will be used to display
25311 * @param obj The calendar object
25312 * @param format_function Function to set the month-year string given
25313 * the selected date
25315 * By default it uses strftime with "%B %Y" format string.
25316 * It should allocate the memory that will be used by the string,
25317 * that will be freed by the widget after usage.
25318 * A pointer to the string and a pointer to the time struct will be provided.
25323 * _format_month_year(struct tm *selected_time)
25326 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25327 * return strdup(buf);
25330 * elm_calendar_format_function_set(calendar, _format_month_year);
25333 * @ref calendar_example_02
25335 * @ingroup Calendar
25337 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25340 * Add a new mark to the calendar
25342 * @param obj The calendar object
25343 * @param mark_type A string used to define the type of mark. It will be
25344 * emitted to the theme, that should display a related modification on these
25345 * days representation.
25346 * @param mark_time A time struct to represent the date of inclusion of the
25347 * mark. For marks that repeats it will just be displayed after the inclusion
25348 * date in the calendar.
25349 * @param repeat Repeat the event following this periodicity. Can be a unique
25350 * mark (that don't repeat), daily, weekly, monthly or annually.
25351 * @return The created mark or @p NULL upon failure.
25353 * Add a mark that will be drawn in the calendar respecting the insertion
25354 * time and periodicity. It will emit the type as signal to the widget theme.
25355 * Default theme supports "holiday" and "checked", but it can be extended.
25357 * It won't immediately update the calendar, drawing the marks.
25358 * For this, call elm_calendar_marks_draw(). However, when user selects
25359 * next or previous month calendar forces marks drawn.
25361 * Marks created with this method can be deleted with
25362 * elm_calendar_mark_del().
25366 * struct tm selected_time;
25367 * time_t current_time;
25369 * current_time = time(NULL) + 5 * 84600;
25370 * localtime_r(¤t_time, &selected_time);
25371 * elm_calendar_mark_add(cal, "holiday", selected_time,
25372 * ELM_CALENDAR_ANNUALLY);
25374 * current_time = time(NULL) + 1 * 84600;
25375 * localtime_r(¤t_time, &selected_time);
25376 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25378 * elm_calendar_marks_draw(cal);
25381 * @see elm_calendar_marks_draw()
25382 * @see elm_calendar_mark_del()
25384 * @ref calendar_example_06
25386 * @ingroup Calendar
25388 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);
25391 * Delete mark from the calendar.
25393 * @param mark The mark to be deleted.
25395 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25396 * should be used instead of getting marks list and deleting each one.
25398 * @see elm_calendar_mark_add()
25400 * @ref calendar_example_06
25402 * @ingroup Calendar
25404 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25407 * Remove all calendar's marks
25409 * @param obj The calendar object.
25411 * @see elm_calendar_mark_add()
25412 * @see elm_calendar_mark_del()
25414 * @ingroup Calendar
25416 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25420 * Get a list of all the calendar marks.
25422 * @param obj The calendar object.
25423 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25425 * @see elm_calendar_mark_add()
25426 * @see elm_calendar_mark_del()
25427 * @see elm_calendar_marks_clear()
25429 * @ingroup Calendar
25431 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25434 * Draw calendar marks.
25436 * @param obj The calendar object.
25438 * Should be used after adding, removing or clearing marks.
25439 * It will go through the entire marks list updating the calendar.
25440 * If lots of marks will be added, add all the marks and then call
25443 * When the month is changed, i.e. user selects next or previous month,
25444 * marks will be drawed.
25446 * @see elm_calendar_mark_add()
25447 * @see elm_calendar_mark_del()
25448 * @see elm_calendar_marks_clear()
25450 * @ref calendar_example_06
25452 * @ingroup Calendar
25454 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25457 * Set a day text color to the same that represents Saturdays.
25459 * @param obj The calendar object.
25460 * @param pos The text position. Position is the cell counter, from left
25461 * to right, up to down. It starts on 0 and ends on 41.
25463 * @deprecated use elm_calendar_mark_add() instead like:
25466 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25467 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25470 * @see elm_calendar_mark_add()
25472 * @ingroup Calendar
25474 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25477 * Set a day text color to the same that represents Sundays.
25479 * @param obj The calendar object.
25480 * @param pos The text position. Position is the cell counter, from left
25481 * to right, up to down. It starts on 0 and ends on 41.
25483 * @deprecated use elm_calendar_mark_add() instead like:
25486 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25487 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25490 * @see elm_calendar_mark_add()
25492 * @ingroup Calendar
25494 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25497 * Set a day text color to the same that represents Weekdays.
25499 * @param obj The calendar object
25500 * @param pos The text position. Position is the cell counter, from left
25501 * to right, up to down. It starts on 0 and ends on 41.
25503 * @deprecated use elm_calendar_mark_add() instead like:
25506 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25508 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25509 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25510 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25511 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25512 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25513 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25514 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25515 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25516 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25519 * @see elm_calendar_mark_add()
25521 * @ingroup Calendar
25523 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25526 * Set the interval on time updates for an user mouse button hold
25527 * on calendar widgets' month selection.
25529 * @param obj The calendar object
25530 * @param interval The (first) interval value in seconds
25532 * This interval value is @b decreased while the user holds the
25533 * mouse pointer either selecting next or previous month.
25535 * This helps the user to get to a given month distant from the
25536 * current one easier/faster, as it will start to change quicker and
25537 * quicker on mouse button holds.
25539 * The calculation for the next change interval value, starting from
25540 * the one set with this call, is the previous interval divided by
25541 * 1.05, so it decreases a little bit.
25543 * The default starting interval value for automatic changes is
25546 * @see elm_calendar_interval_get()
25548 * @ingroup Calendar
25550 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25553 * Get the interval on time updates for an user mouse button hold
25554 * on calendar widgets' month selection.
25556 * @param obj The calendar object
25557 * @return The (first) interval value, in seconds, set on it
25559 * @see elm_calendar_interval_set() for more details
25561 * @ingroup Calendar
25563 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25570 * @defgroup Diskselector Diskselector
25571 * @ingroup Elementary
25573 * @image html img/widget/diskselector/preview-00.png
25574 * @image latex img/widget/diskselector/preview-00.eps
25576 * A diskselector is a kind of list widget. It scrolls horizontally,
25577 * and can contain label and icon objects. Three items are displayed
25578 * with the selected one in the middle.
25580 * It can act like a circular list with round mode and labels can be
25581 * reduced for a defined length for side items.
25583 * Smart callbacks one can listen to:
25584 * - "selected" - when item is selected, i.e. scroller stops.
25586 * Available styles for it:
25589 * List of examples:
25590 * @li @ref diskselector_example_01
25591 * @li @ref diskselector_example_02
25595 * @addtogroup Diskselector
25599 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(). */
25602 * Add a new diskselector widget to the given parent Elementary
25603 * (container) object.
25605 * @param parent The parent object.
25606 * @return a new diskselector widget handle or @c NULL, on errors.
25608 * This function inserts a new diskselector widget on the canvas.
25610 * @ingroup Diskselector
25612 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25615 * Enable or disable round mode.
25617 * @param obj The diskselector object.
25618 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25621 * Disabled by default. If round mode is enabled the items list will
25622 * work like a circle list, so when the user reaches the last item,
25623 * the first one will popup.
25625 * @see elm_diskselector_round_get()
25627 * @ingroup Diskselector
25629 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25632 * Get a value whether round mode is enabled or not.
25634 * @see elm_diskselector_round_set() for details.
25636 * @param obj The diskselector object.
25637 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25638 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25640 * @ingroup Diskselector
25642 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25645 * Get the side labels max length.
25647 * @deprecated use elm_diskselector_side_label_length_get() instead:
25649 * @param obj The diskselector object.
25650 * @return The max length defined for side labels, or 0 if not a valid
25653 * @ingroup Diskselector
25655 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25658 * Set the side labels max length.
25660 * @deprecated use elm_diskselector_side_label_length_set() instead:
25662 * @param obj The diskselector object.
25663 * @param len The max length defined for side labels.
25665 * @ingroup Diskselector
25667 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25670 * Get the side labels max length.
25672 * @see elm_diskselector_side_label_length_set() for details.
25674 * @param obj The diskselector object.
25675 * @return The max length defined for side labels, or 0 if not a valid
25678 * @ingroup Diskselector
25680 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25683 * Set the side labels max length.
25685 * @param obj The diskselector object.
25686 * @param len The max length defined for side labels.
25688 * Length is the number of characters of items' label that will be
25689 * visible when it's set on side positions. It will just crop
25690 * the string after defined size. E.g.:
25692 * An item with label "January" would be displayed on side position as
25693 * "Jan" if max length is set to 3, or "Janu", if this property
25696 * When it's selected, the entire label will be displayed, except for
25697 * width restrictions. In this case label will be cropped and "..."
25698 * will be concatenated.
25700 * Default side label max length is 3.
25702 * This property will be applyed over all items, included before or
25703 * later this function call.
25705 * @ingroup Diskselector
25707 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25710 * Set the number of items to be displayed.
25712 * @param obj The diskselector object.
25713 * @param num The number of items the diskselector will display.
25715 * Default value is 3, and also it's the minimun. If @p num is less
25716 * than 3, it will be set to 3.
25718 * Also, it can be set on theme, using data item @c display_item_num
25719 * on group "elm/diskselector/item/X", where X is style set.
25722 * group { name: "elm/diskselector/item/X";
25724 * item: "display_item_num" "5";
25727 * @ingroup Diskselector
25729 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25732 * Get the number of items in the diskselector object.
25734 * @param obj The diskselector object.
25736 * @ingroup Diskselector
25738 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25741 * Set bouncing behaviour when the scrolled content reaches an edge.
25743 * Tell the internal scroller object whether it should bounce or not
25744 * when it reaches the respective edges for each axis.
25746 * @param obj The diskselector object.
25747 * @param h_bounce Whether to bounce or not in the horizontal axis.
25748 * @param v_bounce Whether to bounce or not in the vertical axis.
25750 * @see elm_scroller_bounce_set()
25752 * @ingroup Diskselector
25754 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25757 * Get the bouncing behaviour of the internal scroller.
25759 * Get whether the internal scroller should bounce when the edge of each
25760 * axis is reached scrolling.
25762 * @param obj The diskselector object.
25763 * @param h_bounce Pointer where to store the bounce state of the horizontal
25765 * @param v_bounce Pointer where to store the bounce state of the vertical
25768 * @see elm_scroller_bounce_get()
25769 * @see elm_diskselector_bounce_set()
25771 * @ingroup Diskselector
25773 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25776 * Get the scrollbar policy.
25778 * @see elm_diskselector_scroller_policy_get() for details.
25780 * @param obj The diskselector object.
25781 * @param policy_h Pointer where to store horizontal scrollbar policy.
25782 * @param policy_v Pointer where to store vertical scrollbar policy.
25784 * @ingroup Diskselector
25786 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);
25789 * Set the scrollbar policy.
25791 * @param obj The diskselector object.
25792 * @param policy_h Horizontal scrollbar policy.
25793 * @param policy_v Vertical scrollbar policy.
25795 * This sets the scrollbar visibility policy for the given scroller.
25796 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25797 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25798 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25799 * This applies respectively for the horizontal and vertical scrollbars.
25801 * The both are disabled by default, i.e., are set to
25802 * #ELM_SCROLLER_POLICY_OFF.
25804 * @ingroup Diskselector
25806 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25809 * Remove all diskselector's items.
25811 * @param obj The diskselector object.
25813 * @see elm_diskselector_item_del()
25814 * @see elm_diskselector_item_append()
25816 * @ingroup Diskselector
25818 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25821 * Get a list of all the diskselector items.
25823 * @param obj The diskselector object.
25824 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25825 * or @c NULL on failure.
25827 * @see elm_diskselector_item_append()
25828 * @see elm_diskselector_item_del()
25829 * @see elm_diskselector_clear()
25831 * @ingroup Diskselector
25833 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25836 * Appends a new item to the diskselector object.
25838 * @param obj The diskselector object.
25839 * @param label The label of the diskselector item.
25840 * @param icon The icon object to use at left side of the item. An
25841 * icon can be any Evas object, but usually it is an icon created
25842 * with elm_icon_add().
25843 * @param func The function to call when the item is selected.
25844 * @param data The data to associate with the item for related callbacks.
25846 * @return The created item or @c NULL upon failure.
25848 * A new item will be created and appended to the diskselector, i.e., will
25849 * be set as last item. Also, if there is no selected item, it will
25850 * be selected. This will always happens for the first appended item.
25852 * If no icon is set, label will be centered on item position, otherwise
25853 * the icon will be placed at left of the label, that will be shifted
25856 * Items created with this method can be deleted with
25857 * elm_diskselector_item_del().
25859 * Associated @p data can be properly freed when item is deleted if a
25860 * callback function is set with elm_diskselector_item_del_cb_set().
25862 * If a function is passed as argument, it will be called everytime this item
25863 * is selected, i.e., the user stops the diskselector with this
25864 * item on center position. If such function isn't needed, just passing
25865 * @c NULL as @p func is enough. The same should be done for @p data.
25867 * Simple example (with no function callback or data associated):
25869 * disk = elm_diskselector_add(win);
25870 * ic = elm_icon_add(win);
25871 * elm_icon_file_set(ic, "path/to/image", NULL);
25872 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25873 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25876 * @see elm_diskselector_item_del()
25877 * @see elm_diskselector_item_del_cb_set()
25878 * @see elm_diskselector_clear()
25879 * @see elm_icon_add()
25881 * @ingroup Diskselector
25883 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);
25887 * Delete them item from the diskselector.
25889 * @param it The item of diskselector to be deleted.
25891 * If deleting all diskselector items is required, elm_diskselector_clear()
25892 * should be used instead of getting items list and deleting each one.
25894 * @see elm_diskselector_clear()
25895 * @see elm_diskselector_item_append()
25896 * @see elm_diskselector_item_del_cb_set()
25898 * @ingroup Diskselector
25900 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25903 * Set the function called when a diskselector item is freed.
25905 * @param it The item to set the callback on
25906 * @param func The function called
25908 * If there is a @p func, then it will be called prior item's memory release.
25909 * That will be called with the following arguments:
25911 * @li item's Evas object;
25914 * This way, a data associated to a diskselector item could be properly
25917 * @ingroup Diskselector
25919 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25922 * Get the data associated to the item.
25924 * @param it The diskselector item
25925 * @return The data associated to @p it
25927 * The return value is a pointer to data associated to @p item when it was
25928 * created, with function elm_diskselector_item_append(). If no data
25929 * was passed as argument, it will return @c NULL.
25931 * @see elm_diskselector_item_append()
25933 * @ingroup Diskselector
25935 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25938 * Set the icon associated to the item.
25940 * @param it The diskselector item
25941 * @param icon The icon object to associate with @p it
25943 * The icon object to use at left side of the item. An
25944 * icon can be any Evas object, but usually it is an icon created
25945 * with elm_icon_add().
25947 * Once the icon object is set, a previously set one will be deleted.
25948 * @warning Setting the same icon for two items will cause the icon to
25949 * dissapear from the first item.
25951 * If an icon was passed as argument on item creation, with function
25952 * elm_diskselector_item_append(), it will be already
25953 * associated to the item.
25955 * @see elm_diskselector_item_append()
25956 * @see elm_diskselector_item_icon_get()
25958 * @ingroup Diskselector
25960 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25963 * Get the icon associated to the item.
25965 * @param it The diskselector item
25966 * @return The icon associated to @p it
25968 * The return value is a pointer to the icon associated to @p item when it was
25969 * created, with function elm_diskselector_item_append(), or later
25970 * with function elm_diskselector_item_icon_set. If no icon
25971 * was passed as argument, it will return @c NULL.
25973 * @see elm_diskselector_item_append()
25974 * @see elm_diskselector_item_icon_set()
25976 * @ingroup Diskselector
25978 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25981 * Set the label of item.
25983 * @param it The item of diskselector.
25984 * @param label The label of item.
25986 * The label to be displayed by the item.
25988 * If no icon is set, label will be centered on item position, otherwise
25989 * the icon will be placed at left of the label, that will be shifted
25992 * An item with label "January" would be displayed on side position as
25993 * "Jan" if max length is set to 3 with function
25994 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25997 * When this @p item is selected, the entire label will be displayed,
25998 * except for width restrictions.
25999 * In this case label will be cropped and "..." will be concatenated,
26000 * but only for display purposes. It will keep the entire string, so
26001 * if diskselector is resized the remaining characters will be displayed.
26003 * If a label was passed as argument on item creation, with function
26004 * elm_diskselector_item_append(), it will be already
26005 * displayed by the item.
26007 * @see elm_diskselector_side_label_lenght_set()
26008 * @see elm_diskselector_item_label_get()
26009 * @see elm_diskselector_item_append()
26011 * @ingroup Diskselector
26013 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26016 * Get the label of item.
26018 * @param it The item of diskselector.
26019 * @return The label of item.
26021 * The return value is a pointer to the label associated to @p item when it was
26022 * created, with function elm_diskselector_item_append(), or later
26023 * with function elm_diskselector_item_label_set. If no label
26024 * was passed as argument, it will return @c NULL.
26026 * @see elm_diskselector_item_label_set() for more details.
26027 * @see elm_diskselector_item_append()
26029 * @ingroup Diskselector
26031 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26034 * Get the selected item.
26036 * @param obj The diskselector object.
26037 * @return The selected diskselector item.
26039 * The selected item can be unselected with function
26040 * elm_diskselector_item_selected_set(), and the first item of
26041 * diskselector will be selected.
26043 * The selected item always will be centered on diskselector, with
26044 * full label displayed, i.e., max lenght set to side labels won't
26045 * apply on the selected item. More details on
26046 * elm_diskselector_side_label_length_set().
26048 * @ingroup Diskselector
26050 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26053 * Set the selected state of an item.
26055 * @param it The diskselector item
26056 * @param selected The selected state
26058 * This sets the selected state of the given item @p it.
26059 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26061 * If a new item is selected the previosly selected will be unselected.
26062 * Previoulsy selected item can be get with function
26063 * elm_diskselector_selected_item_get().
26065 * If the item @p it is unselected, the first item of diskselector will
26068 * Selected items will be visible on center position of diskselector.
26069 * So if it was on another position before selected, or was invisible,
26070 * diskselector will animate items until the selected item reaches center
26073 * @see elm_diskselector_item_selected_get()
26074 * @see elm_diskselector_selected_item_get()
26076 * @ingroup Diskselector
26078 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26081 * Get whether the @p item is selected or not.
26083 * @param it The diskselector item.
26084 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26085 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26087 * @see elm_diskselector_selected_item_set() for details.
26088 * @see elm_diskselector_item_selected_get()
26090 * @ingroup Diskselector
26092 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26095 * Get the first item of the diskselector.
26097 * @param obj The diskselector object.
26098 * @return The first item, or @c NULL if none.
26100 * The list of items follows append order. So it will return the first
26101 * item appended to the widget that wasn't deleted.
26103 * @see elm_diskselector_item_append()
26104 * @see elm_diskselector_items_get()
26106 * @ingroup Diskselector
26108 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26111 * Get the last item of the diskselector.
26113 * @param obj The diskselector object.
26114 * @return The last item, or @c NULL if none.
26116 * The list of items follows append order. So it will return last first
26117 * item appended to the widget that wasn't deleted.
26119 * @see elm_diskselector_item_append()
26120 * @see elm_diskselector_items_get()
26122 * @ingroup Diskselector
26124 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26127 * Get the item before @p item in diskselector.
26129 * @param it The diskselector item.
26130 * @return The item before @p item, or @c NULL if none or on failure.
26132 * The list of items follows append order. So it will return item appended
26133 * just before @p item and that wasn't deleted.
26135 * If it is the first item, @c NULL will be returned.
26136 * First item can be get by elm_diskselector_first_item_get().
26138 * @see elm_diskselector_item_append()
26139 * @see elm_diskselector_items_get()
26141 * @ingroup Diskselector
26143 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26146 * Get the item after @p item in diskselector.
26148 * @param it The diskselector item.
26149 * @return The item after @p item, or @c NULL if none or on failure.
26151 * The list of items follows append order. So it will return item appended
26152 * just after @p item and that wasn't deleted.
26154 * If it is the last item, @c NULL will be returned.
26155 * Last item can be get by elm_diskselector_last_item_get().
26157 * @see elm_diskselector_item_append()
26158 * @see elm_diskselector_items_get()
26160 * @ingroup Diskselector
26162 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26165 * Set the text to be shown in the diskselector item.
26167 * @param item Target item
26168 * @param text The text to set in the content
26170 * Setup the text as tooltip to object. The item can have only one tooltip,
26171 * so any previous tooltip data is removed.
26173 * @see elm_object_tooltip_text_set() for more details.
26175 * @ingroup Diskselector
26177 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26180 * Set the content to be shown in the tooltip item.
26182 * Setup the tooltip to item. The item can have only one tooltip,
26183 * so any previous tooltip data is removed. @p func(with @p data) will
26184 * be called every time that need show the tooltip and it should
26185 * return a valid Evas_Object. This object is then managed fully by
26186 * tooltip system and is deleted when the tooltip is gone.
26188 * @param item the diskselector item being attached a tooltip.
26189 * @param func the function used to create the tooltip contents.
26190 * @param data what to provide to @a func as callback data/context.
26191 * @param del_cb called when data is not needed anymore, either when
26192 * another callback replaces @p func, the tooltip is unset with
26193 * elm_diskselector_item_tooltip_unset() or the owner @a item
26194 * dies. This callback receives as the first parameter the
26195 * given @a data, and @c event_info is the item.
26197 * @see elm_object_tooltip_content_cb_set() for more details.
26199 * @ingroup Diskselector
26201 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);
26204 * Unset tooltip from item.
26206 * @param item diskselector item to remove previously set tooltip.
26208 * Remove tooltip from item. The callback provided as del_cb to
26209 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26210 * it is not used anymore.
26212 * @see elm_object_tooltip_unset() for more details.
26213 * @see elm_diskselector_item_tooltip_content_cb_set()
26215 * @ingroup Diskselector
26217 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26221 * Sets a different style for this item tooltip.
26223 * @note before you set a style you should define a tooltip with
26224 * elm_diskselector_item_tooltip_content_cb_set() or
26225 * elm_diskselector_item_tooltip_text_set()
26227 * @param item diskselector item with tooltip already set.
26228 * @param style the theme style to use (default, transparent, ...)
26230 * @see elm_object_tooltip_style_set() for more details.
26232 * @ingroup Diskselector
26234 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26237 * Get the style for this item tooltip.
26239 * @param item diskselector item with tooltip already set.
26240 * @return style the theme style in use, defaults to "default". If the
26241 * object does not have a tooltip set, then NULL is returned.
26243 * @see elm_object_tooltip_style_get() for more details.
26244 * @see elm_diskselector_item_tooltip_style_set()
26246 * @ingroup Diskselector
26248 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26251 * Set the cursor to be shown when mouse is over the diskselector item
26253 * @param item Target item
26254 * @param cursor the cursor name to be used.
26256 * @see elm_object_cursor_set() for more details.
26258 * @ingroup Diskselector
26260 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26263 * Get the cursor to be shown when mouse is over the diskselector item
26265 * @param item diskselector item with cursor already set.
26266 * @return the cursor name.
26268 * @see elm_object_cursor_get() for more details.
26269 * @see elm_diskselector_cursor_set()
26271 * @ingroup Diskselector
26273 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26277 * Unset the cursor to be shown when mouse is over the diskselector item
26279 * @param item Target item
26281 * @see elm_object_cursor_unset() for more details.
26282 * @see elm_diskselector_cursor_set()
26284 * @ingroup Diskselector
26286 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26289 * Sets a different style for this item cursor.
26291 * @note before you set a style you should define a cursor with
26292 * elm_diskselector_item_cursor_set()
26294 * @param item diskselector item with cursor already set.
26295 * @param style the theme style to use (default, transparent, ...)
26297 * @see elm_object_cursor_style_set() for more details.
26299 * @ingroup Diskselector
26301 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26305 * Get the style for this item cursor.
26307 * @param item diskselector item with cursor already set.
26308 * @return style the theme style in use, defaults to "default". If the
26309 * object does not have a cursor set, then @c NULL is returned.
26311 * @see elm_object_cursor_style_get() for more details.
26312 * @see elm_diskselector_item_cursor_style_set()
26314 * @ingroup Diskselector
26316 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26320 * Set if the cursor set should be searched on the theme or should use
26321 * the provided by the engine, only.
26323 * @note before you set if should look on theme you should define a cursor
26324 * with elm_diskselector_item_cursor_set().
26325 * By default it will only look for cursors provided by the engine.
26327 * @param item widget item with cursor already set.
26328 * @param engine_only boolean to define if cursors set with
26329 * elm_diskselector_item_cursor_set() should be searched only
26330 * between cursors provided by the engine or searched on widget's
26333 * @see elm_object_cursor_engine_only_set() for more details.
26335 * @ingroup Diskselector
26337 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26340 * Get the cursor engine only usage for this item cursor.
26342 * @param item widget item with cursor already set.
26343 * @return engine_only boolean to define it cursors should be looked only
26344 * between the provided by the engine or searched on widget's theme as well.
26345 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26347 * @see elm_object_cursor_engine_only_get() for more details.
26348 * @see elm_diskselector_item_cursor_engine_only_set()
26350 * @ingroup Diskselector
26352 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26359 * @defgroup Colorselector Colorselector
26363 * @image html img/widget/colorselector/preview-00.png
26364 * @image latex img/widget/colorselector/preview-00.eps
26366 * @brief Widget for user to select a color.
26368 * Signals that you can add callbacks for are:
26369 * "changed" - When the color value changes(event_info is NULL).
26371 * See @ref tutorial_colorselector.
26374 * @brief Add a new colorselector to the parent
26376 * @param parent The parent object
26377 * @return The new object or NULL if it cannot be created
26379 * @ingroup Colorselector
26381 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26383 * Set a color for the colorselector
26385 * @param obj Colorselector object
26386 * @param r r-value of color
26387 * @param g g-value of color
26388 * @param b b-value of color
26389 * @param a a-value of color
26391 * @ingroup Colorselector
26393 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26395 * Get a color from the colorselector
26397 * @param obj Colorselector object
26398 * @param r integer pointer for r-value of color
26399 * @param g integer pointer for g-value of color
26400 * @param b integer pointer for b-value of color
26401 * @param a integer pointer for a-value of color
26403 * @ingroup Colorselector
26405 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26411 * @defgroup Ctxpopup Ctxpopup
26413 * @image html img/widget/ctxpopup/preview-00.png
26414 * @image latex img/widget/ctxpopup/preview-00.eps
26416 * @brief Context popup widet.
26418 * A ctxpopup is a widget that, when shown, pops up a list of items.
26419 * It automatically chooses an area inside its parent object's view
26420 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26421 * optimally fit into it. In the default theme, it will also point an
26422 * arrow to it's top left position at the time one shows it. Ctxpopup
26423 * items have a label and/or an icon. It is intended for a small
26424 * number of items (hence the use of list, not genlist).
26426 * @note Ctxpopup is a especialization of @ref Hover.
26428 * Signals that you can add callbacks for are:
26429 * "dismissed" - the ctxpopup was dismissed
26431 * Default contents parts of the ctxpopup widget that you can use for are:
26432 * @li "default" - A content of the ctxpopup
26434 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26437 typedef enum _Elm_Ctxpopup_Direction
26439 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26441 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26442 the clicked area */
26443 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26444 the clicked area */
26445 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26447 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26448 } Elm_Ctxpopup_Direction;
26449 #define Elm_Ctxpopup_Item Elm_Object_Item
26452 * @brief Add a new Ctxpopup object to the parent.
26454 * @param parent Parent object
26455 * @return New object or @c NULL, if it cannot be created
26457 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26459 * @brief Set the Ctxpopup's parent
26461 * @param obj The ctxpopup object
26462 * @param area The parent to use
26464 * Set the parent object.
26466 * @note elm_ctxpopup_add() will automatically call this function
26467 * with its @c parent argument.
26469 * @see elm_ctxpopup_add()
26470 * @see elm_hover_parent_set()
26472 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26474 * @brief Get the Ctxpopup's parent
26476 * @param obj The ctxpopup object
26478 * @see elm_ctxpopup_hover_parent_set() for more information
26480 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26482 * @brief Clear all items in the given ctxpopup object.
26484 * @param obj Ctxpopup object
26486 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26488 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26490 * @param obj Ctxpopup object
26491 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26493 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26495 * @brief Get the value of current ctxpopup object's orientation.
26497 * @param obj Ctxpopup object
26498 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26500 * @see elm_ctxpopup_horizontal_set()
26502 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26504 * @brief Add a new item to a ctxpopup object.
26506 * @param obj Ctxpopup object
26507 * @param icon Icon to be set on new item
26508 * @param label The Label of the new item
26509 * @param func Convenience function called when item selected
26510 * @param data Data passed to @p func
26511 * @return A handle to the item added or @c NULL, on errors
26513 * @warning Ctxpopup can't hold both an item list and a content at the same
26514 * time. When an item is added, any previous content will be removed.
26516 * @see elm_ctxpopup_content_set()
26518 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);
26520 * @brief Delete the given item in a ctxpopup object.
26522 * @param it Ctxpopup item to be deleted
26524 * @see elm_ctxpopup_item_append()
26526 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26528 * @brief Set the ctxpopup item's state as disabled or enabled.
26530 * @param it Ctxpopup item to be enabled/disabled
26531 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26533 * When disabled the item is greyed out to indicate it's state.
26535 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26537 * @brief Get the ctxpopup item's disabled/enabled state.
26539 * @param it Ctxpopup item to be enabled/disabled
26540 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26542 * @see elm_ctxpopup_item_disabled_set()
26543 * @deprecated use elm_object_item_disabled_get() instead
26545 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26547 * @brief Get the icon object for the given ctxpopup item.
26549 * @param it Ctxpopup item
26550 * @return icon object or @c NULL, if the item does not have icon or an error
26553 * @see elm_ctxpopup_item_append()
26554 * @see elm_ctxpopup_item_icon_set()
26556 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26558 * @brief Sets the side icon associated with the ctxpopup item
26560 * @param it Ctxpopup item
26561 * @param icon Icon object to be set
26563 * Once the icon object is set, a previously set one will be deleted.
26564 * @warning Setting the same icon for two items will cause the icon to
26565 * dissapear from the first item.
26567 * @see elm_ctxpopup_item_append()
26569 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26571 * @brief Get the label for the given ctxpopup item.
26573 * @param it Ctxpopup item
26574 * @return label string or @c NULL, if the item does not have label or an
26577 * @see elm_ctxpopup_item_append()
26578 * @see elm_ctxpopup_item_label_set()
26580 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26582 * @brief (Re)set the label on the given ctxpopup item.
26584 * @param it Ctxpopup item
26585 * @param label String to set as label
26587 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26589 * @brief Set an elm widget as the content of the ctxpopup.
26591 * @param obj Ctxpopup object
26592 * @param content Content to be swallowed
26594 * If the content object is already set, a previous one will bedeleted. If
26595 * you want to keep that old content object, use the
26596 * elm_ctxpopup_content_unset() function.
26598 * @deprecated use elm_object_content_set()
26600 * @warning Ctxpopup can't hold both a item list and a content at the same
26601 * time. When a content is set, any previous items will be removed.
26603 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26605 * @brief Unset the ctxpopup content
26607 * @param obj Ctxpopup object
26608 * @return The content that was being used
26610 * Unparent and return the content object which was set for this widget.
26612 * @deprecated use elm_object_content_unset()
26614 * @see elm_ctxpopup_content_set()
26616 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26618 * @brief Set the direction priority of a ctxpopup.
26620 * @param obj Ctxpopup object
26621 * @param first 1st priority of direction
26622 * @param second 2nd priority of direction
26623 * @param third 3th priority of direction
26624 * @param fourth 4th priority of direction
26626 * This functions gives a chance to user to set the priority of ctxpopup
26627 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26628 * requested direction.
26630 * @see Elm_Ctxpopup_Direction
26632 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);
26634 * @brief Get the direction priority of a ctxpopup.
26636 * @param obj Ctxpopup object
26637 * @param first 1st priority of direction to be returned
26638 * @param second 2nd priority of direction to be returned
26639 * @param third 3th priority of direction to be returned
26640 * @param fourth 4th priority of direction to be returned
26642 * @see elm_ctxpopup_direction_priority_set() for more information.
26644 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);
26647 * @brief Get the current direction of a ctxpopup.
26649 * @param obj Ctxpopup object
26650 * @return current direction of a ctxpopup
26652 * @warning Once the ctxpopup showed up, the direction would be determined
26654 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26663 * @defgroup Transit Transit
26664 * @ingroup Elementary
26666 * Transit is designed to apply various animated transition effects to @c
26667 * Evas_Object, such like translation, rotation, etc. For using these
26668 * effects, create an @ref Elm_Transit and add the desired transition effects.
26670 * Once the effects are added into transit, they will be automatically
26671 * managed (their callback will be called until the duration is ended, and
26672 * they will be deleted on completion).
26676 * Elm_Transit *trans = elm_transit_add();
26677 * elm_transit_object_add(trans, obj);
26678 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26679 * elm_transit_duration_set(transit, 1);
26680 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26681 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26682 * elm_transit_repeat_times_set(transit, 3);
26685 * Some transition effects are used to change the properties of objects. They
26687 * @li @ref elm_transit_effect_translation_add
26688 * @li @ref elm_transit_effect_color_add
26689 * @li @ref elm_transit_effect_rotation_add
26690 * @li @ref elm_transit_effect_wipe_add
26691 * @li @ref elm_transit_effect_zoom_add
26692 * @li @ref elm_transit_effect_resizing_add
26694 * Other transition effects are used to make one object disappear and another
26695 * object appear on its old place. These effects are:
26697 * @li @ref elm_transit_effect_flip_add
26698 * @li @ref elm_transit_effect_resizable_flip_add
26699 * @li @ref elm_transit_effect_fade_add
26700 * @li @ref elm_transit_effect_blend_add
26702 * It's also possible to make a transition chain with @ref
26703 * elm_transit_chain_transit_add.
26705 * @warning We strongly recommend to use elm_transit just when edje can not do
26706 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26707 * animations can be manipulated inside the theme.
26709 * List of examples:
26710 * @li @ref transit_example_01_explained
26711 * @li @ref transit_example_02_explained
26712 * @li @ref transit_example_03_c
26713 * @li @ref transit_example_04_c
26719 * @enum Elm_Transit_Tween_Mode
26721 * The type of acceleration used in the transition.
26725 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26726 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26727 over time, then decrease again
26729 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26731 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26733 } Elm_Transit_Tween_Mode;
26736 * @enum Elm_Transit_Effect_Flip_Axis
26738 * The axis where flip effect should be applied.
26742 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26743 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26744 } Elm_Transit_Effect_Flip_Axis;
26746 * @enum Elm_Transit_Effect_Wipe_Dir
26748 * The direction where the wipe effect should occur.
26752 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26753 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26754 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26755 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26756 } Elm_Transit_Effect_Wipe_Dir;
26757 /** @enum Elm_Transit_Effect_Wipe_Type
26759 * Whether the wipe effect should show or hide the object.
26763 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26765 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26767 } Elm_Transit_Effect_Wipe_Type;
26770 * @typedef Elm_Transit
26772 * The Transit created with elm_transit_add(). This type has the information
26773 * about the objects which the transition will be applied, and the
26774 * transition effects that will be used. It also contains info about
26775 * duration, number of repetitions, auto-reverse, etc.
26777 typedef struct _Elm_Transit Elm_Transit;
26778 typedef void Elm_Transit_Effect;
26780 * @typedef Elm_Transit_Effect_Transition_Cb
26782 * Transition callback called for this effect on each transition iteration.
26784 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26786 * Elm_Transit_Effect_End_Cb
26788 * Transition callback called for this effect when the transition is over.
26790 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26793 * Elm_Transit_Del_Cb
26795 * A callback called when the transit is deleted.
26797 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26802 * @note Is not necessary to delete the transit object, it will be deleted at
26803 * the end of its operation.
26804 * @note The transit will start playing when the program enter in the main loop, is not
26805 * necessary to give a start to the transit.
26807 * @return The transit object.
26811 EAPI Elm_Transit *elm_transit_add(void);
26814 * Stops the animation and delete the @p transit object.
26816 * Call this function if you wants to stop the animation before the duration
26817 * time. Make sure the @p transit object is still alive with
26818 * elm_transit_del_cb_set() function.
26819 * All added effects will be deleted, calling its repective data_free_cb
26820 * functions. The function setted by elm_transit_del_cb_set() will be called.
26822 * @see elm_transit_del_cb_set()
26824 * @param transit The transit object to be deleted.
26827 * @warning Just call this function if you are sure the transit is alive.
26829 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26832 * Add a new effect to the transit.
26834 * @note The cb function and the data are the key to the effect. If you try to
26835 * add an already added effect, nothing is done.
26836 * @note After the first addition of an effect in @p transit, if its
26837 * effect list become empty again, the @p transit will be killed by
26838 * elm_transit_del(transit) function.
26842 * Elm_Transit *transit = elm_transit_add();
26843 * elm_transit_effect_add(transit,
26844 * elm_transit_effect_blend_op,
26845 * elm_transit_effect_blend_context_new(),
26846 * elm_transit_effect_blend_context_free);
26849 * @param transit The transit object.
26850 * @param transition_cb The operation function. It is called when the
26851 * animation begins, it is the function that actually performs the animation.
26852 * It is called with the @p data, @p transit and the time progression of the
26853 * animation (a double value between 0.0 and 1.0).
26854 * @param effect The context data of the effect.
26855 * @param end_cb The function to free the context data, it will be called
26856 * at the end of the effect, it must finalize the animation and free the
26860 * @warning The transit free the context data at the and of the transition with
26861 * the data_free_cb function, do not use the context data in another transit.
26863 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);
26866 * Delete an added effect.
26868 * This function will remove the effect from the @p transit, calling the
26869 * data_free_cb to free the @p data.
26871 * @see elm_transit_effect_add()
26873 * @note If the effect is not found, nothing is done.
26874 * @note If the effect list become empty, this function will call
26875 * elm_transit_del(transit), that is, it will kill the @p transit.
26877 * @param transit The transit object.
26878 * @param transition_cb The operation function.
26879 * @param effect The context data of the effect.
26883 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);
26886 * Add new object to apply the effects.
26888 * @note After the first addition of an object in @p transit, if its
26889 * object list become empty again, the @p transit will be killed by
26890 * elm_transit_del(transit) function.
26891 * @note If the @p obj belongs to another transit, the @p obj will be
26892 * removed from it and it will only belong to the @p transit. If the old
26893 * transit stays without objects, it will die.
26894 * @note When you add an object into the @p transit, its state from
26895 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26896 * transit ends, if you change this state whith evas_object_pass_events_set()
26897 * after add the object, this state will change again when @p transit stops to
26900 * @param transit The transit object.
26901 * @param obj Object to be animated.
26904 * @warning It is not allowed to add a new object after transit begins to go.
26906 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26909 * Removes an added object from the transit.
26911 * @note If the @p obj is not in the @p transit, nothing is done.
26912 * @note If the list become empty, this function will call
26913 * elm_transit_del(transit), that is, it will kill the @p transit.
26915 * @param transit The transit object.
26916 * @param obj Object to be removed from @p transit.
26919 * @warning It is not allowed to remove objects after transit begins to go.
26921 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26924 * Get the objects of the transit.
26926 * @param transit The transit object.
26927 * @return a Eina_List with the objects from the transit.
26931 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26934 * Enable/disable keeping up the objects states.
26935 * If it is not kept, the objects states will be reset when transition ends.
26937 * @note @p transit can not be NULL.
26938 * @note One state includes geometry, color, map data.
26940 * @param transit The transit object.
26941 * @param state_keep Keeping or Non Keeping.
26945 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26948 * Get a value whether the objects states will be reset or not.
26950 * @note @p transit can not be NULL
26952 * @see elm_transit_objects_final_state_keep_set()
26954 * @param transit The transit object.
26955 * @return EINA_TRUE means the states of the objects will be reset.
26956 * If @p transit is NULL, EINA_FALSE is returned
26960 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26963 * Set the event enabled when transit is operating.
26965 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26966 * events from mouse and keyboard during the animation.
26967 * @note When you add an object with elm_transit_object_add(), its state from
26968 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26969 * transit ends, if you change this state with evas_object_pass_events_set()
26970 * after adding the object, this state will change again when @p transit stops
26973 * @param transit The transit object.
26974 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26975 * ignored otherwise.
26979 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26982 * Get the value of event enabled status.
26984 * @see elm_transit_event_enabled_set()
26986 * @param transit The Transit object
26987 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26988 * EINA_FALSE is returned
26992 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26995 * Set the user-callback function when the transit is deleted.
26997 * @note Using this function twice will overwrite the first function setted.
26998 * @note the @p transit object will be deleted after call @p cb function.
27000 * @param transit The transit object.
27001 * @param cb Callback function pointer. This function will be called before
27002 * the deletion of the transit.
27003 * @param data Callback funtion user data. It is the @p op parameter.
27007 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27010 * Set reverse effect automatically.
27012 * If auto reverse is setted, after running the effects with the progress
27013 * parameter from 0 to 1, it will call the effecs again with the progress
27014 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27015 * where the duration was setted with the function elm_transit_add and
27016 * the repeat with the function elm_transit_repeat_times_set().
27018 * @param transit The transit object.
27019 * @param reverse EINA_TRUE means the auto_reverse is on.
27023 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27026 * Get if the auto reverse is on.
27028 * @see elm_transit_auto_reverse_set()
27030 * @param transit The transit object.
27031 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27032 * EINA_FALSE is returned
27036 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27039 * Set the transit repeat count. Effect will be repeated by repeat count.
27041 * This function sets the number of repetition the transit will run after
27042 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27043 * If the @p repeat is a negative number, it will repeat infinite times.
27045 * @note If this function is called during the transit execution, the transit
27046 * will run @p repeat times, ignoring the times it already performed.
27048 * @param transit The transit object
27049 * @param repeat Repeat count
27053 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27056 * Get the transit repeat count.
27058 * @see elm_transit_repeat_times_set()
27060 * @param transit The Transit object.
27061 * @return The repeat count. If @p transit is NULL
27066 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27069 * Set the transit animation acceleration type.
27071 * This function sets the tween mode of the transit that can be:
27072 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27073 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27074 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27075 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27077 * @param transit The transit object.
27078 * @param tween_mode The tween type.
27082 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27085 * Get the transit animation acceleration type.
27087 * @note @p transit can not be NULL
27089 * @param transit The transit object.
27090 * @return The tween type. If @p transit is NULL
27091 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27095 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27098 * Set the transit animation time
27100 * @note @p transit can not be NULL
27102 * @param transit The transit object.
27103 * @param duration The animation time.
27107 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27110 * Get the transit animation time
27112 * @note @p transit can not be NULL
27114 * @param transit The transit object.
27116 * @return The transit animation time.
27120 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27123 * Starts the transition.
27124 * Once this API is called, the transit begins to measure the time.
27126 * @note @p transit can not be NULL
27128 * @param transit The transit object.
27132 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27135 * Pause/Resume the transition.
27137 * If you call elm_transit_go again, the transit will be started from the
27138 * beginning, and will be unpaused.
27140 * @note @p transit can not be NULL
27142 * @param transit The transit object.
27143 * @param paused Whether the transition should be paused or not.
27147 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27150 * Get the value of paused status.
27152 * @see elm_transit_paused_set()
27154 * @note @p transit can not be NULL
27156 * @param transit The transit object.
27157 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27158 * EINA_FALSE is returned
27162 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27165 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27167 * The value returned is a fraction (current time / total time). It
27168 * represents the progression position relative to the total.
27170 * @note @p transit can not be NULL
27172 * @param transit The transit object.
27174 * @return The time progression value. If @p transit is NULL
27179 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27182 * Makes the chain relationship between two transits.
27184 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27185 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27187 * @param transit The transit object.
27188 * @param chain_transit The chain transit object. This transit will be operated
27189 * after transit is done.
27191 * This function adds @p chain_transit transition to a chain after the @p
27192 * transit, and will be started as soon as @p transit ends. See @ref
27193 * transit_example_02_explained for a full example.
27197 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27200 * Cut off the chain relationship between two transits.
27202 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27203 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27205 * @param transit The transit object.
27206 * @param chain_transit The chain transit object.
27208 * This function remove the @p chain_transit transition from the @p transit.
27212 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27215 * Get the current chain transit list.
27217 * @note @p transit can not be NULL.
27219 * @param transit The transit object.
27220 * @return chain transit list.
27224 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27227 * Add the Resizing Effect to Elm_Transit.
27229 * @note This API is one of the facades. It creates resizing effect context
27230 * and add it's required APIs to elm_transit_effect_add.
27232 * @see elm_transit_effect_add()
27234 * @param transit Transit object.
27235 * @param from_w Object width size when effect begins.
27236 * @param from_h Object height size when effect begins.
27237 * @param to_w Object width size when effect ends.
27238 * @param to_h Object height size when effect ends.
27239 * @return Resizing effect context data.
27243 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);
27246 * Add the Translation Effect to Elm_Transit.
27248 * @note This API is one of the facades. It creates translation effect context
27249 * and add it's required APIs to elm_transit_effect_add.
27251 * @see elm_transit_effect_add()
27253 * @param transit Transit object.
27254 * @param from_dx X Position variation when effect begins.
27255 * @param from_dy Y Position variation when effect begins.
27256 * @param to_dx X Position variation when effect ends.
27257 * @param to_dy Y Position variation when effect ends.
27258 * @return Translation effect context data.
27261 * @warning It is highly recommended just create a transit with this effect when
27262 * the window that the objects of the transit belongs has already been created.
27263 * This is because this effect needs the geometry information about the objects,
27264 * and if the window was not created yet, it can get a wrong information.
27266 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);
27269 * Add the Zoom Effect to Elm_Transit.
27271 * @note This API is one of the facades. It creates zoom effect context
27272 * and add it's required APIs to elm_transit_effect_add.
27274 * @see elm_transit_effect_add()
27276 * @param transit Transit object.
27277 * @param from_rate Scale rate when effect begins (1 is current rate).
27278 * @param to_rate Scale rate when effect ends.
27279 * @return Zoom effect context data.
27282 * @warning It is highly recommended just create a transit with this effect when
27283 * the window that the objects of the transit belongs has already been created.
27284 * This is because this effect needs the geometry information about the objects,
27285 * and if the window was not created yet, it can get a wrong information.
27287 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27290 * Add the Flip Effect to Elm_Transit.
27292 * @note This API is one of the facades. It creates flip effect context
27293 * and add it's required APIs to elm_transit_effect_add.
27294 * @note This effect is applied to each pair of objects in the order they are listed
27295 * in the transit list of objects. The first object in the pair will be the
27296 * "front" object and the second will be the "back" object.
27298 * @see elm_transit_effect_add()
27300 * @param transit Transit object.
27301 * @param axis Flipping Axis(X or Y).
27302 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27303 * @return Flip effect context data.
27306 * @warning It is highly recommended just create a transit with this effect when
27307 * the window that the objects of the transit belongs has already been created.
27308 * This is because this effect needs the geometry information about the objects,
27309 * and if the window was not created yet, it can get a wrong information.
27311 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27314 * Add the Resizable Flip Effect to Elm_Transit.
27316 * @note This API is one of the facades. It creates resizable flip effect context
27317 * and add it's required APIs to elm_transit_effect_add.
27318 * @note This effect is applied to each pair of objects in the order they are listed
27319 * in the transit list of objects. The first object in the pair will be the
27320 * "front" object and the second will be the "back" object.
27322 * @see elm_transit_effect_add()
27324 * @param transit Transit object.
27325 * @param axis Flipping Axis(X or Y).
27326 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27327 * @return Resizable flip effect context data.
27330 * @warning It is highly recommended just create a transit with this effect when
27331 * the window that the objects of the transit belongs has already been created.
27332 * This is because this effect needs the geometry information about the objects,
27333 * and if the window was not created yet, it can get a wrong information.
27335 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27338 * Add the Wipe Effect to Elm_Transit.
27340 * @note This API is one of the facades. It creates wipe effect context
27341 * and add it's required APIs to elm_transit_effect_add.
27343 * @see elm_transit_effect_add()
27345 * @param transit Transit object.
27346 * @param type Wipe type. Hide or show.
27347 * @param dir Wipe Direction.
27348 * @return Wipe effect context data.
27351 * @warning It is highly recommended just create a transit with this effect when
27352 * the window that the objects of the transit belongs has already been created.
27353 * This is because this effect needs the geometry information about the objects,
27354 * and if the window was not created yet, it can get a wrong information.
27356 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27359 * Add the Color Effect to Elm_Transit.
27361 * @note This API is one of the facades. It creates color effect context
27362 * and add it's required APIs to elm_transit_effect_add.
27364 * @see elm_transit_effect_add()
27366 * @param transit Transit object.
27367 * @param from_r RGB R when effect begins.
27368 * @param from_g RGB G when effect begins.
27369 * @param from_b RGB B when effect begins.
27370 * @param from_a RGB A when effect begins.
27371 * @param to_r RGB R when effect ends.
27372 * @param to_g RGB G when effect ends.
27373 * @param to_b RGB B when effect ends.
27374 * @param to_a RGB A when effect ends.
27375 * @return Color effect context data.
27379 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);
27382 * Add the Fade Effect to Elm_Transit.
27384 * @note This API is one of the facades. It creates fade effect context
27385 * and add it's required APIs to elm_transit_effect_add.
27386 * @note This effect is applied to each pair of objects in the order they are listed
27387 * in the transit list of objects. The first object in the pair will be the
27388 * "before" object and the second will be the "after" object.
27390 * @see elm_transit_effect_add()
27392 * @param transit Transit object.
27393 * @return Fade effect context data.
27396 * @warning It is highly recommended just create a transit with this effect when
27397 * the window that the objects of the transit belongs has already been created.
27398 * This is because this effect needs the color information about the objects,
27399 * and if the window was not created yet, it can get a wrong information.
27401 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27404 * Add the Blend Effect to Elm_Transit.
27406 * @note This API is one of the facades. It creates blend effect context
27407 * and add it's required APIs to elm_transit_effect_add.
27408 * @note This effect is applied to each pair of objects in the order they are listed
27409 * in the transit list of objects. The first object in the pair will be the
27410 * "before" object and the second will be the "after" object.
27412 * @see elm_transit_effect_add()
27414 * @param transit Transit object.
27415 * @return Blend effect context data.
27418 * @warning It is highly recommended just create a transit with this effect when
27419 * the window that the objects of the transit belongs has already been created.
27420 * This is because this effect needs the color information about the objects,
27421 * and if the window was not created yet, it can get a wrong information.
27423 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27426 * Add the Rotation Effect to Elm_Transit.
27428 * @note This API is one of the facades. It creates rotation effect context
27429 * and add it's required APIs to elm_transit_effect_add.
27431 * @see elm_transit_effect_add()
27433 * @param transit Transit object.
27434 * @param from_degree Degree when effect begins.
27435 * @param to_degree Degree when effect is ends.
27436 * @return Rotation effect context data.
27439 * @warning It is highly recommended just create a transit with this effect when
27440 * the window that the objects of the transit belongs has already been created.
27441 * This is because this effect needs the geometry information about the objects,
27442 * and if the window was not created yet, it can get a wrong information.
27444 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27447 * Add the ImageAnimation Effect to Elm_Transit.
27449 * @note This API is one of the facades. It creates image animation effect context
27450 * and add it's required APIs to elm_transit_effect_add.
27451 * The @p images parameter is a list images paths. This list and
27452 * its contents will be deleted at the end of the effect by
27453 * elm_transit_effect_image_animation_context_free() function.
27457 * char buf[PATH_MAX];
27458 * Eina_List *images = NULL;
27459 * Elm_Transit *transi = elm_transit_add();
27461 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27462 * images = eina_list_append(images, eina_stringshare_add(buf));
27464 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27465 * images = eina_list_append(images, eina_stringshare_add(buf));
27466 * elm_transit_effect_image_animation_add(transi, images);
27470 * @see elm_transit_effect_add()
27472 * @param transit Transit object.
27473 * @param images Eina_List of images file paths. This list and
27474 * its contents will be deleted at the end of the effect by
27475 * elm_transit_effect_image_animation_context_free() function.
27476 * @return Image Animation effect context data.
27480 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27486 typedef struct _Elm_Store Elm_Store;
27487 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27488 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27489 typedef struct _Elm_Store_Item Elm_Store_Item;
27490 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27491 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27492 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27493 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27494 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27495 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27496 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27497 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27498 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27500 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27501 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27502 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27503 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27504 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27505 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27506 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27510 ELM_STORE_ITEM_MAPPING_NONE = 0,
27511 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27512 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27513 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27514 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27515 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27516 // can add more here as needed by common apps
27517 ELM_STORE_ITEM_MAPPING_LAST
27518 } Elm_Store_Item_Mapping_Type;
27520 struct _Elm_Store_Item_Mapping_Icon
27522 // FIXME: allow edje file icons
27524 Elm_Icon_Lookup_Order lookup_order;
27525 Eina_Bool standard_name : 1;
27526 Eina_Bool no_scale : 1;
27527 Eina_Bool smooth : 1;
27528 Eina_Bool scale_up : 1;
27529 Eina_Bool scale_down : 1;
27532 struct _Elm_Store_Item_Mapping_Empty
27537 struct _Elm_Store_Item_Mapping_Photo
27542 struct _Elm_Store_Item_Mapping_Custom
27544 Elm_Store_Item_Mapping_Cb func;
27547 struct _Elm_Store_Item_Mapping
27549 Elm_Store_Item_Mapping_Type type;
27554 Elm_Store_Item_Mapping_Empty empty;
27555 Elm_Store_Item_Mapping_Icon icon;
27556 Elm_Store_Item_Mapping_Photo photo;
27557 Elm_Store_Item_Mapping_Custom custom;
27558 // add more types here
27562 struct _Elm_Store_Item_Info
27567 Eina_Bool rec_item;
27568 int pre_group_index;
27570 Elm_Genlist_Item_Class *item_class;
27571 const Elm_Store_Item_Mapping *mapping;
27576 struct _Elm_Store_Item_Info_Filesystem
27578 Elm_Store_Item_Info base;
27582 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27583 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27585 EAPI Elm_Store *elm_store_dbsystem_new(void);
27586 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27587 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27588 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27589 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27590 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27591 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27592 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27593 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27594 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27595 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27596 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27597 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27598 EAPI void elm_store_free(Elm_Store *st);
27599 EAPI Elm_Store *elm_store_filesystem_new(void);
27600 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27601 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27602 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27604 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27606 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27607 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27608 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27609 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27610 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27611 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27613 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27614 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27615 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27616 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27617 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27618 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27619 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27622 * @defgroup SegmentControl SegmentControl
27623 * @ingroup Elementary
27625 * @image html img/widget/segment_control/preview-00.png
27626 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27628 * @image html img/segment_control.png
27629 * @image latex img/segment_control.eps width=\textwidth
27631 * Segment control widget is a horizontal control made of multiple segment
27632 * items, each segment item functioning similar to discrete two state button.
27633 * A segment control groups the items together and provides compact
27634 * single button with multiple equal size segments.
27636 * Segment item size is determined by base widget
27637 * size and the number of items added.
27638 * Only one segment item can be at selected state. A segment item can display
27639 * combination of Text and any Evas_Object like Images or other widget.
27641 * Smart callbacks one can listen to:
27642 * - "changed" - When the user clicks on a segment item which is not
27643 * previously selected and get selected. The event_info parameter is the
27644 * segment item pointer.
27646 * Available styles for it:
27649 * Here is an example on its usage:
27650 * @li @ref segment_control_example
27654 * @addtogroup SegmentControl
27658 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27661 * Add a new segment control widget to the given parent Elementary
27662 * (container) object.
27664 * @param parent The parent object.
27665 * @return a new segment control widget handle or @c NULL, on errors.
27667 * This function inserts a new segment control widget on the canvas.
27669 * @ingroup SegmentControl
27671 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27674 * Append a new item to the segment control object.
27676 * @param obj The segment control object.
27677 * @param icon The icon object to use for the left side of the item. An
27678 * icon can be any Evas object, but usually it is an icon created
27679 * with elm_icon_add().
27680 * @param label The label of the item.
27681 * Note that, NULL is different from empty string "".
27682 * @return The created item or @c NULL upon failure.
27684 * A new item will be created and appended to the segment control, i.e., will
27685 * be set as @b last item.
27687 * If it should be inserted at another position,
27688 * elm_segment_control_item_insert_at() should be used instead.
27690 * Items created with this function can be deleted with function
27691 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27693 * @note @p label set to @c NULL is different from empty string "".
27695 * only has icon, it will be displayed bigger and centered. If it has
27696 * icon and label, even that an empty string, icon will be smaller and
27697 * positioned at left.
27701 * sc = elm_segment_control_add(win);
27702 * ic = elm_icon_add(win);
27703 * elm_icon_file_set(ic, "path/to/image", NULL);
27704 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27705 * elm_segment_control_item_add(sc, ic, "label");
27706 * evas_object_show(sc);
27709 * @see elm_segment_control_item_insert_at()
27710 * @see elm_segment_control_item_del()
27712 * @ingroup SegmentControl
27714 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27717 * Insert a new item to the segment control object at specified position.
27719 * @param obj The segment control object.
27720 * @param icon The icon object to use for the left side of the item. An
27721 * icon can be any Evas object, but usually it is an icon created
27722 * with elm_icon_add().
27723 * @param label The label of the item.
27724 * @param index Item position. Value should be between 0 and items count.
27725 * @return The created item or @c NULL upon failure.
27727 * Index values must be between @c 0, when item will be prepended to
27728 * segment control, and items count, that can be get with
27729 * elm_segment_control_item_count_get(), case when item will be appended
27730 * to segment control, just like elm_segment_control_item_add().
27732 * Items created with this function can be deleted with function
27733 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27735 * @note @p label set to @c NULL is different from empty string "".
27737 * only has icon, it will be displayed bigger and centered. If it has
27738 * icon and label, even that an empty string, icon will be smaller and
27739 * positioned at left.
27741 * @see elm_segment_control_item_add()
27742 * @see elm_segment_control_item_count_get()
27743 * @see elm_segment_control_item_del()
27745 * @ingroup SegmentControl
27747 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);
27750 * Remove a segment control item from its parent, deleting it.
27752 * @param it The item to be removed.
27754 * Items can be added with elm_segment_control_item_add() or
27755 * elm_segment_control_item_insert_at().
27757 * @ingroup SegmentControl
27759 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27762 * Remove a segment control item at given index from its parent,
27765 * @param obj The segment control object.
27766 * @param index The position of the segment control item to be deleted.
27768 * Items can be added with elm_segment_control_item_add() or
27769 * elm_segment_control_item_insert_at().
27771 * @ingroup SegmentControl
27773 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27776 * Get the Segment items count from segment control.
27778 * @param obj The segment control object.
27779 * @return Segment items count.
27781 * It will just return the number of items added to segment control @p obj.
27783 * @ingroup SegmentControl
27785 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27788 * Get the item placed at specified index.
27790 * @param obj The segment control object.
27791 * @param index The index of the segment item.
27792 * @return The segment control item or @c NULL on failure.
27794 * Index is the position of an item in segment control widget. Its
27795 * range is from @c 0 to <tt> count - 1 </tt>.
27796 * Count is the number of items, that can be get with
27797 * elm_segment_control_item_count_get().
27799 * @ingroup SegmentControl
27801 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27804 * Get the label of item.
27806 * @param obj The segment control object.
27807 * @param index The index of the segment item.
27808 * @return The label of the item at @p index.
27810 * The return value is a pointer to the label associated to the item when
27811 * it was created, with function elm_segment_control_item_add(), or later
27812 * with function elm_segment_control_item_label_set. If no label
27813 * was passed as argument, it will return @c NULL.
27815 * @see elm_segment_control_item_label_set() for more details.
27816 * @see elm_segment_control_item_add()
27818 * @ingroup SegmentControl
27820 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27823 * Set the label of item.
27825 * @param it The item of segment control.
27826 * @param text The label of item.
27828 * The label to be displayed by the item.
27829 * Label will be at right of the icon (if set).
27831 * If a label was passed as argument on item creation, with function
27832 * elm_control_segment_item_add(), it will be already
27833 * displayed by the item.
27835 * @see elm_segment_control_item_label_get()
27836 * @see elm_segment_control_item_add()
27838 * @ingroup SegmentControl
27840 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27843 * Get the icon associated to the item.
27845 * @param obj The segment control object.
27846 * @param index The index of the segment item.
27847 * @return The left side icon associated to the item at @p index.
27849 * The return value is a pointer to the icon associated to the item when
27850 * it was created, with function elm_segment_control_item_add(), or later
27851 * with function elm_segment_control_item_icon_set(). If no icon
27852 * was passed as argument, it will return @c NULL.
27854 * @see elm_segment_control_item_add()
27855 * @see elm_segment_control_item_icon_set()
27857 * @ingroup SegmentControl
27859 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27862 * Set the icon associated to the item.
27864 * @param it The segment control item.
27865 * @param icon The icon object to associate with @p it.
27867 * The icon object to use at left side of the item. An
27868 * icon can be any Evas object, but usually it is an icon created
27869 * with elm_icon_add().
27871 * Once the icon object is set, a previously set one will be deleted.
27872 * @warning Setting the same icon for two items will cause the icon to
27873 * dissapear from the first item.
27875 * If an icon was passed as argument on item creation, with function
27876 * elm_segment_control_item_add(), it will be already
27877 * associated to the item.
27879 * @see elm_segment_control_item_add()
27880 * @see elm_segment_control_item_icon_get()
27882 * @ingroup SegmentControl
27884 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27887 * Get the index of an item.
27889 * @param it The segment control item.
27890 * @return The position of item in segment control widget.
27892 * Index is the position of an item in segment control widget. Its
27893 * range is from @c 0 to <tt> count - 1 </tt>.
27894 * Count is the number of items, that can be get with
27895 * elm_segment_control_item_count_get().
27897 * @ingroup SegmentControl
27899 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27902 * Get the base object of the item.
27904 * @param it The segment control item.
27905 * @return The base object associated with @p it.
27907 * Base object is the @c Evas_Object that represents that item.
27909 * @ingroup SegmentControl
27911 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27914 * Get the selected item.
27916 * @param obj The segment control object.
27917 * @return The selected item or @c NULL if none of segment items is
27920 * The selected item can be unselected with function
27921 * elm_segment_control_item_selected_set().
27923 * The selected item always will be highlighted on segment control.
27925 * @ingroup SegmentControl
27927 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27930 * Set the selected state of an item.
27932 * @param it The segment control item
27933 * @param select The selected state
27935 * This sets the selected state of the given item @p it.
27936 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27938 * If a new item is selected the previosly selected will be unselected.
27939 * Previoulsy selected item can be get with function
27940 * elm_segment_control_item_selected_get().
27942 * The selected item always will be highlighted on segment control.
27944 * @see elm_segment_control_item_selected_get()
27946 * @ingroup SegmentControl
27948 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27955 * @defgroup Grid Grid
27957 * The grid is a grid layout widget that lays out a series of children as a
27958 * fixed "grid" of widgets using a given percentage of the grid width and
27959 * height each using the child object.
27961 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27962 * widgets size itself. The default is 100 x 100, so that means the
27963 * position and sizes of children will effectively be percentages (0 to 100)
27964 * of the width or height of the grid widget
27970 * Add a new grid to the parent
27972 * @param parent The parent object
27973 * @return The new object or NULL if it cannot be created
27977 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27980 * Set the virtual size of the grid
27982 * @param obj The grid object
27983 * @param w The virtual width of the grid
27984 * @param h The virtual height of the grid
27988 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27991 * Get the virtual size of the grid
27993 * @param obj The grid object
27994 * @param w Pointer to integer to store the virtual width of the grid
27995 * @param h Pointer to integer to store the virtual height of the grid
27999 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28002 * Pack child at given position and size
28004 * @param obj The grid object
28005 * @param subobj The child to pack
28006 * @param x The virtual x coord at which to pack it
28007 * @param y The virtual y coord at which to pack it
28008 * @param w The virtual width at which to pack it
28009 * @param h The virtual height at which to pack it
28013 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28016 * Unpack a child from a grid object
28018 * @param obj The grid object
28019 * @param subobj The child to unpack
28023 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28026 * Faster way to remove all child objects from a grid object.
28028 * @param obj The grid object
28029 * @param clear If true, it will delete just removed children
28033 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28036 * Set packing of an existing child at to position and size
28038 * @param subobj The child to set packing of
28039 * @param x The virtual x coord at which to pack it
28040 * @param y The virtual y coord at which to pack it
28041 * @param w The virtual width at which to pack it
28042 * @param h The virtual height at which to pack it
28046 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28049 * get packing of a child
28051 * @param subobj The child to query
28052 * @param x Pointer to integer to store the virtual x coord
28053 * @param y Pointer to integer to store the virtual y coord
28054 * @param w Pointer to integer to store the virtual width
28055 * @param h Pointer to integer to store the virtual height
28059 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28065 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28066 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28067 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28068 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28069 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28070 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28073 * @defgroup Video Video
28075 * @addtogroup Video
28078 * Elementary comes with two object that help design application that need
28079 * to display video. The main one, Elm_Video, display a video by using Emotion.
28080 * It does embedded the video inside an Edje object, so you can do some
28081 * animation depending on the video state change. It does also implement a
28082 * ressource management policy to remove this burden from the application writer.
28084 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28085 * It take care of updating its content according to Emotion event and provide a
28086 * way to theme itself. It also does automatically raise the priority of the
28087 * linked Elm_Video so it will use the video decoder if available. It also does
28088 * activate the remember function on the linked Elm_Video object.
28090 * Signals that you can add callback for are :
28092 * "forward,clicked" - the user clicked the forward button.
28093 * "info,clicked" - the user clicked the info button.
28094 * "next,clicked" - the user clicked the next button.
28095 * "pause,clicked" - the user clicked the pause button.
28096 * "play,clicked" - the user clicked the play button.
28097 * "prev,clicked" - the user clicked the prev button.
28098 * "rewind,clicked" - the user clicked the rewind button.
28099 * "stop,clicked" - the user clicked the stop button.
28101 * Default contents parts of the player widget that you can use for are:
28102 * @li "video" - A video of the player
28107 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28109 * @param parent The parent object
28110 * @return a new player widget handle or @c NULL, on errors.
28112 * This function inserts a new player widget on the canvas.
28114 * @see elm_object_content_part_set()
28118 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28121 * @brief Link a Elm_Payer with an Elm_Video object.
28123 * @param player the Elm_Player object.
28124 * @param video The Elm_Video object.
28126 * This mean that action on the player widget will affect the
28127 * video object and the state of the video will be reflected in
28128 * the player itself.
28130 * @see elm_player_add()
28131 * @see elm_video_add()
28132 * @deprecated use elm_object_content_part_set() instead
28136 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28139 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28141 * @param parent The parent object
28142 * @return a new video widget handle or @c NULL, on errors.
28144 * This function inserts a new video widget on the canvas.
28146 * @seeelm_video_file_set()
28147 * @see elm_video_uri_set()
28151 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28154 * @brief Define the file that will be the video source.
28156 * @param video The video object to define the file for.
28157 * @param filename The file to target.
28159 * This function will explicitly define a filename as a source
28160 * for the video of the Elm_Video object.
28162 * @see elm_video_uri_set()
28163 * @see elm_video_add()
28164 * @see elm_player_add()
28168 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28171 * @brief Define the uri that will be the video source.
28173 * @param video The video object to define the file for.
28174 * @param uri The uri to target.
28176 * This function will define an uri as a source for the video of the
28177 * Elm_Video object. URI could be remote source of video, like http:// or local source
28178 * like for example WebCam who are most of the time v4l2:// (but that depend and
28179 * you should use Emotion API to request and list the available Webcam on your system).
28181 * @see elm_video_file_set()
28182 * @see elm_video_add()
28183 * @see elm_player_add()
28187 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28190 * @brief Get the underlying Emotion object.
28192 * @param video The video object to proceed the request on.
28193 * @return the underlying Emotion object.
28197 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28200 * @brief Start to play the video
28202 * @param video The video object to proceed the request on.
28204 * Start to play the video and cancel all suspend state.
28208 EAPI void elm_video_play(Evas_Object *video);
28211 * @brief Pause the video
28213 * @param video The video object to proceed the request on.
28215 * Pause the video and start a timer to trigger suspend mode.
28219 EAPI void elm_video_pause(Evas_Object *video);
28222 * @brief Stop the video
28224 * @param video The video object to proceed the request on.
28226 * Stop the video and put the emotion in deep sleep mode.
28230 EAPI void elm_video_stop(Evas_Object *video);
28233 * @brief Is the video actually playing.
28235 * @param video The video object to proceed the request on.
28236 * @return EINA_TRUE if the video is actually playing.
28238 * You should consider watching event on the object instead of polling
28239 * the object state.
28243 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28246 * @brief Is it possible to seek inside the video.
28248 * @param video The video object to proceed the request on.
28249 * @return EINA_TRUE if is possible to seek inside the video.
28253 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28256 * @brief Is the audio muted.
28258 * @param video The video object to proceed the request on.
28259 * @return EINA_TRUE if the audio is muted.
28263 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28266 * @brief Change the mute state of the Elm_Video object.
28268 * @param video The video object to proceed the request on.
28269 * @param mute The new mute state.
28273 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28276 * @brief Get the audio level of the current video.
28278 * @param video The video object to proceed the request on.
28279 * @return the current audio level.
28283 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28286 * @brief Set the audio level of anElm_Video object.
28288 * @param video The video object to proceed the request on.
28289 * @param volume The new audio volume.
28293 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28295 EAPI double elm_video_play_position_get(const Evas_Object *video);
28296 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28297 EAPI double elm_video_play_length_get(const Evas_Object *video);
28298 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28299 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28300 EAPI const char *elm_video_title_get(const Evas_Object *video);
28305 // FIXME: incomplete - carousel. don't use this until this comment is removed
28306 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28307 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28308 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28309 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28310 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28311 /* smart callbacks called:
28312 * "clicked" - when the user clicks on a carousel item and becomes selected
28317 typedef enum _Elm_Datefield_ItemType
28319 ELM_DATEFIELD_YEAR = 0,
28320 ELM_DATEFIELD_MONTH,
28321 ELM_DATEFIELD_DATE,
28322 ELM_DATEFIELD_HOUR,
28323 ELM_DATEFIELD_MINUTE,
28325 } Elm_Datefield_ItemType;
28327 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28328 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28329 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28330 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28331 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28332 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28333 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28334 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28335 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28336 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28337 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28338 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28339 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28341 /* smart callbacks called:
28342 * "changed" - when datefield value is changed, this signal is sent.
28345 ////////////////////// DEPRECATED ///////////////////////////////////
28347 typedef enum _Elm_Datefield_Layout
28349 ELM_DATEFIELD_LAYOUT_TIME,
28350 ELM_DATEFIELD_LAYOUT_DATE,
28351 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28352 } Elm_Datefield_Layout;
28354 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28355 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28356 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28357 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28358 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28359 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28360 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28361 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28362 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28363 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28364 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28365 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28366 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
28367 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28368 /////////////////////////////////////////////////////////////////////
28371 typedef enum _Elm_Popup_Response
28373 ELM_POPUP_RESPONSE_NONE = -1,
28374 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28375 ELM_POPUP_RESPONSE_OK = -3,
28376 ELM_POPUP_RESPONSE_CANCEL = -4,
28377 ELM_POPUP_RESPONSE_CLOSE = -5
28378 } Elm_Popup_Response;
28380 typedef enum _Elm_Popup_Mode
28382 ELM_POPUP_TYPE_NONE = 0,
28383 ELM_POPUP_TYPE_ALERT = (1 << 0)
28386 typedef enum _Elm_Popup_Orient
28388 ELM_POPUP_ORIENT_TOP,
28389 ELM_POPUP_ORIENT_CENTER,
28390 ELM_POPUP_ORIENT_BOTTOM,
28391 ELM_POPUP_ORIENT_LEFT,
28392 ELM_POPUP_ORIENT_RIGHT,
28393 ELM_POPUP_ORIENT_TOP_LEFT,
28394 ELM_POPUP_ORIENT_TOP_RIGHT,
28395 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28396 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28397 } Elm_Popup_Orient;
28399 /* smart callbacks called:
28400 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28403 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28404 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28405 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28406 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28407 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28408 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28409 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28410 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28411 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28412 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28413 EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
28414 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28415 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28416 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28417 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28418 EAPI int elm_popup_run(Evas_Object *obj);
28420 /* NavigationBar */
28421 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28422 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28426 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28427 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28428 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28429 ELM_NAVIGATIONBAR_BACK_BUTTON
28430 } Elm_Navi_Button_Type;
28432 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28433 EINA_DEPRECATED EAPI void elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
28434 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28435 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28436 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28437 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28438 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28439 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28440 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28441 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28442 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28443 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28444 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28445 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28446 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28447 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28448 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28449 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28450 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28451 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28452 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28453 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28455 /* NavigationBar */
28456 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28457 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28461 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28462 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28463 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28464 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28465 ELM_NAVIGATIONBAR_EX_MAX
28466 } Elm_Navi_ex_Button_Type;
28467 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28469 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28470 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28471 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28472 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28473 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28474 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28475 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28476 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28477 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28478 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
28479 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28480 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28481 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28482 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28483 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28484 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28485 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28486 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28487 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28488 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28489 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28490 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28491 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28492 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28493 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28494 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28495 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28496 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28499 * @defgroup Naviframe Naviframe
28500 * @ingroup Elementary
28502 * @brief Naviframe is a kind of view manager for the applications.
28504 * Naviframe provides functions to switch different pages with stack
28505 * mechanism. It means if one page(item) needs to be changed to the new one,
28506 * then naviframe would push the new page to it's internal stack. Of course,
28507 * it can be back to the previous page by popping the top page. Naviframe
28508 * provides some transition effect while the pages are switching (same as
28511 * Since each item could keep the different styles, users could keep the
28512 * same look & feel for the pages or different styles for the items in it's
28515 * Signals that you can add callback for are:
28516 * @li "transition,finished" - When the transition is finished in changing
28518 * @li "title,clicked" - User clicked title area
28520 * Default contents parts of the naviframe items that you can use for are:
28521 * @li "default" - A main content of the page
28522 * @li "icon" - A icon in the title area
28523 * @li "prev_btn" - A button to go to the previous page
28524 * @li "next_btn" - A button to go to the next page
28526 * Default text parts of the naviframe items that you can use for are:
28527 * @li "default" - Title label in the title area
28528 * @li "subtitle" - Sub-title label in the title area
28530 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28533 //Available commonly
28534 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28535 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28536 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28537 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28538 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28539 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28540 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28541 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28542 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28543 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28544 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28545 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28546 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28547 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28548 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28549 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28550 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28552 //Available only in a style - "2line"
28553 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28555 //Available only in a style - "segment"
28556 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28557 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28560 * @addtogroup Naviframe
28565 * @brief Add a new Naviframe object to the parent.
28567 * @param parent Parent object
28568 * @return New object or @c NULL, if it cannot be created
28570 * @ingroup Naviframe
28572 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28574 * @brief Push a new item to the top of the naviframe stack (and show it).
28576 * @param obj The naviframe object
28577 * @param title_label The label in the title area. The name of the title
28578 * label part is "elm.text.title"
28579 * @param prev_btn The button to go to the previous item. If it is NULL,
28580 * then naviframe will create a back button automatically. The name of
28581 * the prev_btn part is "elm.swallow.prev_btn"
28582 * @param next_btn The button to go to the next item. Or It could be just an
28583 * extra function button. The name of the next_btn part is
28584 * "elm.swallow.next_btn"
28585 * @param content The main content object. The name of content part is
28586 * "elm.swallow.content"
28587 * @param item_style The current item style name. @c NULL would be default.
28588 * @return The created item or @c NULL upon failure.
28590 * The item pushed becomes one page of the naviframe, this item will be
28591 * deleted when it is popped.
28593 * @see also elm_naviframe_item_style_set()
28594 * @see also elm_naviframe_item_insert_before()
28595 * @see also elm_naviframe_item_insert_after()
28597 * The following styles are available for this item:
28600 * @ingroup Naviframe
28602 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);
28604 * @brief Insert a new item into the naviframe before item @p before.
28606 * @param before The naviframe item to insert before.
28607 * @param title_label The label in the title area. The name of the title
28608 * label part is "elm.text.title"
28609 * @param prev_btn The button to go to the previous item. If it is NULL,
28610 * then naviframe will create a back button automatically. The name of
28611 * the prev_btn part is "elm.swallow.prev_btn"
28612 * @param next_btn The button to go to the next item. Or It could be just an
28613 * extra function button. The name of the next_btn part is
28614 * "elm.swallow.next_btn"
28615 * @param content The main content object. The name of content part is
28616 * "elm.swallow.content"
28617 * @param item_style The current item style name. @c NULL would be default.
28618 * @return The created item or @c NULL upon failure.
28620 * The item is inserted into the naviframe straight away without any
28621 * transition operations. This item will be deleted when it is popped.
28623 * @see also elm_naviframe_item_style_set()
28624 * @see also elm_naviframe_item_push()
28625 * @see also elm_naviframe_item_insert_after()
28627 * The following styles are available for this item:
28630 * @ingroup Naviframe
28632 EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28634 * @brief Insert a new item into the naviframe after item @p after.
28636 * @param after The naviframe item to insert after.
28637 * @param title_label The label in the title area. The name of the title
28638 * label part is "elm.text.title"
28639 * @param prev_btn The button to go to the previous item. If it is NULL,
28640 * then naviframe will create a back button automatically. The name of
28641 * the prev_btn part is "elm.swallow.prev_btn"
28642 * @param next_btn The button to go to the next item. Or It could be just an
28643 * extra function button. The name of the next_btn part is
28644 * "elm.swallow.next_btn"
28645 * @param content The main content object. The name of content part is
28646 * "elm.swallow.content"
28647 * @param item_style The current item style name. @c NULL would be default.
28648 * @return The created item or @c NULL upon failure.
28650 * The item is inserted into the naviframe straight away without any
28651 * transition operations. This item will be deleted when it is popped.
28653 * @see also elm_naviframe_item_style_set()
28654 * @see also elm_naviframe_item_push()
28655 * @see also elm_naviframe_item_insert_before()
28657 * The following styles are available for this item:
28660 * @ingroup Naviframe
28662 EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28664 * @brief Pop an item that is on top of the stack
28666 * @param obj The naviframe object
28667 * @return @c NULL or the content object(if the
28668 * elm_naviframe_content_preserve_on_pop_get is true).
28670 * This pops an item that is on the top(visible) of the naviframe, makes it
28671 * disappear, then deletes the item. The item that was underneath it on the
28672 * stack will become visible.
28674 * @see also elm_naviframe_content_preserve_on_pop_get()
28676 * @ingroup Naviframe
28678 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28680 * @brief Pop the items between the top and the above one on the given item.
28682 * @param it The naviframe item
28684 * @ingroup Naviframe
28686 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28688 * Promote an item already in the naviframe stack to the top of the stack
28690 * @param it The naviframe item
28692 * This will take the indicated item and promote it to the top of the stack
28693 * as if it had been pushed there. The item must already be inside the
28694 * naviframe stack to work.
28697 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28699 * @brief Delete the given item instantly.
28701 * @param it The naviframe item
28703 * This just deletes the given item from the naviframe item list instantly.
28704 * So this would not emit any signals for view transitions but just change
28705 * the current view if the given item is a top one.
28707 * @ingroup Naviframe
28709 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28711 * @brief preserve the content objects when items are popped.
28713 * @param obj The naviframe object
28714 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28716 * @see also elm_naviframe_content_preserve_on_pop_get()
28718 * @ingroup Naviframe
28720 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28722 * @brief Get a value whether preserve mode is enabled or not.
28724 * @param obj The naviframe object
28725 * @return If @c EINA_TRUE, preserve mode is enabled
28727 * @see also elm_naviframe_content_preserve_on_pop_set()
28729 * @ingroup Naviframe
28731 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28733 * @brief Get a top item on the naviframe stack
28735 * @param obj The naviframe object
28736 * @return The top item on the naviframe stack or @c NULL, if the stack is
28739 * @ingroup Naviframe
28741 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28743 * @brief Get a bottom item on the naviframe stack
28745 * @param obj The naviframe object
28746 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28749 * @ingroup Naviframe
28751 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28753 * @brief Set an item style
28755 * @param obj The naviframe item
28756 * @param item_style The current item style name. @c NULL would be default
28758 * The following styles are available for this item:
28761 * @see also elm_naviframe_item_style_get()
28763 * @ingroup Naviframe
28765 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28767 * @brief Get an item style
28769 * @param obj The naviframe item
28770 * @return The current item style name
28772 * @see also elm_naviframe_item_style_set()
28774 * @ingroup Naviframe
28776 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28778 * @brief Show/Hide the title area
28780 * @param it The naviframe item
28781 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28784 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28786 * @see also elm_naviframe_item_title_visible_get()
28788 * @ingroup Naviframe
28790 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28792 * @brief Get a value whether title area is visible or not.
28794 * @param it The naviframe item
28795 * @return If @c EINA_TRUE, title area is visible
28797 * @see also elm_naviframe_item_title_visible_set()
28799 * @ingroup Naviframe
28801 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28804 * @brief Set creating prev button automatically or not
28806 * @param obj The naviframe object
28807 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28808 * be created internally when you pass the @c NULL to the prev_btn
28809 * parameter in elm_naviframe_item_push
28811 * @see also elm_naviframe_item_push()
28813 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28815 * @brief Get a value whether prev button(back button) will be auto pushed or
28818 * @param obj The naviframe object
28819 * @return If @c EINA_TRUE, prev button will be auto pushed.
28821 * @see also elm_naviframe_item_push()
28822 * elm_naviframe_prev_btn_auto_pushed_set()
28824 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28826 * @brief Get a list of all the naviframe items.
28828 * @param obj The naviframe object
28829 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28830 * or @c NULL on failure.
28832 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28839 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28840 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28841 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28842 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28843 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28844 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28845 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28846 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28847 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28849 typedef enum _Elm_Controlbar_Mode_Type
28851 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28852 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28853 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28854 ELM_CONTROLBAR_MODE_LARGE,
28855 ELM_CONTROLBAR_MODE_SMALL,
28856 ELM_CONTROLBAR_MODE_LEFT,
28857 ELM_CONTROLBAR_MODE_RIGHT
28858 } Elm_Controlbar_Mode_Type;
28860 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28861 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28862 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28863 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28864 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
28865 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
28866 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28867 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28868 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28869 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28870 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28871 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28872 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28873 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28874 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28875 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28876 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28877 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28878 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28879 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28880 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28881 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28882 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28883 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28884 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28885 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28886 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28887 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28888 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28889 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28890 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28891 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28892 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28893 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28894 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28895 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28896 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28897 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28898 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28901 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28902 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28903 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28904 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28905 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28906 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28907 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28908 EAPI void elm_searchbar_clear(Evas_Object *obj);
28909 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28911 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28912 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28913 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28914 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28917 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28918 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28919 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28920 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28921 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28926 ELM_TICKERNOTI_ORIENT_TOP = 0,
28927 ELM_TICKERNOTI_ORIENT_BOTTOM,
28928 ELM_TICKERNOTI_ORIENT_LAST
28929 } Elm_Tickernoti_Orient;
28931 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28932 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28933 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28934 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28935 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28936 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28937 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28940 ELM_TICKERNOTI_DEFAULT,
28941 ELM_TICKERNOTI_DETAILVIEW
28942 } Elm_Tickernoti_Mode;
28943 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28944 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28945 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28946 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28947 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28948 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28949 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28950 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28951 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28952 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28953 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28954 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28955 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28956 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28957 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28958 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28959 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28960 /* ############################################################################### */
28962 * Parts which can be used with elm_object_text_part_set() and
28963 * elm_object_text_part_get():
28965 * @li NULL/"default" - Operates on tickernoti content-text
28967 * Parts which can be used with elm_object_content_part_set(),
28968 * elm_object_content_part_get() and elm_object_content_part_unset():
28970 * @li "icon" - Operates on tickernoti's icon
28971 * @li "button" - Operates on tickernoti's button
28973 * smart callbacks called:
28974 * @li "clicked" - emitted when tickernoti is clicked, except at the
28975 * swallow/button region, if any.
28976 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
28977 * any hide animation, this signal is emitted after the animation.
28981 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
28983 struct _Colorpalette_Color
28985 unsigned int r, g, b;
28988 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
28989 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
28990 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
28991 /* smart callbacks called:
28992 * "clicked" - when image clicked
28996 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
28997 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
28998 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
28999 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29000 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29001 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29002 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29003 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29004 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29005 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29006 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29007 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29008 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29009 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29010 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29011 /* smart callbacks called:
29012 * "clicked" - when an editfield is clicked
29013 * "unfocused" - when an editfield is unfocused
29017 /* Sliding Drawer */
29018 typedef enum _Elm_SlidingDrawer_Pos
29020 ELM_SLIDINGDRAWER_BOTTOM,
29021 ELM_SLIDINGDRAWER_LEFT,
29022 ELM_SLIDINGDRAWER_RIGHT,
29023 ELM_SLIDINGDRAWER_TOP
29024 } Elm_SlidingDrawer_Pos;
29026 typedef struct _Elm_SlidingDrawer_Drag_Value
29029 } Elm_SlidingDrawer_Drag_Value;
29031 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29032 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29033 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29034 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29035 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
29036 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29038 /* multibuttonentry */
29039 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29040 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29041 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29042 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
29043 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29044 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29045 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29046 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29047 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29048 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29049 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29050 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29051 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29052 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29053 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
29054 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29055 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29056 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29057 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29058 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29059 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29060 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29061 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29062 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29063 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29064 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29065 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29066 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29067 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29068 /* smart callback called:
29069 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29070 * "added" - This signal is emitted when a new multibuttonentry item is added.
29071 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29072 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29073 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29074 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29075 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29076 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29077 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29078 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29079 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29080 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29082 /* available styles:
29087 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29088 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29089 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29090 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29091 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29092 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29093 /* smart callback called:
29094 * "expanded" - This signal is emitted when a stackedicon is expanded.
29095 * "clicked" - This signal is emitted when a stackedicon is clicked.
29097 /* available styles:
29101 /* dialoguegroup */
29102 typedef struct _Dialogue_Item Dialogue_Item;
29104 typedef enum _Elm_Dialoguegourp_Item_Style
29106 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29107 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29108 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29109 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29110 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29111 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29112 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29113 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29114 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29115 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29116 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29117 } Elm_Dialoguegroup_Item_Style;
29119 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29120 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29121 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29122 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29123 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29124 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29125 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29126 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29127 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29128 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29129 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29130 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29131 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29132 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29133 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29134 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29139 ELM_DAYSELECTOR_SUN,
29140 ELM_DAYSELECTOR_MON,
29141 ELM_DAYSELECTOR_TUE,
29142 ELM_DAYSELECTOR_WED,
29143 ELM_DAYSELECTOR_THU,
29144 ELM_DAYSELECTOR_FRI,
29145 ELM_DAYSELECTOR_SAT
29146 } Elm_DaySelector_Day;
29148 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29149 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29150 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29153 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29154 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29155 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29156 EAPI Elm_Imageslider_Item *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
29157 EAPI Elm_Imageslider_Item *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
29158 EAPI Elm_Imageslider_Item *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
29159 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29160 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29161 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29162 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29163 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29164 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29165 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29166 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29167 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29168 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29169 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);