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.
588 * @param tooltip The tooltip object (affix content to this!)
590 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
593 * Called back when a widget's item tooltip is activated and needs content.
594 * @param data user-data given to elm_object_tooltip_content_cb_set()
595 * @param obj owner widget.
596 * @param tooltip The tooltip object (affix content to this!)
597 * @param item context dependent item. As an example, if tooltip was
598 * set on Elm_List_Item, then it is of this type.
600 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
602 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
604 #ifndef ELM_LIB_QUICKLAUNCH
605 #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 */
607 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
610 /**************************************************************************/
614 * Initialize Elementary
616 * @param[in] argc System's argument count value
617 * @param[in] argv System's pointer to array of argument strings
618 * @return The init counter value.
620 * This function initializes Elementary and increments a counter of
621 * the number of calls to it. It returns the new counter's value.
623 * @warning This call is exported only for use by the @c ELM_MAIN()
624 * macro. There is no need to use this if you use this macro (which
625 * is highly advisable). An elm_main() should contain the entry
626 * point code for your application, having the same prototype as
627 * elm_init(), and @b not being static (putting the @c EAPI symbol
628 * in front of its type declaration is advisable). The @c
629 * ELM_MAIN() call should be placed just after it.
632 * @dontinclude bg_example_01.c
636 * See the full @ref bg_example_01_c "example".
638 * @see elm_shutdown().
641 EAPI int elm_init(int argc, char **argv);
644 * Shut down Elementary
646 * @return The init counter value.
648 * This should be called at the end of your application, just
649 * before it ceases to do any more processing. This will clean up
650 * any permanent resources your application may have allocated via
651 * Elementary that would otherwise persist.
653 * @see elm_init() for an example
657 EAPI int elm_shutdown(void);
660 * Run Elementary's main loop
662 * This call should be issued just after all initialization is
663 * completed. This function will not return until elm_exit() is
664 * called. It will keep looping, running the main
665 * (event/processing) loop for Elementary.
667 * @see elm_init() for an example
671 EAPI void elm_run(void);
674 * Exit Elementary's main loop
676 * If this call is issued, it will flag the main loop to cease
677 * processing and return back to its parent function (usually your
678 * elm_main() function).
680 * @see elm_init() for an example. There, just after a request to
681 * close the window comes, the main loop will be left.
683 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
684 * applications, you'll be able to get this function called automatically for you.
688 EAPI void elm_exit(void);
691 * Provide information in order to make Elementary determine the @b
692 * run time location of the software in question, so other data files
693 * such as images, sound files, executable utilities, libraries,
694 * modules and locale files can be found.
696 * @param mainfunc This is your application's main function name,
697 * whose binary's location is to be found. Providing @c NULL
698 * will make Elementary not to use it
699 * @param dom This will be used as the application's "domain", in the
700 * form of a prefix to any environment variables that may
701 * override prefix detection and the directory name, inside the
702 * standard share or data directories, where the software's
703 * data files will be looked for.
704 * @param checkfile This is an (optional) magic file's path to check
705 * for existence (and it must be located in the data directory,
706 * under the share directory provided above). Its presence will
707 * help determine the prefix found was correct. Pass @c NULL if
708 * the check is not to be done.
710 * This function allows one to re-locate the application somewhere
711 * else after compilation, if the developer wishes for easier
712 * distribution of pre-compiled binaries.
714 * The prefix system is designed to locate where the given software is
715 * installed (under a common path prefix) at run time and then report
716 * specific locations of this prefix and common directories inside
717 * this prefix like the binary, library, data and locale directories,
718 * through the @c elm_app_*_get() family of functions.
720 * Call elm_app_info_set() early on before you change working
721 * directory or anything about @c argv[0], so it gets accurate
724 * It will then try and trace back which file @p mainfunc comes from,
725 * if provided, to determine the application's prefix directory.
727 * The @p dom parameter provides a string prefix to prepend before
728 * environment variables, allowing a fallback to @b specific
729 * environment variables to locate the software. You would most
730 * probably provide a lowercase string there, because it will also
731 * serve as directory domain, explained next. For environment
732 * variables purposes, this string is made uppercase. For example if
733 * @c "myapp" is provided as the prefix, then the program would expect
734 * @c "MYAPP_PREFIX" as a master environment variable to specify the
735 * exact install prefix for the software, or more specific environment
736 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
737 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
738 * the user or scripts before launching. If not provided (@c NULL),
739 * environment variables will not be used to override compiled-in
740 * defaults or auto detections.
742 * The @p dom string also provides a subdirectory inside the system
743 * shared data directory for data files. For example, if the system
744 * directory is @c /usr/local/share, then this directory name is
745 * appended, creating @c /usr/local/share/myapp, if it @p was @c
746 * "myapp". It is expected that the application installs data files in
749 * The @p checkfile is a file name or path of something inside the
750 * share or data directory to be used to test that the prefix
751 * detection worked. For example, your app will install a wallpaper
752 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
753 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
756 * @see elm_app_compile_bin_dir_set()
757 * @see elm_app_compile_lib_dir_set()
758 * @see elm_app_compile_data_dir_set()
759 * @see elm_app_compile_locale_set()
760 * @see elm_app_prefix_dir_get()
761 * @see elm_app_bin_dir_get()
762 * @see elm_app_lib_dir_get()
763 * @see elm_app_data_dir_get()
764 * @see elm_app_locale_dir_get()
766 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
769 * Provide information on the @b fallback application's binaries
770 * directory, in scenarios where they get overriden by
771 * elm_app_info_set().
773 * @param dir The path to the default binaries directory (compile time
776 * @note Elementary will as well use this path to determine actual
777 * names of binaries' directory paths, maybe changing it to be @c
778 * something/local/bin instead of @c something/bin, only, for
781 * @warning You should call this function @b before
782 * elm_app_info_set().
784 EAPI void elm_app_compile_bin_dir_set(const char *dir);
787 * Provide information on the @b fallback application's libraries
788 * directory, on scenarios where they get overriden by
789 * elm_app_info_set().
791 * @param dir The path to the default libraries directory (compile
794 * @note Elementary will as well use this path to determine actual
795 * names of libraries' directory paths, maybe changing it to be @c
796 * something/lib32 or @c something/lib64 instead of @c something/lib,
799 * @warning You should call this function @b before
800 * elm_app_info_set().
802 EAPI void elm_app_compile_lib_dir_set(const char *dir);
805 * Provide information on the @b fallback application's data
806 * directory, on scenarios where they get overriden by
807 * elm_app_info_set().
809 * @param dir The path to the default data directory (compile time
812 * @note Elementary will as well use this path to determine actual
813 * names of data directory paths, maybe changing it to be @c
814 * something/local/share instead of @c something/share, only, for
817 * @warning You should call this function @b before
818 * elm_app_info_set().
820 EAPI void elm_app_compile_data_dir_set(const char *dir);
823 * Provide information on the @b fallback application's locale
824 * directory, on scenarios where they get overriden by
825 * elm_app_info_set().
827 * @param dir The path to the default locale directory (compile time
830 * @warning You should call this function @b before
831 * elm_app_info_set().
833 EAPI void elm_app_compile_locale_set(const char *dir);
836 * Retrieve the application's run time prefix directory, as set by
837 * elm_app_info_set() and the way (environment) the application was
840 * @return The directory prefix the application is actually using.
842 EAPI const char *elm_app_prefix_dir_get(void);
845 * Retrieve the application's run time binaries prefix directory, as
846 * set by elm_app_info_set() and the way (environment) the application
849 * @return The binaries directory prefix the application is actually
852 EAPI const char *elm_app_bin_dir_get(void);
855 * Retrieve the application's run time libraries prefix directory, as
856 * set by elm_app_info_set() and the way (environment) the application
859 * @return The libraries directory prefix the application is actually
862 EAPI const char *elm_app_lib_dir_get(void);
865 * Retrieve the application's run time data prefix directory, as
866 * set by elm_app_info_set() and the way (environment) the application
869 * @return The data directory prefix the application is actually
872 EAPI const char *elm_app_data_dir_get(void);
875 * Retrieve the application's run time locale prefix directory, as
876 * set by elm_app_info_set() and the way (environment) the application
879 * @return The locale directory prefix the application is actually
882 EAPI const char *elm_app_locale_dir_get(void);
884 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
885 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
886 EAPI int elm_quicklaunch_init(int argc, char **argv);
887 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
888 EAPI int elm_quicklaunch_sub_shutdown(void);
889 EAPI int elm_quicklaunch_shutdown(void);
890 EAPI void elm_quicklaunch_seed(void);
891 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
892 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
893 EAPI void elm_quicklaunch_cleanup(void);
894 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
895 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
897 EAPI Eina_Bool elm_need_efreet(void);
898 EAPI Eina_Bool elm_need_e_dbus(void);
901 * This must be called before any other function that deals with
902 * elm_thumb objects or ethumb_client instances.
906 EAPI Eina_Bool elm_need_ethumb(void);
909 * This must be called before any other function that deals with
910 * elm_web objects or ewk_view instances.
914 EAPI Eina_Bool elm_need_web(void);
917 * Set a new policy's value (for a given policy group/identifier).
919 * @param policy policy identifier, as in @ref Elm_Policy.
920 * @param value policy value, which depends on the identifier
922 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
924 * Elementary policies define applications' behavior,
925 * somehow. These behaviors are divided in policy groups (see
926 * #Elm_Policy enumeration). This call will emit the Ecore event
927 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
928 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
931 * @note Currently, we have only one policy identifier/group
932 * (#ELM_POLICY_QUIT), which has two possible values.
936 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
939 * Gets the policy value for given policy identifier.
941 * @param policy policy identifier, as in #Elm_Policy.
942 * @return The currently set policy value, for that
943 * identifier. Will be @c 0 if @p policy passed is invalid.
947 EAPI int elm_policy_get(unsigned int policy);
950 * Change the language of the current application
952 * The @p lang passed must be the full name of the locale to use, for
953 * example "en_US.utf8" or "es_ES@euro".
955 * Changing language with this function will make Elementary run through
956 * all its widgets, translating strings set with
957 * elm_object_domain_translatable_text_part_set(). This way, an entire
958 * UI can have its language changed without having to restart the program.
960 * For more complex cases, like having formatted strings that need
961 * translation, widgets will also emit a "language,changed" signal that
962 * the user can listen to to manually translate the text.
964 * @param lang Language to set, must be the full name of the locale
968 EAPI void elm_language_set(const char *lang);
971 * Set a label of an object
973 * @param obj The Elementary object
974 * @param part The text part name to set (NULL for the default label)
975 * @param label The new text of the label
977 * @note Elementary objects may have many labels (e.g. Action Slider)
978 * @deprecated Use elm_object_part_text_set() instead.
981 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
984 * Set a label of an object
986 * @param obj The Elementary object
987 * @param part The text part name to set (NULL for the default label)
988 * @param label The new text of the label
990 * @note Elementary objects may have many labels (e.g. Action Slider)
994 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
996 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
999 * Get a label of an object
1001 * @param obj The Elementary object
1002 * @param part The text part name to get (NULL for the default label)
1003 * @return text of the label or NULL for any error
1005 * @note Elementary objects may have many labels (e.g. Action Slider)
1006 * @deprecated Use elm_object_part_text_get() instead.
1009 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1012 * Get a label of an object
1014 * @param obj The Elementary object
1015 * @param part The text part name to get (NULL for the default label)
1016 * @return text of the label or NULL for any error
1018 * @note Elementary objects may have many labels (e.g. Action Slider)
1022 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1024 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1027 * Set the text for an objects' part, marking it as translatable.
1029 * The string to set as @p text must be the original one. Do not pass the
1030 * return of @c gettext() here. Elementary will translate the string
1031 * internally and set it on the object using elm_object_part_text_set(),
1032 * also storing the original string so that it can be automatically
1033 * translated when the language is changed with elm_language_set().
1035 * The @p domain will be stored along to find the translation in the
1036 * correct catalog. It can be NULL, in which case it will use whatever
1037 * domain was set by the application with @c textdomain(). This is useful
1038 * in case you are building a library on top of Elementary that will have
1039 * its own translatable strings, that should not be mixed with those of
1040 * programs using the library.
1042 * @param obj The object containing the text part
1043 * @param part The name of the part to set
1044 * @param domain The translation domain to use
1045 * @param text The original, non-translated text to set
1049 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1051 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1053 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1056 * Gets the original string set as translatable for an object
1058 * When setting translated strings, the function elm_object_part_text_get()
1059 * will return the translation returned by @c gettext(). To get the
1060 * original string use this function.
1062 * @param obj The object
1063 * @param part The name of the part that was set
1065 * @return The original, untranslated string
1069 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1071 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1074 * Set a content of an object
1076 * @param obj The Elementary object
1077 * @param part The content part name to set (NULL for the default content)
1078 * @param content The new content of the object
1080 * @note Elementary objects may have many contents
1081 * @deprecated Use elm_object_part_content_set instead.
1084 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1087 * Set a content of an object
1089 * @param obj The Elementary object
1090 * @param part The content part name to set (NULL for the default content)
1091 * @param content The new content of the object
1093 * @note Elementary objects may have many contents
1097 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1099 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1102 * Get a content of an object
1104 * @param obj The Elementary object
1105 * @param item The content part name to get (NULL for the default content)
1106 * @return content of the object or NULL for any error
1108 * @note Elementary objects may have many contents
1109 * @deprecated Use elm_object_part_content_get instead.
1112 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1115 * Get a content of an object
1117 * @param obj The Elementary object
1118 * @param item The content part name to get (NULL for the default content)
1119 * @return content of the object or NULL for any error
1121 * @note Elementary objects may have many contents
1125 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1127 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1130 * Unset a content of an object
1132 * @param obj The Elementary object
1133 * @param item The content part name to unset (NULL for the default content)
1135 * @note Elementary objects may have many contents
1136 * @deprecated Use elm_object_part_content_unset instead.
1139 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1142 * Unset a content of an object
1144 * @param obj The Elementary object
1145 * @param item The content part name to unset (NULL for the default content)
1147 * @note Elementary objects may have many contents
1151 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1153 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1156 * Set the text to read out when in accessibility mode
1158 * @param obj The object which is to be described
1159 * @param txt The text that describes the widget to people with poor or no vision
1163 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1166 * Get the widget object's handle which contains a given item
1168 * @param item The Elementary object item
1169 * @return The widget object
1171 * @note This returns the widget object itself that an item belongs to.
1175 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1178 * Set a content of an object item
1180 * @param it The Elementary object item
1181 * @param part The content part name to set (NULL for the default content)
1182 * @param content The new content of the object item
1184 * @note Elementary object items may have many contents
1188 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1190 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1193 * Get a content of an object item
1195 * @param it The Elementary object item
1196 * @param part The content part name to unset (NULL for the default content)
1197 * @return content of the object item or NULL for any error
1199 * @note Elementary object items may have many contents
1203 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1205 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1208 * Unset a content of an object item
1210 * @param it The Elementary object item
1211 * @param part The content part name to unset (NULL for the default content)
1213 * @note Elementary object items may have many contents
1217 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1219 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1222 * Set a label of an object item
1224 * @param it The Elementary object item
1225 * @param part The text part name to set (NULL for the default label)
1226 * @param label The new text of the label
1228 * @note Elementary object items may have many labels
1232 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1234 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1237 * Get a label of an object item
1239 * @param it The Elementary object item
1240 * @param part The text part name to get (NULL for the default label)
1241 * @return text of the label or NULL for any error
1243 * @note Elementary object items may have many labels
1247 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1250 * Set the text to read out when in accessibility mode
1252 * @param obj The object which is to be described
1253 * @param txt The text that describes the widget to people with poor or no vision
1257 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1260 * Set the text to read out when in accessibility mode
1262 * @param it The object item which is to be described
1263 * @param txt The text that describes the widget to people with poor or no vision
1267 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1270 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1273 * Set the text to read out when in accessibility mode
1275 * @param it The object item which is to be described
1276 * @param txt The text that describes the widget to people with poor or no vision
1280 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1283 * Get the data associated with an object item
1284 * @param it The Elementary object item
1285 * @return The data associated with @p it
1289 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1292 * Set the data associated with an object item
1293 * @param it The Elementary object item
1294 * @param data The data to be associated with @p it
1298 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1301 * Send a signal to the edje object of the widget item.
1303 * This function sends a signal to the edje object of the obj item. An
1304 * edje program can respond to a signal by specifying matching
1305 * 'signal' and 'source' fields.
1307 * @param it The Elementary object item
1308 * @param emission The signal's name.
1309 * @param source The signal's source.
1312 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1315 * Set the disabled state of an widget item.
1317 * @param obj The Elementary object item
1318 * @param disabled The state to put in in: @c EINA_TRUE for
1319 * disabled, @c EINA_FALSE for enabled
1321 * Elementary object item can be @b disabled, in which state they won't
1322 * receive input and, in general, will be themed differently from
1323 * their normal state, usually greyed out. Useful for contexts
1324 * where you don't want your users to interact with some of the
1325 * parts of you interface.
1327 * This sets the state for the widget item, either disabling it or
1332 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1335 * Get the disabled state of an widget item.
1337 * @param obj The Elementary object
1338 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1339 * if it's enabled (or on errors)
1341 * This gets the state of the widget, which might be enabled or disabled.
1345 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1352 * @defgroup Caches Caches
1354 * These are functions which let one fine-tune some cache values for
1355 * Elementary applications, thus allowing for performance adjustments.
1361 * @brief Flush all caches.
1363 * Frees all data that was in cache and is not currently being used to reduce
1364 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1365 * to calling all of the following functions:
1366 * @li edje_file_cache_flush()
1367 * @li edje_collection_cache_flush()
1368 * @li eet_clearcache()
1369 * @li evas_image_cache_flush()
1370 * @li evas_font_cache_flush()
1371 * @li evas_render_dump()
1372 * @note Evas caches are flushed for every canvas associated with a window.
1376 EAPI void elm_all_flush(void);
1379 * Get the configured cache flush interval time
1381 * This gets the globally configured cache flush interval time, in
1384 * @return The cache flush interval time
1387 * @see elm_all_flush()
1389 EAPI int elm_cache_flush_interval_get(void);
1392 * Set the configured cache flush interval time
1394 * This sets the globally configured cache flush interval time, in ticks
1396 * @param size The cache flush interval time
1399 * @see elm_all_flush()
1401 EAPI void elm_cache_flush_interval_set(int size);
1404 * Set the configured cache flush interval time for all applications on the
1407 * This sets the globally configured cache flush interval time -- in ticks
1408 * -- for all applications on the display.
1410 * @param size The cache flush interval time
1413 EAPI void elm_cache_flush_interval_all_set(int size);
1416 * Get the configured cache flush enabled state
1418 * This gets the globally configured cache flush state - if it is enabled
1419 * or not. When cache flushing is enabled, elementary will regularly
1420 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1421 * memory and allow usage to re-seed caches and data in memory where it
1422 * can do so. An idle application will thus minimise its memory usage as
1423 * data will be freed from memory and not be re-loaded as it is idle and
1424 * not rendering or doing anything graphically right now.
1426 * @return The cache flush state
1429 * @see elm_all_flush()
1431 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1434 * Set the configured cache flush enabled state
1436 * This sets the globally configured cache flush enabled state.
1438 * @param size The cache flush enabled state
1441 * @see elm_all_flush()
1443 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1446 * Set the configured cache flush enabled state for all applications on the
1449 * This sets the globally configured cache flush enabled state for all
1450 * applications on the display.
1452 * @param size The cache flush enabled state
1455 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1458 * Get the configured font cache size
1460 * This gets the globally configured font cache size, in bytes.
1462 * @return The font cache size
1465 EAPI int elm_font_cache_get(void);
1468 * Set the configured font cache size
1470 * This sets the globally configured font cache size, in bytes
1472 * @param size The font cache size
1475 EAPI void elm_font_cache_set(int size);
1478 * Set the configured font cache size for all applications on the
1481 * This sets the globally configured font cache size -- in bytes
1482 * -- for all applications on the display.
1484 * @param size The font cache size
1487 EAPI void elm_font_cache_all_set(int size);
1490 * Get the configured image cache size
1492 * This gets the globally configured image cache size, in bytes
1494 * @return The image cache size
1497 EAPI int elm_image_cache_get(void);
1500 * Set the configured image cache size
1502 * This sets the globally configured image cache size, in bytes
1504 * @param size The image cache size
1507 EAPI void elm_image_cache_set(int size);
1510 * Set the configured image cache size for all applications on the
1513 * This sets the globally configured image cache size -- in bytes
1514 * -- for all applications on the display.
1516 * @param size The image cache size
1519 EAPI void elm_image_cache_all_set(int size);
1522 * Get the configured edje file cache size.
1524 * This gets the globally configured edje file cache size, in number
1527 * @return The edje file cache size
1530 EAPI int elm_edje_file_cache_get(void);
1533 * Set the configured edje file cache size
1535 * This sets the globally configured edje file cache size, in number
1538 * @param size The edje file cache size
1541 EAPI void elm_edje_file_cache_set(int size);
1544 * Set the configured edje file cache size for all applications on the
1547 * This sets the globally configured edje file cache size -- in number
1548 * of files -- for all applications on the display.
1550 * @param size The edje file cache size
1553 EAPI void elm_edje_file_cache_all_set(int size);
1556 * Get the configured edje collections (groups) cache size.
1558 * This gets the globally configured edje collections cache size, in
1559 * number of collections.
1561 * @return The edje collections cache size
1564 EAPI int elm_edje_collection_cache_get(void);
1567 * Set the configured edje collections (groups) cache size
1569 * This sets the globally configured edje collections cache size, in
1570 * number of collections.
1572 * @param size The edje collections cache size
1575 EAPI void elm_edje_collection_cache_set(int size);
1578 * Set the configured edje collections (groups) cache size for all
1579 * applications on the display
1581 * This sets the globally configured edje collections cache size -- in
1582 * number of collections -- for all applications on the display.
1584 * @param size The edje collections cache size
1587 EAPI void elm_edje_collection_cache_all_set(int size);
1594 * @defgroup Scaling Widget Scaling
1596 * Different widgets can be scaled independently. These functions
1597 * allow you to manipulate this scaling on a per-widget basis. The
1598 * object and all its children get their scaling factors multiplied
1599 * by the scale factor set. This is multiplicative, in that if a
1600 * child also has a scale size set it is in turn multiplied by its
1601 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1602 * double size, @c 0.5 is half, etc.
1604 * @ref general_functions_example_page "This" example contemplates
1605 * some of these functions.
1609 * Get the global scaling factor
1611 * This gets the globally configured scaling factor that is applied to all
1614 * @return The scaling factor
1617 EAPI double elm_scale_get(void);
1620 * Set the global scaling factor
1622 * This sets the globally configured scaling factor that is applied to all
1625 * @param scale The scaling factor to set
1628 EAPI void elm_scale_set(double scale);
1631 * Set the global scaling factor for all applications on the display
1633 * This sets the globally configured scaling factor that is applied to all
1634 * objects for all applications.
1635 * @param scale The scaling factor to set
1638 EAPI void elm_scale_all_set(double scale);
1641 * Set the scaling factor for a given Elementary object
1643 * @param obj The Elementary to operate on
1644 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1649 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1652 * Get the scaling factor for a given Elementary object
1654 * @param obj The object
1655 * @return The scaling factor set by elm_object_scale_set()
1659 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1662 * @defgroup Password_last_show Password last input show
1664 * Last show feature of password mode enables user to view
1665 * the last input entered for few seconds before masking it.
1666 * These functions allow to set this feature in password mode
1667 * of entry widget and also allow to manipulate the duration
1668 * for which the input has to be visible.
1674 * Get show last setting of password mode.
1676 * This gets the show last input setting of password mode which might be
1677 * enabled or disabled.
1679 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1681 * @ingroup Password_last_show
1683 EAPI Eina_Bool elm_password_show_last_get(void);
1686 * Set show last setting in password mode.
1688 * This enables or disables show last setting of password mode.
1690 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1691 * @see elm_password_show_last_timeout_set()
1692 * @ingroup Password_last_show
1694 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1697 * Get's the timeout value in last show password mode.
1699 * This gets the time out value for which the last input entered in password
1700 * mode will be visible.
1702 * @return The timeout value of last show password mode.
1703 * @ingroup Password_last_show
1705 EAPI double elm_password_show_last_timeout_get(void);
1708 * Set's the timeout value in last show password mode.
1710 * This sets the time out value for which the last input entered in password
1711 * mode will be visible.
1713 * @param password_show_last_timeout The timeout value.
1714 * @see elm_password_show_last_set()
1715 * @ingroup Password_last_show
1717 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1724 * @defgroup UI-Mirroring Selective Widget mirroring
1726 * These functions allow you to set ui-mirroring on specific
1727 * widgets or the whole interface. Widgets can be in one of two
1728 * modes, automatic and manual. Automatic means they'll be changed
1729 * according to the system mirroring mode and manual means only
1730 * explicit changes will matter. You are not supposed to change
1731 * mirroring state of a widget set to automatic, will mostly work,
1732 * but the behavior is not really defined.
1737 EAPI Eina_Bool elm_mirrored_get(void);
1738 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1741 * Get the system mirrored mode. This determines the default mirrored mode
1744 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1746 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1749 * Set the system mirrored mode. This determines the default mirrored mode
1752 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1754 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1757 * Returns the widget's mirrored mode setting.
1759 * @param obj The widget.
1760 * @return mirrored mode setting of the object.
1763 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1766 * Sets the widget's mirrored mode setting.
1767 * When widget in automatic mode, it follows the system mirrored mode set by
1768 * elm_mirrored_set().
1769 * @param obj The widget.
1770 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1772 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1779 * Set the style to use by a widget
1781 * Sets the style name that will define the appearance of a widget. Styles
1782 * vary from widget to widget and may also be defined by other themes
1783 * by means of extensions and overlays.
1785 * @param obj The Elementary widget to style
1786 * @param style The style name to use
1788 * @see elm_theme_extension_add()
1789 * @see elm_theme_extension_del()
1790 * @see elm_theme_overlay_add()
1791 * @see elm_theme_overlay_del()
1795 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1797 * Get the style used by the widget
1799 * This gets the style being used for that widget. Note that the string
1800 * pointer is only valid as longas the object is valid and the style doesn't
1803 * @param obj The Elementary widget to query for its style
1804 * @return The style name used
1806 * @see elm_object_style_set()
1810 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1813 * @defgroup Styles Styles
1815 * Widgets can have different styles of look. These generic API's
1816 * set styles of widgets, if they support them (and if the theme(s)
1819 * @ref general_functions_example_page "This" example contemplates
1820 * some of these functions.
1824 * Set the disabled state of an Elementary object.
1826 * @param obj The Elementary object to operate on
1827 * @param disabled The state to put in in: @c EINA_TRUE for
1828 * disabled, @c EINA_FALSE for enabled
1830 * Elementary objects can be @b disabled, in which state they won't
1831 * receive input and, in general, will be themed differently from
1832 * their normal state, usually greyed out. Useful for contexts
1833 * where you don't want your users to interact with some of the
1834 * parts of you interface.
1836 * This sets the state for the widget, either disabling it or
1841 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1844 * Get the disabled state of an Elementary object.
1846 * @param obj The Elementary object to operate on
1847 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1848 * if it's enabled (or on errors)
1850 * This gets the state of the widget, which might be enabled or disabled.
1854 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1857 * @defgroup WidgetNavigation Widget Tree Navigation.
1859 * How to check if an Evas Object is an Elementary widget? How to
1860 * get the first elementary widget that is parent of the given
1861 * object? These are all covered in widget tree navigation.
1863 * @ref general_functions_example_page "This" example contemplates
1864 * some of these functions.
1868 * Check if the given Evas Object is an Elementary widget.
1870 * @param obj the object to query.
1871 * @return @c EINA_TRUE if it is an elementary widget variant,
1872 * @c EINA_FALSE otherwise
1873 * @ingroup WidgetNavigation
1875 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1878 * Get the first parent of the given object that is an Elementary
1881 * @param obj the Elementary object to query parent from.
1882 * @return the parent object that is an Elementary widget, or @c
1883 * NULL, if it was not found.
1885 * Use this to query for an object's parent widget.
1887 * @note Most of Elementary users wouldn't be mixing non-Elementary
1888 * smart objects in the objects tree of an application, as this is
1889 * an advanced usage of Elementary with Evas. So, except for the
1890 * application's window, which is the root of that tree, all other
1891 * objects would have valid Elementary widget parents.
1893 * @ingroup WidgetNavigation
1895 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1898 * Get the top level parent of an Elementary widget.
1900 * @param obj The object to query.
1901 * @return The top level Elementary widget, or @c NULL if parent cannot be
1903 * @ingroup WidgetNavigation
1905 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1908 * Get the string that represents this Elementary widget.
1910 * @note Elementary is weird and exposes itself as a single
1911 * Evas_Object_Smart_Class of type "elm_widget", so
1912 * evas_object_type_get() always return that, making debug and
1913 * language bindings hard. This function tries to mitigate this
1914 * problem, but the solution is to change Elementary to use
1915 * proper inheritance.
1917 * @param obj the object to query.
1918 * @return Elementary widget name, or @c NULL if not a valid widget.
1919 * @ingroup WidgetNavigation
1921 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1924 * @defgroup Config Elementary Config
1926 * Elementary configuration is formed by a set options bounded to a
1927 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1928 * "finger size", etc. These are functions with which one syncronizes
1929 * changes made to those values to the configuration storing files, de
1930 * facto. You most probably don't want to use the functions in this
1931 * group unlees you're writing an elementary configuration manager.
1937 * Save back Elementary's configuration, so that it will persist on
1940 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1943 * This function will take effect -- thus, do I/O -- immediately. Use
1944 * it when you want to apply all configuration changes at once. The
1945 * current configuration set will get saved onto the current profile
1946 * configuration file.
1949 EAPI Eina_Bool elm_config_save(void);
1952 * Reload Elementary's configuration, bounded to current selected
1955 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1958 * Useful when you want to force reloading of configuration values for
1959 * a profile. If one removes user custom configuration directories,
1960 * for example, it will force a reload with system values instead.
1963 EAPI void elm_config_reload(void);
1970 * @defgroup Profile Elementary Profile
1972 * Profiles are pre-set options that affect the whole look-and-feel of
1973 * Elementary-based applications. There are, for example, profiles
1974 * aimed at desktop computer applications and others aimed at mobile,
1975 * touchscreen-based ones. You most probably don't want to use the
1976 * functions in this group unlees you're writing an elementary
1977 * configuration manager.
1983 * Get Elementary's profile in use.
1985 * This gets the global profile that is applied to all Elementary
1988 * @return The profile's name
1991 EAPI const char *elm_profile_current_get(void);
1994 * Get an Elementary's profile directory path in the filesystem. One
1995 * may want to fetch a system profile's dir or an user one (fetched
1998 * @param profile The profile's name
1999 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2000 * or a system one (@c EINA_FALSE)
2001 * @return The profile's directory path.
2004 * @note You must free it with elm_profile_dir_free().
2006 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2009 * Free an Elementary's profile directory path, as returned by
2010 * elm_profile_dir_get().
2012 * @param p_dir The profile's path
2016 EAPI void elm_profile_dir_free(const char *p_dir);
2019 * Get Elementary's list of available profiles.
2021 * @return The profiles list. List node data are the profile name
2025 * @note One must free this list, after usage, with the function
2026 * elm_profile_list_free().
2028 EAPI Eina_List *elm_profile_list_get(void);
2031 * Free Elementary's list of available profiles.
2033 * @param l The profiles list, as returned by elm_profile_list_get().
2037 EAPI void elm_profile_list_free(Eina_List *l);
2040 * Set Elementary's profile.
2042 * This sets the global profile that is applied to Elementary
2043 * applications. Just the process the call comes from will be
2046 * @param profile The profile's name
2050 EAPI void elm_profile_set(const char *profile);
2053 * Set Elementary's profile.
2055 * This sets the global profile that is applied to all Elementary
2056 * applications. All running Elementary windows will be affected.
2058 * @param profile The profile's name
2062 EAPI void elm_profile_all_set(const char *profile);
2069 * @defgroup Engine Elementary Engine
2071 * These are functions setting and querying which rendering engine
2072 * Elementary will use for drawing its windows' pixels.
2074 * The following are the available engines:
2075 * @li "software_x11"
2078 * @li "software_16_x11"
2079 * @li "software_8_x11"
2082 * @li "software_gdi"
2083 * @li "software_16_wince_gdi"
2085 * @li "software_16_sdl"
2089 * @li "opengl_cocoa"
2096 * @brief Get Elementary's rendering engine in use.
2098 * @return The rendering engine's name
2099 * @note there's no need to free the returned string, here.
2101 * This gets the global rendering engine that is applied to all Elementary
2104 * @see elm_engine_set()
2106 EAPI const char *elm_engine_current_get(void);
2109 * @brief Set Elementary's rendering engine for use.
2111 * @param engine The rendering engine's name
2113 * This sets global rendering engine that is applied to all Elementary
2114 * applications. Note that it will take effect only to Elementary windows
2115 * created after this is called.
2117 * @see elm_win_add()
2119 EAPI void elm_engine_set(const char *engine);
2126 * @defgroup Fonts Elementary Fonts
2128 * These are functions dealing with font rendering, selection and the
2129 * like for Elementary applications. One might fetch which system
2130 * fonts are there to use and set custom fonts for individual classes
2131 * of UI items containing text (text classes).
2136 typedef struct _Elm_Text_Class
2142 typedef struct _Elm_Font_Overlay
2144 const char *text_class;
2146 Evas_Font_Size size;
2149 typedef struct _Elm_Font_Properties
2153 } Elm_Font_Properties;
2156 * Get Elementary's list of supported text classes.
2158 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2161 * Release the list with elm_text_classes_list_free().
2163 EAPI const Eina_List *elm_text_classes_list_get(void);
2166 * Free Elementary's list of supported text classes.
2170 * @see elm_text_classes_list_get().
2172 EAPI void elm_text_classes_list_free(const Eina_List *list);
2175 * Get Elementary's list of font overlays, set with
2176 * elm_font_overlay_set().
2178 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2183 * For each text class, one can set a <b>font overlay</b> for it,
2184 * overriding the default font properties for that class coming from
2185 * the theme in use. There is no need to free this list.
2187 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2189 EAPI const Eina_List *elm_font_overlay_list_get(void);
2192 * Set a font overlay for a given Elementary text class.
2194 * @param text_class Text class name
2195 * @param font Font name and style string
2196 * @param size Font size
2200 * @p font has to be in the format returned by
2201 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2202 * and elm_font_overlay_unset().
2204 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2207 * Unset a font overlay for a given Elementary text class.
2209 * @param text_class Text class name
2213 * This will bring back text elements belonging to text class
2214 * @p text_class back to their default font settings.
2216 EAPI void elm_font_overlay_unset(const char *text_class);
2219 * Apply the changes made with elm_font_overlay_set() and
2220 * elm_font_overlay_unset() on the current Elementary window.
2224 * This applies all font overlays set to all objects in the UI.
2226 EAPI void elm_font_overlay_apply(void);
2229 * Apply the changes made with elm_font_overlay_set() and
2230 * elm_font_overlay_unset() on all Elementary application windows.
2234 * This applies all font overlays set to all objects in the UI.
2236 EAPI void elm_font_overlay_all_apply(void);
2239 * Translate a font (family) name string in fontconfig's font names
2240 * syntax into an @c Elm_Font_Properties struct.
2242 * @param font The font name and styles string
2243 * @return the font properties struct
2247 * @note The reverse translation can be achived with
2248 * elm_font_fontconfig_name_get(), for one style only (single font
2249 * instance, not family).
2251 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2254 * Free font properties return by elm_font_properties_get().
2256 * @param efp the font properties struct
2260 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2263 * Translate a font name, bound to a style, into fontconfig's font names
2266 * @param name The font (family) name
2267 * @param style The given style (may be @c NULL)
2269 * @return the font name and style string
2273 * @note The reverse translation can be achived with
2274 * elm_font_properties_get(), for one style only (single font
2275 * instance, not family).
2277 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2280 * Free the font string return by elm_font_fontconfig_name_get().
2282 * @param efp the font properties struct
2286 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2289 * Create a font hash table of available system fonts.
2291 * One must call it with @p list being the return value of
2292 * evas_font_available_list(). The hash will be indexed by font
2293 * (family) names, being its values @c Elm_Font_Properties blobs.
2295 * @param list The list of available system fonts, as returned by
2296 * evas_font_available_list().
2297 * @return the font hash.
2301 * @note The user is supposed to get it populated at least with 3
2302 * default font families (Sans, Serif, Monospace), which should be
2303 * present on most systems.
2305 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2308 * Free the hash return by elm_font_available_hash_add().
2310 * @param hash the hash to be freed.
2314 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2321 * @defgroup Fingers Fingers
2323 * Elementary is designed to be finger-friendly for touchscreens,
2324 * and so in addition to scaling for display resolution, it can
2325 * also scale based on finger "resolution" (or size). You can then
2326 * customize the granularity of the areas meant to receive clicks
2329 * Different profiles may have pre-set values for finger sizes.
2331 * @ref general_functions_example_page "This" example contemplates
2332 * some of these functions.
2338 * Get the configured "finger size"
2340 * @return The finger size
2342 * This gets the globally configured finger size, <b>in pixels</b>
2346 EAPI Evas_Coord elm_finger_size_get(void);
2349 * Set the configured finger size
2351 * This sets the globally configured finger size in pixels
2353 * @param size The finger size
2356 EAPI void elm_finger_size_set(Evas_Coord size);
2359 * Set the configured finger size for all applications on the display
2361 * This sets the globally configured finger size in pixels for all
2362 * applications on the display
2364 * @param size The finger size
2367 EAPI void elm_finger_size_all_set(Evas_Coord size);
2374 * @defgroup Focus Focus
2376 * An Elementary application has, at all times, one (and only one)
2377 * @b focused object. This is what determines where the input
2378 * events go to within the application's window. Also, focused
2379 * objects can be decorated differently, in order to signal to the
2380 * user where the input is, at a given moment.
2382 * Elementary applications also have the concept of <b>focus
2383 * chain</b>: one can cycle through all the windows' focusable
2384 * objects by input (tab key) or programmatically. The default
2385 * focus chain for an application is the one define by the order in
2386 * which the widgets where added in code. One will cycle through
2387 * top level widgets, and, for each one containg sub-objects, cycle
2388 * through them all, before returning to the level
2389 * above. Elementary also allows one to set @b custom focus chains
2390 * for their applications.
2392 * Besides the focused decoration a widget may exhibit, when it
2393 * gets focus, Elementary has a @b global focus highlight object
2394 * that can be enabled for a window. If one chooses to do so, this
2395 * extra highlight effect will surround the current focused object,
2398 * @note Some Elementary widgets are @b unfocusable, after
2399 * creation, by their very nature: they are not meant to be
2400 * interacted with input events, but are there just for visual
2403 * @ref general_functions_example_page "This" example contemplates
2404 * some of these functions.
2408 * Get the enable status of the focus highlight
2410 * This gets whether the highlight on focused objects is enabled or not
2413 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2416 * Set the enable status of the focus highlight
2418 * Set whether to show or not the highlight on focused objects
2419 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2422 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2425 * Get the enable status of the highlight animation
2427 * Get whether the focus highlight, if enabled, will animate its switch from
2428 * one object to the next
2431 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2434 * Set the enable status of the highlight animation
2436 * Set whether the focus highlight, if enabled, will animate its switch from
2437 * one object to the next
2438 * @param animate Enable animation if EINA_TRUE, disable otherwise
2441 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2444 * Get the whether an Elementary object has the focus or not.
2446 * @param obj The Elementary object to get the information from
2447 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2448 * not (and on errors).
2450 * @see elm_object_focus_set()
2454 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2457 * Set/unset focus to a given Elementary object.
2459 * @param obj The Elementary object to operate on.
2460 * @param enable @c EINA_TRUE Set focus to a given object,
2461 * @c EINA_FALSE Unset focus to a given object.
2463 * @note When you set focus to this object, if it can handle focus, will
2464 * take the focus away from the one who had it previously and will, for
2465 * now on, be the one receiving input events. Unsetting focus will remove
2466 * the focus from @p obj, passing it back to the previous element in the
2469 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2473 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2476 * Make a given Elementary object the focused one.
2478 * @param obj The Elementary object to make focused.
2480 * @note This object, if it can handle focus, will take the focus
2481 * away from the one who had it previously and will, for now on, be
2482 * the one receiving input events.
2484 * @see elm_object_focus_get()
2488 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2491 * Remove the focus from an Elementary object
2493 * @param obj The Elementary to take focus from
2495 * This removes the focus from @p obj, passing it back to the
2496 * previous element in the focus chain list.
2498 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2502 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2505 * Set the ability for an Element object to be focused
2507 * @param obj The Elementary object to operate on
2508 * @param enable @c EINA_TRUE if the object can be focused, @c
2509 * EINA_FALSE if not (and on errors)
2511 * This sets whether the object @p obj is able to take focus or
2512 * not. Unfocusable objects do nothing when programmatically
2513 * focused, being the nearest focusable parent object the one
2514 * really getting focus. Also, when they receive mouse input, they
2515 * will get the event, but not take away the focus from where it
2520 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2523 * Get whether an Elementary object is focusable or not
2525 * @param obj The Elementary object to operate on
2526 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2527 * EINA_FALSE if not (and on errors)
2529 * @note Objects which are meant to be interacted with by input
2530 * events are created able to be focused, by default. All the
2535 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2538 * Set custom focus chain.
2540 * This function overwrites any previous custom focus chain within
2541 * the list of objects. The previous list will be deleted and this list
2542 * will be managed by elementary. After it is set, don't modify it.
2544 * @note On focus cycle, only will be evaluated children of this container.
2546 * @param obj The container object
2547 * @param objs Chain of objects to pass focus
2550 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2553 * Unset a custom focus chain on a given Elementary widget
2555 * @param obj The container object to remove focus chain from
2557 * Any focus chain previously set on @p obj (for its child objects)
2558 * is removed entirely after this call.
2562 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2565 * Get custom focus chain
2567 * @param obj The container object
2570 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2573 * Append object to custom focus chain.
2575 * @note If relative_child equal to NULL or not in custom chain, the object
2576 * will be added in end.
2578 * @note On focus cycle, only will be evaluated children of this container.
2580 * @param obj The container object
2581 * @param child The child to be added in custom chain
2582 * @param relative_child The relative object to position the child
2585 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2588 * Prepend object to custom focus chain.
2590 * @note If relative_child equal to NULL or not in custom chain, the object
2591 * will be added in begin.
2593 * @note On focus cycle, only will be evaluated children of this container.
2595 * @param obj The container object
2596 * @param child The child to be added in custom chain
2597 * @param relative_child The relative object to position the child
2600 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2603 * Give focus to next object in object tree.
2605 * Give focus to next object in focus chain of one object sub-tree.
2606 * If the last object of chain already have focus, the focus will go to the
2607 * first object of chain.
2609 * @param obj The object root of sub-tree
2610 * @param dir Direction to cycle the focus
2614 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2617 * Give focus to near object in one direction.
2619 * Give focus to near object in direction of one object.
2620 * If none focusable object in given direction, the focus will not change.
2622 * @param obj The reference object
2623 * @param x Horizontal component of direction to focus
2624 * @param y Vertical component of direction to focus
2628 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2631 * Make the elementary object and its children to be unfocusable
2634 * @param obj The Elementary object to operate on
2635 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2636 * @c EINA_FALSE for focusable.
2638 * This sets whether the object @p obj and its children objects
2639 * are able to take focus or not. If the tree is set as unfocusable,
2640 * newest focused object which is not in this tree will get focus.
2641 * This API can be helpful for an object to be deleted.
2642 * When an object will be deleted soon, it and its children may not
2643 * want to get focus (by focus reverting or by other focus controls).
2644 * Then, just use this API before deleting.
2646 * @see elm_object_tree_unfocusable_get()
2650 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2653 * Get whether an Elementary object and its children are unfocusable or not.
2655 * @param obj The Elementary object to get the information from
2656 * @return @c EINA_TRUE, if the tree is unfocussable,
2657 * @c EINA_FALSE if not (and on errors).
2659 * @see elm_object_tree_unfocusable_set()
2663 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2666 * @defgroup Scrolling Scrolling
2668 * These are functions setting how scrollable views in Elementary
2669 * widgets should behave on user interaction.
2675 * Get whether scrollers should bounce when they reach their
2676 * viewport's edge during a scroll.
2678 * @return the thumb scroll bouncing state
2680 * This is the default behavior for touch screens, in general.
2681 * @ingroup Scrolling
2683 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2686 * Set whether scrollers should bounce when they reach their
2687 * viewport's edge during a scroll.
2689 * @param enabled the thumb scroll bouncing state
2691 * @see elm_thumbscroll_bounce_enabled_get()
2692 * @ingroup Scrolling
2694 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2697 * Set whether scrollers should bounce when they reach their
2698 * viewport's edge during a scroll, for all Elementary application
2701 * @param enabled the thumb scroll bouncing state
2703 * @see elm_thumbscroll_bounce_enabled_get()
2704 * @ingroup Scrolling
2706 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2709 * Get the amount of inertia a scroller will impose at bounce
2712 * @return the thumb scroll bounce friction
2714 * @ingroup Scrolling
2716 EAPI double elm_scroll_bounce_friction_get(void);
2719 * Set the amount of inertia a scroller will impose at bounce
2722 * @param friction the thumb scroll bounce friction
2724 * @see elm_thumbscroll_bounce_friction_get()
2725 * @ingroup Scrolling
2727 EAPI void elm_scroll_bounce_friction_set(double friction);
2730 * Set the amount of inertia a scroller will impose at bounce
2731 * animations, for all Elementary application windows.
2733 * @param friction the thumb scroll bounce friction
2735 * @see elm_thumbscroll_bounce_friction_get()
2736 * @ingroup Scrolling
2738 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2741 * Get the amount of inertia a <b>paged</b> scroller will impose at
2742 * page fitting animations.
2744 * @return the page scroll friction
2746 * @ingroup Scrolling
2748 EAPI double elm_scroll_page_scroll_friction_get(void);
2751 * Set the amount of inertia a <b>paged</b> scroller will impose at
2752 * page fitting animations.
2754 * @param friction the page scroll friction
2756 * @see elm_thumbscroll_page_scroll_friction_get()
2757 * @ingroup Scrolling
2759 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2762 * Set the amount of inertia a <b>paged</b> scroller will impose at
2763 * page fitting animations, for all Elementary application windows.
2765 * @param friction the page scroll friction
2767 * @see elm_thumbscroll_page_scroll_friction_get()
2768 * @ingroup Scrolling
2770 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2773 * Get the amount of inertia a scroller will impose at region bring
2776 * @return the bring in scroll friction
2778 * @ingroup Scrolling
2780 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2783 * Set the amount of inertia a scroller will impose at region bring
2786 * @param friction the bring in scroll friction
2788 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2789 * @ingroup Scrolling
2791 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2794 * Set the amount of inertia a scroller will impose at region bring
2795 * animations, for all Elementary application windows.
2797 * @param friction the bring in scroll friction
2799 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2800 * @ingroup Scrolling
2802 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2805 * Get the amount of inertia scrollers will impose at animations
2806 * triggered by Elementary widgets' zooming API.
2808 * @return the zoom friction
2810 * @ingroup Scrolling
2812 EAPI double elm_scroll_zoom_friction_get(void);
2815 * Set the amount of inertia scrollers will impose at animations
2816 * triggered by Elementary widgets' zooming API.
2818 * @param friction the zoom friction
2820 * @see elm_thumbscroll_zoom_friction_get()
2821 * @ingroup Scrolling
2823 EAPI void elm_scroll_zoom_friction_set(double friction);
2826 * Set the amount of inertia scrollers will impose at animations
2827 * triggered by Elementary widgets' zooming API, for all Elementary
2828 * application windows.
2830 * @param friction the zoom friction
2832 * @see elm_thumbscroll_zoom_friction_get()
2833 * @ingroup Scrolling
2835 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2838 * Get whether scrollers should be draggable from any point in their
2841 * @return the thumb scroll state
2843 * @note This is the default behavior for touch screens, in general.
2844 * @note All other functions namespaced with "thumbscroll" will only
2845 * have effect if this mode is enabled.
2847 * @ingroup Scrolling
2849 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2852 * Set whether scrollers should be draggable from any point in their
2855 * @param enabled the thumb scroll state
2857 * @see elm_thumbscroll_enabled_get()
2858 * @ingroup Scrolling
2860 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2863 * Set whether scrollers should be draggable from any point in their
2864 * views, for all Elementary application windows.
2866 * @param enabled the thumb scroll state
2868 * @see elm_thumbscroll_enabled_get()
2869 * @ingroup Scrolling
2871 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2874 * Get the number of pixels one should travel while dragging a
2875 * scroller's view to actually trigger scrolling.
2877 * @return the thumb scroll threshould
2879 * One would use higher values for touch screens, in general, because
2880 * of their inherent imprecision.
2881 * @ingroup Scrolling
2883 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2886 * Set the number of pixels one should travel while dragging a
2887 * scroller's view to actually trigger scrolling.
2889 * @param threshold the thumb scroll threshould
2891 * @see elm_thumbscroll_threshould_get()
2892 * @ingroup Scrolling
2894 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2897 * Set the number of pixels one should travel while dragging a
2898 * scroller's view to actually trigger scrolling, for all Elementary
2899 * application windows.
2901 * @param threshold the thumb scroll threshould
2903 * @see elm_thumbscroll_threshould_get()
2904 * @ingroup Scrolling
2906 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2909 * Get the minimum speed of mouse cursor movement which will trigger
2910 * list self scrolling animation after a mouse up event
2913 * @return the thumb scroll momentum threshould
2915 * @ingroup Scrolling
2917 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2920 * Set the minimum speed of mouse cursor movement which will trigger
2921 * list self scrolling animation after a mouse up event
2924 * @param threshold the thumb scroll momentum threshould
2926 * @see elm_thumbscroll_momentum_threshould_get()
2927 * @ingroup Scrolling
2929 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2932 * Set the minimum speed of mouse cursor movement which will trigger
2933 * list self scrolling animation after a mouse up event
2934 * (pixels/second), for all Elementary application windows.
2936 * @param threshold the thumb scroll momentum threshould
2938 * @see elm_thumbscroll_momentum_threshould_get()
2939 * @ingroup Scrolling
2941 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2944 * Get the amount of inertia a scroller will impose at self scrolling
2947 * @return the thumb scroll friction
2949 * @ingroup Scrolling
2951 EAPI double elm_scroll_thumbscroll_friction_get(void);
2954 * Set the amount of inertia a scroller will impose at self scrolling
2957 * @param friction the thumb scroll friction
2959 * @see elm_thumbscroll_friction_get()
2960 * @ingroup Scrolling
2962 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2965 * Set the amount of inertia a scroller will impose at self scrolling
2966 * animations, for all Elementary application windows.
2968 * @param friction the thumb scroll friction
2970 * @see elm_thumbscroll_friction_get()
2971 * @ingroup Scrolling
2973 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2976 * Get the amount of lag between your actual mouse cursor dragging
2977 * movement and a scroller's view movement itself, while pushing it
2978 * into bounce state manually.
2980 * @return the thumb scroll border friction
2982 * @ingroup Scrolling
2984 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2987 * Set the amount of lag between your actual mouse cursor dragging
2988 * movement and a scroller's view movement itself, while pushing it
2989 * into bounce state manually.
2991 * @param friction the thumb scroll border friction. @c 0.0 for
2992 * perfect synchrony between two movements, @c 1.0 for maximum
2995 * @see elm_thumbscroll_border_friction_get()
2996 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2998 * @ingroup Scrolling
3000 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3003 * Set the amount of lag between your actual mouse cursor dragging
3004 * movement and a scroller's view movement itself, while pushing it
3005 * into bounce state manually, for all Elementary application windows.
3007 * @param friction the thumb scroll border friction. @c 0.0 for
3008 * perfect synchrony between two movements, @c 1.0 for maximum
3011 * @see elm_thumbscroll_border_friction_get()
3012 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3014 * @ingroup Scrolling
3016 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3019 * Get the sensitivity amount which is be multiplied by the length of
3022 * @return the thumb scroll sensitivity friction
3024 * @ingroup Scrolling
3026 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3029 * Set the sensitivity amount which is be multiplied by the length of
3032 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3033 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3036 * @see elm_thumbscroll_sensitivity_friction_get()
3037 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3039 * @ingroup Scrolling
3041 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3044 * Set the sensitivity amount which is be multiplied by the length of
3045 * mouse dragging, for all Elementary application windows.
3047 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3048 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3051 * @see elm_thumbscroll_sensitivity_friction_get()
3052 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3054 * @ingroup Scrolling
3056 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3063 * @defgroup Scrollhints Scrollhints
3065 * Objects when inside a scroller can scroll, but this may not always be
3066 * desirable in certain situations. This allows an object to hint to itself
3067 * and parents to "not scroll" in one of 2 ways. If any child object of a
3068 * scroller has pushed a scroll freeze or hold then it affects all parent
3069 * scrollers until all children have released them.
3071 * 1. To hold on scrolling. This means just flicking and dragging may no
3072 * longer scroll, but pressing/dragging near an edge of the scroller will
3073 * still scroll. This is automatically used by the entry object when
3076 * 2. To totally freeze scrolling. This means it stops. until
3083 * Push the scroll hold by 1
3085 * This increments the scroll hold count by one. If it is more than 0 it will
3086 * take effect on the parents of the indicated object.
3088 * @param obj The object
3089 * @ingroup Scrollhints
3091 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3094 * Pop the scroll hold by 1
3096 * This decrements the scroll hold count by one. If it is more than 0 it will
3097 * take effect on the parents of the indicated object.
3099 * @param obj The object
3100 * @ingroup Scrollhints
3102 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3105 * Push the scroll freeze by 1
3107 * This increments the scroll freeze count by one. If it is more
3108 * than 0 it will take effect on the parents of the indicated
3111 * @param obj The object
3112 * @ingroup Scrollhints
3114 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3117 * Pop the scroll freeze by 1
3119 * This decrements the scroll freeze count by one. If it is more
3120 * than 0 it will take effect on the parents of the indicated
3123 * @param obj The object
3124 * @ingroup Scrollhints
3126 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3129 * Lock the scrolling of the given widget (and thus all parents)
3131 * This locks the given object from scrolling in the X axis (and implicitly
3132 * also locks all parent scrollers too from doing the same).
3134 * @param obj The object
3135 * @param lock The lock state (1 == locked, 0 == unlocked)
3136 * @ingroup Scrollhints
3138 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3141 * Lock the scrolling of the given widget (and thus all parents)
3143 * This locks the given object from scrolling in the Y axis (and implicitly
3144 * also locks all parent scrollers too from doing the same).
3146 * @param obj The object
3147 * @param lock The lock state (1 == locked, 0 == unlocked)
3148 * @ingroup Scrollhints
3150 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3153 * Get the scrolling lock of the given widget
3155 * This gets the lock for X axis scrolling.
3157 * @param obj The object
3158 * @ingroup Scrollhints
3160 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3163 * Get the scrolling lock of the given widget
3165 * This gets the lock for X axis scrolling.
3167 * @param obj The object
3168 * @ingroup Scrollhints
3170 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3177 * Send a signal to the widget edje object.
3179 * This function sends a signal to the edje object of the obj. An
3180 * edje program can respond to a signal by specifying matching
3181 * 'signal' and 'source' fields.
3183 * @param obj The object
3184 * @param emission The signal's name.
3185 * @param source The signal's source.
3188 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3191 * Add a callback for a signal emitted by widget edje object.
3193 * This function connects a callback function to a signal emitted by the
3194 * edje object of the obj.
3195 * Globs can occur in either the emission or source name.
3197 * @param obj The object
3198 * @param emission The signal's name.
3199 * @param source The signal's source.
3200 * @param func The callback function to be executed when the signal is
3202 * @param data A pointer to data to pass in to the callback function.
3205 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);
3208 * Remove a signal-triggered callback from a widget edje object.
3210 * This function removes a callback, previoulsy attached to a
3211 * signal emitted by the edje object of the obj. The parameters
3212 * emission, source and func must match exactly those passed to a
3213 * previous call to elm_object_signal_callback_add(). The data
3214 * pointer that was passed to this call will be returned.
3216 * @param obj The object
3217 * @param emission The signal's name.
3218 * @param source The signal's source.
3219 * @param func The callback function to be executed when the signal is
3221 * @return The data pointer
3224 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);
3227 * Add a callback for input events (key up, key down, mouse wheel)
3228 * on a given Elementary widget
3230 * @param obj The widget to add an event callback on
3231 * @param func The callback function to be executed when the event
3233 * @param data Data to pass in to @p func
3235 * Every widget in an Elementary interface set to receive focus,
3236 * with elm_object_focus_allow_set(), will propagate @b all of its
3237 * key up, key down and mouse wheel input events up to its parent
3238 * object, and so on. All of the focusable ones in this chain which
3239 * had an event callback set, with this call, will be able to treat
3240 * those events. There are two ways of making the propagation of
3241 * these event upwards in the tree of widgets to @b cease:
3242 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3243 * the event was @b not processed, so the propagation will go on.
3244 * - The @c event_info pointer passed to @p func will contain the
3245 * event's structure and, if you OR its @c event_flags inner
3246 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3247 * one has already handled it, thus killing the event's
3250 * @note Your event callback will be issued on those events taking
3251 * place only if no other child widget of @obj has consumed the
3254 * @note Not to be confused with @c
3255 * evas_object_event_callback_add(), which will add event callbacks
3256 * per type on general Evas objects (no event propagation
3257 * infrastructure taken in account).
3259 * @note Not to be confused with @c
3260 * elm_object_signal_callback_add(), which will add callbacks to @b
3261 * signals coming from a widget's theme, not input events.
3263 * @note Not to be confused with @c
3264 * edje_object_signal_callback_add(), which does the same as
3265 * elm_object_signal_callback_add(), but directly on an Edje
3268 * @note Not to be confused with @c
3269 * evas_object_smart_callback_add(), which adds callbacks to smart
3270 * objects' <b>smart events</b>, and not input events.
3272 * @see elm_object_event_callback_del()
3276 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3279 * Remove an event callback from a widget.
3281 * This function removes a callback, previoulsy attached to event emission
3283 * The parameters func and data must match exactly those passed to
3284 * a previous call to elm_object_event_callback_add(). The data pointer that
3285 * was passed to this call will be returned.
3287 * @param obj The object
3288 * @param func The callback function to be executed when the event is
3290 * @param data Data to pass in to the callback function.
3291 * @return The data pointer
3294 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3297 * Adjust size of an element for finger usage.
3299 * @param times_w How many fingers should fit horizontally
3300 * @param w Pointer to the width size to adjust
3301 * @param times_h How many fingers should fit vertically
3302 * @param h Pointer to the height size to adjust
3304 * This takes width and height sizes (in pixels) as input and a
3305 * size multiple (which is how many fingers you want to place
3306 * within the area, being "finger" the size set by
3307 * elm_finger_size_set()), and adjusts the size to be large enough
3308 * to accommodate the resulting size -- if it doesn't already
3309 * accommodate it. On return the @p w and @p h sizes pointed to by
3310 * these parameters will be modified, on those conditions.
3312 * @note This is kind of a low level Elementary call, most useful
3313 * on size evaluation times for widgets. An external user wouldn't
3314 * be calling, most of the time.
3318 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3321 * Get the duration for occuring long press event.
3323 * @return Timeout for long press event
3324 * @ingroup Longpress
3326 EAPI double elm_longpress_timeout_get(void);
3329 * Set the duration for occuring long press event.
3331 * @param lonpress_timeout Timeout for long press event
3332 * @ingroup Longpress
3334 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3337 * @defgroup Debug Debug
3338 * don't use it unless you are sure
3344 * Print Tree object hierarchy in stdout
3346 * @param obj The root object
3349 EAPI void elm_object_tree_dump(const Evas_Object *top);
3350 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3352 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3353 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3355 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3357 * @param obj The root object
3358 * @param file The path of output file
3361 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3368 * @defgroup Theme Theme
3370 * Elementary uses Edje to theme its widgets, naturally. But for the most
3371 * part this is hidden behind a simpler interface that lets the user set
3372 * extensions and choose the style of widgets in a much easier way.
3374 * Instead of thinking in terms of paths to Edje files and their groups
3375 * each time you want to change the appearance of a widget, Elementary
3376 * works so you can add any theme file with extensions or replace the
3377 * main theme at one point in the application, and then just set the style
3378 * of widgets with elm_object_style_set() and related functions. Elementary
3379 * will then look in its list of themes for a matching group and apply it,
3380 * and when the theme changes midway through the application, all widgets
3381 * will be updated accordingly.
3383 * There are three concepts you need to know to understand how Elementary
3384 * theming works: default theme, extensions and overlays.
3386 * Default theme, obviously enough, is the one that provides the default
3387 * look of all widgets. End users can change the theme used by Elementary
3388 * by setting the @c ELM_THEME environment variable before running an
3389 * application, or globally for all programs using the @c elementary_config
3390 * utility. Applications can change the default theme using elm_theme_set(),
3391 * but this can go against the user wishes, so it's not an adviced practice.
3393 * Ideally, applications should find everything they need in the already
3394 * provided theme, but there may be occasions when that's not enough and
3395 * custom styles are required to correctly express the idea. For this
3396 * cases, Elementary has extensions.
3398 * Extensions allow the application developer to write styles of its own
3399 * to apply to some widgets. This requires knowledge of how each widget
3400 * is themed, as extensions will always replace the entire group used by
3401 * the widget, so important signals and parts need to be there for the
3402 * object to behave properly (see documentation of Edje for details).
3403 * Once the theme for the extension is done, the application needs to add
3404 * it to the list of themes Elementary will look into, using
3405 * elm_theme_extension_add(), and set the style of the desired widgets as
3406 * he would normally with elm_object_style_set().
3408 * Overlays, on the other hand, can replace the look of all widgets by
3409 * overriding the default style. Like extensions, it's up to the application
3410 * developer to write the theme for the widgets it wants, the difference
3411 * being that when looking for the theme, Elementary will check first the
3412 * list of overlays, then the set theme and lastly the list of extensions,
3413 * so with overlays it's possible to replace the default view and every
3414 * widget will be affected. This is very much alike to setting the whole
3415 * theme for the application and will probably clash with the end user
3416 * options, not to mention the risk of ending up with not matching styles
3417 * across the program. Unless there's a very special reason to use them,
3418 * overlays should be avoided for the resons exposed before.
3420 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3421 * keeps one default internally and every function that receives one of
3422 * these can be called with NULL to refer to this default (except for
3423 * elm_theme_free()). It's possible to create a new instance of a
3424 * ::Elm_Theme to set other theme for a specific widget (and all of its
3425 * children), but this is as discouraged, if not even more so, than using
3426 * overlays. Don't use this unless you really know what you are doing.
3428 * But to be less negative about things, you can look at the following
3430 * @li @ref theme_example_01 "Using extensions"
3431 * @li @ref theme_example_02 "Using overlays"
3436 * @typedef Elm_Theme
3438 * Opaque handler for the list of themes Elementary looks for when
3439 * rendering widgets.
3441 * Stay out of this unless you really know what you are doing. For most
3442 * cases, sticking to the default is all a developer needs.
3444 typedef struct _Elm_Theme Elm_Theme;
3447 * Create a new specific theme
3449 * This creates an empty specific theme that only uses the default theme. A
3450 * specific theme has its own private set of extensions and overlays too
3451 * (which are empty by default). Specific themes do not fall back to themes
3452 * of parent objects. They are not intended for this use. Use styles, overlays
3453 * and extensions when needed, but avoid specific themes unless there is no
3454 * other way (example: you want to have a preview of a new theme you are
3455 * selecting in a "theme selector" window. The preview is inside a scroller
3456 * and should display what the theme you selected will look like, but not
3457 * actually apply it yet. The child of the scroller will have a specific
3458 * theme set to show this preview before the user decides to apply it to all
3461 EAPI Elm_Theme *elm_theme_new(void);
3463 * Free a specific theme
3465 * @param th The theme to free
3467 * This frees a theme created with elm_theme_new().
3469 EAPI void elm_theme_free(Elm_Theme *th);
3471 * Copy the theme fom the source to the destination theme
3473 * @param th The source theme to copy from
3474 * @param thdst The destination theme to copy data to
3476 * This makes a one-time static copy of all the theme config, extensions
3477 * and overlays from @p th to @p thdst. If @p th references a theme, then
3478 * @p thdst is also set to reference it, with all the theme settings,
3479 * overlays and extensions that @p th had.
3481 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3483 * Tell the source theme to reference the ref theme
3485 * @param th The theme that will do the referencing
3486 * @param thref The theme that is the reference source
3488 * This clears @p th to be empty and then sets it to refer to @p thref
3489 * so @p th acts as an override to @p thref, but where its overrides
3490 * don't apply, it will fall through to @p thref for configuration.
3492 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3494 * Return the theme referred to
3496 * @param th The theme to get the reference from
3497 * @return The referenced theme handle
3499 * This gets the theme set as the reference theme by elm_theme_ref_set().
3500 * If no theme is set as a reference, NULL is returned.
3502 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3504 * Return the default theme
3506 * @return The default theme handle
3508 * This returns the internal default theme setup handle that all widgets
3509 * use implicitly unless a specific theme is set. This is also often use
3510 * as a shorthand of NULL.
3512 EAPI Elm_Theme *elm_theme_default_get(void);
3514 * Prepends a theme overlay to the list of overlays
3516 * @param th The theme to add to, or if NULL, the default theme
3517 * @param item The Edje file path to be used
3519 * Use this if your application needs to provide some custom overlay theme
3520 * (An Edje file that replaces some default styles of widgets) where adding
3521 * new styles, or changing system theme configuration is not possible. Do
3522 * NOT use this instead of a proper system theme configuration. Use proper
3523 * configuration files, profiles, environment variables etc. to set a theme
3524 * so that the theme can be altered by simple confiugration by a user. Using
3525 * this call to achieve that effect is abusing the API and will create lots
3528 * @see elm_theme_extension_add()
3530 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3532 * Delete a theme overlay from the list of overlays
3534 * @param th The theme to delete from, or if NULL, the default theme
3535 * @param item The name of the theme overlay
3537 * @see elm_theme_overlay_add()
3539 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3541 * Appends a theme extension to the list of extensions.
3543 * @param th The theme to add to, or if NULL, the default theme
3544 * @param item The Edje file path to be used
3546 * This is intended when an application needs more styles of widgets or new
3547 * widget themes that the default does not provide (or may not provide). The
3548 * application has "extended" usage by coming up with new custom style names
3549 * for widgets for specific uses, but as these are not "standard", they are
3550 * not guaranteed to be provided by a default theme. This means the
3551 * application is required to provide these extra elements itself in specific
3552 * Edje files. This call adds one of those Edje files to the theme search
3553 * path to be search after the default theme. The use of this call is
3554 * encouraged when default styles do not meet the needs of the application.
3555 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3557 * @see elm_object_style_set()
3559 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3561 * Deletes a theme extension from the list of extensions.
3563 * @param th The theme to delete from, or if NULL, the default theme
3564 * @param item The name of the theme extension
3566 * @see elm_theme_extension_add()
3568 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3570 * Set the theme search order for the given theme
3572 * @param th The theme to set the search order, or if NULL, the default theme
3573 * @param theme Theme search string
3575 * This sets the search string for the theme in path-notation from first
3576 * theme to search, to last, delimited by the : character. Example:
3578 * "shiny:/path/to/file.edj:default"
3580 * See the ELM_THEME environment variable for more information.
3582 * @see elm_theme_get()
3583 * @see elm_theme_list_get()
3585 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3587 * Return the theme search order
3589 * @param th The theme to get the search order, or if NULL, the default theme
3590 * @return The internal search order path
3592 * This function returns a colon separated string of theme elements as
3593 * returned by elm_theme_list_get().
3595 * @see elm_theme_set()
3596 * @see elm_theme_list_get()
3598 EAPI const char *elm_theme_get(Elm_Theme *th);
3600 * Return a list of theme elements to be used in a theme.
3602 * @param th Theme to get the list of theme elements from.
3603 * @return The internal list of theme elements
3605 * This returns the internal list of theme elements (will only be valid as
3606 * long as the theme is not modified by elm_theme_set() or theme is not
3607 * freed by elm_theme_free(). This is a list of strings which must not be
3608 * altered as they are also internal. If @p th is NULL, then the default
3609 * theme element list is returned.
3611 * A theme element can consist of a full or relative path to a .edj file,
3612 * or a name, without extension, for a theme to be searched in the known
3613 * theme paths for Elemementary.
3615 * @see elm_theme_set()
3616 * @see elm_theme_get()
3618 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3620 * Return the full patrh for a theme element
3622 * @param f The theme element name
3623 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3624 * @return The full path to the file found.
3626 * This returns a string you should free with free() on success, NULL on
3627 * failure. This will search for the given theme element, and if it is a
3628 * full or relative path element or a simple searchable name. The returned
3629 * path is the full path to the file, if searched, and the file exists, or it
3630 * is simply the full path given in the element or a resolved path if
3631 * relative to home. The @p in_search_path boolean pointed to is set to
3632 * EINA_TRUE if the file was a searchable file andis in the search path,
3633 * and EINA_FALSE otherwise.
3635 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3637 * Flush the current theme.
3639 * @param th Theme to flush
3641 * This flushes caches that let elementary know where to find theme elements
3642 * in the given theme. If @p th is NULL, then the default theme is flushed.
3643 * Call this function if source theme data has changed in such a way as to
3644 * make any caches Elementary kept invalid.
3646 EAPI void elm_theme_flush(Elm_Theme *th);
3648 * This flushes all themes (default and specific ones).
3650 * This will flush all themes in the current application context, by calling
3651 * elm_theme_flush() on each of them.
3653 EAPI void elm_theme_full_flush(void);
3655 * Set the theme for all elementary using applications on the current display
3657 * @param theme The name of the theme to use. Format same as the ELM_THEME
3658 * environment variable.
3660 EAPI void elm_theme_all_set(const char *theme);
3662 * Return a list of theme elements in the theme search path
3664 * @return A list of strings that are the theme element names.
3666 * This lists all available theme files in the standard Elementary search path
3667 * for theme elements, and returns them in alphabetical order as theme
3668 * element names in a list of strings. Free this with
3669 * elm_theme_name_available_list_free() when you are done with the list.
3671 EAPI Eina_List *elm_theme_name_available_list_new(void);
3673 * Free the list returned by elm_theme_name_available_list_new()
3675 * This frees the list of themes returned by
3676 * elm_theme_name_available_list_new(). Once freed the list should no longer
3677 * be used. a new list mys be created.
3679 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3681 * Set a specific theme to be used for this object and its children
3683 * @param obj The object to set the theme on
3684 * @param th The theme to set
3686 * This sets a specific theme that will be used for the given object and any
3687 * child objects it has. If @p th is NULL then the theme to be used is
3688 * cleared and the object will inherit its theme from its parent (which
3689 * ultimately will use the default theme if no specific themes are set).
3691 * Use special themes with great care as this will annoy users and make
3692 * configuration difficult. Avoid any custom themes at all if it can be
3695 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3697 * Get the specific theme to be used
3699 * @param obj The object to get the specific theme from
3700 * @return The specifc theme set.
3702 * This will return a specific theme set, or NULL if no specific theme is
3703 * set on that object. It will not return inherited themes from parents, only
3704 * the specific theme set for that specific object. See elm_object_theme_set()
3705 * for more information.
3707 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3710 * Get a data item from a theme
3712 * @param th The theme, or NULL for default theme
3713 * @param key The data key to search with
3714 * @return The data value, or NULL on failure
3716 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3717 * It works the same way as edje_file_data_get() except that the return is stringshared.
3719 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3725 /** @defgroup Win Win
3727 * @image html img/widget/win/preview-00.png
3728 * @image latex img/widget/win/preview-00.eps
3730 * The window class of Elementary. Contains functions to manipulate
3731 * windows. The Evas engine used to render the window contents is specified
3732 * in the system or user elementary config files (whichever is found last),
3733 * and can be overridden with the ELM_ENGINE environment variable for
3734 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3735 * compilation setup and modules actually installed at runtime) are (listed
3736 * in order of best supported and most likely to be complete and work to
3739 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3740 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3742 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3744 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3746 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3748 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3749 * rendering using SDL as the buffer)
3750 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3751 * GDI with software)
3752 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3753 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3754 * grayscale using dedicated 8bit software engine in X11)
3755 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3756 * X11 using 16bit software engine)
3757 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3758 * (Windows CE rendering via GDI with 16bit software renderer)
3759 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3760 * buffer with 16bit software renderer)
3761 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3762 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3763 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3765 * All engines use a simple string to select the engine to render, EXCEPT
3766 * the "shot" engine. This actually encodes the output of the virtual
3767 * screenshot and how long to delay in the engine string. The engine string
3768 * is encoded in the following way:
3770 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3772 * Where options are separated by a ":" char if more than one option is
3773 * given, with delay, if provided being the first option and file the last
3774 * (order is important). The delay specifies how long to wait after the
3775 * window is shown before doing the virtual "in memory" rendering and then
3776 * save the output to the file specified by the file option (and then exit).
3777 * If no delay is given, the default is 0.5 seconds. If no file is given the
3778 * default output file is "out.png". Repeat option is for continous
3779 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3780 * fixed to "out001.png" Some examples of using the shot engine:
3782 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3783 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3784 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3785 * ELM_ENGINE="shot:delay=2.0" elementary_test
3786 * ELM_ENGINE="shot:" elementary_test
3788 * Signals that you can add callbacks for are:
3790 * @li "delete,request": the user requested to close the window. See
3791 * elm_win_autodel_set().
3792 * @li "focus,in": window got focus
3793 * @li "focus,out": window lost focus
3794 * @li "moved": window that holds the canvas was moved
3797 * @li @ref win_example_01
3802 * Defines the types of window that can be created
3804 * These are hints set on the window so that a running Window Manager knows
3805 * how the window should be handled and/or what kind of decorations it
3808 * Currently, only the X11 backed engines use them.
3810 typedef enum _Elm_Win_Type
3812 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3813 window. Almost every window will be created with this
3815 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3816 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3817 window holding desktop icons. */
3818 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3819 be kept on top of any other window by the Window
3821 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3823 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3824 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3826 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3827 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3828 entry in a menubar is clicked. Typically used
3829 with elm_win_override_set(). This hint exists
3830 for completion only, as the EFL way of
3831 implementing a menu would not normally use a
3832 separate window for its contents. */
3833 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3834 triggered by right-clicking an object. */
3835 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3836 explanatory text that typically appear after the
3837 mouse cursor hovers over an object for a while.
3838 Typically used with elm_win_override_set() and also
3839 not very commonly used in the EFL. */
3840 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3841 battery life or a new E-Mail received. */
3842 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3843 usually used in the EFL. */
3844 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3845 object being dragged across different windows, or even
3846 applications. Typically used with
3847 elm_win_override_set(). */
3848 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3849 buffer. No actual window is created for this
3850 type, instead the window and all of its
3851 contents will be rendered to an image buffer.
3852 This allows to have children window inside a
3853 parent one just like any other object would
3854 be, and do other things like applying @c
3855 Evas_Map effects to it. This is the only type
3856 of window that requires the @c parent
3857 parameter of elm_win_add() to be a valid @c
3862 * The differents layouts that can be requested for the virtual keyboard.
3864 * When the application window is being managed by Illume, it may request
3865 * any of the following layouts for the virtual keyboard.
3867 typedef enum _Elm_Win_Keyboard_Mode
3869 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3870 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3871 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3872 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3873 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3874 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3875 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3876 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3877 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3878 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3879 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3880 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3881 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3882 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3883 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3884 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3885 } Elm_Win_Keyboard_Mode;
3888 * Available commands that can be sent to the Illume manager.
3890 * When running under an Illume session, a window may send commands to the
3891 * Illume manager to perform different actions.
3893 typedef enum _Elm_Illume_Command
3895 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3897 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3899 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3901 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3902 } Elm_Illume_Command;
3905 * Adds a window object. If this is the first window created, pass NULL as
3908 * @param parent Parent object to add the window to, or NULL
3909 * @param name The name of the window
3910 * @param type The window type, one of #Elm_Win_Type.
3912 * The @p parent paramter can be @c NULL for every window @p type except
3913 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3914 * which the image object will be created.
3916 * @return The created object, or NULL on failure
3918 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3920 * Adds a window object with standard setup
3922 * @param name The name of the window
3923 * @param title The title for the window
3925 * This creates a window like elm_win_add() but also puts in a standard
3926 * background with elm_bg_add(), as well as setting the window title to
3927 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3928 * as the parent widget.
3930 * @return The created object, or NULL on failure
3932 * @see elm_win_add()
3934 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3936 * Add @p subobj as a resize object of window @p obj.
3939 * Setting an object as a resize object of the window means that the
3940 * @p subobj child's size and position will be controlled by the window
3941 * directly. That is, the object will be resized to match the window size
3942 * and should never be moved or resized manually by the developer.
3944 * In addition, resize objects of the window control what the minimum size
3945 * of it will be, as well as whether it can or not be resized by the user.
3947 * For the end user to be able to resize a window by dragging the handles
3948 * or borders provided by the Window Manager, or using any other similar
3949 * mechanism, all of the resize objects in the window should have their
3950 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3952 * @param obj The window object
3953 * @param subobj The resize object to add
3955 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3957 * Delete @p subobj as a resize object of window @p obj.
3959 * This function removes the object @p subobj from the resize objects of
3960 * the window @p obj. It will not delete the object itself, which will be
3961 * left unmanaged and should be deleted by the developer, manually handled
3962 * or set as child of some other container.
3964 * @param obj The window object
3965 * @param subobj The resize object to add
3967 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3969 * Set the title of the window
3971 * @param obj The window object
3972 * @param title The title to set
3974 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3976 * Get the title of the window
3978 * The returned string is an internal one and should not be freed or
3979 * modified. It will also be rendered invalid if a new title is set or if
3980 * the window is destroyed.
3982 * @param obj The window object
3985 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3987 * Set the window's autodel state.
3989 * When closing the window in any way outside of the program control, like
3990 * pressing the X button in the titlebar or using a command from the
3991 * Window Manager, a "delete,request" signal is emitted to indicate that
3992 * this event occurred and the developer can take any action, which may
3993 * include, or not, destroying the window object.
3995 * When the @p autodel parameter is set, the window will be automatically
3996 * destroyed when this event occurs, after the signal is emitted.
3997 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3998 * and is up to the program to do so when it's required.
4000 * @param obj The window object
4001 * @param autodel If true, the window will automatically delete itself when
4004 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4006 * Get the window's autodel state.
4008 * @param obj The window object
4009 * @return If the window will automatically delete itself when closed
4011 * @see elm_win_autodel_set()
4013 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4015 * Activate a window object.
4017 * This function sends a request to the Window Manager to activate the
4018 * window pointed by @p obj. If honored by the WM, the window will receive
4019 * the keyboard focus.
4021 * @note This is just a request that a Window Manager may ignore, so calling
4022 * this function does not ensure in any way that the window will be the
4023 * active one after it.
4025 * @param obj The window object
4027 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4029 * Lower a window object.
4031 * Places the window pointed by @p obj at the bottom of the stack, so that
4032 * no other window is covered by it.
4034 * If elm_win_override_set() is not set, the Window Manager may ignore this
4037 * @param obj The window object
4039 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4041 * Raise a window object.
4043 * Places the window pointed by @p obj at the top of the stack, so that it's
4044 * not covered by any other window.
4046 * If elm_win_override_set() is not set, the Window Manager may ignore this
4049 * @param obj The window object
4051 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4053 * Set the borderless state of a window.
4055 * This function requests the Window Manager to not draw any decoration
4056 * around the window.
4058 * @param obj The window object
4059 * @param borderless If true, the window is borderless
4061 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4063 * Get the borderless state of a window.
4065 * @param obj The window object
4066 * @return If true, the window is borderless
4068 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4070 * Set the shaped state of a window.
4072 * Shaped windows, when supported, will render the parts of the window that
4073 * has no content, transparent.
4075 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4076 * background object or cover the entire window in any other way, or the
4077 * parts of the canvas that have no data will show framebuffer artifacts.
4079 * @param obj The window object
4080 * @param shaped If true, the window is shaped
4082 * @see elm_win_alpha_set()
4084 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4086 * Get the shaped state of a window.
4088 * @param obj The window object
4089 * @return If true, the window is shaped
4091 * @see elm_win_shaped_set()
4093 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4095 * Set the alpha channel state of a window.
4097 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4098 * possibly making parts of the window completely or partially transparent.
4099 * This is also subject to the underlying system supporting it, like for
4100 * example, running under a compositing manager. If no compositing is
4101 * available, enabling this option will instead fallback to using shaped
4102 * windows, with elm_win_shaped_set().
4104 * @param obj The window object
4105 * @param alpha If true, the window has an alpha channel
4107 * @see elm_win_alpha_set()
4109 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4111 * Get the transparency state of a window.
4113 * @param obj The window object
4114 * @return If true, the window is transparent
4116 * @see elm_win_transparent_set()
4118 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4120 * Set the transparency state of a window.
4122 * Use elm_win_alpha_set() instead.
4124 * @param obj The window object
4125 * @param transparent If true, the window is transparent
4127 * @see elm_win_alpha_set()
4129 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4131 * Get the alpha channel state of a window.
4133 * @param obj The window object
4134 * @return If true, the window has an alpha channel
4136 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138 * Set the override state of a window.
4140 * A window with @p override set to EINA_TRUE will not be managed by the
4141 * Window Manager. This means that no decorations of any kind will be shown
4142 * for it, moving and resizing must be handled by the application, as well
4143 * as the window visibility.
4145 * This should not be used for normal windows, and even for not so normal
4146 * ones, it should only be used when there's a good reason and with a lot
4147 * of care. Mishandling override windows may result situations that
4148 * disrupt the normal workflow of the end user.
4150 * @param obj The window object
4151 * @param override If true, the window is overridden
4153 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4155 * Get the override state of a window.
4157 * @param obj The window object
4158 * @return If true, the window is overridden
4160 * @see elm_win_override_set()
4162 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4164 * Set the fullscreen state of a window.
4166 * @param obj The window object
4167 * @param fullscreen If true, the window is fullscreen
4169 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4171 * Get the fullscreen state of a window.
4173 * @param obj The window object
4174 * @return If true, the window is fullscreen
4176 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4178 * Set the maximized state of a window.
4180 * @param obj The window object
4181 * @param maximized If true, the window is maximized
4183 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4185 * Get the maximized state of a window.
4187 * @param obj The window object
4188 * @return If true, the window is maximized
4190 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4192 * Set the iconified state of a window.
4194 * @param obj The window object
4195 * @param iconified If true, the window is iconified
4197 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4199 * Get the iconified state of a window.
4201 * @param obj The window object
4202 * @return If true, the window is iconified
4204 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4206 * Set the layer of the window.
4208 * What this means exactly will depend on the underlying engine used.
4210 * In the case of X11 backed engines, the value in @p layer has the
4211 * following meanings:
4212 * @li < 3: The window will be placed below all others.
4213 * @li > 5: The window will be placed above all others.
4214 * @li other: The window will be placed in the default layer.
4216 * @param obj The window object
4217 * @param layer The layer of the window
4219 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4221 * Get the layer of the window.
4223 * @param obj The window object
4224 * @return The layer of the window
4226 * @see elm_win_layer_set()
4228 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4230 * Set the rotation of the window.
4232 * Most engines only work with multiples of 90.
4234 * This function is used to set the orientation of the window @p obj to
4235 * match that of the screen. The window itself will be resized to adjust
4236 * to the new geometry of its contents. If you want to keep the window size,
4237 * see elm_win_rotation_with_resize_set().
4239 * @param obj The window object
4240 * @param rotation The rotation of the window, in degrees (0-360),
4241 * counter-clockwise.
4243 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4245 * Rotates the window and resizes it.
4247 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4248 * that they fit inside the current window geometry.
4250 * @param obj The window object
4251 * @param layer The rotation of the window in degrees (0-360),
4252 * counter-clockwise.
4254 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4256 * Get the rotation of the window.
4258 * @param obj The window object
4259 * @return The rotation of the window in degrees (0-360)
4261 * @see elm_win_rotation_set()
4262 * @see elm_win_rotation_with_resize_set()
4264 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4266 * Set the sticky state of the window.
4268 * Hints the Window Manager that the window in @p obj should be left fixed
4269 * at its position even when the virtual desktop it's on moves or changes.
4271 * @param obj The window object
4272 * @param sticky If true, the window's sticky state is enabled
4274 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4276 * Get the sticky state of the window.
4278 * @param obj The window object
4279 * @return If true, the window's sticky state is enabled
4281 * @see elm_win_sticky_set()
4283 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4285 * Set if this window is an illume conformant window
4287 * @param obj The window object
4288 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4290 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4292 * Get if this window is an illume conformant window
4294 * @param obj The window object
4295 * @return A boolean if this window is illume conformant or not
4297 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4299 * Set a window to be an illume quickpanel window
4301 * By default window objects are not quickpanel windows.
4303 * @param obj The window object
4304 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4306 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4308 * Get if this window is a quickpanel or not
4310 * @param obj The window object
4311 * @return A boolean if this window is a quickpanel or not
4313 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4315 * Set the major priority of a quickpanel window
4317 * @param obj The window object
4318 * @param priority The major priority for this quickpanel
4320 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4322 * Get the major priority of a quickpanel window
4324 * @param obj The window object
4325 * @return The major priority of this quickpanel
4327 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4329 * Set the minor priority of a quickpanel window
4331 * @param obj The window object
4332 * @param priority The minor priority for this quickpanel
4334 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4336 * Get the minor priority of a quickpanel window
4338 * @param obj The window object
4339 * @return The minor priority of this quickpanel
4341 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4343 * Set which zone this quickpanel should appear in
4345 * @param obj The window object
4346 * @param zone The requested zone for this quickpanel
4348 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4350 * Get which zone this quickpanel should appear in
4352 * @param obj The window object
4353 * @return The requested zone for this quickpanel
4355 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4357 * Set the window to be skipped by keyboard focus
4359 * This sets the window to be skipped by normal keyboard input. This means
4360 * a window manager will be asked to not focus this window as well as omit
4361 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4363 * Call this and enable it on a window BEFORE you show it for the first time,
4364 * otherwise it may have no effect.
4366 * Use this for windows that have only output information or might only be
4367 * interacted with by the mouse or fingers, and never for typing input.
4368 * Be careful that this may have side-effects like making the window
4369 * non-accessible in some cases unless the window is specially handled. Use
4372 * @param obj The window object
4373 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4375 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4377 * Send a command to the windowing environment
4379 * This is intended to work in touchscreen or small screen device
4380 * environments where there is a more simplistic window management policy in
4381 * place. This uses the window object indicated to select which part of the
4382 * environment to control (the part that this window lives in), and provides
4383 * a command and an optional parameter structure (use NULL for this if not
4386 * @param obj The window object that lives in the environment to control
4387 * @param command The command to send
4388 * @param params Optional parameters for the command
4390 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4392 * Get the inlined image object handle
4394 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4395 * then the window is in fact an evas image object inlined in the parent
4396 * canvas. You can get this object (be careful to not manipulate it as it
4397 * is under control of elementary), and use it to do things like get pixel
4398 * data, save the image to a file, etc.
4400 * @param obj The window object to get the inlined image from
4401 * @return The inlined image object, or NULL if none exists
4403 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4405 * Get screen geometry details for the screen that a window is on
4406 * @param obj The window to query
4407 * @param x where to return the horizontal offset value. May be NULL.
4408 * @param y where to return the vertical offset value. May be NULL.
4409 * @param w where to return the width value. May be NULL.
4410 * @param h where to return the height value. May be NULL.
4412 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4414 * Set the enabled status for the focus highlight in a window
4416 * This function will enable or disable the focus highlight only for the
4417 * given window, regardless of the global setting for it
4419 * @param obj The window where to enable the highlight
4420 * @param enabled The enabled value for the highlight
4422 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4424 * Get the enabled value of the focus highlight for this window
4426 * @param obj The window in which to check if the focus highlight is enabled
4428 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4430 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4432 * Set the style for the focus highlight on this window
4434 * Sets the style to use for theming the highlight of focused objects on
4435 * the given window. If @p style is NULL, the default will be used.
4437 * @param obj The window where to set the style
4438 * @param style The style to set
4440 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4442 * Get the style set for the focus highlight object
4444 * Gets the style set for this windows highilght object, or NULL if none
4447 * @param obj The window to retrieve the highlights style from
4449 * @return The style set or NULL if none was. Default is used in that case.
4451 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4452 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4453 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4455 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4456 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4457 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4458 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4459 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4460 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4461 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4463 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4464 * (blank mouse, private mouse obj, defaultmouse)
4468 * Sets the keyboard mode of the window.
4470 * @param obj The window object
4471 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4473 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4475 * Gets the keyboard mode of the window.
4477 * @param obj The window object
4478 * @return The mode, one of #Elm_Win_Keyboard_Mode
4480 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4482 * Sets whether the window is a keyboard.
4484 * @param obj The window object
4485 * @param is_keyboard If true, the window is a virtual keyboard
4487 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4489 * Gets whether the window is a keyboard.
4491 * @param obj The window object
4492 * @return If the window is a virtual keyboard
4494 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4497 * Get the screen position of a window.
4499 * @param obj The window object
4500 * @param x The int to store the x coordinate to
4501 * @param y The int to store the y coordinate to
4503 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4509 * @defgroup Inwin Inwin
4511 * @image html img/widget/inwin/preview-00.png
4512 * @image latex img/widget/inwin/preview-00.eps
4513 * @image html img/widget/inwin/preview-01.png
4514 * @image latex img/widget/inwin/preview-01.eps
4515 * @image html img/widget/inwin/preview-02.png
4516 * @image latex img/widget/inwin/preview-02.eps
4518 * An inwin is a window inside a window that is useful for a quick popup.
4519 * It does not hover.
4521 * It works by creating an object that will occupy the entire window, so it
4522 * must be created using an @ref Win "elm_win" as parent only. The inwin
4523 * object can be hidden or restacked below every other object if it's
4524 * needed to show what's behind it without destroying it. If this is done,
4525 * the elm_win_inwin_activate() function can be used to bring it back to
4526 * full visibility again.
4528 * There are three styles available in the default theme. These are:
4529 * @li default: The inwin is sized to take over most of the window it's
4531 * @li minimal: The size of the inwin will be the minimum necessary to show
4533 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4534 * possible, but it's sized vertically the most it needs to fit its\
4537 * Some examples of Inwin can be found in the following:
4538 * @li @ref inwin_example_01
4543 * Adds an inwin to the current window
4545 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4546 * Never call this function with anything other than the top-most window
4547 * as its parameter, unless you are fond of undefined behavior.
4549 * After creating the object, the widget will set itself as resize object
4550 * for the window with elm_win_resize_object_add(), so when shown it will
4551 * appear to cover almost the entire window (how much of it depends on its
4552 * content and the style used). It must not be added into other container
4553 * objects and it needs not be moved or resized manually.
4555 * @param parent The parent object
4556 * @return The new object or NULL if it cannot be created
4558 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4560 * Activates an inwin object, ensuring its visibility
4562 * This function will make sure that the inwin @p obj is completely visible
4563 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4564 * to the front. It also sets the keyboard focus to it, which will be passed
4567 * The object's theme will also receive the signal "elm,action,show" with
4570 * @param obj The inwin to activate
4572 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4574 * Set the content of an inwin object.
4576 * Once the content object is set, a previously set one will be deleted.
4577 * If you want to keep that old content object, use the
4578 * elm_win_inwin_content_unset() function.
4580 * @param obj The inwin object
4581 * @param content The object to set as content
4583 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4585 * Get the content of an inwin object.
4587 * Return the content object which is set for this widget.
4589 * The returned object is valid as long as the inwin is still alive and no
4590 * other content is set on it. Deleting the object will notify the inwin
4591 * about it and this one will be left empty.
4593 * If you need to remove an inwin's content to be reused somewhere else,
4594 * see elm_win_inwin_content_unset().
4596 * @param obj The inwin object
4597 * @return The content that is being used
4599 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4601 * Unset the content of an inwin object.
4603 * Unparent and return the content object which was set for this widget.
4605 * @param obj The inwin object
4606 * @return The content that was being used
4608 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4612 /* X specific calls - won't work on non-x engines (return 0) */
4615 * Get the Ecore_X_Window of an Evas_Object
4617 * @param obj The object
4619 * @return The Ecore_X_Window of @p obj
4623 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4625 /* smart callbacks called:
4626 * "delete,request" - the user requested to delete the window
4627 * "focus,in" - window got focus
4628 * "focus,out" - window lost focus
4629 * "moved" - window that holds the canvas was moved
4635 * @image html img/widget/bg/preview-00.png
4636 * @image latex img/widget/bg/preview-00.eps
4638 * @brief Background object, used for setting a solid color, image or Edje
4639 * group as background to a window or any container object.
4641 * The bg object is used for setting a solid background to a window or
4642 * packing into any container object. It works just like an image, but has
4643 * some properties useful to a background, like setting it to tiled,
4644 * centered, scaled or stretched.
4646 * Default contents parts of the bg widget that you can use for are:
4647 * @li "overlay" - overlay of the bg
4649 * Here is some sample code using it:
4650 * @li @ref bg_01_example_page
4651 * @li @ref bg_02_example_page
4652 * @li @ref bg_03_example_page
4656 typedef enum _Elm_Bg_Option
4658 ELM_BG_OPTION_CENTER, /**< center the background */
4659 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4660 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4661 ELM_BG_OPTION_TILE /**< tile background at its original size */
4665 * Add a new background to the parent
4667 * @param parent The parent object
4668 * @return The new object or NULL if it cannot be created
4672 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4675 * Set the file (image or edje) used for the background
4677 * @param obj The bg object
4678 * @param file The file path
4679 * @param group Optional key (group in Edje) within the file
4681 * This sets the image file used in the background object. The image (or edje)
4682 * will be stretched (retaining aspect if its an image file) to completely fill
4683 * the bg object. This may mean some parts are not visible.
4685 * @note Once the image of @p obj is set, a previously set one will be deleted,
4686 * even if @p file is NULL.
4690 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4693 * Get the file (image or edje) used for the background
4695 * @param obj The bg object
4696 * @param file The file path
4697 * @param group Optional key (group in Edje) within the file
4701 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4704 * Set the option used for the background image
4706 * @param obj The bg object
4707 * @param option The desired background option (TILE, SCALE)
4709 * This sets the option used for manipulating the display of the background
4710 * image. The image can be tiled or scaled.
4714 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4717 * Get the option used for the background image
4719 * @param obj The bg object
4720 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4724 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4726 * Set the option used for the background color
4728 * @param obj The bg object
4733 * This sets the color used for the background rectangle. Its range goes
4738 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4740 * Get the option used for the background color
4742 * @param obj The bg object
4749 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4752 * Set the overlay object used for the background object.
4754 * @param obj The bg object
4755 * @param overlay The overlay object
4757 * This provides a way for elm_bg to have an 'overlay' that will be on top
4758 * of the bg. Once the over object is set, a previously set one will be
4759 * deleted, even if you set the new one to NULL. If you want to keep that
4760 * old content object, use the elm_bg_overlay_unset() function.
4762 * @deprecated use elm_object_part_content_set() instead
4767 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4770 * Get the overlay object used for the background object.
4772 * @param obj The bg object
4773 * @return The content that is being used
4775 * Return the content object which is set for this widget
4777 * @deprecated use elm_object_part_content_get() instead
4781 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4784 * Get the overlay object used for the background object.
4786 * @param obj The bg object
4787 * @return The content that was being used
4789 * Unparent and return the overlay object which was set for this widget
4791 * @deprecated use elm_object_part_content_unset() instead
4795 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4798 * Set the size of the pixmap representation of the image.
4800 * This option just makes sense if an image is going to be set in the bg.
4802 * @param obj The bg object
4803 * @param w The new width of the image pixmap representation.
4804 * @param h The new height of the image pixmap representation.
4806 * This function sets a new size for pixmap representation of the given bg
4807 * image. It allows the image to be loaded already in the specified size,
4808 * reducing the memory usage and load time when loading a big image with load
4809 * size set to a smaller size.
4811 * NOTE: this is just a hint, the real size of the pixmap may differ
4812 * depending on the type of image being loaded, being bigger than requested.
4816 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4817 /* smart callbacks called:
4821 * @defgroup Icon Icon
4823 * @image html img/widget/icon/preview-00.png
4824 * @image latex img/widget/icon/preview-00.eps
4826 * An object that provides standard icon images (delete, edit, arrows, etc.)
4827 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4829 * The icon image requested can be in the elementary theme, or in the
4830 * freedesktop.org paths. It's possible to set the order of preference from
4831 * where the image will be used.
4833 * This API is very similar to @ref Image, but with ready to use images.
4835 * Default images provided by the theme are described below.
4837 * The first list contains icons that were first intended to be used in
4838 * toolbars, but can be used in many other places too:
4854 * Now some icons that were designed to be used in menus (but again, you can
4855 * use them anywhere else):
4860 * @li menu/arrow_down
4861 * @li menu/arrow_left
4862 * @li menu/arrow_right
4871 * And here we have some media player specific icons:
4872 * @li media_player/forward
4873 * @li media_player/info
4874 * @li media_player/next
4875 * @li media_player/pause
4876 * @li media_player/play
4877 * @li media_player/prev
4878 * @li media_player/rewind
4879 * @li media_player/stop
4881 * Signals that you can add callbacks for are:
4883 * "clicked" - This is called when a user has clicked the icon
4885 * An example of usage for this API follows:
4886 * @li @ref tutorial_icon
4894 typedef enum _Elm_Icon_Type
4901 * @enum _Elm_Icon_Lookup_Order
4902 * @typedef Elm_Icon_Lookup_Order
4904 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4905 * theme, FDO paths, or both?
4909 typedef enum _Elm_Icon_Lookup_Order
4911 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4912 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4913 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4914 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4915 } Elm_Icon_Lookup_Order;
4918 * Add a new icon object to the parent.
4920 * @param parent The parent object
4921 * @return The new object or NULL if it cannot be created
4923 * @see elm_icon_file_set()
4927 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4929 * Set the file that will be used as icon.
4931 * @param obj The icon object
4932 * @param file The path to file that will be used as icon image
4933 * @param group The group that the icon belongs to an edje file
4935 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4937 * @note The icon image set by this function can be changed by
4938 * elm_icon_standard_set().
4940 * @see elm_icon_file_get()
4944 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4946 * Set a location in memory to be used as an icon
4948 * @param obj The icon object
4949 * @param img The binary data that will be used as an image
4950 * @param size The size of binary data @p img
4951 * @param format Optional format of @p img to pass to the image loader
4952 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4954 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4956 * @note The icon image set by this function can be changed by
4957 * elm_icon_standard_set().
4961 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);
4963 * Get the file that will be used as icon.
4965 * @param obj The icon object
4966 * @param file The path to file that will be used as the icon image
4967 * @param group The group that the icon belongs to, in edje file
4969 * @see elm_icon_file_set()
4973 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4974 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4976 * Set the icon by icon standards names.
4978 * @param obj The icon object
4979 * @param name The icon name
4981 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4983 * For example, freedesktop.org defines standard icon names such as "home",
4984 * "network", etc. There can be different icon sets to match those icon
4985 * keys. The @p name given as parameter is one of these "keys", and will be
4986 * used to look in the freedesktop.org paths and elementary theme. One can
4987 * change the lookup order with elm_icon_order_lookup_set().
4989 * If name is not found in any of the expected locations and it is the
4990 * absolute path of an image file, this image will be used.
4992 * @note The icon image set by this function can be changed by
4993 * elm_icon_file_set().
4995 * @see elm_icon_standard_get()
4996 * @see elm_icon_file_set()
5000 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5002 * Get the icon name set by icon standard names.
5004 * @param obj The icon object
5005 * @return The icon name
5007 * If the icon image was set using elm_icon_file_set() instead of
5008 * elm_icon_standard_set(), then this function will return @c NULL.
5010 * @see elm_icon_standard_set()
5014 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5016 * Set the smooth scaling for an icon object.
5018 * @param obj The icon object
5019 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5020 * otherwise. Default is @c EINA_TRUE.
5022 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5023 * scaling provides a better resulting image, but is slower.
5025 * The smooth scaling should be disabled when making animations that change
5026 * the icon size, since they will be faster. Animations that don't require
5027 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5028 * is already scaled, since the scaled icon image will be cached).
5030 * @see elm_icon_smooth_get()
5034 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5036 * Get whether smooth scaling is enabled for an icon object.
5038 * @param obj The icon object
5039 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5041 * @see elm_icon_smooth_set()
5045 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5047 * Disable scaling of this object.
5049 * @param obj The icon object.
5050 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5051 * otherwise. Default is @c EINA_FALSE.
5053 * This function disables scaling of the icon object through the function
5054 * elm_object_scale_set(). However, this does not affect the object
5055 * size/resize in any way. For that effect, take a look at
5056 * elm_icon_scale_set().
5058 * @see elm_icon_no_scale_get()
5059 * @see elm_icon_scale_set()
5060 * @see elm_object_scale_set()
5064 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5066 * Get whether scaling is disabled on the object.
5068 * @param obj The icon object
5069 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5071 * @see elm_icon_no_scale_set()
5075 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5077 * Set if the object is (up/down) resizable.
5079 * @param obj The icon object
5080 * @param scale_up A bool to set if the object is resizable up. Default is
5082 * @param scale_down A bool to set if the object is resizable down. Default
5085 * This function limits the icon object resize ability. If @p scale_up is set to
5086 * @c EINA_FALSE, the object can't have its height or width resized to a value
5087 * higher than the original icon size. Same is valid for @p scale_down.
5089 * @see elm_icon_scale_get()
5093 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5095 * Get if the object is (up/down) resizable.
5097 * @param obj The icon object
5098 * @param scale_up A bool to set if the object is resizable up
5099 * @param scale_down A bool to set if the object is resizable down
5101 * @see elm_icon_scale_set()
5105 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5107 * Get the object's image size
5109 * @param obj The icon object
5110 * @param w A pointer to store the width in
5111 * @param h A pointer to store the height in
5115 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5117 * Set if the icon fill the entire object area.
5119 * @param obj The icon object
5120 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5121 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5123 * When the icon object is resized to a different aspect ratio from the
5124 * original icon image, the icon image will still keep its aspect. This flag
5125 * tells how the image should fill the object's area. They are: keep the
5126 * entire icon inside the limits of height and width of the object (@p
5127 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5128 * of the object, and the icon will fill the entire object (@p fill_outside
5131 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5132 * retain property to false. Thus, the icon image will always keep its
5133 * original aspect ratio.
5135 * @see elm_icon_fill_outside_get()
5136 * @see elm_image_fill_outside_set()
5140 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5142 * Get if the object is filled outside.
5144 * @param obj The icon object
5145 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5147 * @see elm_icon_fill_outside_set()
5151 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5153 * Set the prescale size for the icon.
5155 * @param obj The icon object
5156 * @param size The prescale size. This value is used for both width and
5159 * This function sets a new size for pixmap representation of the given
5160 * icon. It allows the icon to be loaded already in the specified size,
5161 * reducing the memory usage and load time when loading a big icon with load
5162 * size set to a smaller size.
5164 * It's equivalent to the elm_bg_load_size_set() function for bg.
5166 * @note this is just a hint, the real size of the pixmap may differ
5167 * depending on the type of icon being loaded, being bigger than requested.
5169 * @see elm_icon_prescale_get()
5170 * @see elm_bg_load_size_set()
5174 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5176 * Get the prescale size for the icon.
5178 * @param obj The icon object
5179 * @return The prescale size
5181 * @see elm_icon_prescale_set()
5185 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5187 * Gets the image object of the icon. DO NOT MODIFY THIS.
5189 * @param obj The icon object
5190 * @return The internal icon object
5194 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5196 * Sets the icon lookup order used by elm_icon_standard_set().
5198 * @param obj The icon object
5199 * @param order The icon lookup order (can be one of
5200 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5201 * or ELM_ICON_LOOKUP_THEME)
5203 * @see elm_icon_order_lookup_get()
5204 * @see Elm_Icon_Lookup_Order
5208 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5210 * Gets the icon lookup order.
5212 * @param obj The icon object
5213 * @return The icon lookup order
5215 * @see elm_icon_order_lookup_set()
5216 * @see Elm_Icon_Lookup_Order
5220 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5222 * Enable or disable preloading of the icon
5224 * @param obj The icon object
5225 * @param disable If EINA_TRUE, preloading will be disabled
5228 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5230 * Get if the icon supports animation or not.
5232 * @param obj The icon object
5233 * @return @c EINA_TRUE if the icon supports animation,
5234 * @c EINA_FALSE otherwise.
5236 * Return if this elm icon's image can be animated. Currently Evas only
5237 * supports gif animation. If the return value is EINA_FALSE, other
5238 * elm_icon_animated_XXX APIs won't work.
5241 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5243 * Set animation mode of the icon.
5245 * @param obj The icon object
5246 * @param anim @c EINA_TRUE if the object do animation job,
5247 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5249 * Since the default animation mode is set to EINA_FALSE,
5250 * the icon is shown without animation.
5251 * This might be desirable when the application developer wants to show
5252 * a snapshot of the animated icon.
5253 * Set it to EINA_TRUE when the icon needs to be animated.
5256 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5258 * Get animation mode of the icon.
5260 * @param obj The icon object
5261 * @return The animation mode of the icon object
5262 * @see elm_icon_animated_set
5265 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5267 * Set animation play mode of the icon.
5269 * @param obj The icon object
5270 * @param play @c EINA_TRUE the object play animation images,
5271 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5273 * To play elm icon's animation, set play to EINA_TURE.
5274 * For example, you make gif player using this set/get API and click event.
5276 * 1. Click event occurs
5277 * 2. Check play flag using elm_icon_animaged_play_get
5278 * 3. If elm icon was playing, set play to EINA_FALSE.
5279 * Then animation will be stopped and vice versa
5282 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5284 * Get animation play mode of the icon.
5286 * @param obj The icon object
5287 * @return The play mode of the icon object
5289 * @see elm_icon_animated_play_get
5292 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5294 /* compatibility code to avoid API and ABI breaks */
5295 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5297 elm_icon_animated_set(obj, animated);
5300 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5302 return elm_icon_animated_get(obj);
5305 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5307 elm_icon_animated_play_set(obj, play);
5310 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5312 return elm_icon_animated_play_get(obj);
5320 * @defgroup Image Image
5322 * @image html img/widget/image/preview-00.png
5323 * @image latex img/widget/image/preview-00.eps
5326 * An object that allows one to load an image file to it. It can be used
5327 * anywhere like any other elementary widget.
5329 * This widget provides most of the functionality provided from @ref Bg or @ref
5330 * Icon, but with a slightly different API (use the one that fits better your
5333 * The features not provided by those two other image widgets are:
5334 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5335 * @li change the object orientation with elm_image_orient_set();
5336 * @li and turning the image editable with elm_image_editable_set().
5338 * Signals that you can add callbacks for are:
5340 * @li @c "clicked" - This is called when a user has clicked the image
5342 * An example of usage for this API follows:
5343 * @li @ref tutorial_image
5352 * @enum _Elm_Image_Orient
5353 * @typedef Elm_Image_Orient
5355 * Possible orientation options for elm_image_orient_set().
5357 * @image html elm_image_orient_set.png
5358 * @image latex elm_image_orient_set.eps width=\textwidth
5362 typedef enum _Elm_Image_Orient
5364 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5365 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5366 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5367 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5368 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5369 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5370 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5371 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5375 * Add a new image to the parent.
5377 * @param parent The parent object
5378 * @return The new object or NULL if it cannot be created
5380 * @see elm_image_file_set()
5384 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5386 * Set the file that will be used as image.
5388 * @param obj The image object
5389 * @param file The path to file that will be used as image
5390 * @param group The group that the image belongs in edje file (if it's an
5393 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5395 * @see elm_image_file_get()
5399 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5401 * Get the file that will be used as image.
5403 * @param obj The image object
5404 * @param file The path to file
5405 * @param group The group that the image belongs in edje file
5407 * @see elm_image_file_set()
5411 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5413 * Set the smooth effect for an image.
5415 * @param obj The image object
5416 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5417 * otherwise. Default is @c EINA_TRUE.
5419 * Set the scaling algorithm to be used when scaling the image. Smooth
5420 * scaling provides a better resulting image, but is slower.
5422 * The smooth scaling should be disabled when making animations that change
5423 * the image size, since it will be faster. Animations that don't require
5424 * resizing of the image can keep the smooth scaling enabled (even if the
5425 * image is already scaled, since the scaled image will be cached).
5427 * @see elm_image_smooth_get()
5431 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5433 * Get the smooth effect for an image.
5435 * @param obj The image object
5436 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5438 * @see elm_image_smooth_get()
5442 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5445 * Gets the current size of the image.
5447 * @param obj The image object.
5448 * @param w Pointer to store width, or NULL.
5449 * @param h Pointer to store height, or NULL.
5451 * This is the real size of the image, not the size of the object.
5453 * On error, neither w or h will be written.
5457 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5459 * Disable scaling of this object.
5461 * @param obj The image object.
5462 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5463 * otherwise. Default is @c EINA_FALSE.
5465 * This function disables scaling of the elm_image widget through the
5466 * function elm_object_scale_set(). However, this does not affect the widget
5467 * size/resize in any way. For that effect, take a look at
5468 * elm_image_scale_set().
5470 * @see elm_image_no_scale_get()
5471 * @see elm_image_scale_set()
5472 * @see elm_object_scale_set()
5476 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5478 * Get whether scaling is disabled on the object.
5480 * @param obj The image object
5481 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5483 * @see elm_image_no_scale_set()
5487 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5489 * Set if the object is (up/down) resizable.
5491 * @param obj The image object
5492 * @param scale_up A bool to set if the object is resizable up. Default is
5494 * @param scale_down A bool to set if the object is resizable down. Default
5497 * This function limits the image resize ability. If @p scale_up is set to
5498 * @c EINA_FALSE, the object can't have its height or width resized to a value
5499 * higher than the original image size. Same is valid for @p scale_down.
5501 * @see elm_image_scale_get()
5505 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5507 * Get if the object is (up/down) resizable.
5509 * @param obj The image object
5510 * @param scale_up A bool to set if the object is resizable up
5511 * @param scale_down A bool to set if the object is resizable down
5513 * @see elm_image_scale_set()
5517 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5519 * Set if the image fills the entire object area, when keeping the aspect ratio.
5521 * @param obj The image object
5522 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5523 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5525 * When the image should keep its aspect ratio even if resized to another
5526 * aspect ratio, there are two possibilities to resize it: keep the entire
5527 * image inside the limits of height and width of the object (@p fill_outside
5528 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5529 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5531 * @note This option will have no effect if
5532 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5534 * @see elm_image_fill_outside_get()
5535 * @see elm_image_aspect_ratio_retained_set()
5539 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5541 * Get if the object is filled outside
5543 * @param obj The image object
5544 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5546 * @see elm_image_fill_outside_set()
5550 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5552 * Set the prescale size for the image
5554 * @param obj The image object
5555 * @param size The prescale size. This value is used for both width and
5558 * This function sets a new size for pixmap representation of the given
5559 * image. It allows the image to be loaded already in the specified size,
5560 * reducing the memory usage and load time when loading a big image with load
5561 * size set to a smaller size.
5563 * It's equivalent to the elm_bg_load_size_set() function for bg.
5565 * @note this is just a hint, the real size of the pixmap may differ
5566 * depending on the type of image being loaded, being bigger than requested.
5568 * @see elm_image_prescale_get()
5569 * @see elm_bg_load_size_set()
5573 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5575 * Get the prescale size for the image
5577 * @param obj The image object
5578 * @return The prescale size
5580 * @see elm_image_prescale_set()
5584 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5586 * Set the image orientation.
5588 * @param obj The image object
5589 * @param orient The image orientation @ref Elm_Image_Orient
5590 * Default is #ELM_IMAGE_ORIENT_NONE.
5592 * This function allows to rotate or flip the given image.
5594 * @see elm_image_orient_get()
5595 * @see @ref Elm_Image_Orient
5599 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5601 * Get the image orientation.
5603 * @param obj The image object
5604 * @return The image orientation @ref Elm_Image_Orient
5606 * @see elm_image_orient_set()
5607 * @see @ref Elm_Image_Orient
5611 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5613 * Make the image 'editable'.
5615 * @param obj Image object.
5616 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5618 * This means the image is a valid drag target for drag and drop, and can be
5619 * cut or pasted too.
5623 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5625 * Check if the image 'editable'.
5627 * @param obj Image object.
5628 * @return Editability.
5630 * A return value of EINA_TRUE means the image is a valid drag target
5631 * for drag and drop, and can be cut or pasted too.
5635 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5637 * Get the basic Evas_Image object from this object (widget).
5639 * @param obj The image object to get the inlined image from
5640 * @return The inlined image object, or NULL if none exists
5642 * This function allows one to get the underlying @c Evas_Object of type
5643 * Image from this elementary widget. It can be useful to do things like get
5644 * the pixel data, save the image to a file, etc.
5646 * @note Be careful to not manipulate it, as it is under control of
5651 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5653 * Set whether the original aspect ratio of the image should be kept on resize.
5655 * @param obj The image object.
5656 * @param retained @c EINA_TRUE if the image should retain the aspect,
5657 * @c EINA_FALSE otherwise.
5659 * The original aspect ratio (width / height) of the image is usually
5660 * distorted to match the object's size. Enabling this option will retain
5661 * this original aspect, and the way that the image is fit into the object's
5662 * area depends on the option set by elm_image_fill_outside_set().
5664 * @see elm_image_aspect_ratio_retained_get()
5665 * @see elm_image_fill_outside_set()
5669 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5671 * Get if the object retains the original aspect ratio.
5673 * @param obj The image object.
5674 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5679 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5686 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5688 /* old API compatibility */
5689 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5691 typedef enum _Elm_GLView_Mode
5693 ELM_GLVIEW_ALPHA = 1,
5694 ELM_GLVIEW_DEPTH = 2,
5695 ELM_GLVIEW_STENCIL = 4
5699 * Defines a policy for the glview resizing.
5701 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5703 typedef enum _Elm_GLView_Resize_Policy
5705 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5706 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5707 } Elm_GLView_Resize_Policy;
5709 typedef enum _Elm_GLView_Render_Policy
5711 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5712 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5713 } Elm_GLView_Render_Policy;
5718 * A simple GLView widget that allows GL rendering.
5720 * Signals that you can add callbacks for are:
5726 * Add a new glview to the parent
5728 * @param parent The parent object
5729 * @return The new object or NULL if it cannot be created
5733 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5736 * Sets the size of the glview
5738 * @param obj The glview object
5739 * @param width width of the glview object
5740 * @param height height of the glview object
5744 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5747 * Gets the size of the glview.
5749 * @param obj The glview object
5750 * @param width width of the glview object
5751 * @param height height of the glview object
5753 * Note that this function returns the actual image size of the
5754 * glview. This means that when the scale policy is set to
5755 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5760 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5763 * Gets the gl api struct for gl rendering
5765 * @param obj The glview object
5766 * @return The api object or NULL if it cannot be created
5770 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5773 * Set the mode of the GLView. Supports Three simple modes.
5775 * @param obj The glview object
5776 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5777 * @return True if set properly.
5781 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5784 * Set the resize policy for the glview object.
5786 * @param obj The glview object.
5787 * @param policy The scaling policy.
5789 * By default, the resize policy is set to
5790 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5791 * destroys the previous surface and recreates the newly specified
5792 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5793 * however, glview only scales the image object and not the underlying
5798 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5801 * Set the render policy for the glview object.
5803 * @param obj The glview object.
5804 * @param policy The render policy.
5806 * By default, the render policy is set to
5807 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5808 * that during the render loop, glview is only redrawn if it needs
5809 * to be redrawn. (i.e. When it is visible) If the policy is set to
5810 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5811 * whether it is visible/need redrawing or not.
5815 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5818 * Set the init function that runs once in the main loop.
5820 * @param obj The glview object.
5821 * @param func The init function to be registered.
5823 * The registered init function gets called once during the render loop.
5827 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5830 * Set the render function that runs in the main loop.
5832 * @param obj The glview object.
5833 * @param func The delete function to be registered.
5835 * The registered del function gets called when GLView object is deleted.
5839 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5842 * Set the resize function that gets called when resize happens.
5844 * @param obj The glview object.
5845 * @param func The resize function to be registered.
5849 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5852 * Set the render function that runs in the main loop.
5854 * @param obj The glview object.
5855 * @param func The render function to be registered.
5859 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5862 * Notifies that there has been changes in the GLView.
5864 * @param obj The glview object.
5868 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5878 * @image html img/widget/box/preview-00.png
5879 * @image latex img/widget/box/preview-00.eps width=\textwidth
5881 * @image html img/box.png
5882 * @image latex img/box.eps width=\textwidth
5884 * A box arranges objects in a linear fashion, governed by a layout function
5885 * that defines the details of this arrangement.
5887 * By default, the box will use an internal function to set the layout to
5888 * a single row, either vertical or horizontal. This layout is affected
5889 * by a number of parameters, such as the homogeneous flag set by
5890 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5891 * elm_box_align_set() and the hints set to each object in the box.
5893 * For this default layout, it's possible to change the orientation with
5894 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5895 * placing its elements ordered from top to bottom. When horizontal is set,
5896 * the order will go from left to right. If the box is set to be
5897 * homogeneous, every object in it will be assigned the same space, that
5898 * of the largest object. Padding can be used to set some spacing between
5899 * the cell given to each object. The alignment of the box, set with
5900 * elm_box_align_set(), determines how the bounding box of all the elements
5901 * will be placed within the space given to the box widget itself.
5903 * The size hints of each object also affect how they are placed and sized
5904 * within the box. evas_object_size_hint_min_set() will give the minimum
5905 * size the object can have, and the box will use it as the basis for all
5906 * latter calculations. Elementary widgets set their own minimum size as
5907 * needed, so there's rarely any need to use it manually.
5909 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5910 * used to tell whether the object will be allocated the minimum size it
5911 * needs or if the space given to it should be expanded. It's important
5912 * to realize that expanding the size given to the object is not the same
5913 * thing as resizing the object. It could very well end being a small
5914 * widget floating in a much larger empty space. If not set, the weight
5915 * for objects will normally be 0.0 for both axis, meaning the widget will
5916 * not be expanded. To take as much space possible, set the weight to
5917 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5919 * Besides how much space each object is allocated, it's possible to control
5920 * how the widget will be placed within that space using
5921 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5922 * for both axis, meaning the object will be centered, but any value from
5923 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5924 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5925 * is -1.0, means the object will be resized to fill the entire space it
5928 * In addition, customized functions to define the layout can be set, which
5929 * allow the application developer to organize the objects within the box
5930 * in any number of ways.
5932 * The special elm_box_layout_transition() function can be used
5933 * to switch from one layout to another, animating the motion of the
5934 * children of the box.
5936 * @note Objects should not be added to box objects using _add() calls.
5938 * Some examples on how to use boxes follow:
5939 * @li @ref box_example_01
5940 * @li @ref box_example_02
5945 * @typedef Elm_Box_Transition
5947 * Opaque handler containing the parameters to perform an animated
5948 * transition of the layout the box uses.
5950 * @see elm_box_transition_new()
5951 * @see elm_box_layout_set()
5952 * @see elm_box_layout_transition()
5954 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5957 * Add a new box to the parent
5959 * By default, the box will be in vertical mode and non-homogeneous.
5961 * @param parent The parent object
5962 * @return The new object or NULL if it cannot be created
5964 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5966 * Set the horizontal orientation
5968 * By default, box object arranges their contents vertically from top to
5970 * By calling this function with @p horizontal as EINA_TRUE, the box will
5971 * become horizontal, arranging contents from left to right.
5973 * @note This flag is ignored if a custom layout function is set.
5975 * @param obj The box object
5976 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5977 * EINA_FALSE = vertical)
5979 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5981 * Get the horizontal orientation
5983 * @param obj The box object
5984 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5986 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5988 * Set the box to arrange its children homogeneously
5990 * If enabled, homogeneous layout makes all items the same size, according
5991 * to the size of the largest of its children.
5993 * @note This flag is ignored if a custom layout function is set.
5995 * @param obj The box object
5996 * @param homogeneous The homogeneous flag
5998 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6000 * Get whether the box is using homogeneous mode or not
6002 * @param obj The box object
6003 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6005 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6006 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6007 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6009 * Add an object to the beginning of the pack list
6011 * Pack @p subobj into the box @p obj, placing it first in the list of
6012 * children objects. The actual position the object will get on screen
6013 * depends on the layout used. If no custom layout is set, it will be at
6014 * the top or left, depending if the box is vertical or horizontal,
6017 * @param obj The box object
6018 * @param subobj The object to add to the box
6020 * @see elm_box_pack_end()
6021 * @see elm_box_pack_before()
6022 * @see elm_box_pack_after()
6023 * @see elm_box_unpack()
6024 * @see elm_box_unpack_all()
6025 * @see elm_box_clear()
6027 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6029 * Add an object at the end of the pack list
6031 * Pack @p subobj into the box @p obj, placing it last in the list of
6032 * children objects. The actual position the object will get on screen
6033 * depends on the layout used. If no custom layout is set, it will be at
6034 * the bottom or right, depending if the box is vertical or horizontal,
6037 * @param obj The box object
6038 * @param subobj The object to add to the box
6040 * @see elm_box_pack_start()
6041 * @see elm_box_pack_before()
6042 * @see elm_box_pack_after()
6043 * @see elm_box_unpack()
6044 * @see elm_box_unpack_all()
6045 * @see elm_box_clear()
6047 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6049 * Adds an object to the box before the indicated object
6051 * This will add the @p subobj to the box indicated before the object
6052 * indicated with @p before. If @p before is not already in the box, results
6053 * are undefined. Before means either to the left of the indicated object or
6054 * above it depending on orientation.
6056 * @param obj The box object
6057 * @param subobj The object to add to the box
6058 * @param before The object before which to add it
6060 * @see elm_box_pack_start()
6061 * @see elm_box_pack_end()
6062 * @see elm_box_pack_after()
6063 * @see elm_box_unpack()
6064 * @see elm_box_unpack_all()
6065 * @see elm_box_clear()
6067 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6069 * Adds an object to the box after the indicated object
6071 * This will add the @p subobj to the box indicated after the object
6072 * indicated with @p after. If @p after is not already in the box, results
6073 * are undefined. After means either to the right of the indicated object or
6074 * below it depending on orientation.
6076 * @param obj The box object
6077 * @param subobj The object to add to the box
6078 * @param after The object after which to add it
6080 * @see elm_box_pack_start()
6081 * @see elm_box_pack_end()
6082 * @see elm_box_pack_before()
6083 * @see elm_box_unpack()
6084 * @see elm_box_unpack_all()
6085 * @see elm_box_clear()
6087 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6089 * Clear the box of all children
6091 * Remove all the elements contained by the box, deleting the respective
6094 * @param obj The box object
6096 * @see elm_box_unpack()
6097 * @see elm_box_unpack_all()
6099 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6103 * Remove the object given by @p subobj from the box @p obj without
6106 * @param obj The box object
6108 * @see elm_box_unpack_all()
6109 * @see elm_box_clear()
6111 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6113 * Remove all items from the box, without deleting them
6115 * Clear the box from all children, but don't delete the respective objects.
6116 * If no other references of the box children exist, the objects will never
6117 * be deleted, and thus the application will leak the memory. Make sure
6118 * when using this function that you hold a reference to all the objects
6119 * in the box @p obj.
6121 * @param obj The box object
6123 * @see elm_box_clear()
6124 * @see elm_box_unpack()
6126 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6128 * Retrieve a list of the objects packed into the box
6130 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6131 * The order of the list corresponds to the packing order the box uses.
6133 * You must free this list with eina_list_free() once you are done with it.
6135 * @param obj The box object
6137 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6139 * Set the space (padding) between the box's elements.
6141 * Extra space in pixels that will be added between a box child and its
6142 * neighbors after its containing cell has been calculated. This padding
6143 * is set for all elements in the box, besides any possible padding that
6144 * individual elements may have through their size hints.
6146 * @param obj The box object
6147 * @param horizontal The horizontal space between elements
6148 * @param vertical The vertical space between elements
6150 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6152 * Get the space (padding) between the box's elements.
6154 * @param obj The box object
6155 * @param horizontal The horizontal space between elements
6156 * @param vertical The vertical space between elements
6158 * @see elm_box_padding_set()
6160 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6162 * Set the alignment of the whole bouding box of contents.
6164 * Sets how the bounding box containing all the elements of the box, after
6165 * their sizes and position has been calculated, will be aligned within
6166 * the space given for the whole box widget.
6168 * @param obj The box object
6169 * @param horizontal The horizontal alignment of elements
6170 * @param vertical The vertical alignment of elements
6172 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6174 * Get the alignment of the whole bouding box of contents.
6176 * @param obj The box object
6177 * @param horizontal The horizontal alignment of elements
6178 * @param vertical The vertical alignment of elements
6180 * @see elm_box_align_set()
6182 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6185 * Force the box to recalculate its children packing.
6187 * If any children was added or removed, box will not calculate the
6188 * values immediately rather leaving it to the next main loop
6189 * iteration. While this is great as it would save lots of
6190 * recalculation, whenever you need to get the position of a just
6191 * added item you must force recalculate before doing so.
6193 * @param obj The box object.
6195 EAPI void elm_box_recalculate(Evas_Object *obj);
6198 * Set the layout defining function to be used by the box
6200 * Whenever anything changes that requires the box in @p obj to recalculate
6201 * the size and position of its elements, the function @p cb will be called
6202 * to determine what the layout of the children will be.
6204 * Once a custom function is set, everything about the children layout
6205 * is defined by it. The flags set by elm_box_horizontal_set() and
6206 * elm_box_homogeneous_set() no longer have any meaning, and the values
6207 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6208 * layout function to decide if they are used and how. These last two
6209 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6210 * passed to @p cb. The @c Evas_Object the function receives is not the
6211 * Elementary widget, but the internal Evas Box it uses, so none of the
6212 * functions described here can be used on it.
6214 * Any of the layout functions in @c Evas can be used here, as well as the
6215 * special elm_box_layout_transition().
6217 * The final @p data argument received by @p cb is the same @p data passed
6218 * here, and the @p free_data function will be called to free it
6219 * whenever the box is destroyed or another layout function is set.
6221 * Setting @p cb to NULL will revert back to the default layout function.
6223 * @param obj The box object
6224 * @param cb The callback function used for layout
6225 * @param data Data that will be passed to layout function
6226 * @param free_data Function called to free @p data
6228 * @see elm_box_layout_transition()
6230 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);
6232 * Special layout function that animates the transition from one layout to another
6234 * Normally, when switching the layout function for a box, this will be
6235 * reflected immediately on screen on the next render, but it's also
6236 * possible to do this through an animated transition.
6238 * This is done by creating an ::Elm_Box_Transition and setting the box
6239 * layout to this function.
6243 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6244 * evas_object_box_layout_vertical, // start
6245 * NULL, // data for initial layout
6246 * NULL, // free function for initial data
6247 * evas_object_box_layout_horizontal, // end
6248 * NULL, // data for final layout
6249 * NULL, // free function for final data
6250 * anim_end, // will be called when animation ends
6251 * NULL); // data for anim_end function\
6252 * elm_box_layout_set(box, elm_box_layout_transition, t,
6253 * elm_box_transition_free);
6256 * @note This function can only be used with elm_box_layout_set(). Calling
6257 * it directly will not have the expected results.
6259 * @see elm_box_transition_new
6260 * @see elm_box_transition_free
6261 * @see elm_box_layout_set
6263 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6265 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6267 * If you want to animate the change from one layout to another, you need
6268 * to set the layout function of the box to elm_box_layout_transition(),
6269 * passing as user data to it an instance of ::Elm_Box_Transition with the
6270 * necessary information to perform this animation. The free function to
6271 * set for the layout is elm_box_transition_free().
6273 * The parameters to create an ::Elm_Box_Transition sum up to how long
6274 * will it be, in seconds, a layout function to describe the initial point,
6275 * another for the final position of the children and one function to be
6276 * called when the whole animation ends. This last function is useful to
6277 * set the definitive layout for the box, usually the same as the end
6278 * layout for the animation, but could be used to start another transition.
6280 * @param start_layout The layout function that will be used to start the animation
6281 * @param start_layout_data The data to be passed the @p start_layout function
6282 * @param start_layout_free_data Function to free @p start_layout_data
6283 * @param end_layout The layout function that will be used to end the animation
6284 * @param end_layout_free_data The data to be passed the @p end_layout function
6285 * @param end_layout_free_data Function to free @p end_layout_data
6286 * @param transition_end_cb Callback function called when animation ends
6287 * @param transition_end_data Data to be passed to @p transition_end_cb
6288 * @return An instance of ::Elm_Box_Transition
6290 * @see elm_box_transition_new
6291 * @see elm_box_layout_transition
6293 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);
6295 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6297 * This function is mostly useful as the @c free_data parameter in
6298 * elm_box_layout_set() when elm_box_layout_transition().
6300 * @param data The Elm_Box_Transition instance to be freed.
6302 * @see elm_box_transition_new
6303 * @see elm_box_layout_transition
6305 EAPI void elm_box_transition_free(void *data);
6312 * @defgroup Button Button
6314 * @image html img/widget/button/preview-00.png
6315 * @image latex img/widget/button/preview-00.eps
6316 * @image html img/widget/button/preview-01.png
6317 * @image latex img/widget/button/preview-01.eps
6318 * @image html img/widget/button/preview-02.png
6319 * @image latex img/widget/button/preview-02.eps
6321 * This is a push-button. Press it and run some function. It can contain
6322 * a simple label and icon object and it also has an autorepeat feature.
6324 * This widgets emits the following signals:
6325 * @li "clicked": the user clicked the button (press/release).
6326 * @li "repeated": the user pressed the button without releasing it.
6327 * @li "pressed": button was pressed.
6328 * @li "unpressed": button was released after being pressed.
6329 * In all three cases, the @c event parameter of the callback will be
6332 * Also, defined in the default theme, the button has the following styles
6334 * @li default: a normal button.
6335 * @li anchor: Like default, but the button fades away when the mouse is not
6336 * over it, leaving only the text or icon.
6337 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6338 * continuous look across its options.
6339 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6341 * Default contents parts of the button widget that you can use for are:
6342 * @li "icon" - A icon of the button
6344 * Default text parts of the button widget that you can use for are:
6345 * @li "default" - Label of the button
6347 * Follow through a complete example @ref button_example_01 "here".
6353 UIControlStateDefault,
6354 UIControlStateHighlighted,
6355 UIControlStateDisabled,
6356 UIControlStateFocused,
6357 UIControlStateReserved
6361 * Add a new button to the parent's canvas
6363 * @param parent The parent object
6364 * @return The new object or NULL if it cannot be created
6366 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6368 * Set the label used in the button
6370 * The passed @p label can be NULL to clean any existing text in it and
6371 * leave the button as an icon only object.
6373 * @param obj The button object
6374 * @param label The text will be written on the button
6375 * @deprecated use elm_object_text_set() instead.
6377 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6379 * Get the label set for the button
6381 * The string returned is an internal pointer and should not be freed or
6382 * altered. It will also become invalid when the button is destroyed.
6383 * The string returned, if not NULL, is a stringshare, so if you need to
6384 * keep it around even after the button is destroyed, you can use
6385 * eina_stringshare_ref().
6387 * @param obj The button object
6388 * @return The text set to the label, or NULL if nothing is set
6389 * @deprecated use elm_object_text_set() instead.
6391 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6393 * Set the label for each state of button
6395 * The passed @p label can be NULL to clean any existing text in it and
6396 * leave the button as an icon only object for the state.
6398 * @param obj The button object
6399 * @param label The text will be written on the button
6400 * @param state The state of button
6404 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6406 * Get the label of button for each state
6408 * The string returned is an internal pointer and should not be freed or
6409 * altered. It will also become invalid when the button is destroyed.
6410 * The string returned, if not NULL, is a stringshare, so if you need to
6411 * keep it around even after the button is destroyed, you can use
6412 * eina_stringshare_ref().
6414 * @param obj The button object
6415 * @param state The state of button
6416 * @return The title of button for state
6420 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6422 * Set the icon used for the button
6424 * Setting a new icon will delete any other that was previously set, making
6425 * any reference to them invalid. If you need to maintain the previous
6426 * object alive, unset it first with elm_button_icon_unset().
6428 * @param obj The button object
6429 * @param icon The icon object for the button
6430 * @deprecated use elm_object_part_content_set() instead.
6432 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6434 * Get the icon used for the button
6436 * Return the icon object which is set for this widget. If the button is
6437 * destroyed or another icon is set, the returned object will be deleted
6438 * and any reference to it will be invalid.
6440 * @param obj The button object
6441 * @return The icon object that is being used
6443 * @deprecated use elm_object_part_content_get() instead
6445 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6447 * Remove the icon set without deleting it and return the object
6449 * This function drops the reference the button holds of the icon object
6450 * and returns this last object. It is used in case you want to remove any
6451 * icon, or set another one, without deleting the actual object. The button
6452 * will be left without an icon set.
6454 * @param obj The button object
6455 * @return The icon object that was being used
6456 * @deprecated use elm_object_part_content_unset() instead.
6458 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6460 * Turn on/off the autorepeat event generated when the button is kept pressed
6462 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6463 * signal when they are clicked.
6465 * When on, keeping a button pressed will continuously emit a @c repeated
6466 * signal until the button is released. The time it takes until it starts
6467 * emitting the signal is given by
6468 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6469 * new emission by elm_button_autorepeat_gap_timeout_set().
6471 * @param obj The button object
6472 * @param on A bool to turn on/off the event
6474 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6476 * Get whether the autorepeat feature is enabled
6478 * @param obj The button object
6479 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6481 * @see elm_button_autorepeat_set()
6483 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6485 * Set the initial timeout before the autorepeat event is generated
6487 * Sets the timeout, in seconds, since the button is pressed until the
6488 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6489 * won't be any delay and the even will be fired the moment the button is
6492 * @param obj The button object
6493 * @param t Timeout in seconds
6495 * @see elm_button_autorepeat_set()
6496 * @see elm_button_autorepeat_gap_timeout_set()
6498 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6500 * Get the initial timeout before the autorepeat event is generated
6502 * @param obj The button object
6503 * @return Timeout in seconds
6505 * @see elm_button_autorepeat_initial_timeout_set()
6507 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6509 * Set the interval between each generated autorepeat event
6511 * After the first @c repeated event is fired, all subsequent ones will
6512 * follow after a delay of @p t seconds for each.
6514 * @param obj The button object
6515 * @param t Interval in seconds
6517 * @see elm_button_autorepeat_initial_timeout_set()
6519 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6521 * Get the interval between each generated autorepeat event
6523 * @param obj The button object
6524 * @return Interval in seconds
6526 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6532 * @defgroup File_Selector_Button File Selector Button
6534 * @image html img/widget/fileselector_button/preview-00.png
6535 * @image latex img/widget/fileselector_button/preview-00.eps
6536 * @image html img/widget/fileselector_button/preview-01.png
6537 * @image latex img/widget/fileselector_button/preview-01.eps
6538 * @image html img/widget/fileselector_button/preview-02.png
6539 * @image latex img/widget/fileselector_button/preview-02.eps
6541 * This is a button that, when clicked, creates an Elementary
6542 * window (or inner window) <b> with a @ref Fileselector "file
6543 * selector widget" within</b>. When a file is chosen, the (inner)
6544 * window is closed and the button emits a signal having the
6545 * selected file as it's @c event_info.
6547 * This widget encapsulates operations on its internal file
6548 * selector on its own API. There is less control over its file
6549 * selector than that one would have instatiating one directly.
6551 * The following styles are available for this button:
6554 * @li @c "hoversel_vertical"
6555 * @li @c "hoversel_vertical_entry"
6557 * Smart callbacks one can register to:
6558 * - @c "file,chosen" - the user has selected a path, whose string
6559 * pointer comes as the @c event_info data (a stringshared
6562 * Here is an example on its usage:
6563 * @li @ref fileselector_button_example
6565 * @see @ref File_Selector_Entry for a similar widget.
6570 * Add a new file selector button widget to the given parent
6571 * Elementary (container) object
6573 * @param parent The parent object
6574 * @return a new file selector button widget handle or @c NULL, on
6577 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6580 * Set the label for a given file selector button widget
6582 * @param obj The file selector button widget
6583 * @param label The text label to be displayed on @p obj
6585 * @deprecated use elm_object_text_set() instead.
6587 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6590 * Get the label set for a given file selector button widget
6592 * @param obj The file selector button widget
6593 * @return The button label
6595 * @deprecated use elm_object_text_set() instead.
6597 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6600 * Set the icon on a given file selector button widget
6602 * @param obj The file selector button widget
6603 * @param icon The icon object for the button
6605 * Once the icon object is set, a previously set one will be
6606 * deleted. If you want to keep the latter, use the
6607 * elm_fileselector_button_icon_unset() function.
6609 * @see elm_fileselector_button_icon_get()
6611 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6614 * Get the icon set for a given file selector button widget
6616 * @param obj The file selector button widget
6617 * @return The icon object currently set on @p obj or @c NULL, if
6620 * @see elm_fileselector_button_icon_set()
6622 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6625 * Unset the icon used in a given file selector button widget
6627 * @param obj The file selector button widget
6628 * @return The icon object that was being used on @p obj or @c
6631 * Unparent and return the icon object which was set for this
6634 * @see elm_fileselector_button_icon_set()
6636 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6639 * Set the title for a given file selector button widget's window
6641 * @param obj The file selector button widget
6642 * @param title The title string
6644 * This will change the window's title, when the file selector pops
6645 * out after a click on the button. Those windows have the default
6646 * (unlocalized) value of @c "Select a file" as titles.
6648 * @note It will only take any effect if the file selector
6649 * button widget is @b not under "inwin mode".
6651 * @see elm_fileselector_button_window_title_get()
6653 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6656 * Get the title set for a given file selector button widget's
6659 * @param obj The file selector button widget
6660 * @return Title of the file selector button's window
6662 * @see elm_fileselector_button_window_title_get() for more details
6664 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6667 * Set the size of a given file selector button widget's window,
6668 * holding the file selector itself.
6670 * @param obj The file selector button widget
6671 * @param width The window's width
6672 * @param height The window's height
6674 * @note it will only take any effect if the file selector button
6675 * widget is @b not under "inwin mode". The default size for the
6676 * window (when applicable) is 400x400 pixels.
6678 * @see elm_fileselector_button_window_size_get()
6680 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6683 * Get the size of a given file selector button widget's window,
6684 * holding the file selector itself.
6686 * @param obj The file selector button widget
6687 * @param width Pointer into which to store the width value
6688 * @param height Pointer into which to store the height value
6690 * @note Use @c NULL pointers on the size values you're not
6691 * interested in: they'll be ignored by the function.
6693 * @see elm_fileselector_button_window_size_set(), for more details
6695 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6698 * Set the initial file system path for a given file selector
6701 * @param obj The file selector button widget
6702 * @param path The path string
6704 * It must be a <b>directory</b> path, which will have the contents
6705 * displayed initially in the file selector's view, when invoked
6706 * from @p obj. The default initial path is the @c "HOME"
6707 * environment variable's value.
6709 * @see elm_fileselector_button_path_get()
6711 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6714 * Get the initial file system path set for a given file selector
6717 * @param obj The file selector button widget
6718 * @return path The path string
6720 * @see elm_fileselector_button_path_set() for more details
6722 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6725 * Enable/disable a tree view in the given file selector button
6726 * widget's internal file selector
6728 * @param obj The file selector button widget
6729 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6732 * This has the same effect as elm_fileselector_expandable_set(),
6733 * but now applied to a file selector button's internal file
6736 * @note There's no way to put a file selector button's internal
6737 * file selector in "grid mode", as one may do with "pure" file
6740 * @see elm_fileselector_expandable_get()
6742 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6745 * Get whether tree view is enabled for the given file selector
6746 * button widget's internal file selector
6748 * @param obj The file selector button widget
6749 * @return @c EINA_TRUE if @p obj widget's internal file selector
6750 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6752 * @see elm_fileselector_expandable_set() for more details
6754 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6757 * Set whether a given file selector button widget's internal file
6758 * selector is to display folders only or the directory contents,
6761 * @param obj The file selector button widget
6762 * @param only @c EINA_TRUE to make @p obj widget's internal file
6763 * selector only display directories, @c EINA_FALSE to make files
6764 * to be displayed in it too
6766 * This has the same effect as elm_fileselector_folder_only_set(),
6767 * but now applied to a file selector button's internal file
6770 * @see elm_fileselector_folder_only_get()
6772 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6775 * Get whether a given file selector button widget's internal file
6776 * selector is displaying folders only or the directory contents,
6779 * @param obj The file selector button widget
6780 * @return @c EINA_TRUE if @p obj widget's internal file
6781 * selector is only displaying directories, @c EINA_FALSE if files
6782 * are being displayed in it too (and on errors)
6784 * @see elm_fileselector_button_folder_only_set() for more details
6786 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6789 * Enable/disable the file name entry box where the user can type
6790 * in a name for a file, in a given file selector button widget's
6791 * internal file selector.
6793 * @param obj The file selector button widget
6794 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6795 * file selector a "saving dialog", @c EINA_FALSE otherwise
6797 * This has the same effect as elm_fileselector_is_save_set(),
6798 * but now applied to a file selector button's internal file
6801 * @see elm_fileselector_is_save_get()
6803 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6806 * Get whether the given file selector button widget's internal
6807 * file selector is in "saving dialog" mode
6809 * @param obj The file selector button widget
6810 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6811 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6814 * @see elm_fileselector_button_is_save_set() for more details
6816 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6819 * Set whether a given file selector button widget's internal file
6820 * selector will raise an Elementary "inner window", instead of a
6821 * dedicated Elementary window. By default, it won't.
6823 * @param obj The file selector button widget
6824 * @param value @c EINA_TRUE to make it use an inner window, @c
6825 * EINA_TRUE to make it use a dedicated window
6827 * @see elm_win_inwin_add() for more information on inner windows
6828 * @see elm_fileselector_button_inwin_mode_get()
6830 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6833 * Get whether a given file selector button widget's internal file
6834 * selector will raise an Elementary "inner window", instead of a
6835 * dedicated Elementary window.
6837 * @param obj The file selector button widget
6838 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6839 * if it will use a dedicated window
6841 * @see elm_fileselector_button_inwin_mode_set() for more details
6843 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6850 * @defgroup File_Selector_Entry File Selector Entry
6852 * @image html img/widget/fileselector_entry/preview-00.png
6853 * @image latex img/widget/fileselector_entry/preview-00.eps
6855 * This is an entry made to be filled with or display a <b>file
6856 * system path string</b>. Besides the entry itself, the widget has
6857 * a @ref File_Selector_Button "file selector button" on its side,
6858 * which will raise an internal @ref Fileselector "file selector widget",
6859 * when clicked, for path selection aided by file system
6862 * This file selector may appear in an Elementary window or in an
6863 * inner window. When a file is chosen from it, the (inner) window
6864 * is closed and the selected file's path string is exposed both as
6865 * an smart event and as the new text on the entry.
6867 * This widget encapsulates operations on its internal file
6868 * selector on its own API. There is less control over its file
6869 * selector than that one would have instatiating one directly.
6871 * Smart callbacks one can register to:
6872 * - @c "changed" - The text within the entry was changed
6873 * - @c "activated" - The entry has had editing finished and
6874 * changes are to be "committed"
6875 * - @c "press" - The entry has been clicked
6876 * - @c "longpressed" - The entry has been clicked (and held) for a
6878 * - @c "clicked" - The entry has been clicked
6879 * - @c "clicked,double" - The entry has been double clicked
6880 * - @c "focused" - The entry has received focus
6881 * - @c "unfocused" - The entry has lost focus
6882 * - @c "selection,paste" - A paste action has occurred on the
6884 * - @c "selection,copy" - A copy action has occurred on the entry
6885 * - @c "selection,cut" - A cut action has occurred on the entry
6886 * - @c "unpressed" - The file selector entry's button was released
6887 * after being pressed.
6888 * - @c "file,chosen" - The user has selected a path via the file
6889 * selector entry's internal file selector, whose string pointer
6890 * comes as the @c event_info data (a stringshared string)
6892 * Here is an example on its usage:
6893 * @li @ref fileselector_entry_example
6895 * @see @ref File_Selector_Button for a similar widget.
6900 * Add a new file selector entry widget to the given parent
6901 * Elementary (container) object
6903 * @param parent The parent object
6904 * @return a new file selector entry widget handle or @c NULL, on
6907 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6910 * Set the label for a given file selector entry widget's button
6912 * @param obj The file selector entry widget
6913 * @param label The text label to be displayed on @p obj widget's
6916 * @deprecated use elm_object_text_set() instead.
6918 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6921 * Get the label set for a given file selector entry widget's button
6923 * @param obj The file selector entry widget
6924 * @return The widget button's label
6926 * @deprecated use elm_object_text_set() instead.
6928 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6931 * Set the icon on a given file selector entry widget's button
6933 * @param obj The file selector entry widget
6934 * @param icon The icon object for the entry's button
6936 * Once the icon object is set, a previously set one will be
6937 * deleted. If you want to keep the latter, use the
6938 * elm_fileselector_entry_button_icon_unset() function.
6940 * @see elm_fileselector_entry_button_icon_get()
6942 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6945 * Get the icon set for a given file selector entry widget's button
6947 * @param obj The file selector entry widget
6948 * @return The icon object currently set on @p obj widget's button
6949 * or @c NULL, if none is
6951 * @see elm_fileselector_entry_button_icon_set()
6953 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6956 * Unset the icon used in a given file selector entry widget's
6959 * @param obj The file selector entry widget
6960 * @return The icon object that was being used on @p obj widget's
6961 * button or @c NULL, on errors
6963 * Unparent and return the icon object which was set for this
6966 * @see elm_fileselector_entry_button_icon_set()
6968 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6971 * Set the title for a given file selector entry widget's window
6973 * @param obj The file selector entry widget
6974 * @param title The title string
6976 * This will change the window's title, when the file selector pops
6977 * out after a click on the entry's button. Those windows have the
6978 * default (unlocalized) value of @c "Select a file" as titles.
6980 * @note It will only take any effect if the file selector
6981 * entry widget is @b not under "inwin mode".
6983 * @see elm_fileselector_entry_window_title_get()
6985 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6988 * Get the title set for a given file selector entry widget's
6991 * @param obj The file selector entry widget
6992 * @return Title of the file selector entry's window
6994 * @see elm_fileselector_entry_window_title_get() for more details
6996 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6999 * Set the size of a given file selector entry widget's window,
7000 * holding the file selector itself.
7002 * @param obj The file selector entry widget
7003 * @param width The window's width
7004 * @param height The window's height
7006 * @note it will only take any effect if the file selector entry
7007 * widget is @b not under "inwin mode". The default size for the
7008 * window (when applicable) is 400x400 pixels.
7010 * @see elm_fileselector_entry_window_size_get()
7012 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7015 * Get the size of a given file selector entry widget's window,
7016 * holding the file selector itself.
7018 * @param obj The file selector entry widget
7019 * @param width Pointer into which to store the width value
7020 * @param height Pointer into which to store the height value
7022 * @note Use @c NULL pointers on the size values you're not
7023 * interested in: they'll be ignored by the function.
7025 * @see elm_fileselector_entry_window_size_set(), for more details
7027 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7030 * Set the initial file system path and the entry's path string for
7031 * a given file selector entry widget
7033 * @param obj The file selector entry widget
7034 * @param path The path string
7036 * It must be a <b>directory</b> path, which will have the contents
7037 * displayed initially in the file selector's view, when invoked
7038 * from @p obj. The default initial path is the @c "HOME"
7039 * environment variable's value.
7041 * @see elm_fileselector_entry_path_get()
7043 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7046 * Get the entry's path string for a given file selector entry
7049 * @param obj The file selector entry widget
7050 * @return path The path string
7052 * @see elm_fileselector_entry_path_set() for more details
7054 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7057 * Enable/disable a tree view in the given file selector entry
7058 * widget's internal file selector
7060 * @param obj The file selector entry widget
7061 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7064 * This has the same effect as elm_fileselector_expandable_set(),
7065 * but now applied to a file selector entry's internal file
7068 * @note There's no way to put a file selector entry's internal
7069 * file selector in "grid mode", as one may do with "pure" file
7072 * @see elm_fileselector_expandable_get()
7074 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7077 * Get whether tree view is enabled for the given file selector
7078 * entry widget's internal file selector
7080 * @param obj The file selector entry widget
7081 * @return @c EINA_TRUE if @p obj widget's internal file selector
7082 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7084 * @see elm_fileselector_expandable_set() for more details
7086 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7089 * Set whether a given file selector entry widget's internal file
7090 * selector is to display folders only or the directory contents,
7093 * @param obj The file selector entry widget
7094 * @param only @c EINA_TRUE to make @p obj widget's internal file
7095 * selector only display directories, @c EINA_FALSE to make files
7096 * to be displayed in it too
7098 * This has the same effect as elm_fileselector_folder_only_set(),
7099 * but now applied to a file selector entry's internal file
7102 * @see elm_fileselector_folder_only_get()
7104 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7107 * Get whether a given file selector entry widget's internal file
7108 * selector is displaying folders only or the directory contents,
7111 * @param obj The file selector entry widget
7112 * @return @c EINA_TRUE if @p obj widget's internal file
7113 * selector is only displaying directories, @c EINA_FALSE if files
7114 * are being displayed in it too (and on errors)
7116 * @see elm_fileselector_entry_folder_only_set() for more details
7118 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7121 * Enable/disable the file name entry box where the user can type
7122 * in a name for a file, in a given file selector entry widget's
7123 * internal file selector.
7125 * @param obj The file selector entry widget
7126 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7127 * file selector a "saving dialog", @c EINA_FALSE otherwise
7129 * This has the same effect as elm_fileselector_is_save_set(),
7130 * but now applied to a file selector entry's internal file
7133 * @see elm_fileselector_is_save_get()
7135 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7138 * Get whether the given file selector entry widget's internal
7139 * file selector is in "saving dialog" mode
7141 * @param obj The file selector entry widget
7142 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7143 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7146 * @see elm_fileselector_entry_is_save_set() for more details
7148 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7151 * Set whether a given file selector entry widget's internal file
7152 * selector will raise an Elementary "inner window", instead of a
7153 * dedicated Elementary window. By default, it won't.
7155 * @param obj The file selector entry widget
7156 * @param value @c EINA_TRUE to make it use an inner window, @c
7157 * EINA_TRUE to make it use a dedicated window
7159 * @see elm_win_inwin_add() for more information on inner windows
7160 * @see elm_fileselector_entry_inwin_mode_get()
7162 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7165 * Get whether a given file selector entry widget's internal file
7166 * selector will raise an Elementary "inner window", instead of a
7167 * dedicated Elementary window.
7169 * @param obj The file selector entry widget
7170 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7171 * if it will use a dedicated window
7173 * @see elm_fileselector_entry_inwin_mode_set() for more details
7175 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7178 * Set the initial file system path for a given file selector entry
7181 * @param obj The file selector entry widget
7182 * @param path The path string
7184 * It must be a <b>directory</b> path, which will have the contents
7185 * displayed initially in the file selector's view, when invoked
7186 * from @p obj. The default initial path is the @c "HOME"
7187 * environment variable's value.
7189 * @see elm_fileselector_entry_path_get()
7191 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7194 * Get the parent directory's path to the latest file selection on
7195 * a given filer selector entry widget
7197 * @param obj The file selector object
7198 * @return The (full) path of the directory of the last selection
7199 * on @p obj widget, a @b stringshared string
7201 * @see elm_fileselector_entry_path_set()
7203 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7210 * @defgroup Scroller Scroller
7212 * A scroller holds a single object and "scrolls it around". This means that
7213 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7214 * region around, allowing to move through a much larger object that is
7215 * contained in the scroller. The scroller will always have a small minimum
7216 * size by default as it won't be limited by the contents of the scroller.
7218 * Signals that you can add callbacks for are:
7219 * @li "edge,left" - the left edge of the content has been reached
7220 * @li "edge,right" - the right edge of the content has been reached
7221 * @li "edge,top" - the top edge of the content has been reached
7222 * @li "edge,bottom" - the bottom edge of the content has been reached
7223 * @li "scroll" - the content has been scrolled (moved)
7224 * @li "scroll,anim,start" - scrolling animation has started
7225 * @li "scroll,anim,stop" - scrolling animation has stopped
7226 * @li "scroll,drag,start" - dragging the contents around has started
7227 * @li "scroll,drag,stop" - dragging the contents around has stopped
7228 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7231 * @note When Elemementary is in embedded mode the scrollbars will not be
7232 * dragable, they appear merely as indicators of how much has been scrolled.
7233 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7234 * fingerscroll) won't work.
7236 * Default contents parts of the scroller widget that you can use for are:
7237 * @li "default" - A content of the scroller
7239 * In @ref tutorial_scroller you'll find an example of how to use most of
7244 * @brief Type that controls when scrollbars should appear.
7246 * @see elm_scroller_policy_set()
7248 typedef enum _Elm_Scroller_Policy
7250 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7251 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7252 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7253 ELM_SCROLLER_POLICY_LAST
7254 } Elm_Scroller_Policy;
7256 * @brief Add a new scroller to the parent
7258 * @param parent The parent object
7259 * @return The new object or NULL if it cannot be created
7261 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7263 * @brief Set the content of the scroller widget (the object to be scrolled around).
7265 * @param obj The scroller object
7266 * @param content The new content object
7268 * Once the content object is set, a previously set one will be deleted.
7269 * If you want to keep that old content object, use the
7270 * elm_scroller_content_unset() function.
7271 * @deprecated use elm_object_content_set() instead
7273 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7275 * @brief Get the content of the scroller widget
7277 * @param obj The slider object
7278 * @return The content that is being used
7280 * Return the content object which is set for this widget
7282 * @see elm_scroller_content_set()
7283 * @deprecated use elm_object_content_get() instead.
7285 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7287 * @brief Unset the content of the scroller widget
7289 * @param obj The slider object
7290 * @return The content that was being used
7292 * Unparent and return the content object which was set for this widget
7294 * @see elm_scroller_content_set()
7295 * @deprecated use elm_object_content_unset() instead.
7297 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7299 * @brief Set custom theme elements for the scroller
7301 * @param obj The scroller object
7302 * @param widget The widget name to use (default is "scroller")
7303 * @param base The base name to use (default is "base")
7305 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7307 * @brief Make the scroller minimum size limited to the minimum size of the content
7309 * @param obj The scroller object
7310 * @param w Enable limiting minimum size horizontally
7311 * @param h Enable limiting minimum size vertically
7313 * By default the scroller will be as small as its design allows,
7314 * irrespective of its content. This will make the scroller minimum size the
7315 * right size horizontally and/or vertically to perfectly fit its content in
7318 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7320 * @brief Show a specific virtual region within the scroller content object
7322 * @param obj The scroller object
7323 * @param x X coordinate of the region
7324 * @param y Y coordinate of the region
7325 * @param w Width of the region
7326 * @param h Height of the region
7328 * This will ensure all (or part if it does not fit) of the designated
7329 * region in the virtual content object (0, 0 starting at the top-left of the
7330 * virtual content object) is shown within the scroller.
7332 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);
7334 * @brief Set the scrollbar visibility policy
7336 * @param obj The scroller object
7337 * @param policy_h Horizontal scrollbar policy
7338 * @param policy_v Vertical scrollbar policy
7340 * This sets the scrollbar visibility policy for the given scroller.
7341 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7342 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7343 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7344 * respectively for the horizontal and vertical scrollbars.
7346 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7348 * @brief Gets scrollbar visibility policy
7350 * @param obj The scroller object
7351 * @param policy_h Horizontal scrollbar policy
7352 * @param policy_v Vertical scrollbar policy
7354 * @see elm_scroller_policy_set()
7356 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7358 * @brief Get the currently visible content region
7360 * @param obj The scroller object
7361 * @param x X coordinate of the region
7362 * @param y Y coordinate of the region
7363 * @param w Width of the region
7364 * @param h Height of the region
7366 * This gets the current region in the content object that is visible through
7367 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7368 * w, @p h values pointed to.
7370 * @note All coordinates are relative to the content.
7372 * @see elm_scroller_region_show()
7374 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);
7376 * @brief Get the size of the content object
7378 * @param obj The scroller object
7379 * @param w Width of the content object.
7380 * @param h Height of the content object.
7382 * This gets the size of the content object of the scroller.
7384 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7386 * @brief Set bouncing behavior
7388 * @param obj The scroller object
7389 * @param h_bounce Allow bounce horizontally
7390 * @param v_bounce Allow bounce vertically
7392 * When scrolling, the scroller may "bounce" when reaching an edge of the
7393 * content object. This is a visual way to indicate the end has been reached.
7394 * This is enabled by default for both axis. This API will set if it is enabled
7395 * for the given axis with the boolean parameters for each axis.
7397 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7399 * @brief Get the bounce behaviour
7401 * @param obj The Scroller object
7402 * @param h_bounce Will the scroller bounce horizontally or not
7403 * @param v_bounce Will the scroller bounce vertically or not
7405 * @see elm_scroller_bounce_set()
7407 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7409 * @brief Set scroll page size relative to viewport size.
7411 * @param obj The scroller object
7412 * @param h_pagerel The horizontal page relative size
7413 * @param v_pagerel The vertical page relative size
7415 * The scroller is capable of limiting scrolling by the user to "pages". That
7416 * is to jump by and only show a "whole page" at a time as if the continuous
7417 * area of the scroller content is split into page sized pieces. This sets
7418 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7419 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7420 * axis. This is mutually exclusive with page size
7421 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7422 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7423 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7426 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7428 * @brief Set scroll page size.
7430 * @param obj The scroller object
7431 * @param h_pagesize The horizontal page size
7432 * @param v_pagesize The vertical page size
7434 * This sets the page size to an absolute fixed value, with 0 turning it off
7437 * @see elm_scroller_page_relative_set()
7439 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7441 * @brief Get scroll current page number.
7443 * @param obj The scroller object
7444 * @param h_pagenumber The horizontal page number
7445 * @param v_pagenumber The vertical page number
7447 * The page number starts from 0. 0 is the first page.
7448 * Current page means the page which meets the top-left of the viewport.
7449 * If there are two or more pages in the viewport, it returns the number of the page
7450 * which meets the top-left of the viewport.
7452 * @see elm_scroller_last_page_get()
7453 * @see elm_scroller_page_show()
7454 * @see elm_scroller_page_brint_in()
7456 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7458 * @brief Get scroll last page number.
7460 * @param obj The scroller object
7461 * @param h_pagenumber The horizontal page number
7462 * @param v_pagenumber The vertical page number
7464 * The page number starts from 0. 0 is the first page.
7465 * This returns the last page number among the pages.
7467 * @see elm_scroller_current_page_get()
7468 * @see elm_scroller_page_show()
7469 * @see elm_scroller_page_brint_in()
7471 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7473 * Show a specific virtual region within the scroller content object by page number.
7475 * @param obj The scroller object
7476 * @param h_pagenumber The horizontal page number
7477 * @param v_pagenumber The vertical page number
7479 * 0, 0 of the indicated page is located at the top-left of the viewport.
7480 * This will jump to the page directly without animation.
7485 * sc = elm_scroller_add(win);
7486 * elm_scroller_content_set(sc, content);
7487 * elm_scroller_page_relative_set(sc, 1, 0);
7488 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7489 * elm_scroller_page_show(sc, h_page + 1, v_page);
7492 * @see elm_scroller_page_bring_in()
7494 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7496 * Show a specific virtual region within the scroller content object by page number.
7498 * @param obj The scroller object
7499 * @param h_pagenumber The horizontal page number
7500 * @param v_pagenumber The vertical page number
7502 * 0, 0 of the indicated page is located at the top-left of the viewport.
7503 * This will slide to the page with animation.
7508 * sc = elm_scroller_add(win);
7509 * elm_scroller_content_set(sc, content);
7510 * elm_scroller_page_relative_set(sc, 1, 0);
7511 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7512 * elm_scroller_page_bring_in(sc, h_page, v_page);
7515 * @see elm_scroller_page_show()
7517 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7519 * @brief Show a specific virtual region within the scroller content object.
7521 * @param obj The scroller object
7522 * @param x X coordinate of the region
7523 * @param y Y coordinate of the region
7524 * @param w Width of the region
7525 * @param h Height of the region
7527 * This will ensure all (or part if it does not fit) of the designated
7528 * region in the virtual content object (0, 0 starting at the top-left of the
7529 * virtual content object) is shown within the scroller. Unlike
7530 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7531 * to this location (if configuration in general calls for transitions). It
7532 * may not jump immediately to the new location and make take a while and
7533 * show other content along the way.
7535 * @see elm_scroller_region_show()
7537 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);
7539 * @brief Set event propagation on a scroller
7541 * @param obj The scroller object
7542 * @param propagation If propagation is enabled or not
7544 * This enables or disabled event propagation from the scroller content to
7545 * the scroller and its parent. By default event propagation is disabled.
7547 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7549 * @brief Get event propagation for a scroller
7551 * @param obj The scroller object
7552 * @return The propagation state
7554 * This gets the event propagation for a scroller.
7556 * @see elm_scroller_propagate_events_set()
7558 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7560 * @brief Set scrolling gravity on a scroller
7562 * @param obj The scroller object
7563 * @param x The scrolling horizontal gravity
7564 * @param y The scrolling vertical gravity
7566 * The gravity, defines how the scroller will adjust its view
7567 * when the size of the scroller contents increase.
7569 * The scroller will adjust the view to glue itself as follows.
7571 * x=0.0, for showing the left most region of the content.
7572 * x=1.0, for showing the right most region of the content.
7573 * y=0.0, for showing the bottom most region of the content.
7574 * y=1.0, for showing the top most region of the content.
7576 * Default values for x and y are 0.0
7578 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7580 * @brief Get scrolling gravity values for a scroller
7582 * @param obj The scroller object
7583 * @param x The scrolling horizontal gravity
7584 * @param y The scrolling vertical gravity
7586 * This gets gravity values for a scroller.
7588 * @see elm_scroller_gravity_set()
7591 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7597 * @defgroup Label Label
7599 * @image html img/widget/label/preview-00.png
7600 * @image latex img/widget/label/preview-00.eps
7602 * @brief Widget to display text, with simple html-like markup.
7604 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7605 * text doesn't fit the geometry of the label it will be ellipsized or be
7606 * cut. Elementary provides several styles for this widget:
7607 * @li default - No animation
7608 * @li marker - Centers the text in the label and make it bold by default
7609 * @li slide_long - The entire text appears from the right of the screen and
7610 * slides until it disappears in the left of the screen(reappering on the
7612 * @li slide_short - The text appears in the left of the label and slides to
7613 * the right to show the overflow. When all of the text has been shown the
7614 * position is reset.
7615 * @li slide_bounce - The text appears in the left of the label and slides to
7616 * the right to show the overflow. When all of the text has been shown the
7617 * animation reverses, moving the text to the left.
7619 * Custom themes can of course invent new markup tags and style them any way
7622 * The following signals may be emitted by the label widget:
7623 * @li "language,changed": The program's language changed.
7625 * See @ref tutorial_label for a demonstration of how to use a label widget.
7629 * @brief Add a new label to the parent
7631 * @param parent The parent object
7632 * @return The new object or NULL if it cannot be created
7634 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7636 * @brief Set the label on the label object
7638 * @param obj The label object
7639 * @param label The label will be used on the label object
7640 * @deprecated See elm_object_text_set()
7642 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 */
7644 * @brief Get the label used on the label object
7646 * @param obj The label object
7647 * @return The string inside the label
7648 * @deprecated See elm_object_text_get()
7650 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7652 * @brief Set the wrapping behavior of the label
7654 * @param obj The label object
7655 * @param wrap To wrap text or not
7657 * By default no wrapping is done. Possible values for @p wrap are:
7658 * @li ELM_WRAP_NONE - No wrapping
7659 * @li ELM_WRAP_CHAR - wrap between characters
7660 * @li ELM_WRAP_WORD - wrap between words
7661 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7663 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7665 * @brief Get the wrapping behavior of the label
7667 * @param obj The label object
7670 * @see elm_label_line_wrap_set()
7672 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7674 * @brief Set wrap width of the label
7676 * @param obj The label object
7677 * @param w The wrap width in pixels at a minimum where words need to wrap
7679 * This function sets the maximum width size hint of the label.
7681 * @warning This is only relevant if the label is inside a container.
7683 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7685 * @brief Get wrap width of the label
7687 * @param obj The label object
7688 * @return The wrap width in pixels at a minimum where words need to wrap
7690 * @see elm_label_wrap_width_set()
7692 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7694 * @brief Set wrap height of the label
7696 * @param obj The label object
7697 * @param h The wrap height in pixels at a minimum where words need to wrap
7699 * This function sets the maximum height size hint of the label.
7701 * @warning This is only relevant if the label is inside a container.
7703 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7705 * @brief get wrap width of the label
7707 * @param obj The label object
7708 * @return The wrap height in pixels at a minimum where words need to wrap
7710 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7712 * @brief Set the font size on the label object.
7714 * @param obj The label object
7715 * @param size font size
7717 * @warning NEVER use this. It is for hyper-special cases only. use styles
7718 * instead. e.g. "default", "marker", "slide_long" etc.
7720 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7722 * @brief Set the text color on the label object
7724 * @param obj The label object
7725 * @param r Red property background color of The label object
7726 * @param g Green property background color of The label object
7727 * @param b Blue property background color of The label object
7728 * @param a Alpha property background color of The label object
7730 * @warning NEVER use this. It is for hyper-special cases only. use styles
7731 * instead. e.g. "default", "marker", "slide_long" etc.
7733 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);
7735 * @brief Set the text align on the label object
7737 * @param obj The label object
7738 * @param align align mode ("left", "center", "right")
7740 * @warning NEVER use this. It is for hyper-special cases only. use styles
7741 * instead. e.g. "default", "marker", "slide_long" etc.
7743 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7745 * @brief Set background color of the label
7747 * @param obj The label object
7748 * @param r Red property background color of The label object
7749 * @param g Green property background color of The label object
7750 * @param b Blue property background color of The label object
7751 * @param a Alpha property background alpha of The label object
7753 * @warning NEVER use this. It is for hyper-special cases only. use styles
7754 * instead. e.g. "default", "marker", "slide_long" etc.
7756 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);
7758 * @brief Set the ellipsis behavior of the label
7760 * @param obj The label object
7761 * @param ellipsis To ellipsis text or not
7763 * If set to true and the text doesn't fit in the label an ellipsis("...")
7764 * will be shown at the end of the widget.
7766 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7767 * choosen wrap method was ELM_WRAP_WORD.
7769 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7770 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7772 * @brief Set the text slide of the label
7774 * @param obj The label object
7775 * @param slide To start slide or stop
7777 * If set to true, the text of the label will slide/scroll through the length of
7780 * @warning This only works with the themes "slide_short", "slide_long" and
7783 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7785 * @brief Get the text slide mode of the label
7787 * @param obj The label object
7788 * @return slide slide mode value
7790 * @see elm_label_slide_set()
7792 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7794 * @brief Set the slide duration(speed) of the label
7796 * @param obj The label object
7797 * @return The duration in seconds in moving text from slide begin position
7798 * to slide end position
7800 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7802 * @brief Get the slide duration(speed) of the label
7804 * @param obj The label object
7805 * @return The duration time in moving text from slide begin position to slide end position
7807 * @see elm_label_slide_duration_set()
7809 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7815 * @defgroup Frame Frame
7817 * @image html img/widget/frame/preview-00.png
7818 * @image latex img/widget/frame/preview-00.eps
7820 * @brief Frame is a widget that holds some content and has a title.
7822 * The default look is a frame with a title, but Frame supports multple
7830 * @li outdent_bottom
7832 * Of all this styles only default shows the title. Frame emits no signals.
7834 * Default contents parts of the frame widget that you can use for are:
7835 * @li "default" - A content of the frame
7837 * Default text parts of the frame widget that you can use for are:
7838 * @li "elm.text" - Label of the frame
7840 * For a detailed example see the @ref tutorial_frame.
7845 * @brief Add a new frame to the parent
7847 * @param parent The parent object
7848 * @return The new object or NULL if it cannot be created
7850 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7852 * @brief Set the frame label
7854 * @param obj The frame object
7855 * @param label The label of this frame object
7857 * @deprecated use elm_object_text_set() instead.
7859 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7861 * @brief Get the frame label
7863 * @param obj The frame object
7865 * @return The label of this frame objet or NULL if unable to get frame
7867 * @deprecated use elm_object_text_get() instead.
7869 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7871 * @brief Set the content of the frame widget
7873 * Once the content object is set, a previously set one will be deleted.
7874 * If you want to keep that old content object, use the
7875 * elm_frame_content_unset() function.
7877 * @param obj The frame object
7878 * @param content The content will be filled in this frame object
7880 * @deprecated use elm_object_content_set() instead.
7882 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7884 * @brief Get the content of the frame widget
7886 * Return the content object which is set for this widget
7888 * @param obj The frame object
7889 * @return The content that is being used
7891 * @deprecated use elm_object_content_get() instead.
7893 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7895 * @brief Unset the content of the frame widget
7897 * Unparent and return the content object which was set for this widget
7899 * @param obj The frame object
7900 * @return The content that was being used
7902 * @deprecated use elm_object_content_unset() instead.
7904 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7910 * @defgroup Table Table
7912 * A container widget to arrange other widgets in a table where items can
7913 * also span multiple columns or rows - even overlap (and then be raised or
7914 * lowered accordingly to adjust stacking if they do overlap).
7916 * For a Table widget the row/column count is not fixed.
7917 * The table widget adjusts itself when subobjects are added to it dynamically.
7919 * The followin are examples of how to use a table:
7920 * @li @ref tutorial_table_01
7921 * @li @ref tutorial_table_02
7926 * @brief Add a new table to the parent
7928 * @param parent The parent object
7929 * @return The new object or NULL if it cannot be created
7931 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7933 * @brief Set the homogeneous layout in the table
7935 * @param obj The layout object
7936 * @param homogeneous A boolean to set if the layout is homogeneous in the
7937 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7939 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7941 * @brief Get the current table homogeneous mode.
7943 * @param obj The table object
7944 * @return A boolean to indicating if the layout is homogeneous in the table
7945 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7947 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7949 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7951 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7953 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7955 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7957 * @brief Set padding between cells.
7959 * @param obj The layout object.
7960 * @param horizontal set the horizontal padding.
7961 * @param vertical set the vertical padding.
7963 * Default value is 0.
7965 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7967 * @brief Get padding between cells.
7969 * @param obj The layout object.
7970 * @param horizontal set the horizontal padding.
7971 * @param vertical set the vertical padding.
7973 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7975 * @brief Add a subobject on the table with the coordinates passed
7977 * @param obj The table object
7978 * @param subobj The subobject to be added to the table
7979 * @param x Row number
7980 * @param y Column number
7984 * @note All positioning inside the table is relative to rows and columns, so
7985 * a value of 0 for x and y, means the top left cell of the table, and a
7986 * value of 1 for w and h means @p subobj only takes that 1 cell.
7988 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7990 * @brief Remove child from table.
7992 * @param obj The table object
7993 * @param subobj The subobject
7995 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7997 * @brief Faster way to remove all child objects from a table object.
7999 * @param obj The table object
8000 * @param clear If true, will delete children, else just remove from table.
8002 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8004 * @brief Set the packing location of an existing child of the table
8006 * @param subobj The subobject to be modified in the table
8007 * @param x Row number
8008 * @param y Column number
8012 * Modifies the position of an object already in the table.
8014 * @note All positioning inside the table is relative to rows and columns, so
8015 * a value of 0 for x and y, means the top left cell of the table, and a
8016 * value of 1 for w and h means @p subobj only takes that 1 cell.
8018 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8020 * @brief Get the packing location of an existing child of the table
8022 * @param subobj The subobject to be modified in the table
8023 * @param x Row number
8024 * @param y Column number
8028 * @see elm_table_pack_set()
8030 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8036 * @defgroup Gengrid Gengrid (Generic grid)
8038 * This widget aims to position objects in a grid layout while
8039 * actually creating and rendering only the visible ones, using the
8040 * same idea as the @ref Genlist "genlist": the user defines a @b
8041 * class for each item, specifying functions that will be called at
8042 * object creation, deletion, etc. When those items are selected by
8043 * the user, a callback function is issued. Users may interact with
8044 * a gengrid via the mouse (by clicking on items to select them and
8045 * clicking on the grid's viewport and swiping to pan the whole
8046 * view) or via the keyboard, navigating through item with the
8049 * @section Gengrid_Layouts Gengrid layouts
8051 * Gengrid may layout its items in one of two possible layouts:
8055 * When in "horizontal mode", items will be placed in @b columns,
8056 * from top to bottom and, when the space for a column is filled,
8057 * another one is started on the right, thus expanding the grid
8058 * horizontally, making for horizontal scrolling. When in "vertical
8059 * mode" , though, items will be placed in @b rows, from left to
8060 * right and, when the space for a row is filled, another one is
8061 * started below, thus expanding the grid vertically (and making
8062 * for vertical scrolling).
8064 * @section Gengrid_Items Gengrid items
8066 * An item in a gengrid can have 0 or more text labels (they can be
8067 * regular text or textblock Evas objects - that's up to the style
8068 * to determine), 0 or more icons (which are simply objects
8069 * swallowed into the gengrid item's theming Edje object) and 0 or
8070 * more <b>boolean states</b>, which have the behavior left to the
8071 * user to define. The Edje part names for each of these properties
8072 * will be looked up, in the theme file for the gengrid, under the
8073 * Edje (string) data items named @c "labels", @c "icons" and @c
8074 * "states", respectively. For each of those properties, if more
8075 * than one part is provided, they must have names listed separated
8076 * by spaces in the data fields. For the default gengrid item
8077 * theme, we have @b one label part (@c "elm.text"), @b two icon
8078 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8081 * A gengrid item may be at one of several styles. Elementary
8082 * provides one by default - "default", but this can be extended by
8083 * system or application custom themes/overlays/extensions (see
8084 * @ref Theme "themes" for more details).
8086 * @section Gengrid_Item_Class Gengrid item classes
8088 * In order to have the ability to add and delete items on the fly,
8089 * gengrid implements a class (callback) system where the
8090 * application provides a structure with information about that
8091 * type of item (gengrid may contain multiple different items with
8092 * different classes, states and styles). Gengrid will call the
8093 * functions in this struct (methods) when an item is "realized"
8094 * (i.e., created dynamically, while the user is scrolling the
8095 * grid). All objects will simply be deleted when no longer needed
8096 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8097 * contains the following members:
8098 * - @c item_style - This is a constant string and simply defines
8099 * the name of the item style. It @b must be specified and the
8100 * default should be @c "default".
8101 * - @c func.label_get - This function is called when an item
8102 * object is actually created. The @c data parameter will point to
8103 * the same data passed to elm_gengrid_item_append() and related
8104 * item creation functions. The @c obj parameter is the gengrid
8105 * object itself, while the @c part one is the name string of one
8106 * of the existing text parts in the Edje group implementing the
8107 * item's theme. This function @b must return a strdup'()ed string,
8108 * as the caller will free() it when done. See
8109 * #Elm_Gengrid_Item_Label_Get_Cb.
8110 * - @c func.content_get - This function is called when an item object
8111 * is actually created. The @c data parameter will point to the
8112 * same data passed to elm_gengrid_item_append() and related item
8113 * creation functions. The @c obj parameter is the gengrid object
8114 * itself, while the @c part one is the name string of one of the
8115 * existing (content) swallow parts in the Edje group implementing the
8116 * item's theme. It must return @c NULL, when no content is desired,
8117 * or a valid object handle, otherwise. The object will be deleted
8118 * by the gengrid on its deletion or when the item is "unrealized".
8119 * See #Elm_Gengrid_Item_Content_Get_Cb.
8120 * - @c func.state_get - This function is called when an item
8121 * object is actually created. The @c data parameter will point to
8122 * the same data passed to elm_gengrid_item_append() and related
8123 * item creation functions. The @c obj parameter is the gengrid
8124 * object itself, while the @c part one is the name string of one
8125 * of the state parts in the Edje group implementing the item's
8126 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8127 * true/on. Gengrids will emit a signal to its theming Edje object
8128 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8129 * "source" arguments, respectively, when the state is true (the
8130 * default is false), where @c XXX is the name of the (state) part.
8131 * See #Elm_Gengrid_Item_State_Get_Cb.
8132 * - @c func.del - This is called when elm_gengrid_item_del() is
8133 * called on an item or elm_gengrid_clear() is called on the
8134 * gengrid. This is intended for use when gengrid items are
8135 * deleted, so any data attached to the item (e.g. its data
8136 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8138 * @section Gengrid_Usage_Hints Usage hints
8140 * If the user wants to have multiple items selected at the same
8141 * time, elm_gengrid_multi_select_set() will permit it. If the
8142 * gengrid is single-selection only (the default), then
8143 * elm_gengrid_select_item_get() will return the selected item or
8144 * @c NULL, if none is selected. If the gengrid is under
8145 * multi-selection, then elm_gengrid_selected_items_get() will
8146 * return a list (that is only valid as long as no items are
8147 * modified (added, deleted, selected or unselected) of child items
8150 * If an item changes (internal (boolean) state, label or content
8151 * changes), then use elm_gengrid_item_update() to have gengrid
8152 * update the item with the new state. A gengrid will re-"realize"
8153 * the item, thus calling the functions in the
8154 * #Elm_Gengrid_Item_Class set for that item.
8156 * To programmatically (un)select an item, use
8157 * elm_gengrid_item_selected_set(). To get its selected state use
8158 * elm_gengrid_item_selected_get(). To make an item disabled
8159 * (unable to be selected and appear differently) use
8160 * elm_gengrid_item_disabled_set() to set this and
8161 * elm_gengrid_item_disabled_get() to get the disabled state.
8163 * Grid cells will only have their selection smart callbacks called
8164 * when firstly getting selected. Any further clicks will do
8165 * nothing, unless you enable the "always select mode", with
8166 * elm_gengrid_always_select_mode_set(), thus making every click to
8167 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8168 * turn off the ability to select items entirely in the widget and
8169 * they will neither appear selected nor call the selection smart
8172 * Remember that you can create new styles and add your own theme
8173 * augmentation per application with elm_theme_extension_add(). If
8174 * you absolutely must have a specific style that overrides any
8175 * theme the user or system sets up you can use
8176 * elm_theme_overlay_add() to add such a file.
8178 * @section Gengrid_Smart_Events Gengrid smart events
8180 * Smart events that you can add callbacks for are:
8181 * - @c "activated" - The user has double-clicked or pressed
8182 * (enter|return|spacebar) on an item. The @c event_info parameter
8183 * is the gengrid item that was activated.
8184 * - @c "clicked,double" - The user has double-clicked an item.
8185 * The @c event_info parameter is the gengrid item that was double-clicked.
8186 * - @c "longpressed" - This is called when the item is pressed for a certain
8187 * amount of time. By default it's 1 second.
8188 * - @c "selected" - The user has made an item selected. The
8189 * @c event_info parameter is the gengrid item that was selected.
8190 * - @c "unselected" - The user has made an item unselected. The
8191 * @c event_info parameter is the gengrid item that was unselected.
8192 * - @c "realized" - This is called when the item in the gengrid
8193 * has its implementing Evas object instantiated, de facto. @c
8194 * event_info is the gengrid item that was created. The object
8195 * may be deleted at any time, so it is highly advised to the
8196 * caller @b not to use the object pointer returned from
8197 * elm_gengrid_item_object_get(), because it may point to freed
8199 * - @c "unrealized" - This is called when the implementing Evas
8200 * object for this item is deleted. @c event_info is the gengrid
8201 * item that was deleted.
8202 * - @c "changed" - Called when an item is added, removed, resized
8203 * or moved and when the gengrid is resized or gets "horizontal"
8205 * - @c "scroll,anim,start" - This is called when scrolling animation has
8207 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8209 * - @c "drag,start,up" - Called when the item in the gengrid has
8210 * been dragged (not scrolled) up.
8211 * - @c "drag,start,down" - Called when the item in the gengrid has
8212 * been dragged (not scrolled) down.
8213 * - @c "drag,start,left" - Called when the item in the gengrid has
8214 * been dragged (not scrolled) left.
8215 * - @c "drag,start,right" - Called when the item in the gengrid has
8216 * been dragged (not scrolled) right.
8217 * - @c "drag,stop" - Called when the item in the gengrid has
8218 * stopped being dragged.
8219 * - @c "drag" - Called when the item in the gengrid is being
8221 * - @c "scroll" - called when the content has been scrolled
8223 * - @c "scroll,drag,start" - called when dragging the content has
8225 * - @c "scroll,drag,stop" - called when dragging the content has
8227 * - @c "edge,top" - This is called when the gengrid is scrolled until
8229 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8230 * until the bottom edge.
8231 * - @c "edge,left" - This is called when the gengrid is scrolled
8232 * until the left edge.
8233 * - @c "edge,right" - This is called when the gengrid is scrolled
8234 * until the right edge.
8236 * List of gengrid examples:
8237 * @li @ref gengrid_example
8241 * @addtogroup Gengrid
8245 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8246 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8247 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8249 * Label fetching class function for Elm_Gen_Item_Class.
8250 * @param data The data passed in the item creation function
8251 * @param obj The base widget object
8252 * @param part The part name of the swallow
8253 * @return The allocated (NOT stringshared) string to set as the label
8255 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8257 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8258 * @param data The data passed in the item creation function
8259 * @param obj The base widget object
8260 * @param part The part name of the swallow
8261 * @return The content object to swallow
8263 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8265 * State fetching class function for Elm_Gen_Item_Class.
8266 * @param data The data passed in the item creation function
8267 * @param obj The base widget object
8268 * @param part The part name of the swallow
8269 * @return The hell if I know
8271 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8273 * Deletion class function for Elm_Gen_Item_Class.
8274 * @param data The data passed in the item creation function
8275 * @param obj The base widget object
8277 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8279 /* temporary compatibility code */
8280 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8281 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8282 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8283 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8286 * @struct _Elm_Gengrid_Item_Class
8288 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8291 struct _Elm_Gengrid_Item_Class
8293 const char *item_style;
8294 struct _Elm_Gengrid_Item_Class_Func
8296 Elm_Gengrid_Item_Label_Get_Cb label_get;
8297 union { /* temporary compatibility code */
8298 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8299 Elm_Gengrid_Item_Content_Get_Cb content_get;
8301 Elm_Gengrid_Item_State_Get_Cb state_get;
8302 Elm_Gengrid_Item_Del_Cb del;
8304 }; /**< #Elm_Gengrid_Item_Class member definitions */
8306 * Add a new gengrid widget to the given parent Elementary
8307 * (container) object
8309 * @param parent The parent object
8310 * @return a new gengrid widget handle or @c NULL, on errors
8312 * This function inserts a new gengrid widget on the canvas.
8314 * @see elm_gengrid_item_size_set()
8315 * @see elm_gengrid_group_item_size_set()
8316 * @see elm_gengrid_horizontal_set()
8317 * @see elm_gengrid_item_append()
8318 * @see elm_gengrid_item_del()
8319 * @see elm_gengrid_clear()
8323 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8326 * Set the size for the items of a given gengrid widget
8328 * @param obj The gengrid object.
8329 * @param w The items' width.
8330 * @param h The items' height;
8332 * A gengrid, after creation, has still no information on the size
8333 * to give to each of its cells. So, you most probably will end up
8334 * with squares one @ref Fingers "finger" wide, the default
8335 * size. Use this function to force a custom size for you items,
8336 * making them as big as you wish.
8338 * @see elm_gengrid_item_size_get()
8342 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8345 * Get the size set for the items of a given gengrid widget
8347 * @param obj The gengrid object.
8348 * @param w Pointer to a variable where to store the items' width.
8349 * @param h Pointer to a variable where to store the items' height.
8351 * @note Use @c NULL pointers on the size values you're not
8352 * interested in: they'll be ignored by the function.
8354 * @see elm_gengrid_item_size_get() for more details
8358 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8361 * Set the items grid's alignment within a given gengrid widget
8363 * @param obj The gengrid object.
8364 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8365 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8367 * This sets the alignment of the whole grid of items of a gengrid
8368 * within its given viewport. By default, those values are both
8369 * 0.5, meaning that the gengrid will have its items grid placed
8370 * exactly in the middle of its viewport.
8372 * @note If given alignment values are out of the cited ranges,
8373 * they'll be changed to the nearest boundary values on the valid
8376 * @see elm_gengrid_align_get()
8380 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8383 * Get the items grid's alignment values within a given gengrid
8386 * @param obj The gengrid object.
8387 * @param align_x Pointer to a variable where to store the
8388 * horizontal alignment.
8389 * @param align_y Pointer to a variable where to store the vertical
8392 * @note Use @c NULL pointers on the alignment values you're not
8393 * interested in: they'll be ignored by the function.
8395 * @see elm_gengrid_align_set() for more details
8399 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8402 * Set whether a given gengrid widget is or not able have items
8405 * @param obj The gengrid object
8406 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8407 * @c EINA_FALSE to turn it off
8409 * If a gengrid is set to allow reordering, a click held for more
8410 * than 0.5 over a given item will highlight it specially,
8411 * signalling the gengrid has entered the reordering state. From
8412 * that time on, the user will be able to, while still holding the
8413 * mouse button down, move the item freely in the gengrid's
8414 * viewport, replacing to said item to the locations it goes to.
8415 * The replacements will be animated and, whenever the user
8416 * releases the mouse button, the item being replaced gets a new
8417 * definitive place in the grid.
8419 * @see elm_gengrid_reorder_mode_get()
8423 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8426 * Get whether a given gengrid widget is or not able have items
8429 * @param obj The gengrid object
8430 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8433 * @see elm_gengrid_reorder_mode_set() for more details
8437 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8440 * Append a new item in a given gengrid widget.
8442 * @param obj The gengrid object.
8443 * @param gic The item class for the item.
8444 * @param data The item data.
8445 * @param func Convenience function called when the item is
8447 * @param func_data Data to be passed to @p func.
8448 * @return A handle to the item added or @c NULL, on errors.
8450 * This adds an item to the beginning of the gengrid.
8452 * @see elm_gengrid_item_prepend()
8453 * @see elm_gengrid_item_insert_before()
8454 * @see elm_gengrid_item_insert_after()
8455 * @see elm_gengrid_item_del()
8459 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);
8462 * Prepend a new item in a given gengrid widget.
8464 * @param obj The gengrid object.
8465 * @param gic The item class for the item.
8466 * @param data The item data.
8467 * @param func Convenience function called when the item is
8469 * @param func_data Data to be passed to @p func.
8470 * @return A handle to the item added or @c NULL, on errors.
8472 * This adds an item to the end of the gengrid.
8474 * @see elm_gengrid_item_append()
8475 * @see elm_gengrid_item_insert_before()
8476 * @see elm_gengrid_item_insert_after()
8477 * @see elm_gengrid_item_del()
8481 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);
8484 * Insert an item before another in a gengrid widget
8486 * @param obj The gengrid object.
8487 * @param gic The item class for the item.
8488 * @param data The item data.
8489 * @param relative The item to place this new one before.
8490 * @param func Convenience function called when the item is
8492 * @param func_data Data to be passed to @p func.
8493 * @return A handle to the item added or @c NULL, on errors.
8495 * This inserts an item before another in the gengrid.
8497 * @see elm_gengrid_item_append()
8498 * @see elm_gengrid_item_prepend()
8499 * @see elm_gengrid_item_insert_after()
8500 * @see elm_gengrid_item_del()
8504 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);
8507 * Insert an item after another in a gengrid widget
8509 * @param obj The gengrid object.
8510 * @param gic The item class for the item.
8511 * @param data The item data.
8512 * @param relative The item to place this new one after.
8513 * @param func Convenience function called when the item is
8515 * @param func_data Data to be passed to @p func.
8516 * @return A handle to the item added or @c NULL, on errors.
8518 * This inserts an item after another in the gengrid.
8520 * @see elm_gengrid_item_append()
8521 * @see elm_gengrid_item_prepend()
8522 * @see elm_gengrid_item_insert_after()
8523 * @see elm_gengrid_item_del()
8527 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);
8530 * Insert an item in a gengrid widget using a user-defined sort function.
8532 * @param obj The gengrid object.
8533 * @param gic The item class for the item.
8534 * @param data The item data.
8535 * @param comp User defined comparison function that defines the sort order based on
8536 * Elm_Gen_Item and its data param.
8537 * @param func Convenience function called when the item is selected.
8538 * @param func_data Data to be passed to @p func.
8539 * @return A handle to the item added or @c NULL, on errors.
8541 * This inserts an item in the gengrid based on user defined comparison function.
8543 * @see elm_gengrid_item_append()
8544 * @see elm_gengrid_item_prepend()
8545 * @see elm_gengrid_item_insert_after()
8546 * @see elm_gengrid_item_del()
8547 * @see elm_gengrid_item_direct_sorted_insert()
8551 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);
8554 * Insert an item in a gengrid widget using a user-defined sort function.
8556 * @param obj The gengrid object.
8557 * @param gic The item class for the item.
8558 * @param data The item data.
8559 * @param comp User defined comparison function that defines the sort order based on
8561 * @param func Convenience function called when the item is selected.
8562 * @param func_data Data to be passed to @p func.
8563 * @return A handle to the item added or @c NULL, on errors.
8565 * This inserts an item in the gengrid based on user defined comparison function.
8567 * @see elm_gengrid_item_append()
8568 * @see elm_gengrid_item_prepend()
8569 * @see elm_gengrid_item_insert_after()
8570 * @see elm_gengrid_item_del()
8571 * @see elm_gengrid_item_sorted_insert()
8575 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);
8578 * Set whether items on a given gengrid widget are to get their
8579 * selection callbacks issued for @b every subsequent selection
8580 * click on them or just for the first click.
8582 * @param obj The gengrid object
8583 * @param always_select @c EINA_TRUE to make items "always
8584 * selected", @c EINA_FALSE, otherwise
8586 * By default, grid items will only call their selection callback
8587 * function when firstly getting selected, any subsequent further
8588 * clicks will do nothing. With this call, you make those
8589 * subsequent clicks also to issue the selection callbacks.
8591 * @note <b>Double clicks</b> will @b always be reported on items.
8593 * @see elm_gengrid_always_select_mode_get()
8597 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8600 * Get whether items on a given gengrid widget have their selection
8601 * callbacks issued for @b every subsequent selection click on them
8602 * or just for the first click.
8604 * @param obj The gengrid object.
8605 * @return @c EINA_TRUE if the gengrid items are "always selected",
8606 * @c EINA_FALSE, otherwise
8608 * @see elm_gengrid_always_select_mode_set() for more details
8612 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8615 * Set whether items on a given gengrid widget can be selected or not.
8617 * @param obj The gengrid object
8618 * @param no_select @c EINA_TRUE to make items selectable,
8619 * @c EINA_FALSE otherwise
8621 * This will make items in @p obj selectable or not. In the latter
8622 * case, any user interaction on the gengrid items will neither make
8623 * them appear selected nor them call their selection callback
8626 * @see elm_gengrid_no_select_mode_get()
8630 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8633 * Get whether items on a given gengrid widget can be selected or
8636 * @param obj The gengrid object
8637 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8640 * @see elm_gengrid_no_select_mode_set() for more details
8644 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8647 * Enable or disable multi-selection in a given gengrid widget
8649 * @param obj The gengrid object.
8650 * @param multi @c EINA_TRUE, to enable multi-selection,
8651 * @c EINA_FALSE to disable it.
8653 * Multi-selection is the ability to have @b more than one
8654 * item selected, on a given gengrid, simultaneously. When it is
8655 * enabled, a sequence of clicks on different items will make them
8656 * all selected, progressively. A click on an already selected item
8657 * will unselect it. If interacting via the keyboard,
8658 * multi-selection is enabled while holding the "Shift" key.
8660 * @note By default, multi-selection is @b disabled on gengrids
8662 * @see elm_gengrid_multi_select_get()
8666 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8669 * Get whether multi-selection is enabled or disabled for a given
8672 * @param obj The gengrid object.
8673 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8674 * EINA_FALSE otherwise
8676 * @see elm_gengrid_multi_select_set() for more details
8680 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8683 * Enable or disable bouncing effect for a given gengrid widget
8685 * @param obj The gengrid object
8686 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8687 * @c EINA_FALSE to disable it
8688 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8689 * @c EINA_FALSE to disable it
8691 * The bouncing effect occurs whenever one reaches the gengrid's
8692 * edge's while panning it -- it will scroll past its limits a
8693 * little bit and return to the edge again, in a animated for,
8696 * @note By default, gengrids have bouncing enabled on both axis
8698 * @see elm_gengrid_bounce_get()
8702 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8705 * Get whether bouncing effects are enabled or disabled, for a
8706 * given gengrid widget, on each axis
8708 * @param obj The gengrid object
8709 * @param h_bounce Pointer to a variable where to store the
8710 * horizontal bouncing flag.
8711 * @param v_bounce Pointer to a variable where to store the
8712 * vertical bouncing flag.
8714 * @see elm_gengrid_bounce_set() for more details
8718 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8721 * Set a given gengrid widget's scrolling page size, relative to
8722 * its viewport size.
8724 * @param obj The gengrid object
8725 * @param h_pagerel The horizontal page (relative) size
8726 * @param v_pagerel The vertical page (relative) size
8728 * The gengrid's scroller is capable of binding scrolling by the
8729 * user to "pages". It means that, while scrolling and, specially
8730 * after releasing the mouse button, the grid will @b snap to the
8731 * nearest displaying page's area. When page sizes are set, the
8732 * grid's continuous content area is split into (equal) page sized
8735 * This function sets the size of a page <b>relatively to the
8736 * viewport dimensions</b> of the gengrid, for each axis. A value
8737 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8738 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8739 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8740 * 1.0. Values beyond those will make it behave behave
8741 * inconsistently. If you only want one axis to snap to pages, use
8742 * the value @c 0.0 for the other one.
8744 * There is a function setting page size values in @b absolute
8745 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8746 * is mutually exclusive to this one.
8748 * @see elm_gengrid_page_relative_get()
8752 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8755 * Get a given gengrid widget's scrolling page size, relative to
8756 * its viewport size.
8758 * @param obj The gengrid object
8759 * @param h_pagerel Pointer to a variable where to store the
8760 * horizontal page (relative) size
8761 * @param v_pagerel Pointer to a variable where to store the
8762 * vertical page (relative) size
8764 * @see elm_gengrid_page_relative_set() for more details
8768 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8771 * Set a given gengrid widget's scrolling page size
8773 * @param obj The gengrid object
8774 * @param h_pagerel The horizontal page size, in pixels
8775 * @param v_pagerel The vertical page size, in pixels
8777 * The gengrid's scroller is capable of binding scrolling by the
8778 * user to "pages". It means that, while scrolling and, specially
8779 * after releasing the mouse button, the grid will @b snap to the
8780 * nearest displaying page's area. When page sizes are set, the
8781 * grid's continuous content area is split into (equal) page sized
8784 * This function sets the size of a page of the gengrid, in pixels,
8785 * for each axis. Sane usable values are, between @c 0 and the
8786 * dimensions of @p obj, for each axis. Values beyond those will
8787 * make it behave behave inconsistently. If you only want one axis
8788 * to snap to pages, use the value @c 0 for the other one.
8790 * There is a function setting page size values in @b relative
8791 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8792 * use is mutually exclusive to this one.
8796 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8799 * Set the direction in which a given gengrid widget will expand while
8800 * placing its items.
8802 * @param obj The gengrid object.
8803 * @param setting @c EINA_TRUE to make the gengrid expand
8804 * horizontally, @c EINA_FALSE to expand vertically.
8806 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8807 * in @b columns, from top to bottom and, when the space for a
8808 * column is filled, another one is started on the right, thus
8809 * expanding the grid horizontally. When in "vertical mode"
8810 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8811 * to right and, when the space for a row is filled, another one is
8812 * started below, thus expanding the grid vertically.
8814 * @see elm_gengrid_horizontal_get()
8818 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8821 * Get for what direction a given gengrid widget will expand while
8822 * placing its items.
8824 * @param obj The gengrid object.
8825 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8826 * @c EINA_FALSE if it's set to expand vertically.
8828 * @see elm_gengrid_horizontal_set() for more detais
8832 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8835 * Get the first item in a given gengrid widget
8837 * @param obj The gengrid object
8838 * @return The first item's handle or @c NULL, if there are no
8839 * items in @p obj (and on errors)
8841 * This returns the first item in the @p obj's internal list of
8844 * @see elm_gengrid_last_item_get()
8848 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8851 * Get the last item in a given gengrid widget
8853 * @param obj The gengrid object
8854 * @return The last item's handle or @c NULL, if there are no
8855 * items in @p obj (and on errors)
8857 * This returns the last item in the @p obj's internal list of
8860 * @see elm_gengrid_first_item_get()
8864 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8867 * Get the @b next item in a gengrid widget's internal list of items,
8868 * given a handle to one of those items.
8870 * @param item The gengrid item to fetch next from
8871 * @return The item after @p item, or @c NULL if there's none (and
8874 * This returns the item placed after the @p item, on the container
8877 * @see elm_gengrid_item_prev_get()
8881 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8884 * Get the @b previous item in a gengrid widget's internal list of items,
8885 * given a handle to one of those items.
8887 * @param item The gengrid item to fetch previous from
8888 * @return The item before @p item, or @c NULL if there's none (and
8891 * This returns the item placed before the @p item, on the container
8894 * @see elm_gengrid_item_next_get()
8898 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8901 * Get the gengrid object's handle which contains a given gengrid
8904 * @param item The item to fetch the container from
8905 * @return The gengrid (parent) object
8907 * This returns the gengrid object itself that an item belongs to.
8911 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8914 * Remove a gengrid item from its parent, deleting it.
8916 * @param item The item to be removed.
8917 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8919 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8924 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8927 * Update the contents of a given gengrid item
8929 * @param item The gengrid item
8931 * This updates an item by calling all the item class functions
8932 * again to get the contents, labels and states. Use this when the
8933 * original item data has changed and you want the changes to be
8938 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8941 * Get the Gengrid Item class for the given Gengrid Item.
8943 * @param item The gengrid item
8945 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8946 * the function pointers and item_style.
8950 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8953 * Get the Gengrid Item class for the given Gengrid Item.
8955 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8956 * the function pointers and item_style.
8958 * @param item The gengrid item
8959 * @param gic The gengrid item class describing the function pointers and the item style.
8963 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8966 * Return the data associated to a given gengrid item
8968 * @param item The gengrid item.
8969 * @return the data associated with this item.
8971 * This returns the @c data value passed on the
8972 * elm_gengrid_item_append() and related item addition calls.
8974 * @see elm_gengrid_item_append()
8975 * @see elm_gengrid_item_data_set()
8979 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8982 * Set the data associated with a given gengrid item
8984 * @param item The gengrid item
8985 * @param data The data pointer to set on it
8987 * This @b overrides the @c data value passed on the
8988 * elm_gengrid_item_append() and related item addition calls. This
8989 * function @b won't call elm_gengrid_item_update() automatically,
8990 * so you'd issue it afterwards if you want to have the item
8991 * updated to reflect the new data.
8993 * @see elm_gengrid_item_data_get()
8994 * @see elm_gengrid_item_update()
8998 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9001 * Get a given gengrid item's position, relative to the whole
9002 * gengrid's grid area.
9004 * @param item The Gengrid item.
9005 * @param x Pointer to variable to store the item's <b>row number</b>.
9006 * @param y Pointer to variable to store the item's <b>column number</b>.
9008 * This returns the "logical" position of the item within the
9009 * gengrid. For example, @c (0, 1) would stand for first row,
9014 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9017 * Set whether a given gengrid item is selected or not
9019 * @param item The gengrid item
9020 * @param selected Use @c EINA_TRUE, to make it selected, @c
9021 * EINA_FALSE to make it unselected
9023 * This sets the selected state of an item. If multi-selection is
9024 * not enabled on the containing gengrid and @p selected is @c
9025 * EINA_TRUE, any other previously selected items will get
9026 * unselected in favor of this new one.
9028 * @see elm_gengrid_item_selected_get()
9032 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9035 * Get whether a given gengrid item is selected or not
9037 * @param item The gengrid item
9038 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9040 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9042 * @see elm_gengrid_item_selected_set() for more details
9046 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9049 * Get the real Evas object created to implement the view of a
9050 * given gengrid item
9052 * @param item The gengrid item.
9053 * @return the Evas object implementing this item's view.
9055 * This returns the actual Evas object used to implement the
9056 * specified gengrid item's view. This may be @c NULL, as it may
9057 * not have been created or may have been deleted, at any time, by
9058 * the gengrid. <b>Do not modify this object</b> (move, resize,
9059 * show, hide, etc.), as the gengrid is controlling it. This
9060 * function is for querying, emitting custom signals or hooking
9061 * lower level callbacks for events on that object. Do not delete
9062 * this object under any circumstances.
9064 * @see elm_gengrid_item_data_get()
9068 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9071 * Show the portion of a gengrid's internal grid containing a given
9072 * item, @b immediately.
9074 * @param item The item to display
9076 * This causes gengrid to @b redraw its viewport's contents to the
9077 * region contining the given @p item item, if it is not fully
9080 * @see elm_gengrid_item_bring_in()
9084 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9087 * Animatedly bring in, to the visible area of a gengrid, a given
9090 * @param item The gengrid item to display
9092 * This causes gengrid to jump to the given @p item and show
9093 * it (by scrolling), if it is not fully visible. This will use
9094 * animation to do so and take a period of time to complete.
9096 * @see elm_gengrid_item_show()
9100 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9103 * Set whether a given gengrid item is disabled or not.
9105 * @param item The gengrid item
9106 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9107 * to enable it back.
9109 * A disabled item cannot be selected or unselected. It will also
9110 * change its appearance, to signal the user it's disabled.
9112 * @see elm_gengrid_item_disabled_get()
9116 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9119 * Get whether a given gengrid item is disabled or not.
9121 * @param item The gengrid item
9122 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9125 * @see elm_gengrid_item_disabled_set() for more details
9129 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9132 * Set the text to be shown in a given gengrid item's tooltips.
9134 * @param item The gengrid item
9135 * @param text The text to set in the content
9137 * This call will setup the text to be used as tooltip to that item
9138 * (analogous to elm_object_tooltip_text_set(), but being item
9139 * tooltips with higher precedence than object tooltips). It can
9140 * have only one tooltip at a time, so any previous tooltip data
9145 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9148 * Set the content to be shown in a given gengrid item's tooltip
9150 * @param item The gengrid item.
9151 * @param func The function returning the tooltip contents.
9152 * @param data What to provide to @a func as callback data/context.
9153 * @param del_cb Called when data is not needed anymore, either when
9154 * another callback replaces @p func, the tooltip is unset with
9155 * elm_gengrid_item_tooltip_unset() or the owner @p item
9156 * dies. This callback receives as its first parameter the
9157 * given @p data, being @c event_info the item handle.
9159 * This call will setup the tooltip's contents to @p item
9160 * (analogous to elm_object_tooltip_content_cb_set(), but being
9161 * item tooltips with higher precedence than object tooltips). It
9162 * can have only one tooltip at a time, so any previous tooltip
9163 * content will get removed. @p func (with @p data) will be called
9164 * every time Elementary needs to show the tooltip and it should
9165 * return a valid Evas object, which will be fully managed by the
9166 * tooltip system, getting deleted when the tooltip is gone.
9170 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);
9173 * Unset a tooltip from a given gengrid item
9175 * @param item gengrid item to remove a previously set tooltip from.
9177 * This call removes any tooltip set on @p item. The callback
9178 * provided as @c del_cb to
9179 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9180 * notify it is not used anymore (and have resources cleaned, if
9183 * @see elm_gengrid_item_tooltip_content_cb_set()
9187 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9190 * Set a different @b style for a given gengrid item's tooltip.
9192 * @param item gengrid item with tooltip set
9193 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9194 * "default", @c "transparent", etc)
9196 * Tooltips can have <b>alternate styles</b> to be displayed on,
9197 * which are defined by the theme set on Elementary. This function
9198 * works analogously as elm_object_tooltip_style_set(), but here
9199 * applied only to gengrid item objects. The default style for
9200 * tooltips is @c "default".
9202 * @note before you set a style you should define a tooltip with
9203 * elm_gengrid_item_tooltip_content_cb_set() or
9204 * elm_gengrid_item_tooltip_text_set()
9206 * @see elm_gengrid_item_tooltip_style_get()
9210 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9213 * Get the style set a given gengrid item's tooltip.
9215 * @param item gengrid item with tooltip already set on.
9216 * @return style the theme style in use, which defaults to
9217 * "default". If the object does not have a tooltip set,
9218 * then @c NULL is returned.
9220 * @see elm_gengrid_item_tooltip_style_set() for more details
9224 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9226 * @brief Disable size restrictions on an object's tooltip
9227 * @param item The tooltip's anchor object
9228 * @param disable If EINA_TRUE, size restrictions are disabled
9229 * @return EINA_FALSE on failure, EINA_TRUE on success
9231 * This function allows a tooltip to expand beyond its parant window's canvas.
9232 * It will instead be limited only by the size of the display.
9234 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9236 * @brief Retrieve size restriction state of an object's tooltip
9237 * @param item The tooltip's anchor object
9238 * @return If EINA_TRUE, size restrictions are disabled
9240 * This function returns whether a tooltip is allowed to expand beyond
9241 * its parant window's canvas.
9242 * It will instead be limited only by the size of the display.
9244 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9246 * Set the type of mouse pointer/cursor decoration to be shown,
9247 * when the mouse pointer is over the given gengrid widget item
9249 * @param item gengrid item to customize cursor on
9250 * @param cursor the cursor type's name
9252 * This function works analogously as elm_object_cursor_set(), but
9253 * here the cursor's changing area is restricted to the item's
9254 * area, and not the whole widget's. Note that that item cursors
9255 * have precedence over widget cursors, so that a mouse over @p
9256 * item will always show cursor @p type.
9258 * If this function is called twice for an object, a previously set
9259 * cursor will be unset on the second call.
9261 * @see elm_object_cursor_set()
9262 * @see elm_gengrid_item_cursor_get()
9263 * @see elm_gengrid_item_cursor_unset()
9267 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9270 * Get the type of mouse pointer/cursor decoration set to be shown,
9271 * when the mouse pointer is over the given gengrid widget item
9273 * @param item gengrid item with custom cursor set
9274 * @return the cursor type's name or @c NULL, if no custom cursors
9275 * were set to @p item (and on errors)
9277 * @see elm_object_cursor_get()
9278 * @see elm_gengrid_item_cursor_set() for more details
9279 * @see elm_gengrid_item_cursor_unset()
9283 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9286 * Unset any custom mouse pointer/cursor decoration set to be
9287 * shown, when the mouse pointer is over the given gengrid widget
9288 * item, thus making it show the @b default cursor again.
9290 * @param item a gengrid item
9292 * Use this call to undo any custom settings on this item's cursor
9293 * decoration, bringing it back to defaults (no custom style set).
9295 * @see elm_object_cursor_unset()
9296 * @see elm_gengrid_item_cursor_set() for more details
9300 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9303 * Set a different @b style for a given custom cursor set for a
9306 * @param item gengrid item with custom cursor set
9307 * @param style the <b>theme style</b> to use (e.g. @c "default",
9308 * @c "transparent", etc)
9310 * This function only makes sense when one is using custom mouse
9311 * cursor decorations <b>defined in a theme file</b> , which can
9312 * have, given a cursor name/type, <b>alternate styles</b> on
9313 * it. It works analogously as elm_object_cursor_style_set(), but
9314 * here applied only to gengrid item objects.
9316 * @warning Before you set a cursor style you should have defined a
9317 * custom cursor previously on the item, with
9318 * elm_gengrid_item_cursor_set()
9320 * @see elm_gengrid_item_cursor_engine_only_set()
9321 * @see elm_gengrid_item_cursor_style_get()
9325 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9328 * Get the current @b style set for a given gengrid item's custom
9331 * @param item gengrid item with custom cursor set.
9332 * @return style the cursor style in use. If the object does not
9333 * have a cursor set, then @c NULL is returned.
9335 * @see elm_gengrid_item_cursor_style_set() for more details
9339 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9342 * Set if the (custom) cursor for a given gengrid item should be
9343 * searched in its theme, also, or should only rely on the
9346 * @param item item with custom (custom) cursor already set on
9347 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9348 * only on those provided by the rendering engine, @c EINA_FALSE to
9349 * have them searched on the widget's theme, as well.
9351 * @note This call is of use only if you've set a custom cursor
9352 * for gengrid items, with elm_gengrid_item_cursor_set().
9354 * @note By default, cursors will only be looked for between those
9355 * provided by the rendering engine.
9359 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9362 * Get if the (custom) cursor for a given gengrid item is being
9363 * searched in its theme, also, or is only relying on the rendering
9366 * @param item a gengrid item
9367 * @return @c EINA_TRUE, if cursors are being looked for only on
9368 * those provided by the rendering engine, @c EINA_FALSE if they
9369 * are being searched on the widget's theme, as well.
9371 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9375 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9378 * Remove all items from a given gengrid widget
9380 * @param obj The gengrid object.
9382 * This removes (and deletes) all items in @p obj, leaving it
9385 * @see elm_gengrid_item_del(), to remove just one item.
9389 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9392 * Get the selected item in a given gengrid widget
9394 * @param obj The gengrid object.
9395 * @return The selected item's handleor @c NULL, if none is
9396 * selected at the moment (and on errors)
9398 * This returns the selected item in @p obj. If multi selection is
9399 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9400 * the first item in the list is selected, which might not be very
9401 * useful. For that case, see elm_gengrid_selected_items_get().
9405 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9408 * Get <b>a list</b> of selected items in a given gengrid
9410 * @param obj The gengrid object.
9411 * @return The list of selected items or @c NULL, if none is
9412 * selected at the moment (and on errors)
9414 * This returns a list of the selected items, in the order that
9415 * they appear in the grid. This list is only valid as long as no
9416 * more items are selected or unselected (or unselected implictly
9417 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9420 * @see elm_gengrid_selected_item_get()
9424 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9431 * @defgroup Clock Clock
9433 * @image html img/widget/clock/preview-00.png
9434 * @image latex img/widget/clock/preview-00.eps
9436 * This is a @b digital clock widget. In its default theme, it has a
9437 * vintage "flipping numbers clock" appearance, which will animate
9438 * sheets of individual algarisms individually as time goes by.
9440 * A newly created clock will fetch system's time (already
9441 * considering local time adjustments) to start with, and will tick
9442 * accondingly. It may or may not show seconds.
9444 * Clocks have an @b edition mode. When in it, the sheets will
9445 * display extra arrow indications on the top and bottom and the
9446 * user may click on them to raise or lower the time values. After
9447 * it's told to exit edition mode, it will keep ticking with that
9448 * new time set (it keeps the difference from local time).
9450 * Also, when under edition mode, user clicks on the cited arrows
9451 * which are @b held for some time will make the clock to flip the
9452 * sheet, thus editing the time, continuosly and automatically for
9453 * the user. The interval between sheet flips will keep growing in
9454 * time, so that it helps the user to reach a time which is distant
9457 * The time display is, by default, in military mode (24h), but an
9458 * am/pm indicator may be optionally shown, too, when it will
9461 * Smart callbacks one can register to:
9462 * - "changed" - the clock's user changed the time
9464 * Here is an example on its usage:
9465 * @li @ref clock_example
9474 * Identifiers for which clock digits should be editable, when a
9475 * clock widget is in edition mode. Values may be ORed together to
9476 * make a mask, naturally.
9478 * @see elm_clock_edit_set()
9479 * @see elm_clock_digit_edit_set()
9481 typedef enum _Elm_Clock_Digedit
9483 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9484 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9485 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9486 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9487 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9488 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9489 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9490 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9491 } Elm_Clock_Digedit;
9494 * Add a new clock widget to the given parent Elementary
9495 * (container) object
9497 * @param parent The parent object
9498 * @return a new clock widget handle or @c NULL, on errors
9500 * This function inserts a new clock widget on the canvas.
9504 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9507 * Set a clock widget's time, programmatically
9509 * @param obj The clock widget object
9510 * @param hrs The hours to set
9511 * @param min The minutes to set
9512 * @param sec The secondes to set
9514 * This function updates the time that is showed by the clock
9517 * Values @b must be set within the following ranges:
9518 * - 0 - 23, for hours
9519 * - 0 - 59, for minutes
9520 * - 0 - 59, for seconds,
9522 * even if the clock is not in "military" mode.
9524 * @warning The behavior for values set out of those ranges is @b
9529 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9532 * Get a clock widget's time values
9534 * @param obj The clock object
9535 * @param[out] hrs Pointer to the variable to get the hours value
9536 * @param[out] min Pointer to the variable to get the minutes value
9537 * @param[out] sec Pointer to the variable to get the seconds value
9539 * This function gets the time set for @p obj, returning
9540 * it on the variables passed as the arguments to function
9542 * @note Use @c NULL pointers on the time values you're not
9543 * interested in: they'll be ignored by the function.
9547 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9550 * Set whether a given clock widget is under <b>edition mode</b> or
9551 * under (default) displaying-only mode.
9553 * @param obj The clock object
9554 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9555 * put it back to "displaying only" mode
9557 * This function makes a clock's time to be editable or not <b>by
9558 * user interaction</b>. When in edition mode, clocks @b stop
9559 * ticking, until one brings them back to canonical mode. The
9560 * elm_clock_digit_edit_set() function will influence which digits
9561 * of the clock will be editable. By default, all of them will be
9562 * (#ELM_CLOCK_NONE).
9564 * @note am/pm sheets, if being shown, will @b always be editable
9565 * under edition mode.
9567 * @see elm_clock_edit_get()
9571 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9574 * Retrieve whether a given clock widget is under <b>edition
9575 * mode</b> or under (default) displaying-only mode.
9577 * @param obj The clock object
9578 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9581 * This function retrieves whether the clock's time can be edited
9582 * or not by user interaction.
9584 * @see elm_clock_edit_set() for more details
9588 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9591 * Set what digits of the given clock widget should be editable
9592 * when in edition mode.
9594 * @param obj The clock object
9595 * @param digedit Bit mask indicating the digits to be editable
9596 * (values in #Elm_Clock_Digedit).
9598 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9599 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9602 * @see elm_clock_digit_edit_get()
9606 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9609 * Retrieve what digits of the given clock widget should be
9610 * editable when in edition mode.
9612 * @param obj The clock object
9613 * @return Bit mask indicating the digits to be editable
9614 * (values in #Elm_Clock_Digedit).
9616 * @see elm_clock_digit_edit_set() for more details
9620 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9623 * Set if the given clock widget must show hours in military or
9626 * @param obj The clock object
9627 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9630 * This function sets if the clock must show hours in military or
9631 * am/pm mode. In some countries like Brazil the military mode
9632 * (00-24h-format) is used, in opposition to the USA, where the
9633 * am/pm mode is more commonly used.
9635 * @see elm_clock_show_am_pm_get()
9639 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9642 * Get if the given clock widget shows hours in military or am/pm
9645 * @param obj The clock object
9646 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9649 * This function gets if the clock shows hours in military or am/pm
9652 * @see elm_clock_show_am_pm_set() for more details
9656 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9659 * Set if the given clock widget must show time with seconds or not
9661 * @param obj The clock object
9662 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9664 * This function sets if the given clock must show or not elapsed
9665 * seconds. By default, they are @b not shown.
9667 * @see elm_clock_show_seconds_get()
9671 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9674 * Get whether the given clock widget is showing time with seconds
9677 * @param obj The clock object
9678 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9680 * This function gets whether @p obj is showing or not the elapsed
9683 * @see elm_clock_show_seconds_set()
9687 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9690 * Set the interval on time updates for an user mouse button hold
9691 * on clock widgets' time edition.
9693 * @param obj The clock object
9694 * @param interval The (first) interval value in seconds
9696 * This interval value is @b decreased while the user holds the
9697 * mouse pointer either incrementing or decrementing a given the
9698 * clock digit's value.
9700 * This helps the user to get to a given time distant from the
9701 * current one easier/faster, as it will start to flip quicker and
9702 * quicker on mouse button holds.
9704 * The calculation for the next flip interval value, starting from
9705 * the one set with this call, is the previous interval divided by
9706 * 1.05, so it decreases a little bit.
9708 * The default starting interval value for automatic flips is
9711 * @see elm_clock_interval_get()
9715 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9718 * Get the interval on time updates for an user mouse button hold
9719 * on clock widgets' time edition.
9721 * @param obj The clock object
9722 * @return The (first) interval value, in seconds, set on it
9724 * @see elm_clock_interval_set() for more details
9728 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9735 * @defgroup Layout Layout
9737 * @image html img/widget/layout/preview-00.png
9738 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9740 * @image html img/layout-predefined.png
9741 * @image latex img/layout-predefined.eps width=\textwidth
9743 * This is a container widget that takes a standard Edje design file and
9744 * wraps it very thinly in a widget.
9746 * An Edje design (theme) file has a very wide range of possibilities to
9747 * describe the behavior of elements added to the Layout. Check out the Edje
9748 * documentation and the EDC reference to get more information about what can
9749 * be done with Edje.
9751 * Just like @ref List, @ref Box, and other container widgets, any
9752 * object added to the Layout will become its child, meaning that it will be
9753 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9755 * The Layout widget can contain as many Contents, Boxes or Tables as
9756 * described in its theme file. For instance, objects can be added to
9757 * different Tables by specifying the respective Table part names. The same
9758 * is valid for Content and Box.
9760 * The objects added as child of the Layout will behave as described in the
9761 * part description where they were added. There are 3 possible types of
9762 * parts where a child can be added:
9764 * @section secContent Content (SWALLOW part)
9766 * Only one object can be added to the @c SWALLOW part (but you still can
9767 * have many @c SWALLOW parts and one object on each of them). Use the @c
9768 * elm_object_content_set/get/unset functions to set, retrieve and unset
9769 * objects as content of the @c SWALLOW. After being set to this part, the
9770 * object size, position, visibility, clipping and other description
9771 * properties will be totally controled by the description of the given part
9772 * (inside the Edje theme file).
9774 * One can use @c evas_object_size_hint_* functions on the child to have some
9775 * kind of control over its behavior, but the resulting behavior will still
9776 * depend heavily on the @c SWALLOW part description.
9778 * The Edje theme also can change the part description, based on signals or
9779 * scripts running inside the theme. This change can also be animated. All of
9780 * this will affect the child object set as content accordingly. The object
9781 * size will be changed if the part size is changed, it will animate move if
9782 * the part is moving, and so on.
9784 * The following picture demonstrates a Layout widget with a child object
9785 * added to its @c SWALLOW:
9787 * @image html layout_swallow.png
9788 * @image latex layout_swallow.eps width=\textwidth
9790 * @section secBox Box (BOX part)
9792 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9793 * allows one to add objects to the box and have them distributed along its
9794 * area, accordingly to the specified @a layout property (now by @a layout we
9795 * mean the chosen layouting design of the Box, not the Layout widget
9798 * A similar effect for having a box with its position, size and other things
9799 * controled by the Layout theme would be to create an Elementary @ref Box
9800 * widget and add it as a Content in the @c SWALLOW part.
9802 * The main difference of using the Layout Box is that its behavior, the box
9803 * properties like layouting format, padding, align, etc. will be all
9804 * controled by the theme. This means, for example, that a signal could be
9805 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9806 * handled the signal by changing the box padding, or align, or both. Using
9807 * the Elementary @ref Box widget is not necessarily harder or easier, it
9808 * just depends on the circunstances and requirements.
9810 * The Layout Box can be used through the @c elm_layout_box_* set of
9813 * The following picture demonstrates a Layout widget with many child objects
9814 * added to its @c BOX part:
9816 * @image html layout_box.png
9817 * @image latex layout_box.eps width=\textwidth
9819 * @section secTable Table (TABLE part)
9821 * Just like the @ref secBox, the Layout Table is very similar to the
9822 * Elementary @ref Table widget. It allows one to add objects to the Table
9823 * specifying the row and column where the object should be added, and any
9824 * column or row span if necessary.
9826 * Again, we could have this design by adding a @ref Table widget to the @c
9827 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9828 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9829 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9831 * The Layout Table can be used through the @c elm_layout_table_* set of
9834 * The following picture demonstrates a Layout widget with many child objects
9835 * added to its @c TABLE part:
9837 * @image html layout_table.png
9838 * @image latex layout_table.eps width=\textwidth
9840 * @section secPredef Predefined Layouts
9842 * Another interesting thing about the Layout widget is that it offers some
9843 * predefined themes that come with the default Elementary theme. These
9844 * themes can be set by the call elm_layout_theme_set(), and provide some
9845 * basic functionality depending on the theme used.
9847 * Most of them already send some signals, some already provide a toolbar or
9848 * back and next buttons.
9850 * These are available predefined theme layouts. All of them have class = @c
9851 * layout, group = @c application, and style = one of the following options:
9853 * @li @c toolbar-content - application with toolbar and main content area
9854 * @li @c toolbar-content-back - application with toolbar and main content
9855 * area with a back button and title area
9856 * @li @c toolbar-content-back-next - application with toolbar and main
9857 * content area with a back and next buttons and title area
9858 * @li @c content-back - application with a main content area with a back
9859 * button and title area
9860 * @li @c content-back-next - application with a main content area with a
9861 * back and next buttons and title area
9862 * @li @c toolbar-vbox - application with toolbar and main content area as a
9864 * @li @c toolbar-table - application with toolbar and main content area as a
9867 * @section secExamples Examples
9869 * Some examples of the Layout widget can be found here:
9870 * @li @ref layout_example_01
9871 * @li @ref layout_example_02
9872 * @li @ref layout_example_03
9873 * @li @ref layout_example_edc
9878 * Add a new layout to the parent
9880 * @param parent The parent object
9881 * @return The new object or NULL if it cannot be created
9883 * @see elm_layout_file_set()
9884 * @see elm_layout_theme_set()
9888 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9890 * Set the file that will be used as layout
9892 * @param obj The layout object
9893 * @param file The path to file (edj) that will be used as layout
9894 * @param group The group that the layout belongs in edje file
9896 * @return (1 = success, 0 = error)
9900 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9902 * Set the edje group from the elementary theme that will be used as layout
9904 * @param obj The layout object
9905 * @param clas the clas of the group
9906 * @param group the group
9907 * @param style the style to used
9909 * @return (1 = success, 0 = error)
9913 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9915 * Set the layout content.
9917 * @param obj The layout object
9918 * @param swallow The swallow part name in the edje file
9919 * @param content The child that will be added in this layout object
9921 * Once the content object is set, a previously set one will be deleted.
9922 * If you want to keep that old content object, use the
9923 * elm_object_part_content_unset() function.
9925 * @note In an Edje theme, the part used as a content container is called @c
9926 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9927 * expected to be a part name just like the second parameter of
9928 * elm_layout_box_append().
9930 * @see elm_layout_box_append()
9931 * @see elm_object_part_content_get()
9932 * @see elm_object_part_content_unset()
9934 * @deprecated use elm_object_part_content_set() instead
9938 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9940 * Get the child object in the given content part.
9942 * @param obj The layout object
9943 * @param swallow The SWALLOW part to get its content
9945 * @return The swallowed object or NULL if none or an error occurred
9947 * @deprecated use elm_object_part_content_get() instead
9951 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9953 * Unset the layout content.
9955 * @param obj The layout object
9956 * @param swallow The swallow part name in the edje file
9957 * @return The content that was being used
9959 * Unparent and return the content object which was set for this part.
9961 * @deprecated use elm_object_part_content_unset() instead
9965 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9967 * Set the text of the given part
9969 * @param obj The layout object
9970 * @param part The TEXT part where to set the text
9971 * @param text The text to set
9974 * @deprecated use elm_object_part_text_set() instead.
9976 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9978 * Get the text set in the given part
9980 * @param obj The layout object
9981 * @param part The TEXT part to retrieve the text off
9983 * @return The text set in @p part
9986 * @deprecated use elm_object_part_text_get() instead.
9988 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9990 * Append child to layout box part.
9992 * @param obj the layout object
9993 * @param part the box part to which the object will be appended.
9994 * @param child the child object to append to box.
9996 * Once the object is appended, it will become child of the layout. Its
9997 * lifetime will be bound to the layout, whenever the layout dies the child
9998 * will be deleted automatically. One should use elm_layout_box_remove() to
9999 * make this layout forget about the object.
10001 * @see elm_layout_box_prepend()
10002 * @see elm_layout_box_insert_before()
10003 * @see elm_layout_box_insert_at()
10004 * @see elm_layout_box_remove()
10008 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10010 * Prepend child to layout box part.
10012 * @param obj the layout object
10013 * @param part the box part to prepend.
10014 * @param child the child object to prepend to box.
10016 * Once the object is prepended, it will become child of the layout. Its
10017 * lifetime will be bound to the layout, whenever the layout dies the child
10018 * will be deleted automatically. One should use elm_layout_box_remove() to
10019 * make this layout forget about the object.
10021 * @see elm_layout_box_append()
10022 * @see elm_layout_box_insert_before()
10023 * @see elm_layout_box_insert_at()
10024 * @see elm_layout_box_remove()
10028 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10030 * Insert child to layout box part before a reference object.
10032 * @param obj the layout object
10033 * @param part the box part to insert.
10034 * @param child the child object to insert into box.
10035 * @param reference another reference object to insert before in box.
10037 * Once the object is inserted, it will become child of the layout. Its
10038 * lifetime will be bound to the layout, whenever the layout dies the child
10039 * will be deleted automatically. One should use elm_layout_box_remove() to
10040 * make this layout forget about the object.
10042 * @see elm_layout_box_append()
10043 * @see elm_layout_box_prepend()
10044 * @see elm_layout_box_insert_before()
10045 * @see elm_layout_box_remove()
10049 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10051 * Insert child to layout box part at a given position.
10053 * @param obj the layout object
10054 * @param part the box part to insert.
10055 * @param child the child object to insert into box.
10056 * @param pos the numeric position >=0 to insert the child.
10058 * Once the object is inserted, it will become child of the layout. Its
10059 * lifetime will be bound to the layout, whenever the layout dies the child
10060 * will be deleted automatically. One should use elm_layout_box_remove() to
10061 * make this layout forget about the object.
10063 * @see elm_layout_box_append()
10064 * @see elm_layout_box_prepend()
10065 * @see elm_layout_box_insert_before()
10066 * @see elm_layout_box_remove()
10070 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10072 * Remove a child of the given part box.
10074 * @param obj The layout object
10075 * @param part The box part name to remove child.
10076 * @param child The object to remove from box.
10077 * @return The object that was being used, or NULL if not found.
10079 * The object will be removed from the box part and its lifetime will
10080 * not be handled by the layout anymore. This is equivalent to
10081 * elm_object_part_content_unset() for box.
10083 * @see elm_layout_box_append()
10084 * @see elm_layout_box_remove_all()
10088 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10090 * Remove all child of the given part box.
10092 * @param obj The layout object
10093 * @param part The box part name to remove child.
10094 * @param clear If EINA_TRUE, then all objects will be deleted as
10095 * well, otherwise they will just be removed and will be
10096 * dangling on the canvas.
10098 * The objects will be removed from the box part and their lifetime will
10099 * not be handled by the layout anymore. This is equivalent to
10100 * elm_layout_box_remove() for all box children.
10102 * @see elm_layout_box_append()
10103 * @see elm_layout_box_remove()
10107 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10109 * Insert child to layout table part.
10111 * @param obj the layout object
10112 * @param part the box part to pack child.
10113 * @param child_obj the child object to pack into table.
10114 * @param col the column to which the child should be added. (>= 0)
10115 * @param row the row to which the child should be added. (>= 0)
10116 * @param colspan how many columns should be used to store this object. (>=
10118 * @param rowspan how many rows should be used to store this object. (>= 1)
10120 * Once the object is inserted, it will become child of the table. Its
10121 * lifetime will be bound to the layout, and whenever the layout dies the
10122 * child will be deleted automatically. One should use
10123 * elm_layout_table_remove() to make this layout forget about the object.
10125 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10126 * more space than a single cell. For instance, the following code:
10128 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10131 * Would result in an object being added like the following picture:
10133 * @image html layout_colspan.png
10134 * @image latex layout_colspan.eps width=\textwidth
10136 * @see elm_layout_table_unpack()
10137 * @see elm_layout_table_clear()
10141 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);
10143 * Unpack (remove) a child of the given part table.
10145 * @param obj The layout object
10146 * @param part The table part name to remove child.
10147 * @param child_obj The object to remove from table.
10148 * @return The object that was being used, or NULL if not found.
10150 * The object will be unpacked from the table part and its lifetime
10151 * will not be handled by the layout anymore. This is equivalent to
10152 * elm_object_part_content_unset() for table.
10154 * @see elm_layout_table_pack()
10155 * @see elm_layout_table_clear()
10159 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10161 * Remove all child of the given part table.
10163 * @param obj The layout object
10164 * @param part The table part name to remove child.
10165 * @param clear If EINA_TRUE, then all objects will be deleted as
10166 * well, otherwise they will just be removed and will be
10167 * dangling on the canvas.
10169 * The objects will be removed from the table part and their lifetime will
10170 * not be handled by the layout anymore. This is equivalent to
10171 * elm_layout_table_unpack() for all table children.
10173 * @see elm_layout_table_pack()
10174 * @see elm_layout_table_unpack()
10178 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10180 * Get the edje layout
10182 * @param obj The layout object
10184 * @return A Evas_Object with the edje layout settings loaded
10185 * with function elm_layout_file_set
10187 * This returns the edje object. It is not expected to be used to then
10188 * swallow objects via edje_object_part_swallow() for example. Use
10189 * elm_object_part_content_set() instead so child object handling and sizing is
10192 * @note This function should only be used if you really need to call some
10193 * low level Edje function on this edje object. All the common stuff (setting
10194 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10195 * with proper elementary functions.
10197 * @see elm_object_signal_callback_add()
10198 * @see elm_object_signal_emit()
10199 * @see elm_object_part_text_set()
10200 * @see elm_object_part_content_set()
10201 * @see elm_layout_box_append()
10202 * @see elm_layout_table_pack()
10203 * @see elm_layout_data_get()
10207 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10209 * Get the edje data from the given layout
10211 * @param obj The layout object
10212 * @param key The data key
10214 * @return The edje data string
10216 * This function fetches data specified inside the edje theme of this layout.
10217 * This function return NULL if data is not found.
10219 * In EDC this comes from a data block within the group block that @p
10220 * obj was loaded from. E.g.
10227 * item: "key1" "value1";
10228 * item: "key2" "value2";
10236 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10240 * @param obj The layout object
10242 * Manually forces a sizing re-evaluation. This is useful when the minimum
10243 * size required by the edje theme of this layout has changed. The change on
10244 * the minimum size required by the edje theme is not immediately reported to
10245 * the elementary layout, so one needs to call this function in order to tell
10246 * the widget (layout) that it needs to reevaluate its own size.
10248 * The minimum size of the theme is calculated based on minimum size of
10249 * parts, the size of elements inside containers like box and table, etc. All
10250 * of this can change due to state changes, and that's when this function
10251 * should be called.
10253 * Also note that a standard signal of "size,eval" "elm" emitted from the
10254 * edje object will cause this to happen too.
10258 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10261 * Sets a specific cursor for an edje part.
10263 * @param obj The layout object.
10264 * @param part_name a part from loaded edje group.
10265 * @param cursor cursor name to use, see Elementary_Cursor.h
10267 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10268 * part not exists or it has "mouse_events: 0".
10272 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10275 * Get the cursor to be shown when mouse is over an edje part
10277 * @param obj The layout object.
10278 * @param part_name a part from loaded edje group.
10279 * @return the cursor name.
10283 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10286 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10288 * @param obj The layout object.
10289 * @param part_name a part from loaded edje group, that had a cursor set
10290 * with elm_layout_part_cursor_set().
10294 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10297 * Sets a specific cursor style for an edje part.
10299 * @param obj The layout object.
10300 * @param part_name a part from loaded edje group.
10301 * @param style the theme style to use (default, transparent, ...)
10303 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10304 * part not exists or it did not had a cursor set.
10308 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10311 * Gets a specific cursor style for an edje part.
10313 * @param obj The layout object.
10314 * @param part_name a part from loaded edje group.
10316 * @return the theme style in use, defaults to "default". If the
10317 * object does not have a cursor set, then NULL is returned.
10321 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10324 * Sets if the cursor set should be searched on the theme or should use
10325 * the provided by the engine, only.
10327 * @note before you set if should look on theme you should define a
10328 * cursor with elm_layout_part_cursor_set(). By default it will only
10329 * look for cursors provided by the engine.
10331 * @param obj The layout object.
10332 * @param part_name a part from loaded edje group.
10333 * @param engine_only if cursors should be just provided by the engine
10334 * or should also search on widget's theme as well
10336 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10337 * part not exists or it did not had a cursor set.
10341 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);
10344 * Gets a specific cursor engine_only for an edje part.
10346 * @param obj The layout object.
10347 * @param part_name a part from loaded edje group.
10349 * @return whenever the cursor is just provided by engine or also from theme.
10353 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10356 * @def elm_layout_icon_set
10357 * Convienience macro to set the icon object in a layout that follows the
10358 * Elementary naming convention for its parts.
10362 #define elm_layout_icon_set(_ly, _obj) \
10365 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10366 if ((_obj)) sig = "elm,state,icon,visible"; \
10367 else sig = "elm,state,icon,hidden"; \
10368 elm_object_signal_emit((_ly), sig, "elm"); \
10372 * @def elm_layout_icon_get
10373 * Convienience macro to get the icon object from a layout that follows the
10374 * Elementary naming convention for its parts.
10378 #define elm_layout_icon_get(_ly) \
10379 elm_object_part_content_get((_ly), "elm.swallow.icon")
10382 * @def elm_layout_end_set
10383 * Convienience macro to set the end object in a layout that follows the
10384 * Elementary naming convention for its parts.
10388 #define elm_layout_end_set(_ly, _obj) \
10391 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10392 if ((_obj)) sig = "elm,state,end,visible"; \
10393 else sig = "elm,state,end,hidden"; \
10394 elm_object_signal_emit((_ly), sig, "elm"); \
10398 * @def elm_layout_end_get
10399 * Convienience macro to get the end object in a layout that follows the
10400 * Elementary naming convention for its parts.
10404 #define elm_layout_end_get(_ly) \
10405 elm_object_part_content_get((_ly), "elm.swallow.end")
10408 * @def elm_layout_label_set
10409 * Convienience macro to set the label in a layout that follows the
10410 * Elementary naming convention for its parts.
10413 * @deprecated use elm_object_text_set() instead.
10415 #define elm_layout_label_set(_ly, _txt) \
10416 elm_layout_text_set((_ly), "elm.text", (_txt))
10419 * @def elm_layout_label_get
10420 * Convenience macro to get the label in a layout that follows the
10421 * Elementary naming convention for its parts.
10424 * @deprecated use elm_object_text_set() instead.
10426 #define elm_layout_label_get(_ly) \
10427 elm_layout_text_get((_ly), "elm.text")
10429 /* smart callbacks called:
10430 * "theme,changed" - when elm theme is changed.
10434 * @defgroup Notify Notify
10436 * @image html img/widget/notify/preview-00.png
10437 * @image latex img/widget/notify/preview-00.eps
10439 * Display a container in a particular region of the parent(top, bottom,
10440 * etc). A timeout can be set to automatically hide the notify. This is so
10441 * that, after an evas_object_show() on a notify object, if a timeout was set
10442 * on it, it will @b automatically get hidden after that time.
10444 * Signals that you can add callbacks for are:
10445 * @li "timeout" - when timeout happens on notify and it's hidden
10446 * @li "block,clicked" - when a click outside of the notify happens
10448 * Default contents parts of the notify widget that you can use for are:
10449 * @li "default" - A content of the notify
10451 * @ref tutorial_notify show usage of the API.
10456 * @brief Possible orient values for notify.
10458 * This values should be used in conjunction to elm_notify_orient_set() to
10459 * set the position in which the notify should appear(relative to its parent)
10460 * and in conjunction with elm_notify_orient_get() to know where the notify
10463 typedef enum _Elm_Notify_Orient
10465 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10466 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10467 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10468 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10469 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10470 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10471 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10472 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10473 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10474 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10475 } Elm_Notify_Orient;
10477 * @brief Add a new notify to the parent
10479 * @param parent The parent object
10480 * @return The new object or NULL if it cannot be created
10482 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10484 * @brief Set the content of the notify widget
10486 * @param obj The notify object
10487 * @param content The content will be filled in this notify object
10489 * Once the content object is set, a previously set one will be deleted. If
10490 * you want to keep that old content object, use the
10491 * elm_notify_content_unset() function.
10493 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10495 * @brief Unset the content of the notify widget
10497 * @param obj The notify object
10498 * @return The content that was being used
10500 * Unparent and return the content object which was set for this widget
10502 * @see elm_notify_content_set()
10504 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10506 * @brief Return the content of the notify widget
10508 * @param obj The notify object
10509 * @return The content that is being used
10511 * @see elm_notify_content_set()
10513 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10515 * @brief Set the notify parent
10517 * @param obj The notify object
10518 * @param content The new parent
10520 * Once the parent object is set, a previously set one will be disconnected
10523 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10525 * @brief Get the notify parent
10527 * @param obj The notify object
10528 * @return The parent
10530 * @see elm_notify_parent_set()
10532 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10534 * @brief Set the orientation
10536 * @param obj The notify object
10537 * @param orient The new orientation
10539 * Sets the position in which the notify will appear in its parent.
10541 * @see @ref Elm_Notify_Orient for possible values.
10543 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10545 * @brief Return the orientation
10546 * @param obj The notify object
10547 * @return The orientation of the notification
10549 * @see elm_notify_orient_set()
10550 * @see Elm_Notify_Orient
10552 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10554 * @brief Set the time interval after which the notify window is going to be
10557 * @param obj The notify object
10558 * @param time The timeout in seconds
10560 * This function sets a timeout and starts the timer controlling when the
10561 * notify is hidden. Since calling evas_object_show() on a notify restarts
10562 * the timer controlling when the notify is hidden, setting this before the
10563 * notify is shown will in effect mean starting the timer when the notify is
10566 * @note Set a value <= 0.0 to disable a running timer.
10568 * @note If the value > 0.0 and the notify is previously visible, the
10569 * timer will be started with this value, canceling any running timer.
10571 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10573 * @brief Return the timeout value (in seconds)
10574 * @param obj the notify object
10576 * @see elm_notify_timeout_set()
10578 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10580 * @brief Sets whether events should be passed to by a click outside
10583 * @param obj The notify object
10584 * @param repeats EINA_TRUE Events are repeats, else no
10586 * When true if the user clicks outside the window the events will be caught
10587 * by the others widgets, else the events are blocked.
10589 * @note The default value is EINA_TRUE.
10591 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10593 * @brief Return true if events are repeat below the notify object
10594 * @param obj the notify object
10596 * @see elm_notify_repeat_events_set()
10598 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10604 * @defgroup Hover Hover
10606 * @image html img/widget/hover/preview-00.png
10607 * @image latex img/widget/hover/preview-00.eps
10609 * A Hover object will hover over its @p parent object at the @p target
10610 * location. Anything in the background will be given a darker coloring to
10611 * indicate that the hover object is on top (at the default theme). When the
10612 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10613 * clicked that @b doesn't cause the hover to be dismissed.
10615 * A Hover object has two parents. One parent that owns it during creation
10616 * and the other parent being the one over which the hover object spans.
10619 * @note The hover object will take up the entire space of @p target
10622 * Elementary has the following styles for the hover widget:
10626 * @li hoversel_vertical
10628 * The following are the available position for content:
10640 * Signals that you can add callbacks for are:
10641 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10642 * @li "smart,changed" - a content object placed under the "smart"
10643 * policy was replaced to a new slot direction.
10645 * See @ref tutorial_hover for more information.
10649 typedef enum _Elm_Hover_Axis
10651 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10652 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10653 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10654 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10657 * @brief Adds a hover object to @p parent
10659 * @param parent The parent object
10660 * @return The hover object or NULL if one could not be created
10662 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10664 * @brief Sets the target object for the hover.
10666 * @param obj The hover object
10667 * @param target The object to center the hover onto. The hover
10669 * This function will cause the hover to be centered on the target object.
10671 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10673 * @brief Gets the target object for the hover.
10675 * @param obj The hover object
10676 * @param parent The object to locate the hover over.
10678 * @see elm_hover_target_set()
10680 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10682 * @brief Sets the parent object for the hover.
10684 * @param obj The hover object
10685 * @param parent The object to locate the hover over.
10687 * This function will cause the hover to take up the entire space that the
10688 * parent object fills.
10690 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10692 * @brief Gets the parent object for the hover.
10694 * @param obj The hover object
10695 * @return The parent object to locate the hover over.
10697 * @see elm_hover_parent_set()
10699 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10701 * @brief Sets the content of the hover object and the direction in which it
10704 * @param obj The hover object
10705 * @param swallow The direction that the object will be displayed
10706 * at. Accepted values are "left", "top-left", "top", "top-right",
10707 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10709 * @param content The content to place at @p swallow
10711 * Once the content object is set for a given direction, a previously
10712 * set one (on the same direction) will be deleted. If you want to
10713 * keep that old content object, use the elm_hover_content_unset()
10716 * All directions may have contents at the same time, except for
10717 * "smart". This is a special placement hint and its use case
10718 * independs of the calculations coming from
10719 * elm_hover_best_content_location_get(). Its use is for cases when
10720 * one desires only one hover content, but with a dinamic special
10721 * placement within the hover area. The content's geometry, whenever
10722 * it changes, will be used to decide on a best location not
10723 * extrapolating the hover's parent object view to show it in (still
10724 * being the hover's target determinant of its medium part -- move and
10725 * resize it to simulate finger sizes, for example). If one of the
10726 * directions other than "smart" are used, a previously content set
10727 * using it will be deleted, and vice-versa.
10729 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10731 * @brief Get the content of the hover object, in a given direction.
10733 * Return the content object which was set for this widget in the
10734 * @p swallow direction.
10736 * @param obj The hover object
10737 * @param swallow The direction that the object was display at.
10738 * @return The content that was being used
10740 * @see elm_hover_content_set()
10742 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10744 * @brief Unset the content of the hover object, in a given direction.
10746 * Unparent and return the content object set at @p swallow direction.
10748 * @param obj The hover object
10749 * @param swallow The direction that the object was display at.
10750 * @return The content that was being used.
10752 * @see elm_hover_content_set()
10754 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10756 * @brief Returns the best swallow location for content in the hover.
10758 * @param obj The hover object
10759 * @param pref_axis The preferred orientation axis for the hover object to use
10760 * @return The edje location to place content into the hover or @c
10763 * Best is defined here as the location at which there is the most available
10766 * @p pref_axis may be one of
10767 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10768 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10769 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10770 * - @c ELM_HOVER_AXIS_BOTH -- both
10772 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10773 * nescessarily be along the horizontal axis("left" or "right"). If
10774 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10775 * be along the vertical axis("top" or "bottom"). Chossing
10776 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10777 * returned position may be in either axis.
10779 * @see elm_hover_content_set()
10781 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10788 * @defgroup Entry Entry
10790 * @image html img/widget/entry/preview-00.png
10791 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10792 * @image html img/widget/entry/preview-01.png
10793 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10794 * @image html img/widget/entry/preview-02.png
10795 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10796 * @image html img/widget/entry/preview-03.png
10797 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10799 * An entry is a convenience widget which shows a box that the user can
10800 * enter text into. Entries by default don't scroll, so they grow to
10801 * accomodate the entire text, resizing the parent window as needed. This
10802 * can be changed with the elm_entry_scrollable_set() function.
10804 * They can also be single line or multi line (the default) and when set
10805 * to multi line mode they support text wrapping in any of the modes
10806 * indicated by #Elm_Wrap_Type.
10808 * Other features include password mode, filtering of inserted text with
10809 * elm_entry_text_filter_append() and related functions, inline "items" and
10810 * formatted markup text.
10812 * @section entry-markup Formatted text
10814 * The markup tags supported by the Entry are defined by the theme, but
10815 * even when writing new themes or extensions it's a good idea to stick to
10816 * a sane default, to maintain coherency and avoid application breakages.
10817 * Currently defined by the default theme are the following tags:
10818 * @li \<br\>: Inserts a line break.
10819 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10821 * @li \<tab\>: Inserts a tab.
10822 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10824 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10825 * @li \<link\>...\</link\>: Underlines the enclosed text.
10826 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10828 * @section entry-special Special markups
10830 * Besides those used to format text, entries support two special markup
10831 * tags used to insert clickable portions of text or items inlined within
10834 * @subsection entry-anchors Anchors
10836 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10837 * \</a\> tags and an event will be generated when this text is clicked,
10841 * This text is outside <a href=anc-01>but this one is an anchor</a>
10844 * The @c href attribute in the opening tag gives the name that will be
10845 * used to identify the anchor and it can be any valid utf8 string.
10847 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10848 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10849 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10850 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10853 * @subsection entry-items Items
10855 * Inlined in the text, any other @c Evas_Object can be inserted by using
10856 * \<item\> tags this way:
10859 * <item size=16x16 vsize=full href=emoticon/haha></item>
10862 * Just like with anchors, the @c href identifies each item, but these need,
10863 * in addition, to indicate their size, which is done using any one of
10864 * @c size, @c absize or @c relsize attributes. These attributes take their
10865 * value in the WxH format, where W is the width and H the height of the
10868 * @li absize: Absolute pixel size for the item. Whatever value is set will
10869 * be the item's size regardless of any scale value the object may have
10870 * been set to. The final line height will be adjusted to fit larger items.
10871 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10873 * @li relsize: Size is adjusted for the item to fit within the current
10876 * Besides their size, items are specificed a @c vsize value that affects
10877 * how their final size and position are calculated. The possible values
10879 * @li ascent: Item will be placed within the line's baseline and its
10880 * ascent. That is, the height between the line where all characters are
10881 * positioned and the highest point in the line. For @c size and @c absize
10882 * items, the descent value will be added to the total line height to make
10883 * them fit. @c relsize items will be adjusted to fit within this space.
10884 * @li full: Items will be placed between the descent and ascent, or the
10885 * lowest point in the line and its highest.
10887 * The next image shows different configurations of items and how they
10888 * are the previously mentioned options affect their sizes. In all cases,
10889 * the green line indicates the ascent, blue for the baseline and red for
10892 * @image html entry_item.png
10893 * @image latex entry_item.eps width=\textwidth
10895 * And another one to show how size differs from absize. In the first one,
10896 * the scale value is set to 1.0, while the second one is using one of 2.0.
10898 * @image html entry_item_scale.png
10899 * @image latex entry_item_scale.eps width=\textwidth
10901 * After the size for an item is calculated, the entry will request an
10902 * object to place in its space. For this, the functions set with
10903 * elm_entry_item_provider_append() and related functions will be called
10904 * in order until one of them returns a @c non-NULL value. If no providers
10905 * are available, or all of them return @c NULL, then the entry falls back
10906 * to one of the internal defaults, provided the name matches with one of
10909 * All of the following are currently supported:
10912 * - emoticon/angry-shout
10913 * - emoticon/crazy-laugh
10914 * - emoticon/evil-laugh
10916 * - emoticon/goggle-smile
10917 * - emoticon/grumpy
10918 * - emoticon/grumpy-smile
10919 * - emoticon/guilty
10920 * - emoticon/guilty-smile
10922 * - emoticon/half-smile
10923 * - emoticon/happy-panting
10925 * - emoticon/indifferent
10927 * - emoticon/knowing-grin
10929 * - emoticon/little-bit-sorry
10930 * - emoticon/love-lots
10932 * - emoticon/minimal-smile
10933 * - emoticon/not-happy
10934 * - emoticon/not-impressed
10936 * - emoticon/opensmile
10939 * - emoticon/squint-laugh
10940 * - emoticon/surprised
10941 * - emoticon/suspicious
10942 * - emoticon/tongue-dangling
10943 * - emoticon/tongue-poke
10945 * - emoticon/unhappy
10946 * - emoticon/very-sorry
10949 * - emoticon/worried
10952 * Alternatively, an item may reference an image by its path, using
10953 * the URI form @c file:///path/to/an/image.png and the entry will then
10954 * use that image for the item.
10956 * @section entry-files Loading and saving files
10958 * Entries have convinience functions to load text from a file and save
10959 * changes back to it after a short delay. The automatic saving is enabled
10960 * by default, but can be disabled with elm_entry_autosave_set() and files
10961 * can be loaded directly as plain text or have any markup in them
10962 * recognized. See elm_entry_file_set() for more details.
10964 * @section entry-signals Emitted signals
10966 * This widget emits the following signals:
10968 * @li "changed": The text within the entry was changed.
10969 * @li "changed,user": The text within the entry was changed because of user interaction.
10970 * @li "activated": The enter key was pressed on a single line entry.
10971 * @li "press": A mouse button has been pressed on the entry.
10972 * @li "longpressed": A mouse button has been pressed and held for a couple
10974 * @li "clicked": The entry has been clicked (mouse press and release).
10975 * @li "clicked,double": The entry has been double clicked.
10976 * @li "clicked,triple": The entry has been triple clicked.
10977 * @li "focused": The entry has received focus.
10978 * @li "unfocused": The entry has lost focus.
10979 * @li "selection,paste": A paste of the clipboard contents was requested.
10980 * @li "selection,copy": A copy of the selected text into the clipboard was
10982 * @li "selection,cut": A cut of the selected text into the clipboard was
10984 * @li "selection,start": A selection has begun and no previous selection
10986 * @li "selection,changed": The current selection has changed.
10987 * @li "selection,cleared": The current selection has been cleared.
10988 * @li "cursor,changed": The cursor has changed position.
10989 * @li "anchor,clicked": An anchor has been clicked. The event_info
10990 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10991 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10992 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10993 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10994 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10995 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10996 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10997 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10998 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10999 * @li "preedit,changed": The preedit string has changed.
11000 * @li "language,changed": Program language changed.
11002 * @section entry-examples
11004 * An overview of the Entry API can be seen in @ref entry_example_01
11009 * @typedef Elm_Entry_Anchor_Info
11011 * The info sent in the callback for the "anchor,clicked" signals emitted
11014 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11016 * @struct _Elm_Entry_Anchor_Info
11018 * The info sent in the callback for the "anchor,clicked" signals emitted
11021 struct _Elm_Entry_Anchor_Info
11023 const char *name; /**< The name of the anchor, as stated in its href */
11024 int button; /**< The mouse button used to click on it */
11025 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11026 y, /**< Anchor geometry, relative to canvas */
11027 w, /**< Anchor geometry, relative to canvas */
11028 h; /**< Anchor geometry, relative to canvas */
11031 * @typedef Elm_Entry_Filter_Cb
11032 * This callback type is used by entry filters to modify text.
11033 * @param data The data specified as the last param when adding the filter
11034 * @param entry The entry object
11035 * @param text A pointer to the location of the text being filtered. This data can be modified,
11036 * but any additional allocations must be managed by the user.
11037 * @see elm_entry_text_filter_append
11038 * @see elm_entry_text_filter_prepend
11040 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11043 * This adds an entry to @p parent object.
11045 * By default, entries are:
11049 * @li autosave is enabled
11051 * @param parent The parent object
11052 * @return The new object or NULL if it cannot be created
11054 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11056 * Sets the entry to single line mode.
11058 * In single line mode, entries don't ever wrap when the text reaches the
11059 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11060 * key will generate an @c "activate" event instead of adding a new line.
11062 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11063 * and pressing enter will break the text into a different line
11064 * without generating any events.
11066 * @param obj The entry object
11067 * @param single_line If true, the text in the entry
11068 * will be on a single line.
11070 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11072 * Gets whether the entry is set to be single line.
11074 * @param obj The entry object
11075 * @return single_line If true, the text in the entry is set to display
11076 * on a single line.
11078 * @see elm_entry_single_line_set()
11080 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11082 * Sets the entry to password mode.
11084 * In password mode, entries are implicitly single line and the display of
11085 * any text in them is replaced with asterisks (*).
11087 * @param obj The entry object
11088 * @param password If true, password mode is enabled.
11090 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11092 * Gets whether the entry is set to password mode.
11094 * @param obj The entry object
11095 * @return If true, the entry is set to display all characters
11096 * as asterisks (*).
11098 * @see elm_entry_password_set()
11100 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11102 * This sets the text displayed within the entry to @p entry.
11104 * @param obj The entry object
11105 * @param entry The text to be displayed
11107 * @deprecated Use elm_object_text_set() instead.
11108 * @note Using this function bypasses text filters
11110 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11112 * This returns the text currently shown in object @p entry.
11113 * See also elm_entry_entry_set().
11115 * @param obj The entry object
11116 * @return The currently displayed text or NULL on failure
11118 * @deprecated Use elm_object_text_get() instead.
11120 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11122 * Appends @p entry to the text of the entry.
11124 * Adds the text in @p entry to the end of any text already present in the
11127 * The appended text is subject to any filters set for the widget.
11129 * @param obj The entry object
11130 * @param entry The text to be displayed
11132 * @see elm_entry_text_filter_append()
11134 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11136 * Gets whether the entry is empty.
11138 * Empty means no text at all. If there are any markup tags, like an item
11139 * tag for which no provider finds anything, and no text is displayed, this
11140 * function still returns EINA_FALSE.
11142 * @param obj The entry object
11143 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11145 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11147 * Gets any selected text within the entry.
11149 * If there's any selected text in the entry, this function returns it as
11150 * a string in markup format. NULL is returned if no selection exists or
11151 * if an error occurred.
11153 * The returned value points to an internal string and should not be freed
11154 * or modified in any way. If the @p entry object is deleted or its
11155 * contents are changed, the returned pointer should be considered invalid.
11157 * @param obj The entry object
11158 * @return The selected text within the entry or NULL on failure
11160 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11162 * Inserts the given text into the entry at the current cursor position.
11164 * This inserts text at the cursor position as if it was typed
11165 * by the user (note that this also allows markup which a user
11166 * can't just "type" as it would be converted to escaped text, so this
11167 * call can be used to insert things like emoticon items or bold push/pop
11168 * tags, other font and color change tags etc.)
11170 * If any selection exists, it will be replaced by the inserted text.
11172 * The inserted text is subject to any filters set for the widget.
11174 * @param obj The entry object
11175 * @param entry The text to insert
11177 * @see elm_entry_text_filter_append()
11179 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11181 * Set the line wrap type to use on multi-line entries.
11183 * Sets the wrap type used by the entry to any of the specified in
11184 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11185 * line (without inserting a line break or paragraph separator) when it
11186 * reaches the far edge of the widget.
11188 * Note that this only makes sense for multi-line entries. A widget set
11189 * to be single line will never wrap.
11191 * @param obj The entry object
11192 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11194 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11195 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11197 * Gets the wrap mode the entry was set to use.
11199 * @param obj The entry object
11200 * @return Wrap type
11202 * @see also elm_entry_line_wrap_set()
11204 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11206 * Sets if the entry is to be editable or not.
11208 * By default, entries are editable and when focused, any text input by the
11209 * user will be inserted at the current cursor position. But calling this
11210 * function with @p editable as EINA_FALSE will prevent the user from
11211 * inputting text into the entry.
11213 * The only way to change the text of a non-editable entry is to use
11214 * elm_object_text_set(), elm_entry_entry_insert() and other related
11217 * @param obj The entry object
11218 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11219 * if not, the entry is read-only and no user input is allowed.
11221 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11223 * Gets whether the entry is editable or not.
11225 * @param obj The entry object
11226 * @return If true, the entry is editable by the user.
11227 * If false, it is not editable by the user
11229 * @see elm_entry_editable_set()
11231 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11233 * This drops any existing text selection within the entry.
11235 * @param obj The entry object
11237 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11239 * This selects all text within the entry.
11241 * @param obj The entry object
11243 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11245 * This moves the cursor one place to the right within the entry.
11247 * @param obj The entry object
11248 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11250 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11252 * This moves the cursor one place to the left within the entry.
11254 * @param obj The entry object
11255 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11257 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11259 * This moves the cursor one line up within the entry.
11261 * @param obj The entry object
11262 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11264 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11266 * This moves the cursor one line down within the entry.
11268 * @param obj The entry object
11269 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11271 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11273 * This moves the cursor to the beginning of the entry.
11275 * @param obj The entry object
11277 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11279 * This moves the cursor to the end of the entry.
11281 * @param obj The entry object
11283 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11285 * This moves the cursor to the beginning of the current line.
11287 * @param obj The entry object
11289 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11291 * This moves the cursor to the end of the current line.
11293 * @param obj The entry object
11295 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11297 * This begins a selection within the entry as though
11298 * the user were holding down the mouse button to make a selection.
11300 * @param obj The entry object
11302 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11304 * This ends a selection within the entry as though
11305 * the user had just released the mouse button while making a selection.
11307 * @param obj The entry object
11309 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11311 * Gets whether a format node exists at the current cursor position.
11313 * A format node is anything that defines how the text is rendered. It can
11314 * be a visible format node, such as a line break or a paragraph separator,
11315 * or an invisible one, such as bold begin or end tag.
11316 * This function returns whether any format node exists at the current
11319 * @param obj The entry object
11320 * @return EINA_TRUE if the current cursor position contains a format node,
11321 * EINA_FALSE otherwise.
11323 * @see elm_entry_cursor_is_visible_format_get()
11325 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11327 * Gets if the current cursor position holds a visible format node.
11329 * @param obj The entry object
11330 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11331 * if it's an invisible one or no format exists.
11333 * @see elm_entry_cursor_is_format_get()
11335 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11337 * Gets the character pointed by the cursor at its current position.
11339 * This function returns a string with the utf8 character stored at the
11340 * current cursor position.
11341 * Only the text is returned, any format that may exist will not be part
11342 * of the return value.
11344 * @param obj The entry object
11345 * @return The text pointed by the cursors.
11347 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11349 * This function returns the geometry of the cursor.
11351 * It's useful if you want to draw something on the cursor (or where it is),
11352 * or for example in the case of scrolled entry where you want to show the
11355 * @param obj The entry object
11356 * @param x returned geometry
11357 * @param y returned geometry
11358 * @param w returned geometry
11359 * @param h returned geometry
11360 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11362 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);
11364 * Sets the cursor position in the entry to the given value
11366 * The value in @p pos is the index of the character position within the
11367 * contents of the string as returned by elm_entry_cursor_pos_get().
11369 * @param obj The entry object
11370 * @param pos The position of the cursor
11372 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11374 * Retrieves the current position of the cursor in the entry
11376 * @param obj The entry object
11377 * @return The cursor position
11379 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11381 * This executes a "cut" action on the selected text in the entry.
11383 * @param obj The entry object
11385 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11387 * This executes a "copy" action on the selected text in the entry.
11389 * @param obj The entry object
11391 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11393 * This executes a "paste" action in the entry.
11395 * @param obj The entry object
11397 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11399 * This clears and frees the items in a entry's contextual (longpress)
11402 * @param obj The entry object
11404 * @see elm_entry_context_menu_item_add()
11406 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11408 * This adds an item to the entry's contextual menu.
11410 * A longpress on an entry will make the contextual menu show up, if this
11411 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11412 * By default, this menu provides a few options like enabling selection mode,
11413 * which is useful on embedded devices that need to be explicit about it,
11414 * and when a selection exists it also shows the copy and cut actions.
11416 * With this function, developers can add other options to this menu to
11417 * perform any action they deem necessary.
11419 * @param obj The entry object
11420 * @param label The item's text label
11421 * @param icon_file The item's icon file
11422 * @param icon_type The item's icon type
11423 * @param func The callback to execute when the item is clicked
11424 * @param data The data to associate with the item for related functions
11426 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);
11428 * This disables the entry's contextual (longpress) menu.
11430 * @param obj The entry object
11431 * @param disabled If true, the menu is disabled
11433 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11435 * This returns whether the entry's contextual (longpress) menu is
11438 * @param obj The entry object
11439 * @return If true, the menu is disabled
11441 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11443 * This appends a custom item provider to the list for that entry
11445 * This appends the given callback. The list is walked from beginning to end
11446 * with each function called given the item href string in the text. If the
11447 * function returns an object handle other than NULL (it should create an
11448 * object to do this), then this object is used to replace that item. If
11449 * not the next provider is called until one provides an item object, or the
11450 * default provider in entry does.
11452 * @param obj The entry object
11453 * @param func The function called to provide the item object
11454 * @param data The data passed to @p func
11456 * @see @ref entry-items
11458 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);
11460 * This prepends a custom item provider to the list for that entry
11462 * This prepends the given callback. See elm_entry_item_provider_append() for
11465 * @param obj The entry object
11466 * @param func The function called to provide the item object
11467 * @param data The data passed to @p func
11469 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);
11471 * This removes a custom item provider to the list for that entry
11473 * This removes the given callback. See elm_entry_item_provider_append() for
11476 * @param obj The entry object
11477 * @param func The function called to provide the item object
11478 * @param data The data passed to @p func
11480 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);
11482 * Append a filter function for text inserted in the entry
11484 * Append the given callback to the list. This functions will be called
11485 * whenever any text is inserted into the entry, with the text to be inserted
11486 * as a parameter. The callback function is free to alter the text in any way
11487 * it wants, but it must remember to free the given pointer and update it.
11488 * If the new text is to be discarded, the function can free it and set its
11489 * text parameter to NULL. This will also prevent any following filters from
11492 * @param obj The entry object
11493 * @param func The function to use as text filter
11494 * @param data User data to pass to @p func
11496 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11498 * Prepend a filter function for text insdrted in the entry
11500 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11501 * for more information
11503 * @param obj The entry object
11504 * @param func The function to use as text filter
11505 * @param data User data to pass to @p func
11507 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11509 * Remove a filter from the list
11511 * Removes the given callback from the filter list. See
11512 * elm_entry_text_filter_append() for more information.
11514 * @param obj The entry object
11515 * @param func The filter function to remove
11516 * @param data The user data passed when adding the function
11518 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11520 * This converts a markup (HTML-like) string into UTF-8.
11522 * The returned string is a malloc'ed buffer and it should be freed when
11523 * not needed anymore.
11525 * @param s The string (in markup) to be converted
11526 * @return The converted string (in UTF-8). It should be freed.
11528 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11530 * This converts a UTF-8 string into markup (HTML-like).
11532 * The returned string is a malloc'ed buffer and it should be freed when
11533 * not needed anymore.
11535 * @param s The string (in UTF-8) to be converted
11536 * @return The converted string (in markup). It should be freed.
11538 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11540 * This sets the file (and implicitly loads it) for the text to display and
11541 * then edit. All changes are written back to the file after a short delay if
11542 * the entry object is set to autosave (which is the default).
11544 * If the entry had any other file set previously, any changes made to it
11545 * will be saved if the autosave feature is enabled, otherwise, the file
11546 * will be silently discarded and any non-saved changes will be lost.
11548 * @param obj The entry object
11549 * @param file The path to the file to load and save
11550 * @param format The file format
11552 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11554 * Gets the file being edited by the entry.
11556 * This function can be used to retrieve any file set on the entry for
11557 * edition, along with the format used to load and save it.
11559 * @param obj The entry object
11560 * @param file The path to the file to load and save
11561 * @param format The file format
11563 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11565 * This function writes any changes made to the file set with
11566 * elm_entry_file_set()
11568 * @param obj The entry object
11570 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11572 * This sets the entry object to 'autosave' the loaded text file or not.
11574 * @param obj The entry object
11575 * @param autosave Autosave the loaded file or not
11577 * @see elm_entry_file_set()
11579 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11581 * This gets the entry object's 'autosave' status.
11583 * @param obj The entry object
11584 * @return Autosave the loaded file or not
11586 * @see elm_entry_file_set()
11588 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11590 * Control pasting of text and images for the widget.
11592 * Normally the entry allows both text and images to be pasted. By setting
11593 * textonly to be true, this prevents images from being pasted.
11595 * Note this only changes the behaviour of text.
11597 * @param obj The entry object
11598 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11599 * text+image+other.
11601 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11603 * Getting elm_entry text paste/drop mode.
11605 * In textonly mode, only text may be pasted or dropped into the widget.
11607 * @param obj The entry object
11608 * @return If the widget only accepts text from pastes.
11610 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11612 * Enable or disable scrolling in entry
11614 * Normally the entry is not scrollable unless you enable it with this call.
11616 * @param obj The entry object
11617 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11619 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11621 * Get the scrollable state of the entry
11623 * Normally the entry is not scrollable. This gets the scrollable state
11624 * of the entry. See elm_entry_scrollable_set() for more information.
11626 * @param obj The entry object
11627 * @return The scrollable state
11629 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11631 * This sets a widget to be displayed to the left of a scrolled entry.
11633 * @param obj The scrolled entry object
11634 * @param icon The widget to display on the left side of the scrolled
11637 * @note A previously set widget will be destroyed.
11638 * @note If the object being set does not have minimum size hints set,
11639 * it won't get properly displayed.
11641 * @see elm_entry_end_set()
11643 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11645 * Gets the leftmost widget of the scrolled entry. This object is
11646 * owned by the scrolled entry and should not be modified.
11648 * @param obj The scrolled entry object
11649 * @return the left widget inside the scroller
11651 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11653 * Unset the leftmost widget of the scrolled entry, unparenting and
11656 * @param obj The scrolled entry object
11657 * @return the previously set icon sub-object of this entry, on
11660 * @see elm_entry_icon_set()
11662 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11664 * Sets the visibility of the left-side widget of the scrolled entry,
11665 * set by elm_entry_icon_set().
11667 * @param obj The scrolled entry object
11668 * @param setting EINA_TRUE if the object should be displayed,
11669 * EINA_FALSE if not.
11671 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11673 * This sets a widget to be displayed to the end of a scrolled entry.
11675 * @param obj The scrolled entry object
11676 * @param end The widget to display on the right side of the scrolled
11679 * @note A previously set widget will be destroyed.
11680 * @note If the object being set does not have minimum size hints set,
11681 * it won't get properly displayed.
11683 * @see elm_entry_icon_set
11685 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11687 * Gets the endmost widget of the scrolled entry. This object is owned
11688 * by the scrolled entry and should not be modified.
11690 * @param obj The scrolled entry object
11691 * @return the right widget inside the scroller
11693 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11695 * Unset the endmost widget of the scrolled entry, unparenting and
11698 * @param obj The scrolled entry object
11699 * @return the previously set icon sub-object of this entry, on
11702 * @see elm_entry_icon_set()
11704 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11706 * Sets the visibility of the end widget of the scrolled entry, set by
11707 * elm_entry_end_set().
11709 * @param obj The scrolled entry object
11710 * @param setting EINA_TRUE if the object should be displayed,
11711 * EINA_FALSE if not.
11713 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11715 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11718 * Setting an entry to single-line mode with elm_entry_single_line_set()
11719 * will automatically disable the display of scrollbars when the entry
11720 * moves inside its scroller.
11722 * @param obj The scrolled entry object
11723 * @param h The horizontal scrollbar policy to apply
11724 * @param v The vertical scrollbar policy to apply
11726 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11728 * This enables/disables bouncing within the entry.
11730 * This function sets whether the entry will bounce when scrolling reaches
11731 * the end of the contained entry.
11733 * @param obj The scrolled entry object
11734 * @param h The horizontal bounce state
11735 * @param v The vertical bounce state
11737 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11739 * Get the bounce mode
11741 * @param obj The Entry object
11742 * @param h_bounce Allow bounce horizontally
11743 * @param v_bounce Allow bounce vertically
11745 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11747 /* pre-made filters for entries */
11749 * @typedef Elm_Entry_Filter_Limit_Size
11751 * Data for the elm_entry_filter_limit_size() entry filter.
11753 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11755 * @struct _Elm_Entry_Filter_Limit_Size
11757 * Data for the elm_entry_filter_limit_size() entry filter.
11759 struct _Elm_Entry_Filter_Limit_Size
11761 int max_char_count; /**< The maximum number of characters allowed. */
11762 int max_byte_count; /**< The maximum number of bytes allowed*/
11765 * Filter inserted text based on user defined character and byte limits
11767 * Add this filter to an entry to limit the characters that it will accept
11768 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11769 * The funtion works on the UTF-8 representation of the string, converting
11770 * it from the set markup, thus not accounting for any format in it.
11772 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11773 * it as data when setting the filter. In it, it's possible to set limits
11774 * by character count or bytes (any of them is disabled if 0), and both can
11775 * be set at the same time. In that case, it first checks for characters,
11778 * The function will cut the inserted text in order to allow only the first
11779 * number of characters that are still allowed. The cut is made in
11780 * characters, even when limiting by bytes, in order to always contain
11781 * valid ones and avoid half unicode characters making it in.
11783 * This filter, like any others, does not apply when setting the entry text
11784 * directly with elm_object_text_set() (or the deprecated
11785 * elm_entry_entry_set()).
11787 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11789 * @typedef Elm_Entry_Filter_Accept_Set
11791 * Data for the elm_entry_filter_accept_set() entry filter.
11793 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11795 * @struct _Elm_Entry_Filter_Accept_Set
11797 * Data for the elm_entry_filter_accept_set() entry filter.
11799 struct _Elm_Entry_Filter_Accept_Set
11801 const char *accepted; /**< Set of characters accepted in the entry. */
11802 const char *rejected; /**< Set of characters rejected from the entry. */
11805 * Filter inserted text based on accepted or rejected sets of characters
11807 * Add this filter to an entry to restrict the set of accepted characters
11808 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11809 * This structure contains both accepted and rejected sets, but they are
11810 * mutually exclusive.
11812 * The @c accepted set takes preference, so if it is set, the filter will
11813 * only work based on the accepted characters, ignoring anything in the
11814 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11816 * In both cases, the function filters by matching utf8 characters to the
11817 * raw markup text, so it can be used to remove formatting tags.
11819 * This filter, like any others, does not apply when setting the entry text
11820 * directly with elm_object_text_set() (or the deprecated
11821 * elm_entry_entry_set()).
11823 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11825 * Set the input panel layout of the entry
11827 * @param obj The entry object
11828 * @param layout layout type
11830 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11832 * Get the input panel layout of the entry
11834 * @param obj The entry object
11835 * @return layout type
11837 * @see elm_entry_input_panel_layout_set
11839 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11841 * Set the autocapitalization type on the immodule.
11843 * @param obj The entry object
11844 * @param autocapital_type The type of autocapitalization
11846 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11848 * Retrieve the autocapitalization type on the immodule.
11850 * @param obj The entry object
11851 * @return autocapitalization type
11853 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11855 * Sets the attribute to show the input panel automatically.
11857 * @param obj The entry object
11858 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11860 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11862 * Retrieve the attribute to show the input panel automatically.
11864 * @param obj The entry object
11865 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11867 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11869 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11870 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11871 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11872 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11873 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11874 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11875 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11877 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11878 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11879 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11880 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11881 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11887 /* composite widgets - these basically put together basic widgets above
11888 * in convenient packages that do more than basic stuff */
11892 * @defgroup Anchorview Anchorview
11894 * @image html img/widget/anchorview/preview-00.png
11895 * @image latex img/widget/anchorview/preview-00.eps
11897 * Anchorview is for displaying text that contains markup with anchors
11898 * like <c>\<a href=1234\>something\</\></c> in it.
11900 * Besides being styled differently, the anchorview widget provides the
11901 * necessary functionality so that clicking on these anchors brings up a
11902 * popup with user defined content such as "call", "add to contacts" or
11903 * "open web page". This popup is provided using the @ref Hover widget.
11905 * This widget is very similar to @ref Anchorblock, so refer to that
11906 * widget for an example. The only difference Anchorview has is that the
11907 * widget is already provided with scrolling functionality, so if the
11908 * text set to it is too large to fit in the given space, it will scroll,
11909 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11910 * text can be displayed.
11912 * This widget emits the following signals:
11913 * @li "anchor,clicked": will be called when an anchor is clicked. The
11914 * @p event_info parameter on the callback will be a pointer of type
11915 * ::Elm_Entry_Anchorview_Info.
11917 * See @ref Anchorblock for an example on how to use both of them.
11926 * @typedef Elm_Entry_Anchorview_Info
11928 * The info sent in the callback for "anchor,clicked" signals emitted by
11929 * the Anchorview widget.
11931 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11933 * @struct _Elm_Entry_Anchorview_Info
11935 * The info sent in the callback for "anchor,clicked" signals emitted by
11936 * the Anchorview widget.
11938 struct _Elm_Entry_Anchorview_Info
11940 const char *name; /**< Name of the anchor, as indicated in its href
11942 int button; /**< The mouse button used to click on it */
11943 Evas_Object *hover; /**< The hover object to use for the popup */
11945 Evas_Coord x, y, w, h;
11946 } anchor, /**< Geometry selection of text used as anchor */
11947 hover_parent; /**< Geometry of the object used as parent by the
11949 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11950 for content on the left side of
11951 the hover. Before calling the
11952 callback, the widget will make the
11953 necessary calculations to check
11954 which sides are fit to be set with
11955 content, based on the position the
11956 hover is activated and its distance
11957 to the edges of its parent object
11959 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11960 the right side of the hover.
11961 See @ref hover_left */
11962 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11963 of the hover. See @ref hover_left */
11964 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11965 below the hover. See @ref
11969 * Add a new Anchorview object
11971 * @param parent The parent object
11972 * @return The new object or NULL if it cannot be created
11974 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11976 * Set the text to show in the anchorview
11978 * Sets the text of the anchorview to @p text. This text can include markup
11979 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11980 * text that will be specially styled and react to click events, ended with
11981 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11982 * "anchor,clicked" signal that you can attach a callback to with
11983 * evas_object_smart_callback_add(). The name of the anchor given in the
11984 * event info struct will be the one set in the href attribute, in this
11985 * case, anchorname.
11987 * Other markup can be used to style the text in different ways, but it's
11988 * up to the style defined in the theme which tags do what.
11989 * @deprecated use elm_object_text_set() instead.
11991 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11993 * Get the markup text set for the anchorview
11995 * Retrieves the text set on the anchorview, with markup tags included.
11997 * @param obj The anchorview object
11998 * @return The markup text set or @c NULL if nothing was set or an error
12000 * @deprecated use elm_object_text_set() instead.
12002 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12004 * Set the parent of the hover popup
12006 * Sets the parent object to use by the hover created by the anchorview
12007 * when an anchor is clicked. See @ref Hover for more details on this.
12008 * If no parent is set, the same anchorview object will be used.
12010 * @param obj The anchorview object
12011 * @param parent The object to use as parent for the hover
12013 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12015 * Get the parent of the hover popup
12017 * Get the object used as parent for the hover created by the anchorview
12018 * widget. See @ref Hover for more details on this.
12020 * @param obj The anchorview object
12021 * @return The object used as parent for the hover, NULL if none is set.
12023 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12025 * Set the style that the hover should use
12027 * When creating the popup hover, anchorview will request that it's
12028 * themed according to @p style.
12030 * @param obj The anchorview object
12031 * @param style The style to use for the underlying hover
12033 * @see elm_object_style_set()
12035 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12037 * Get the style that the hover should use
12039 * Get the style the hover created by anchorview will use.
12041 * @param obj The anchorview object
12042 * @return The style to use by the hover. NULL means the default is used.
12044 * @see elm_object_style_set()
12046 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12048 * Ends the hover popup in the anchorview
12050 * When an anchor is clicked, the anchorview widget will create a hover
12051 * object to use as a popup with user provided content. This function
12052 * terminates this popup, returning the anchorview to its normal state.
12054 * @param obj The anchorview object
12056 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12058 * Set bouncing behaviour when the scrolled content reaches an edge
12060 * Tell the internal scroller object whether it should bounce or not
12061 * when it reaches the respective edges for each axis.
12063 * @param obj The anchorview object
12064 * @param h_bounce Whether to bounce or not in the horizontal axis
12065 * @param v_bounce Whether to bounce or not in the vertical axis
12067 * @see elm_scroller_bounce_set()
12069 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12071 * Get the set bouncing behaviour of the internal scroller
12073 * Get whether the internal scroller should bounce when the edge of each
12074 * axis is reached scrolling.
12076 * @param obj The anchorview object
12077 * @param h_bounce Pointer where to store the bounce state of the horizontal
12079 * @param v_bounce Pointer where to store the bounce state of the vertical
12082 * @see elm_scroller_bounce_get()
12084 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12086 * Appends a custom item provider to the given anchorview
12088 * Appends the given function to the list of items providers. This list is
12089 * called, one function at a time, with the given @p data pointer, the
12090 * anchorview object and, in the @p item parameter, the item name as
12091 * referenced in its href string. Following functions in the list will be
12092 * called in order until one of them returns something different to NULL,
12093 * which should be an Evas_Object which will be used in place of the item
12096 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12097 * href=item/name\>\</item\>
12099 * @param obj The anchorview object
12100 * @param func The function to add to the list of providers
12101 * @param data User data that will be passed to the callback function
12103 * @see elm_entry_item_provider_append()
12105 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);
12107 * Prepend a custom item provider to the given anchorview
12109 * Like elm_anchorview_item_provider_append(), but it adds the function
12110 * @p func to the beginning of the list, instead of the end.
12112 * @param obj The anchorview object
12113 * @param func The function to add to the list of providers
12114 * @param data User data that will be passed to the callback function
12116 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);
12118 * Remove a custom item provider from the list of the given anchorview
12120 * Removes the function and data pairing that matches @p func and @p data.
12121 * That is, unless the same function and same user data are given, the
12122 * function will not be removed from the list. This allows us to add the
12123 * same callback several times, with different @p data pointers and be
12124 * able to remove them later without conflicts.
12126 * @param obj The anchorview object
12127 * @param func The function to remove from the list
12128 * @param data The data matching the function to remove from the list
12130 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);
12137 * @defgroup Anchorblock Anchorblock
12139 * @image html img/widget/anchorblock/preview-00.png
12140 * @image latex img/widget/anchorblock/preview-00.eps
12142 * Anchorblock is for displaying text that contains markup with anchors
12143 * like <c>\<a href=1234\>something\</\></c> in it.
12145 * Besides being styled differently, the anchorblock widget provides the
12146 * necessary functionality so that clicking on these anchors brings up a
12147 * popup with user defined content such as "call", "add to contacts" or
12148 * "open web page". This popup is provided using the @ref Hover widget.
12150 * This widget emits the following signals:
12151 * @li "anchor,clicked": will be called when an anchor is clicked. The
12152 * @p event_info parameter on the callback will be a pointer of type
12153 * ::Elm_Entry_Anchorblock_Info.
12159 * Since examples are usually better than plain words, we might as well
12160 * try @ref tutorial_anchorblock_example "one".
12163 * @addtogroup Anchorblock
12167 * @typedef Elm_Entry_Anchorblock_Info
12169 * The info sent in the callback for "anchor,clicked" signals emitted by
12170 * the Anchorblock widget.
12172 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12174 * @struct _Elm_Entry_Anchorblock_Info
12176 * The info sent in the callback for "anchor,clicked" signals emitted by
12177 * the Anchorblock widget.
12179 struct _Elm_Entry_Anchorblock_Info
12181 const char *name; /**< Name of the anchor, as indicated in its href
12183 int button; /**< The mouse button used to click on it */
12184 Evas_Object *hover; /**< The hover object to use for the popup */
12186 Evas_Coord x, y, w, h;
12187 } anchor, /**< Geometry selection of text used as anchor */
12188 hover_parent; /**< Geometry of the object used as parent by the
12190 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12191 for content on the left side of
12192 the hover. Before calling the
12193 callback, the widget will make the
12194 necessary calculations to check
12195 which sides are fit to be set with
12196 content, based on the position the
12197 hover is activated and its distance
12198 to the edges of its parent object
12200 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12201 the right side of the hover.
12202 See @ref hover_left */
12203 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12204 of the hover. See @ref hover_left */
12205 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12206 below the hover. See @ref
12210 * Add a new Anchorblock object
12212 * @param parent The parent object
12213 * @return The new object or NULL if it cannot be created
12215 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12217 * Set the text to show in the anchorblock
12219 * Sets the text of the anchorblock to @p text. This text can include markup
12220 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12221 * of text that will be specially styled and react to click events, ended
12222 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12223 * "anchor,clicked" signal that you can attach a callback to with
12224 * evas_object_smart_callback_add(). The name of the anchor given in the
12225 * event info struct will be the one set in the href attribute, in this
12226 * case, anchorname.
12228 * Other markup can be used to style the text in different ways, but it's
12229 * up to the style defined in the theme which tags do what.
12230 * @deprecated use elm_object_text_set() instead.
12232 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12234 * Get the markup text set for the anchorblock
12236 * Retrieves the text set on the anchorblock, with markup tags included.
12238 * @param obj The anchorblock object
12239 * @return The markup text set or @c NULL if nothing was set or an error
12241 * @deprecated use elm_object_text_set() instead.
12243 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12245 * Set the parent of the hover popup
12247 * Sets the parent object to use by the hover created by the anchorblock
12248 * when an anchor is clicked. See @ref Hover for more details on this.
12250 * @param obj The anchorblock object
12251 * @param parent The object to use as parent for the hover
12253 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12255 * Get the parent of the hover popup
12257 * Get the object used as parent for the hover created by the anchorblock
12258 * widget. See @ref Hover for more details on this.
12259 * If no parent is set, the same anchorblock object will be used.
12261 * @param obj The anchorblock object
12262 * @return The object used as parent for the hover, NULL if none is set.
12264 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12266 * Set the style that the hover should use
12268 * When creating the popup hover, anchorblock will request that it's
12269 * themed according to @p style.
12271 * @param obj The anchorblock object
12272 * @param style The style to use for the underlying hover
12274 * @see elm_object_style_set()
12276 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12278 * Get the style that the hover should use
12280 * Get the style, the hover created by anchorblock will use.
12282 * @param obj The anchorblock object
12283 * @return The style to use by the hover. NULL means the default is used.
12285 * @see elm_object_style_set()
12287 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12289 * Ends the hover popup in the anchorblock
12291 * When an anchor is clicked, the anchorblock widget will create a hover
12292 * object to use as a popup with user provided content. This function
12293 * terminates this popup, returning the anchorblock to its normal state.
12295 * @param obj The anchorblock object
12297 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12299 * Appends a custom item provider to the given anchorblock
12301 * Appends the given function to the list of items providers. This list is
12302 * called, one function at a time, with the given @p data pointer, the
12303 * anchorblock object and, in the @p item parameter, the item name as
12304 * referenced in its href string. Following functions in the list will be
12305 * called in order until one of them returns something different to NULL,
12306 * which should be an Evas_Object which will be used in place of the item
12309 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12310 * href=item/name\>\</item\>
12312 * @param obj The anchorblock object
12313 * @param func The function to add to the list of providers
12314 * @param data User data that will be passed to the callback function
12316 * @see elm_entry_item_provider_append()
12318 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);
12320 * Prepend a custom item provider to the given anchorblock
12322 * Like elm_anchorblock_item_provider_append(), but it adds the function
12323 * @p func to the beginning of the list, instead of the end.
12325 * @param obj The anchorblock object
12326 * @param func The function to add to the list of providers
12327 * @param data User data that will be passed to the callback function
12329 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);
12331 * Remove a custom item provider from the list of the given anchorblock
12333 * Removes the function and data pairing that matches @p func and @p data.
12334 * That is, unless the same function and same user data are given, the
12335 * function will not be removed from the list. This allows us to add the
12336 * same callback several times, with different @p data pointers and be
12337 * able to remove them later without conflicts.
12339 * @param obj The anchorblock object
12340 * @param func The function to remove from the list
12341 * @param data The data matching the function to remove from the list
12343 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);
12349 * @defgroup Bubble Bubble
12351 * @image html img/widget/bubble/preview-00.png
12352 * @image latex img/widget/bubble/preview-00.eps
12353 * @image html img/widget/bubble/preview-01.png
12354 * @image latex img/widget/bubble/preview-01.eps
12355 * @image html img/widget/bubble/preview-02.png
12356 * @image latex img/widget/bubble/preview-02.eps
12358 * @brief The Bubble is a widget to show text similar to how speech is
12359 * represented in comics.
12361 * The bubble widget contains 5 important visual elements:
12362 * @li The frame is a rectangle with rounded edjes and an "arrow".
12363 * @li The @p icon is an image to which the frame's arrow points to.
12364 * @li The @p label is a text which appears to the right of the icon if the
12365 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12367 * @li The @p info is a text which appears to the right of the label. Info's
12368 * font is of a ligther color than label.
12369 * @li The @p content is an evas object that is shown inside the frame.
12371 * The position of the arrow, icon, label and info depends on which corner is
12372 * selected. The four available corners are:
12373 * @li "top_left" - Default
12375 * @li "bottom_left"
12376 * @li "bottom_right"
12378 * Signals that you can add callbacks for are:
12379 * @li "clicked" - This is called when a user has clicked the bubble.
12381 * Default contents parts of the bubble that you can use for are:
12382 * @li "default" - A content of the bubble
12383 * @li "icon" - An icon of the bubble
12385 * Default text parts of the button widget that you can use for are:
12386 * @li NULL - Label of the bubble
12388 * For an example of using a buble see @ref bubble_01_example_page "this".
12394 * Add a new bubble to the parent
12396 * @param parent The parent object
12397 * @return The new object or NULL if it cannot be created
12399 * This function adds a text bubble to the given parent evas object.
12401 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12403 * Set the label of the bubble
12405 * @param obj The bubble object
12406 * @param label The string to set in the label
12408 * This function sets the title of the bubble. Where this appears depends on
12409 * the selected corner.
12410 * @deprecated use elm_object_text_set() instead.
12412 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12414 * Get the label of the bubble
12416 * @param obj The bubble object
12417 * @return The string of set in the label
12419 * This function gets the title of the bubble.
12420 * @deprecated use elm_object_text_get() instead.
12422 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12424 * Set the info of the bubble
12426 * @param obj The bubble object
12427 * @param info The given info about the bubble
12429 * This function sets the info of the bubble. Where this appears depends on
12430 * the selected corner.
12431 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12433 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12435 * Get the info of the bubble
12437 * @param obj The bubble object
12439 * @return The "info" string of the bubble
12441 * This function gets the info text.
12442 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12444 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12446 * Set the content to be shown in the bubble
12448 * Once the content object is set, a previously set one will be deleted.
12449 * If you want to keep the old content object, use the
12450 * elm_bubble_content_unset() function.
12452 * @param obj The bubble object
12453 * @param content The given content of the bubble
12455 * This function sets the content shown on the middle of the bubble.
12457 * @deprecated use elm_object_content_set() instead
12460 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12462 * Get the content shown in the bubble
12464 * Return the content object which is set for this widget.
12466 * @param obj The bubble object
12467 * @return The content that is being used
12469 * @deprecated use elm_object_content_get() instead
12472 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12474 * Unset the content shown in the bubble
12476 * Unparent and return the content object which was set for this widget.
12478 * @param obj The bubble object
12479 * @return The content that was being used
12481 * @deprecated use elm_object_content_unset() instead
12484 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12486 * Set the icon of the bubble
12488 * Once the icon object is set, a previously set one will be deleted.
12489 * If you want to keep the old content object, use the
12490 * elm_icon_content_unset() function.
12492 * @param obj The bubble object
12493 * @param icon The given icon for the bubble
12495 * @deprecated use elm_object_part_content_set() instead
12498 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12500 * Get the icon of the bubble
12502 * @param obj The bubble object
12503 * @return The icon for the bubble
12505 * This function gets the icon shown on the top left of bubble.
12507 * @deprecated use elm_object_part_content_get() instead
12510 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12512 * Unset the icon of the bubble
12514 * Unparent and return the icon object which was set for this widget.
12516 * @param obj The bubble object
12517 * @return The icon that was being used
12519 * @deprecated use elm_object_part_content_unset() instead
12522 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12524 * Set the corner of the bubble
12526 * @param obj The bubble object.
12527 * @param corner The given corner for the bubble.
12529 * This function sets the corner of the bubble. The corner will be used to
12530 * determine where the arrow in the frame points to and where label, icon and
12533 * Possible values for corner are:
12534 * @li "top_left" - Default
12536 * @li "bottom_left"
12537 * @li "bottom_right"
12539 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12541 * Get the corner of the bubble
12543 * @param obj The bubble object.
12544 * @return The given corner for the bubble.
12546 * This function gets the selected corner of the bubble.
12548 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12550 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12551 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12558 * @defgroup Photo Photo
12560 * For displaying the photo of a person (contact). Simple, yet
12561 * with a very specific purpose.
12563 * Signals that you can add callbacks for are:
12565 * "clicked" - This is called when a user has clicked the photo
12566 * "drag,start" - Someone started dragging the image out of the object
12567 * "drag,end" - Dragged item was dropped (somewhere)
12573 * Add a new photo to the parent
12575 * @param parent The parent object
12576 * @return The new object or NULL if it cannot be created
12580 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12583 * Set the file that will be used as photo
12585 * @param obj The photo object
12586 * @param file The path to file that will be used as photo
12588 * @return (1 = success, 0 = error)
12592 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12595 * Set the file that will be used as thumbnail in the photo.
12597 * @param obj The photo object.
12598 * @param file The path to file that will be used as thumb.
12599 * @param group The key used in case of an EET file.
12603 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12606 * Set the size that will be used on the photo
12608 * @param obj The photo object
12609 * @param size The size that the photo will be
12613 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12616 * Set if the photo should be completely visible or not.
12618 * @param obj The photo object
12619 * @param fill if true the photo will be completely visible
12623 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12626 * Set editability of the photo.
12628 * An editable photo can be dragged to or from, and can be cut or
12629 * pasted too. Note that pasting an image or dropping an item on
12630 * the image will delete the existing content.
12632 * @param obj The photo object.
12633 * @param set To set of clear editablity.
12635 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12641 /* gesture layer */
12643 * @defgroup Elm_Gesture_Layer Gesture Layer
12644 * Gesture Layer Usage:
12646 * Use Gesture Layer to detect gestures.
12647 * The advantage is that you don't have to implement
12648 * gesture detection, just set callbacks of gesture state.
12649 * By using gesture layer we make standard interface.
12651 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12652 * with a parent object parameter.
12653 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12654 * call. Usually with same object as target (2nd parameter).
12656 * Now you need to tell gesture layer what gestures you follow.
12657 * This is done with @ref elm_gesture_layer_cb_set call.
12658 * By setting the callback you actually saying to gesture layer:
12659 * I would like to know when the gesture @ref Elm_Gesture_Types
12660 * switches to state @ref Elm_Gesture_State.
12662 * Next, you need to implement the actual action that follows the input
12663 * in your callback.
12665 * Note that if you like to stop being reported about a gesture, just set
12666 * all callbacks referring this gesture to NULL.
12667 * (again with @ref elm_gesture_layer_cb_set)
12669 * The information reported by gesture layer to your callback is depending
12670 * on @ref Elm_Gesture_Types:
12671 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12672 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12673 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12675 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12676 * @ref ELM_GESTURE_MOMENTUM.
12678 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12679 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12680 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12681 * Note that we consider a flick as a line-gesture that should be completed
12682 * in flick-time-limit as defined in @ref Config.
12684 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12686 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12689 * Gesture Layer Tweaks:
12691 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12692 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12694 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12695 * so gesture starts when user touches (a *DOWN event) touch-surface
12696 * and ends when no fingers touches surface (a *UP event).
12700 * @enum _Elm_Gesture_Types
12701 * Enum of supported gesture types.
12702 * @ingroup Elm_Gesture_Layer
12704 enum _Elm_Gesture_Types
12706 ELM_GESTURE_FIRST = 0,
12708 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12709 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12710 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12711 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12713 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12715 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12716 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12718 ELM_GESTURE_ZOOM, /**< Zoom */
12719 ELM_GESTURE_ROTATE, /**< Rotate */
12725 * @typedef Elm_Gesture_Types
12726 * gesture types enum
12727 * @ingroup Elm_Gesture_Layer
12729 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12732 * @enum _Elm_Gesture_State
12733 * Enum of gesture states.
12734 * @ingroup Elm_Gesture_Layer
12736 enum _Elm_Gesture_State
12738 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12739 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12740 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12741 ELM_GESTURE_STATE_END, /**< Gesture completed */
12742 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12746 * @typedef Elm_Gesture_State
12747 * gesture states enum
12748 * @ingroup Elm_Gesture_Layer
12750 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12753 * @struct _Elm_Gesture_Taps_Info
12754 * Struct holds taps info for user
12755 * @ingroup Elm_Gesture_Layer
12757 struct _Elm_Gesture_Taps_Info
12759 Evas_Coord x, y; /**< Holds center point between fingers */
12760 unsigned int n; /**< Number of fingers tapped */
12761 unsigned int timestamp; /**< event timestamp */
12765 * @typedef Elm_Gesture_Taps_Info
12766 * holds taps info for user
12767 * @ingroup Elm_Gesture_Layer
12769 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12772 * @struct _Elm_Gesture_Momentum_Info
12773 * Struct holds momentum info for user
12774 * x1 and y1 are not necessarily in sync
12775 * x1 holds x value of x direction starting point
12776 * and same holds for y1.
12777 * This is noticeable when doing V-shape movement
12778 * @ingroup Elm_Gesture_Layer
12780 struct _Elm_Gesture_Momentum_Info
12781 { /* Report line ends, timestamps, and momentum computed */
12782 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12783 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12784 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12785 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12787 unsigned int tx; /**< Timestamp of start of final x-swipe */
12788 unsigned int ty; /**< Timestamp of start of final y-swipe */
12790 Evas_Coord mx; /**< Momentum on X */
12791 Evas_Coord my; /**< Momentum on Y */
12793 unsigned int n; /**< Number of fingers */
12797 * @typedef Elm_Gesture_Momentum_Info
12798 * holds momentum info for user
12799 * @ingroup Elm_Gesture_Layer
12801 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12804 * @struct _Elm_Gesture_Line_Info
12805 * Struct holds line info for user
12806 * @ingroup Elm_Gesture_Layer
12808 struct _Elm_Gesture_Line_Info
12809 { /* Report line ends, timestamps, and momentum computed */
12810 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12811 double angle; /**< Angle (direction) of lines */
12815 * @typedef Elm_Gesture_Line_Info
12816 * Holds line info for user
12817 * @ingroup Elm_Gesture_Layer
12819 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12822 * @struct _Elm_Gesture_Zoom_Info
12823 * Struct holds zoom info for user
12824 * @ingroup Elm_Gesture_Layer
12826 struct _Elm_Gesture_Zoom_Info
12828 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12829 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12830 double zoom; /**< Zoom value: 1.0 means no zoom */
12831 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12835 * @typedef Elm_Gesture_Zoom_Info
12836 * Holds zoom info for user
12837 * @ingroup Elm_Gesture_Layer
12839 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12842 * @struct _Elm_Gesture_Rotate_Info
12843 * Struct holds rotation info for user
12844 * @ingroup Elm_Gesture_Layer
12846 struct _Elm_Gesture_Rotate_Info
12848 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12849 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12850 double base_angle; /**< Holds start-angle */
12851 double angle; /**< Rotation value: 0.0 means no rotation */
12852 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12856 * @typedef Elm_Gesture_Rotate_Info
12857 * Holds rotation info for user
12858 * @ingroup Elm_Gesture_Layer
12860 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12863 * @typedef Elm_Gesture_Event_Cb
12864 * User callback used to stream gesture info from gesture layer
12865 * @param data user data
12866 * @param event_info gesture report info
12867 * Returns a flag field to be applied on the causing event.
12868 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12869 * upon the event, in an irreversible way.
12871 * @ingroup Elm_Gesture_Layer
12873 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12876 * Use function to set callbacks to be notified about
12877 * change of state of gesture.
12878 * When a user registers a callback with this function
12879 * this means this gesture has to be tested.
12881 * When ALL callbacks for a gesture are set to NULL
12882 * it means user isn't interested in gesture-state
12883 * and it will not be tested.
12885 * @param obj Pointer to gesture-layer.
12886 * @param idx The gesture you would like to track its state.
12887 * @param cb callback function pointer.
12888 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12889 * @param data user info to be sent to callback (usually, Smart Data)
12891 * @ingroup Elm_Gesture_Layer
12893 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);
12896 * Call this function to get repeat-events settings.
12898 * @param obj Pointer to gesture-layer.
12900 * @return repeat events settings.
12901 * @see elm_gesture_layer_hold_events_set()
12902 * @ingroup Elm_Gesture_Layer
12904 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12907 * This function called in order to make gesture-layer repeat events.
12908 * Set this of you like to get the raw events only if gestures were not detected.
12909 * Clear this if you like gesture layer to fwd events as testing gestures.
12911 * @param obj Pointer to gesture-layer.
12912 * @param r Repeat: TRUE/FALSE
12914 * @ingroup Elm_Gesture_Layer
12916 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12919 * This function sets step-value for zoom action.
12920 * Set step to any positive value.
12921 * Cancel step setting by setting to 0.0
12923 * @param obj Pointer to gesture-layer.
12924 * @param s new zoom step value.
12926 * @ingroup Elm_Gesture_Layer
12928 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12931 * This function sets step-value for rotate action.
12932 * Set step to any positive value.
12933 * Cancel step setting by setting to 0.0
12935 * @param obj Pointer to gesture-layer.
12936 * @param s new roatate step value.
12938 * @ingroup Elm_Gesture_Layer
12940 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12943 * This function called to attach gesture-layer to an Evas_Object.
12944 * @param obj Pointer to gesture-layer.
12945 * @param t Pointer to underlying object (AKA Target)
12947 * @return TRUE, FALSE on success, failure.
12949 * @ingroup Elm_Gesture_Layer
12951 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12954 * Call this function to construct a new gesture-layer object.
12955 * This does not activate the gesture layer. You have to
12956 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12958 * @param parent the parent object.
12960 * @return Pointer to new gesture-layer object.
12962 * @ingroup Elm_Gesture_Layer
12964 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12967 * @defgroup Thumb Thumb
12969 * @image html img/widget/thumb/preview-00.png
12970 * @image latex img/widget/thumb/preview-00.eps
12972 * A thumb object is used for displaying the thumbnail of an image or video.
12973 * You must have compiled Elementary with Ethumb_Client support and the DBus
12974 * service must be present and auto-activated in order to have thumbnails to
12977 * Once the thumbnail object becomes visible, it will check if there is a
12978 * previously generated thumbnail image for the file set on it. If not, it
12979 * will start generating this thumbnail.
12981 * Different config settings will cause different thumbnails to be generated
12982 * even on the same file.
12984 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12985 * Ethumb documentation to change this path, and to see other configuration
12988 * Signals that you can add callbacks for are:
12990 * - "clicked" - This is called when a user has clicked the thumb without dragging
12992 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12993 * - "press" - This is called when a user has pressed down the thumb.
12994 * - "generate,start" - The thumbnail generation started.
12995 * - "generate,stop" - The generation process stopped.
12996 * - "generate,error" - The generation failed.
12997 * - "load,error" - The thumbnail image loading failed.
12999 * available styles:
13003 * An example of use of thumbnail:
13005 * - @ref thumb_example_01
13009 * @addtogroup Thumb
13014 * @enum _Elm_Thumb_Animation_Setting
13015 * @typedef Elm_Thumb_Animation_Setting
13017 * Used to set if a video thumbnail is animating or not.
13021 typedef enum _Elm_Thumb_Animation_Setting
13023 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13024 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13025 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13026 ELM_THUMB_ANIMATION_LAST
13027 } Elm_Thumb_Animation_Setting;
13030 * Add a new thumb object to the parent.
13032 * @param parent The parent object.
13033 * @return The new object or NULL if it cannot be created.
13035 * @see elm_thumb_file_set()
13036 * @see elm_thumb_ethumb_client_get()
13040 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13042 * Reload thumbnail if it was generated before.
13044 * @param obj The thumb object to reload
13046 * This is useful if the ethumb client configuration changed, like its
13047 * size, aspect or any other property one set in the handle returned
13048 * by elm_thumb_ethumb_client_get().
13050 * If the options didn't change, the thumbnail won't be generated again, but
13051 * the old one will still be used.
13053 * @see elm_thumb_file_set()
13057 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13059 * Set the file that will be used as thumbnail.
13061 * @param obj The thumb object.
13062 * @param file The path to file that will be used as thumb.
13063 * @param key The key used in case of an EET file.
13065 * The file can be an image or a video (in that case, acceptable extensions are:
13066 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13067 * function elm_thumb_animate().
13069 * @see elm_thumb_file_get()
13070 * @see elm_thumb_reload()
13071 * @see elm_thumb_animate()
13075 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13077 * Get the image or video path and key used to generate the thumbnail.
13079 * @param obj The thumb object.
13080 * @param file Pointer to filename.
13081 * @param key Pointer to key.
13083 * @see elm_thumb_file_set()
13084 * @see elm_thumb_path_get()
13088 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13090 * Get the path and key to the image or video generated by ethumb.
13092 * One just need to make sure that the thumbnail was generated before getting
13093 * its path; otherwise, the path will be NULL. One way to do that is by asking
13094 * for the path when/after the "generate,stop" smart callback is called.
13096 * @param obj The thumb object.
13097 * @param file Pointer to thumb path.
13098 * @param key Pointer to thumb key.
13100 * @see elm_thumb_file_get()
13104 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13106 * Set the animation state for the thumb object. If its content is an animated
13107 * video, you may start/stop the animation or tell it to play continuously and
13110 * @param obj The thumb object.
13111 * @param setting The animation setting.
13113 * @see elm_thumb_file_set()
13117 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13119 * Get the animation state for the thumb object.
13121 * @param obj The thumb object.
13122 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13125 * @see elm_thumb_animate_set()
13129 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13131 * Get the ethumb_client handle so custom configuration can be made.
13133 * @return Ethumb_Client instance or NULL.
13135 * This must be called before the objects are created to be sure no object is
13136 * visible and no generation started.
13138 * Example of usage:
13141 * #include <Elementary.h>
13142 * #ifndef ELM_LIB_QUICKLAUNCH
13144 * elm_main(int argc, char **argv)
13146 * Ethumb_Client *client;
13148 * elm_need_ethumb();
13152 * client = elm_thumb_ethumb_client_get();
13155 * ERR("could not get ethumb_client");
13158 * ethumb_client_size_set(client, 100, 100);
13159 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13162 * // Create elm_thumb objects here
13172 * @note There's only one client handle for Ethumb, so once a configuration
13173 * change is done to it, any other request for thumbnails (for any thumbnail
13174 * object) will use that configuration. Thus, this configuration is global.
13178 EAPI void *elm_thumb_ethumb_client_get(void);
13180 * Get the ethumb_client connection state.
13182 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13185 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13187 * Make the thumbnail 'editable'.
13189 * @param obj Thumb object.
13190 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13192 * This means the thumbnail is a valid drag target for drag and drop, and can be
13193 * cut or pasted too.
13195 * @see elm_thumb_editable_get()
13199 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13200 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13202 * Make the thumbnail 'editable'.
13204 * @param obj Thumb object.
13205 * @return Editability.
13207 * This means the thumbnail is a valid drag target for drag and drop, and can be
13208 * cut or pasted too.
13210 * @see elm_thumb_editable_set()
13214 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13221 * @defgroup Web Web
13223 * @image html img/widget/web/preview-00.png
13224 * @image latex img/widget/web/preview-00.eps
13226 * A web object is used for displaying web pages (HTML/CSS/JS)
13227 * using WebKit-EFL. You must have compiled Elementary with
13230 * Signals that you can add callbacks for are:
13231 * @li "download,request": A file download has been requested. Event info is
13232 * a pointer to a Elm_Web_Download
13233 * @li "editorclient,contents,changed": Editor client's contents changed
13234 * @li "editorclient,selection,changed": Editor client's selection changed
13235 * @li "frame,created": A new frame was created. Event info is an
13236 * Evas_Object which can be handled with WebKit's ewk_frame API
13237 * @li "icon,received": An icon was received by the main frame
13238 * @li "inputmethod,changed": Input method changed. Event info is an
13239 * Eina_Bool indicating whether it's enabled or not
13240 * @li "js,windowobject,clear": JS window object has been cleared
13241 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13242 * is a char *link[2], where the first string contains the URL the link
13243 * points to, and the second one the title of the link
13244 * @li "link,hover,out": Mouse cursor left the link
13245 * @li "load,document,finished": Loading of a document finished. Event info
13246 * is the frame that finished loading
13247 * @li "load,error": Load failed. Event info is a pointer to
13248 * Elm_Web_Frame_Load_Error
13249 * @li "load,finished": Load finished. Event info is NULL on success, on
13250 * error it's a pointer to Elm_Web_Frame_Load_Error
13251 * @li "load,newwindow,show": A new window was created and is ready to be
13253 * @li "load,progress": Overall load progress. Event info is a pointer to
13254 * a double containing a value between 0.0 and 1.0
13255 * @li "load,provisional": Started provisional load
13256 * @li "load,started": Loading of a document started
13257 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13258 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13259 * the menubar is visible, or EINA_FALSE in case it's not
13260 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13261 * an Eina_Bool indicating the visibility
13262 * @li "popup,created": A dropdown widget was activated, requesting its
13263 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13264 * @li "popup,willdelete": The web object is ready to destroy the popup
13265 * object created. Event info is a pointer to Elm_Web_Menu
13266 * @li "ready": Page is fully loaded
13267 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13268 * info is a pointer to Eina_Bool where the visibility state should be set
13269 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13270 * is an Eina_Bool with the visibility state set
13271 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13272 * a string with the new text
13273 * @li "statusbar,visible,get": Queries visibility of the status bar.
13274 * Event info is a pointer to Eina_Bool where the visibility state should be
13276 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13277 * an Eina_Bool with the visibility value
13278 * @li "title,changed": Title of the main frame changed. Event info is a
13279 * string with the new title
13280 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13281 * is a pointer to Eina_Bool where the visibility state should be set
13282 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13283 * info is an Eina_Bool with the visibility state
13284 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13285 * a string with the text to show
13286 * @li "uri,changed": URI of the main frame changed. Event info is a string
13288 * @li "view,resized": The web object internal's view changed sized
13289 * @li "windows,close,request": A JavaScript request to close the current
13290 * window was requested
13291 * @li "zoom,animated,end": Animated zoom finished
13293 * available styles:
13296 * An example of use of web:
13298 * - @ref web_example_01 TBD
13307 * Structure used to report load errors.
13309 * Load errors are reported as signal by elm_web. All the strings are
13310 * temporary references and should @b not be used after the signal
13311 * callback returns. If it's required, make copies with strdup() or
13312 * eina_stringshare_add() (they are not even guaranteed to be
13313 * stringshared, so must use eina_stringshare_add() and not
13314 * eina_stringshare_ref()).
13316 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13318 * Structure used to report load errors.
13320 * Load errors are reported as signal by elm_web. All the strings are
13321 * temporary references and should @b not be used after the signal
13322 * callback returns. If it's required, make copies with strdup() or
13323 * eina_stringshare_add() (they are not even guaranteed to be
13324 * stringshared, so must use eina_stringshare_add() and not
13325 * eina_stringshare_ref()).
13327 struct _Elm_Web_Frame_Load_Error
13329 int code; /**< Numeric error code */
13330 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13331 const char *domain; /**< Error domain name */
13332 const char *description; /**< Error description (already localized) */
13333 const char *failing_url; /**< The URL that failed to load */
13334 Evas_Object *frame; /**< Frame object that produced the error */
13338 * The possibles types that the items in a menu can be
13340 typedef enum _Elm_Web_Menu_Item_Type
13342 ELM_WEB_MENU_SEPARATOR,
13343 ELM_WEB_MENU_GROUP,
13344 ELM_WEB_MENU_OPTION
13345 } Elm_Web_Menu_Item_Type;
13348 * Structure describing the items in a menu
13350 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13352 * Structure describing the items in a menu
13354 struct _Elm_Web_Menu_Item
13356 const char *text; /**< The text for the item */
13357 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13361 * Structure describing the menu of a popup
13363 * This structure will be passed as the @c event_info for the "popup,create"
13364 * signal, which is emitted when a dropdown menu is opened. Users wanting
13365 * to handle these popups by themselves should listen to this signal and
13366 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13367 * property as @c EINA_FALSE means that the user will not handle the popup
13368 * and the default implementation will be used.
13370 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13371 * will be emitted to notify the user that it can destroy any objects and
13372 * free all data related to it.
13374 * @see elm_web_popup_selected_set()
13375 * @see elm_web_popup_destroy()
13377 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13379 * Structure describing the menu of a popup
13381 * This structure will be passed as the @c event_info for the "popup,create"
13382 * signal, which is emitted when a dropdown menu is opened. Users wanting
13383 * to handle these popups by themselves should listen to this signal and
13384 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13385 * property as @c EINA_FALSE means that the user will not handle the popup
13386 * and the default implementation will be used.
13388 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13389 * will be emitted to notify the user that it can destroy any objects and
13390 * free all data related to it.
13392 * @see elm_web_popup_selected_set()
13393 * @see elm_web_popup_destroy()
13395 struct _Elm_Web_Menu
13397 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13398 int x; /**< The X position of the popup, relative to the elm_web object */
13399 int y; /**< The Y position of the popup, relative to the elm_web object */
13400 int width; /**< Width of the popup menu */
13401 int height; /**< Height of the popup menu */
13403 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. */
13406 typedef struct _Elm_Web_Download Elm_Web_Download;
13407 struct _Elm_Web_Download
13413 * Types of zoom available.
13415 typedef enum _Elm_Web_Zoom_Mode
13417 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13418 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13419 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13420 ELM_WEB_ZOOM_MODE_LAST
13421 } Elm_Web_Zoom_Mode;
13423 * Opaque handler containing the features (such as statusbar, menubar, etc)
13424 * that are to be set on a newly requested window.
13426 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13428 * Callback type for the create_window hook.
13430 * The function parameters are:
13431 * @li @p data User data pointer set when setting the hook function
13432 * @li @p obj The elm_web object requesting the new window
13433 * @li @p js Set to @c EINA_TRUE if the request was originated from
13434 * JavaScript. @c EINA_FALSE otherwise.
13435 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13436 * the features requested for the new window.
13438 * The returned value of the function should be the @c elm_web widget where
13439 * the request will be loaded. That is, if a new window or tab is created,
13440 * the elm_web widget in it should be returned, and @b NOT the window
13442 * Returning @c NULL should cancel the request.
13444 * @see elm_web_window_create_hook_set()
13446 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13448 * Callback type for the JS alert hook.
13450 * The function parameters are:
13451 * @li @p data User data pointer set when setting the hook function
13452 * @li @p obj The elm_web object requesting the new window
13453 * @li @p message The message to show in the alert dialog
13455 * The function should return the object representing the alert dialog.
13456 * Elm_Web will run a second main loop to handle the dialog and normal
13457 * flow of the application will be restored when the object is deleted, so
13458 * the user should handle the popup properly in order to delete the object
13459 * when the action is finished.
13460 * If the function returns @c NULL the popup will be ignored.
13462 * @see elm_web_dialog_alert_hook_set()
13464 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13466 * Callback type for the JS confirm hook.
13468 * The function parameters are:
13469 * @li @p data User data pointer set when setting the hook function
13470 * @li @p obj The elm_web object requesting the new window
13471 * @li @p message The message to show in the confirm dialog
13472 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13473 * the user selected @c Ok, @c EINA_FALSE otherwise.
13475 * The function should return the object representing the confirm dialog.
13476 * Elm_Web will run a second main loop to handle the dialog and normal
13477 * flow of the application will be restored when the object is deleted, so
13478 * the user should handle the popup properly in order to delete the object
13479 * when the action is finished.
13480 * If the function returns @c NULL the popup will be ignored.
13482 * @see elm_web_dialog_confirm_hook_set()
13484 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13486 * Callback type for the JS prompt hook.
13488 * The function parameters are:
13489 * @li @p data User data pointer set when setting the hook function
13490 * @li @p obj The elm_web object requesting the new window
13491 * @li @p message The message to show in the prompt dialog
13492 * @li @p def_value The default value to present the user in the entry
13493 * @li @p value Pointer where to store the value given by the user. Must
13494 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13495 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13496 * the user selected @c Ok, @c EINA_FALSE otherwise.
13498 * The function should return the object representing the prompt dialog.
13499 * Elm_Web will run a second main loop to handle the dialog and normal
13500 * flow of the application will be restored when the object is deleted, so
13501 * the user should handle the popup properly in order to delete the object
13502 * when the action is finished.
13503 * If the function returns @c NULL the popup will be ignored.
13505 * @see elm_web_dialog_prompt_hook_set()
13507 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13509 * Callback type for the JS file selector hook.
13511 * The function parameters are:
13512 * @li @p data User data pointer set when setting the hook function
13513 * @li @p obj The elm_web object requesting the new window
13514 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13515 * @li @p accept_types Mime types accepted
13516 * @li @p selected Pointer where to store the list of malloc'ed strings
13517 * containing the path to each file selected. Must be @c NULL if the file
13518 * dialog is cancelled
13519 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13520 * the user selected @c Ok, @c EINA_FALSE otherwise.
13522 * The function should return the object representing the file selector
13524 * Elm_Web will run a second main loop to handle the dialog and normal
13525 * flow of the application will be restored when the object is deleted, so
13526 * the user should handle the popup properly in order to delete the object
13527 * when the action is finished.
13528 * If the function returns @c NULL the popup will be ignored.
13530 * @see elm_web_dialog_file selector_hook_set()
13532 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);
13534 * Callback type for the JS console message hook.
13536 * When a console message is added from JavaScript, any set function to the
13537 * console message hook will be called for the user to handle. There is no
13538 * default implementation of this hook.
13540 * The function parameters are:
13541 * @li @p data User data pointer set when setting the hook function
13542 * @li @p obj The elm_web object that originated the message
13543 * @li @p message The message sent
13544 * @li @p line_number The line number
13545 * @li @p source_id Source id
13547 * @see elm_web_console_message_hook_set()
13549 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13551 * Add a new web object to the parent.
13553 * @param parent The parent object.
13554 * @return The new object or NULL if it cannot be created.
13556 * @see elm_web_uri_set()
13557 * @see elm_web_webkit_view_get()
13559 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13562 * Get internal ewk_view object from web object.
13564 * Elementary may not provide some low level features of EWebKit,
13565 * instead of cluttering the API with proxy methods we opted to
13566 * return the internal reference. Be careful using it as it may
13567 * interfere with elm_web behavior.
13569 * @param obj The web object.
13570 * @return The internal ewk_view object or NULL if it does not
13571 * exist. (Failure to create or Elementary compiled without
13574 * @see elm_web_add()
13576 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13579 * Sets the function to call when a new window is requested
13581 * This hook will be called when a request to create a new window is
13582 * issued from the web page loaded.
13583 * There is no default implementation for this feature, so leaving this
13584 * unset or passing @c NULL in @p func will prevent new windows from
13587 * @param obj The web object where to set the hook function
13588 * @param func The hook function to be called when a window is requested
13589 * @param data User data
13591 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13593 * Sets the function to call when an alert dialog
13595 * This hook will be called when a JavaScript alert dialog is requested.
13596 * If no function is set or @c NULL is passed in @p func, the default
13597 * implementation will take place.
13599 * @param obj The web object where to set the hook function
13600 * @param func The callback function to be used
13601 * @param data User data
13603 * @see elm_web_inwin_mode_set()
13605 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13607 * Sets the function to call when an confirm dialog
13609 * This hook will be called when a JavaScript confirm dialog is requested.
13610 * If no function is set or @c NULL is passed in @p func, the default
13611 * implementation will take place.
13613 * @param obj The web object where to set the hook function
13614 * @param func The callback function to be used
13615 * @param data User data
13617 * @see elm_web_inwin_mode_set()
13619 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13621 * Sets the function to call when an prompt dialog
13623 * This hook will be called when a JavaScript prompt dialog is requested.
13624 * If no function is set or @c NULL is passed in @p func, the default
13625 * implementation will take place.
13627 * @param obj The web object where to set the hook function
13628 * @param func The callback function to be used
13629 * @param data User data
13631 * @see elm_web_inwin_mode_set()
13633 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13635 * Sets the function to call when an file selector dialog
13637 * This hook will be called when a JavaScript file selector dialog is
13639 * If no function is set or @c NULL is passed in @p func, the default
13640 * implementation will take place.
13642 * @param obj The web object where to set the hook function
13643 * @param func The callback function to be used
13644 * @param data User data
13646 * @see elm_web_inwin_mode_set()
13648 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13650 * Sets the function to call when a console message is emitted from JS
13652 * This hook will be called when a console message is emitted from
13653 * JavaScript. There is no default implementation for this feature.
13655 * @param obj The web object where to set the hook function
13656 * @param func The callback function to be used
13657 * @param data User data
13659 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13661 * Gets the status of the tab propagation
13663 * @param obj The web object to query
13664 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13666 * @see elm_web_tab_propagate_set()
13668 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13670 * Sets whether to use tab propagation
13672 * If tab propagation is enabled, whenever the user presses the Tab key,
13673 * Elementary will handle it and switch focus to the next widget.
13674 * The default value is disabled, where WebKit will handle the Tab key to
13675 * cycle focus though its internal objects, jumping to the next widget
13676 * only when that cycle ends.
13678 * @param obj The web object
13679 * @param propagate Whether to propagate Tab keys to Elementary or not
13681 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13683 * Sets the URI for the web object
13685 * It must be a full URI, with resource included, in the form
13686 * http://www.enlightenment.org or file:///tmp/something.html
13688 * @param obj The web object
13689 * @param uri The URI to set
13690 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13692 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13694 * Gets the current URI for the object
13696 * The returned string must not be freed and is guaranteed to be
13699 * @param obj The web object
13700 * @return A stringshared internal string with the current URI, or NULL on
13703 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13705 * Gets the current title
13707 * The returned string must not be freed and is guaranteed to be
13710 * @param obj The web object
13711 * @return A stringshared internal string with the current title, or NULL on
13714 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13716 * Sets the background color to be used by the web object
13718 * This is the color that will be used by default when the loaded page
13719 * does not set it's own. Color values are pre-multiplied.
13721 * @param obj The web object
13722 * @param r Red component
13723 * @param g Green component
13724 * @param b Blue component
13725 * @param a Alpha component
13727 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13729 * Gets the background color to be used by the web object
13731 * This is the color that will be used by default when the loaded page
13732 * does not set it's own. Color values are pre-multiplied.
13734 * @param obj The web object
13735 * @param r Red component
13736 * @param g Green component
13737 * @param b Blue component
13738 * @param a Alpha component
13740 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13742 * Gets a copy of the currently selected text
13744 * The string returned must be freed by the user when it's done with it.
13746 * @param obj The web object
13747 * @return A newly allocated string, or NULL if nothing is selected or an
13750 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13752 * Tells the web object which index in the currently open popup was selected
13754 * When the user handles the popup creation from the "popup,created" signal,
13755 * it needs to tell the web object which item was selected by calling this
13756 * function with the index corresponding to the item.
13758 * @param obj The web object
13759 * @param index The index selected
13761 * @see elm_web_popup_destroy()
13763 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13765 * Dismisses an open dropdown popup
13767 * When the popup from a dropdown widget is to be dismissed, either after
13768 * selecting an option or to cancel it, this function must be called, which
13769 * will later emit an "popup,willdelete" signal to notify the user that
13770 * any memory and objects related to this popup can be freed.
13772 * @param obj The web object
13773 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13774 * if there was no menu to destroy
13776 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13778 * Searches the given string in a document.
13780 * @param obj The web object where to search the text
13781 * @param string String to search
13782 * @param case_sensitive If search should be case sensitive or not
13783 * @param forward If search is from cursor and on or backwards
13784 * @param wrap If search should wrap at the end
13786 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13789 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13791 * Marks matches of the given string in a document.
13793 * @param obj The web object where to search text
13794 * @param string String to match
13795 * @param case_sensitive If match should be case sensitive or not
13796 * @param highlight If matches should be highlighted
13797 * @param limit Maximum amount of matches, or zero to unlimited
13799 * @return number of matched @a string
13801 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13803 * Clears all marked matches in the document
13805 * @param obj The web object
13807 * @return EINA_TRUE on success, EINA_FALSE otherwise
13809 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13811 * Sets whether to highlight the matched marks
13813 * If enabled, marks set with elm_web_text_matches_mark() will be
13816 * @param obj The web object
13817 * @param highlight Whether to highlight the marks or not
13819 * @return EINA_TRUE on success, EINA_FALSE otherwise
13821 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13823 * Gets whether highlighting marks is enabled
13825 * @param The web object
13827 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13830 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13832 * Gets the overall loading progress of the page
13834 * Returns the estimated loading progress of the page, with a value between
13835 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13836 * included in the page.
13838 * @param The web object
13840 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13843 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13845 * Stops loading the current page
13847 * Cancels the loading of the current page in the web object. This will
13848 * cause a "load,error" signal to be emitted, with the is_cancellation
13849 * flag set to EINA_TRUE.
13851 * @param obj The web object
13853 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13855 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13857 * Requests a reload of the current document in the object
13859 * @param obj The web object
13861 * @return EINA_TRUE on success, EINA_FALSE otherwise
13863 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13865 * Requests a reload of the current document, avoiding any existing caches
13867 * @param obj The web object
13869 * @return EINA_TRUE on success, EINA_FALSE otherwise
13871 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13873 * Goes back one step in the browsing history
13875 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13877 * @param obj The web object
13879 * @return EINA_TRUE on success, EINA_FALSE otherwise
13881 * @see elm_web_history_enable_set()
13882 * @see elm_web_back_possible()
13883 * @see elm_web_forward()
13884 * @see elm_web_navigate()
13886 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13888 * Goes forward one step in the browsing history
13890 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13892 * @param obj The web object
13894 * @return EINA_TRUE on success, EINA_FALSE otherwise
13896 * @see elm_web_history_enable_set()
13897 * @see elm_web_forward_possible()
13898 * @see elm_web_back()
13899 * @see elm_web_navigate()
13901 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13903 * Jumps the given number of steps in the browsing history
13905 * The @p steps value can be a negative integer to back in history, or a
13906 * positive to move forward.
13908 * @param obj The web object
13909 * @param steps The number of steps to jump
13911 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13912 * history exists to jump the given number of steps
13914 * @see elm_web_history_enable_set()
13915 * @see elm_web_navigate_possible()
13916 * @see elm_web_back()
13917 * @see elm_web_forward()
13919 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13921 * Queries whether it's possible to go back in history
13923 * @param obj The web object
13925 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13928 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13930 * Queries whether it's possible to go forward in history
13932 * @param obj The web object
13934 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13937 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13939 * Queries whether it's possible to jump the given number of steps
13941 * The @p steps value can be a negative integer to back in history, or a
13942 * positive to move forward.
13944 * @param obj The web object
13945 * @param steps The number of steps to check for
13947 * @return EINA_TRUE if enough history exists to perform the given jump,
13948 * EINA_FALSE otherwise
13950 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13952 * Gets whether browsing history is enabled for the given object
13954 * @param obj The web object
13956 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13958 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13960 * Enables or disables the browsing history
13962 * @param obj The web object
13963 * @param enable Whether to enable or disable the browsing history
13965 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13967 * Sets the zoom level of the web object
13969 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13970 * values meaning zoom in and lower meaning zoom out. This function will
13971 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13972 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13974 * @param obj The web object
13975 * @param zoom The zoom level to set
13977 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13979 * Gets the current zoom level set on the web object
13981 * Note that this is the zoom level set on the web object and not that
13982 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13983 * the two zoom levels should match, but for the other two modes the
13984 * Webkit zoom is calculated internally to match the chosen mode without
13985 * changing the zoom level set for the web object.
13987 * @param obj The web object
13989 * @return The zoom level set on the object
13991 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13993 * Sets the zoom mode to use
13995 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13996 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13998 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13999 * with the elm_web_zoom_set() function.
14000 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14001 * make sure the entirety of the web object's contents are shown.
14002 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14003 * fit the contents in the web object's size, without leaving any space
14006 * @param obj The web object
14007 * @param mode The mode to set
14009 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14011 * Gets the currently set zoom mode
14013 * @param obj The web object
14015 * @return The current zoom mode set for the object, or
14016 * ::ELM_WEB_ZOOM_MODE_LAST on error
14018 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14020 * Shows the given region in the web object
14022 * @param obj The web object
14023 * @param x The x coordinate of the region to show
14024 * @param y The y coordinate of the region to show
14025 * @param w The width of the region to show
14026 * @param h The height of the region to show
14028 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14030 * Brings in the region to the visible area
14032 * Like elm_web_region_show(), but it animates the scrolling of the object
14035 * @param obj The web object
14036 * @param x The x coordinate of the region to show
14037 * @param y The y coordinate of the region to show
14038 * @param w The width of the region to show
14039 * @param h The height of the region to show
14041 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14043 * Sets the default dialogs to use an Inwin instead of a normal window
14045 * If set, then the default implementation for the JavaScript dialogs and
14046 * file selector will be opened in an Inwin. Otherwise they will use a
14047 * normal separated window.
14049 * @param obj The web object
14050 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14052 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14054 * Gets whether Inwin mode is set for the current object
14056 * @param obj The web object
14058 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14060 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14062 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14063 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14064 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);
14065 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14072 * @defgroup Hoversel Hoversel
14074 * @image html img/widget/hoversel/preview-00.png
14075 * @image latex img/widget/hoversel/preview-00.eps
14077 * A hoversel is a button that pops up a list of items (automatically
14078 * choosing the direction to display) that have a label and, optionally, an
14079 * icon to select from. It is a convenience widget to avoid the need to do
14080 * all the piecing together yourself. It is intended for a small number of
14081 * items in the hoversel menu (no more than 8), though is capable of many
14084 * Signals that you can add callbacks for are:
14085 * "clicked" - the user clicked the hoversel button and popped up the sel
14086 * "selected" - an item in the hoversel list is selected. event_info is the item
14087 * "dismissed" - the hover is dismissed
14089 * See @ref tutorial_hoversel for an example.
14092 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14094 * @brief Add a new Hoversel object
14096 * @param parent The parent object
14097 * @return The new object or NULL if it cannot be created
14099 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14101 * @brief This sets the hoversel to expand horizontally.
14103 * @param obj The hoversel object
14104 * @param horizontal If true, the hover will expand horizontally to the
14107 * @note The initial button will display horizontally regardless of this
14110 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14112 * @brief This returns whether the hoversel is set to expand horizontally.
14114 * @param obj The hoversel object
14115 * @return If true, the hover will expand horizontally to the right.
14117 * @see elm_hoversel_horizontal_set()
14119 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14121 * @brief Set the Hover parent
14123 * @param obj The hoversel object
14124 * @param parent The parent to use
14126 * Sets the hover parent object, the area that will be darkened when the
14127 * hoversel is clicked. Should probably be the window that the hoversel is
14128 * in. See @ref Hover objects for more information.
14130 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14132 * @brief Get the Hover parent
14134 * @param obj The hoversel object
14135 * @return The used parent
14137 * Gets the hover parent object.
14139 * @see elm_hoversel_hover_parent_set()
14141 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14143 * @brief Set the hoversel button label
14145 * @param obj The hoversel object
14146 * @param label The label text.
14148 * This sets the label of the button that is always visible (before it is
14149 * clicked and expanded).
14151 * @deprecated elm_object_text_set()
14153 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14155 * @brief Get the hoversel button label
14157 * @param obj The hoversel object
14158 * @return The label text.
14160 * @deprecated elm_object_text_get()
14162 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14164 * @brief Set the icon of the hoversel button
14166 * @param obj The hoversel object
14167 * @param icon The icon object
14169 * Sets the icon of the button that is always visible (before it is clicked
14170 * and expanded). Once the icon object is set, a previously set one will be
14171 * deleted, if you want to keep that old content object, use the
14172 * elm_hoversel_icon_unset() function.
14174 * @see elm_object_content_set() for the button widget
14176 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14178 * @brief Get the icon of the hoversel button
14180 * @param obj The hoversel object
14181 * @return The icon object
14183 * Get the icon of the button that is always visible (before it is clicked
14184 * and expanded). Also see elm_object_content_get() for the button widget.
14186 * @see elm_hoversel_icon_set()
14188 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14190 * @brief Get and unparent the icon of the hoversel button
14192 * @param obj The hoversel object
14193 * @return The icon object that was being used
14195 * Unparent and return the icon of the button that is always visible
14196 * (before it is clicked and expanded).
14198 * @see elm_hoversel_icon_set()
14199 * @see elm_object_content_unset() for the button widget
14201 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14203 * @brief This triggers the hoversel popup from code, the same as if the user
14204 * had clicked the button.
14206 * @param obj The hoversel object
14208 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14210 * @brief This dismisses the hoversel popup as if the user had clicked
14211 * outside the hover.
14213 * @param obj The hoversel object
14215 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14217 * @brief Returns whether the hoversel is expanded.
14219 * @param obj The hoversel object
14220 * @return This will return EINA_TRUE if the hoversel is expanded or
14221 * EINA_FALSE if it is not expanded.
14223 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14225 * @brief This will remove all the children items from the hoversel.
14227 * @param obj The hoversel object
14229 * @warning Should @b not be called while the hoversel is active; use
14230 * elm_hoversel_expanded_get() to check first.
14232 * @see elm_hoversel_item_del_cb_set()
14233 * @see elm_hoversel_item_del()
14235 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14237 * @brief Get the list of items within the given hoversel.
14239 * @param obj The hoversel object
14240 * @return Returns a list of Elm_Hoversel_Item*
14242 * @see elm_hoversel_item_add()
14244 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14246 * @brief Add an item to the hoversel button
14248 * @param obj The hoversel object
14249 * @param label The text label to use for the item (NULL if not desired)
14250 * @param icon_file An image file path on disk to use for the icon or standard
14251 * icon name (NULL if not desired)
14252 * @param icon_type The icon type if relevant
14253 * @param func Convenience function to call when this item is selected
14254 * @param data Data to pass to item-related functions
14255 * @return A handle to the item added.
14257 * This adds an item to the hoversel to show when it is clicked. Note: if you
14258 * need to use an icon from an edje file then use
14259 * elm_hoversel_item_icon_set() right after the this function, and set
14260 * icon_file to NULL here.
14262 * For more information on what @p icon_file and @p icon_type are see the
14263 * @ref Icon "icon documentation".
14265 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);
14267 * @brief Delete an item from the hoversel
14269 * @param item The item to delete
14271 * This deletes the item from the hoversel (should not be called while the
14272 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14274 * @see elm_hoversel_item_add()
14275 * @see elm_hoversel_item_del_cb_set()
14277 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14279 * @brief Set the function to be called when an item from the hoversel is
14282 * @param item The item to set the callback on
14283 * @param func The function called
14285 * That function will receive these parameters:
14286 * @li void *item_data
14287 * @li Evas_Object *the_item_object
14288 * @li Elm_Hoversel_Item *the_object_struct
14290 * @see elm_hoversel_item_add()
14292 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14294 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14295 * that will be passed to associated function callbacks.
14297 * @param item The item to get the data from
14298 * @return The data pointer set with elm_hoversel_item_add()
14300 * @see elm_hoversel_item_add()
14302 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14304 * @brief This returns the label text of the given hoversel item.
14306 * @param item The item to get the label
14307 * @return The label text of the hoversel item
14309 * @see elm_hoversel_item_add()
14311 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14313 * @brief This sets the icon for the given hoversel item.
14315 * @param item The item to set the icon
14316 * @param icon_file An image file path on disk to use for the icon or standard
14318 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14319 * to NULL if the icon is not an edje file
14320 * @param icon_type The icon type
14322 * The icon can be loaded from the standard set, from an image file, or from
14325 * @see elm_hoversel_item_add()
14327 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);
14329 * @brief Get the icon object of the hoversel item
14331 * @param item The item to get the icon from
14332 * @param icon_file The image file path on disk used for the icon or standard
14334 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14335 * if the icon is not an edje file
14336 * @param icon_type The icon type
14338 * @see elm_hoversel_item_icon_set()
14339 * @see elm_hoversel_item_add()
14341 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);
14347 * @defgroup Toolbar Toolbar
14348 * @ingroup Elementary
14350 * @image html img/widget/toolbar/preview-00.png
14351 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14353 * @image html img/toolbar.png
14354 * @image latex img/toolbar.eps width=\textwidth
14356 * A toolbar is a widget that displays a list of items inside
14357 * a box. It can be scrollable, show a menu with items that don't fit
14358 * to toolbar size or even crop them.
14360 * Only one item can be selected at a time.
14362 * Items can have multiple states, or show menus when selected by the user.
14364 * Smart callbacks one can listen to:
14365 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14366 * - "language,changed" - when the program language changes
14368 * Available styles for it:
14370 * - @c "transparent" - no background or shadow, just show the content
14372 * List of examples:
14373 * @li @ref toolbar_example_01
14374 * @li @ref toolbar_example_02
14375 * @li @ref toolbar_example_03
14379 * @addtogroup Toolbar
14384 * @enum _Elm_Toolbar_Shrink_Mode
14385 * @typedef Elm_Toolbar_Shrink_Mode
14387 * Set toolbar's items display behavior, it can be scrollabel,
14388 * show a menu with exceeding items, or simply hide them.
14390 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14393 * Values <b> don't </b> work as bitmask, only one can be choosen.
14395 * @see elm_toolbar_mode_shrink_set()
14396 * @see elm_toolbar_mode_shrink_get()
14400 typedef enum _Elm_Toolbar_Shrink_Mode
14402 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14403 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14404 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14405 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14406 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14407 } Elm_Toolbar_Shrink_Mode;
14409 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(). */
14411 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(). */
14414 * Add a new toolbar widget to the given parent Elementary
14415 * (container) object.
14417 * @param parent The parent object.
14418 * @return a new toolbar widget handle or @c NULL, on errors.
14420 * This function inserts a new toolbar widget on the canvas.
14424 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14427 * Set the icon size, in pixels, to be used by toolbar items.
14429 * @param obj The toolbar object
14430 * @param icon_size The icon size in pixels
14432 * @note Default value is @c 32. It reads value from elm config.
14434 * @see elm_toolbar_icon_size_get()
14438 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14441 * Get the icon size, in pixels, to be used by toolbar items.
14443 * @param obj The toolbar object.
14444 * @return The icon size in pixels.
14446 * @see elm_toolbar_icon_size_set() for details.
14450 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14453 * Sets icon lookup order, for toolbar items' icons.
14455 * @param obj The toolbar object.
14456 * @param order The icon lookup order.
14458 * Icons added before calling this function will not be affected.
14459 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14461 * @see elm_toolbar_icon_order_lookup_get()
14465 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14468 * Gets the icon lookup order.
14470 * @param obj The toolbar object.
14471 * @return The icon lookup order.
14473 * @see elm_toolbar_icon_order_lookup_set() for details.
14477 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14480 * Set whether the toolbar should always have an item selected.
14482 * @param obj The toolbar object.
14483 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14486 * This will cause the toolbar to always have an item selected, and clicking
14487 * the selected item will not cause a selected event to be emitted. Enabling this mode
14488 * will immediately select the first toolbar item.
14490 * Always-selected is disabled by default.
14492 * @see elm_toolbar_always_select_mode_get().
14496 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14499 * Get whether the toolbar should always have an item selected.
14501 * @param obj The toolbar object.
14502 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14503 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14505 * @see elm_toolbar_always_select_mode_set() for details.
14509 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14512 * Set whether the toolbar items' should be selected by the user or not.
14514 * @param obj The toolbar object.
14515 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14518 * This will turn off the ability to select items entirely and they will
14519 * neither appear selected nor emit selected signals. The clicked
14520 * callback function will still be called.
14522 * Selection is enabled by default.
14524 * @see elm_toolbar_no_select_mode_get().
14528 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14531 * Set whether the toolbar items' should be selected by the user or not.
14533 * @param obj The toolbar object.
14534 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14535 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14537 * @see elm_toolbar_no_select_mode_set() for details.
14541 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14544 * Append item to the toolbar.
14546 * @param obj The toolbar object.
14547 * @param icon A string with icon name or the absolute path of an image file.
14548 * @param label The label of the item.
14549 * @param func The function to call when the item is clicked.
14550 * @param data The data to associate with the item for related callbacks.
14551 * @return The created item or @c NULL upon failure.
14553 * A new item will be created and appended to the toolbar, i.e., will
14554 * be set as @b last item.
14556 * Items created with this method can be deleted with
14557 * elm_toolbar_item_del().
14559 * Associated @p data can be properly freed when item is deleted if a
14560 * callback function is set with elm_toolbar_item_del_cb_set().
14562 * If a function is passed as argument, it will be called everytime this item
14563 * is selected, i.e., the user clicks over an unselected item.
14564 * If such function isn't needed, just passing
14565 * @c NULL as @p func is enough. The same should be done for @p data.
14567 * Toolbar will load icon image from fdo or current theme.
14568 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14569 * If an absolute path is provided it will load it direct from a file.
14571 * @see elm_toolbar_item_icon_set()
14572 * @see elm_toolbar_item_del()
14573 * @see elm_toolbar_item_del_cb_set()
14577 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);
14580 * Prepend item to the toolbar.
14582 * @param obj The toolbar object.
14583 * @param icon A string with icon name or the absolute path of an image file.
14584 * @param label The label of the item.
14585 * @param func The function to call when the item is clicked.
14586 * @param data The data to associate with the item for related callbacks.
14587 * @return The created item or @c NULL upon failure.
14589 * A new item will be created and prepended to the toolbar, i.e., will
14590 * be set as @b first item.
14592 * Items created with this method can be deleted with
14593 * elm_toolbar_item_del().
14595 * Associated @p data can be properly freed when item is deleted if a
14596 * callback function is set with elm_toolbar_item_del_cb_set().
14598 * If a function is passed as argument, it will be called everytime this item
14599 * is selected, i.e., the user clicks over an unselected item.
14600 * If such function isn't needed, just passing
14601 * @c NULL as @p func is enough. The same should be done for @p data.
14603 * Toolbar will load icon image from fdo or current theme.
14604 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14605 * If an absolute path is provided it will load it direct from a file.
14607 * @see elm_toolbar_item_icon_set()
14608 * @see elm_toolbar_item_del()
14609 * @see elm_toolbar_item_del_cb_set()
14613 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);
14616 * Insert a new item into the toolbar object before item @p before.
14618 * @param obj The toolbar object.
14619 * @param before The toolbar item to insert before.
14620 * @param icon A string with icon name or the absolute path of an image file.
14621 * @param label The label of the item.
14622 * @param func The function to call when the item is clicked.
14623 * @param data The data to associate with the item for related callbacks.
14624 * @return The created item or @c NULL upon failure.
14626 * A new item will be created and added to the toolbar. Its position in
14627 * this toolbar will be just before item @p before.
14629 * Items created with this method can be deleted with
14630 * elm_toolbar_item_del().
14632 * Associated @p data can be properly freed when item is deleted if a
14633 * callback function is set with elm_toolbar_item_del_cb_set().
14635 * If a function is passed as argument, it will be called everytime this item
14636 * is selected, i.e., the user clicks over an unselected item.
14637 * If such function isn't needed, just passing
14638 * @c NULL as @p func is enough. The same should be done for @p data.
14640 * Toolbar will load icon image from fdo or current theme.
14641 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14642 * If an absolute path is provided it will load it direct from a file.
14644 * @see elm_toolbar_item_icon_set()
14645 * @see elm_toolbar_item_del()
14646 * @see elm_toolbar_item_del_cb_set()
14650 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);
14653 * Insert a new item into the toolbar object after item @p after.
14655 * @param obj The toolbar object.
14656 * @param after The toolbar item to insert after.
14657 * @param icon A string with icon name or the absolute path of an image file.
14658 * @param label The label of the item.
14659 * @param func The function to call when the item is clicked.
14660 * @param data The data to associate with the item for related callbacks.
14661 * @return The created item or @c NULL upon failure.
14663 * A new item will be created and added to the toolbar. Its position in
14664 * this toolbar will be just after item @p after.
14666 * Items created with this method can be deleted with
14667 * elm_toolbar_item_del().
14669 * Associated @p data can be properly freed when item is deleted if a
14670 * callback function is set with elm_toolbar_item_del_cb_set().
14672 * If a function is passed as argument, it will be called everytime this item
14673 * is selected, i.e., the user clicks over an unselected item.
14674 * If such function isn't needed, just passing
14675 * @c NULL as @p func is enough. The same should be done for @p data.
14677 * Toolbar will load icon image from fdo or current theme.
14678 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14679 * If an absolute path is provided it will load it direct from a file.
14681 * @see elm_toolbar_item_icon_set()
14682 * @see elm_toolbar_item_del()
14683 * @see elm_toolbar_item_del_cb_set()
14687 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);
14690 * Get the first item in the given toolbar widget's list of
14693 * @param obj The toolbar object
14694 * @return The first item or @c NULL, if it has no items (and on
14697 * @see elm_toolbar_item_append()
14698 * @see elm_toolbar_last_item_get()
14702 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14705 * Get the last item in the given toolbar widget's list of
14708 * @param obj The toolbar object
14709 * @return The last item or @c NULL, if it has no items (and on
14712 * @see elm_toolbar_item_prepend()
14713 * @see elm_toolbar_first_item_get()
14717 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14720 * Get the item after @p item in toolbar.
14722 * @param item The toolbar item.
14723 * @return The item after @p item, or @c NULL if none or on failure.
14725 * @note If it is the last item, @c NULL will be returned.
14727 * @see elm_toolbar_item_append()
14731 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14734 * Get the item before @p item in toolbar.
14736 * @param item The toolbar item.
14737 * @return The item before @p item, or @c NULL if none or on failure.
14739 * @note If it is the first item, @c NULL will be returned.
14741 * @see elm_toolbar_item_prepend()
14745 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14748 * Get the toolbar object from an item.
14750 * @param item The item.
14751 * @return The toolbar object.
14753 * This returns the toolbar object itself that an item belongs to.
14757 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14760 * Set the priority of a toolbar item.
14762 * @param item The toolbar item.
14763 * @param priority The item priority. The default is zero.
14765 * This is used only when the toolbar shrink mode is set to
14766 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14767 * When space is less than required, items with low priority
14768 * will be removed from the toolbar and added to a dynamically-created menu,
14769 * while items with higher priority will remain on the toolbar,
14770 * with the same order they were added.
14772 * @see elm_toolbar_item_priority_get()
14776 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14779 * Get the priority of a toolbar item.
14781 * @param item The toolbar item.
14782 * @return The @p item priority, or @c 0 on failure.
14784 * @see elm_toolbar_item_priority_set() for details.
14788 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14791 * Get the label of item.
14793 * @param item The item of toolbar.
14794 * @return The label of item.
14796 * The return value is a pointer to the label associated to @p item when
14797 * it was created, with function elm_toolbar_item_append() or similar,
14799 * with function elm_toolbar_item_label_set. If no label
14800 * was passed as argument, it will return @c NULL.
14802 * @see elm_toolbar_item_label_set() for more details.
14803 * @see elm_toolbar_item_append()
14807 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14810 * Set the label of item.
14812 * @param item The item of toolbar.
14813 * @param text The label of item.
14815 * The label to be displayed by the item.
14816 * Label will be placed at icons bottom (if set).
14818 * If a label was passed as argument on item creation, with function
14819 * elm_toolbar_item_append() or similar, it will be already
14820 * displayed by the item.
14822 * @see elm_toolbar_item_label_get()
14823 * @see elm_toolbar_item_append()
14827 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14830 * Return the data associated with a given toolbar widget item.
14832 * @param item The toolbar widget item handle.
14833 * @return The data associated with @p item.
14835 * @see elm_toolbar_item_data_set()
14839 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14842 * Set the data associated with a given toolbar widget item.
14844 * @param item The toolbar widget item handle.
14845 * @param data The new data pointer to set to @p item.
14847 * This sets new item data on @p item.
14849 * @warning The old data pointer won't be touched by this function, so
14850 * the user had better to free that old data himself/herself.
14854 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14857 * Returns a pointer to a toolbar item by its label.
14859 * @param obj The toolbar object.
14860 * @param label The label of the item to find.
14862 * @return The pointer to the toolbar item matching @p label or @c NULL
14867 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14870 * Get whether the @p item is selected or not.
14872 * @param item The toolbar item.
14873 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14874 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14876 * @see elm_toolbar_selected_item_set() for details.
14877 * @see elm_toolbar_item_selected_get()
14881 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14884 * Set the selected state of an item.
14886 * @param item The toolbar item
14887 * @param selected The selected state
14889 * This sets the selected state of the given item @p it.
14890 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14892 * If a new item is selected the previosly selected will be unselected.
14893 * Previoulsy selected item can be get with function
14894 * elm_toolbar_selected_item_get().
14896 * Selected items will be highlighted.
14898 * @see elm_toolbar_item_selected_get()
14899 * @see elm_toolbar_selected_item_get()
14903 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14906 * Get the selected item.
14908 * @param obj The toolbar object.
14909 * @return The selected toolbar item.
14911 * The selected item can be unselected with function
14912 * elm_toolbar_item_selected_set().
14914 * The selected item always will be highlighted on toolbar.
14916 * @see elm_toolbar_selected_items_get()
14920 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14923 * Set the icon associated with @p item.
14925 * @param obj The parent of this item.
14926 * @param item The toolbar item.
14927 * @param icon A string with icon name or the absolute path of an image file.
14929 * Toolbar will load icon image from fdo or current theme.
14930 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14931 * If an absolute path is provided it will load it direct from a file.
14933 * @see elm_toolbar_icon_order_lookup_set()
14934 * @see elm_toolbar_icon_order_lookup_get()
14938 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14941 * Get the string used to set the icon of @p item.
14943 * @param item The toolbar item.
14944 * @return The string associated with the icon object.
14946 * @see elm_toolbar_item_icon_set() for details.
14950 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14953 * Get the object of @p item.
14955 * @param item The toolbar item.
14956 * @return The object
14960 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14963 * Get the icon object of @p item.
14965 * @param item The toolbar item.
14966 * @return The icon object
14968 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14972 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14975 * Set the icon associated with @p item to an image in a binary buffer.
14977 * @param item The toolbar item.
14978 * @param img The binary data that will be used as an image
14979 * @param size The size of binary data @p img
14980 * @param format Optional format of @p img to pass to the image loader
14981 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14983 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14985 * @note The icon image set by this function can be changed by
14986 * elm_toolbar_item_icon_set().
14990 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);
14993 * Delete them item from the toolbar.
14995 * @param item The item of toolbar to be deleted.
14997 * @see elm_toolbar_item_append()
14998 * @see elm_toolbar_item_del_cb_set()
15002 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15005 * Set the function called when a toolbar item is freed.
15007 * @param item The item to set the callback on.
15008 * @param func The function called.
15010 * If there is a @p func, then it will be called prior item's memory release.
15011 * That will be called with the following arguments:
15013 * @li item's Evas object;
15016 * This way, a data associated to a toolbar item could be properly freed.
15020 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15023 * Get a value whether toolbar item is disabled or not.
15025 * @param item The item.
15026 * @return The disabled state.
15028 * @see elm_toolbar_item_disabled_set() for more details.
15032 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15035 * Sets the disabled/enabled state of a toolbar item.
15037 * @param item The item.
15038 * @param disabled The disabled state.
15040 * A disabled item cannot be selected or unselected. It will also
15041 * change its appearance (generally greyed out). This sets the
15042 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15047 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15050 * Set or unset item as a separator.
15052 * @param item The toolbar item.
15053 * @param setting @c EINA_TRUE to set item @p item as separator or
15054 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15056 * Items aren't set as separator by default.
15058 * If set as separator it will display separator theme, so won't display
15061 * @see elm_toolbar_item_separator_get()
15065 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15068 * Get a value whether item is a separator or not.
15070 * @param item The toolbar item.
15071 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15072 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15074 * @see elm_toolbar_item_separator_set() for details.
15078 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15081 * Set the shrink state of toolbar @p obj.
15083 * @param obj The toolbar object.
15084 * @param shrink_mode Toolbar's items display behavior.
15086 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15087 * but will enforce a minimun size so all the items will fit, won't scroll
15088 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15089 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15090 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15094 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15097 * Get the shrink mode of toolbar @p obj.
15099 * @param obj The toolbar object.
15100 * @return Toolbar's items display behavior.
15102 * @see elm_toolbar_mode_shrink_set() for details.
15106 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15109 * Enable/disable homogenous mode.
15111 * @param obj The toolbar object
15112 * @param homogeneous Assume the items within the toolbar are of the
15113 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15115 * This will enable the homogeneous mode where items are of the same size.
15116 * @see elm_toolbar_homogeneous_get()
15120 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15123 * Get whether the homogenous mode is enabled.
15125 * @param obj The toolbar object.
15126 * @return Assume the items within the toolbar are of the same height
15127 * and width (EINA_TRUE = on, EINA_FALSE = off).
15129 * @see elm_toolbar_homogeneous_set()
15133 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15136 * Enable/disable homogenous mode.
15138 * @param obj The toolbar object
15139 * @param homogeneous Assume the items within the toolbar are of the
15140 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15142 * This will enable the homogeneous mode where items are of the same size.
15143 * @see elm_toolbar_homogeneous_get()
15145 * @deprecated use elm_toolbar_homogeneous_set() instead.
15149 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15152 * Get whether the homogenous mode is enabled.
15154 * @param obj The toolbar object.
15155 * @return Assume the items within the toolbar are of the same height
15156 * and width (EINA_TRUE = on, EINA_FALSE = off).
15158 * @see elm_toolbar_homogeneous_set()
15159 * @deprecated use elm_toolbar_homogeneous_get() instead.
15163 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15166 * Set the parent object of the toolbar items' menus.
15168 * @param obj The toolbar object.
15169 * @param parent The parent of the menu objects.
15171 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15173 * For more details about setting the parent for toolbar menus, see
15174 * elm_menu_parent_set().
15176 * @see elm_menu_parent_set() for details.
15177 * @see elm_toolbar_item_menu_set() for details.
15181 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15184 * Get the parent object of the toolbar items' menus.
15186 * @param obj The toolbar object.
15187 * @return The parent of the menu objects.
15189 * @see elm_toolbar_menu_parent_set() for details.
15193 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15196 * Set the alignment of the items.
15198 * @param obj The toolbar object.
15199 * @param align The new alignment, a float between <tt> 0.0 </tt>
15200 * and <tt> 1.0 </tt>.
15202 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15203 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15206 * Centered items by default.
15208 * @see elm_toolbar_align_get()
15212 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15215 * Get the alignment of the items.
15217 * @param obj The toolbar object.
15218 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15221 * @see elm_toolbar_align_set() for details.
15225 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15228 * Set whether the toolbar item opens a menu.
15230 * @param item The toolbar item.
15231 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15233 * A toolbar item can be set to be a menu, using this function.
15235 * Once it is set to be a menu, it can be manipulated through the
15236 * menu-like function elm_toolbar_menu_parent_set() and the other
15237 * elm_menu functions, using the Evas_Object @c menu returned by
15238 * elm_toolbar_item_menu_get().
15240 * So, items to be displayed in this item's menu should be added with
15241 * elm_menu_item_add().
15243 * The following code exemplifies the most basic usage:
15245 * tb = elm_toolbar_add(win)
15246 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15247 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15248 * elm_toolbar_menu_parent_set(tb, win);
15249 * menu = elm_toolbar_item_menu_get(item);
15250 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15251 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15255 * @see elm_toolbar_item_menu_get()
15259 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15262 * Get toolbar item's menu.
15264 * @param item The toolbar item.
15265 * @return Item's menu object or @c NULL on failure.
15267 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15268 * this function will set it.
15270 * @see elm_toolbar_item_menu_set() for details.
15274 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15277 * Add a new state to @p item.
15279 * @param item The item.
15280 * @param icon A string with icon name or the absolute path of an image file.
15281 * @param label The label of the new state.
15282 * @param func The function to call when the item is clicked when this
15283 * state is selected.
15284 * @param data The data to associate with the state.
15285 * @return The toolbar item state, or @c NULL upon failure.
15287 * Toolbar will load icon image from fdo or current theme.
15288 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15289 * If an absolute path is provided it will load it direct from a file.
15291 * States created with this function can be removed with
15292 * elm_toolbar_item_state_del().
15294 * @see elm_toolbar_item_state_del()
15295 * @see elm_toolbar_item_state_sel()
15296 * @see elm_toolbar_item_state_get()
15300 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);
15303 * Delete a previoulsy added state to @p item.
15305 * @param item The toolbar item.
15306 * @param state The state to be deleted.
15307 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15309 * @see elm_toolbar_item_state_add()
15311 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15314 * Set @p state as the current state of @p it.
15316 * @param it The item.
15317 * @param state The state to use.
15318 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15320 * If @p state is @c NULL, it won't select any state and the default item's
15321 * icon and label will be used. It's the same behaviour than
15322 * elm_toolbar_item_state_unser().
15324 * @see elm_toolbar_item_state_unset()
15328 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15331 * Unset the state of @p it.
15333 * @param it The item.
15335 * The default icon and label from this item will be displayed.
15337 * @see elm_toolbar_item_state_set() for more details.
15341 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15344 * Get the current state of @p it.
15346 * @param item The item.
15347 * @return The selected state or @c NULL if none is selected or on failure.
15349 * @see elm_toolbar_item_state_set() for details.
15350 * @see elm_toolbar_item_state_unset()
15351 * @see elm_toolbar_item_state_add()
15355 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15358 * Get the state after selected state in toolbar's @p item.
15360 * @param it The toolbar item to change state.
15361 * @return The state after current state, or @c NULL on failure.
15363 * If last state is selected, this function will return first state.
15365 * @see elm_toolbar_item_state_set()
15366 * @see elm_toolbar_item_state_add()
15370 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15373 * Get the state before selected state in toolbar's @p item.
15375 * @param it The toolbar item to change state.
15376 * @return The state before current state, or @c NULL on failure.
15378 * If first state is selected, this function will return last state.
15380 * @see elm_toolbar_item_state_set()
15381 * @see elm_toolbar_item_state_add()
15385 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15388 * Set the text to be shown in a given toolbar item's tooltips.
15390 * @param item Target item.
15391 * @param text The text to set in the content.
15393 * Setup the text as tooltip to object. The item can have only one tooltip,
15394 * so any previous tooltip data - set with this function or
15395 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15397 * @see elm_object_tooltip_text_set() for more details.
15401 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15404 * Set the content to be shown in the tooltip item.
15406 * Setup the tooltip to item. The item can have only one tooltip,
15407 * so any previous tooltip data is removed. @p func(with @p data) will
15408 * be called every time that need show the tooltip and it should
15409 * return a valid Evas_Object. This object is then managed fully by
15410 * tooltip system and is deleted when the tooltip is gone.
15412 * @param item the toolbar item being attached a tooltip.
15413 * @param func the function used to create the tooltip contents.
15414 * @param data what to provide to @a func as callback data/context.
15415 * @param del_cb called when data is not needed anymore, either when
15416 * another callback replaces @a func, the tooltip is unset with
15417 * elm_toolbar_item_tooltip_unset() or the owner @a item
15418 * dies. This callback receives as the first parameter the
15419 * given @a data, and @c event_info is the item.
15421 * @see elm_object_tooltip_content_cb_set() for more details.
15425 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);
15428 * Unset tooltip from item.
15430 * @param item toolbar item to remove previously set tooltip.
15432 * Remove tooltip from item. The callback provided as del_cb to
15433 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15434 * it is not used anymore.
15436 * @see elm_object_tooltip_unset() for more details.
15437 * @see elm_toolbar_item_tooltip_content_cb_set()
15441 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15444 * Sets a different style for this item tooltip.
15446 * @note before you set a style you should define a tooltip with
15447 * elm_toolbar_item_tooltip_content_cb_set() or
15448 * elm_toolbar_item_tooltip_text_set()
15450 * @param item toolbar item with tooltip already set.
15451 * @param style the theme style to use (default, transparent, ...)
15453 * @see elm_object_tooltip_style_set() for more details.
15457 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15460 * Get the style for this item tooltip.
15462 * @param item toolbar item with tooltip already set.
15463 * @return style the theme style in use, defaults to "default". If the
15464 * object does not have a tooltip set, then NULL is returned.
15466 * @see elm_object_tooltip_style_get() for more details.
15467 * @see elm_toolbar_item_tooltip_style_set()
15471 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15474 * Set the type of mouse pointer/cursor decoration to be shown,
15475 * when the mouse pointer is over the given toolbar widget item
15477 * @param item toolbar item to customize cursor on
15478 * @param cursor the cursor type's name
15480 * This function works analogously as elm_object_cursor_set(), but
15481 * here the cursor's changing area is restricted to the item's
15482 * area, and not the whole widget's. Note that that item cursors
15483 * have precedence over widget cursors, so that a mouse over an
15484 * item with custom cursor set will always show @b that cursor.
15486 * If this function is called twice for an object, a previously set
15487 * cursor will be unset on the second call.
15489 * @see elm_object_cursor_set()
15490 * @see elm_toolbar_item_cursor_get()
15491 * @see elm_toolbar_item_cursor_unset()
15495 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15498 * Get the type of mouse pointer/cursor decoration set to be shown,
15499 * when the mouse pointer is over the given toolbar widget item
15501 * @param item toolbar item with custom cursor set
15502 * @return the cursor type's name or @c NULL, if no custom cursors
15503 * were set to @p item (and on errors)
15505 * @see elm_object_cursor_get()
15506 * @see elm_toolbar_item_cursor_set()
15507 * @see elm_toolbar_item_cursor_unset()
15511 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15514 * Unset any custom mouse pointer/cursor decoration set to be
15515 * shown, when the mouse pointer is over the given toolbar widget
15516 * item, thus making it show the @b default cursor again.
15518 * @param item a toolbar item
15520 * Use this call to undo any custom settings on this item's cursor
15521 * decoration, bringing it back to defaults (no custom style set).
15523 * @see elm_object_cursor_unset()
15524 * @see elm_toolbar_item_cursor_set()
15528 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15531 * Set a different @b style for a given custom cursor set for a
15534 * @param item toolbar item with custom cursor set
15535 * @param style the <b>theme style</b> to use (e.g. @c "default",
15536 * @c "transparent", etc)
15538 * This function only makes sense when one is using custom mouse
15539 * cursor decorations <b>defined in a theme file</b>, which can have,
15540 * given a cursor name/type, <b>alternate styles</b> on it. It
15541 * works analogously as elm_object_cursor_style_set(), but here
15542 * applyed only to toolbar item objects.
15544 * @warning Before you set a cursor style you should have definen a
15545 * custom cursor previously on the item, with
15546 * elm_toolbar_item_cursor_set()
15548 * @see elm_toolbar_item_cursor_engine_only_set()
15549 * @see elm_toolbar_item_cursor_style_get()
15553 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15556 * Get the current @b style set for a given toolbar item's custom
15559 * @param item toolbar item with custom cursor set.
15560 * @return style the cursor style in use. If the object does not
15561 * have a cursor set, then @c NULL is returned.
15563 * @see elm_toolbar_item_cursor_style_set() for more details
15567 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15570 * Set if the (custom)cursor for a given toolbar item should be
15571 * searched in its theme, also, or should only rely on the
15572 * rendering engine.
15574 * @param item item with custom (custom) cursor already set on
15575 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15576 * only on those provided by the rendering engine, @c EINA_FALSE to
15577 * have them searched on the widget's theme, as well.
15579 * @note This call is of use only if you've set a custom cursor
15580 * for toolbar items, with elm_toolbar_item_cursor_set().
15582 * @note By default, cursors will only be looked for between those
15583 * provided by the rendering engine.
15587 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15590 * Get if the (custom) cursor for a given toolbar item is being
15591 * searched in its theme, also, or is only relying on the rendering
15594 * @param item a toolbar item
15595 * @return @c EINA_TRUE, if cursors are being looked for only on
15596 * those provided by the rendering engine, @c EINA_FALSE if they
15597 * are being searched on the widget's theme, as well.
15599 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15603 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15606 * Change a toolbar's orientation
15607 * @param obj The toolbar object
15608 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15609 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15611 * @deprecated use elm_toolbar_horizontal_set() instead.
15613 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15616 * Change a toolbar's orientation
15617 * @param obj The toolbar object
15618 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15619 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15622 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15625 * Get a toolbar's orientation
15626 * @param obj The toolbar object
15627 * @return If @c EINA_TRUE, the toolbar is vertical
15628 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15630 * @deprecated use elm_toolbar_horizontal_get() instead.
15632 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15635 * Get a toolbar's orientation
15636 * @param obj The toolbar object
15637 * @return If @c EINA_TRUE, the toolbar is horizontal
15638 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15641 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15647 * @defgroup Tooltips Tooltips
15649 * The Tooltip is an (internal, for now) smart object used to show a
15650 * content in a frame on mouse hover of objects(or widgets), with
15651 * tips/information about them.
15656 EAPI double elm_tooltip_delay_get(void);
15657 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15658 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15659 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15660 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15661 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15662 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15663 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);
15664 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15665 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15666 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15667 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15668 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15675 * @defgroup Cursors Cursors
15677 * The Elementary cursor is an internal smart object used to
15678 * customize the mouse cursor displayed over objects (or
15679 * widgets). In the most common scenario, the cursor decoration
15680 * comes from the graphical @b engine Elementary is running
15681 * on. Those engines may provide different decorations for cursors,
15682 * and Elementary provides functions to choose them (think of X11
15683 * cursors, as an example).
15685 * There's also the possibility of, besides using engine provided
15686 * cursors, also use ones coming from Edje theming files. Both
15687 * globally and per widget, Elementary makes it possible for one to
15688 * make the cursors lookup to be held on engines only or on
15689 * Elementary's theme file, too. To set cursor's hot spot,
15690 * two data items should be added to cursor's theme: "hot_x" and
15691 * "hot_y", that are the offset from upper-left corner of the cursor
15692 * (coordinates 0,0).
15698 * Set the cursor to be shown when mouse is over the object
15700 * Set the cursor that will be displayed when mouse is over the
15701 * object. The object can have only one cursor set to it, so if
15702 * this function is called twice for an object, the previous set
15704 * If using X cursors, a definition of all the valid cursor names
15705 * is listed on Elementary_Cursors.h. If an invalid name is set
15706 * the default cursor will be used.
15708 * @param obj the object being set a cursor.
15709 * @param cursor the cursor name to be used.
15713 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15716 * Get the cursor to be shown when mouse is over the object
15718 * @param obj an object with cursor already set.
15719 * @return the cursor name.
15723 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15726 * Unset cursor for object
15728 * Unset cursor for object, and set the cursor to default if the mouse
15729 * was over this object.
15731 * @param obj Target object
15732 * @see elm_object_cursor_set()
15736 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15739 * Sets a different style for this object cursor.
15741 * @note before you set a style you should define a cursor with
15742 * elm_object_cursor_set()
15744 * @param obj an object with cursor already set.
15745 * @param style the theme style to use (default, transparent, ...)
15749 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15752 * Get the style for this object cursor.
15754 * @param obj an object with cursor already set.
15755 * @return style the theme style in use, defaults to "default". If the
15756 * object does not have a cursor set, then NULL is returned.
15760 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15763 * Set if the cursor set should be searched on the theme or should use
15764 * the provided by the engine, only.
15766 * @note before you set if should look on theme you should define a cursor
15767 * with elm_object_cursor_set(). By default it will only look for cursors
15768 * provided by the engine.
15770 * @param obj an object with cursor already set.
15771 * @param engine_only boolean to define it cursors should be looked only
15772 * between the provided by the engine or searched on widget's theme as well.
15776 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15779 * Get the cursor engine only usage for this object cursor.
15781 * @param obj an object with cursor already set.
15782 * @return engine_only boolean to define it cursors should be
15783 * looked only between the provided by the engine or searched on
15784 * widget's theme as well. If the object does not have a cursor
15785 * set, then EINA_FALSE is returned.
15789 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15792 * Get the configured cursor engine only usage
15794 * This gets the globally configured exclusive usage of engine cursors.
15796 * @return 1 if only engine cursors should be used
15799 EAPI int elm_cursor_engine_only_get(void);
15802 * Set the configured cursor engine only usage
15804 * This sets the globally configured exclusive usage of engine cursors.
15805 * It won't affect cursors set before changing this value.
15807 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15808 * look for them on theme before.
15809 * @return EINA_TRUE if value is valid and setted (0 or 1)
15812 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15819 * @defgroup Menu Menu
15821 * @image html img/widget/menu/preview-00.png
15822 * @image latex img/widget/menu/preview-00.eps
15824 * A menu is a list of items displayed above its parent. When the menu is
15825 * showing its parent is darkened. Each item can have a sub-menu. The menu
15826 * object can be used to display a menu on a right click event, in a toolbar,
15829 * Signals that you can add callbacks for are:
15830 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15831 * event_info is NULL.
15833 * @see @ref tutorial_menu
15836 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15838 * @brief Add a new menu to the parent
15840 * @param parent The parent object.
15841 * @return The new object or NULL if it cannot be created.
15843 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15845 * @brief Set the parent for the given menu widget
15847 * @param obj The menu object.
15848 * @param parent The new parent.
15850 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15852 * @brief Get the parent for the given menu widget
15854 * @param obj The menu object.
15855 * @return The parent.
15857 * @see elm_menu_parent_set()
15859 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15861 * @brief Move the menu to a new position
15863 * @param obj The menu object.
15864 * @param x The new position.
15865 * @param y The new position.
15867 * Sets the top-left position of the menu to (@p x,@p y).
15869 * @note @p x and @p y coordinates are relative to parent.
15871 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15873 * @brief Close a opened menu
15875 * @param obj the menu object
15878 * Hides the menu and all it's sub-menus.
15880 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15882 * @brief Returns a list of @p item's items.
15884 * @param obj The menu object
15885 * @return An Eina_List* of @p item's items
15887 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15889 * @brief Get the Evas_Object of an Elm_Menu_Item
15891 * @param item The menu item object.
15892 * @return The edje object containing the swallowed content
15894 * @warning Don't manipulate this object!
15896 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15898 * @brief Add an item at the end of the given menu widget
15900 * @param obj The menu object.
15901 * @param parent The parent menu item (optional)
15902 * @param icon A icon display on the item. The icon will be destryed by the menu.
15903 * @param label The label of the item.
15904 * @param func Function called when the user select the item.
15905 * @param data Data sent by the callback.
15906 * @return Returns the new item.
15908 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);
15910 * @brief Add an object swallowed in an item at the end of the given menu
15913 * @param obj The menu object.
15914 * @param parent The parent menu item (optional)
15915 * @param subobj The object to swallow
15916 * @param func Function called when the user select the item.
15917 * @param data Data sent by the callback.
15918 * @return Returns the new item.
15920 * Add an evas object as an item to the menu.
15922 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);
15924 * @brief Set the label of a menu item
15926 * @param item The menu item object.
15927 * @param label The label to set for @p item
15929 * @warning Don't use this funcion on items created with
15930 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15932 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15934 * @brief Get the label of a menu item
15936 * @param item The menu item object.
15937 * @return The label of @p item
15939 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15941 * @brief Set the icon of a menu item to the standard icon with name @p icon
15943 * @param item The menu item object.
15944 * @param icon The icon object to set for the content of @p item
15946 * Once this icon is set, any previously set icon will be deleted.
15948 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15950 * @brief Get the string representation from the icon of a menu item
15952 * @param item The menu item object.
15953 * @return The string representation of @p item's icon or NULL
15955 * @see elm_menu_item_object_icon_name_set()
15957 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15959 * @brief Set the content object of a menu item
15961 * @param item The menu item object
15962 * @param The content object or NULL
15963 * @return EINA_TRUE on success, else EINA_FALSE
15965 * Use this function to change the object swallowed by a menu item, deleting
15966 * any previously swallowed object.
15968 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15970 * @brief Get the content object of a menu item
15972 * @param item The menu item object
15973 * @return The content object or NULL
15974 * @note If @p item was added with elm_menu_item_add_object, this
15975 * function will return the object passed, else it will return the
15978 * @see elm_menu_item_object_content_set()
15980 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15982 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15984 elm_menu_item_object_icon_name_set(item, icon);
15987 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15989 return elm_menu_item_object_content_get(item);
15992 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15994 return elm_menu_item_object_icon_name_get(item);
15998 * @brief Set the selected state of @p item.
16000 * @param item The menu item object.
16001 * @param selected The selected/unselected state of the item
16003 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16005 * @brief Get the selected state of @p item.
16007 * @param item The menu item object.
16008 * @return The selected/unselected state of the item
16010 * @see elm_menu_item_selected_set()
16012 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16014 * @brief Set the disabled state of @p item.
16016 * @param item The menu item object.
16017 * @param disabled The enabled/disabled state of the item
16019 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16021 * @brief Get the disabled state of @p item.
16023 * @param item The menu item object.
16024 * @return The enabled/disabled state of the item
16026 * @see elm_menu_item_disabled_set()
16028 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16030 * @brief Add a separator item to menu @p obj under @p parent.
16032 * @param obj The menu object
16033 * @param parent The item to add the separator under
16034 * @return The created item or NULL on failure
16036 * This is item is a @ref Separator.
16038 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16040 * @brief Returns whether @p item is a separator.
16042 * @param item The item to check
16043 * @return If true, @p item is a separator
16045 * @see elm_menu_item_separator_add()
16047 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16049 * @brief Deletes an item from the menu.
16051 * @param item The item to delete.
16053 * @see elm_menu_item_add()
16055 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16057 * @brief Set the function called when a menu item is deleted.
16059 * @param item The item to set the callback on
16060 * @param func The function called
16062 * @see elm_menu_item_add()
16063 * @see elm_menu_item_del()
16065 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16067 * @brief Returns the data associated with menu item @p item.
16069 * @param item The item
16070 * @return The data associated with @p item or NULL if none was set.
16072 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16074 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16076 * @brief Sets the data to be associated with menu item @p item.
16078 * @param item The item
16079 * @param data The data to be associated with @p item
16081 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16083 * @brief Returns a list of @p item's subitems.
16085 * @param item The item
16086 * @return An Eina_List* of @p item's subitems
16088 * @see elm_menu_add()
16090 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16092 * @brief Get the position of a menu item
16094 * @param item The menu item
16095 * @return The item's index
16097 * This function returns the index position of a menu item in a menu.
16098 * For a sub-menu, this number is relative to the first item in the sub-menu.
16100 * @note Index values begin with 0
16102 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16104 * @brief @brief Return a menu item's owner menu
16106 * @param item The menu item
16107 * @return The menu object owning @p item, or NULL on failure
16109 * Use this function to get the menu object owning an item.
16111 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16113 * @brief Get the selected item in the menu
16115 * @param obj The menu object
16116 * @return The selected item, or NULL if none
16118 * @see elm_menu_item_selected_get()
16119 * @see elm_menu_item_selected_set()
16121 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16123 * @brief Get the last item in the menu
16125 * @param obj The menu object
16126 * @return The last item, or NULL if none
16128 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16130 * @brief Get the first item in the menu
16132 * @param obj The menu object
16133 * @return The first item, or NULL if none
16135 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16137 * @brief Get the next item in the menu.
16139 * @param item The menu item object.
16140 * @return The item after it, or NULL if none
16142 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16144 * @brief Get the previous item in the menu.
16146 * @param item The menu item object.
16147 * @return The item before it, or NULL if none
16149 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16155 * @defgroup List List
16156 * @ingroup Elementary
16158 * @image html img/widget/list/preview-00.png
16159 * @image latex img/widget/list/preview-00.eps width=\textwidth
16161 * @image html img/list.png
16162 * @image latex img/list.eps width=\textwidth
16164 * A list widget is a container whose children are displayed vertically or
16165 * horizontally, in order, and can be selected.
16166 * The list can accept only one or multiple items selection. Also has many
16167 * modes of items displaying.
16169 * A list is a very simple type of list widget. For more robust
16170 * lists, @ref Genlist should probably be used.
16172 * Smart callbacks one can listen to:
16173 * - @c "activated" - The user has double-clicked or pressed
16174 * (enter|return|spacebar) on an item. The @c event_info parameter
16175 * is the item that was activated.
16176 * - @c "clicked,double" - The user has double-clicked an item.
16177 * The @c event_info parameter is the item that was double-clicked.
16178 * - "selected" - when the user selected an item
16179 * - "unselected" - when the user unselected an item
16180 * - "longpressed" - an item in the list is long-pressed
16181 * - "edge,top" - the list is scrolled until the top edge
16182 * - "edge,bottom" - the list is scrolled until the bottom edge
16183 * - "edge,left" - the list is scrolled until the left edge
16184 * - "edge,right" - the list is scrolled until the right edge
16185 * - "language,changed" - the program's language changed
16187 * Available styles for it:
16190 * List of examples:
16191 * @li @ref list_example_01
16192 * @li @ref list_example_02
16193 * @li @ref list_example_03
16202 * @enum _Elm_List_Mode
16203 * @typedef Elm_List_Mode
16205 * Set list's resize behavior, transverse axis scroll and
16206 * items cropping. See each mode's description for more details.
16208 * @note Default value is #ELM_LIST_SCROLL.
16210 * Values <b> don't </b> work as bitmask, only one can be choosen.
16212 * @see elm_list_mode_set()
16213 * @see elm_list_mode_get()
16217 typedef enum _Elm_List_Mode
16219 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. */
16220 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). */
16221 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. */
16222 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. */
16223 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16226 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(). */
16229 * Add a new list widget to the given parent Elementary
16230 * (container) object.
16232 * @param parent The parent object.
16233 * @return a new list widget handle or @c NULL, on errors.
16235 * This function inserts a new list widget on the canvas.
16239 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16244 * @param obj The list object
16246 * @note Call before running show() on the list object.
16247 * @warning If not called, it won't display the list properly.
16250 * li = elm_list_add(win);
16251 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16252 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16254 * evas_object_show(li);
16259 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16262 * Enable or disable multiple items selection on the list object.
16264 * @param obj The list object
16265 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16268 * Disabled by default. If disabled, the user can select a single item of
16269 * the list each time. Selected items are highlighted on list.
16270 * If enabled, many items can be selected.
16272 * If a selected item is selected again, it will be unselected.
16274 * @see elm_list_multi_select_get()
16278 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16281 * Get a value whether multiple items selection is enabled or not.
16283 * @see elm_list_multi_select_set() for details.
16285 * @param obj The list object.
16286 * @return @c EINA_TRUE means multiple items selection is enabled.
16287 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16288 * @c EINA_FALSE is returned.
16292 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16295 * Set which mode to use for the list object.
16297 * @param obj The list object
16298 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16299 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16301 * Set list's resize behavior, transverse axis scroll and
16302 * items cropping. See each mode's description for more details.
16304 * @note Default value is #ELM_LIST_SCROLL.
16306 * Only one can be set, if a previous one was set, it will be changed
16307 * by the new mode set. Bitmask won't work as well.
16309 * @see elm_list_mode_get()
16313 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16316 * Get the mode the list is at.
16318 * @param obj The list object
16319 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16320 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16322 * @note see elm_list_mode_set() for more information.
16326 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16329 * Enable or disable horizontal mode on the list object.
16331 * @param obj The list object.
16332 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16333 * disable it, i.e., to enable vertical mode.
16335 * @note Vertical mode is set by default.
16337 * On horizontal mode items are displayed on list from left to right,
16338 * instead of from top to bottom. Also, the list will scroll horizontally.
16339 * Each item will presents left icon on top and right icon, or end, at
16342 * @see elm_list_horizontal_get()
16346 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16349 * Get a value whether horizontal mode is enabled or not.
16351 * @param obj The list object.
16352 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16353 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16354 * @c EINA_FALSE is returned.
16356 * @see elm_list_horizontal_set() for details.
16360 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16363 * Enable or disable always select mode on the list object.
16365 * @param obj The list object
16366 * @param always_select @c EINA_TRUE to enable always select mode or
16367 * @c EINA_FALSE to disable it.
16369 * @note Always select mode is disabled by default.
16371 * Default behavior of list items is to only call its callback function
16372 * the first time it's pressed, i.e., when it is selected. If a selected
16373 * item is pressed again, and multi-select is disabled, it won't call
16374 * this function (if multi-select is enabled it will unselect the item).
16376 * If always select is enabled, it will call the callback function
16377 * everytime a item is pressed, so it will call when the item is selected,
16378 * and again when a selected item is pressed.
16380 * @see elm_list_always_select_mode_get()
16381 * @see elm_list_multi_select_set()
16385 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16388 * Get a value whether always select mode is enabled or not, meaning that
16389 * an item will always call its callback function, even if already selected.
16391 * @param obj The list object
16392 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16393 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16394 * @c EINA_FALSE is returned.
16396 * @see elm_list_always_select_mode_set() for details.
16400 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16403 * Set bouncing behaviour when the scrolled content reaches an edge.
16405 * Tell the internal scroller object whether it should bounce or not
16406 * when it reaches the respective edges for each axis.
16408 * @param obj The list object
16409 * @param h_bounce Whether to bounce or not in the horizontal axis.
16410 * @param v_bounce Whether to bounce or not in the vertical axis.
16412 * @see elm_scroller_bounce_set()
16416 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16419 * Get the bouncing behaviour of the internal scroller.
16421 * Get whether the internal scroller should bounce when the edge of each
16422 * axis is reached scrolling.
16424 * @param obj The list object.
16425 * @param h_bounce Pointer where to store the bounce state of the horizontal
16427 * @param v_bounce Pointer where to store the bounce state of the vertical
16430 * @see elm_scroller_bounce_get()
16431 * @see elm_list_bounce_set()
16435 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16438 * Set the scrollbar policy.
16440 * @param obj The list object
16441 * @param policy_h Horizontal scrollbar policy.
16442 * @param policy_v Vertical scrollbar policy.
16444 * This sets the scrollbar visibility policy for the given scroller.
16445 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16446 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16447 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16448 * This applies respectively for the horizontal and vertical scrollbars.
16450 * The both are disabled by default, i.e., are set to
16451 * #ELM_SCROLLER_POLICY_OFF.
16455 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16458 * Get the scrollbar policy.
16460 * @see elm_list_scroller_policy_get() for details.
16462 * @param obj The list object.
16463 * @param policy_h Pointer where to store horizontal scrollbar policy.
16464 * @param policy_v Pointer where to store vertical scrollbar policy.
16468 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);
16471 * Append a new item to the list object.
16473 * @param obj The list object.
16474 * @param label The label of the list item.
16475 * @param icon The icon object to use for the left side of the item. An
16476 * icon can be any Evas object, but usually it is an icon created
16477 * with elm_icon_add().
16478 * @param end The icon object to use for the right side of the item. An
16479 * icon can be any Evas object.
16480 * @param func The function to call when the item is clicked.
16481 * @param data The data to associate with the item for related callbacks.
16483 * @return The created item or @c NULL upon failure.
16485 * A new item will be created and appended to the list, i.e., will
16486 * be set as @b last item.
16488 * Items created with this method can be deleted with
16489 * elm_list_item_del().
16491 * Associated @p data can be properly freed when item is deleted if a
16492 * callback function is set with elm_list_item_del_cb_set().
16494 * If a function is passed as argument, it will be called everytime this item
16495 * is selected, i.e., the user clicks over an unselected item.
16496 * If always select is enabled it will call this function every time
16497 * user clicks over an item (already selected or not).
16498 * If such function isn't needed, just passing
16499 * @c NULL as @p func is enough. The same should be done for @p data.
16501 * Simple example (with no function callback or data associated):
16503 * li = elm_list_add(win);
16504 * ic = elm_icon_add(win);
16505 * elm_icon_file_set(ic, "path/to/image", NULL);
16506 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16507 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16509 * evas_object_show(li);
16512 * @see elm_list_always_select_mode_set()
16513 * @see elm_list_item_del()
16514 * @see elm_list_item_del_cb_set()
16515 * @see elm_list_clear()
16516 * @see elm_icon_add()
16520 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);
16523 * Prepend a new item to the list object.
16525 * @param obj The list object.
16526 * @param label The label of the list item.
16527 * @param icon The icon object to use for the left side of the item. An
16528 * icon can be any Evas object, but usually it is an icon created
16529 * with elm_icon_add().
16530 * @param end The icon object to use for the right side of the item. An
16531 * icon can be any Evas object.
16532 * @param func The function to call when the item is clicked.
16533 * @param data The data to associate with the item for related callbacks.
16535 * @return The created item or @c NULL upon failure.
16537 * A new item will be created and prepended to the list, i.e., will
16538 * be set as @b first item.
16540 * Items created with this method can be deleted with
16541 * elm_list_item_del().
16543 * Associated @p data can be properly freed when item is deleted if a
16544 * callback function is set with elm_list_item_del_cb_set().
16546 * If a function is passed as argument, it will be called everytime this item
16547 * is selected, i.e., the user clicks over an unselected item.
16548 * If always select is enabled it will call this function every time
16549 * user clicks over an item (already selected or not).
16550 * If such function isn't needed, just passing
16551 * @c NULL as @p func is enough. The same should be done for @p data.
16553 * @see elm_list_item_append() for a simple code example.
16554 * @see elm_list_always_select_mode_set()
16555 * @see elm_list_item_del()
16556 * @see elm_list_item_del_cb_set()
16557 * @see elm_list_clear()
16558 * @see elm_icon_add()
16562 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);
16565 * Insert a new item into the list object before item @p before.
16567 * @param obj The list object.
16568 * @param before The list item to insert before.
16569 * @param label The label of the list item.
16570 * @param icon The icon object to use for the left side of the item. An
16571 * icon can be any Evas object, but usually it is an icon created
16572 * with elm_icon_add().
16573 * @param end The icon object to use for the right side of the item. An
16574 * icon can be any Evas object.
16575 * @param func The function to call when the item is clicked.
16576 * @param data The data to associate with the item for related callbacks.
16578 * @return The created item or @c NULL upon failure.
16580 * A new item will be created and added to the list. Its position in
16581 * this list will be just before item @p before.
16583 * Items created with this method can be deleted with
16584 * elm_list_item_del().
16586 * Associated @p data can be properly freed when item is deleted if a
16587 * callback function is set with elm_list_item_del_cb_set().
16589 * If a function is passed as argument, it will be called everytime this item
16590 * is selected, i.e., the user clicks over an unselected item.
16591 * If always select is enabled it will call this function every time
16592 * user clicks over an item (already selected or not).
16593 * If such function isn't needed, just passing
16594 * @c NULL as @p func is enough. The same should be done for @p data.
16596 * @see elm_list_item_append() for a simple code example.
16597 * @see elm_list_always_select_mode_set()
16598 * @see elm_list_item_del()
16599 * @see elm_list_item_del_cb_set()
16600 * @see elm_list_clear()
16601 * @see elm_icon_add()
16605 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);
16608 * Insert a new item into the list object after item @p after.
16610 * @param obj The list object.
16611 * @param after The list item to insert after.
16612 * @param label The label of the list item.
16613 * @param icon The icon object to use for the left side of the item. An
16614 * icon can be any Evas object, but usually it is an icon created
16615 * with elm_icon_add().
16616 * @param end The icon object to use for the right side of the item. An
16617 * icon can be any Evas object.
16618 * @param func The function to call when the item is clicked.
16619 * @param data The data to associate with the item for related callbacks.
16621 * @return The created item or @c NULL upon failure.
16623 * A new item will be created and added to the list. Its position in
16624 * this list will be just after item @p after.
16626 * Items created with this method can be deleted with
16627 * elm_list_item_del().
16629 * Associated @p data can be properly freed when item is deleted if a
16630 * callback function is set with elm_list_item_del_cb_set().
16632 * If a function is passed as argument, it will be called everytime this item
16633 * is selected, i.e., the user clicks over an unselected item.
16634 * If always select is enabled it will call this function every time
16635 * user clicks over an item (already selected or not).
16636 * If such function isn't needed, just passing
16637 * @c NULL as @p func is enough. The same should be done for @p data.
16639 * @see elm_list_item_append() for a simple code example.
16640 * @see elm_list_always_select_mode_set()
16641 * @see elm_list_item_del()
16642 * @see elm_list_item_del_cb_set()
16643 * @see elm_list_clear()
16644 * @see elm_icon_add()
16648 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);
16651 * Insert a new item into the sorted list object.
16653 * @param obj The list object.
16654 * @param label The label of the list item.
16655 * @param icon The icon object to use for the left side of the item. An
16656 * icon can be any Evas object, but usually it is an icon created
16657 * with elm_icon_add().
16658 * @param end The icon object to use for the right side of the item. An
16659 * icon can be any Evas object.
16660 * @param func The function to call when the item is clicked.
16661 * @param data The data to associate with the item for related callbacks.
16662 * @param cmp_func The comparing function to be used to sort list
16663 * items <b>by #Elm_List_Item item handles</b>. This function will
16664 * receive two items and compare them, returning a non-negative integer
16665 * if the second item should be place after the first, or negative value
16666 * if should be placed before.
16668 * @return The created item or @c NULL upon failure.
16670 * @note This function inserts values into a list object assuming it was
16671 * sorted and the result will be sorted.
16673 * A new item will be created and added to the list. Its position in
16674 * this list will be found comparing the new item with previously inserted
16675 * items using function @p cmp_func.
16677 * Items created with this method can be deleted with
16678 * elm_list_item_del().
16680 * Associated @p data can be properly freed when item is deleted if a
16681 * callback function is set with elm_list_item_del_cb_set().
16683 * If a function is passed as argument, it will be called everytime this item
16684 * is selected, i.e., the user clicks over an unselected item.
16685 * If always select is enabled it will call this function every time
16686 * user clicks over an item (already selected or not).
16687 * If such function isn't needed, just passing
16688 * @c NULL as @p func is enough. The same should be done for @p data.
16690 * @see elm_list_item_append() for a simple code example.
16691 * @see elm_list_always_select_mode_set()
16692 * @see elm_list_item_del()
16693 * @see elm_list_item_del_cb_set()
16694 * @see elm_list_clear()
16695 * @see elm_icon_add()
16699 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);
16702 * Remove all list's items.
16704 * @param obj The list object
16706 * @see elm_list_item_del()
16707 * @see elm_list_item_append()
16711 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16714 * Get a list of all the list items.
16716 * @param obj The list object
16717 * @return An @c Eina_List of list items, #Elm_List_Item,
16718 * or @c NULL on failure.
16720 * @see elm_list_item_append()
16721 * @see elm_list_item_del()
16722 * @see elm_list_clear()
16726 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16729 * Get the selected item.
16731 * @param obj The list object.
16732 * @return The selected list item.
16734 * The selected item can be unselected with function
16735 * elm_list_item_selected_set().
16737 * The selected item always will be highlighted on list.
16739 * @see elm_list_selected_items_get()
16743 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16746 * Return a list of the currently selected list items.
16748 * @param obj The list object.
16749 * @return An @c Eina_List of list items, #Elm_List_Item,
16750 * or @c NULL on failure.
16752 * Multiple items can be selected if multi select is enabled. It can be
16753 * done with elm_list_multi_select_set().
16755 * @see elm_list_selected_item_get()
16756 * @see elm_list_multi_select_set()
16760 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16763 * Set the selected state of an item.
16765 * @param item The list item
16766 * @param selected The selected state
16768 * This sets the selected state of the given item @p it.
16769 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16771 * If a new item is selected the previosly selected will be unselected,
16772 * unless multiple selection is enabled with elm_list_multi_select_set().
16773 * Previoulsy selected item can be get with function
16774 * elm_list_selected_item_get().
16776 * Selected items will be highlighted.
16778 * @see elm_list_item_selected_get()
16779 * @see elm_list_selected_item_get()
16780 * @see elm_list_multi_select_set()
16784 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16787 * Get whether the @p item is selected or not.
16789 * @param item The list item.
16790 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16791 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16793 * @see elm_list_selected_item_set() for details.
16794 * @see elm_list_item_selected_get()
16798 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16801 * Set or unset item as a separator.
16803 * @param it The list item.
16804 * @param setting @c EINA_TRUE to set item @p it as separator or
16805 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16807 * Items aren't set as separator by default.
16809 * If set as separator it will display separator theme, so won't display
16812 * @see elm_list_item_separator_get()
16816 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16819 * Get a value whether item is a separator or not.
16821 * @see elm_list_item_separator_set() for details.
16823 * @param it The list item.
16824 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16825 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16829 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16832 * Show @p item in the list view.
16834 * @param item The list item to be shown.
16836 * It won't animate list until item is visible. If such behavior is wanted,
16837 * use elm_list_bring_in() intead.
16841 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16844 * Bring in the given item to list view.
16846 * @param item The item.
16848 * This causes list to jump to the given item @p item and show it
16849 * (by scrolling), if it is not fully visible.
16851 * This may use animation to do so and take a period of time.
16853 * If animation isn't wanted, elm_list_item_show() can be used.
16857 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16860 * Delete them item from the list.
16862 * @param item The item of list to be deleted.
16864 * If deleting all list items is required, elm_list_clear()
16865 * should be used instead of getting items list and deleting each one.
16867 * @see elm_list_clear()
16868 * @see elm_list_item_append()
16869 * @see elm_list_item_del_cb_set()
16873 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16876 * Set the function called when a list item is freed.
16878 * @param item The item to set the callback on
16879 * @param func The function called
16881 * If there is a @p func, then it will be called prior item's memory release.
16882 * That will be called with the following arguments:
16884 * @li item's Evas object;
16887 * This way, a data associated to a list item could be properly freed.
16891 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16894 * Get the data associated to the item.
16896 * @param item The list item
16897 * @return The data associated to @p item
16899 * The return value is a pointer to data associated to @p item when it was
16900 * created, with function elm_list_item_append() or similar. If no data
16901 * was passed as argument, it will return @c NULL.
16903 * @see elm_list_item_append()
16907 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16910 * Get the left side icon associated to the item.
16912 * @param item The list item
16913 * @return The left side icon associated to @p item
16915 * The return value is a pointer to the icon associated to @p item when
16917 * created, with function elm_list_item_append() or similar, or later
16918 * with function elm_list_item_icon_set(). If no icon
16919 * was passed as argument, it will return @c NULL.
16921 * @see elm_list_item_append()
16922 * @see elm_list_item_icon_set()
16926 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16929 * Set the left side icon associated to the item.
16931 * @param item The list item
16932 * @param icon The left side icon object to associate with @p item
16934 * The icon object to use at left side of the item. An
16935 * icon can be any Evas object, but usually it is an icon created
16936 * with elm_icon_add().
16938 * Once the icon object is set, a previously set one will be deleted.
16939 * @warning Setting the same icon for two items will cause the icon to
16940 * dissapear from the first item.
16942 * If an icon was passed as argument on item creation, with function
16943 * elm_list_item_append() or similar, it will be already
16944 * associated to the item.
16946 * @see elm_list_item_append()
16947 * @see elm_list_item_icon_get()
16951 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16954 * Get the right side icon associated to the item.
16956 * @param item The list item
16957 * @return The right side icon associated to @p item
16959 * The return value is a pointer to the icon associated to @p item when
16961 * created, with function elm_list_item_append() or similar, or later
16962 * with function elm_list_item_icon_set(). If no icon
16963 * was passed as argument, it will return @c NULL.
16965 * @see elm_list_item_append()
16966 * @see elm_list_item_icon_set()
16970 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16973 * Set the right side icon associated to the item.
16975 * @param item The list item
16976 * @param end The right side icon object to associate with @p item
16978 * The icon object to use at right side of the item. An
16979 * icon can be any Evas object, but usually it is an icon created
16980 * with elm_icon_add().
16982 * Once the icon object is set, a previously set one will be deleted.
16983 * @warning Setting the same icon for two items will cause the icon to
16984 * dissapear from the first item.
16986 * If an icon was passed as argument on item creation, with function
16987 * elm_list_item_append() or similar, it will be already
16988 * associated to the item.
16990 * @see elm_list_item_append()
16991 * @see elm_list_item_end_get()
16995 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16996 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16999 * Gets the base object of the item.
17001 * @param item The list item
17002 * @return The base object associated with @p item
17004 * Base object is the @c Evas_Object that represents that item.
17008 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17011 * Get the label of item.
17013 * @param item The item of list.
17014 * @return The label of item.
17016 * The return value is a pointer to the label associated to @p item when
17017 * it was created, with function elm_list_item_append(), or later
17018 * with function elm_list_item_label_set. If no label
17019 * was passed as argument, it will return @c NULL.
17021 * @see elm_list_item_label_set() for more details.
17022 * @see elm_list_item_append()
17026 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17029 * Set the label of item.
17031 * @param item The item of list.
17032 * @param text The label of item.
17034 * The label to be displayed by the item.
17035 * Label will be placed between left and right side icons (if set).
17037 * If a label was passed as argument on item creation, with function
17038 * elm_list_item_append() or similar, it will be already
17039 * displayed by the item.
17041 * @see elm_list_item_label_get()
17042 * @see elm_list_item_append()
17046 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17050 * Get the item before @p it in list.
17052 * @param it The list item.
17053 * @return The item before @p it, or @c NULL if none or on failure.
17055 * @note If it is the first item, @c NULL will be returned.
17057 * @see elm_list_item_append()
17058 * @see elm_list_items_get()
17062 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17065 * Get the item after @p it in list.
17067 * @param it The list item.
17068 * @return The item after @p it, or @c NULL if none or on failure.
17070 * @note If it is the last item, @c NULL will be returned.
17072 * @see elm_list_item_append()
17073 * @see elm_list_items_get()
17077 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17080 * Sets the disabled/enabled state of a list item.
17082 * @param it The item.
17083 * @param disabled The disabled state.
17085 * A disabled item cannot be selected or unselected. It will also
17086 * change its appearance (generally greyed out). This sets the
17087 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17092 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17095 * Get a value whether list item is disabled or not.
17097 * @param it The item.
17098 * @return The disabled state.
17100 * @see elm_list_item_disabled_set() for more details.
17104 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17107 * Set the text to be shown in a given list item's tooltips.
17109 * @param item Target item.
17110 * @param text The text to set in the content.
17112 * Setup the text as tooltip to object. The item can have only one tooltip,
17113 * so any previous tooltip data - set with this function or
17114 * elm_list_item_tooltip_content_cb_set() - is removed.
17116 * @see elm_object_tooltip_text_set() for more details.
17120 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17124 * @brief Disable size restrictions on an object's tooltip
17125 * @param item The tooltip's anchor object
17126 * @param disable If EINA_TRUE, size restrictions are disabled
17127 * @return EINA_FALSE on failure, EINA_TRUE on success
17129 * This function allows a tooltip to expand beyond its parant window's canvas.
17130 * It will instead be limited only by the size of the display.
17132 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17134 * @brief Retrieve size restriction state of an object's tooltip
17135 * @param obj The tooltip's anchor object
17136 * @return If EINA_TRUE, size restrictions are disabled
17138 * This function returns whether a tooltip is allowed to expand beyond
17139 * its parant window's canvas.
17140 * It will instead be limited only by the size of the display.
17142 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17145 * Set the content to be shown in the tooltip item.
17147 * Setup the tooltip to item. The item can have only one tooltip,
17148 * so any previous tooltip data is removed. @p func(with @p data) will
17149 * be called every time that need show the tooltip and it should
17150 * return a valid Evas_Object. This object is then managed fully by
17151 * tooltip system and is deleted when the tooltip is gone.
17153 * @param item the list item being attached a tooltip.
17154 * @param func the function used to create the tooltip contents.
17155 * @param data what to provide to @a func as callback data/context.
17156 * @param del_cb called when data is not needed anymore, either when
17157 * another callback replaces @a func, the tooltip is unset with
17158 * elm_list_item_tooltip_unset() or the owner @a item
17159 * dies. This callback receives as the first parameter the
17160 * given @a data, and @c event_info is the item.
17162 * @see elm_object_tooltip_content_cb_set() for more details.
17166 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);
17169 * Unset tooltip from item.
17171 * @param item list item to remove previously set tooltip.
17173 * Remove tooltip from item. The callback provided as del_cb to
17174 * elm_list_item_tooltip_content_cb_set() will be called to notify
17175 * it is not used anymore.
17177 * @see elm_object_tooltip_unset() for more details.
17178 * @see elm_list_item_tooltip_content_cb_set()
17182 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17185 * Sets a different style for this item tooltip.
17187 * @note before you set a style you should define a tooltip with
17188 * elm_list_item_tooltip_content_cb_set() or
17189 * elm_list_item_tooltip_text_set()
17191 * @param item list item with tooltip already set.
17192 * @param style the theme style to use (default, transparent, ...)
17194 * @see elm_object_tooltip_style_set() for more details.
17198 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17201 * Get the style for this item tooltip.
17203 * @param item list item with tooltip already set.
17204 * @return style the theme style in use, defaults to "default". If the
17205 * object does not have a tooltip set, then NULL is returned.
17207 * @see elm_object_tooltip_style_get() for more details.
17208 * @see elm_list_item_tooltip_style_set()
17212 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17215 * Set the type of mouse pointer/cursor decoration to be shown,
17216 * when the mouse pointer is over the given list widget item
17218 * @param item list item to customize cursor on
17219 * @param cursor the cursor type's name
17221 * This function works analogously as elm_object_cursor_set(), but
17222 * here the cursor's changing area is restricted to the item's
17223 * area, and not the whole widget's. Note that that item cursors
17224 * have precedence over widget cursors, so that a mouse over an
17225 * item with custom cursor set will always show @b that cursor.
17227 * If this function is called twice for an object, a previously set
17228 * cursor will be unset on the second call.
17230 * @see elm_object_cursor_set()
17231 * @see elm_list_item_cursor_get()
17232 * @see elm_list_item_cursor_unset()
17236 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17239 * Get the type of mouse pointer/cursor decoration set to be shown,
17240 * when the mouse pointer is over the given list widget item
17242 * @param item list item with custom cursor set
17243 * @return the cursor type's name or @c NULL, if no custom cursors
17244 * were set to @p item (and on errors)
17246 * @see elm_object_cursor_get()
17247 * @see elm_list_item_cursor_set()
17248 * @see elm_list_item_cursor_unset()
17252 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17255 * Unset any custom mouse pointer/cursor decoration set to be
17256 * shown, when the mouse pointer is over the given list widget
17257 * item, thus making it show the @b default cursor again.
17259 * @param item a list item
17261 * Use this call to undo any custom settings on this item's cursor
17262 * decoration, bringing it back to defaults (no custom style set).
17264 * @see elm_object_cursor_unset()
17265 * @see elm_list_item_cursor_set()
17269 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17272 * Set a different @b style for a given custom cursor set for a
17275 * @param item list item with custom cursor set
17276 * @param style the <b>theme style</b> to use (e.g. @c "default",
17277 * @c "transparent", etc)
17279 * This function only makes sense when one is using custom mouse
17280 * cursor decorations <b>defined in a theme file</b>, which can have,
17281 * given a cursor name/type, <b>alternate styles</b> on it. It
17282 * works analogously as elm_object_cursor_style_set(), but here
17283 * applyed only to list item objects.
17285 * @warning Before you set a cursor style you should have definen a
17286 * custom cursor previously on the item, with
17287 * elm_list_item_cursor_set()
17289 * @see elm_list_item_cursor_engine_only_set()
17290 * @see elm_list_item_cursor_style_get()
17294 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17297 * Get the current @b style set for a given list item's custom
17300 * @param item list item with custom cursor set.
17301 * @return style the cursor style in use. If the object does not
17302 * have a cursor set, then @c NULL is returned.
17304 * @see elm_list_item_cursor_style_set() for more details
17308 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17311 * Set if the (custom)cursor for a given list item should be
17312 * searched in its theme, also, or should only rely on the
17313 * rendering engine.
17315 * @param item item with custom (custom) cursor already set on
17316 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17317 * only on those provided by the rendering engine, @c EINA_FALSE to
17318 * have them searched on the widget's theme, as well.
17320 * @note This call is of use only if you've set a custom cursor
17321 * for list items, with elm_list_item_cursor_set().
17323 * @note By default, cursors will only be looked for between those
17324 * provided by the rendering engine.
17328 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17331 * Get if the (custom) cursor for a given list item is being
17332 * searched in its theme, also, or is only relying on the rendering
17335 * @param item a list item
17336 * @return @c EINA_TRUE, if cursors are being looked for only on
17337 * those provided by the rendering engine, @c EINA_FALSE if they
17338 * are being searched on the widget's theme, as well.
17340 * @see elm_list_item_cursor_engine_only_set(), for more details
17344 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17351 * @defgroup Slider Slider
17352 * @ingroup Elementary
17354 * @image html img/widget/slider/preview-00.png
17355 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17357 * The slider adds a dragable āsliderā widget for selecting the value of
17358 * something within a range.
17360 * A slider can be horizontal or vertical. It can contain an Icon and has a
17361 * primary label as well as a units label (that is formatted with floating
17362 * point values and thus accepts a printf-style format string, like
17363 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17364 * else (like on the slider itself) that also accepts a format string like
17365 * units. Label, Icon Unit and Indicator strings/objects are optional.
17367 * A slider may be inverted which means values invert, with high vales being
17368 * on the left or top and low values on the right or bottom (as opposed to
17369 * normally being low on the left or top and high on the bottom and right).
17371 * The slider should have its minimum and maximum values set by the
17372 * application with elm_slider_min_max_set() and value should also be set by
17373 * the application before use with elm_slider_value_set(). The span of the
17374 * slider is its length (horizontally or vertically). This will be scaled by
17375 * the object or applications scaling factor. At any point code can query the
17376 * slider for its value with elm_slider_value_get().
17378 * Smart callbacks one can listen to:
17379 * - "changed" - Whenever the slider value is changed by the user.
17380 * - "slider,drag,start" - dragging the slider indicator around has started.
17381 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17382 * - "delay,changed" - A short time after the value is changed by the user.
17383 * This will be called only when the user stops dragging for
17384 * a very short period or when they release their
17385 * finger/mouse, so it avoids possibly expensive reactions to
17386 * the value change.
17388 * Available styles for it:
17391 * Default contents parts of the slider widget that you can use for are:
17392 * @li "icon" - A icon of the slider
17393 * @li "end" - A end part content of the slider
17395 * Default text parts of the silder widget that you can use for are:
17396 * @li "default" - Label of the silder
17397 * Here is an example on its usage:
17398 * @li @ref slider_example
17402 * @addtogroup Slider
17407 * Add a new slider widget to the given parent Elementary
17408 * (container) object.
17410 * @param parent The parent object.
17411 * @return a new slider widget handle or @c NULL, on errors.
17413 * This function inserts a new slider widget on the canvas.
17417 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17420 * Set the label of a given slider widget
17422 * @param obj The progress bar object
17423 * @param label The text label string, in UTF-8
17426 * @deprecated use elm_object_text_set() instead.
17428 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17431 * Get the label of a given slider widget
17433 * @param obj The progressbar object
17434 * @return The text label string, in UTF-8
17437 * @deprecated use elm_object_text_get() instead.
17439 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17442 * Set the icon object of the slider object.
17444 * @param obj The slider object.
17445 * @param icon The icon object.
17447 * On horizontal mode, icon is placed at left, and on vertical mode,
17450 * @note Once the icon object is set, a previously set one will be deleted.
17451 * If you want to keep that old content object, use the
17452 * elm_slider_icon_unset() function.
17454 * @warning If the object being set does not have minimum size hints set,
17455 * it won't get properly displayed.
17458 * @deprecated use elm_object_part_content_set() instead.
17460 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17463 * Unset an icon set on a given slider widget.
17465 * @param obj The slider object.
17466 * @return The icon object that was being used, if any was set, or
17467 * @c NULL, otherwise (and on errors).
17469 * On horizontal mode, icon is placed at left, and on vertical mode,
17472 * This call will unparent and return the icon object which was set
17473 * for this widget, previously, on success.
17475 * @see elm_slider_icon_set() for more details
17476 * @see elm_slider_icon_get()
17477 * @deprecated use elm_object_part_content_unset() instead.
17481 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17484 * Retrieve the icon object set for a given slider widget.
17486 * @param obj The slider object.
17487 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17488 * otherwise (and on errors).
17490 * On horizontal mode, icon is placed at left, and on vertical mode,
17493 * @see elm_slider_icon_set() for more details
17494 * @see elm_slider_icon_unset()
17496 * @deprecated use elm_object_part_content_get() instead.
17500 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17503 * Set the end object of the slider object.
17505 * @param obj The slider object.
17506 * @param end The end object.
17508 * On horizontal mode, end is placed at left, and on vertical mode,
17509 * placed at bottom.
17511 * @note Once the icon object is set, a previously set one will be deleted.
17512 * If you want to keep that old content object, use the
17513 * elm_slider_end_unset() function.
17515 * @warning If the object being set does not have minimum size hints set,
17516 * it won't get properly displayed.
17518 * @deprecated use elm_object_part_content_set() instead.
17522 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17525 * Unset an end object set on a given slider widget.
17527 * @param obj The slider object.
17528 * @return The end object that was being used, if any was set, or
17529 * @c NULL, otherwise (and on errors).
17531 * On horizontal mode, end is placed at left, and on vertical mode,
17532 * placed at bottom.
17534 * This call will unparent and return the icon object which was set
17535 * for this widget, previously, on success.
17537 * @see elm_slider_end_set() for more details.
17538 * @see elm_slider_end_get()
17540 * @deprecated use elm_object_part_content_unset() instead
17545 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17548 * Retrieve the end object set for a given slider widget.
17550 * @param obj The slider object.
17551 * @return The end object's handle, if @p obj had one set, or @c NULL,
17552 * otherwise (and on errors).
17554 * On horizontal mode, icon is placed at right, and on vertical mode,
17555 * placed at bottom.
17557 * @see elm_slider_end_set() for more details.
17558 * @see elm_slider_end_unset()
17561 * @deprecated use elm_object_part_content_get() instead
17566 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17569 * Set the (exact) length of the bar region of a given slider widget.
17571 * @param obj The slider object.
17572 * @param size The length of the slider's bar region.
17574 * This sets the minimum width (when in horizontal mode) or height
17575 * (when in vertical mode) of the actual bar area of the slider
17576 * @p obj. This in turn affects the object's minimum size. Use
17577 * this when you're not setting other size hints expanding on the
17578 * given direction (like weight and alignment hints) and you would
17579 * like it to have a specific size.
17581 * @note Icon, end, label, indicator and unit text around @p obj
17582 * will require their
17583 * own space, which will make @p obj to require more the @p size,
17586 * @see elm_slider_span_size_get()
17590 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17593 * Get the length set for the bar region of a given slider widget
17595 * @param obj The slider object.
17596 * @return The length of the slider's bar region.
17598 * If that size was not set previously, with
17599 * elm_slider_span_size_set(), this call will return @c 0.
17603 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17606 * Set the format string for the unit label.
17608 * @param obj The slider object.
17609 * @param format The format string for the unit display.
17611 * Unit label is displayed all the time, if set, after slider's bar.
17612 * In horizontal mode, at right and in vertical mode, at bottom.
17614 * If @c NULL, unit label won't be visible. If not it sets the format
17615 * string for the label text. To the label text is provided a floating point
17616 * value, so the label text can display up to 1 floating point value.
17617 * Note that this is optional.
17619 * Use a format string such as "%1.2f meters" for example, and it will
17620 * display values like: "3.14 meters" for a value equal to 3.14159.
17622 * Default is unit label disabled.
17624 * @see elm_slider_indicator_format_get()
17628 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17631 * Get the unit label format of the slider.
17633 * @param obj The slider object.
17634 * @return The unit label format string in UTF-8.
17636 * Unit label is displayed all the time, if set, after slider's bar.
17637 * In horizontal mode, at right and in vertical mode, at bottom.
17639 * @see elm_slider_unit_format_set() for more
17640 * information on how this works.
17644 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17647 * Set the format string for the indicator label.
17649 * @param obj The slider object.
17650 * @param indicator The format string for the indicator display.
17652 * The slider may display its value somewhere else then unit label,
17653 * for example, above the slider knob that is dragged around. This function
17654 * sets the format string used for this.
17656 * If @c NULL, indicator label won't be visible. If not it sets the format
17657 * string for the label text. To the label text is provided a floating point
17658 * value, so the label text can display up to 1 floating point value.
17659 * Note that this is optional.
17661 * Use a format string such as "%1.2f meters" for example, and it will
17662 * display values like: "3.14 meters" for a value equal to 3.14159.
17664 * Default is indicator label disabled.
17666 * @see elm_slider_indicator_format_get()
17670 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17673 * Get the indicator label format of the slider.
17675 * @param obj The slider object.
17676 * @return The indicator label format string in UTF-8.
17678 * The slider may display its value somewhere else then unit label,
17679 * for example, above the slider knob that is dragged around. This function
17680 * gets the format string used for this.
17682 * @see elm_slider_indicator_format_set() for more
17683 * information on how this works.
17687 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17690 * Set the format function pointer for the indicator label
17692 * @param obj The slider object.
17693 * @param func The indicator format function.
17694 * @param free_func The freeing function for the format string.
17696 * Set the callback function to format the indicator string.
17698 * @see elm_slider_indicator_format_set() for more info on how this works.
17702 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);
17705 * Set the format function pointer for the units label
17707 * @param obj The slider object.
17708 * @param func The units format function.
17709 * @param free_func The freeing function for the format string.
17711 * Set the callback function to format the indicator string.
17713 * @see elm_slider_units_format_set() for more info on how this works.
17717 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);
17720 * Set the orientation of a given slider widget.
17722 * @param obj The slider object.
17723 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17724 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17726 * Use this function to change how your slider is to be
17727 * disposed: vertically or horizontally.
17729 * By default it's displayed horizontally.
17731 * @see elm_slider_horizontal_get()
17735 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17738 * Retrieve the orientation of a given slider widget
17740 * @param obj The slider object.
17741 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17742 * @c EINA_FALSE if it's @b vertical (and on errors).
17744 * @see elm_slider_horizontal_set() for more details.
17748 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17751 * Set the minimum and maximum values for the slider.
17753 * @param obj The slider object.
17754 * @param min The minimum value.
17755 * @param max The maximum value.
17757 * Define the allowed range of values to be selected by the user.
17759 * If actual value is less than @p min, it will be updated to @p min. If it
17760 * is bigger then @p max, will be updated to @p max. Actual value can be
17761 * get with elm_slider_value_get().
17763 * By default, min is equal to 0.0, and max is equal to 1.0.
17765 * @warning Maximum must be greater than minimum, otherwise behavior
17768 * @see elm_slider_min_max_get()
17772 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17775 * Get the minimum and maximum values of the slider.
17777 * @param obj The slider object.
17778 * @param min Pointer where to store the minimum value.
17779 * @param max Pointer where to store the maximum value.
17781 * @note If only one value is needed, the other pointer can be passed
17784 * @see elm_slider_min_max_set() for details.
17788 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17791 * Set the value the slider displays.
17793 * @param obj The slider object.
17794 * @param val The value to be displayed.
17796 * Value will be presented on the unit label following format specified with
17797 * elm_slider_unit_format_set() and on indicator with
17798 * elm_slider_indicator_format_set().
17800 * @warning The value must to be between min and max values. This values
17801 * are set by elm_slider_min_max_set().
17803 * @see elm_slider_value_get()
17804 * @see elm_slider_unit_format_set()
17805 * @see elm_slider_indicator_format_set()
17806 * @see elm_slider_min_max_set()
17810 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17813 * Get the value displayed by the spinner.
17815 * @param obj The spinner object.
17816 * @return The value displayed.
17818 * @see elm_spinner_value_set() for details.
17822 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17825 * Invert a given slider widget's displaying values order
17827 * @param obj The slider object.
17828 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17829 * @c EINA_FALSE to bring it back to default, non-inverted values.
17831 * A slider may be @b inverted, in which state it gets its
17832 * values inverted, with high vales being on the left or top and
17833 * low values on the right or bottom, as opposed to normally have
17834 * the low values on the former and high values on the latter,
17835 * respectively, for horizontal and vertical modes.
17837 * @see elm_slider_inverted_get()
17841 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17844 * Get whether a given slider widget's displaying values are
17847 * @param obj The slider object.
17848 * @return @c EINA_TRUE, if @p obj has inverted values,
17849 * @c EINA_FALSE otherwise (and on errors).
17851 * @see elm_slider_inverted_set() for more details.
17855 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17858 * Set whether to enlarge slider indicator (augmented knob) or not.
17860 * @param obj The slider object.
17861 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17862 * let the knob always at default size.
17864 * By default, indicator will be bigger while dragged by the user.
17866 * @warning It won't display values set with
17867 * elm_slider_indicator_format_set() if you disable indicator.
17871 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17874 * Get whether a given slider widget's enlarging indicator or not.
17876 * @param obj The slider object.
17877 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17878 * @c EINA_FALSE otherwise (and on errors).
17880 * @see elm_slider_indicator_show_set() for details.
17884 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17891 * @addtogroup Actionslider Actionslider
17893 * @image html img/widget/actionslider/preview-00.png
17894 * @image latex img/widget/actionslider/preview-00.eps
17896 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17897 * properties. The user drags and releases the indicator, to choose a label.
17899 * Labels occupy the following positions.
17904 * Positions can be enabled or disabled.
17906 * Magnets can be set on the above positions.
17908 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17910 * @note By default all positions are set as enabled.
17912 * Signals that you can add callbacks for are:
17914 * "selected" - when user selects an enabled position (the label is passed
17917 * "pos_changed" - when the indicator reaches any of the positions("left",
17918 * "right" or "center").
17920 * See an example of actionslider usage @ref actionslider_example_page "here"
17924 typedef enum _Elm_Actionslider_Indicator_Pos
17926 ELM_ACTIONSLIDER_INDICATOR_NONE,
17927 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17928 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17929 ELM_ACTIONSLIDER_INDICATOR_CENTER
17930 } Elm_Actionslider_Indicator_Pos;
17932 typedef enum _Elm_Actionslider_Magnet_Pos
17934 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17935 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17936 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17937 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17938 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17939 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17940 } Elm_Actionslider_Magnet_Pos;
17942 typedef enum _Elm_Actionslider_Label_Pos
17944 ELM_ACTIONSLIDER_LABEL_LEFT,
17945 ELM_ACTIONSLIDER_LABEL_RIGHT,
17946 ELM_ACTIONSLIDER_LABEL_CENTER,
17947 ELM_ACTIONSLIDER_LABEL_BUTTON
17948 } Elm_Actionslider_Label_Pos;
17950 /* smart callbacks called:
17951 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17955 * Add a new actionslider to the parent.
17957 * @param parent The parent object
17958 * @return The new actionslider object or NULL if it cannot be created
17960 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17963 * Set actionslider label.
17965 * @param[in] obj The actionslider object
17966 * @param[in] pos The position of the label.
17967 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17968 * @param label The label which is going to be set.
17970 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17972 * Get actionslider labels.
17974 * @param obj The actionslider object
17975 * @param left_label A char** to place the left_label of @p obj into.
17976 * @param center_label A char** to place the center_label of @p obj into.
17977 * @param right_label A char** to place the right_label of @p obj into.
17979 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);
17981 * Get actionslider selected label.
17983 * @param obj The actionslider object
17984 * @return The selected label
17986 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17988 * Set actionslider indicator position.
17990 * @param obj The actionslider object.
17991 * @param pos The position of the indicator.
17993 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17995 * Get actionslider indicator position.
17997 * @param obj The actionslider object.
17998 * @return The position of the indicator.
18000 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18002 * Set actionslider magnet position. To make multiple positions magnets @c or
18003 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18005 * @param obj The actionslider object.
18006 * @param pos Bit mask indicating the magnet positions.
18008 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18010 * Get actionslider magnet position.
18012 * @param obj The actionslider object.
18013 * @return The positions with magnet property.
18015 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18017 * Set actionslider enabled position. To set multiple positions as enabled @c or
18018 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18020 * @note All the positions are enabled by default.
18022 * @param obj The actionslider object.
18023 * @param pos Bit mask indicating the enabled positions.
18025 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18027 * Get actionslider enabled position.
18029 * @param obj The actionslider object.
18030 * @return The enabled positions.
18032 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18034 * Set the label used on the indicator.
18036 * @param obj The actionslider object
18037 * @param label The label to be set on the indicator.
18038 * @deprecated use elm_object_text_set() instead.
18040 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18042 * Get the label used on the indicator object.
18044 * @param obj The actionslider object
18045 * @return The indicator label
18046 * @deprecated use elm_object_text_get() instead.
18048 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18051 * Hold actionslider object movement.
18053 * @param[in] obj The actionslider object
18054 * @param[in] flag Actionslider hold/release
18055 * (EINA_TURE = hold/EIN_FALSE = release)
18057 * @ingroup Actionslider
18059 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18067 * @defgroup Genlist Genlist
18069 * @image html img/widget/genlist/preview-00.png
18070 * @image latex img/widget/genlist/preview-00.eps
18071 * @image html img/genlist.png
18072 * @image latex img/genlist.eps
18074 * This widget aims to have more expansive list than the simple list in
18075 * Elementary that could have more flexible items and allow many more entries
18076 * while still being fast and low on memory usage. At the same time it was
18077 * also made to be able to do tree structures. But the price to pay is more
18078 * complexity when it comes to usage. If all you want is a simple list with
18079 * icons and a single label, use the normal @ref List object.
18081 * Genlist has a fairly large API, mostly because it's relatively complex,
18082 * trying to be both expansive, powerful and efficient. First we will begin
18083 * an overview on the theory behind genlist.
18085 * @section Genlist_Item_Class Genlist item classes - creating items
18087 * In order to have the ability to add and delete items on the fly, genlist
18088 * implements a class (callback) system where the application provides a
18089 * structure with information about that type of item (genlist may contain
18090 * multiple different items with different classes, states and styles).
18091 * Genlist will call the functions in this struct (methods) when an item is
18092 * "realized" (i.e., created dynamically, while the user is scrolling the
18093 * grid). All objects will simply be deleted when no longer needed with
18094 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18095 * following members:
18096 * - @c item_style - This is a constant string and simply defines the name
18097 * of the item style. It @b must be specified and the default should be @c
18100 * - @c func - A struct with pointers to functions that will be called when
18101 * an item is going to be actually created. All of them receive a @c data
18102 * parameter that will point to the same data passed to
18103 * elm_genlist_item_append() and related item creation functions, and a @c
18104 * obj parameter that points to the genlist object itself.
18106 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18107 * state_get and @c del. The 3 first functions also receive a @c part
18108 * parameter described below. A brief description of these functions follows:
18110 * - @c label_get - The @c part parameter is the name string of one of the
18111 * existing text parts in the Edje group implementing the item's theme.
18112 * This function @b must return a strdup'()ed string, as the caller will
18113 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18114 * - @c content_get - The @c part parameter is the name string of one of the
18115 * existing (content) swallow parts in the Edje group implementing the item's
18116 * theme. It must return @c NULL, when no content is desired, or a valid
18117 * object handle, otherwise. The object will be deleted by the genlist on
18118 * its deletion or when the item is "unrealized". See
18119 * #Elm_Genlist_Item_Content_Get_Cb.
18120 * - @c func.state_get - The @c part parameter is the name string of one of
18121 * the state parts in the Edje group implementing the item's theme. Return
18122 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18123 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18124 * and @c "elm" as "emission" and "source" arguments, respectively, when
18125 * the state is true (the default is false), where @c XXX is the name of
18126 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18127 * - @c func.del - This is intended for use when genlist items are deleted,
18128 * so any data attached to the item (e.g. its data parameter on creation)
18129 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18131 * available item styles:
18133 * - default_style - The text part is a textblock
18135 * @image html img/widget/genlist/preview-04.png
18136 * @image latex img/widget/genlist/preview-04.eps
18140 * @image html img/widget/genlist/preview-01.png
18141 * @image latex img/widget/genlist/preview-01.eps
18143 * - icon_top_text_bottom
18145 * @image html img/widget/genlist/preview-02.png
18146 * @image latex img/widget/genlist/preview-02.eps
18150 * @image html img/widget/genlist/preview-03.png
18151 * @image latex img/widget/genlist/preview-03.eps
18153 * @section Genlist_Items Structure of items
18155 * An item in a genlist can have 0 or more text labels (they can be regular
18156 * text or textblock Evas objects - that's up to the style to determine), 0
18157 * or more contents (which are simply objects swallowed into the genlist item's
18158 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18159 * behavior left to the user to define. The Edje part names for each of
18160 * these properties will be looked up, in the theme file for the genlist,
18161 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18162 * "states", respectively. For each of those properties, if more than one
18163 * part is provided, they must have names listed separated by spaces in the
18164 * data fields. For the default genlist item theme, we have @b one label
18165 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18166 * "elm.swallow.end") and @b no state parts.
18168 * A genlist item may be at one of several styles. Elementary provides one
18169 * by default - "default", but this can be extended by system or application
18170 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18173 * @section Genlist_Manipulation Editing and Navigating
18175 * Items can be added by several calls. All of them return a @ref
18176 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18177 * They all take a data parameter that is meant to be used for a handle to
18178 * the applications internal data (eg the struct with the original item
18179 * data). The parent parameter is the parent genlist item this belongs to if
18180 * it is a tree or an indexed group, and NULL if there is no parent. The
18181 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18182 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18183 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18184 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18185 * is set then this item is group index item that is displayed at the top
18186 * until the next group comes. The func parameter is a convenience callback
18187 * that is called when the item is selected and the data parameter will be
18188 * the func_data parameter, obj be the genlist object and event_info will be
18189 * the genlist item.
18191 * elm_genlist_item_append() adds an item to the end of the list, or if
18192 * there is a parent, to the end of all the child items of the parent.
18193 * elm_genlist_item_prepend() is the same but adds to the beginning of
18194 * the list or children list. elm_genlist_item_insert_before() inserts at
18195 * item before another item and elm_genlist_item_insert_after() inserts after
18196 * the indicated item.
18198 * The application can clear the list with elm_gen_clear() which deletes
18199 * all the items in the list and elm_genlist_item_del() will delete a specific
18200 * item. elm_genlist_item_subitems_clear() will clear all items that are
18201 * children of the indicated parent item.
18203 * To help inspect list items you can jump to the item at the top of the list
18204 * with elm_genlist_first_item_get() which will return the item pointer, and
18205 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18206 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18207 * and previous items respectively relative to the indicated item. Using
18208 * these calls you can walk the entire item list/tree. Note that as a tree
18209 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18210 * let you know which item is the parent (and thus know how to skip them if
18213 * @section Genlist_Muti_Selection Multi-selection
18215 * If the application wants multiple items to be able to be selected,
18216 * elm_genlist_multi_select_set() can enable this. If the list is
18217 * single-selection only (the default), then elm_genlist_selected_item_get()
18218 * will return the selected item, if any, or NULL if none is selected. If the
18219 * list is multi-select then elm_genlist_selected_items_get() will return a
18220 * list (that is only valid as long as no items are modified (added, deleted,
18221 * selected or unselected)).
18223 * @section Genlist_Usage_Hints Usage hints
18225 * There are also convenience functions. elm_gen_item_genlist_get() will
18226 * return the genlist object the item belongs to. elm_genlist_item_show()
18227 * will make the scroller scroll to show that specific item so its visible.
18228 * elm_genlist_item_data_get() returns the data pointer set by the item
18229 * creation functions.
18231 * If an item changes (state of boolean changes, label or contents change),
18232 * then use elm_genlist_item_update() to have genlist update the item with
18233 * the new state. Genlist will re-realize the item thus call the functions
18234 * in the _Elm_Genlist_Item_Class for that item.
18236 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18237 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18238 * to expand/contract an item and get its expanded state, use
18239 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18240 * again to make an item disabled (unable to be selected and appear
18241 * differently) use elm_genlist_item_disabled_set() to set this and
18242 * elm_genlist_item_disabled_get() to get the disabled state.
18244 * In general to indicate how the genlist should expand items horizontally to
18245 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18246 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18247 * mode means that if items are too wide to fit, the scroller will scroll
18248 * horizontally. Otherwise items are expanded to fill the width of the
18249 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18250 * to the viewport width and limited to that size. This can be combined with
18251 * a different style that uses edjes' ellipsis feature (cutting text off like
18254 * Items will only call their selection func and callback when first becoming
18255 * selected. Any further clicks will do nothing, unless you enable always
18256 * select with elm_gen_always_select_mode_set(). This means even if
18257 * selected, every click will make the selected callbacks be called.
18258 * elm_genlist_no_select_mode_set() will turn off the ability to select
18259 * items entirely and they will neither appear selected nor call selected
18260 * callback functions.
18262 * Remember that you can create new styles and add your own theme augmentation
18263 * per application with elm_theme_extension_add(). If you absolutely must
18264 * have a specific style that overrides any theme the user or system sets up
18265 * you can use elm_theme_overlay_add() to add such a file.
18267 * @section Genlist_Implementation Implementation
18269 * Evas tracks every object you create. Every time it processes an event
18270 * (mouse move, down, up etc.) it needs to walk through objects and find out
18271 * what event that affects. Even worse every time it renders display updates,
18272 * in order to just calculate what to re-draw, it needs to walk through many
18273 * many many objects. Thus, the more objects you keep active, the more
18274 * overhead Evas has in just doing its work. It is advisable to keep your
18275 * active objects to the minimum working set you need. Also remember that
18276 * object creation and deletion carries an overhead, so there is a
18277 * middle-ground, which is not easily determined. But don't keep massive lists
18278 * of objects you can't see or use. Genlist does this with list objects. It
18279 * creates and destroys them dynamically as you scroll around. It groups them
18280 * into blocks so it can determine the visibility etc. of a whole block at
18281 * once as opposed to having to walk the whole list. This 2-level list allows
18282 * for very large numbers of items to be in the list (tests have used up to
18283 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18284 * may be different sizes, every item added needs to be calculated as to its
18285 * size and thus this presents a lot of overhead on populating the list, this
18286 * genlist employs a queue. Any item added is queued and spooled off over
18287 * time, actually appearing some time later, so if your list has many members
18288 * you may find it takes a while for them to all appear, with your process
18289 * consuming a lot of CPU while it is busy spooling.
18291 * Genlist also implements a tree structure, but it does so with callbacks to
18292 * the application, with the application filling in tree structures when
18293 * requested (allowing for efficient building of a very deep tree that could
18294 * even be used for file-management). See the above smart signal callbacks for
18297 * @section Genlist_Smart_Events Genlist smart events
18299 * Signals that you can add callbacks for are:
18300 * - @c "activated" - The user has double-clicked or pressed
18301 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18302 * item that was activated.
18303 * - @c "clicked,double" - The user has double-clicked an item. The @c
18304 * event_info parameter is the item that was double-clicked.
18305 * - @c "selected" - This is called when a user has made an item selected.
18306 * The event_info parameter is the genlist item that was selected.
18307 * - @c "unselected" - This is called when a user has made an item
18308 * unselected. The event_info parameter is the genlist item that was
18310 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18311 * called and the item is now meant to be expanded. The event_info
18312 * parameter is the genlist item that was indicated to expand. It is the
18313 * job of this callback to then fill in the child items.
18314 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18315 * called and the item is now meant to be contracted. The event_info
18316 * parameter is the genlist item that was indicated to contract. It is the
18317 * job of this callback to then delete the child items.
18318 * - @c "expand,request" - This is called when a user has indicated they want
18319 * to expand a tree branch item. The callback should decide if the item can
18320 * expand (has any children) and then call elm_genlist_item_expanded_set()
18321 * appropriately to set the state. The event_info parameter is the genlist
18322 * item that was indicated to expand.
18323 * - @c "contract,request" - This is called when a user has indicated they
18324 * want to contract a tree branch item. The callback should decide if the
18325 * item can contract (has any children) and then call
18326 * elm_genlist_item_expanded_set() appropriately to set the state. The
18327 * event_info parameter is the genlist item that was indicated to contract.
18328 * - @c "realized" - This is called when the item in the list is created as a
18329 * real evas object. event_info parameter is the genlist item that was
18330 * created. The object may be deleted at any time, so it is up to the
18331 * caller to not use the object pointer from elm_genlist_item_object_get()
18332 * in a way where it may point to freed objects.
18333 * - @c "unrealized" - This is called just before an item is unrealized.
18334 * After this call content objects provided will be deleted and the item
18335 * object itself delete or be put into a floating cache.
18336 * - @c "drag,start,up" - This is called when the item in the list has been
18337 * dragged (not scrolled) up.
18338 * - @c "drag,start,down" - This is called when the item in the list has been
18339 * dragged (not scrolled) down.
18340 * - @c "drag,start,left" - This is called when the item in the list has been
18341 * dragged (not scrolled) left.
18342 * - @c "drag,start,right" - This is called when the item in the list has
18343 * been dragged (not scrolled) right.
18344 * - @c "drag,stop" - This is called when the item in the list has stopped
18346 * - @c "drag" - This is called when the item in the list is being dragged.
18347 * - @c "longpressed" - This is called when the item is pressed for a certain
18348 * amount of time. By default it's 1 second.
18349 * - @c "scroll,anim,start" - This is called when scrolling animation has
18351 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18353 * - @c "scroll,drag,start" - This is called when dragging the content has
18355 * - @c "scroll,drag,stop" - This is called when dragging the content has
18357 * - @c "edge,top" - This is called when the genlist is scrolled until
18359 * - @c "edge,bottom" - This is called when the genlist is scrolled
18360 * until the bottom edge.
18361 * - @c "edge,left" - This is called when the genlist is scrolled
18362 * until the left edge.
18363 * - @c "edge,right" - This is called when the genlist is scrolled
18364 * until the right edge.
18365 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18367 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18369 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18371 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18373 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18374 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18375 * multi-touch pinched in.
18376 * - @c "swipe" - This is called when the genlist is swiped.
18377 * - @c "moved" - This is called when a genlist item is moved.
18378 * - @c "language,changed" - This is called when the program's language is
18381 * @section Genlist_Examples Examples
18383 * Here is a list of examples that use the genlist, trying to show some of
18384 * its capabilities:
18385 * - @ref genlist_example_01
18386 * - @ref genlist_example_02
18387 * - @ref genlist_example_03
18388 * - @ref genlist_example_04
18389 * - @ref genlist_example_05
18393 * @addtogroup Genlist
18398 * @enum _Elm_Genlist_Item_Flags
18399 * @typedef Elm_Genlist_Item_Flags
18401 * Defines if the item is of any special type (has subitems or it's the
18402 * index of a group), or is just a simple item.
18406 typedef enum _Elm_Genlist_Item_Flags
18408 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18409 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18410 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18411 } Elm_Genlist_Item_Flags;
18412 typedef enum _Elm_Genlist_Item_Field_Flags
18414 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18415 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18416 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18417 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18418 } Elm_Genlist_Item_Field_Flags;
18419 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18420 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18421 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18422 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18423 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18424 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18425 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18426 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18429 * @struct _Elm_Genlist_Item_Class
18431 * Genlist item class definition structs.
18433 * This struct contains the style and fetching functions that will define the
18434 * contents of each item.
18436 * @see @ref Genlist_Item_Class
18438 struct _Elm_Genlist_Item_Class
18440 const char *item_style;
18442 GenlistItemLabelGetFunc label_get;
18443 GenlistItemIconGetFunc icon_get;
18444 GenlistItemStateGetFunc state_get;
18445 GenlistItemDelFunc del;
18446 GenlistItemMovedFunc moved;
18448 const char *edit_item_style;
18449 const char *mode_item_style;
18451 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18453 * Add a new genlist widget to the given parent Elementary
18454 * (container) object
18456 * @param parent The parent object
18457 * @return a new genlist widget handle or @c NULL, on errors
18459 * This function inserts a new genlist widget on the canvas.
18461 * @see elm_genlist_item_append()
18462 * @see elm_genlist_item_del()
18463 * @see elm_gen_clear()
18467 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18469 * Remove all items from a given genlist widget.
18471 * @param obj The genlist object
18473 * This removes (and deletes) all items in @p obj, leaving it empty.
18475 * This is deprecated. Please use elm_gen_clear() instead.
18477 * @see elm_genlist_item_del(), to remove just one item.
18481 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18483 * Enable or disable multi-selection in the genlist
18485 * @param obj The genlist object
18486 * @param multi Multi-select enable/disable. Default is disabled.
18488 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18489 * the list. This allows more than 1 item to be selected. To retrieve the list
18490 * of selected items, use elm_genlist_selected_items_get().
18492 * @see elm_genlist_selected_items_get()
18493 * @see elm_genlist_multi_select_get()
18497 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18499 * Gets if multi-selection in genlist is enabled or disabled.
18501 * @param obj The genlist object
18502 * @return Multi-select enabled/disabled
18503 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18505 * @see elm_genlist_multi_select_set()
18509 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18511 * This sets the horizontal stretching mode.
18513 * @param obj The genlist object
18514 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18516 * This sets the mode used for sizing items horizontally. Valid modes
18517 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18518 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18519 * the scroller will scroll horizontally. Otherwise items are expanded
18520 * to fill the width of the viewport of the scroller. If it is
18521 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18522 * limited to that size.
18524 * @see elm_genlist_horizontal_get()
18528 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18530 * Gets the horizontal stretching mode.
18532 * @param obj The genlist object
18533 * @return The mode to use
18534 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18536 * @see elm_genlist_horizontal_set()
18540 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18542 * Set the always select mode.
18544 * @param obj The genlist object
18545 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18546 * EINA_FALSE = off). Default is @c EINA_FALSE.
18548 * Items will only call their selection func and callback when first
18549 * becoming selected. Any further clicks will do nothing, unless you
18550 * enable always select with elm_gen_always_select_mode_set().
18551 * This means that, even if selected, every click will make the selected
18552 * callbacks be called.
18554 * This function is deprecated. please see elm_gen_always_select_mode_set()
18556 * @see elm_genlist_always_select_mode_get()
18560 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18562 * Get the always select mode.
18564 * @param obj The genlist object
18565 * @return The always select mode
18566 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18568 * @see elm_genlist_always_select_mode_set()
18572 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18574 * Enable/disable the no select mode.
18576 * @param obj The genlist object
18577 * @param no_select The no select mode
18578 * (EINA_TRUE = on, EINA_FALSE = off)
18580 * This will turn off the ability to select items entirely and they
18581 * will neither appear selected nor call selected callback functions.
18583 * @see elm_genlist_no_select_mode_get()
18587 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18589 * Gets whether the no select mode is enabled.
18591 * @param obj The genlist object
18592 * @return The no select mode
18593 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18595 * @see elm_genlist_no_select_mode_set()
18599 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18601 * Enable/disable compress mode.
18603 * @param obj The genlist object
18604 * @param compress The compress mode
18605 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18607 * This will enable the compress mode where items are "compressed"
18608 * horizontally to fit the genlist scrollable viewport width. This is
18609 * special for genlist. Do not rely on
18610 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18611 * work as genlist needs to handle it specially.
18613 * @see elm_genlist_compress_mode_get()
18617 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18619 * Get whether the compress mode is enabled.
18621 * @param obj The genlist object
18622 * @return The compress mode
18623 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18625 * @see elm_genlist_compress_mode_set()
18629 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18631 * Enable/disable height-for-width mode.
18633 * @param obj The genlist object
18634 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18635 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18637 * With height-for-width mode the item width will be fixed (restricted
18638 * to a minimum of) to the list width when calculating its size in
18639 * order to allow the height to be calculated based on it. This allows,
18640 * for instance, text block to wrap lines if the Edje part is
18641 * configured with "text.min: 0 1".
18643 * @note This mode will make list resize slower as it will have to
18644 * recalculate every item height again whenever the list width
18647 * @note When height-for-width mode is enabled, it also enables
18648 * compress mode (see elm_genlist_compress_mode_set()) and
18649 * disables homogeneous (see elm_genlist_homogeneous_set()).
18653 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18655 * Get whether the height-for-width mode is enabled.
18657 * @param obj The genlist object
18658 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18663 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18665 * Enable/disable horizontal and vertical bouncing effect.
18667 * @param obj The genlist object
18668 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18669 * EINA_FALSE = off). Default is @c EINA_FALSE.
18670 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18671 * EINA_FALSE = off). Default is @c EINA_TRUE.
18673 * This will enable or disable the scroller bouncing effect for the
18674 * genlist. See elm_scroller_bounce_set() for details.
18676 * @see elm_scroller_bounce_set()
18677 * @see elm_genlist_bounce_get()
18681 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18683 * Get whether the horizontal and vertical bouncing effect is enabled.
18685 * @param obj The genlist object
18686 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18688 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18691 * @see elm_genlist_bounce_set()
18695 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18697 * Enable/disable homogenous mode.
18699 * @param obj The genlist object
18700 * @param homogeneous Assume the items within the genlist are of the
18701 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18704 * This will enable the homogeneous mode where items are of the same
18705 * height and width so that genlist may do the lazy-loading at its
18706 * maximum (which increases the performance for scrolling the list). This
18707 * implies 'compressed' mode.
18709 * @see elm_genlist_compress_mode_set()
18710 * @see elm_genlist_homogeneous_get()
18714 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18716 * Get whether the homogenous mode is enabled.
18718 * @param obj The genlist object
18719 * @return Assume the items within the genlist are of the same height
18720 * and width (EINA_TRUE = on, EINA_FALSE = off)
18722 * @see elm_genlist_homogeneous_set()
18726 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18728 * Set the maximum number of items within an item block
18730 * @param obj The genlist object
18731 * @param n Maximum number of items within an item block. Default is 32.
18733 * This will configure the block count to tune to the target with
18734 * particular performance matrix.
18736 * A block of objects will be used to reduce the number of operations due to
18737 * many objects in the screen. It can determine the visibility, or if the
18738 * object has changed, it theme needs to be updated, etc. doing this kind of
18739 * calculation to the entire block, instead of per object.
18741 * The default value for the block count is enough for most lists, so unless
18742 * you know you will have a lot of objects visible in the screen at the same
18743 * time, don't try to change this.
18745 * @see elm_genlist_block_count_get()
18746 * @see @ref Genlist_Implementation
18750 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18752 * Get the maximum number of items within an item block
18754 * @param obj The genlist object
18755 * @return Maximum number of items within an item block
18757 * @see elm_genlist_block_count_set()
18761 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18763 * Set the timeout in seconds for the longpress event.
18765 * @param obj The genlist object
18766 * @param timeout timeout in seconds. Default is 1.
18768 * This option will change how long it takes to send an event "longpressed"
18769 * after the mouse down signal is sent to the list. If this event occurs, no
18770 * "clicked" event will be sent.
18772 * @see elm_genlist_longpress_timeout_set()
18776 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18778 * Get the timeout in seconds for the longpress event.
18780 * @param obj The genlist object
18781 * @return timeout in seconds
18783 * @see elm_genlist_longpress_timeout_get()
18787 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18789 * Append a new item in a given genlist widget.
18791 * @param obj The genlist object
18792 * @param itc The item class for the item
18793 * @param data The item data
18794 * @param parent The parent item, or NULL if none
18795 * @param flags Item flags
18796 * @param func Convenience function called when the item is selected
18797 * @param func_data Data passed to @p func above.
18798 * @return A handle to the item added or @c NULL if not possible
18800 * This adds the given item to the end of the list or the end of
18801 * the children list if the @p parent is given.
18803 * @see elm_genlist_item_prepend()
18804 * @see elm_genlist_item_insert_before()
18805 * @see elm_genlist_item_insert_after()
18806 * @see elm_genlist_item_del()
18810 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);
18812 * Prepend a new item in a given genlist widget.
18814 * @param obj The genlist object
18815 * @param itc The item class for the item
18816 * @param data The item data
18817 * @param parent The parent item, or NULL if none
18818 * @param flags Item flags
18819 * @param func Convenience function called when the item is selected
18820 * @param func_data Data passed to @p func above.
18821 * @return A handle to the item added or NULL if not possible
18823 * This adds an item to the beginning of the list or beginning of the
18824 * children of the parent if given.
18826 * @see elm_genlist_item_append()
18827 * @see elm_genlist_item_insert_before()
18828 * @see elm_genlist_item_insert_after()
18829 * @see elm_genlist_item_del()
18833 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);
18835 * Insert an item before another in a genlist widget
18837 * @param obj The genlist object
18838 * @param itc The item class for the item
18839 * @param data The item data
18840 * @param before The item to place this new one before.
18841 * @param flags Item flags
18842 * @param func Convenience function called when the item is selected
18843 * @param func_data Data passed to @p func above.
18844 * @return A handle to the item added or @c NULL if not possible
18846 * This inserts an item before another in the list. It will be in the
18847 * same tree level or group as the item it is inserted before.
18849 * @see elm_genlist_item_append()
18850 * @see elm_genlist_item_prepend()
18851 * @see elm_genlist_item_insert_after()
18852 * @see elm_genlist_item_del()
18856 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);
18858 * Insert an item after another in a genlist widget
18860 * @param obj The genlist object
18861 * @param itc The item class for the item
18862 * @param data The item data
18863 * @param after The item to place this new one after.
18864 * @param flags Item flags
18865 * @param func Convenience function called when the item is selected
18866 * @param func_data Data passed to @p func above.
18867 * @return A handle to the item added or @c NULL if not possible
18869 * This inserts an item after another in the list. It will be in the
18870 * same tree level or group as the item it is inserted after.
18872 * @see elm_genlist_item_append()
18873 * @see elm_genlist_item_prepend()
18874 * @see elm_genlist_item_insert_before()
18875 * @see elm_genlist_item_del()
18879 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);
18881 * Insert a new item into the sorted genlist object
18883 * @param obj The genlist object
18884 * @param itc The item class for the item
18885 * @param data The item data
18886 * @param parent The parent item, or NULL if none
18887 * @param flags Item flags
18888 * @param comp The function called for the sort
18889 * @param func Convenience function called when item selected
18890 * @param func_data Data passed to @p func above.
18891 * @return A handle to the item added or NULL if not possible
18895 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);
18896 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);
18897 /* operations to retrieve existing items */
18899 * Get the selectd item in the genlist.
18901 * @param obj The genlist object
18902 * @return The selected item, or NULL if none is selected.
18904 * This gets the selected item in the list (if multi-selection is enabled, only
18905 * the item that was first selected in the list is returned - which is not very
18906 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18909 * If no item is selected, NULL is returned.
18911 * @see elm_genlist_selected_items_get()
18915 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18917 * Get a list of selected items in the genlist.
18919 * @param obj The genlist object
18920 * @return The list of selected items, or NULL if none are selected.
18922 * It returns a list of the selected items. This list pointer is only valid so
18923 * long as the selection doesn't change (no items are selected or unselected, or
18924 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18925 * pointers. The order of the items in this list is the order which they were
18926 * selected, i.e. the first item in this list is the first item that was
18927 * selected, and so on.
18929 * @note If not in multi-select mode, consider using function
18930 * elm_genlist_selected_item_get() instead.
18932 * @see elm_genlist_multi_select_set()
18933 * @see elm_genlist_selected_item_get()
18937 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18939 * Get the mode item style of items in the genlist
18940 * @param obj The genlist object
18941 * @return The mode item style string, or NULL if none is specified
18943 * This is a constant string and simply defines the name of the
18944 * style that will be used for mode animations. It can be
18945 * @c NULL if you don't plan to use Genlist mode. See
18946 * elm_genlist_item_mode_set() for more info.
18950 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18952 * Set the mode item style of items in the genlist
18953 * @param obj The genlist object
18954 * @param style The mode item style string, or NULL if none is desired
18956 * This is a constant string and simply defines the name of the
18957 * style that will be used for mode animations. It can be
18958 * @c NULL if you don't plan to use Genlist mode. See
18959 * elm_genlist_item_mode_set() for more info.
18963 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18965 * Get a list of realized items in genlist
18967 * @param obj The genlist object
18968 * @return The list of realized items, nor NULL if none are realized.
18970 * This returns a list of the realized items in the genlist. The list
18971 * contains Elm_Genlist_Item pointers. The list must be freed by the
18972 * caller when done with eina_list_free(). The item pointers in the
18973 * list are only valid so long as those items are not deleted or the
18974 * genlist is not deleted.
18976 * @see elm_genlist_realized_items_update()
18980 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18982 * Get the item that is at the x, y canvas coords.
18984 * @param obj The gelinst object.
18985 * @param x The input x coordinate
18986 * @param y The input y coordinate
18987 * @param posret The position relative to the item returned here
18988 * @return The item at the coordinates or NULL if none
18990 * This returns the item at the given coordinates (which are canvas
18991 * relative, not object-relative). If an item is at that coordinate,
18992 * that item handle is returned, and if @p posret is not NULL, the
18993 * integer pointed to is set to a value of -1, 0 or 1, depending if
18994 * the coordinate is on the upper portion of that item (-1), on the
18995 * middle section (0) or on the lower part (1). If NULL is returned as
18996 * an item (no item found there), then posret may indicate -1 or 1
18997 * based if the coordinate is above or below all items respectively in
19002 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);
19004 * Get the first item in the genlist
19006 * This returns the first item in the list.
19008 * @param obj The genlist object
19009 * @return The first item, or NULL if none
19013 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19015 * Get the last item in the genlist
19017 * This returns the last item in the list.
19019 * @return The last item, or NULL if none
19023 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19025 * Set the scrollbar policy
19027 * @param obj The genlist object
19028 * @param policy_h Horizontal scrollbar policy.
19029 * @param policy_v Vertical scrollbar policy.
19031 * This sets the scrollbar visibility policy for the given genlist
19032 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19033 * made visible if it is needed, and otherwise kept hidden.
19034 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19035 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19036 * respectively for the horizontal and vertical scrollbars. Default is
19037 * #ELM_SMART_SCROLLER_POLICY_AUTO
19039 * @see elm_genlist_scroller_policy_get()
19043 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19045 * Get the scrollbar policy
19047 * @param obj The genlist object
19048 * @param policy_h Pointer to store the horizontal scrollbar policy.
19049 * @param policy_v Pointer to store the vertical scrollbar policy.
19051 * @see elm_genlist_scroller_policy_set()
19055 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);
19057 * Get the @b next item in a genlist widget's internal list of items,
19058 * given a handle to one of those items.
19060 * @param item The genlist item to fetch next from
19061 * @return The item after @p item, or @c NULL if there's none (and
19064 * This returns the item placed after the @p item, on the container
19067 * @see elm_genlist_item_prev_get()
19071 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19073 * Get the @b previous item in a genlist widget's internal list of items,
19074 * given a handle to one of those items.
19076 * @param item The genlist item to fetch previous from
19077 * @return The item before @p item, or @c NULL if there's none (and
19080 * This returns the item placed before the @p item, on the container
19083 * @see elm_genlist_item_next_get()
19087 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19089 * Get the genlist object's handle which contains a given genlist
19092 * @param item The item to fetch the container from
19093 * @return The genlist (parent) object
19095 * This returns the genlist object itself that an item belongs to.
19097 * This function is deprecated. Please use elm_gen_item_widget_get()
19101 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19103 * Get the parent item of the given item
19105 * @param it The item
19106 * @return The parent of the item or @c NULL if it has no parent.
19108 * This returns the item that was specified as parent of the item @p it on
19109 * elm_genlist_item_append() and insertion related functions.
19113 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19115 * Remove all sub-items (children) of the given item
19117 * @param it The item
19119 * This removes all items that are children (and their descendants) of the
19120 * given item @p it.
19122 * @see elm_genlist_clear()
19123 * @see elm_genlist_item_del()
19127 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19129 * Set whether a given genlist item is selected or not
19131 * @param it The item
19132 * @param selected Use @c EINA_TRUE, to make it selected, @c
19133 * EINA_FALSE to make it unselected
19135 * This sets the selected state of an item. If multi selection is
19136 * not enabled on the containing genlist and @p selected is @c
19137 * EINA_TRUE, any other previously selected items will get
19138 * unselected in favor of this new one.
19140 * @see elm_genlist_item_selected_get()
19144 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19146 * Get whether a given genlist item is selected or not
19148 * @param it The item
19149 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19151 * @see elm_genlist_item_selected_set() for more details
19155 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19157 * Sets the expanded state of an item.
19159 * @param it The item
19160 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19162 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19165 * The theme will respond to this change visually, and a signal "expanded" or
19166 * "contracted" will be sent from the genlist with a pointer to the item that
19167 * has been expanded/contracted.
19169 * Calling this function won't show or hide any child of this item (if it is
19170 * a parent). You must manually delete and create them on the callbacks fo
19171 * the "expanded" or "contracted" signals.
19173 * @see elm_genlist_item_expanded_get()
19177 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19179 * Get the expanded state of an item
19181 * @param it The item
19182 * @return The expanded state
19184 * This gets the expanded state of an item.
19186 * @see elm_genlist_item_expanded_set()
19190 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19192 * Get the depth of expanded item
19194 * @param it The genlist item object
19195 * @return The depth of expanded item
19199 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19201 * Set whether a given genlist item is disabled or not.
19203 * @param it The item
19204 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19205 * to enable it back.
19207 * A disabled item cannot be selected or unselected. It will also
19208 * change its appearance, to signal the user it's disabled.
19210 * @see elm_genlist_item_disabled_get()
19214 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19216 * Get whether a given genlist item is disabled or not.
19218 * @param it The item
19219 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19222 * @see elm_genlist_item_disabled_set() for more details
19226 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19228 * Sets the display only state of an item.
19230 * @param it The item
19231 * @param display_only @c EINA_TRUE if the item is display only, @c
19232 * EINA_FALSE otherwise.
19234 * A display only item cannot be selected or unselected. It is for
19235 * display only and not selecting or otherwise clicking, dragging
19236 * etc. by the user, thus finger size rules will not be applied to
19239 * It's good to set group index items to display only state.
19241 * @see elm_genlist_item_display_only_get()
19245 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19247 * Get the display only state of an item
19249 * @param it The item
19250 * @return @c EINA_TRUE if the item is display only, @c
19251 * EINA_FALSE otherwise.
19253 * @see elm_genlist_item_display_only_set()
19257 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19259 * Show the portion of a genlist's internal list containing a given
19260 * item, immediately.
19262 * @param it The item to display
19264 * This causes genlist to jump to the given item @p it and show it (by
19265 * immediately scrolling to that position), if it is not fully visible.
19267 * @see elm_genlist_item_bring_in()
19268 * @see elm_genlist_item_top_show()
19269 * @see elm_genlist_item_middle_show()
19273 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19275 * Animatedly bring in, to the visible are of a genlist, a given
19278 * @param it The item to display
19280 * This causes genlist to jump to the given item @p it and show it (by
19281 * animatedly scrolling), if it is not fully visible. This may use animation
19282 * to do so and take a period of time
19284 * @see elm_genlist_item_show()
19285 * @see elm_genlist_item_top_bring_in()
19286 * @see elm_genlist_item_middle_bring_in()
19290 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19292 * Show the portion of a genlist's internal list containing a given
19293 * item, immediately.
19295 * @param it The item to display
19297 * This causes genlist to jump to the given item @p it and show it (by
19298 * immediately scrolling to that position), if it is not fully visible.
19300 * The item will be positioned at the top of the genlist viewport.
19302 * @see elm_genlist_item_show()
19303 * @see elm_genlist_item_top_bring_in()
19307 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19309 * Animatedly bring in, to the visible are of a genlist, a given
19312 * @param it The item
19314 * This causes genlist to jump to the given item @p it and show it (by
19315 * animatedly scrolling), if it is not fully visible. This may use animation
19316 * to do so and take a period of time
19318 * The item will be positioned at the top of the genlist viewport.
19320 * @see elm_genlist_item_bring_in()
19321 * @see elm_genlist_item_top_show()
19325 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19327 * Show the portion of a genlist's internal list containing a given
19328 * item, immediately.
19330 * @param it The item to display
19332 * This causes genlist to jump to the given item @p it and show it (by
19333 * immediately scrolling to that position), if it is not fully visible.
19335 * The item will be positioned at the middle of the genlist viewport.
19337 * @see elm_genlist_item_show()
19338 * @see elm_genlist_item_middle_bring_in()
19342 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19344 * Animatedly bring in, to the visible are of a genlist, a given
19347 * @param it The item
19349 * This causes genlist to jump to the given item @p it and show it (by
19350 * animatedly scrolling), if it is not fully visible. This may use animation
19351 * to do so and take a period of time
19353 * The item will be positioned at the middle of the genlist viewport.
19355 * @see elm_genlist_item_bring_in()
19356 * @see elm_genlist_item_middle_show()
19360 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19362 * Remove a genlist item from the its parent, deleting it.
19364 * @param item The item to be removed.
19365 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19367 * @see elm_genlist_clear(), to remove all items in a genlist at
19372 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19374 * Return the data associated to a given genlist item
19376 * @param item The genlist item.
19377 * @return the data associated to this item.
19379 * This returns the @c data value passed on the
19380 * elm_genlist_item_append() and related item addition calls.
19382 * @see elm_genlist_item_append()
19383 * @see elm_genlist_item_data_set()
19387 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19389 * Set the data associated to a given genlist item
19391 * @param item The genlist item
19392 * @param data The new data pointer to set on it
19394 * This @b overrides the @c data value passed on the
19395 * elm_genlist_item_append() and related item addition calls. This
19396 * function @b won't call elm_genlist_item_update() automatically,
19397 * so you'd issue it afterwards if you want to hove the item
19398 * updated to reflect the that new data.
19400 * @see elm_genlist_item_data_get()
19404 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19406 * Tells genlist to "orphan" icons fetchs by the item class
19408 * @param it The item
19410 * This instructs genlist to release references to icons in the item,
19411 * meaning that they will no longer be managed by genlist and are
19412 * floating "orphans" that can be re-used elsewhere if the user wants
19417 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19418 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19420 * Get the real Evas object created to implement the view of a
19421 * given genlist item
19423 * @param item The genlist item.
19424 * @return the Evas object implementing this item's view.
19426 * This returns the actual Evas object used to implement the
19427 * specified genlist item's view. This may be @c NULL, as it may
19428 * not have been created or may have been deleted, at any time, by
19429 * the genlist. <b>Do not modify this object</b> (move, resize,
19430 * show, hide, etc.), as the genlist is controlling it. This
19431 * function is for querying, emitting custom signals or hooking
19432 * lower level callbacks for events on that object. Do not delete
19433 * this object under any circumstances.
19435 * @see elm_genlist_item_data_get()
19439 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19441 * Update the contents of an item
19443 * @param it The item
19445 * This updates an item by calling all the item class functions again
19446 * to get the icons, labels and states. Use this when the original
19447 * item data has changed and the changes are desired to be reflected.
19449 * Use elm_genlist_realized_items_update() to update all already realized
19452 * @see elm_genlist_realized_items_update()
19456 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19457 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19459 * Update the item class of an item
19461 * @param it The item
19462 * @param itc The item class for the item
19464 * This sets another class fo the item, changing the way that it is
19465 * displayed. After changing the item class, elm_genlist_item_update() is
19466 * called on the item @p it.
19470 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19471 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19473 * Set the text to be shown in a given genlist item's tooltips.
19475 * @param item The genlist item
19476 * @param text The text to set in the content
19478 * This call will setup the text to be used as tooltip to that item
19479 * (analogous to elm_object_tooltip_text_set(), but being item
19480 * tooltips with higher precedence than object tooltips). It can
19481 * have only one tooltip at a time, so any previous tooltip data
19482 * will get removed.
19484 * In order to set an icon or something else as a tooltip, look at
19485 * elm_genlist_item_tooltip_content_cb_set().
19489 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19491 * Set the content to be shown in a given genlist item's tooltips
19493 * @param item The genlist item.
19494 * @param func The function returning the tooltip contents.
19495 * @param data What to provide to @a func as callback data/context.
19496 * @param del_cb Called when data is not needed anymore, either when
19497 * another callback replaces @p func, the tooltip is unset with
19498 * elm_genlist_item_tooltip_unset() or the owner @p item
19499 * dies. This callback receives as its first parameter the
19500 * given @p data, being @c event_info the item handle.
19502 * This call will setup the tooltip's contents to @p item
19503 * (analogous to elm_object_tooltip_content_cb_set(), but being
19504 * item tooltips with higher precedence than object tooltips). It
19505 * can have only one tooltip at a time, so any previous tooltip
19506 * content will get removed. @p func (with @p data) will be called
19507 * every time Elementary needs to show the tooltip and it should
19508 * return a valid Evas object, which will be fully managed by the
19509 * tooltip system, getting deleted when the tooltip is gone.
19511 * In order to set just a text as a tooltip, look at
19512 * elm_genlist_item_tooltip_text_set().
19516 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);
19518 * Unset a tooltip from a given genlist item
19520 * @param item genlist item to remove a previously set tooltip from.
19522 * This call removes any tooltip set on @p item. The callback
19523 * provided as @c del_cb to
19524 * elm_genlist_item_tooltip_content_cb_set() will be called to
19525 * notify it is not used anymore (and have resources cleaned, if
19528 * @see elm_genlist_item_tooltip_content_cb_set()
19532 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19534 * Set a different @b style for a given genlist item's tooltip.
19536 * @param item genlist item with tooltip set
19537 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19538 * "default", @c "transparent", etc)
19540 * Tooltips can have <b>alternate styles</b> to be displayed on,
19541 * which are defined by the theme set on Elementary. This function
19542 * works analogously as elm_object_tooltip_style_set(), but here
19543 * applied only to genlist item objects. The default style for
19544 * tooltips is @c "default".
19546 * @note before you set a style you should define a tooltip with
19547 * elm_genlist_item_tooltip_content_cb_set() or
19548 * elm_genlist_item_tooltip_text_set()
19550 * @see elm_genlist_item_tooltip_style_get()
19554 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19556 * Get the style set a given genlist item's tooltip.
19558 * @param item genlist item with tooltip already set on.
19559 * @return style the theme style in use, which defaults to
19560 * "default". If the object does not have a tooltip set,
19561 * then @c NULL is returned.
19563 * @see elm_genlist_item_tooltip_style_set() for more details
19567 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19569 * Set the type of mouse pointer/cursor decoration to be shown,
19570 * when the mouse pointer is over the given genlist widget item
19572 * @param item genlist item to customize cursor on
19573 * @param cursor the cursor type's name
19575 * This function works analogously as elm_object_cursor_set(), but
19576 * here the cursor's changing area is restricted to the item's
19577 * area, and not the whole widget's. Note that that item cursors
19578 * have precedence over widget cursors, so that a mouse over @p
19579 * item will always show cursor @p type.
19581 * If this function is called twice for an object, a previously set
19582 * cursor will be unset on the second call.
19584 * @see elm_object_cursor_set()
19585 * @see elm_genlist_item_cursor_get()
19586 * @see elm_genlist_item_cursor_unset()
19590 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19592 * Get the type of mouse pointer/cursor decoration set to be shown,
19593 * when the mouse pointer is over the given genlist widget item
19595 * @param item genlist item with custom cursor set
19596 * @return the cursor type's name or @c NULL, if no custom cursors
19597 * were set to @p item (and on errors)
19599 * @see elm_object_cursor_get()
19600 * @see elm_genlist_item_cursor_set() for more details
19601 * @see elm_genlist_item_cursor_unset()
19605 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19607 * Unset any custom mouse pointer/cursor decoration set to be
19608 * shown, when the mouse pointer is over the given genlist widget
19609 * item, thus making it show the @b default cursor again.
19611 * @param item a genlist item
19613 * Use this call to undo any custom settings on this item's cursor
19614 * decoration, bringing it back to defaults (no custom style set).
19616 * @see elm_object_cursor_unset()
19617 * @see elm_genlist_item_cursor_set() for more details
19621 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19623 * Set a different @b style for a given custom cursor set for a
19626 * @param item genlist item with custom cursor set
19627 * @param style the <b>theme style</b> to use (e.g. @c "default",
19628 * @c "transparent", etc)
19630 * This function only makes sense when one is using custom mouse
19631 * cursor decorations <b>defined in a theme file</b> , which can
19632 * have, given a cursor name/type, <b>alternate styles</b> on
19633 * it. It works analogously as elm_object_cursor_style_set(), but
19634 * here applied only to genlist item objects.
19636 * @warning Before you set a cursor style you should have defined a
19637 * custom cursor previously on the item, with
19638 * elm_genlist_item_cursor_set()
19640 * @see elm_genlist_item_cursor_engine_only_set()
19641 * @see elm_genlist_item_cursor_style_get()
19645 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19647 * Get the current @b style set for a given genlist item's custom
19650 * @param item genlist item with custom cursor set.
19651 * @return style the cursor style in use. If the object does not
19652 * have a cursor set, then @c NULL is returned.
19654 * @see elm_genlist_item_cursor_style_set() for more details
19658 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19660 * Set if the (custom) cursor for a given genlist item should be
19661 * searched in its theme, also, or should only rely on the
19662 * rendering engine.
19664 * @param item item with custom (custom) cursor already set on
19665 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19666 * only on those provided by the rendering engine, @c EINA_FALSE to
19667 * have them searched on the widget's theme, as well.
19669 * @note This call is of use only if you've set a custom cursor
19670 * for genlist items, with elm_genlist_item_cursor_set().
19672 * @note By default, cursors will only be looked for between those
19673 * provided by the rendering engine.
19677 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19679 * Get if the (custom) cursor for a given genlist item is being
19680 * searched in its theme, also, or is only relying on the rendering
19683 * @param item a genlist item
19684 * @return @c EINA_TRUE, if cursors are being looked for only on
19685 * those provided by the rendering engine, @c EINA_FALSE if they
19686 * are being searched on the widget's theme, as well.
19688 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19692 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19694 * Update the contents of all realized items.
19696 * @param obj The genlist object.
19698 * This updates all realized items by calling all the item class functions again
19699 * to get the icons, labels and states. Use this when the original
19700 * item data has changed and the changes are desired to be reflected.
19702 * To update just one item, use elm_genlist_item_update().
19704 * @see elm_genlist_realized_items_get()
19705 * @see elm_genlist_item_update()
19709 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19711 * Activate a genlist mode on an item
19713 * @param item The genlist item
19714 * @param mode Mode name
19715 * @param mode_set Boolean to define set or unset mode.
19717 * A genlist mode is a different way of selecting an item. Once a mode is
19718 * activated on an item, any other selected item is immediately unselected.
19719 * This feature provides an easy way of implementing a new kind of animation
19720 * for selecting an item, without having to entirely rewrite the item style
19721 * theme. However, the elm_genlist_selected_* API can't be used to get what
19722 * item is activate for a mode.
19724 * The current item style will still be used, but applying a genlist mode to
19725 * an item will select it using a different kind of animation.
19727 * The current active item for a mode can be found by
19728 * elm_genlist_mode_item_get().
19730 * The characteristics of genlist mode are:
19731 * - Only one mode can be active at any time, and for only one item.
19732 * - Genlist handles deactivating other items when one item is activated.
19733 * - A mode is defined in the genlist theme (edc), and more modes can easily
19735 * - A mode style and the genlist item style are different things. They
19736 * can be combined to provide a default style to the item, with some kind
19737 * of animation for that item when the mode is activated.
19739 * When a mode is activated on an item, a new view for that item is created.
19740 * The theme of this mode defines the animation that will be used to transit
19741 * the item from the old view to the new view. This second (new) view will be
19742 * active for that item while the mode is active on the item, and will be
19743 * destroyed after the mode is totally deactivated from that item.
19745 * @see elm_genlist_mode_get()
19746 * @see elm_genlist_mode_item_get()
19750 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19752 * Get the last (or current) genlist mode used.
19754 * @param obj The genlist object
19756 * This function just returns the name of the last used genlist mode. It will
19757 * be the current mode if it's still active.
19759 * @see elm_genlist_item_mode_set()
19760 * @see elm_genlist_mode_item_get()
19764 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19766 * Get active genlist mode item
19768 * @param obj The genlist object
19769 * @return The active item for that current mode. Or @c NULL if no item is
19770 * activated with any mode.
19772 * This function returns the item that was activated with a mode, by the
19773 * function elm_genlist_item_mode_set().
19775 * @see elm_genlist_item_mode_set()
19776 * @see elm_genlist_mode_get()
19780 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19785 * @param obj The genlist object
19786 * @param reorder_mode The reorder mode
19787 * (EINA_TRUE = on, EINA_FALSE = off)
19791 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19794 * Get the reorder mode
19796 * @param obj The genlist object
19797 * @return The reorder mode
19798 * (EINA_TRUE = on, EINA_FALSE = off)
19802 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19804 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19805 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19806 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19807 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19808 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19809 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19810 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19811 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19812 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19813 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19820 * @defgroup Check Check
19822 * @image html img/widget/check/preview-00.png
19823 * @image latex img/widget/check/preview-00.eps
19824 * @image html img/widget/check/preview-01.png
19825 * @image latex img/widget/check/preview-01.eps
19826 * @image html img/widget/check/preview-02.png
19827 * @image latex img/widget/check/preview-02.eps
19829 * @brief The check widget allows for toggling a value between true and
19832 * Check objects are a lot like radio objects in layout and functionality
19833 * except they do not work as a group, but independently and only toggle the
19834 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19835 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19836 * returns the current state. For convenience, like the radio objects, you
19837 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19838 * for it to modify.
19840 * Signals that you can add callbacks for are:
19841 * "changed" - This is called whenever the user changes the state of one of
19842 * the check object(event_info is NULL).
19844 * Default contents parts of the check widget that you can use for are:
19845 * @li "icon" - A icon of the check
19847 * Default text parts of the check widget that you can use for are:
19848 * @li "elm.text" - Label of the check
19850 * @ref tutorial_check should give you a firm grasp of how to use this widget
19855 * @brief Add a new Check object
19857 * @param parent The parent object
19858 * @return The new object or NULL if it cannot be created
19860 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19862 * @brief Set the text label of the check object
19864 * @param obj The check object
19865 * @param label The text label string in UTF-8
19867 * @deprecated use elm_object_text_set() instead.
19869 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19871 * @brief Get the text label of the check object
19873 * @param obj The check object
19874 * @return The text label string in UTF-8
19876 * @deprecated use elm_object_text_get() instead.
19878 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19880 * @brief Set the icon object of the check object
19882 * @param obj The check object
19883 * @param icon The icon object
19885 * Once the icon object is set, a previously set one will be deleted.
19886 * If you want to keep that old content object, use the
19887 * elm_object_content_unset() function.
19889 * @deprecated use elm_object_part_content_set() instead.
19892 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19894 * @brief Get the icon object of the check object
19896 * @param obj The check object
19897 * @return The icon object
19899 * @deprecated use elm_object_part_content_get() instead.
19902 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19904 * @brief Unset the icon used for the check object
19906 * @param obj The check object
19907 * @return The icon object that was being used
19909 * Unparent and return the icon object which was set for this widget.
19911 * @deprecated use elm_object_part_content_unset() instead.
19914 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19916 * @brief Set the on/off state of the check object
19918 * @param obj The check object
19919 * @param state The state to use (1 == on, 0 == off)
19921 * This sets the state of the check. If set
19922 * with elm_check_state_pointer_set() the state of that variable is also
19923 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19925 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19927 * @brief Get the state of the check object
19929 * @param obj The check object
19930 * @return The boolean state
19932 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19934 * @brief Set a convenience pointer to a boolean to change
19936 * @param obj The check object
19937 * @param statep Pointer to the boolean to modify
19939 * This sets a pointer to a boolean, that, in addition to the check objects
19940 * state will also be modified directly. To stop setting the object pointed
19941 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19942 * then when this is called, the check objects state will also be modified to
19943 * reflect the value of the boolean @p statep points to, just like calling
19944 * elm_check_state_set().
19946 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19951 /* compatibility code for toggle controls */
19953 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
19957 obj = elm_check_add(parent);
19958 elm_object_style_set(obj, "toggle");
19959 elm_object_part_text_set(obj, "on", "ON");
19960 elm_object_part_text_set(obj, "off", "OFF");
19964 EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
19966 elm_object_text_set(obj, label);
19969 EINA_DEPRECATED EAPI extern inline const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19971 return elm_object_text_get(obj);
19974 EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
19976 elm_object_content_set(obj, icon);
19979 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
19981 return elm_object_content_get(obj);
19984 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
19986 return elm_object_content_unset(obj);
19989 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
19991 elm_object_part_text_set(obj, "on", onlabel);
19992 elm_object_part_text_set(obj, "off", offlabel);
19995 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)
19997 if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
19998 if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20001 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20003 elm_check_state_set(obj, state);
20006 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20008 return elm_check_state_get(obj);
20011 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20013 elm_check_state_pointer_set(obj, statep);
20017 * @defgroup Radio Radio
20019 * @image html img/widget/radio/preview-00.png
20020 * @image latex img/widget/radio/preview-00.eps
20022 * @brief Radio is a widget that allows for 1 or more options to be displayed
20023 * and have the user choose only 1 of them.
20025 * A radio object contains an indicator, an optional Label and an optional
20026 * icon object. While it's possible to have a group of only one radio they,
20027 * are normally used in groups of 2 or more. To add a radio to a group use
20028 * elm_radio_group_add(). The radio object(s) will select from one of a set
20029 * of integer values, so any value they are configuring needs to be mapped to
20030 * a set of integers. To configure what value that radio object represents,
20031 * use elm_radio_state_value_set() to set the integer it represents. To set
20032 * the value the whole group(which one is currently selected) is to indicate
20033 * use elm_radio_value_set() on any group member, and to get the groups value
20034 * use elm_radio_value_get(). For convenience the radio objects are also able
20035 * to directly set an integer(int) to the value that is selected. To specify
20036 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20037 * The radio objects will modify this directly. That implies the pointer must
20038 * point to valid memory for as long as the radio objects exist.
20040 * Signals that you can add callbacks for are:
20041 * @li changed - This is called whenever the user changes the state of one of
20042 * the radio objects within the group of radio objects that work together.
20044 * Default contents parts of the radio widget that you can use for are:
20045 * @li "icon" - A icon of the radio
20047 * @ref tutorial_radio show most of this API in action.
20051 * @brief Add a new radio to the parent
20053 * @param parent The parent object
20054 * @return The new object or NULL if it cannot be created
20056 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20058 * @brief Set the text label of the radio object
20060 * @param obj The radio object
20061 * @param label The text label string in UTF-8
20063 * @deprecated use elm_object_text_set() instead.
20065 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20067 * @brief Get the text label of the radio object
20069 * @param obj The radio object
20070 * @return The text label string in UTF-8
20072 * @deprecated use elm_object_text_set() instead.
20074 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20076 * @brief Set the icon object of the radio object
20078 * @param obj The radio object
20079 * @param icon The icon object
20081 * Once the icon object is set, a previously set one will be deleted. If you
20082 * want to keep that old content object, use the elm_radio_icon_unset()
20085 * @deprecated use elm_object_part_content_set() instead.
20088 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20090 * @brief Get the icon object of the radio object
20092 * @param obj The radio object
20093 * @return The icon object
20095 * @see elm_radio_icon_set()
20097 * @deprecated use elm_object_part_content_get() instead.
20100 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20102 * @brief Unset the icon used for the radio object
20104 * @param obj The radio object
20105 * @return The icon object that was being used
20107 * Unparent and return the icon object which was set for this widget.
20109 * @see elm_radio_icon_set()
20110 * @deprecated use elm_object_part_content_unset() instead.
20113 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20115 * @brief Add this radio to a group of other radio objects
20117 * @param obj The radio object
20118 * @param group Any object whose group the @p obj is to join.
20120 * Radio objects work in groups. Each member should have a different integer
20121 * value assigned. In order to have them work as a group, they need to know
20122 * about each other. This adds the given radio object to the group of which
20123 * the group object indicated is a member.
20125 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20127 * @brief Set the integer value that this radio object represents
20129 * @param obj The radio object
20130 * @param value The value to use if this radio object is selected
20132 * This sets the value of the radio.
20134 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20136 * @brief Get the integer value that this radio object represents
20138 * @param obj The radio object
20139 * @return The value used if this radio object is selected
20141 * This gets the value of the radio.
20143 * @see elm_radio_value_set()
20145 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20147 * @brief Set the value of the radio.
20149 * @param obj The radio object
20150 * @param value The value to use for the group
20152 * This sets the value of the radio group and will also set the value if
20153 * pointed to, to the value supplied, but will not call any callbacks.
20155 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20157 * @brief Get the state of the radio object
20159 * @param obj The radio object
20160 * @return The integer state
20162 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20164 * @brief Set a convenience pointer to a integer to change
20166 * @param obj The radio object
20167 * @param valuep Pointer to the integer to modify
20169 * This sets a pointer to a integer, that, in addition to the radio objects
20170 * state will also be modified directly. To stop setting the object pointed
20171 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20172 * when this is called, the radio objects state will also be modified to
20173 * reflect the value of the integer valuep points to, just like calling
20174 * elm_radio_value_set().
20176 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20182 * @defgroup Pager Pager
20184 * @image html img/widget/pager/preview-00.png
20185 * @image latex img/widget/pager/preview-00.eps
20187 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20189 * The flipping between āpagesā of objects is animated. All content in pager
20190 * is kept in a stack, the last content to be added will be on the top of the
20191 * stack(be visible).
20193 * Objects can be pushed or popped from the stack or deleted as normal.
20194 * Pushes and pops will animate (and a pop will delete the object once the
20195 * animation is finished). Any object already in the pager can be promoted to
20196 * the top(from its current stacking position) through the use of
20197 * elm_pager_content_promote(). Objects are pushed to the top with
20198 * elm_pager_content_push() and when the top item is no longer wanted, simply
20199 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20200 * object is no longer needed and is not the top item, just delete it as
20201 * normal. You can query which objects are the top and bottom with
20202 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20204 * Signals that you can add callbacks for are:
20205 * "hide,finished" - when the previous page is hided
20207 * This widget has the following styles available:
20210 * @li fade_translucide
20211 * @li fade_invisible
20212 * @note This styles affect only the flipping animations, the appearance when
20213 * not animating is unaffected by styles.
20215 * @ref tutorial_pager gives a good overview of the usage of the API.
20219 * Add a new pager to the parent
20221 * @param parent The parent object
20222 * @return The new object or NULL if it cannot be created
20226 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20229 * @brief Push an object to the top of the pager stack (and show it).
20231 * @param obj The pager object
20232 * @param content The object to push
20234 * The object pushed becomes a child of the pager, it will be controlled and
20235 * deleted when the pager is deleted.
20237 * @note If the content is already in the stack use
20238 * elm_pager_content_promote().
20239 * @warning Using this function on @p content already in the stack results in
20240 * undefined behavior.
20242 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20245 * @brief Pop the object that is on top of the stack
20247 * @param obj The pager object
20249 * This pops the object that is on the top(visible) of the pager, makes it
20250 * disappear, then deletes the object. The object that was underneath it on
20251 * the stack will become visible.
20253 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20256 * @brief Moves an object already in the pager stack to the top of the stack.
20258 * @param obj The pager object
20259 * @param content The object to promote
20261 * This will take the @p content and move it to the top of the stack as
20262 * if it had been pushed there.
20264 * @note If the content isn't already in the stack use
20265 * elm_pager_content_push().
20266 * @warning Using this function on @p content not already in the stack
20267 * results in undefined behavior.
20269 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20272 * @brief Return the object at the bottom of the pager stack
20274 * @param obj The pager object
20275 * @return The bottom object or NULL if none
20277 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20280 * @brief Return the object at the top of the pager stack
20282 * @param obj The pager object
20283 * @return The top object or NULL if none
20285 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20287 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20288 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20295 * @defgroup Slideshow Slideshow
20297 * @image html img/widget/slideshow/preview-00.png
20298 * @image latex img/widget/slideshow/preview-00.eps
20300 * This widget, as the name indicates, is a pre-made image
20301 * slideshow panel, with API functions acting on (child) image
20302 * items presentation. Between those actions, are:
20303 * - advance to next/previous image
20304 * - select the style of image transition animation
20305 * - set the exhibition time for each image
20306 * - start/stop the slideshow
20308 * The transition animations are defined in the widget's theme,
20309 * consequently new animations can be added without having to
20310 * update the widget's code.
20312 * @section Slideshow_Items Slideshow items
20314 * For slideshow items, just like for @ref Genlist "genlist" ones,
20315 * the user defines a @b classes, specifying functions that will be
20316 * called on the item's creation and deletion times.
20318 * The #Elm_Slideshow_Item_Class structure contains the following
20321 * - @c func.get - When an item is displayed, this function is
20322 * called, and it's where one should create the item object, de
20323 * facto. For example, the object can be a pure Evas image object
20324 * or an Elementary @ref Photocam "photocam" widget. See
20325 * #SlideshowItemGetFunc.
20326 * - @c func.del - When an item is no more displayed, this function
20327 * is called, where the user must delete any data associated to
20328 * the item. See #SlideshowItemDelFunc.
20330 * @section Slideshow_Caching Slideshow caching
20332 * The slideshow provides facilities to have items adjacent to the
20333 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20334 * you, so that the system does not have to decode image data
20335 * anymore at the time it has to actually switch images on its
20336 * viewport. The user is able to set the numbers of items to be
20337 * cached @b before and @b after the current item, in the widget's
20340 * Smart events one can add callbacks for are:
20342 * - @c "changed" - when the slideshow switches its view to a new
20345 * List of examples for the slideshow widget:
20346 * @li @ref slideshow_example
20350 * @addtogroup Slideshow
20354 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20355 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20356 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20357 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20358 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20361 * @struct _Elm_Slideshow_Item_Class
20363 * Slideshow item class definition. See @ref Slideshow_Items for
20366 struct _Elm_Slideshow_Item_Class
20368 struct _Elm_Slideshow_Item_Class_Func
20370 SlideshowItemGetFunc get;
20371 SlideshowItemDelFunc del;
20373 }; /**< #Elm_Slideshow_Item_Class member definitions */
20376 * Add a new slideshow widget to the given parent Elementary
20377 * (container) object
20379 * @param parent The parent object
20380 * @return A new slideshow widget handle or @c NULL, on errors
20382 * This function inserts a new slideshow widget on the canvas.
20384 * @ingroup Slideshow
20386 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20389 * Add (append) a new item in a given slideshow widget.
20391 * @param obj The slideshow object
20392 * @param itc The item class for the item
20393 * @param data The item's data
20394 * @return A handle to the item added or @c NULL, on errors
20396 * Add a new item to @p obj's internal list of items, appending it.
20397 * The item's class must contain the function really fetching the
20398 * image object to show for this item, which could be an Evas image
20399 * object or an Elementary photo, for example. The @p data
20400 * parameter is going to be passed to both class functions of the
20403 * @see #Elm_Slideshow_Item_Class
20404 * @see elm_slideshow_item_sorted_insert()
20406 * @ingroup Slideshow
20408 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20411 * Insert a new item into the given slideshow widget, using the @p func
20412 * function to sort items (by item handles).
20414 * @param obj The slideshow object
20415 * @param itc The item class for the item
20416 * @param data The item's data
20417 * @param func The comparing function to be used to sort slideshow
20418 * items <b>by #Elm_Slideshow_Item item handles</b>
20419 * @return Returns The slideshow item handle, on success, or
20420 * @c NULL, on errors
20422 * Add a new item to @p obj's internal list of items, in a position
20423 * determined by the @p func comparing function. The item's class
20424 * must contain the function really fetching the image object to
20425 * show for this item, which could be an Evas image object or an
20426 * Elementary photo, for example. The @p data parameter is going to
20427 * be passed to both class functions of the item.
20429 * @see #Elm_Slideshow_Item_Class
20430 * @see elm_slideshow_item_add()
20432 * @ingroup Slideshow
20434 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);
20437 * Display a given slideshow widget's item, programmatically.
20439 * @param obj The slideshow object
20440 * @param item The item to display on @p obj's viewport
20442 * The change between the current item and @p item will use the
20443 * transition @p obj is set to use (@see
20444 * elm_slideshow_transition_set()).
20446 * @ingroup Slideshow
20448 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20451 * Slide to the @b next item, in a given slideshow widget
20453 * @param obj The slideshow object
20455 * The sliding animation @p obj is set to use will be the
20456 * transition effect used, after this call is issued.
20458 * @note If the end of the slideshow's internal list of items is
20459 * reached, it'll wrap around to the list's beginning, again.
20461 * @ingroup Slideshow
20463 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20466 * Slide to the @b previous item, in a given slideshow widget
20468 * @param obj The slideshow object
20470 * The sliding animation @p obj is set to use will be the
20471 * transition effect used, after this call is issued.
20473 * @note If the beginning of the slideshow's internal list of items
20474 * is reached, it'll wrap around to the list's end, again.
20476 * @ingroup Slideshow
20478 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20481 * Returns the list of sliding transition/effect names available, for a
20482 * given slideshow widget.
20484 * @param obj The slideshow object
20485 * @return The list of transitions (list of @b stringshared strings
20488 * The transitions, which come from @p obj's theme, must be an EDC
20489 * data item named @c "transitions" on the theme file, with (prefix)
20490 * names of EDC programs actually implementing them.
20492 * The available transitions for slideshows on the default theme are:
20493 * - @c "fade" - the current item fades out, while the new one
20494 * fades in to the slideshow's viewport.
20495 * - @c "black_fade" - the current item fades to black, and just
20496 * then, the new item will fade in.
20497 * - @c "horizontal" - the current item slides horizontally, until
20498 * it gets out of the slideshow's viewport, while the new item
20499 * comes from the left to take its place.
20500 * - @c "vertical" - the current item slides vertically, until it
20501 * gets out of the slideshow's viewport, while the new item comes
20502 * from the bottom to take its place.
20503 * - @c "square" - the new item starts to appear from the middle of
20504 * the current one, but with a tiny size, growing until its
20505 * target (full) size and covering the old one.
20507 * @warning The stringshared strings get no new references
20508 * exclusive to the user grabbing the list, here, so if you'd like
20509 * to use them out of this call's context, you'd better @c
20510 * eina_stringshare_ref() them.
20512 * @see elm_slideshow_transition_set()
20514 * @ingroup Slideshow
20516 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20519 * Set the current slide transition/effect in use for a given
20522 * @param obj The slideshow object
20523 * @param transition The new transition's name string
20525 * If @p transition is implemented in @p obj's theme (i.e., is
20526 * contained in the list returned by
20527 * elm_slideshow_transitions_get()), this new sliding effect will
20528 * be used on the widget.
20530 * @see elm_slideshow_transitions_get() for more details
20532 * @ingroup Slideshow
20534 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20537 * Get the current slide transition/effect in use for a given
20540 * @param obj The slideshow object
20541 * @return The current transition's name
20543 * @see elm_slideshow_transition_set() for more details
20545 * @ingroup Slideshow
20547 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20550 * Set the interval between each image transition on a given
20551 * slideshow widget, <b>and start the slideshow, itself</b>
20553 * @param obj The slideshow object
20554 * @param timeout The new displaying timeout for images
20556 * After this call, the slideshow widget will start cycling its
20557 * view, sequentially and automatically, with the images of the
20558 * items it has. The time between each new image displayed is going
20559 * to be @p timeout, in @b seconds. If a different timeout was set
20560 * previously and an slideshow was in progress, it will continue
20561 * with the new time between transitions, after this call.
20563 * @note A value less than or equal to 0 on @p timeout will disable
20564 * the widget's internal timer, thus halting any slideshow which
20565 * could be happening on @p obj.
20567 * @see elm_slideshow_timeout_get()
20569 * @ingroup Slideshow
20571 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20574 * Get the interval set for image transitions on a given slideshow
20577 * @param obj The slideshow object
20578 * @return Returns the timeout set on it
20580 * @see elm_slideshow_timeout_set() for more details
20582 * @ingroup Slideshow
20584 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20587 * Set if, after a slideshow is started, for a given slideshow
20588 * widget, its items should be displayed cyclically or not.
20590 * @param obj The slideshow object
20591 * @param loop Use @c EINA_TRUE to make it cycle through items or
20592 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20595 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20596 * ignore what is set by this functions, i.e., they'll @b always
20597 * cycle through items. This affects only the "automatic"
20598 * slideshow, as set by elm_slideshow_timeout_set().
20600 * @see elm_slideshow_loop_get()
20602 * @ingroup Slideshow
20604 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20607 * Get if, after a slideshow is started, for a given slideshow
20608 * widget, its items are to be displayed cyclically or not.
20610 * @param obj The slideshow object
20611 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20612 * through or @c EINA_FALSE, otherwise
20614 * @see elm_slideshow_loop_set() for more details
20616 * @ingroup Slideshow
20618 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20621 * Remove all items from a given slideshow widget
20623 * @param obj The slideshow object
20625 * This removes (and deletes) all items in @p obj, leaving it
20628 * @see elm_slideshow_item_del(), to remove just one item.
20630 * @ingroup Slideshow
20632 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20635 * Get the internal list of items in a given slideshow widget.
20637 * @param obj The slideshow object
20638 * @return The list of items (#Elm_Slideshow_Item as data) or
20639 * @c NULL on errors.
20641 * This list is @b not to be modified in any way and must not be
20642 * freed. Use the list members with functions like
20643 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20645 * @warning This list is only valid until @p obj object's internal
20646 * items list is changed. It should be fetched again with another
20647 * call to this function when changes happen.
20649 * @ingroup Slideshow
20651 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20654 * Delete a given item from a slideshow widget.
20656 * @param item The slideshow item
20658 * @ingroup Slideshow
20660 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20663 * Return the data associated with a given slideshow item
20665 * @param item The slideshow item
20666 * @return Returns the data associated to this item
20668 * @ingroup Slideshow
20670 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20673 * Returns the currently displayed item, in a given slideshow widget
20675 * @param obj The slideshow object
20676 * @return A handle to the item being displayed in @p obj or
20677 * @c NULL, if none is (and on errors)
20679 * @ingroup Slideshow
20681 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20684 * Get the real Evas object created to implement the view of a
20685 * given slideshow item
20687 * @param item The slideshow item.
20688 * @return the Evas object implementing this item's view.
20690 * This returns the actual Evas object used to implement the
20691 * specified slideshow item's view. This may be @c NULL, as it may
20692 * not have been created or may have been deleted, at any time, by
20693 * the slideshow. <b>Do not modify this object</b> (move, resize,
20694 * show, hide, etc.), as the slideshow is controlling it. This
20695 * function is for querying, emitting custom signals or hooking
20696 * lower level callbacks for events on that object. Do not delete
20697 * this object under any circumstances.
20699 * @see elm_slideshow_item_data_get()
20701 * @ingroup Slideshow
20703 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20706 * Get the the item, in a given slideshow widget, placed at
20707 * position @p nth, in its internal items list
20709 * @param obj The slideshow object
20710 * @param nth The number of the item to grab a handle to (0 being
20712 * @return The item stored in @p obj at position @p nth or @c NULL,
20713 * if there's no item with that index (and on errors)
20715 * @ingroup Slideshow
20717 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20720 * Set the current slide layout in use for a given slideshow widget
20722 * @param obj The slideshow object
20723 * @param layout The new layout's name string
20725 * If @p layout is implemented in @p obj's theme (i.e., is contained
20726 * in the list returned by elm_slideshow_layouts_get()), this new
20727 * images layout will be used on the widget.
20729 * @see elm_slideshow_layouts_get() for more details
20731 * @ingroup Slideshow
20733 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20736 * Get the current slide layout in use for a given slideshow widget
20738 * @param obj The slideshow object
20739 * @return The current layout's name
20741 * @see elm_slideshow_layout_set() for more details
20743 * @ingroup Slideshow
20745 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20748 * Returns the list of @b layout names available, for a given
20749 * slideshow widget.
20751 * @param obj The slideshow object
20752 * @return The list of layouts (list of @b stringshared strings
20755 * Slideshow layouts will change how the widget is to dispose each
20756 * image item in its viewport, with regard to cropping, scaling,
20759 * The layouts, which come from @p obj's theme, must be an EDC
20760 * data item name @c "layouts" on the theme file, with (prefix)
20761 * names of EDC programs actually implementing them.
20763 * The available layouts for slideshows on the default theme are:
20764 * - @c "fullscreen" - item images with original aspect, scaled to
20765 * touch top and down slideshow borders or, if the image's heigh
20766 * is not enough, left and right slideshow borders.
20767 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20768 * one, but always leaving 10% of the slideshow's dimensions of
20769 * distance between the item image's borders and the slideshow
20770 * borders, for each axis.
20772 * @warning The stringshared strings get no new references
20773 * exclusive to the user grabbing the list, here, so if you'd like
20774 * to use them out of this call's context, you'd better @c
20775 * eina_stringshare_ref() them.
20777 * @see elm_slideshow_layout_set()
20779 * @ingroup Slideshow
20781 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20784 * Set the number of items to cache, on a given slideshow widget,
20785 * <b>before the current item</b>
20787 * @param obj The slideshow object
20788 * @param count Number of items to cache before the current one
20790 * The default value for this property is @c 2. See
20791 * @ref Slideshow_Caching "slideshow caching" for more details.
20793 * @see elm_slideshow_cache_before_get()
20795 * @ingroup Slideshow
20797 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20800 * Retrieve the number of items to cache, on a given slideshow widget,
20801 * <b>before the current item</b>
20803 * @param obj The slideshow object
20804 * @return The number of items set to be cached before the current one
20806 * @see elm_slideshow_cache_before_set() for more details
20808 * @ingroup Slideshow
20810 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20813 * Set the number of items to cache, on a given slideshow widget,
20814 * <b>after the current item</b>
20816 * @param obj The slideshow object
20817 * @param count Number of items to cache after the current one
20819 * The default value for this property is @c 2. See
20820 * @ref Slideshow_Caching "slideshow caching" for more details.
20822 * @see elm_slideshow_cache_after_get()
20824 * @ingroup Slideshow
20826 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20829 * Retrieve the number of items to cache, on a given slideshow widget,
20830 * <b>after the current item</b>
20832 * @param obj The slideshow object
20833 * @return The number of items set to be cached after the current one
20835 * @see elm_slideshow_cache_after_set() for more details
20837 * @ingroup Slideshow
20839 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20842 * Get the number of items stored in a given slideshow widget
20844 * @param obj The slideshow object
20845 * @return The number of items on @p obj, at the moment of this call
20847 * @ingroup Slideshow
20849 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20856 * @defgroup Fileselector File Selector
20858 * @image html img/widget/fileselector/preview-00.png
20859 * @image latex img/widget/fileselector/preview-00.eps
20861 * A file selector is a widget that allows a user to navigate
20862 * through a file system, reporting file selections back via its
20865 * It contains shortcut buttons for home directory (@c ~) and to
20866 * jump one directory upwards (..), as well as cancel/ok buttons to
20867 * confirm/cancel a given selection. After either one of those two
20868 * former actions, the file selector will issue its @c "done" smart
20871 * There's a text entry on it, too, showing the name of the current
20872 * selection. There's the possibility of making it editable, so it
20873 * is useful on file saving dialogs on applications, where one
20874 * gives a file name to save contents to, in a given directory in
20875 * the system. This custom file name will be reported on the @c
20876 * "done" smart callback (explained in sequence).
20878 * Finally, it has a view to display file system items into in two
20883 * If Elementary is built with support of the Ethumb thumbnailing
20884 * library, the second form of view will display preview thumbnails
20885 * of files which it supports.
20887 * Smart callbacks one can register to:
20889 * - @c "selected" - the user has clicked on a file (when not in
20890 * folders-only mode) or directory (when in folders-only mode)
20891 * - @c "directory,open" - the list has been populated with new
20892 * content (@c event_info is a pointer to the directory's
20893 * path, a @b stringshared string)
20894 * - @c "done" - the user has clicked on the "ok" or "cancel"
20895 * buttons (@c event_info is a pointer to the selection's
20896 * path, a @b stringshared string)
20898 * Here is an example on its usage:
20899 * @li @ref fileselector_example
20903 * @addtogroup Fileselector
20908 * Defines how a file selector widget is to layout its contents
20909 * (file system entries).
20911 typedef enum _Elm_Fileselector_Mode
20913 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20914 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20915 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20916 } Elm_Fileselector_Mode;
20919 * Add a new file selector widget to the given parent Elementary
20920 * (container) object
20922 * @param parent The parent object
20923 * @return a new file selector widget handle or @c NULL, on errors
20925 * This function inserts a new file selector widget on the canvas.
20927 * @ingroup Fileselector
20929 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20932 * Enable/disable the file name entry box where the user can type
20933 * in a name for a file, in a given file selector widget
20935 * @param obj The file selector object
20936 * @param is_save @c EINA_TRUE to make the file selector a "saving
20937 * dialog", @c EINA_FALSE otherwise
20939 * Having the entry editable is useful on file saving dialogs on
20940 * applications, where one gives a file name to save contents to,
20941 * in a given directory in the system. This custom file name will
20942 * be reported on the @c "done" smart callback.
20944 * @see elm_fileselector_is_save_get()
20946 * @ingroup Fileselector
20948 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20951 * Get whether the given file selector is in "saving dialog" mode
20953 * @param obj The file selector object
20954 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20955 * mode, @c EINA_FALSE otherwise (and on errors)
20957 * @see elm_fileselector_is_save_set() for more details
20959 * @ingroup Fileselector
20961 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20964 * Enable/disable folder-only view for a given file selector widget
20966 * @param obj The file selector object
20967 * @param only @c EINA_TRUE to make @p obj only display
20968 * directories, @c EINA_FALSE to make files to be displayed in it
20971 * If enabled, the widget's view will only display folder items,
20974 * @see elm_fileselector_folder_only_get()
20976 * @ingroup Fileselector
20978 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20981 * Get whether folder-only view is set for a given file selector
20984 * @param obj The file selector object
20985 * @return only @c EINA_TRUE if @p obj is only displaying
20986 * directories, @c EINA_FALSE if files are being displayed in it
20987 * too (and on errors)
20989 * @see elm_fileselector_folder_only_get()
20991 * @ingroup Fileselector
20993 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20996 * Enable/disable the "ok" and "cancel" buttons on a given file
20999 * @param obj The file selector object
21000 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21002 * @note A file selector without those buttons will never emit the
21003 * @c "done" smart event, and is only usable if one is just hooking
21004 * to the other two events.
21006 * @see elm_fileselector_buttons_ok_cancel_get()
21008 * @ingroup Fileselector
21010 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21013 * Get whether the "ok" and "cancel" buttons on a given file
21014 * selector widget are being shown.
21016 * @param obj The file selector object
21017 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21018 * otherwise (and on errors)
21020 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21022 * @ingroup Fileselector
21024 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21027 * Enable/disable a tree view in the given file selector widget,
21028 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21030 * @param obj The file selector object
21031 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21034 * In a tree view, arrows are created on the sides of directories,
21035 * allowing them to expand in place.
21037 * @note If it's in other mode, the changes made by this function
21038 * will only be visible when one switches back to "list" mode.
21040 * @see elm_fileselector_expandable_get()
21042 * @ingroup Fileselector
21044 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21047 * Get whether tree view is enabled for the given file selector
21050 * @param obj The file selector object
21051 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21052 * otherwise (and or errors)
21054 * @see elm_fileselector_expandable_set() for more details
21056 * @ingroup Fileselector
21058 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21061 * Set, programmatically, the @b directory that a given file
21062 * selector widget will display contents from
21064 * @param obj The file selector object
21065 * @param path The path to display in @p obj
21067 * This will change the @b directory that @p obj is displaying. It
21068 * will also clear the text entry area on the @p obj object, which
21069 * displays select files' names.
21071 * @see elm_fileselector_path_get()
21073 * @ingroup Fileselector
21075 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21078 * Get the parent directory's path that a given file selector
21079 * widget is displaying
21081 * @param obj The file selector object
21082 * @return The (full) path of the directory the file selector is
21083 * displaying, a @b stringshared string
21085 * @see elm_fileselector_path_set()
21087 * @ingroup Fileselector
21089 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21092 * Set, programmatically, the currently selected file/directory in
21093 * the given file selector widget
21095 * @param obj The file selector object
21096 * @param path The (full) path to a file or directory
21097 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21098 * latter case occurs if the directory or file pointed to do not
21101 * @see elm_fileselector_selected_get()
21103 * @ingroup Fileselector
21105 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21108 * Get the currently selected item's (full) path, in the given file
21111 * @param obj The file selector object
21112 * @return The absolute path of the selected item, a @b
21113 * stringshared string
21115 * @note Custom editions on @p obj object's text entry, if made,
21116 * will appear on the return string of this function, naturally.
21118 * @see elm_fileselector_selected_set() for more details
21120 * @ingroup Fileselector
21122 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21125 * Set the mode in which a given file selector widget will display
21126 * (layout) file system entries in its view
21128 * @param obj The file selector object
21129 * @param mode The mode of the fileselector, being it one of
21130 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21131 * first one, naturally, will display the files in a list. The
21132 * latter will make the widget to display its entries in a grid
21135 * @note By using elm_fileselector_expandable_set(), the user may
21136 * trigger a tree view for that list.
21138 * @note If Elementary is built with support of the Ethumb
21139 * thumbnailing library, the second form of view will display
21140 * preview thumbnails of files which it supports. You must have
21141 * elm_need_ethumb() called in your Elementary for thumbnailing to
21144 * @see elm_fileselector_expandable_set().
21145 * @see elm_fileselector_mode_get().
21147 * @ingroup Fileselector
21149 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21152 * Get the mode in which a given file selector widget is displaying
21153 * (layouting) file system entries in its view
21155 * @param obj The fileselector object
21156 * @return The mode in which the fileselector is at
21158 * @see elm_fileselector_mode_set() for more details
21160 * @ingroup Fileselector
21162 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21169 * @defgroup Progressbar Progress bar
21171 * The progress bar is a widget for visually representing the
21172 * progress status of a given job/task.
21174 * A progress bar may be horizontal or vertical. It may display an
21175 * icon besides it, as well as primary and @b units labels. The
21176 * former is meant to label the widget as a whole, while the
21177 * latter, which is formatted with floating point values (and thus
21178 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21179 * units"</c>), is meant to label the widget's <b>progress
21180 * value</b>. Label, icon and unit strings/objects are @b optional
21181 * for progress bars.
21183 * A progress bar may be @b inverted, in which state it gets its
21184 * values inverted, with high values being on the left or top and
21185 * low values on the right or bottom, as opposed to normally have
21186 * the low values on the former and high values on the latter,
21187 * respectively, for horizontal and vertical modes.
21189 * The @b span of the progress, as set by
21190 * elm_progressbar_span_size_set(), is its length (horizontally or
21191 * vertically), unless one puts size hints on the widget to expand
21192 * on desired directions, by any container. That length will be
21193 * scaled by the object or applications scaling factor. At any
21194 * point code can query the progress bar for its value with
21195 * elm_progressbar_value_get().
21197 * Available widget styles for progress bars:
21199 * - @c "wheel" (simple style, no text, no progression, only
21200 * "pulse" effect is available)
21202 * Default contents parts of the progressbar widget that you can use for are:
21203 * @li "icon" - A icon of the progressbar
21205 * Here is an example on its usage:
21206 * @li @ref progressbar_example
21210 * Add a new progress bar widget to the given parent Elementary
21211 * (container) object
21213 * @param parent The parent object
21214 * @return a new progress bar widget handle or @c NULL, on errors
21216 * This function inserts a new progress bar widget on the canvas.
21218 * @ingroup Progressbar
21220 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21223 * Set whether a given progress bar widget is at "pulsing mode" or
21226 * @param obj The progress bar object
21227 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21228 * @c EINA_FALSE to put it back to its default one
21230 * By default, progress bars will display values from the low to
21231 * high value boundaries. There are, though, contexts in which the
21232 * state of progression of a given task is @b unknown. For those,
21233 * one can set a progress bar widget to a "pulsing state", to give
21234 * the user an idea that some computation is being held, but
21235 * without exact progress values. In the default theme it will
21236 * animate its bar with the contents filling in constantly and back
21237 * to non-filled, in a loop. To start and stop this pulsing
21238 * animation, one has to explicitly call elm_progressbar_pulse().
21240 * @see elm_progressbar_pulse_get()
21241 * @see elm_progressbar_pulse()
21243 * @ingroup Progressbar
21245 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21248 * Get whether a given progress bar widget is at "pulsing mode" or
21251 * @param obj The progress bar object
21252 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21253 * if it's in the default one (and on errors)
21255 * @ingroup Progressbar
21257 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21260 * Start/stop a given progress bar "pulsing" animation, if its
21263 * @param obj The progress bar object
21264 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21265 * @c EINA_FALSE to @b stop it
21267 * @note This call won't do anything if @p obj is not under "pulsing mode".
21269 * @see elm_progressbar_pulse_set() for more details.
21271 * @ingroup Progressbar
21273 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21276 * Set the progress value (in percentage) on a given progress bar
21279 * @param obj The progress bar object
21280 * @param val The progress value (@b must be between @c 0.0 and @c
21283 * Use this call to set progress bar levels.
21285 * @note If you passes a value out of the specified range for @p
21286 * val, it will be interpreted as the @b closest of the @b boundary
21287 * values in the range.
21289 * @ingroup Progressbar
21291 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21294 * Get the progress value (in percentage) on a given progress bar
21297 * @param obj The progress bar object
21298 * @return The value of the progressbar
21300 * @see elm_progressbar_value_set() for more details
21302 * @ingroup Progressbar
21304 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21307 * Set the label of a given progress bar widget
21309 * @param obj The progress bar object
21310 * @param label The text label string, in UTF-8
21312 * @ingroup Progressbar
21313 * @deprecated use elm_object_text_set() instead.
21315 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21318 * Get the label of a given progress bar widget
21320 * @param obj The progressbar object
21321 * @return The text label string, in UTF-8
21323 * @ingroup Progressbar
21324 * @deprecated use elm_object_text_set() instead.
21326 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21329 * Set the icon object of a given progress bar widget
21331 * @param obj The progress bar object
21332 * @param icon The icon object
21334 * Use this call to decorate @p obj with an icon next to it.
21336 * @note Once the icon object is set, a previously set one will be
21337 * deleted. If you want to keep that old content object, use the
21338 * elm_progressbar_icon_unset() function.
21340 * @see elm_progressbar_icon_get()
21341 * @deprecated use elm_object_part_content_set() instead.
21343 * @ingroup Progressbar
21345 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21348 * Retrieve the icon object set for a given progress bar widget
21350 * @param obj The progress bar object
21351 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21352 * otherwise (and on errors)
21354 * @see elm_progressbar_icon_set() for more details
21355 * @deprecated use elm_object_part_content_get() instead.
21357 * @ingroup Progressbar
21359 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21362 * Unset an icon set on a given progress bar widget
21364 * @param obj The progress bar object
21365 * @return The icon object that was being used, if any was set, or
21366 * @c NULL, otherwise (and on errors)
21368 * This call will unparent and return the icon object which was set
21369 * for this widget, previously, on success.
21371 * @see elm_progressbar_icon_set() for more details
21372 * @deprecated use elm_object_part_content_unset() instead.
21374 * @ingroup Progressbar
21376 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21379 * Set the (exact) length of the bar region of a given progress bar
21382 * @param obj The progress bar object
21383 * @param size The length of the progress bar's bar region
21385 * This sets the minimum width (when in horizontal mode) or height
21386 * (when in vertical mode) of the actual bar area of the progress
21387 * bar @p obj. This in turn affects the object's minimum size. Use
21388 * this when you're not setting other size hints expanding on the
21389 * given direction (like weight and alignment hints) and you would
21390 * like it to have a specific size.
21392 * @note Icon, label and unit text around @p obj will require their
21393 * own space, which will make @p obj to require more the @p size,
21396 * @see elm_progressbar_span_size_get()
21398 * @ingroup Progressbar
21400 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21403 * Get the length set for the bar region of a given progress bar
21406 * @param obj The progress bar object
21407 * @return The length of the progress bar's bar region
21409 * If that size was not set previously, with
21410 * elm_progressbar_span_size_set(), this call will return @c 0.
21412 * @ingroup Progressbar
21414 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21417 * Set the format string for a given progress bar widget's units
21420 * @param obj The progress bar object
21421 * @param format The format string for @p obj's units label
21423 * If @c NULL is passed on @p format, it will make @p obj's units
21424 * area to be hidden completely. If not, it'll set the <b>format
21425 * string</b> for the units label's @b text. The units label is
21426 * provided a floating point value, so the units text is up display
21427 * at most one floating point falue. Note that the units label is
21428 * optional. Use a format string such as "%1.2f meters" for
21431 * @note The default format string for a progress bar is an integer
21432 * percentage, as in @c "%.0f %%".
21434 * @see elm_progressbar_unit_format_get()
21436 * @ingroup Progressbar
21438 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21441 * Retrieve the format string set for a given progress bar widget's
21444 * @param obj The progress bar object
21445 * @return The format set string for @p obj's units label or
21446 * @c NULL, if none was set (and on errors)
21448 * @see elm_progressbar_unit_format_set() for more details
21450 * @ingroup Progressbar
21452 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21455 * Set the orientation of a given progress bar widget
21457 * @param obj The progress bar object
21458 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21459 * @b horizontal, @c EINA_FALSE to make it @b vertical
21461 * Use this function to change how your progress bar is to be
21462 * disposed: vertically or horizontally.
21464 * @see elm_progressbar_horizontal_get()
21466 * @ingroup Progressbar
21468 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21471 * Retrieve the orientation of a given progress bar widget
21473 * @param obj The progress bar object
21474 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21475 * @c EINA_FALSE if it's @b vertical (and on errors)
21477 * @see elm_progressbar_horizontal_set() for more details
21479 * @ingroup Progressbar
21481 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21484 * Invert a given progress bar widget's displaying values order
21486 * @param obj The progress bar object
21487 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21488 * @c EINA_FALSE to bring it back to default, non-inverted values.
21490 * A progress bar may be @b inverted, in which state it gets its
21491 * values inverted, with high values being on the left or top and
21492 * low values on the right or bottom, as opposed to normally have
21493 * the low values on the former and high values on the latter,
21494 * respectively, for horizontal and vertical modes.
21496 * @see elm_progressbar_inverted_get()
21498 * @ingroup Progressbar
21500 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21503 * Get whether a given progress bar widget's displaying values are
21506 * @param obj The progress bar object
21507 * @return @c EINA_TRUE, if @p obj has inverted values,
21508 * @c EINA_FALSE otherwise (and on errors)
21510 * @see elm_progressbar_inverted_set() for more details
21512 * @ingroup Progressbar
21514 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21517 * @defgroup Separator Separator
21519 * @brief Separator is a very thin object used to separate other objects.
21521 * A separator can be vertical or horizontal.
21523 * @ref tutorial_separator is a good example of how to use a separator.
21527 * @brief Add a separator object to @p parent
21529 * @param parent The parent object
21531 * @return The separator object, or NULL upon failure
21533 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21535 * @brief Set the horizontal mode of a separator object
21537 * @param obj The separator object
21538 * @param horizontal If true, the separator is horizontal
21540 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21542 * @brief Get the horizontal mode of a separator object
21544 * @param obj The separator object
21545 * @return If true, the separator is horizontal
21547 * @see elm_separator_horizontal_set()
21549 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21555 * @defgroup Spinner Spinner
21556 * @ingroup Elementary
21558 * @image html img/widget/spinner/preview-00.png
21559 * @image latex img/widget/spinner/preview-00.eps
21561 * A spinner is a widget which allows the user to increase or decrease
21562 * numeric values using arrow buttons, or edit values directly, clicking
21563 * over it and typing the new value.
21565 * By default the spinner will not wrap and has a label
21566 * of "%.0f" (just showing the integer value of the double).
21568 * A spinner has a label that is formatted with floating
21569 * point values and thus accepts a printf-style format string, like
21570 * ā%1.2f unitsā.
21572 * It also allows specific values to be replaced by pre-defined labels.
21574 * Smart callbacks one can register to:
21576 * - "changed" - Whenever the spinner value is changed.
21577 * - "delay,changed" - A short time after the value is changed by the user.
21578 * This will be called only when the user stops dragging for a very short
21579 * period or when they release their finger/mouse, so it avoids possibly
21580 * expensive reactions to the value change.
21582 * Available styles for it:
21584 * - @c "vertical": up/down buttons at the right side and text left aligned.
21586 * Here is an example on its usage:
21587 * @ref spinner_example
21591 * @addtogroup Spinner
21596 * Add a new spinner widget to the given parent Elementary
21597 * (container) object.
21599 * @param parent The parent object.
21600 * @return a new spinner widget handle or @c NULL, on errors.
21602 * This function inserts a new spinner widget on the canvas.
21607 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21610 * Set the format string of the displayed label.
21612 * @param obj The spinner object.
21613 * @param fmt The format string for the label display.
21615 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21616 * string for the label text. The label text is provided a floating point
21617 * value, so the label text can display up to 1 floating point value.
21618 * Note that this is optional.
21620 * Use a format string such as "%1.2f meters" for example, and it will
21621 * display values like: "3.14 meters" for a value equal to 3.14159.
21623 * Default is "%0.f".
21625 * @see elm_spinner_label_format_get()
21629 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21632 * Get the label format of the spinner.
21634 * @param obj The spinner object.
21635 * @return The text label format string in UTF-8.
21637 * @see elm_spinner_label_format_set() for details.
21641 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21644 * Set the minimum and maximum values for the spinner.
21646 * @param obj The spinner object.
21647 * @param min The minimum value.
21648 * @param max The maximum value.
21650 * Define the allowed range of values to be selected by the user.
21652 * If actual value is less than @p min, it will be updated to @p min. If it
21653 * is bigger then @p max, will be updated to @p max. Actual value can be
21654 * get with elm_spinner_value_get().
21656 * By default, min is equal to 0, and max is equal to 100.
21658 * @warning Maximum must be greater than minimum.
21660 * @see elm_spinner_min_max_get()
21664 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21667 * Get the minimum and maximum values of the spinner.
21669 * @param obj The spinner object.
21670 * @param min Pointer where to store the minimum value.
21671 * @param max Pointer where to store the maximum value.
21673 * @note If only one value is needed, the other pointer can be passed
21676 * @see elm_spinner_min_max_set() for details.
21680 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21683 * Set the step used to increment or decrement the spinner value.
21685 * @param obj The spinner object.
21686 * @param step The step value.
21688 * This value will be incremented or decremented to the displayed value.
21689 * It will be incremented while the user keep right or top arrow pressed,
21690 * and will be decremented while the user keep left or bottom arrow pressed.
21692 * The interval to increment / decrement can be set with
21693 * elm_spinner_interval_set().
21695 * By default step value is equal to 1.
21697 * @see elm_spinner_step_get()
21701 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21704 * Get the step used to increment or decrement the spinner value.
21706 * @param obj The spinner object.
21707 * @return The step value.
21709 * @see elm_spinner_step_get() for more details.
21713 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21716 * Set the value the spinner displays.
21718 * @param obj The spinner object.
21719 * @param val The value to be displayed.
21721 * Value will be presented on the label following format specified with
21722 * elm_spinner_format_set().
21724 * @warning The value must to be between min and max values. This values
21725 * are set by elm_spinner_min_max_set().
21727 * @see elm_spinner_value_get().
21728 * @see elm_spinner_format_set().
21729 * @see elm_spinner_min_max_set().
21733 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21736 * Get the value displayed by the spinner.
21738 * @param obj The spinner object.
21739 * @return The value displayed.
21741 * @see elm_spinner_value_set() for details.
21745 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21748 * Set whether the spinner should wrap when it reaches its
21749 * minimum or maximum value.
21751 * @param obj The spinner object.
21752 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21755 * Disabled by default. If disabled, when the user tries to increment the
21757 * but displayed value plus step value is bigger than maximum value,
21759 * won't allow it. The same happens when the user tries to decrement it,
21760 * but the value less step is less than minimum value.
21762 * When wrap is enabled, in such situations it will allow these changes,
21763 * but will get the value that would be less than minimum and subtracts
21764 * from maximum. Or add the value that would be more than maximum to
21768 * @li min value = 10
21769 * @li max value = 50
21770 * @li step value = 20
21771 * @li displayed value = 20
21773 * When the user decrement value (using left or bottom arrow), it will
21774 * displays @c 40, because max - (min - (displayed - step)) is
21775 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21777 * @see elm_spinner_wrap_get().
21781 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21784 * Get whether the spinner should wrap when it reaches its
21785 * minimum or maximum value.
21787 * @param obj The spinner object
21788 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21789 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21791 * @see elm_spinner_wrap_set() for details.
21795 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21798 * Set whether the spinner can be directly edited by the user or not.
21800 * @param obj The spinner object.
21801 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21802 * don't allow users to edit it directly.
21804 * Spinner objects can have edition @b disabled, in which state they will
21805 * be changed only by arrows.
21806 * Useful for contexts
21807 * where you don't want your users to interact with it writting the value.
21809 * when using special values, the user can see real value instead
21810 * of special label on edition.
21812 * It's enabled by default.
21814 * @see elm_spinner_editable_get()
21818 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21821 * Get whether the spinner can be directly edited by the user or not.
21823 * @param obj The spinner object.
21824 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21825 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21827 * @see elm_spinner_editable_set() for details.
21831 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21834 * Set a special string to display in the place of the numerical value.
21836 * @param obj The spinner object.
21837 * @param value The value to be replaced.
21838 * @param label The label to be used.
21840 * It's useful for cases when a user should select an item that is
21841 * better indicated by a label than a value. For example, weekdays or months.
21845 * sp = elm_spinner_add(win);
21846 * elm_spinner_min_max_set(sp, 1, 3);
21847 * elm_spinner_special_value_add(sp, 1, "January");
21848 * elm_spinner_special_value_add(sp, 2, "February");
21849 * elm_spinner_special_value_add(sp, 3, "March");
21850 * evas_object_show(sp);
21855 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21858 * Set the interval on time updates for an user mouse button hold
21859 * on spinner widgets' arrows.
21861 * @param obj The spinner object.
21862 * @param interval The (first) interval value in seconds.
21864 * This interval value is @b decreased while the user holds the
21865 * mouse pointer either incrementing or decrementing spinner's value.
21867 * This helps the user to get to a given value distant from the
21868 * current one easier/faster, as it will start to change quicker and
21869 * quicker on mouse button holds.
21871 * The calculation for the next change interval value, starting from
21872 * the one set with this call, is the previous interval divided by
21873 * @c 1.05, so it decreases a little bit.
21875 * The default starting interval value for automatic changes is
21878 * @see elm_spinner_interval_get()
21882 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21885 * Get the interval on time updates for an user mouse button hold
21886 * on spinner widgets' arrows.
21888 * @param obj The spinner object.
21889 * @return The (first) interval value, in seconds, set on it.
21891 * @see elm_spinner_interval_set() for more details.
21895 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21902 * @defgroup Index Index
21904 * @image html img/widget/index/preview-00.png
21905 * @image latex img/widget/index/preview-00.eps
21907 * An index widget gives you an index for fast access to whichever
21908 * group of other UI items one might have. It's a list of text
21909 * items (usually letters, for alphabetically ordered access).
21911 * Index widgets are by default hidden and just appear when the
21912 * user clicks over it's reserved area in the canvas. In its
21913 * default theme, it's an area one @ref Fingers "finger" wide on
21914 * the right side of the index widget's container.
21916 * When items on the index are selected, smart callbacks get
21917 * called, so that its user can make other container objects to
21918 * show a given area or child object depending on the index item
21919 * selected. You'd probably be using an index together with @ref
21920 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21923 * Smart events one can add callbacks for are:
21924 * - @c "changed" - When the selected index item changes. @c
21925 * event_info is the selected item's data pointer.
21926 * - @c "delay,changed" - When the selected index item changes, but
21927 * after a small idling period. @c event_info is the selected
21928 * item's data pointer.
21929 * - @c "selected" - When the user releases a mouse button and
21930 * selects an item. @c event_info is the selected item's data
21932 * - @c "level,up" - when the user moves a finger from the first
21933 * level to the second level
21934 * - @c "level,down" - when the user moves a finger from the second
21935 * level to the first level
21937 * The @c "delay,changed" event is so that it'll wait a small time
21938 * before actually reporting those events and, moreover, just the
21939 * last event happening on those time frames will actually be
21942 * Here are some examples on its usage:
21943 * @li @ref index_example_01
21944 * @li @ref index_example_02
21948 * @addtogroup Index
21952 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21955 * Add a new index widget to the given parent Elementary
21956 * (container) object
21958 * @param parent The parent object
21959 * @return a new index widget handle or @c NULL, on errors
21961 * This function inserts a new index widget on the canvas.
21965 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21968 * Set whether a given index widget is or not visible,
21971 * @param obj The index object
21972 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21974 * Not to be confused with visible as in @c evas_object_show() --
21975 * visible with regard to the widget's auto hiding feature.
21977 * @see elm_index_active_get()
21981 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21984 * Get whether a given index widget is currently visible or not.
21986 * @param obj The index object
21987 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21989 * @see elm_index_active_set() for more details
21993 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21996 * Set the items level for a given index widget.
21998 * @param obj The index object.
21999 * @param level @c 0 or @c 1, the currently implemented levels.
22001 * @see elm_index_item_level_get()
22005 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22008 * Get the items level set for a given index widget.
22010 * @param obj The index object.
22011 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22013 * @see elm_index_item_level_set() for more information
22017 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22020 * Returns the last selected item's data, for a given index widget.
22022 * @param obj The index object.
22023 * @return The item @b data associated to the last selected item on
22024 * @p obj (or @c NULL, on errors).
22026 * @warning The returned value is @b not an #Elm_Index_Item item
22027 * handle, but the data associated to it (see the @c item parameter
22028 * in elm_index_item_append(), as an example).
22032 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22035 * Append a new item on a given index widget.
22037 * @param obj The index object.
22038 * @param letter Letter under which the item should be indexed
22039 * @param item The item data to set for the index's item
22041 * Despite the most common usage of the @p letter argument is for
22042 * single char strings, one could use arbitrary strings as index
22045 * @c item will be the pointer returned back on @c "changed", @c
22046 * "delay,changed" and @c "selected" smart events.
22050 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22053 * Prepend a new item on a given index widget.
22055 * @param obj The index object.
22056 * @param letter Letter under which the item should be indexed
22057 * @param item The item data to set for the index's item
22059 * Despite the most common usage of the @p letter argument is for
22060 * single char strings, one could use arbitrary strings as index
22063 * @c item will be the pointer returned back on @c "changed", @c
22064 * "delay,changed" and @c "selected" smart events.
22068 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22071 * Append a new item, on a given index widget, <b>after the item
22072 * having @p relative as data</b>.
22074 * @param obj The index object.
22075 * @param letter Letter under which the item should be indexed
22076 * @param item The item data to set for the index's item
22077 * @param relative The item data of the index item to be the
22078 * predecessor of this new one
22080 * Despite the most common usage of the @p letter argument is for
22081 * single char strings, one could use arbitrary strings as index
22084 * @c item will be the pointer returned back on @c "changed", @c
22085 * "delay,changed" and @c "selected" smart events.
22087 * @note If @p relative is @c NULL or if it's not found to be data
22088 * set on any previous item on @p obj, this function will behave as
22089 * elm_index_item_append().
22093 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22096 * Prepend a new item, on a given index widget, <b>after the item
22097 * having @p relative as data</b>.
22099 * @param obj The index object.
22100 * @param letter Letter under which the item should be indexed
22101 * @param item The item data to set for the index's item
22102 * @param relative The item data of the index item to be the
22103 * successor of this new one
22105 * Despite the most common usage of the @p letter argument is for
22106 * single char strings, one could use arbitrary strings as index
22109 * @c item will be the pointer returned back on @c "changed", @c
22110 * "delay,changed" and @c "selected" smart events.
22112 * @note If @p relative is @c NULL or if it's not found to be data
22113 * set on any previous item on @p obj, this function will behave as
22114 * elm_index_item_prepend().
22118 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22121 * Insert a new item into the given index widget, using @p cmp_func
22122 * function to sort items (by item handles).
22124 * @param obj The index object.
22125 * @param letter Letter under which the item should be indexed
22126 * @param item The item data to set for the index's item
22127 * @param cmp_func The comparing function to be used to sort index
22128 * items <b>by #Elm_Index_Item item handles</b>
22129 * @param cmp_data_func A @b fallback function to be called for the
22130 * sorting of index items <b>by item data</b>). It will be used
22131 * when @p cmp_func returns @c 0 (equality), which means an index
22132 * item with provided item data already exists. To decide which
22133 * data item should be pointed to by the index item in question, @p
22134 * cmp_data_func will be used. If @p cmp_data_func returns a
22135 * non-negative value, the previous index item data will be
22136 * replaced by the given @p item pointer. If the previous data need
22137 * to be freed, it should be done by the @p cmp_data_func function,
22138 * because all references to it will be lost. If this function is
22139 * not provided (@c NULL is given), index items will be @b
22140 * duplicated, if @p cmp_func returns @c 0.
22142 * Despite the most common usage of the @p letter argument is for
22143 * single char strings, one could use arbitrary strings as index
22146 * @c item will be the pointer returned back on @c "changed", @c
22147 * "delay,changed" and @c "selected" smart events.
22151 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);
22154 * Remove an item from a given index widget, <b>to be referenced by
22155 * it's data value</b>.
22157 * @param obj The index object
22158 * @param item The item's data pointer for the item to be removed
22161 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22162 * that callback function will be called by this one.
22164 * @warning The item to be removed from @p obj will be found via
22165 * its item data pointer, and not by an #Elm_Index_Item handle.
22169 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22172 * Find a given index widget's item, <b>using item data</b>.
22174 * @param obj The index object
22175 * @param item The item data pointed to by the desired index item
22176 * @return The index item handle, if found, or @c NULL otherwise
22180 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22183 * Removes @b all items from a given index widget.
22185 * @param obj The index object.
22187 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22188 * that callback function will be called for each item in @p obj.
22192 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22195 * Go to a given items level on a index widget
22197 * @param obj The index object
22198 * @param level The index level (one of @c 0 or @c 1)
22202 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22205 * Return the data associated with a given index widget item
22207 * @param it The index widget item handle
22208 * @return The data associated with @p it
22210 * @see elm_index_item_data_set()
22214 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22217 * Set the data associated with a given index widget item
22219 * @param it The index widget item handle
22220 * @param data The new data pointer to set to @p it
22222 * This sets new item data on @p it.
22224 * @warning The old data pointer won't be touched by this function, so
22225 * the user had better to free that old data himself/herself.
22229 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22232 * Set the function to be called when a given index widget item is freed.
22234 * @param it The item to set the callback on
22235 * @param func The function to call on the item's deletion
22237 * When called, @p func will have both @c data and @c event_info
22238 * arguments with the @p it item's data value and, naturally, the
22239 * @c obj argument with a handle to the parent index widget.
22243 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22246 * Get the letter (string) set on a given index widget item.
22248 * @param it The index item handle
22249 * @return The letter string set on @p it
22253 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22257 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22264 * @defgroup Photocam Photocam
22266 * @image html img/widget/photocam/preview-00.png
22267 * @image latex img/widget/photocam/preview-00.eps
22269 * This is a widget specifically for displaying high-resolution digital
22270 * camera photos giving speedy feedback (fast load), low memory footprint
22271 * and zooming and panning as well as fitting logic. It is entirely focused
22272 * on jpeg images, and takes advantage of properties of the jpeg format (via
22273 * evas loader features in the jpeg loader).
22275 * Signals that you can add callbacks for are:
22276 * @li "clicked" - This is called when a user has clicked the photo without
22278 * @li "press" - This is called when a user has pressed down on the photo.
22279 * @li "longpressed" - This is called when a user has pressed down on the
22280 * photo for a long time without dragging around.
22281 * @li "clicked,double" - This is called when a user has double-clicked the
22283 * @li "load" - Photo load begins.
22284 * @li "loaded" - This is called when the image file load is complete for the
22285 * first view (low resolution blurry version).
22286 * @li "load,detail" - Photo detailed data load begins.
22287 * @li "loaded,detail" - This is called when the image file load is complete
22288 * for the detailed image data (full resolution needed).
22289 * @li "zoom,start" - Zoom animation started.
22290 * @li "zoom,stop" - Zoom animation stopped.
22291 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22292 * @li "scroll" - the content has been scrolled (moved)
22293 * @li "scroll,anim,start" - scrolling animation has started
22294 * @li "scroll,anim,stop" - scrolling animation has stopped
22295 * @li "scroll,drag,start" - dragging the contents around has started
22296 * @li "scroll,drag,stop" - dragging the contents around has stopped
22298 * @ref tutorial_photocam shows the API in action.
22302 * @brief Types of zoom available.
22304 typedef enum _Elm_Photocam_Zoom_Mode
22306 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22307 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22308 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22309 ELM_PHOTOCAM_ZOOM_MODE_LAST
22310 } Elm_Photocam_Zoom_Mode;
22312 * @brief Add a new Photocam object
22314 * @param parent The parent object
22315 * @return The new object or NULL if it cannot be created
22317 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22319 * @brief Set the photo file to be shown
22321 * @param obj The photocam object
22322 * @param file The photo file
22323 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22325 * This sets (and shows) the specified file (with a relative or absolute
22326 * path) and will return a load error (same error that
22327 * evas_object_image_load_error_get() will return). The image will change and
22328 * adjust its size at this point and begin a background load process for this
22329 * photo that at some time in the future will be displayed at the full
22332 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22334 * @brief Returns the path of the current image file
22336 * @param obj The photocam object
22337 * @return Returns the path
22339 * @see elm_photocam_file_set()
22341 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22343 * @brief Set the zoom level of the photo
22345 * @param obj The photocam object
22346 * @param zoom The zoom level to set
22348 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22349 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22350 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22351 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22354 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22356 * @brief Get the zoom level of the photo
22358 * @param obj The photocam object
22359 * @return The current zoom level
22361 * This returns the current zoom level of the photocam object. Note that if
22362 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22363 * (which is the default), the zoom level may be changed at any time by the
22364 * photocam object itself to account for photo size and photocam viewpoer
22367 * @see elm_photocam_zoom_set()
22368 * @see elm_photocam_zoom_mode_set()
22370 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22372 * @brief Set the zoom mode
22374 * @param obj The photocam object
22375 * @param mode The desired mode
22377 * This sets the zoom mode to manual or one of several automatic levels.
22378 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22379 * elm_photocam_zoom_set() and will stay at that level until changed by code
22380 * or until zoom mode is changed. This is the default mode. The Automatic
22381 * modes will allow the photocam object to automatically adjust zoom mode
22382 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22383 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22384 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22385 * pixels within the frame are left unfilled.
22387 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22389 * @brief Get the zoom mode
22391 * @param obj The photocam object
22392 * @return The current zoom mode
22394 * This gets the current zoom mode of the photocam object.
22396 * @see elm_photocam_zoom_mode_set()
22398 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22400 * @brief Get the current image pixel width and height
22402 * @param obj The photocam object
22403 * @param w A pointer to the width return
22404 * @param h A pointer to the height return
22406 * This gets the current photo pixel width and height (for the original).
22407 * The size will be returned in the integers @p w and @p h that are pointed
22410 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22412 * @brief Get the area of the image that is currently shown
22415 * @param x A pointer to the X-coordinate of region
22416 * @param y A pointer to the Y-coordinate of region
22417 * @param w A pointer to the width
22418 * @param h A pointer to the height
22420 * @see elm_photocam_image_region_show()
22421 * @see elm_photocam_image_region_bring_in()
22423 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22425 * @brief Set the viewed portion of the image
22427 * @param obj The photocam object
22428 * @param x X-coordinate of region in image original pixels
22429 * @param y Y-coordinate of region in image original pixels
22430 * @param w Width of region in image original pixels
22431 * @param h Height of region in image original pixels
22433 * This shows the region of the image without using animation.
22435 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22437 * @brief Bring in the viewed portion of the image
22439 * @param obj The photocam object
22440 * @param x X-coordinate of region in image original pixels
22441 * @param y Y-coordinate of region in image original pixels
22442 * @param w Width of region in image original pixels
22443 * @param h Height of region in image original pixels
22445 * This shows the region of the image using animation.
22447 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22449 * @brief Set the paused state for photocam
22451 * @param obj The photocam object
22452 * @param paused The pause state to set
22454 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22455 * photocam. The default is off. This will stop zooming using animation on
22456 * zoom levels changes and change instantly. This will stop any existing
22457 * animations that are running.
22459 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22461 * @brief Get the paused state for photocam
22463 * @param obj The photocam object
22464 * @return The current paused state
22466 * This gets the current paused state for the photocam object.
22468 * @see elm_photocam_paused_set()
22470 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22472 * @brief Get the internal low-res image used for photocam
22474 * @param obj The photocam object
22475 * @return The internal image object handle, or NULL if none exists
22477 * This gets the internal image object inside photocam. Do not modify it. It
22478 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22479 * deleted at any time as well.
22481 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22483 * @brief Set the photocam scrolling bouncing.
22485 * @param obj The photocam object
22486 * @param h_bounce bouncing for horizontal
22487 * @param v_bounce bouncing for vertical
22489 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22491 * @brief Get the photocam scrolling bouncing.
22493 * @param obj The photocam object
22494 * @param h_bounce bouncing for horizontal
22495 * @param v_bounce bouncing for vertical
22497 * @see elm_photocam_bounce_set()
22499 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22505 * @defgroup Map Map
22506 * @ingroup Elementary
22508 * @image html img/widget/map/preview-00.png
22509 * @image latex img/widget/map/preview-00.eps
22511 * This is a widget specifically for displaying a map. It uses basically
22512 * OpenStreetMap provider http://www.openstreetmap.org/,
22513 * but custom providers can be added.
22515 * It supports some basic but yet nice features:
22516 * @li zoom and scroll
22517 * @li markers with content to be displayed when user clicks over it
22518 * @li group of markers
22521 * Smart callbacks one can listen to:
22523 * - "clicked" - This is called when a user has clicked the map without
22525 * - "press" - This is called when a user has pressed down on the map.
22526 * - "longpressed" - This is called when a user has pressed down on the map
22527 * for a long time without dragging around.
22528 * - "clicked,double" - This is called when a user has double-clicked
22530 * - "load,detail" - Map detailed data load begins.
22531 * - "loaded,detail" - This is called when all currently visible parts of
22532 * the map are loaded.
22533 * - "zoom,start" - Zoom animation started.
22534 * - "zoom,stop" - Zoom animation stopped.
22535 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22536 * - "scroll" - the content has been scrolled (moved).
22537 * - "scroll,anim,start" - scrolling animation has started.
22538 * - "scroll,anim,stop" - scrolling animation has stopped.
22539 * - "scroll,drag,start" - dragging the contents around has started.
22540 * - "scroll,drag,stop" - dragging the contents around has stopped.
22541 * - "downloaded" - This is called when all currently required map images
22543 * - "route,load" - This is called when route request begins.
22544 * - "route,loaded" - This is called when route request ends.
22545 * - "name,load" - This is called when name request begins.
22546 * - "name,loaded- This is called when name request ends.
22548 * Available style for map widget:
22551 * Available style for markers:
22556 * Available style for marker bubble:
22559 * List of examples:
22560 * @li @ref map_example_01
22561 * @li @ref map_example_02
22562 * @li @ref map_example_03
22571 * @enum _Elm_Map_Zoom_Mode
22572 * @typedef Elm_Map_Zoom_Mode
22574 * Set map's zoom behavior. It can be set to manual or automatic.
22576 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22578 * Values <b> don't </b> work as bitmask, only one can be choosen.
22580 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22581 * than the scroller view.
22583 * @see elm_map_zoom_mode_set()
22584 * @see elm_map_zoom_mode_get()
22588 typedef enum _Elm_Map_Zoom_Mode
22590 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22591 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22592 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22593 ELM_MAP_ZOOM_MODE_LAST
22594 } Elm_Map_Zoom_Mode;
22597 * @enum _Elm_Map_Route_Sources
22598 * @typedef Elm_Map_Route_Sources
22600 * Set route service to be used. By default used source is
22601 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22603 * @see elm_map_route_source_set()
22604 * @see elm_map_route_source_get()
22608 typedef enum _Elm_Map_Route_Sources
22610 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22611 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. */
22612 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22613 ELM_MAP_ROUTE_SOURCE_LAST
22614 } Elm_Map_Route_Sources;
22616 typedef enum _Elm_Map_Name_Sources
22618 ELM_MAP_NAME_SOURCE_NOMINATIM,
22619 ELM_MAP_NAME_SOURCE_LAST
22620 } Elm_Map_Name_Sources;
22623 * @enum _Elm_Map_Route_Type
22624 * @typedef Elm_Map_Route_Type
22626 * Set type of transport used on route.
22628 * @see elm_map_route_add()
22632 typedef enum _Elm_Map_Route_Type
22634 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22635 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22636 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22637 ELM_MAP_ROUTE_TYPE_LAST
22638 } Elm_Map_Route_Type;
22641 * @enum _Elm_Map_Route_Method
22642 * @typedef Elm_Map_Route_Method
22644 * Set the routing method, what should be priorized, time or distance.
22646 * @see elm_map_route_add()
22650 typedef enum _Elm_Map_Route_Method
22652 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22653 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22654 ELM_MAP_ROUTE_METHOD_LAST
22655 } Elm_Map_Route_Method;
22657 typedef enum _Elm_Map_Name_Method
22659 ELM_MAP_NAME_METHOD_SEARCH,
22660 ELM_MAP_NAME_METHOD_REVERSE,
22661 ELM_MAP_NAME_METHOD_LAST
22662 } Elm_Map_Name_Method;
22664 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(). */
22665 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(). */
22666 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(). */
22667 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(). */
22668 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22669 typedef struct _Elm_Map_Track Elm_Map_Track;
22671 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. */
22672 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22673 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22674 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22676 typedef char *(*ElmMapModuleSourceFunc) (void);
22677 typedef int (*ElmMapModuleZoomMinFunc) (void);
22678 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22679 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22680 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22681 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22682 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22683 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22684 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22687 * Add a new map widget to the given parent Elementary (container) object.
22689 * @param parent The parent object.
22690 * @return a new map widget handle or @c NULL, on errors.
22692 * This function inserts a new map widget on the canvas.
22696 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22699 * Set the zoom level of the map.
22701 * @param obj The map object.
22702 * @param zoom The zoom level to set.
22704 * This sets the zoom level.
22706 * It will respect limits defined by elm_map_source_zoom_min_set() and
22707 * elm_map_source_zoom_max_set().
22709 * By default these values are 0 (world map) and 18 (maximum zoom).
22711 * This function should be used when zoom mode is set to
22712 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22713 * with elm_map_zoom_mode_set().
22715 * @see elm_map_zoom_mode_set().
22716 * @see elm_map_zoom_get().
22720 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22723 * Get the zoom level of the map.
22725 * @param obj The map object.
22726 * @return The current zoom level.
22728 * This returns the current zoom level of the map object.
22730 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22731 * (which is the default), the zoom level may be changed at any time by the
22732 * map object itself to account for map size and map viewport size.
22734 * @see elm_map_zoom_set() for details.
22738 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22741 * Set the zoom mode used by the map object.
22743 * @param obj The map object.
22744 * @param mode The zoom mode of the map, being it one of
22745 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22746 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22748 * This sets the zoom mode to manual or one of the automatic levels.
22749 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22750 * elm_map_zoom_set() and will stay at that level until changed by code
22751 * or until zoom mode is changed. This is the default mode.
22753 * The Automatic modes will allow the map object to automatically
22754 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22755 * adjust zoom so the map fits inside the scroll frame with no pixels
22756 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22757 * ensure no pixels within the frame are left unfilled. Do not forget that
22758 * the valid sizes are 2^zoom, consequently the map may be smaller than
22759 * the scroller view.
22761 * @see elm_map_zoom_set()
22765 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22768 * Get the zoom mode used by the map object.
22770 * @param obj The map object.
22771 * @return The zoom mode of the map, being it one of
22772 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22773 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22775 * This function returns the current zoom mode used by the map object.
22777 * @see elm_map_zoom_mode_set() for more details.
22781 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22784 * Get the current coordinates of the map.
22786 * @param obj The map object.
22787 * @param lon Pointer where to store longitude.
22788 * @param lat Pointer where to store latitude.
22790 * This gets the current center coordinates of the map object. It can be
22791 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22793 * @see elm_map_geo_region_bring_in()
22794 * @see elm_map_geo_region_show()
22798 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22802 * @brief Disable size restrictions on an object's tooltip
22803 * @param item The tooltip's anchor object
22804 * @param disable If EINA_TRUE, size restrictions are disabled
22805 * @return EINA_FALSE on failure, EINA_TRUE on success
22807 * This function allows a tooltip to expand beyond its parant window's canvas.
22808 * It will instead be limited only by the size of the display.
22810 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
22812 * @brief Retrieve size restriction state of an object's tooltip
22813 * @param obj The tooltip's anchor object
22814 * @return If EINA_TRUE, size restrictions are disabled
22816 * This function returns whether a tooltip is allowed to expand beyond
22817 * its parant window's canvas.
22818 * It will instead be limited only by the size of the display.
22820 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
22823 * Animatedly bring in given coordinates to the center of the map.
22825 * @param obj The map object.
22826 * @param lon Longitude to center at.
22827 * @param lat Latitude to center at.
22829 * This causes map to jump to the given @p lat and @p lon coordinates
22830 * and show it (by scrolling) in the center of the viewport, if it is not
22831 * already centered. This will use animation to do so and take a period
22832 * of time to complete.
22834 * @see elm_map_geo_region_show() for a function to avoid animation.
22835 * @see elm_map_geo_region_get()
22839 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22842 * Show the given coordinates at the center of the map, @b immediately.
22844 * @param obj The map object.
22845 * @param lon Longitude to center at.
22846 * @param lat Latitude to center at.
22848 * This causes map to @b redraw its viewport's contents to the
22849 * region contining the given @p lat and @p lon, that will be moved to the
22850 * center of the map.
22852 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22853 * @see elm_map_geo_region_get()
22857 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22860 * Pause or unpause the map.
22862 * @param obj The map object.
22863 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22866 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22869 * The default is off.
22871 * This will stop zooming using animation, changing zoom levels will
22872 * change instantly. This will stop any existing animations that are running.
22874 * @see elm_map_paused_get()
22878 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22881 * Get a value whether map is paused or not.
22883 * @param obj The map object.
22884 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22885 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22887 * This gets the current paused state for the map object.
22889 * @see elm_map_paused_set() for details.
22893 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22896 * Set to show markers during zoom level changes or not.
22898 * @param obj The map object.
22899 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22902 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22905 * The default is off.
22907 * This will stop zooming using animation, changing zoom levels will
22908 * change instantly. This will stop any existing animations that are running.
22910 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22913 * The default is off.
22915 * Enabling it will force the map to stop displaying the markers during
22916 * zoom level changes. Set to on if you have a large number of markers.
22918 * @see elm_map_paused_markers_get()
22922 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22925 * Get a value whether markers will be displayed on zoom level changes or not
22927 * @param obj The map object.
22928 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22929 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22931 * This gets the current markers paused state for the map object.
22933 * @see elm_map_paused_markers_set() for details.
22937 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22940 * Get the information of downloading status.
22942 * @param obj The map object.
22943 * @param try_num Pointer where to store number of tiles being downloaded.
22944 * @param finish_num Pointer where to store number of tiles successfully
22947 * This gets the current downloading status for the map object, the number
22948 * of tiles being downloaded and the number of tiles already downloaded.
22952 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22955 * Convert a pixel coordinate (x,y) into a geographic coordinate
22956 * (longitude, latitude).
22958 * @param obj The map object.
22959 * @param x the coordinate.
22960 * @param y the coordinate.
22961 * @param size the size in pixels of the map.
22962 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22963 * @param lon Pointer where to store the longitude that correspond to x.
22964 * @param lat Pointer where to store the latitude that correspond to y.
22966 * @note Origin pixel point is the top left corner of the viewport.
22967 * Map zoom and size are taken on account.
22969 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22973 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);
22976 * Convert a geographic coordinate (longitude, latitude) into a pixel
22977 * coordinate (x, y).
22979 * @param obj The map object.
22980 * @param lon the longitude.
22981 * @param lat the latitude.
22982 * @param size the size in pixels of the map. The map is a square
22983 * and generally his size is : pow(2.0, zoom)*256.
22984 * @param x Pointer where to store the horizontal pixel coordinate that
22985 * correspond to the longitude.
22986 * @param y Pointer where to store the vertical pixel coordinate that
22987 * correspond to the latitude.
22989 * @note Origin pixel point is the top left corner of the viewport.
22990 * Map zoom and size are taken on account.
22992 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22996 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);
22999 * Convert a geographic coordinate (longitude, latitude) into a name
23002 * @param obj The map object.
23003 * @param lon the longitude.
23004 * @param lat the latitude.
23005 * @return name A #Elm_Map_Name handle for this coordinate.
23007 * To get the string for this address, elm_map_name_address_get()
23010 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23014 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23017 * Convert a name (address) into a geographic coordinate
23018 * (longitude, latitude).
23020 * @param obj The map object.
23021 * @param name The address.
23022 * @return name A #Elm_Map_Name handle for this address.
23024 * To get the longitude and latitude, elm_map_name_region_get()
23027 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23031 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23034 * Convert a pixel coordinate into a rotated pixel coordinate.
23036 * @param obj The map object.
23037 * @param x horizontal coordinate of the point to rotate.
23038 * @param y vertical coordinate of the point to rotate.
23039 * @param cx rotation's center horizontal position.
23040 * @param cy rotation's center vertical position.
23041 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23042 * @param xx Pointer where to store rotated x.
23043 * @param yy Pointer where to store rotated y.
23047 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);
23050 * Add a new marker to the map object.
23052 * @param obj The map object.
23053 * @param lon The longitude of the marker.
23054 * @param lat The latitude of the marker.
23055 * @param clas The class, to use when marker @b isn't grouped to others.
23056 * @param clas_group The class group, to use when marker is grouped to others
23057 * @param data The data passed to the callbacks.
23059 * @return The created marker or @c NULL upon failure.
23061 * A marker will be created and shown in a specific point of the map, defined
23062 * by @p lon and @p lat.
23064 * It will be displayed using style defined by @p class when this marker
23065 * is displayed alone (not grouped). A new class can be created with
23066 * elm_map_marker_class_new().
23068 * If the marker is grouped to other markers, it will be displayed with
23069 * style defined by @p class_group. Markers with the same group are grouped
23070 * if they are close. A new group class can be created with
23071 * elm_map_marker_group_class_new().
23073 * Markers created with this method can be deleted with
23074 * elm_map_marker_remove().
23076 * A marker can have associated content to be displayed by a bubble,
23077 * when a user click over it, as well as an icon. These objects will
23078 * be fetch using class' callback functions.
23080 * @see elm_map_marker_class_new()
23081 * @see elm_map_marker_group_class_new()
23082 * @see elm_map_marker_remove()
23086 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);
23089 * Set the maximum numbers of markers' content to be displayed in a group.
23091 * @param obj The map object.
23092 * @param max The maximum numbers of items displayed in a bubble.
23094 * A bubble will be displayed when the user clicks over the group,
23095 * and will place the content of markers that belong to this group
23098 * A group can have a long list of markers, consequently the creation
23099 * of the content of the bubble can be very slow.
23101 * In order to avoid this, a maximum number of items is displayed
23104 * By default this number is 30.
23106 * Marker with the same group class are grouped if they are close.
23108 * @see elm_map_marker_add()
23112 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23115 * Remove a marker from the map.
23117 * @param marker The marker to remove.
23119 * @see elm_map_marker_add()
23123 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23126 * Get the current coordinates of the marker.
23128 * @param marker marker.
23129 * @param lat Pointer where to store the marker's latitude.
23130 * @param lon Pointer where to store the marker's longitude.
23132 * These values are set when adding markers, with function
23133 * elm_map_marker_add().
23135 * @see elm_map_marker_add()
23139 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23142 * Animatedly bring in given marker to the center of the map.
23144 * @param marker The marker to center at.
23146 * This causes map to jump to the given @p marker's coordinates
23147 * and show it (by scrolling) in the center of the viewport, if it is not
23148 * already centered. This will use animation to do so and take a period
23149 * of time to complete.
23151 * @see elm_map_marker_show() for a function to avoid animation.
23152 * @see elm_map_marker_region_get()
23156 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23159 * Show the given marker at the center of the map, @b immediately.
23161 * @param marker The marker to center at.
23163 * This causes map to @b redraw its viewport's contents to the
23164 * region contining the given @p marker's coordinates, that will be
23165 * moved to the center of the map.
23167 * @see elm_map_marker_bring_in() for a function to move with animation.
23168 * @see elm_map_markers_list_show() if more than one marker need to be
23170 * @see elm_map_marker_region_get()
23174 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23177 * Move and zoom the map to display a list of markers.
23179 * @param markers A list of #Elm_Map_Marker handles.
23181 * The map will be centered on the center point of the markers in the list.
23182 * Then the map will be zoomed in order to fit the markers using the maximum
23183 * zoom which allows display of all the markers.
23185 * @warning All the markers should belong to the same map object.
23187 * @see elm_map_marker_show() to show a single marker.
23188 * @see elm_map_marker_bring_in()
23192 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23195 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23197 * @param marker The marker wich content should be returned.
23198 * @return Return the evas object if it exists, else @c NULL.
23200 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23201 * elm_map_marker_class_get_cb_set() should be used.
23203 * This content is what will be inside the bubble that will be displayed
23204 * when an user clicks over the marker.
23206 * This returns the actual Evas object used to be placed inside
23207 * the bubble. This may be @c NULL, as it may
23208 * not have been created or may have been deleted, at any time, by
23209 * the map. <b>Do not modify this object</b> (move, resize,
23210 * show, hide, etc.), as the map is controlling it. This
23211 * function is for querying, emitting custom signals or hooking
23212 * lower level callbacks for events on that object. Do not delete
23213 * this object under any circumstances.
23217 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23220 * Update the marker
23222 * @param marker The marker to be updated.
23224 * If a content is set to this marker, it will call function to delete it,
23225 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23226 * #ElmMapMarkerGetFunc.
23228 * These functions are set for the marker class with
23229 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23233 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23236 * Close all the bubbles opened by the user.
23238 * @param obj The map object.
23240 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23241 * when the user clicks on a marker.
23243 * This functions is set for the marker class with
23244 * elm_map_marker_class_get_cb_set().
23248 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23251 * Create a new group class.
23253 * @param obj The map object.
23254 * @return Returns the new group class.
23256 * Each marker must be associated to a group class. Markers in the same
23257 * group are grouped if they are close.
23259 * The group class defines the style of the marker when a marker is grouped
23260 * to others markers. When it is alone, another class will be used.
23262 * A group class will need to be provided when creating a marker with
23263 * elm_map_marker_add().
23265 * Some properties and functions can be set by class, as:
23266 * - style, with elm_map_group_class_style_set()
23267 * - data - to be associated to the group class. It can be set using
23268 * elm_map_group_class_data_set().
23269 * - min zoom to display markers, set with
23270 * elm_map_group_class_zoom_displayed_set().
23271 * - max zoom to group markers, set using
23272 * elm_map_group_class_zoom_grouped_set().
23273 * - visibility - set if markers will be visible or not, set with
23274 * elm_map_group_class_hide_set().
23275 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23276 * It can be set using elm_map_group_class_icon_cb_set().
23278 * @see elm_map_marker_add()
23279 * @see elm_map_group_class_style_set()
23280 * @see elm_map_group_class_data_set()
23281 * @see elm_map_group_class_zoom_displayed_set()
23282 * @see elm_map_group_class_zoom_grouped_set()
23283 * @see elm_map_group_class_hide_set()
23284 * @see elm_map_group_class_icon_cb_set()
23288 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23291 * Set the marker's style of a group class.
23293 * @param clas The group class.
23294 * @param style The style to be used by markers.
23296 * Each marker must be associated to a group class, and will use the style
23297 * defined by such class when grouped to other markers.
23299 * The following styles are provided by default theme:
23300 * @li @c radio - blue circle
23301 * @li @c radio2 - green circle
23304 * @see elm_map_group_class_new() for more details.
23305 * @see elm_map_marker_add()
23309 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23312 * Set the icon callback function of a group class.
23314 * @param clas The group class.
23315 * @param icon_get The callback function that will return the icon.
23317 * Each marker must be associated to a group class, and it can display a
23318 * custom icon. The function @p icon_get must return this icon.
23320 * @see elm_map_group_class_new() for more details.
23321 * @see elm_map_marker_add()
23325 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23328 * Set the data associated to the group class.
23330 * @param clas The group class.
23331 * @param data The new user data.
23333 * This data will be passed for callback functions, like icon get callback,
23334 * that can be set with elm_map_group_class_icon_cb_set().
23336 * If a data was previously set, the object will lose the pointer for it,
23337 * so if needs to be freed, you must do it yourself.
23339 * @see elm_map_group_class_new() for more details.
23340 * @see elm_map_group_class_icon_cb_set()
23341 * @see elm_map_marker_add()
23345 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23348 * Set the minimum zoom from where the markers are displayed.
23350 * @param clas The group class.
23351 * @param zoom The minimum zoom.
23353 * Markers only will be displayed when the map is displayed at @p zoom
23356 * @see elm_map_group_class_new() for more details.
23357 * @see elm_map_marker_add()
23361 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23364 * Set the zoom from where the markers are no more grouped.
23366 * @param clas The group class.
23367 * @param zoom The maximum zoom.
23369 * Markers only will be grouped when the map is displayed at
23370 * less than @p zoom.
23372 * @see elm_map_group_class_new() for more details.
23373 * @see elm_map_marker_add()
23377 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23380 * Set if the markers associated to the group class @clas are hidden or not.
23382 * @param clas The group class.
23383 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23386 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23391 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23394 * Create a new marker class.
23396 * @param obj The map object.
23397 * @return Returns the new group class.
23399 * Each marker must be associated to a class.
23401 * The marker class defines the style of the marker when a marker is
23402 * displayed alone, i.e., not grouped to to others markers. When grouped
23403 * it will use group class style.
23405 * A marker class will need to be provided when creating a marker with
23406 * elm_map_marker_add().
23408 * Some properties and functions can be set by class, as:
23409 * - style, with elm_map_marker_class_style_set()
23410 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23411 * It can be set using elm_map_marker_class_icon_cb_set().
23412 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23413 * Set using elm_map_marker_class_get_cb_set().
23414 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23415 * Set using elm_map_marker_class_del_cb_set().
23417 * @see elm_map_marker_add()
23418 * @see elm_map_marker_class_style_set()
23419 * @see elm_map_marker_class_icon_cb_set()
23420 * @see elm_map_marker_class_get_cb_set()
23421 * @see elm_map_marker_class_del_cb_set()
23425 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23428 * Set the marker's style of a marker class.
23430 * @param clas The marker class.
23431 * @param style The style to be used by markers.
23433 * Each marker must be associated to a marker class, and will use the style
23434 * defined by such class when alone, i.e., @b not grouped to other markers.
23436 * The following styles are provided by default theme:
23441 * @see elm_map_marker_class_new() for more details.
23442 * @see elm_map_marker_add()
23446 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23449 * Set the icon callback function of a marker class.
23451 * @param clas The marker class.
23452 * @param icon_get The callback function that will return the icon.
23454 * Each marker must be associated to a marker class, and it can display a
23455 * custom icon. The function @p icon_get must return this icon.
23457 * @see elm_map_marker_class_new() for more details.
23458 * @see elm_map_marker_add()
23462 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23465 * Set the bubble content callback function of a marker class.
23467 * @param clas The marker class.
23468 * @param get The callback function that will return the content.
23470 * Each marker must be associated to a marker class, and it can display a
23471 * a content on a bubble that opens when the user click over the marker.
23472 * The function @p get must return this content object.
23474 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23477 * @see elm_map_marker_class_new() for more details.
23478 * @see elm_map_marker_class_del_cb_set()
23479 * @see elm_map_marker_add()
23483 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23486 * Set the callback function used to delete bubble content of a marker class.
23488 * @param clas The marker class.
23489 * @param del The callback function that will delete the content.
23491 * Each marker must be associated to a marker class, and it can display a
23492 * a content on a bubble that opens when the user click over the marker.
23493 * The function to return such content can be set with
23494 * elm_map_marker_class_get_cb_set().
23496 * If this content must be freed, a callback function need to be
23497 * set for that task with this function.
23499 * If this callback is defined it will have to delete (or not) the
23500 * object inside, but if the callback is not defined the object will be
23501 * destroyed with evas_object_del().
23503 * @see elm_map_marker_class_new() for more details.
23504 * @see elm_map_marker_class_get_cb_set()
23505 * @see elm_map_marker_add()
23509 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23512 * Get the list of available sources.
23514 * @param obj The map object.
23515 * @return The source names list.
23517 * It will provide a list with all available sources, that can be set as
23518 * current source with elm_map_source_name_set(), or get with
23519 * elm_map_source_name_get().
23521 * Available sources:
23527 * @see elm_map_source_name_set() for more details.
23528 * @see elm_map_source_name_get()
23532 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23535 * Set the source of the map.
23537 * @param obj The map object.
23538 * @param source The source to be used.
23540 * Map widget retrieves images that composes the map from a web service.
23541 * This web service can be set with this method.
23543 * A different service can return a different maps with different
23544 * information and it can use different zoom values.
23546 * The @p source_name need to match one of the names provided by
23547 * elm_map_source_names_get().
23549 * The current source can be get using elm_map_source_name_get().
23551 * @see elm_map_source_names_get()
23552 * @see elm_map_source_name_get()
23557 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23560 * Get the name of currently used source.
23562 * @param obj The map object.
23563 * @return Returns the name of the source in use.
23565 * @see elm_map_source_name_set() for more details.
23569 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23572 * Set the source of the route service to be used by the map.
23574 * @param obj The map object.
23575 * @param source The route service to be used, being it one of
23576 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23577 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23579 * Each one has its own algorithm, so the route retrieved may
23580 * differ depending on the source route. Now, only the default is working.
23582 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23583 * http://www.yournavigation.org/.
23585 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23586 * assumptions. Its routing core is based on Contraction Hierarchies.
23588 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23590 * @see elm_map_route_source_get().
23594 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23597 * Get the current route source.
23599 * @param obj The map object.
23600 * @return The source of the route service used by the map.
23602 * @see elm_map_route_source_set() for details.
23606 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23609 * Set the minimum zoom of the source.
23611 * @param obj The map object.
23612 * @param zoom New minimum zoom value to be used.
23614 * By default, it's 0.
23618 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23621 * Get the minimum zoom of the source.
23623 * @param obj The map object.
23624 * @return Returns the minimum zoom of the source.
23626 * @see elm_map_source_zoom_min_set() for details.
23630 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23633 * Set the maximum zoom of the source.
23635 * @param obj The map object.
23636 * @param zoom New maximum zoom value to be used.
23638 * By default, it's 18.
23642 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23645 * Get the maximum zoom of the source.
23647 * @param obj The map object.
23648 * @return Returns the maximum zoom of the source.
23650 * @see elm_map_source_zoom_min_set() for details.
23654 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23657 * Set the user agent used by the map object to access routing services.
23659 * @param obj The map object.
23660 * @param user_agent The user agent to be used by the map.
23662 * User agent is a client application implementing a network protocol used
23663 * in communications within a clientāserver distributed computing system
23665 * The @p user_agent identification string will transmitted in a header
23666 * field @c User-Agent.
23668 * @see elm_map_user_agent_get()
23672 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23675 * Get the user agent used by the map object.
23677 * @param obj The map object.
23678 * @return The user agent identification string used by the map.
23680 * @see elm_map_user_agent_set() for details.
23684 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23687 * Add a new route to the map object.
23689 * @param obj The map object.
23690 * @param type The type of transport to be considered when tracing a route.
23691 * @param method The routing method, what should be priorized.
23692 * @param flon The start longitude.
23693 * @param flat The start latitude.
23694 * @param tlon The destination longitude.
23695 * @param tlat The destination latitude.
23697 * @return The created route or @c NULL upon failure.
23699 * A route will be traced by point on coordinates (@p flat, @p flon)
23700 * to point on coordinates (@p tlat, @p tlon), using the route service
23701 * set with elm_map_route_source_set().
23703 * It will take @p type on consideration to define the route,
23704 * depending if the user will be walking or driving, the route may vary.
23705 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23706 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23708 * Another parameter is what the route should priorize, the minor distance
23709 * or the less time to be spend on the route. So @p method should be one
23710 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23712 * Routes created with this method can be deleted with
23713 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23714 * and distance can be get with elm_map_route_distance_get().
23716 * @see elm_map_route_remove()
23717 * @see elm_map_route_color_set()
23718 * @see elm_map_route_distance_get()
23719 * @see elm_map_route_source_set()
23723 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);
23726 * Remove a route from the map.
23728 * @param route The route to remove.
23730 * @see elm_map_route_add()
23734 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23737 * Set the route color.
23739 * @param route The route object.
23740 * @param r Red channel value, from 0 to 255.
23741 * @param g Green channel value, from 0 to 255.
23742 * @param b Blue channel value, from 0 to 255.
23743 * @param a Alpha channel value, from 0 to 255.
23745 * It uses an additive color model, so each color channel represents
23746 * how much of each primary colors must to be used. 0 represents
23747 * ausence of this color, so if all of the three are set to 0,
23748 * the color will be black.
23750 * These component values should be integers in the range 0 to 255,
23751 * (single 8-bit byte).
23753 * This sets the color used for the route. By default, it is set to
23754 * solid red (r = 255, g = 0, b = 0, a = 255).
23756 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23758 * @see elm_map_route_color_get()
23762 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23765 * Get the route color.
23767 * @param route The route object.
23768 * @param r Pointer where to store the red channel value.
23769 * @param g Pointer where to store the green channel value.
23770 * @param b Pointer where to store the blue channel value.
23771 * @param a Pointer where to store the alpha channel value.
23773 * @see elm_map_route_color_set() for details.
23777 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23780 * Get the route distance in kilometers.
23782 * @param route The route object.
23783 * @return The distance of route (unit : km).
23787 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23790 * Get the information of route nodes.
23792 * @param route The route object.
23793 * @return Returns a string with the nodes of route.
23797 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23800 * Get the information of route waypoint.
23802 * @param route the route object.
23803 * @return Returns a string with information about waypoint of route.
23807 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23810 * Get the address of the name.
23812 * @param name The name handle.
23813 * @return Returns the address string of @p name.
23815 * This gets the coordinates of the @p name, created with one of the
23816 * conversion functions.
23818 * @see elm_map_utils_convert_name_into_coord()
23819 * @see elm_map_utils_convert_coord_into_name()
23823 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23826 * Get the current coordinates of the name.
23828 * @param name The name handle.
23829 * @param lat Pointer where to store the latitude.
23830 * @param lon Pointer where to store The longitude.
23832 * This gets the coordinates of the @p name, created with one of the
23833 * conversion functions.
23835 * @see elm_map_utils_convert_name_into_coord()
23836 * @see elm_map_utils_convert_coord_into_name()
23840 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23843 * Remove a name from the map.
23845 * @param name The name to remove.
23847 * Basically the struct handled by @p name will be freed, so convertions
23848 * between address and coordinates will be lost.
23850 * @see elm_map_utils_convert_name_into_coord()
23851 * @see elm_map_utils_convert_coord_into_name()
23855 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23860 * @param obj The map object.
23861 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23862 * @param cx Rotation's center horizontal position.
23863 * @param cy Rotation's center vertical position.
23865 * @see elm_map_rotate_get()
23869 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23872 * Get the rotate degree of the map
23874 * @param obj The map object
23875 * @param degree Pointer where to store degrees from 0.0 to 360.0
23876 * to rotate arount Z axis.
23877 * @param cx Pointer where to store rotation's center horizontal position.
23878 * @param cy Pointer where to store rotation's center vertical position.
23880 * @see elm_map_rotate_set() to set map rotation.
23884 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);
23887 * Enable or disable mouse wheel to be used to zoom in / out the map.
23889 * @param obj The map object.
23890 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23893 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23895 * It's disabled by default.
23897 * @see elm_map_wheel_disabled_get()
23901 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23904 * Get a value whether mouse wheel is enabled or not.
23906 * @param obj The map object.
23907 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23908 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23910 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23912 * @see elm_map_wheel_disabled_set() for details.
23916 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23920 * Add a track on the map
23922 * @param obj The map object.
23923 * @param emap The emap route object.
23924 * @return The route object. This is an elm object of type Route.
23926 * @see elm_route_add() for details.
23930 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23934 * Remove a track from the map
23936 * @param obj The map object.
23937 * @param route The track to remove.
23941 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23948 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23950 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23952 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23953 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23954 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23955 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23959 * @defgroup Panel Panel
23961 * @image html img/widget/panel/preview-00.png
23962 * @image latex img/widget/panel/preview-00.eps
23964 * @brief A panel is a type of animated container that contains subobjects.
23965 * It can be expanded or contracted by clicking the button on it's edge.
23967 * Orientations are as follows:
23968 * @li ELM_PANEL_ORIENT_TOP
23969 * @li ELM_PANEL_ORIENT_LEFT
23970 * @li ELM_PANEL_ORIENT_RIGHT
23972 * Default contents parts of the panel widget that you can use for are:
23973 * @li "default" - A content of the panel
23975 * @ref tutorial_panel shows one way to use this widget.
23978 typedef enum _Elm_Panel_Orient
23980 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23981 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23982 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23983 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23984 } Elm_Panel_Orient;
23986 * @brief Adds a panel object
23988 * @param parent The parent object
23990 * @return The panel object, or NULL on failure
23992 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23994 * @brief Sets the orientation of the panel
23996 * @param parent The parent object
23997 * @param orient The panel orientation. Can be one of the following:
23998 * @li ELM_PANEL_ORIENT_TOP
23999 * @li ELM_PANEL_ORIENT_LEFT
24000 * @li ELM_PANEL_ORIENT_RIGHT
24002 * Sets from where the panel will (dis)appear.
24004 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24006 * @brief Get the orientation of the panel.
24008 * @param obj The panel object
24009 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24011 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24013 * @brief Set the content of the panel.
24015 * @param obj The panel object
24016 * @param content The panel content
24018 * Once the content object is set, a previously set one will be deleted.
24019 * If you want to keep that old content object, use the
24020 * elm_panel_content_unset() function.
24022 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24024 * @brief Get the content of the panel.
24026 * @param obj The panel object
24027 * @return The content that is being used
24029 * Return the content object which is set for this widget.
24031 * @see elm_panel_content_set()
24033 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24035 * @brief Unset the content of the panel.
24037 * @param obj The panel object
24038 * @return The content that was being used
24040 * Unparent and return the content object which was set for this widget.
24042 * @see elm_panel_content_set()
24044 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24046 * @brief Set the state of the panel.
24048 * @param obj The panel object
24049 * @param hidden If true, the panel will run the animation to contract
24051 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24053 * @brief Get the state of the panel.
24055 * @param obj The panel object
24056 * @param hidden If true, the panel is in the "hide" state
24058 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24060 * @brief Toggle the hidden state of the panel from code
24062 * @param obj The panel object
24064 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24070 * @defgroup Panes Panes
24071 * @ingroup Elementary
24073 * @image html img/widget/panes/preview-00.png
24074 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24076 * @image html img/panes.png
24077 * @image latex img/panes.eps width=\textwidth
24079 * The panes adds a dragable bar between two contents. When dragged
24080 * this bar will resize contents size.
24082 * Panes can be displayed vertically or horizontally, and contents
24083 * size proportion can be customized (homogeneous by default).
24085 * Smart callbacks one can listen to:
24086 * - "press" - The panes has been pressed (button wasn't released yet).
24087 * - "unpressed" - The panes was released after being pressed.
24088 * - "clicked" - The panes has been clicked>
24089 * - "clicked,double" - The panes has been double clicked
24091 * Available styles for it:
24094 * Default contents parts of the panes widget that you can use for are:
24095 * @li "left" - A leftside content of the panes
24096 * @li "right" - A rightside content of the panes
24098 * If panes is displayed vertically, left content will be displayed at
24101 * Here is an example on its usage:
24102 * @li @ref panes_example
24106 * @addtogroup Panes
24111 * Add a new panes widget to the given parent Elementary
24112 * (container) object.
24114 * @param parent The parent object.
24115 * @return a new panes widget handle or @c NULL, on errors.
24117 * This function inserts a new panes widget on the canvas.
24121 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24124 * Set the left content of the panes widget.
24126 * @param obj The panes object.
24127 * @param content The new left content object.
24129 * Once the content object is set, a previously set one will be deleted.
24130 * If you want to keep that old content object, use the
24131 * elm_panes_content_left_unset() function.
24133 * If panes is displayed vertically, left content will be displayed at
24136 * @see elm_panes_content_left_get()
24137 * @see elm_panes_content_right_set() to set content on the other side.
24139 * @deprecated use elm_object_part_content_set() instead
24143 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24146 * Set the right content of the panes widget.
24148 * @param obj The panes object.
24149 * @param content The new right content object.
24151 * Once the content object is set, a previously set one will be deleted.
24152 * If you want to keep that old content object, use the
24153 * elm_panes_content_right_unset() function.
24155 * If panes is displayed vertically, left content will be displayed at
24158 * @see elm_panes_content_right_get()
24159 * @see elm_panes_content_left_set() to set content on the other side.
24161 * @deprecated use elm_object_part_content_set() instead
24165 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24168 * Get the left content of the panes.
24170 * @param obj The panes object.
24171 * @return The left content object that is being used.
24173 * Return the left content object which is set for this widget.
24175 * @see elm_panes_content_left_set() for details.
24177 * @deprecated use elm_object_part_content_get() instead
24181 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24184 * Get the right content of the panes.
24186 * @param obj The panes object
24187 * @return The right content object that is being used
24189 * Return the right content object which is set for this widget.
24191 * @see elm_panes_content_right_set() for details.
24193 * @deprecated use elm_object_part_content_get() instead
24197 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24200 * Unset the left content used for the panes.
24202 * @param obj The panes object.
24203 * @return The left content object that was being used.
24205 * Unparent and return the left content object which was set for this widget.
24207 * @see elm_panes_content_left_set() for details.
24208 * @see elm_panes_content_left_get().
24210 * @deprecated use elm_object_part_content_unset() instead
24214 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24217 * Unset the right content used for the panes.
24219 * @param obj The panes object.
24220 * @return The right content object that was being used.
24222 * Unparent and return the right content object which was set for this
24225 * @see elm_panes_content_right_set() for details.
24226 * @see elm_panes_content_right_get().
24228 * @deprecated use elm_object_part_content_unset() instead
24232 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24235 * Get the size proportion of panes widget's left side.
24237 * @param obj The panes object.
24238 * @return float value between 0.0 and 1.0 representing size proportion
24241 * @see elm_panes_content_left_size_set() for more details.
24245 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24248 * Set the size proportion of panes widget's left side.
24250 * @param obj The panes object.
24251 * @param size Value between 0.0 and 1.0 representing size proportion
24254 * By default it's homogeneous, i.e., both sides have the same size.
24256 * If something different is required, it can be set with this function.
24257 * For example, if the left content should be displayed over
24258 * 75% of the panes size, @p size should be passed as @c 0.75.
24259 * This way, right content will be resized to 25% of panes size.
24261 * If displayed vertically, left content is displayed at top, and
24262 * right content at bottom.
24264 * @note This proportion will change when user drags the panes bar.
24266 * @see elm_panes_content_left_size_get()
24270 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24273 * Set the orientation of a given panes widget.
24275 * @param obj The panes object.
24276 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24277 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24279 * Use this function to change how your panes is to be
24280 * disposed: vertically or horizontally.
24282 * By default it's displayed horizontally.
24284 * @see elm_panes_horizontal_get()
24288 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24291 * Retrieve the orientation of a given panes widget.
24293 * @param obj The panes object.
24294 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24295 * @c EINA_FALSE if it's @b vertical (and on errors).
24297 * @see elm_panes_horizontal_set() for more details.
24301 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24302 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24303 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24310 * @defgroup Flip Flip
24312 * @image html img/widget/flip/preview-00.png
24313 * @image latex img/widget/flip/preview-00.eps
24315 * This widget holds 2 content objects(Evas_Object): one on the front and one
24316 * on the back. It allows you to flip from front to back and vice-versa using
24317 * various animations.
24319 * If either the front or back contents are not set the flip will treat that
24320 * as transparent. So if you wore to set the front content but not the back,
24321 * and then call elm_flip_go() you would see whatever is below the flip.
24323 * For a list of supported animations see elm_flip_go().
24325 * Signals that you can add callbacks for are:
24326 * "animate,begin" - when a flip animation was started
24327 * "animate,done" - when a flip animation is finished
24329 * @ref tutorial_flip show how to use most of the API.
24333 typedef enum _Elm_Flip_Mode
24335 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24336 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24337 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24338 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24339 ELM_FLIP_CUBE_LEFT,
24340 ELM_FLIP_CUBE_RIGHT,
24342 ELM_FLIP_CUBE_DOWN,
24343 ELM_FLIP_PAGE_LEFT,
24344 ELM_FLIP_PAGE_RIGHT,
24348 typedef enum _Elm_Flip_Interaction
24350 ELM_FLIP_INTERACTION_NONE,
24351 ELM_FLIP_INTERACTION_ROTATE,
24352 ELM_FLIP_INTERACTION_CUBE,
24353 ELM_FLIP_INTERACTION_PAGE
24354 } Elm_Flip_Interaction;
24355 typedef enum _Elm_Flip_Direction
24357 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24358 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24359 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24360 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24361 } Elm_Flip_Direction;
24363 * @brief Add a new flip to the parent
24365 * @param parent The parent object
24366 * @return The new object or NULL if it cannot be created
24368 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24370 * @brief Set the front content of the flip widget.
24372 * @param obj The flip object
24373 * @param content The new front content object
24375 * Once the content object is set, a previously set one will be deleted.
24376 * If you want to keep that old content object, use the
24377 * elm_flip_content_front_unset() function.
24379 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24381 * @brief Set the back content of the flip widget.
24383 * @param obj The flip object
24384 * @param content The new back content object
24386 * Once the content object is set, a previously set one will be deleted.
24387 * If you want to keep that old content object, use the
24388 * elm_flip_content_back_unset() function.
24390 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24392 * @brief Get the front content used for the flip
24394 * @param obj The flip object
24395 * @return The front content object that is being used
24397 * Return the front content object which is set for this widget.
24399 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24401 * @brief Get the back content used for the flip
24403 * @param obj The flip object
24404 * @return The back content object that is being used
24406 * Return the back content object which is set for this widget.
24408 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24410 * @brief Unset the front content used for the flip
24412 * @param obj The flip object
24413 * @return The front content object that was being used
24415 * Unparent and return the front content object which was set for this widget.
24417 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24419 * @brief Unset the back content used for the flip
24421 * @param obj The flip object
24422 * @return The back content object that was being used
24424 * Unparent and return the back content object which was set for this widget.
24426 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24428 * @brief Get flip front visibility state
24430 * @param obj The flip objct
24431 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24434 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24436 * @brief Set flip perspective
24438 * @param obj The flip object
24439 * @param foc The coordinate to set the focus on
24440 * @param x The X coordinate
24441 * @param y The Y coordinate
24443 * @warning This function currently does nothing.
24445 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24447 * @brief Runs the flip animation
24449 * @param obj The flip object
24450 * @param mode The mode type
24452 * Flips the front and back contents using the @p mode animation. This
24453 * efectively hides the currently visible content and shows the hidden one.
24455 * There a number of possible animations to use for the flipping:
24456 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24457 * around a horizontal axis in the middle of its height, the other content
24458 * is shown as the other side of the flip.
24459 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24460 * around a vertical axis in the middle of its width, the other content is
24461 * shown as the other side of the flip.
24462 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24463 * around a diagonal axis in the middle of its width, the other content is
24464 * shown as the other side of the flip.
24465 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24466 * around a diagonal axis in the middle of its height, the other content is
24467 * shown as the other side of the flip.
24468 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24469 * as if the flip was a cube, the other content is show as the right face of
24471 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24472 * right as if the flip was a cube, the other content is show as the left
24473 * face of the cube.
24474 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24475 * flip was a cube, the other content is show as the bottom face of the cube.
24476 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24477 * the flip was a cube, the other content is show as the upper face of the
24479 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24480 * if the flip was a book, the other content is shown as the page below that.
24481 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24482 * as if the flip was a book, the other content is shown as the page below
24484 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24485 * flip was a book, the other content is shown as the page below that.
24486 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24487 * flip was a book, the other content is shown as the page below that.
24489 * @image html elm_flip.png
24490 * @image latex elm_flip.eps width=\textwidth
24492 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24494 * @brief Set the interactive flip mode
24496 * @param obj The flip object
24497 * @param mode The interactive flip mode to use
24499 * This sets if the flip should be interactive (allow user to click and
24500 * drag a side of the flip to reveal the back page and cause it to flip).
24501 * By default a flip is not interactive. You may also need to set which
24502 * sides of the flip are "active" for flipping and how much space they use
24503 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24504 * and elm_flip_interacton_direction_hitsize_set()
24506 * The four avilable mode of interaction are:
24507 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24508 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24509 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24510 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24512 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24513 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24514 * happen, those can only be acheived with elm_flip_go();
24516 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24518 * @brief Get the interactive flip mode
24520 * @param obj The flip object
24521 * @return The interactive flip mode
24523 * Returns the interactive flip mode set by elm_flip_interaction_set()
24525 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24527 * @brief Set which directions of the flip respond to interactive flip
24529 * @param obj The flip object
24530 * @param dir The direction to change
24531 * @param enabled If that direction is enabled or not
24533 * By default all directions are disabled, so you may want to enable the
24534 * desired directions for flipping if you need interactive flipping. You must
24535 * call this function once for each direction that should be enabled.
24537 * @see elm_flip_interaction_set()
24539 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24541 * @brief Get the enabled state of that flip direction
24543 * @param obj The flip object
24544 * @param dir The direction to check
24545 * @return If that direction is enabled or not
24547 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24549 * @see elm_flip_interaction_set()
24551 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24553 * @brief Set the amount of the flip that is sensitive to interactive flip
24555 * @param obj The flip object
24556 * @param dir The direction to modify
24557 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24559 * Set the amount of the flip that is sensitive to interactive flip, with 0
24560 * representing no area in the flip and 1 representing the entire flip. There
24561 * is however a consideration to be made in that the area will never be
24562 * smaller than the finger size set(as set in your Elementary configuration).
24564 * @see elm_flip_interaction_set()
24566 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24568 * @brief Get the amount of the flip that is sensitive to interactive flip
24570 * @param obj The flip object
24571 * @param dir The direction to check
24572 * @return The size set for that direction
24574 * Returns the amount os sensitive area set by
24575 * elm_flip_interacton_direction_hitsize_set().
24577 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24582 /* scrolledentry */
24583 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24584 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24585 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24586 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24587 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24588 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24589 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24590 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24591 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24592 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24593 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24594 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24595 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24596 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24597 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24598 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24599 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24600 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24601 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24602 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24603 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24604 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24605 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24606 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24607 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24608 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24609 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24610 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24611 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24612 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24613 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24614 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24615 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24616 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24617 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24618 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);
24619 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24620 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24621 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);
24622 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24623 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);
24624 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24625 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24626 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24627 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24628 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24629 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24630 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24631 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24632 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);
24633 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);
24634 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);
24635 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);
24636 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);
24637 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);
24638 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24639 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24640 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24641 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24642 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24643 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24644 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24645 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24646 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24647 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24648 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24649 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24650 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24653 * @defgroup Conformant Conformant
24654 * @ingroup Elementary
24656 * @image html img/widget/conformant/preview-00.png
24657 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24659 * @image html img/conformant.png
24660 * @image latex img/conformant.eps width=\textwidth
24662 * The aim is to provide a widget that can be used in elementary apps to
24663 * account for space taken up by the indicator, virtual keypad & softkey
24664 * windows when running the illume2 module of E17.
24666 * So conformant content will be sized and positioned considering the
24667 * space required for such stuff, and when they popup, as a keyboard
24668 * shows when an entry is selected, conformant content won't change.
24670 * Available styles for it:
24673 * Default contents parts of the conformant widget that you can use for are:
24674 * @li "default" - A content of the conformant
24676 * See how to use this widget in this example:
24677 * @ref conformant_example
24681 * @addtogroup Conformant
24686 * Add a new conformant widget to the given parent Elementary
24687 * (container) object.
24689 * @param parent The parent object.
24690 * @return A new conformant widget handle or @c NULL, on errors.
24692 * This function inserts a new conformant widget on the canvas.
24694 * @ingroup Conformant
24696 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24699 * Set the content of the conformant widget.
24701 * @param obj The conformant object.
24702 * @param content The content to be displayed by the conformant.
24704 * Content will be sized and positioned considering the space required
24705 * to display a virtual keyboard. So it won't fill all the conformant
24706 * size. This way is possible to be sure that content won't resize
24707 * or be re-positioned after the keyboard is displayed.
24709 * Once the content object is set, a previously set one will be deleted.
24710 * If you want to keep that old content object, use the
24711 * elm_object_content_unset() function.
24713 * @see elm_object_content_unset()
24714 * @see elm_object_content_get()
24716 * @ingroup Conformant
24718 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24721 * Get the content of the conformant widget.
24723 * @param obj The conformant object.
24724 * @return The content that is being used.
24726 * Return the content object which is set for this widget.
24727 * It won't be unparent from conformant. For that, use
24728 * elm_object_content_unset().
24730 * @see elm_object_content_set().
24731 * @see elm_object_content_unset()
24733 * @ingroup Conformant
24735 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738 * Unset the content of the conformant widget.
24740 * @param obj The conformant object.
24741 * @return The content that was being used.
24743 * Unparent and return the content object which was set for this widget.
24745 * @see elm_object_content_set().
24747 * @ingroup Conformant
24749 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24752 * Returns the Evas_Object that represents the content area.
24754 * @param obj The conformant object.
24755 * @return The content area of the widget.
24757 * @ingroup Conformant
24759 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24766 * @defgroup Mapbuf Mapbuf
24767 * @ingroup Elementary
24769 * @image html img/widget/mapbuf/preview-00.png
24770 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24772 * This holds one content object and uses an Evas Map of transformation
24773 * points to be later used with this content. So the content will be
24774 * moved, resized, etc as a single image. So it will improve performance
24775 * when you have a complex interafce, with a lot of elements, and will
24776 * need to resize or move it frequently (the content object and its
24779 * Default contents parts of the mapbuf widget that you can use for are:
24780 * @li "default" - A content of the mapbuf
24782 * To enable map, elm_mapbuf_enabled_set() should be used.
24784 * See how to use this widget in this example:
24785 * @ref mapbuf_example
24789 * @addtogroup Mapbuf
24794 * Add a new mapbuf widget to the given parent Elementary
24795 * (container) object.
24797 * @param parent The parent object.
24798 * @return A new mapbuf widget handle or @c NULL, on errors.
24800 * This function inserts a new mapbuf widget on the canvas.
24804 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24807 * Set the content of the mapbuf.
24809 * @param obj The mapbuf object.
24810 * @param content The content that will be filled in this mapbuf object.
24812 * Once the content object is set, a previously set one will be deleted.
24813 * If you want to keep that old content object, use the
24814 * elm_mapbuf_content_unset() function.
24816 * To enable map, elm_mapbuf_enabled_set() should be used.
24820 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24823 * Get the content of the mapbuf.
24825 * @param obj The mapbuf object.
24826 * @return The content that is being used.
24828 * Return the content object which is set for this widget.
24830 * @see elm_mapbuf_content_set() for details.
24834 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24837 * Unset the content of the mapbuf.
24839 * @param obj The mapbuf object.
24840 * @return The content that was being used.
24842 * Unparent and return the content object which was set for this widget.
24844 * @see elm_mapbuf_content_set() for details.
24848 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24851 * Enable or disable the map.
24853 * @param obj The mapbuf object.
24854 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24856 * This enables the map that is set or disables it. On enable, the object
24857 * geometry will be saved, and the new geometry will change (position and
24858 * size) to reflect the map geometry set.
24860 * Also, when enabled, alpha and smooth states will be used, so if the
24861 * content isn't solid, alpha should be enabled, for example, otherwise
24862 * a black retangle will fill the content.
24864 * When disabled, the stored map will be freed and geometry prior to
24865 * enabling the map will be restored.
24867 * It's disabled by default.
24869 * @see elm_mapbuf_alpha_set()
24870 * @see elm_mapbuf_smooth_set()
24874 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24877 * Get a value whether map is enabled or not.
24879 * @param obj The mapbuf object.
24880 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24881 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24883 * @see elm_mapbuf_enabled_set() for details.
24887 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24890 * Enable or disable smooth map rendering.
24892 * @param obj The mapbuf object.
24893 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24896 * This sets smoothing for map rendering. If the object is a type that has
24897 * its own smoothing settings, then both the smooth settings for this object
24898 * and the map must be turned off.
24900 * By default smooth maps are enabled.
24904 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24907 * Get a value whether smooth map rendering is enabled or not.
24909 * @param obj The mapbuf object.
24910 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24911 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24913 * @see elm_mapbuf_smooth_set() for details.
24917 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24920 * Set or unset alpha flag for map rendering.
24922 * @param obj The mapbuf object.
24923 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24926 * This sets alpha flag for map rendering. If the object is a type that has
24927 * its own alpha settings, then this will take precedence. Only image objects
24928 * have this currently. It stops alpha blending of the map area, and is
24929 * useful if you know the object and/or all sub-objects is 100% solid.
24931 * Alpha is enabled by default.
24935 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24938 * Get a value whether alpha blending is enabled or not.
24940 * @param obj The mapbuf object.
24941 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24942 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24944 * @see elm_mapbuf_alpha_set() for details.
24948 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24955 * @defgroup Flipselector Flip Selector
24957 * @image html img/widget/flipselector/preview-00.png
24958 * @image latex img/widget/flipselector/preview-00.eps
24960 * A flip selector is a widget to show a set of @b text items, one
24961 * at a time, with the same sheet switching style as the @ref Clock
24962 * "clock" widget, when one changes the current displaying sheet
24963 * (thus, the "flip" in the name).
24965 * User clicks to flip sheets which are @b held for some time will
24966 * make the flip selector to flip continuosly and automatically for
24967 * the user. The interval between flips will keep growing in time,
24968 * so that it helps the user to reach an item which is distant from
24969 * the current selection.
24971 * Smart callbacks one can register to:
24972 * - @c "selected" - when the widget's selected text item is changed
24973 * - @c "overflowed" - when the widget's current selection is changed
24974 * from the first item in its list to the last
24975 * - @c "underflowed" - when the widget's current selection is changed
24976 * from the last item in its list to the first
24978 * Available styles for it:
24981 * To set/get the label of the flipselector item, you can use
24982 * elm_object_item_text_set/get APIs.
24983 * Once the text is set, a previously set one will be deleted.
24985 * Here is an example on its usage:
24986 * @li @ref flipselector_example
24990 * @addtogroup Flipselector
24995 * Add a new flip selector widget to the given parent Elementary
24996 * (container) widget
24998 * @param parent The parent object
24999 * @return a new flip selector widget handle or @c NULL, on errors
25001 * This function inserts a new flip selector widget on the canvas.
25003 * @ingroup Flipselector
25005 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25008 * Programmatically select the next item of a flip selector widget
25010 * @param obj The flipselector object
25012 * @note The selection will be animated. Also, if it reaches the
25013 * end of its list of member items, it will continue with the first
25016 * @ingroup Flipselector
25018 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25021 * Programmatically select the previous item of a flip selector
25024 * @param obj The flipselector object
25026 * @note The selection will be animated. Also, if it reaches the
25027 * beginning of its list of member items, it will continue with the
25028 * last one backwards.
25030 * @ingroup Flipselector
25032 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25035 * Append a (text) item to a flip selector widget
25037 * @param obj The flipselector object
25038 * @param label The (text) label of the new item
25039 * @param func Convenience callback function to take place when
25041 * @param data Data passed to @p func, above
25042 * @return A handle to the item added or @c NULL, on errors
25044 * The widget's list of labels to show will be appended with the
25045 * given value. If the user wishes so, a callback function pointer
25046 * can be passed, which will get called when this same item is
25049 * @note The current selection @b won't be modified by appending an
25050 * element to the list.
25052 * @note The maximum length of the text label is going to be
25053 * determined <b>by the widget's theme</b>. Strings larger than
25054 * that value are going to be @b truncated.
25056 * @ingroup Flipselector
25058 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25061 * Prepend a (text) item to a flip selector widget
25063 * @param obj The flipselector object
25064 * @param label The (text) label of the new item
25065 * @param func Convenience callback function to take place when
25067 * @param data Data passed to @p func, above
25068 * @return A handle to the item added or @c NULL, on errors
25070 * The widget's list of labels to show will be prepended with the
25071 * given value. If the user wishes so, a callback function pointer
25072 * can be passed, which will get called when this same item is
25075 * @note The current selection @b won't be modified by prepending
25076 * an element to the list.
25078 * @note The maximum length of the text label is going to be
25079 * determined <b>by the widget's theme</b>. Strings larger than
25080 * that value are going to be @b truncated.
25082 * @ingroup Flipselector
25084 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25087 * Get the internal list of items in a given flip selector widget.
25089 * @param obj The flipselector object
25090 * @return The list of items (#Elm_Object_Item as data) or
25091 * @c NULL on errors.
25093 * This list is @b not to be modified in any way and must not be
25094 * freed. Use the list members with functions like
25095 * elm_object_item_text_set(),
25096 * elm_object_item_text_get(),
25097 * elm_flipselector_item_del(),
25098 * elm_flipselector_item_selected_get(),
25099 * elm_flipselector_item_selected_set().
25101 * @warning This list is only valid until @p obj object's internal
25102 * items list is changed. It should be fetched again with another
25103 * call to this function when changes happen.
25105 * @ingroup Flipselector
25107 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25110 * Get the first item in the given flip selector widget's list of
25113 * @param obj The flipselector object
25114 * @return The first item or @c NULL, if it has no items (and on
25117 * @see elm_flipselector_item_append()
25118 * @see elm_flipselector_last_item_get()
25120 * @ingroup Flipselector
25122 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25125 * Get the last item in the given flip selector widget's list of
25128 * @param obj The flipselector object
25129 * @return The last item or @c NULL, if it has no items (and on
25132 * @see elm_flipselector_item_prepend()
25133 * @see elm_flipselector_first_item_get()
25135 * @ingroup Flipselector
25137 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25140 * Get the currently selected item in a flip selector widget.
25142 * @param obj The flipselector object
25143 * @return The selected item or @c NULL, if the widget has no items
25146 * @ingroup Flipselector
25148 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25151 * Set whether a given flip selector widget's item should be the
25152 * currently selected one.
25154 * @param it The flip selector item
25155 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25157 * This sets whether @p item is or not the selected (thus, under
25158 * display) one. If @p item is different than one under display,
25159 * the latter will be unselected. If the @p item is set to be
25160 * unselected, on the other hand, the @b first item in the widget's
25161 * internal members list will be the new selected one.
25163 * @see elm_flipselector_item_selected_get()
25165 * @ingroup Flipselector
25167 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25170 * Get whether a given flip selector widget's item is the currently
25173 * @param it The flip selector item
25174 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25177 * @see elm_flipselector_item_selected_set()
25179 * @ingroup Flipselector
25181 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25184 * Delete a given item from a flip selector widget.
25186 * @param it The item to delete
25188 * @ingroup Flipselector
25190 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25193 * Get the label of a given flip selector widget's item.
25195 * @param it The item to get label from
25196 * @return The text label of @p item or @c NULL, on errors
25198 * @see elm_object_item_text_set()
25200 * @deprecated see elm_object_item_text_get() instead
25201 * @ingroup Flipselector
25203 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25206 * Set the label of a given flip selector widget's item.
25208 * @param it The item to set label on
25209 * @param label The text label string, in UTF-8 encoding
25211 * @see elm_object_item_text_get()
25213 * @deprecated see elm_object_item_text_set() instead
25214 * @ingroup Flipselector
25216 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25219 * Gets the item before @p item in a flip selector widget's
25220 * internal list of items.
25222 * @param it The item to fetch previous from
25223 * @return The item before the @p item, in its parent's list. If
25224 * there is no previous item for @p item or there's an
25225 * error, @c NULL is returned.
25227 * @see elm_flipselector_item_next_get()
25229 * @ingroup Flipselector
25231 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25234 * Gets the item after @p item in a flip selector widget's
25235 * internal list of items.
25237 * @param it The item to fetch next from
25238 * @return The item after the @p item, in its parent's list. If
25239 * there is no next item for @p item or there's an
25240 * error, @c NULL is returned.
25242 * @see elm_flipselector_item_next_get()
25244 * @ingroup Flipselector
25246 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25249 * Set the interval on time updates for an user mouse button hold
25250 * on a flip selector widget.
25252 * @param obj The flip selector object
25253 * @param interval The (first) interval value in seconds
25255 * This interval value is @b decreased while the user holds the
25256 * mouse pointer either flipping up or flipping doww a given flip
25259 * This helps the user to get to a given item distant from the
25260 * current one easier/faster, as it will start to flip quicker and
25261 * quicker on mouse button holds.
25263 * The calculation for the next flip interval value, starting from
25264 * the one set with this call, is the previous interval divided by
25265 * 1.05, so it decreases a little bit.
25267 * The default starting interval value for automatic flips is
25270 * @see elm_flipselector_interval_get()
25272 * @ingroup Flipselector
25274 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25277 * Get the interval on time updates for an user mouse button hold
25278 * on a flip selector widget.
25280 * @param obj The flip selector object
25281 * @return The (first) interval value, in seconds, set on it
25283 * @see elm_flipselector_interval_set() for more details
25285 * @ingroup Flipselector
25287 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25293 * @addtogroup Calendar
25298 * @enum _Elm_Calendar_Mark_Repeat
25299 * @typedef Elm_Calendar_Mark_Repeat
25301 * Event periodicity, used to define if a mark should be repeated
25302 * @b beyond event's day. It's set when a mark is added.
25304 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25305 * there will be marks every week after this date. Marks will be displayed
25306 * at 13th, 20th, 27th, 3rd June ...
25308 * Values don't work as bitmask, only one can be choosen.
25310 * @see elm_calendar_mark_add()
25312 * @ingroup Calendar
25314 typedef enum _Elm_Calendar_Mark_Repeat
25316 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25317 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25318 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25319 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*/
25320 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. */
25321 } Elm_Calendar_Mark_Repeat;
25323 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(). */
25326 * Add a new calendar widget to the given parent Elementary
25327 * (container) object.
25329 * @param parent The parent object.
25330 * @return a new calendar widget handle or @c NULL, on errors.
25332 * This function inserts a new calendar widget on the canvas.
25334 * @ref calendar_example_01
25336 * @ingroup Calendar
25338 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25341 * Get weekdays names displayed by the calendar.
25343 * @param obj The calendar object.
25344 * @return Array of seven strings to be used as weekday names.
25346 * By default, weekdays abbreviations get from system are displayed:
25347 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25348 * The first string is related to Sunday, the second to Monday...
25350 * @see elm_calendar_weekdays_name_set()
25352 * @ref calendar_example_05
25354 * @ingroup Calendar
25356 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25359 * Set weekdays names to be displayed by the calendar.
25361 * @param obj The calendar object.
25362 * @param weekdays Array of seven strings to be used as weekday names.
25363 * @warning It must have 7 elements, or it will access invalid memory.
25364 * @warning The strings must be NULL terminated ('@\0').
25366 * By default, weekdays abbreviations get from system are displayed:
25367 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25369 * The first string should be related to Sunday, the second to Monday...
25371 * The usage should be like this:
25373 * const char *weekdays[] =
25375 * "Sunday", "Monday", "Tuesday", "Wednesday",
25376 * "Thursday", "Friday", "Saturday"
25378 * elm_calendar_weekdays_names_set(calendar, weekdays);
25381 * @see elm_calendar_weekdays_name_get()
25383 * @ref calendar_example_02
25385 * @ingroup Calendar
25387 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25390 * Set the minimum and maximum values for the year
25392 * @param obj The calendar object
25393 * @param min The minimum year, greater than 1901;
25394 * @param max The maximum year;
25396 * Maximum must be greater than minimum, except if you don't wan't to set
25398 * Default values are 1902 and -1.
25400 * If the maximum year is a negative value, it will be limited depending
25401 * on the platform architecture (year 2037 for 32 bits);
25403 * @see elm_calendar_min_max_year_get()
25405 * @ref calendar_example_03
25407 * @ingroup Calendar
25409 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25412 * Get the minimum and maximum values for the year
25414 * @param obj The calendar object.
25415 * @param min The minimum year.
25416 * @param max The maximum year.
25418 * Default values are 1902 and -1.
25420 * @see elm_calendar_min_max_year_get() for more details.
25422 * @ref calendar_example_05
25424 * @ingroup Calendar
25426 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25429 * Enable or disable day selection
25431 * @param obj The calendar object.
25432 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25435 * Enabled by default. If disabled, the user still can select months,
25436 * but not days. Selected days are highlighted on calendar.
25437 * It should be used if you won't need such selection for the widget usage.
25439 * When a day is selected, or month is changed, smart callbacks for
25440 * signal "changed" will be called.
25442 * @see elm_calendar_day_selection_enable_get()
25444 * @ref calendar_example_04
25446 * @ingroup Calendar
25448 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25451 * Get a value whether day selection is enabled or not.
25453 * @see elm_calendar_day_selection_enable_set() for details.
25455 * @param obj The calendar object.
25456 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25457 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25459 * @ref calendar_example_05
25461 * @ingroup Calendar
25463 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25467 * Set selected date to be highlighted on calendar.
25469 * @param obj The calendar object.
25470 * @param selected_time A @b tm struct to represent the selected date.
25472 * Set the selected date, changing the displayed month if needed.
25473 * Selected date changes when the user goes to next/previous month or
25474 * select a day pressing over it on calendar.
25476 * @see elm_calendar_selected_time_get()
25478 * @ref calendar_example_04
25480 * @ingroup Calendar
25482 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25485 * Get selected date.
25487 * @param obj The calendar object
25488 * @param selected_time A @b tm struct to point to selected date
25489 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25492 * Get date selected by the user or set by function
25493 * elm_calendar_selected_time_set().
25494 * Selected date changes when the user goes to next/previous month or
25495 * select a day pressing over it on calendar.
25497 * @see elm_calendar_selected_time_get()
25499 * @ref calendar_example_05
25501 * @ingroup Calendar
25503 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25506 * Set a function to format the string that will be used to display
25509 * @param obj The calendar object
25510 * @param format_function Function to set the month-year string given
25511 * the selected date
25513 * By default it uses strftime with "%B %Y" format string.
25514 * It should allocate the memory that will be used by the string,
25515 * that will be freed by the widget after usage.
25516 * A pointer to the string and a pointer to the time struct will be provided.
25521 * _format_month_year(struct tm *selected_time)
25524 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25525 * return strdup(buf);
25528 * elm_calendar_format_function_set(calendar, _format_month_year);
25531 * @ref calendar_example_02
25533 * @ingroup Calendar
25535 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25538 * Add a new mark to the calendar
25540 * @param obj The calendar object
25541 * @param mark_type A string used to define the type of mark. It will be
25542 * emitted to the theme, that should display a related modification on these
25543 * days representation.
25544 * @param mark_time A time struct to represent the date of inclusion of the
25545 * mark. For marks that repeats it will just be displayed after the inclusion
25546 * date in the calendar.
25547 * @param repeat Repeat the event following this periodicity. Can be a unique
25548 * mark (that don't repeat), daily, weekly, monthly or annually.
25549 * @return The created mark or @p NULL upon failure.
25551 * Add a mark that will be drawn in the calendar respecting the insertion
25552 * time and periodicity. It will emit the type as signal to the widget theme.
25553 * Default theme supports "holiday" and "checked", but it can be extended.
25555 * It won't immediately update the calendar, drawing the marks.
25556 * For this, call elm_calendar_marks_draw(). However, when user selects
25557 * next or previous month calendar forces marks drawn.
25559 * Marks created with this method can be deleted with
25560 * elm_calendar_mark_del().
25564 * struct tm selected_time;
25565 * time_t current_time;
25567 * current_time = time(NULL) + 5 * 84600;
25568 * localtime_r(¤t_time, &selected_time);
25569 * elm_calendar_mark_add(cal, "holiday", selected_time,
25570 * ELM_CALENDAR_ANNUALLY);
25572 * current_time = time(NULL) + 1 * 84600;
25573 * localtime_r(¤t_time, &selected_time);
25574 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25576 * elm_calendar_marks_draw(cal);
25579 * @see elm_calendar_marks_draw()
25580 * @see elm_calendar_mark_del()
25582 * @ref calendar_example_06
25584 * @ingroup Calendar
25586 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);
25589 * Delete mark from the calendar.
25591 * @param mark The mark to be deleted.
25593 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25594 * should be used instead of getting marks list and deleting each one.
25596 * @see elm_calendar_mark_add()
25598 * @ref calendar_example_06
25600 * @ingroup Calendar
25602 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25605 * Remove all calendar's marks
25607 * @param obj The calendar object.
25609 * @see elm_calendar_mark_add()
25610 * @see elm_calendar_mark_del()
25612 * @ingroup Calendar
25614 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25618 * Get a list of all the calendar marks.
25620 * @param obj The calendar object.
25621 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25623 * @see elm_calendar_mark_add()
25624 * @see elm_calendar_mark_del()
25625 * @see elm_calendar_marks_clear()
25627 * @ingroup Calendar
25629 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25632 * Draw calendar marks.
25634 * @param obj The calendar object.
25636 * Should be used after adding, removing or clearing marks.
25637 * It will go through the entire marks list updating the calendar.
25638 * If lots of marks will be added, add all the marks and then call
25641 * When the month is changed, i.e. user selects next or previous month,
25642 * marks will be drawed.
25644 * @see elm_calendar_mark_add()
25645 * @see elm_calendar_mark_del()
25646 * @see elm_calendar_marks_clear()
25648 * @ref calendar_example_06
25650 * @ingroup Calendar
25652 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25655 * Set a day text color to the same that represents Saturdays.
25657 * @param obj The calendar object.
25658 * @param pos The text position. Position is the cell counter, from left
25659 * to right, up to down. It starts on 0 and ends on 41.
25661 * @deprecated use elm_calendar_mark_add() instead like:
25664 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25665 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25668 * @see elm_calendar_mark_add()
25670 * @ingroup Calendar
25672 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25675 * Set a day text color to the same that represents Sundays.
25677 * @param obj The calendar object.
25678 * @param pos The text position. Position is the cell counter, from left
25679 * to right, up to down. It starts on 0 and ends on 41.
25681 * @deprecated use elm_calendar_mark_add() instead like:
25684 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25685 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25688 * @see elm_calendar_mark_add()
25690 * @ingroup Calendar
25692 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25695 * Set a day text color to the same that represents Weekdays.
25697 * @param obj The calendar object
25698 * @param pos The text position. Position is the cell counter, from left
25699 * to right, up to down. It starts on 0 and ends on 41.
25701 * @deprecated use elm_calendar_mark_add() instead like:
25704 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25706 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25707 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25708 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25709 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25710 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25711 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25712 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25713 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25714 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25717 * @see elm_calendar_mark_add()
25719 * @ingroup Calendar
25721 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25724 * Set the interval on time updates for an user mouse button hold
25725 * on calendar widgets' month selection.
25727 * @param obj The calendar object
25728 * @param interval The (first) interval value in seconds
25730 * This interval value is @b decreased while the user holds the
25731 * mouse pointer either selecting next or previous month.
25733 * This helps the user to get to a given month distant from the
25734 * current one easier/faster, as it will start to change quicker and
25735 * quicker on mouse button holds.
25737 * The calculation for the next change interval value, starting from
25738 * the one set with this call, is the previous interval divided by
25739 * 1.05, so it decreases a little bit.
25741 * The default starting interval value for automatic changes is
25744 * @see elm_calendar_interval_get()
25746 * @ingroup Calendar
25748 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25751 * Get the interval on time updates for an user mouse button hold
25752 * on calendar widgets' month selection.
25754 * @param obj The calendar object
25755 * @return The (first) interval value, in seconds, set on it
25757 * @see elm_calendar_interval_set() for more details
25759 * @ingroup Calendar
25761 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25768 * @defgroup Diskselector Diskselector
25769 * @ingroup Elementary
25771 * @image html img/widget/diskselector/preview-00.png
25772 * @image latex img/widget/diskselector/preview-00.eps
25774 * A diskselector is a kind of list widget. It scrolls horizontally,
25775 * and can contain label and icon objects. Three items are displayed
25776 * with the selected one in the middle.
25778 * It can act like a circular list with round mode and labels can be
25779 * reduced for a defined length for side items.
25781 * Smart callbacks one can listen to:
25782 * - "selected" - when item is selected, i.e. scroller stops.
25784 * Available styles for it:
25787 * List of examples:
25788 * @li @ref diskselector_example_01
25789 * @li @ref diskselector_example_02
25793 * @addtogroup Diskselector
25797 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(). */
25800 * Add a new diskselector widget to the given parent Elementary
25801 * (container) object.
25803 * @param parent The parent object.
25804 * @return a new diskselector widget handle or @c NULL, on errors.
25806 * This function inserts a new diskselector widget on the canvas.
25808 * @ingroup Diskselector
25810 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25813 * Enable or disable round mode.
25815 * @param obj The diskselector object.
25816 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25819 * Disabled by default. If round mode is enabled the items list will
25820 * work like a circle list, so when the user reaches the last item,
25821 * the first one will popup.
25823 * @see elm_diskselector_round_get()
25825 * @ingroup Diskselector
25827 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25830 * Get a value whether round mode is enabled or not.
25832 * @see elm_diskselector_round_set() for details.
25834 * @param obj The diskselector object.
25835 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25836 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25838 * @ingroup Diskselector
25840 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25843 * Get the side labels max length.
25845 * @deprecated use elm_diskselector_side_label_length_get() instead:
25847 * @param obj The diskselector object.
25848 * @return The max length defined for side labels, or 0 if not a valid
25851 * @ingroup Diskselector
25853 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25856 * Set the side labels max length.
25858 * @deprecated use elm_diskselector_side_label_length_set() instead:
25860 * @param obj The diskselector object.
25861 * @param len The max length defined for side labels.
25863 * @ingroup Diskselector
25865 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25868 * Get the side labels max length.
25870 * @see elm_diskselector_side_label_length_set() for details.
25872 * @param obj The diskselector object.
25873 * @return The max length defined for side labels, or 0 if not a valid
25876 * @ingroup Diskselector
25878 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25881 * Set the side labels max length.
25883 * @param obj The diskselector object.
25884 * @param len The max length defined for side labels.
25886 * Length is the number of characters of items' label that will be
25887 * visible when it's set on side positions. It will just crop
25888 * the string after defined size. E.g.:
25890 * An item with label "January" would be displayed on side position as
25891 * "Jan" if max length is set to 3, or "Janu", if this property
25894 * When it's selected, the entire label will be displayed, except for
25895 * width restrictions. In this case label will be cropped and "..."
25896 * will be concatenated.
25898 * Default side label max length is 3.
25900 * This property will be applyed over all items, included before or
25901 * later this function call.
25903 * @ingroup Diskselector
25905 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25908 * Set the number of items to be displayed.
25910 * @param obj The diskselector object.
25911 * @param num The number of items the diskselector will display.
25913 * Default value is 3, and also it's the minimun. If @p num is less
25914 * than 3, it will be set to 3.
25916 * Also, it can be set on theme, using data item @c display_item_num
25917 * on group "elm/diskselector/item/X", where X is style set.
25920 * group { name: "elm/diskselector/item/X";
25922 * item: "display_item_num" "5";
25925 * @ingroup Diskselector
25927 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25930 * Get the number of items in the diskselector object.
25932 * @param obj The diskselector object.
25934 * @ingroup Diskselector
25936 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25939 * Set bouncing behaviour when the scrolled content reaches an edge.
25941 * Tell the internal scroller object whether it should bounce or not
25942 * when it reaches the respective edges for each axis.
25944 * @param obj The diskselector object.
25945 * @param h_bounce Whether to bounce or not in the horizontal axis.
25946 * @param v_bounce Whether to bounce or not in the vertical axis.
25948 * @see elm_scroller_bounce_set()
25950 * @ingroup Diskselector
25952 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25955 * Get the bouncing behaviour of the internal scroller.
25957 * Get whether the internal scroller should bounce when the edge of each
25958 * axis is reached scrolling.
25960 * @param obj The diskselector object.
25961 * @param h_bounce Pointer where to store the bounce state of the horizontal
25963 * @param v_bounce Pointer where to store the bounce state of the vertical
25966 * @see elm_scroller_bounce_get()
25967 * @see elm_diskselector_bounce_set()
25969 * @ingroup Diskselector
25971 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25974 * Get the scrollbar policy.
25976 * @see elm_diskselector_scroller_policy_get() for details.
25978 * @param obj The diskselector object.
25979 * @param policy_h Pointer where to store horizontal scrollbar policy.
25980 * @param policy_v Pointer where to store vertical scrollbar policy.
25982 * @ingroup Diskselector
25984 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);
25987 * Set the scrollbar policy.
25989 * @param obj The diskselector object.
25990 * @param policy_h Horizontal scrollbar policy.
25991 * @param policy_v Vertical scrollbar policy.
25993 * This sets the scrollbar visibility policy for the given scroller.
25994 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25995 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25996 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25997 * This applies respectively for the horizontal and vertical scrollbars.
25999 * The both are disabled by default, i.e., are set to
26000 * #ELM_SCROLLER_POLICY_OFF.
26002 * @ingroup Diskselector
26004 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26007 * Remove all diskselector's items.
26009 * @param obj The diskselector object.
26011 * @see elm_diskselector_item_del()
26012 * @see elm_diskselector_item_append()
26014 * @ingroup Diskselector
26016 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26019 * Get a list of all the diskselector items.
26021 * @param obj The diskselector object.
26022 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26023 * or @c NULL on failure.
26025 * @see elm_diskselector_item_append()
26026 * @see elm_diskselector_item_del()
26027 * @see elm_diskselector_clear()
26029 * @ingroup Diskselector
26031 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26034 * Appends a new item to the diskselector object.
26036 * @param obj The diskselector object.
26037 * @param label The label of the diskselector item.
26038 * @param icon The icon object to use at left side of the item. An
26039 * icon can be any Evas object, but usually it is an icon created
26040 * with elm_icon_add().
26041 * @param func The function to call when the item is selected.
26042 * @param data The data to associate with the item for related callbacks.
26044 * @return The created item or @c NULL upon failure.
26046 * A new item will be created and appended to the diskselector, i.e., will
26047 * be set as last item. Also, if there is no selected item, it will
26048 * be selected. This will always happens for the first appended item.
26050 * If no icon is set, label will be centered on item position, otherwise
26051 * the icon will be placed at left of the label, that will be shifted
26054 * Items created with this method can be deleted with
26055 * elm_diskselector_item_del().
26057 * Associated @p data can be properly freed when item is deleted if a
26058 * callback function is set with elm_diskselector_item_del_cb_set().
26060 * If a function is passed as argument, it will be called everytime this item
26061 * is selected, i.e., the user stops the diskselector with this
26062 * item on center position. If such function isn't needed, just passing
26063 * @c NULL as @p func is enough. The same should be done for @p data.
26065 * Simple example (with no function callback or data associated):
26067 * disk = elm_diskselector_add(win);
26068 * ic = elm_icon_add(win);
26069 * elm_icon_file_set(ic, "path/to/image", NULL);
26070 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26071 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26074 * @see elm_diskselector_item_del()
26075 * @see elm_diskselector_item_del_cb_set()
26076 * @see elm_diskselector_clear()
26077 * @see elm_icon_add()
26079 * @ingroup Diskselector
26081 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);
26085 * Delete them item from the diskselector.
26087 * @param it The item of diskselector to be deleted.
26089 * If deleting all diskselector items is required, elm_diskselector_clear()
26090 * should be used instead of getting items list and deleting each one.
26092 * @see elm_diskselector_clear()
26093 * @see elm_diskselector_item_append()
26094 * @see elm_diskselector_item_del_cb_set()
26096 * @ingroup Diskselector
26098 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26101 * Set the function called when a diskselector item is freed.
26103 * @param it The item to set the callback on
26104 * @param func The function called
26106 * If there is a @p func, then it will be called prior item's memory release.
26107 * That will be called with the following arguments:
26109 * @li item's Evas object;
26112 * This way, a data associated to a diskselector item could be properly
26115 * @ingroup Diskselector
26117 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26120 * Get the data associated to the item.
26122 * @param it The diskselector item
26123 * @return The data associated to @p it
26125 * The return value is a pointer to data associated to @p item when it was
26126 * created, with function elm_diskselector_item_append(). If no data
26127 * was passed as argument, it will return @c NULL.
26129 * @see elm_diskselector_item_append()
26131 * @ingroup Diskselector
26133 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26136 * Set the icon associated to the item.
26138 * @param it The diskselector item
26139 * @param icon The icon object to associate with @p it
26141 * The icon object to use at left side of the item. An
26142 * icon can be any Evas object, but usually it is an icon created
26143 * with elm_icon_add().
26145 * Once the icon object is set, a previously set one will be deleted.
26146 * @warning Setting the same icon for two items will cause the icon to
26147 * dissapear from the first item.
26149 * If an icon was passed as argument on item creation, with function
26150 * elm_diskselector_item_append(), it will be already
26151 * associated to the item.
26153 * @see elm_diskselector_item_append()
26154 * @see elm_diskselector_item_icon_get()
26156 * @ingroup Diskselector
26158 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26161 * Get the icon associated to the item.
26163 * @param it The diskselector item
26164 * @return The icon associated to @p it
26166 * The return value is a pointer to the icon associated to @p item when it was
26167 * created, with function elm_diskselector_item_append(), or later
26168 * with function elm_diskselector_item_icon_set. If no icon
26169 * was passed as argument, it will return @c NULL.
26171 * @see elm_diskselector_item_append()
26172 * @see elm_diskselector_item_icon_set()
26174 * @ingroup Diskselector
26176 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26179 * Set the label of item.
26181 * @param it The item of diskselector.
26182 * @param label The label of item.
26184 * The label to be displayed by the item.
26186 * If no icon is set, label will be centered on item position, otherwise
26187 * the icon will be placed at left of the label, that will be shifted
26190 * An item with label "January" would be displayed on side position as
26191 * "Jan" if max length is set to 3 with function
26192 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26195 * When this @p item is selected, the entire label will be displayed,
26196 * except for width restrictions.
26197 * In this case label will be cropped and "..." will be concatenated,
26198 * but only for display purposes. It will keep the entire string, so
26199 * if diskselector is resized the remaining characters will be displayed.
26201 * If a label was passed as argument on item creation, with function
26202 * elm_diskselector_item_append(), it will be already
26203 * displayed by the item.
26205 * @see elm_diskselector_side_label_lenght_set()
26206 * @see elm_diskselector_item_label_get()
26207 * @see elm_diskselector_item_append()
26209 * @ingroup Diskselector
26211 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26214 * Get the label of item.
26216 * @param it The item of diskselector.
26217 * @return The label of item.
26219 * The return value is a pointer to the label associated to @p item when it was
26220 * created, with function elm_diskselector_item_append(), or later
26221 * with function elm_diskselector_item_label_set. If no label
26222 * was passed as argument, it will return @c NULL.
26224 * @see elm_diskselector_item_label_set() for more details.
26225 * @see elm_diskselector_item_append()
26227 * @ingroup Diskselector
26229 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26232 * Get the selected item.
26234 * @param obj The diskselector object.
26235 * @return The selected diskselector item.
26237 * The selected item can be unselected with function
26238 * elm_diskselector_item_selected_set(), and the first item of
26239 * diskselector will be selected.
26241 * The selected item always will be centered on diskselector, with
26242 * full label displayed, i.e., max lenght set to side labels won't
26243 * apply on the selected item. More details on
26244 * elm_diskselector_side_label_length_set().
26246 * @ingroup Diskselector
26248 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26251 * Set the selected state of an item.
26253 * @param it The diskselector item
26254 * @param selected The selected state
26256 * This sets the selected state of the given item @p it.
26257 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26259 * If a new item is selected the previosly selected will be unselected.
26260 * Previoulsy selected item can be get with function
26261 * elm_diskselector_selected_item_get().
26263 * If the item @p it is unselected, the first item of diskselector will
26266 * Selected items will be visible on center position of diskselector.
26267 * So if it was on another position before selected, or was invisible,
26268 * diskselector will animate items until the selected item reaches center
26271 * @see elm_diskselector_item_selected_get()
26272 * @see elm_diskselector_selected_item_get()
26274 * @ingroup Diskselector
26276 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26279 * Get whether the @p item is selected or not.
26281 * @param it The diskselector item.
26282 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26283 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26285 * @see elm_diskselector_selected_item_set() for details.
26286 * @see elm_diskselector_item_selected_get()
26288 * @ingroup Diskselector
26290 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26293 * Get the first item of the diskselector.
26295 * @param obj The diskselector object.
26296 * @return The first item, or @c NULL if none.
26298 * The list of items follows append order. So it will return the first
26299 * item appended to the widget that wasn't deleted.
26301 * @see elm_diskselector_item_append()
26302 * @see elm_diskselector_items_get()
26304 * @ingroup Diskselector
26306 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26309 * Get the last item of the diskselector.
26311 * @param obj The diskselector object.
26312 * @return The last item, or @c NULL if none.
26314 * The list of items follows append order. So it will return last first
26315 * item appended to the widget that wasn't deleted.
26317 * @see elm_diskselector_item_append()
26318 * @see elm_diskselector_items_get()
26320 * @ingroup Diskselector
26322 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26325 * Get the item before @p item in diskselector.
26327 * @param it The diskselector item.
26328 * @return The item before @p item, or @c NULL if none or on failure.
26330 * The list of items follows append order. So it will return item appended
26331 * just before @p item and that wasn't deleted.
26333 * If it is the first item, @c NULL will be returned.
26334 * First item can be get by elm_diskselector_first_item_get().
26336 * @see elm_diskselector_item_append()
26337 * @see elm_diskselector_items_get()
26339 * @ingroup Diskselector
26341 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26344 * Get the item after @p item in diskselector.
26346 * @param it The diskselector item.
26347 * @return The item after @p item, or @c NULL if none or on failure.
26349 * The list of items follows append order. So it will return item appended
26350 * just after @p item and that wasn't deleted.
26352 * If it is the last item, @c NULL will be returned.
26353 * Last item can be get by elm_diskselector_last_item_get().
26355 * @see elm_diskselector_item_append()
26356 * @see elm_diskselector_items_get()
26358 * @ingroup Diskselector
26360 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26363 * Set the text to be shown in the diskselector item.
26365 * @param item Target item
26366 * @param text The text to set in the content
26368 * Setup the text as tooltip to object. The item can have only one tooltip,
26369 * so any previous tooltip data is removed.
26371 * @see elm_object_tooltip_text_set() for more details.
26373 * @ingroup Diskselector
26375 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26378 * Set the content to be shown in the tooltip item.
26380 * Setup the tooltip to item. The item can have only one tooltip,
26381 * so any previous tooltip data is removed. @p func(with @p data) will
26382 * be called every time that need show the tooltip and it should
26383 * return a valid Evas_Object. This object is then managed fully by
26384 * tooltip system and is deleted when the tooltip is gone.
26386 * @param item the diskselector item being attached a tooltip.
26387 * @param func the function used to create the tooltip contents.
26388 * @param data what to provide to @a func as callback data/context.
26389 * @param del_cb called when data is not needed anymore, either when
26390 * another callback replaces @p func, the tooltip is unset with
26391 * elm_diskselector_item_tooltip_unset() or the owner @a item
26392 * dies. This callback receives as the first parameter the
26393 * given @a data, and @c event_info is the item.
26395 * @see elm_object_tooltip_content_cb_set() for more details.
26397 * @ingroup Diskselector
26399 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);
26402 * Unset tooltip from item.
26404 * @param item diskselector item to remove previously set tooltip.
26406 * Remove tooltip from item. The callback provided as del_cb to
26407 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26408 * it is not used anymore.
26410 * @see elm_object_tooltip_unset() for more details.
26411 * @see elm_diskselector_item_tooltip_content_cb_set()
26413 * @ingroup Diskselector
26415 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26419 * Sets a different style for this item tooltip.
26421 * @note before you set a style you should define a tooltip with
26422 * elm_diskselector_item_tooltip_content_cb_set() or
26423 * elm_diskselector_item_tooltip_text_set()
26425 * @param item diskselector item with tooltip already set.
26426 * @param style the theme style to use (default, transparent, ...)
26428 * @see elm_object_tooltip_style_set() for more details.
26430 * @ingroup Diskselector
26432 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26435 * Get the style for this item tooltip.
26437 * @param item diskselector item with tooltip already set.
26438 * @return style the theme style in use, defaults to "default". If the
26439 * object does not have a tooltip set, then NULL is returned.
26441 * @see elm_object_tooltip_style_get() for more details.
26442 * @see elm_diskselector_item_tooltip_style_set()
26444 * @ingroup Diskselector
26446 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26449 * Set the cursor to be shown when mouse is over the diskselector item
26451 * @param item Target item
26452 * @param cursor the cursor name to be used.
26454 * @see elm_object_cursor_set() for more details.
26456 * @ingroup Diskselector
26458 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26461 * Get the cursor to be shown when mouse is over the diskselector item
26463 * @param item diskselector item with cursor already set.
26464 * @return the cursor name.
26466 * @see elm_object_cursor_get() for more details.
26467 * @see elm_diskselector_cursor_set()
26469 * @ingroup Diskselector
26471 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26475 * Unset the cursor to be shown when mouse is over the diskselector item
26477 * @param item Target item
26479 * @see elm_object_cursor_unset() for more details.
26480 * @see elm_diskselector_cursor_set()
26482 * @ingroup Diskselector
26484 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26487 * Sets a different style for this item cursor.
26489 * @note before you set a style you should define a cursor with
26490 * elm_diskselector_item_cursor_set()
26492 * @param item diskselector item with cursor already set.
26493 * @param style the theme style to use (default, transparent, ...)
26495 * @see elm_object_cursor_style_set() for more details.
26497 * @ingroup Diskselector
26499 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26503 * Get the style for this item cursor.
26505 * @param item diskselector item with cursor already set.
26506 * @return style the theme style in use, defaults to "default". If the
26507 * object does not have a cursor set, then @c NULL is returned.
26509 * @see elm_object_cursor_style_get() for more details.
26510 * @see elm_diskselector_item_cursor_style_set()
26512 * @ingroup Diskselector
26514 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26518 * Set if the cursor set should be searched on the theme or should use
26519 * the provided by the engine, only.
26521 * @note before you set if should look on theme you should define a cursor
26522 * with elm_diskselector_item_cursor_set().
26523 * By default it will only look for cursors provided by the engine.
26525 * @param item widget item with cursor already set.
26526 * @param engine_only boolean to define if cursors set with
26527 * elm_diskselector_item_cursor_set() should be searched only
26528 * between cursors provided by the engine or searched on widget's
26531 * @see elm_object_cursor_engine_only_set() for more details.
26533 * @ingroup Diskselector
26535 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26538 * Get the cursor engine only usage for this item cursor.
26540 * @param item widget item with cursor already set.
26541 * @return engine_only boolean to define it cursors should be looked only
26542 * between the provided by the engine or searched on widget's theme as well.
26543 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26545 * @see elm_object_cursor_engine_only_get() for more details.
26546 * @see elm_diskselector_item_cursor_engine_only_set()
26548 * @ingroup Diskselector
26550 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26557 * @defgroup Colorselector Colorselector
26561 * @image html img/widget/colorselector/preview-00.png
26562 * @image latex img/widget/colorselector/preview-00.eps
26564 * @brief Widget for user to select a color.
26566 * Signals that you can add callbacks for are:
26567 * "changed" - When the color value changes(event_info is NULL).
26569 * See @ref tutorial_colorselector.
26572 * @brief Add a new colorselector to the parent
26574 * @param parent The parent object
26575 * @return The new object or NULL if it cannot be created
26577 * @ingroup Colorselector
26579 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26581 * Set a color for the colorselector
26583 * @param obj Colorselector object
26584 * @param r r-value of color
26585 * @param g g-value of color
26586 * @param b b-value of color
26587 * @param a a-value of color
26589 * @ingroup Colorselector
26591 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26593 * Get a color from the colorselector
26595 * @param obj Colorselector object
26596 * @param r integer pointer for r-value of color
26597 * @param g integer pointer for g-value of color
26598 * @param b integer pointer for b-value of color
26599 * @param a integer pointer for a-value of color
26601 * @ingroup Colorselector
26603 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26609 * @defgroup Ctxpopup Ctxpopup
26611 * @image html img/widget/ctxpopup/preview-00.png
26612 * @image latex img/widget/ctxpopup/preview-00.eps
26614 * @brief Context popup widet.
26616 * A ctxpopup is a widget that, when shown, pops up a list of items.
26617 * It automatically chooses an area inside its parent object's view
26618 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26619 * optimally fit into it. In the default theme, it will also point an
26620 * arrow to it's top left position at the time one shows it. Ctxpopup
26621 * items have a label and/or an icon. It is intended for a small
26622 * number of items (hence the use of list, not genlist).
26624 * @note Ctxpopup is a especialization of @ref Hover.
26626 * Signals that you can add callbacks for are:
26627 * "dismissed" - the ctxpopup was dismissed
26629 * Default contents parts of the ctxpopup widget that you can use for are:
26630 * @li "default" - A content of the ctxpopup
26632 * Default contents parts of the naviframe items that you can use for are:
26633 * @li "icon" - A icon in the title area
26635 * Default text parts of the naviframe items that you can use for are:
26636 * @li "default" - Title label in the title area
26638 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26641 typedef enum _Elm_Ctxpopup_Direction
26643 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26645 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26646 the clicked area */
26647 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26648 the clicked area */
26649 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26651 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26652 } Elm_Ctxpopup_Direction;
26653 #define Elm_Ctxpopup_Item Elm_Object_Item
26656 * @brief Add a new Ctxpopup object to the parent.
26658 * @param parent Parent object
26659 * @return New object or @c NULL, if it cannot be created
26661 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26663 * @brief Set the Ctxpopup's parent
26665 * @param obj The ctxpopup object
26666 * @param area The parent to use
26668 * Set the parent object.
26670 * @note elm_ctxpopup_add() will automatically call this function
26671 * with its @c parent argument.
26673 * @see elm_ctxpopup_add()
26674 * @see elm_hover_parent_set()
26676 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26678 * @brief Get the Ctxpopup's parent
26680 * @param obj The ctxpopup object
26682 * @see elm_ctxpopup_hover_parent_set() for more information
26684 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26686 * @brief Clear all items in the given ctxpopup object.
26688 * @param obj Ctxpopup object
26690 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26692 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26694 * @param obj Ctxpopup object
26695 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26697 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26699 * @brief Get the value of current ctxpopup object's orientation.
26701 * @param obj Ctxpopup object
26702 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26704 * @see elm_ctxpopup_horizontal_set()
26706 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26708 * @brief Add a new item to a ctxpopup object.
26710 * @param obj Ctxpopup object
26711 * @param icon Icon to be set on new item
26712 * @param label The Label of the new item
26713 * @param func Convenience function called when item selected
26714 * @param data Data passed to @p func
26715 * @return A handle to the item added or @c NULL, on errors
26717 * @warning Ctxpopup can't hold both an item list and a content at the same
26718 * time. When an item is added, any previous content will be removed.
26720 * @see elm_ctxpopup_content_set()
26722 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);
26724 * @brief Delete the given item in a ctxpopup object.
26726 * @param it Ctxpopup item to be deleted
26728 * @see elm_ctxpopup_item_append()
26730 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26732 * @brief Set the ctxpopup item's state as disabled or enabled.
26734 * @param it Ctxpopup item to be enabled/disabled
26735 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26737 * When disabled the item is greyed out to indicate it's state.
26738 * @deprecated use elm_object_item_disabled_set() instead
26740 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26742 * @brief Get the ctxpopup item's disabled/enabled state.
26744 * @param it Ctxpopup item to be enabled/disabled
26745 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26747 * @see elm_ctxpopup_item_disabled_set()
26748 * @deprecated use elm_object_item_disabled_get() instead
26750 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26752 * @brief Get the icon object for the given ctxpopup item.
26754 * @param it Ctxpopup item
26755 * @return icon object or @c NULL, if the item does not have icon or an error
26758 * @see elm_ctxpopup_item_append()
26759 * @see elm_ctxpopup_item_icon_set()
26761 * @deprecated use elm_object_item_content_part_get() instead
26763 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26765 * @brief Sets the side icon associated with the ctxpopup item
26767 * @param it Ctxpopup item
26768 * @param icon Icon object to be set
26770 * Once the icon object is set, a previously set one will be deleted.
26771 * @warning Setting the same icon for two items will cause the icon to
26772 * dissapear from the first item.
26774 * @see elm_ctxpopup_item_append()
26776 * @deprecated use elm_object_item_content_part_set() instead
26779 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26781 * @brief Get the label for the given ctxpopup item.
26783 * @param it Ctxpopup item
26784 * @return label string or @c NULL, if the item does not have label or an
26787 * @see elm_ctxpopup_item_append()
26788 * @see elm_ctxpopup_item_label_set()
26790 * @deprecated use elm_object_item_text_get() instead
26792 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26794 * @brief (Re)set the label on the given ctxpopup item.
26796 * @param it Ctxpopup item
26797 * @param label String to set as label
26799 * @deprecated use elm_object_item_text_set() instead
26801 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26803 * @brief Set an elm widget as the content of the ctxpopup.
26805 * @param obj Ctxpopup object
26806 * @param content Content to be swallowed
26808 * If the content object is already set, a previous one will bedeleted. If
26809 * you want to keep that old content object, use the
26810 * elm_ctxpopup_content_unset() function.
26812 * @deprecated use elm_object_content_set()
26814 * @warning Ctxpopup can't hold both a item list and a content at the same
26815 * time. When a content is set, any previous items will be removed.
26817 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26819 * @brief Unset the ctxpopup content
26821 * @param obj Ctxpopup object
26822 * @return The content that was being used
26824 * Unparent and return the content object which was set for this widget.
26826 * @deprecated use elm_object_content_unset()
26828 * @see elm_ctxpopup_content_set()
26830 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26832 * @brief Set the direction priority of a ctxpopup.
26834 * @param obj Ctxpopup object
26835 * @param first 1st priority of direction
26836 * @param second 2nd priority of direction
26837 * @param third 3th priority of direction
26838 * @param fourth 4th priority of direction
26840 * This functions gives a chance to user to set the priority of ctxpopup
26841 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26842 * requested direction.
26844 * @see Elm_Ctxpopup_Direction
26846 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);
26848 * @brief Get the direction priority of a ctxpopup.
26850 * @param obj Ctxpopup object
26851 * @param first 1st priority of direction to be returned
26852 * @param second 2nd priority of direction to be returned
26853 * @param third 3th priority of direction to be returned
26854 * @param fourth 4th priority of direction to be returned
26856 * @see elm_ctxpopup_direction_priority_set() for more information.
26858 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);
26861 * @brief Get the current direction of a ctxpopup.
26863 * @param obj Ctxpopup object
26864 * @return current direction of a ctxpopup
26866 * @warning Once the ctxpopup showed up, the direction would be determined
26868 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26877 * @defgroup Transit Transit
26878 * @ingroup Elementary
26880 * Transit is designed to apply various animated transition effects to @c
26881 * Evas_Object, such like translation, rotation, etc. For using these
26882 * effects, create an @ref Elm_Transit and add the desired transition effects.
26884 * Once the effects are added into transit, they will be automatically
26885 * managed (their callback will be called until the duration is ended, and
26886 * they will be deleted on completion).
26890 * Elm_Transit *trans = elm_transit_add();
26891 * elm_transit_object_add(trans, obj);
26892 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26893 * elm_transit_duration_set(transit, 1);
26894 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26895 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26896 * elm_transit_repeat_times_set(transit, 3);
26899 * Some transition effects are used to change the properties of objects. They
26901 * @li @ref elm_transit_effect_translation_add
26902 * @li @ref elm_transit_effect_color_add
26903 * @li @ref elm_transit_effect_rotation_add
26904 * @li @ref elm_transit_effect_wipe_add
26905 * @li @ref elm_transit_effect_zoom_add
26906 * @li @ref elm_transit_effect_resizing_add
26908 * Other transition effects are used to make one object disappear and another
26909 * object appear on its old place. These effects are:
26911 * @li @ref elm_transit_effect_flip_add
26912 * @li @ref elm_transit_effect_resizable_flip_add
26913 * @li @ref elm_transit_effect_fade_add
26914 * @li @ref elm_transit_effect_blend_add
26916 * It's also possible to make a transition chain with @ref
26917 * elm_transit_chain_transit_add.
26919 * @warning We strongly recommend to use elm_transit just when edje can not do
26920 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26921 * animations can be manipulated inside the theme.
26923 * List of examples:
26924 * @li @ref transit_example_01_explained
26925 * @li @ref transit_example_02_explained
26926 * @li @ref transit_example_03_c
26927 * @li @ref transit_example_04_c
26933 * @enum Elm_Transit_Tween_Mode
26935 * The type of acceleration used in the transition.
26939 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26940 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26941 over time, then decrease again
26943 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26945 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26947 } Elm_Transit_Tween_Mode;
26950 * @enum Elm_Transit_Effect_Flip_Axis
26952 * The axis where flip effect should be applied.
26956 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26957 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26958 } Elm_Transit_Effect_Flip_Axis;
26960 * @enum Elm_Transit_Effect_Wipe_Dir
26962 * The direction where the wipe effect should occur.
26966 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26967 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26968 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26969 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26970 } Elm_Transit_Effect_Wipe_Dir;
26971 /** @enum Elm_Transit_Effect_Wipe_Type
26973 * Whether the wipe effect should show or hide the object.
26977 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26979 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26981 } Elm_Transit_Effect_Wipe_Type;
26984 * @typedef Elm_Transit
26986 * The Transit created with elm_transit_add(). This type has the information
26987 * about the objects which the transition will be applied, and the
26988 * transition effects that will be used. It also contains info about
26989 * duration, number of repetitions, auto-reverse, etc.
26991 typedef struct _Elm_Transit Elm_Transit;
26992 typedef void Elm_Transit_Effect;
26994 * @typedef Elm_Transit_Effect_Transition_Cb
26996 * Transition callback called for this effect on each transition iteration.
26998 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27000 * Elm_Transit_Effect_End_Cb
27002 * Transition callback called for this effect when the transition is over.
27004 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27007 * Elm_Transit_Del_Cb
27009 * A callback called when the transit is deleted.
27011 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27016 * @note Is not necessary to delete the transit object, it will be deleted at
27017 * the end of its operation.
27018 * @note The transit will start playing when the program enter in the main loop, is not
27019 * necessary to give a start to the transit.
27021 * @return The transit object.
27025 EAPI Elm_Transit *elm_transit_add(void);
27028 * Stops the animation and delete the @p transit object.
27030 * Call this function if you wants to stop the animation before the duration
27031 * time. Make sure the @p transit object is still alive with
27032 * elm_transit_del_cb_set() function.
27033 * All added effects will be deleted, calling its repective data_free_cb
27034 * functions. The function setted by elm_transit_del_cb_set() will be called.
27036 * @see elm_transit_del_cb_set()
27038 * @param transit The transit object to be deleted.
27041 * @warning Just call this function if you are sure the transit is alive.
27043 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27046 * Add a new effect to the transit.
27048 * @note The cb function and the data are the key to the effect. If you try to
27049 * add an already added effect, nothing is done.
27050 * @note After the first addition of an effect in @p transit, if its
27051 * effect list become empty again, the @p transit will be killed by
27052 * elm_transit_del(transit) function.
27056 * Elm_Transit *transit = elm_transit_add();
27057 * elm_transit_effect_add(transit,
27058 * elm_transit_effect_blend_op,
27059 * elm_transit_effect_blend_context_new(),
27060 * elm_transit_effect_blend_context_free);
27063 * @param transit The transit object.
27064 * @param transition_cb The operation function. It is called when the
27065 * animation begins, it is the function that actually performs the animation.
27066 * It is called with the @p data, @p transit and the time progression of the
27067 * animation (a double value between 0.0 and 1.0).
27068 * @param effect The context data of the effect.
27069 * @param end_cb The function to free the context data, it will be called
27070 * at the end of the effect, it must finalize the animation and free the
27074 * @warning The transit free the context data at the and of the transition with
27075 * the data_free_cb function, do not use the context data in another transit.
27077 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);
27080 * Delete an added effect.
27082 * This function will remove the effect from the @p transit, calling the
27083 * data_free_cb to free the @p data.
27085 * @see elm_transit_effect_add()
27087 * @note If the effect is not found, nothing is done.
27088 * @note If the effect list become empty, this function will call
27089 * elm_transit_del(transit), that is, it will kill the @p transit.
27091 * @param transit The transit object.
27092 * @param transition_cb The operation function.
27093 * @param effect The context data of the effect.
27097 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);
27100 * Add new object to apply the effects.
27102 * @note After the first addition of an object in @p transit, if its
27103 * object list become empty again, the @p transit will be killed by
27104 * elm_transit_del(transit) function.
27105 * @note If the @p obj belongs to another transit, the @p obj will be
27106 * removed from it and it will only belong to the @p transit. If the old
27107 * transit stays without objects, it will die.
27108 * @note When you add an object into the @p transit, its state from
27109 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27110 * transit ends, if you change this state whith evas_object_pass_events_set()
27111 * after add the object, this state will change again when @p transit stops to
27114 * @param transit The transit object.
27115 * @param obj Object to be animated.
27118 * @warning It is not allowed to add a new object after transit begins to go.
27120 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27123 * Removes an added object from the transit.
27125 * @note If the @p obj is not in the @p transit, nothing is done.
27126 * @note If the list become empty, this function will call
27127 * elm_transit_del(transit), that is, it will kill the @p transit.
27129 * @param transit The transit object.
27130 * @param obj Object to be removed from @p transit.
27133 * @warning It is not allowed to remove objects after transit begins to go.
27135 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27138 * Get the objects of the transit.
27140 * @param transit The transit object.
27141 * @return a Eina_List with the objects from the transit.
27145 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27148 * Enable/disable keeping up the objects states.
27149 * If it is not kept, the objects states will be reset when transition ends.
27151 * @note @p transit can not be NULL.
27152 * @note One state includes geometry, color, map data.
27154 * @param transit The transit object.
27155 * @param state_keep Keeping or Non Keeping.
27159 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27162 * Get a value whether the objects states will be reset or not.
27164 * @note @p transit can not be NULL
27166 * @see elm_transit_objects_final_state_keep_set()
27168 * @param transit The transit object.
27169 * @return EINA_TRUE means the states of the objects will be reset.
27170 * If @p transit is NULL, EINA_FALSE is returned
27174 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27177 * Set the event enabled when transit is operating.
27179 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27180 * events from mouse and keyboard during the animation.
27181 * @note When you add an object with elm_transit_object_add(), its state from
27182 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27183 * transit ends, if you change this state with evas_object_pass_events_set()
27184 * after adding the object, this state will change again when @p transit stops
27187 * @param transit The transit object.
27188 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27189 * ignored otherwise.
27193 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27196 * Get the value of event enabled status.
27198 * @see elm_transit_event_enabled_set()
27200 * @param transit The Transit object
27201 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27202 * EINA_FALSE is returned
27206 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27209 * Set the user-callback function when the transit is deleted.
27211 * @note Using this function twice will overwrite the first function setted.
27212 * @note the @p transit object will be deleted after call @p cb function.
27214 * @param transit The transit object.
27215 * @param cb Callback function pointer. This function will be called before
27216 * the deletion of the transit.
27217 * @param data Callback funtion user data. It is the @p op parameter.
27221 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27224 * Set reverse effect automatically.
27226 * If auto reverse is setted, after running the effects with the progress
27227 * parameter from 0 to 1, it will call the effecs again with the progress
27228 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27229 * where the duration was setted with the function elm_transit_add and
27230 * the repeat with the function elm_transit_repeat_times_set().
27232 * @param transit The transit object.
27233 * @param reverse EINA_TRUE means the auto_reverse is on.
27237 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27240 * Get if the auto reverse is on.
27242 * @see elm_transit_auto_reverse_set()
27244 * @param transit The transit object.
27245 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27246 * EINA_FALSE is returned
27250 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27253 * Set the transit repeat count. Effect will be repeated by repeat count.
27255 * This function sets the number of repetition the transit will run after
27256 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27257 * If the @p repeat is a negative number, it will repeat infinite times.
27259 * @note If this function is called during the transit execution, the transit
27260 * will run @p repeat times, ignoring the times it already performed.
27262 * @param transit The transit object
27263 * @param repeat Repeat count
27267 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27270 * Get the transit repeat count.
27272 * @see elm_transit_repeat_times_set()
27274 * @param transit The Transit object.
27275 * @return The repeat count. If @p transit is NULL
27280 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27283 * Set the transit animation acceleration type.
27285 * This function sets the tween mode of the transit that can be:
27286 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27287 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27288 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27289 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27291 * @param transit The transit object.
27292 * @param tween_mode The tween type.
27296 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27299 * Get the transit animation acceleration type.
27301 * @note @p transit can not be NULL
27303 * @param transit The transit object.
27304 * @return The tween type. If @p transit is NULL
27305 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27309 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27312 * Set the transit animation time
27314 * @note @p transit can not be NULL
27316 * @param transit The transit object.
27317 * @param duration The animation time.
27321 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27324 * Get the transit animation time
27326 * @note @p transit can not be NULL
27328 * @param transit The transit object.
27330 * @return The transit animation time.
27334 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27337 * Starts the transition.
27338 * Once this API is called, the transit begins to measure the time.
27340 * @note @p transit can not be NULL
27342 * @param transit The transit object.
27346 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27349 * Pause/Resume the transition.
27351 * If you call elm_transit_go again, the transit will be started from the
27352 * beginning, and will be unpaused.
27354 * @note @p transit can not be NULL
27356 * @param transit The transit object.
27357 * @param paused Whether the transition should be paused or not.
27361 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27364 * Get the value of paused status.
27366 * @see elm_transit_paused_set()
27368 * @note @p transit can not be NULL
27370 * @param transit The transit object.
27371 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27372 * EINA_FALSE is returned
27376 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27379 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27381 * The value returned is a fraction (current time / total time). It
27382 * represents the progression position relative to the total.
27384 * @note @p transit can not be NULL
27386 * @param transit The transit object.
27388 * @return The time progression value. If @p transit is NULL
27393 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27396 * Makes the chain relationship between two transits.
27398 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27399 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27401 * @param transit The transit object.
27402 * @param chain_transit The chain transit object. This transit will be operated
27403 * after transit is done.
27405 * This function adds @p chain_transit transition to a chain after the @p
27406 * transit, and will be started as soon as @p transit ends. See @ref
27407 * transit_example_02_explained for a full example.
27411 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27414 * Cut off the chain relationship between two transits.
27416 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27417 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27419 * @param transit The transit object.
27420 * @param chain_transit The chain transit object.
27422 * This function remove the @p chain_transit transition from the @p transit.
27426 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27429 * Get the current chain transit list.
27431 * @note @p transit can not be NULL.
27433 * @param transit The transit object.
27434 * @return chain transit list.
27438 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27441 * Add the Resizing Effect to Elm_Transit.
27443 * @note This API is one of the facades. It creates resizing effect context
27444 * and add it's required APIs to elm_transit_effect_add.
27446 * @see elm_transit_effect_add()
27448 * @param transit Transit object.
27449 * @param from_w Object width size when effect begins.
27450 * @param from_h Object height size when effect begins.
27451 * @param to_w Object width size when effect ends.
27452 * @param to_h Object height size when effect ends.
27453 * @return Resizing effect context data.
27457 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);
27460 * Add the Translation Effect to Elm_Transit.
27462 * @note This API is one of the facades. It creates translation effect context
27463 * and add it's required APIs to elm_transit_effect_add.
27465 * @see elm_transit_effect_add()
27467 * @param transit Transit object.
27468 * @param from_dx X Position variation when effect begins.
27469 * @param from_dy Y Position variation when effect begins.
27470 * @param to_dx X Position variation when effect ends.
27471 * @param to_dy Y Position variation when effect ends.
27472 * @return Translation effect context data.
27475 * @warning It is highly recommended just create a transit with this effect when
27476 * the window that the objects of the transit belongs has already been created.
27477 * This is because this effect needs the geometry information about the objects,
27478 * and if the window was not created yet, it can get a wrong information.
27480 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);
27483 * Add the Zoom Effect to Elm_Transit.
27485 * @note This API is one of the facades. It creates zoom effect context
27486 * and add it's required APIs to elm_transit_effect_add.
27488 * @see elm_transit_effect_add()
27490 * @param transit Transit object.
27491 * @param from_rate Scale rate when effect begins (1 is current rate).
27492 * @param to_rate Scale rate when effect ends.
27493 * @return Zoom effect context data.
27496 * @warning It is highly recommended just create a transit with this effect when
27497 * the window that the objects of the transit belongs has already been created.
27498 * This is because this effect needs the geometry information about the objects,
27499 * and if the window was not created yet, it can get a wrong information.
27501 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27504 * Add the Flip Effect to Elm_Transit.
27506 * @note This API is one of the facades. It creates flip effect context
27507 * and add it's required APIs to elm_transit_effect_add.
27508 * @note This effect is applied to each pair of objects in the order they are listed
27509 * in the transit list of objects. The first object in the pair will be the
27510 * "front" object and the second will be the "back" object.
27512 * @see elm_transit_effect_add()
27514 * @param transit Transit object.
27515 * @param axis Flipping Axis(X or Y).
27516 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27517 * @return Flip effect context data.
27520 * @warning It is highly recommended just create a transit with this effect when
27521 * the window that the objects of the transit belongs has already been created.
27522 * This is because this effect needs the geometry information about the objects,
27523 * and if the window was not created yet, it can get a wrong information.
27525 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27528 * Add the Resizable Flip Effect to Elm_Transit.
27530 * @note This API is one of the facades. It creates resizable flip effect context
27531 * and add it's required APIs to elm_transit_effect_add.
27532 * @note This effect is applied to each pair of objects in the order they are listed
27533 * in the transit list of objects. The first object in the pair will be the
27534 * "front" object and the second will be the "back" object.
27536 * @see elm_transit_effect_add()
27538 * @param transit Transit object.
27539 * @param axis Flipping Axis(X or Y).
27540 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27541 * @return Resizable flip effect context data.
27544 * @warning It is highly recommended just create a transit with this effect when
27545 * the window that the objects of the transit belongs has already been created.
27546 * This is because this effect needs the geometry information about the objects,
27547 * and if the window was not created yet, it can get a wrong information.
27549 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27552 * Add the Wipe Effect to Elm_Transit.
27554 * @note This API is one of the facades. It creates wipe effect context
27555 * and add it's required APIs to elm_transit_effect_add.
27557 * @see elm_transit_effect_add()
27559 * @param transit Transit object.
27560 * @param type Wipe type. Hide or show.
27561 * @param dir Wipe Direction.
27562 * @return Wipe effect context data.
27565 * @warning It is highly recommended just create a transit with this effect when
27566 * the window that the objects of the transit belongs has already been created.
27567 * This is because this effect needs the geometry information about the objects,
27568 * and if the window was not created yet, it can get a wrong information.
27570 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27573 * Add the Color Effect to Elm_Transit.
27575 * @note This API is one of the facades. It creates color effect context
27576 * and add it's required APIs to elm_transit_effect_add.
27578 * @see elm_transit_effect_add()
27580 * @param transit Transit object.
27581 * @param from_r RGB R when effect begins.
27582 * @param from_g RGB G when effect begins.
27583 * @param from_b RGB B when effect begins.
27584 * @param from_a RGB A when effect begins.
27585 * @param to_r RGB R when effect ends.
27586 * @param to_g RGB G when effect ends.
27587 * @param to_b RGB B when effect ends.
27588 * @param to_a RGB A when effect ends.
27589 * @return Color effect context data.
27593 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);
27596 * Add the Fade Effect to Elm_Transit.
27598 * @note This API is one of the facades. It creates fade effect context
27599 * and add it's required APIs to elm_transit_effect_add.
27600 * @note This effect is applied to each pair of objects in the order they are listed
27601 * in the transit list of objects. The first object in the pair will be the
27602 * "before" object and the second will be the "after" object.
27604 * @see elm_transit_effect_add()
27606 * @param transit Transit object.
27607 * @return Fade effect context data.
27610 * @warning It is highly recommended just create a transit with this effect when
27611 * the window that the objects of the transit belongs has already been created.
27612 * This is because this effect needs the color information about the objects,
27613 * and if the window was not created yet, it can get a wrong information.
27615 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27618 * Add the Blend Effect to Elm_Transit.
27620 * @note This API is one of the facades. It creates blend effect context
27621 * and add it's required APIs to elm_transit_effect_add.
27622 * @note This effect is applied to each pair of objects in the order they are listed
27623 * in the transit list of objects. The first object in the pair will be the
27624 * "before" object and the second will be the "after" object.
27626 * @see elm_transit_effect_add()
27628 * @param transit Transit object.
27629 * @return Blend effect context data.
27632 * @warning It is highly recommended just create a transit with this effect when
27633 * the window that the objects of the transit belongs has already been created.
27634 * This is because this effect needs the color information about the objects,
27635 * and if the window was not created yet, it can get a wrong information.
27637 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27640 * Add the Rotation Effect to Elm_Transit.
27642 * @note This API is one of the facades. It creates rotation effect context
27643 * and add it's required APIs to elm_transit_effect_add.
27645 * @see elm_transit_effect_add()
27647 * @param transit Transit object.
27648 * @param from_degree Degree when effect begins.
27649 * @param to_degree Degree when effect is ends.
27650 * @return Rotation effect context data.
27653 * @warning It is highly recommended just create a transit with this effect when
27654 * the window that the objects of the transit belongs has already been created.
27655 * This is because this effect needs the geometry information about the objects,
27656 * and if the window was not created yet, it can get a wrong information.
27658 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27661 * Add the ImageAnimation Effect to Elm_Transit.
27663 * @note This API is one of the facades. It creates image animation effect context
27664 * and add it's required APIs to elm_transit_effect_add.
27665 * The @p images parameter is a list images paths. This list and
27666 * its contents will be deleted at the end of the effect by
27667 * elm_transit_effect_image_animation_context_free() function.
27671 * char buf[PATH_MAX];
27672 * Eina_List *images = NULL;
27673 * Elm_Transit *transi = elm_transit_add();
27675 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27676 * images = eina_list_append(images, eina_stringshare_add(buf));
27678 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27679 * images = eina_list_append(images, eina_stringshare_add(buf));
27680 * elm_transit_effect_image_animation_add(transi, images);
27684 * @see elm_transit_effect_add()
27686 * @param transit Transit object.
27687 * @param images Eina_List of images file paths. This list and
27688 * its contents will be deleted at the end of the effect by
27689 * elm_transit_effect_image_animation_context_free() function.
27690 * @return Image Animation effect context data.
27694 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27700 typedef struct _Elm_Store Elm_Store;
27701 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27702 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27703 typedef struct _Elm_Store_Item Elm_Store_Item;
27704 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27705 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27706 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27707 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27708 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27709 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27710 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27711 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27712 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27714 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27715 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27716 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27717 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27718 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27719 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27720 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27724 ELM_STORE_ITEM_MAPPING_NONE = 0,
27725 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27726 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27727 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27728 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27729 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27730 // can add more here as needed by common apps
27731 ELM_STORE_ITEM_MAPPING_LAST
27732 } Elm_Store_Item_Mapping_Type;
27734 struct _Elm_Store_Item_Mapping_Icon
27736 // FIXME: allow edje file icons
27738 Elm_Icon_Lookup_Order lookup_order;
27739 Eina_Bool standard_name : 1;
27740 Eina_Bool no_scale : 1;
27741 Eina_Bool smooth : 1;
27742 Eina_Bool scale_up : 1;
27743 Eina_Bool scale_down : 1;
27746 struct _Elm_Store_Item_Mapping_Empty
27751 struct _Elm_Store_Item_Mapping_Photo
27756 struct _Elm_Store_Item_Mapping_Custom
27758 Elm_Store_Item_Mapping_Cb func;
27761 struct _Elm_Store_Item_Mapping
27763 Elm_Store_Item_Mapping_Type type;
27768 Elm_Store_Item_Mapping_Empty empty;
27769 Elm_Store_Item_Mapping_Icon icon;
27770 Elm_Store_Item_Mapping_Photo photo;
27771 Elm_Store_Item_Mapping_Custom custom;
27772 // add more types here
27776 struct _Elm_Store_Item_Info
27781 Eina_Bool rec_item;
27782 int pre_group_index;
27784 Elm_Genlist_Item_Class *item_class;
27785 const Elm_Store_Item_Mapping *mapping;
27790 struct _Elm_Store_Item_Info_Filesystem
27792 Elm_Store_Item_Info base;
27796 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27797 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27799 EAPI Elm_Store *elm_store_dbsystem_new(void);
27800 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27801 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27802 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27803 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27804 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27805 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27806 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27807 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27808 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27809 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27810 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27811 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27812 EAPI void elm_store_free(Elm_Store *st);
27813 EAPI Elm_Store *elm_store_filesystem_new(void);
27814 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27815 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27816 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27818 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27820 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27821 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27822 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27823 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27824 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27825 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27827 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27828 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27829 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27830 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27831 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27832 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27833 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27836 * @defgroup SegmentControl SegmentControl
27837 * @ingroup Elementary
27839 * @image html img/widget/segment_control/preview-00.png
27840 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27842 * @image html img/segment_control.png
27843 * @image latex img/segment_control.eps width=\textwidth
27845 * Segment control widget is a horizontal control made of multiple segment
27846 * items, each segment item functioning similar to discrete two state button.
27847 * A segment control groups the items together and provides compact
27848 * single button with multiple equal size segments.
27850 * Segment item size is determined by base widget
27851 * size and the number of items added.
27852 * Only one segment item can be at selected state. A segment item can display
27853 * combination of Text and any Evas_Object like Images or other widget.
27855 * Smart callbacks one can listen to:
27856 * - "changed" - When the user clicks on a segment item which is not
27857 * previously selected and get selected. The event_info parameter is the
27858 * segment item pointer.
27860 * Available styles for it:
27863 * Here is an example on its usage:
27864 * @li @ref segment_control_example
27868 * @addtogroup SegmentControl
27872 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27875 * Add a new segment control widget to the given parent Elementary
27876 * (container) object.
27878 * @param parent The parent object.
27879 * @return a new segment control widget handle or @c NULL, on errors.
27881 * This function inserts a new segment control widget on the canvas.
27883 * @ingroup SegmentControl
27885 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27888 * Append a new item to the segment control object.
27890 * @param obj The segment control object.
27891 * @param icon The icon object to use for the left side of the item. An
27892 * icon can be any Evas object, but usually it is an icon created
27893 * with elm_icon_add().
27894 * @param label The label of the item.
27895 * Note that, NULL is different from empty string "".
27896 * @return The created item or @c NULL upon failure.
27898 * A new item will be created and appended to the segment control, i.e., will
27899 * be set as @b last item.
27901 * If it should be inserted at another position,
27902 * elm_segment_control_item_insert_at() should be used instead.
27904 * Items created with this function can be deleted with function
27905 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27907 * @note @p label set to @c NULL is different from empty string "".
27909 * only has icon, it will be displayed bigger and centered. If it has
27910 * icon and label, even that an empty string, icon will be smaller and
27911 * positioned at left.
27915 * sc = elm_segment_control_add(win);
27916 * ic = elm_icon_add(win);
27917 * elm_icon_file_set(ic, "path/to/image", NULL);
27918 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27919 * elm_segment_control_item_add(sc, ic, "label");
27920 * evas_object_show(sc);
27923 * @see elm_segment_control_item_insert_at()
27924 * @see elm_segment_control_item_del()
27926 * @ingroup SegmentControl
27928 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27931 * Insert a new item to the segment control object at specified position.
27933 * @param obj The segment control object.
27934 * @param icon The icon object to use for the left side of the item. An
27935 * icon can be any Evas object, but usually it is an icon created
27936 * with elm_icon_add().
27937 * @param label The label of the item.
27938 * @param index Item position. Value should be between 0 and items count.
27939 * @return The created item or @c NULL upon failure.
27941 * Index values must be between @c 0, when item will be prepended to
27942 * segment control, and items count, that can be get with
27943 * elm_segment_control_item_count_get(), case when item will be appended
27944 * to segment control, just like elm_segment_control_item_add().
27946 * Items created with this function can be deleted with function
27947 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27949 * @note @p label set to @c NULL is different from empty string "".
27951 * only has icon, it will be displayed bigger and centered. If it has
27952 * icon and label, even that an empty string, icon will be smaller and
27953 * positioned at left.
27955 * @see elm_segment_control_item_add()
27956 * @see elm_segment_control_item_count_get()
27957 * @see elm_segment_control_item_del()
27959 * @ingroup SegmentControl
27961 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);
27964 * Remove a segment control item from its parent, deleting it.
27966 * @param it The item to be removed.
27968 * Items can be added with elm_segment_control_item_add() or
27969 * elm_segment_control_item_insert_at().
27971 * @ingroup SegmentControl
27973 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27976 * Remove a segment control item at given index from its parent,
27979 * @param obj The segment control object.
27980 * @param index The position of the segment control item to be deleted.
27982 * Items can be added with elm_segment_control_item_add() or
27983 * elm_segment_control_item_insert_at().
27985 * @ingroup SegmentControl
27987 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27990 * Get the Segment items count from segment control.
27992 * @param obj The segment control object.
27993 * @return Segment items count.
27995 * It will just return the number of items added to segment control @p obj.
27997 * @ingroup SegmentControl
27999 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28002 * Get the item placed at specified index.
28004 * @param obj The segment control object.
28005 * @param index The index of the segment item.
28006 * @return The segment control item or @c NULL on failure.
28008 * Index is the position of an item in segment control widget. Its
28009 * range is from @c 0 to <tt> count - 1 </tt>.
28010 * Count is the number of items, that can be get with
28011 * elm_segment_control_item_count_get().
28013 * @ingroup SegmentControl
28015 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28018 * Get the label of item.
28020 * @param obj The segment control object.
28021 * @param index The index of the segment item.
28022 * @return The label of the item at @p index.
28024 * The return value is a pointer to the label associated to the item when
28025 * it was created, with function elm_segment_control_item_add(), or later
28026 * with function elm_segment_control_item_label_set. If no label
28027 * was passed as argument, it will return @c NULL.
28029 * @see elm_segment_control_item_label_set() for more details.
28030 * @see elm_segment_control_item_add()
28032 * @ingroup SegmentControl
28034 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28037 * Set the label of item.
28039 * @param it The item of segment control.
28040 * @param text The label of item.
28042 * The label to be displayed by the item.
28043 * Label will be at right of the icon (if set).
28045 * If a label was passed as argument on item creation, with function
28046 * elm_control_segment_item_add(), it will be already
28047 * displayed by the item.
28049 * @see elm_segment_control_item_label_get()
28050 * @see elm_segment_control_item_add()
28052 * @ingroup SegmentControl
28054 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28057 * Get the icon associated to the item.
28059 * @param obj The segment control object.
28060 * @param index The index of the segment item.
28061 * @return The left side icon associated to the item at @p index.
28063 * The return value is a pointer to the icon associated to the item when
28064 * it was created, with function elm_segment_control_item_add(), or later
28065 * with function elm_segment_control_item_icon_set(). If no icon
28066 * was passed as argument, it will return @c NULL.
28068 * @see elm_segment_control_item_add()
28069 * @see elm_segment_control_item_icon_set()
28071 * @ingroup SegmentControl
28073 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28076 * Set the icon associated to the item.
28078 * @param it The segment control item.
28079 * @param icon The icon object to associate with @p it.
28081 * The icon object to use at left side of the item. An
28082 * icon can be any Evas object, but usually it is an icon created
28083 * with elm_icon_add().
28085 * Once the icon object is set, a previously set one will be deleted.
28086 * @warning Setting the same icon for two items will cause the icon to
28087 * dissapear from the first item.
28089 * If an icon was passed as argument on item creation, with function
28090 * elm_segment_control_item_add(), it will be already
28091 * associated to the item.
28093 * @see elm_segment_control_item_add()
28094 * @see elm_segment_control_item_icon_get()
28096 * @ingroup SegmentControl
28098 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28101 * Get the index of an item.
28103 * @param it The segment control item.
28104 * @return The position of item in segment control widget.
28106 * Index is the position of an item in segment control widget. Its
28107 * range is from @c 0 to <tt> count - 1 </tt>.
28108 * Count is the number of items, that can be get with
28109 * elm_segment_control_item_count_get().
28111 * @ingroup SegmentControl
28113 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28116 * Get the base object of the item.
28118 * @param it The segment control item.
28119 * @return The base object associated with @p it.
28121 * Base object is the @c Evas_Object that represents that item.
28123 * @ingroup SegmentControl
28125 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28128 * Get the selected item.
28130 * @param obj The segment control object.
28131 * @return The selected item or @c NULL if none of segment items is
28134 * The selected item can be unselected with function
28135 * elm_segment_control_item_selected_set().
28137 * The selected item always will be highlighted on segment control.
28139 * @ingroup SegmentControl
28141 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28144 * Set the selected state of an item.
28146 * @param it The segment control item
28147 * @param select The selected state
28149 * This sets the selected state of the given item @p it.
28150 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28152 * If a new item is selected the previosly selected will be unselected.
28153 * Previoulsy selected item can be get with function
28154 * elm_segment_control_item_selected_get().
28156 * The selected item always will be highlighted on segment control.
28158 * @see elm_segment_control_item_selected_get()
28160 * @ingroup SegmentControl
28162 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28169 * @defgroup Grid Grid
28171 * The grid is a grid layout widget that lays out a series of children as a
28172 * fixed "grid" of widgets using a given percentage of the grid width and
28173 * height each using the child object.
28175 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28176 * widgets size itself. The default is 100 x 100, so that means the
28177 * position and sizes of children will effectively be percentages (0 to 100)
28178 * of the width or height of the grid widget
28184 * Add a new grid to the parent
28186 * @param parent The parent object
28187 * @return The new object or NULL if it cannot be created
28191 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28194 * Set the virtual size of the grid
28196 * @param obj The grid object
28197 * @param w The virtual width of the grid
28198 * @param h The virtual height of the grid
28202 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28205 * Get the virtual size of the grid
28207 * @param obj The grid object
28208 * @param w Pointer to integer to store the virtual width of the grid
28209 * @param h Pointer to integer to store the virtual height of the grid
28213 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28216 * Pack child at given position and size
28218 * @param obj The grid object
28219 * @param subobj The child to pack
28220 * @param x The virtual x coord at which to pack it
28221 * @param y The virtual y coord at which to pack it
28222 * @param w The virtual width at which to pack it
28223 * @param h The virtual height at which to pack it
28227 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28230 * Unpack a child from a grid object
28232 * @param obj The grid object
28233 * @param subobj The child to unpack
28237 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28240 * Faster way to remove all child objects from a grid object.
28242 * @param obj The grid object
28243 * @param clear If true, it will delete just removed children
28247 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28250 * Set packing of an existing child at to position and size
28252 * @param subobj The child to set packing of
28253 * @param x The virtual x coord at which to pack it
28254 * @param y The virtual y coord at which to pack it
28255 * @param w The virtual width at which to pack it
28256 * @param h The virtual height at which to pack it
28260 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28263 * get packing of a child
28265 * @param subobj The child to query
28266 * @param x Pointer to integer to store the virtual x coord
28267 * @param y Pointer to integer to store the virtual y coord
28268 * @param w Pointer to integer to store the virtual width
28269 * @param h Pointer to integer to store the virtual height
28273 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28279 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28280 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28281 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28282 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28283 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28284 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28287 * @defgroup Video Video
28289 * @addtogroup Video
28292 * Elementary comes with two object that help design application that need
28293 * to display video. The main one, Elm_Video, display a video by using Emotion.
28294 * It does embedded the video inside an Edje object, so you can do some
28295 * animation depending on the video state change. It does also implement a
28296 * ressource management policy to remove this burden from the application writer.
28298 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28299 * It take care of updating its content according to Emotion event and provide a
28300 * way to theme itself. It also does automatically raise the priority of the
28301 * linked Elm_Video so it will use the video decoder if available. It also does
28302 * activate the remember function on the linked Elm_Video object.
28304 * Signals that you can add callback for are :
28306 * "forward,clicked" - the user clicked the forward button.
28307 * "info,clicked" - the user clicked the info button.
28308 * "next,clicked" - the user clicked the next button.
28309 * "pause,clicked" - the user clicked the pause button.
28310 * "play,clicked" - the user clicked the play button.
28311 * "prev,clicked" - the user clicked the prev button.
28312 * "rewind,clicked" - the user clicked the rewind button.
28313 * "stop,clicked" - the user clicked the stop button.
28315 * Default contents parts of the player widget that you can use for are:
28316 * @li "video" - A video of the player
28321 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28323 * @param parent The parent object
28324 * @return a new player widget handle or @c NULL, on errors.
28326 * This function inserts a new player widget on the canvas.
28328 * @see elm_object_part_content_set()
28332 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28335 * @brief Link a Elm_Payer with an Elm_Video object.
28337 * @param player the Elm_Player object.
28338 * @param video The Elm_Video object.
28340 * This mean that action on the player widget will affect the
28341 * video object and the state of the video will be reflected in
28342 * the player itself.
28344 * @see elm_player_add()
28345 * @see elm_video_add()
28346 * @deprecated use elm_object_part_content_set() instead
28350 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28353 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28355 * @param parent The parent object
28356 * @return a new video widget handle or @c NULL, on errors.
28358 * This function inserts a new video widget on the canvas.
28360 * @seeelm_video_file_set()
28361 * @see elm_video_uri_set()
28365 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28368 * @brief Define the file that will be the video source.
28370 * @param video The video object to define the file for.
28371 * @param filename The file to target.
28373 * This function will explicitly define a filename as a source
28374 * for the video of the Elm_Video object.
28376 * @see elm_video_uri_set()
28377 * @see elm_video_add()
28378 * @see elm_player_add()
28382 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28385 * @brief Define the uri that will be the video source.
28387 * @param video The video object to define the file for.
28388 * @param uri The uri to target.
28390 * This function will define an uri as a source for the video of the
28391 * Elm_Video object. URI could be remote source of video, like http:// or local source
28392 * like for example WebCam who are most of the time v4l2:// (but that depend and
28393 * you should use Emotion API to request and list the available Webcam on your system).
28395 * @see elm_video_file_set()
28396 * @see elm_video_add()
28397 * @see elm_player_add()
28401 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28404 * @brief Get the underlying Emotion object.
28406 * @param video The video object to proceed the request on.
28407 * @return the underlying Emotion object.
28411 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28414 * @brief Start to play the video
28416 * @param video The video object to proceed the request on.
28418 * Start to play the video and cancel all suspend state.
28422 EAPI void elm_video_play(Evas_Object *video);
28425 * @brief Pause the video
28427 * @param video The video object to proceed the request on.
28429 * Pause the video and start a timer to trigger suspend mode.
28433 EAPI void elm_video_pause(Evas_Object *video);
28436 * @brief Stop the video
28438 * @param video The video object to proceed the request on.
28440 * Stop the video and put the emotion in deep sleep mode.
28444 EAPI void elm_video_stop(Evas_Object *video);
28447 * @brief Is the video actually playing.
28449 * @param video The video object to proceed the request on.
28450 * @return EINA_TRUE if the video is actually playing.
28452 * You should consider watching event on the object instead of polling
28453 * the object state.
28457 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28460 * @brief Is it possible to seek inside the video.
28462 * @param video The video object to proceed the request on.
28463 * @return EINA_TRUE if is possible to seek inside the video.
28467 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28470 * @brief Is the audio muted.
28472 * @param video The video object to proceed the request on.
28473 * @return EINA_TRUE if the audio is muted.
28477 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28480 * @brief Change the mute state of the Elm_Video object.
28482 * @param video The video object to proceed the request on.
28483 * @param mute The new mute state.
28487 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28490 * @brief Get the audio level of the current video.
28492 * @param video The video object to proceed the request on.
28493 * @return the current audio level.
28497 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28500 * @brief Set the audio level of anElm_Video object.
28502 * @param video The video object to proceed the request on.
28503 * @param volume The new audio volume.
28507 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28509 EAPI double elm_video_play_position_get(const Evas_Object *video);
28510 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28511 EAPI double elm_video_play_length_get(const Evas_Object *video);
28512 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28513 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28514 EAPI const char *elm_video_title_get(const Evas_Object *video);
28519 // FIXME: incomplete - carousel. don't use this until this comment is removed
28520 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28521 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28522 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28523 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28524 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28525 /* smart callbacks called:
28526 * "clicked" - when the user clicks on a carousel item and becomes selected
28531 typedef enum _Elm_Datefield_ItemType
28533 ELM_DATEFIELD_YEAR = 0,
28534 ELM_DATEFIELD_MONTH,
28535 ELM_DATEFIELD_DATE,
28536 ELM_DATEFIELD_HOUR,
28537 ELM_DATEFIELD_MINUTE,
28539 } Elm_Datefield_ItemType;
28541 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28542 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28543 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28544 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28545 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28546 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28547 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28548 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28549 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28550 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28551 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28552 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28553 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28555 /* smart callbacks called:
28556 * "changed" - when datefield value is changed, this signal is sent.
28559 ////////////////////// DEPRECATED ///////////////////////////////////
28561 typedef enum _Elm_Datefield_Layout
28563 ELM_DATEFIELD_LAYOUT_TIME,
28564 ELM_DATEFIELD_LAYOUT_DATE,
28565 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28566 } Elm_Datefield_Layout;
28568 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28569 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28570 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28571 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28572 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28573 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28574 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28575 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28576 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28577 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28578 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28579 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28580 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);
28581 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28582 /////////////////////////////////////////////////////////////////////
28585 typedef enum _Elm_Popup_Response
28587 ELM_POPUP_RESPONSE_NONE = -1,
28588 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28589 ELM_POPUP_RESPONSE_OK = -3,
28590 ELM_POPUP_RESPONSE_CANCEL = -4,
28591 ELM_POPUP_RESPONSE_CLOSE = -5
28592 } Elm_Popup_Response;
28594 typedef enum _Elm_Popup_Mode
28596 ELM_POPUP_TYPE_NONE = 0,
28597 ELM_POPUP_TYPE_ALERT = (1 << 0)
28600 typedef enum _Elm_Popup_Orient
28602 ELM_POPUP_ORIENT_TOP,
28603 ELM_POPUP_ORIENT_CENTER,
28604 ELM_POPUP_ORIENT_BOTTOM,
28605 ELM_POPUP_ORIENT_LEFT,
28606 ELM_POPUP_ORIENT_RIGHT,
28607 ELM_POPUP_ORIENT_TOP_LEFT,
28608 ELM_POPUP_ORIENT_TOP_RIGHT,
28609 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28610 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28611 } Elm_Popup_Orient;
28613 /* smart callbacks called:
28614 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28617 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28618 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28619 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28620 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28621 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28622 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28623 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28624 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28625 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28626 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28627 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, ... );
28628 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28629 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28630 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28631 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28632 EAPI int elm_popup_run(Evas_Object *obj);
28634 /* NavigationBar */
28635 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28636 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28640 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28641 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28642 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28643 ELM_NAVIGATIONBAR_BACK_BUTTON
28644 } Elm_Navi_Button_Type;
28646 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28647 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);
28648 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28649 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28650 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28651 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28652 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28653 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28654 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28655 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28656 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28657 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28658 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28659 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28660 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28661 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28662 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28663 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28664 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28665 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28666 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28667 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28669 /* NavigationBar */
28670 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28671 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28675 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28676 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28677 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28678 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28679 ELM_NAVIGATIONBAR_EX_MAX
28680 } Elm_Navi_ex_Button_Type;
28681 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28683 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28684 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28685 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28686 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28687 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28688 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28689 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28690 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28691 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28692 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);
28693 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28694 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28695 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28696 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28697 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28698 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28699 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28700 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28701 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28702 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28703 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28704 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28705 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28706 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28707 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28708 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28709 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28710 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28713 * @defgroup Naviframe Naviframe
28714 * @ingroup Elementary
28716 * @brief Naviframe is a kind of view manager for the applications.
28718 * Naviframe provides functions to switch different pages with stack
28719 * mechanism. It means if one page(item) needs to be changed to the new one,
28720 * then naviframe would push the new page to it's internal stack. Of course,
28721 * it can be back to the previous page by popping the top page. Naviframe
28722 * provides some transition effect while the pages are switching (same as
28725 * Since each item could keep the different styles, users could keep the
28726 * same look & feel for the pages or different styles for the items in it's
28729 * Signals that you can add callback for are:
28730 * @li "transition,finished" - When the transition is finished in changing
28732 * @li "title,clicked" - User clicked title area
28734 * Default contents parts of the naviframe items that you can use for are:
28735 * @li "default" - A main content of the page
28736 * @li "icon" - A icon in the title area
28737 * @li "prev_btn" - A button to go to the previous page
28738 * @li "next_btn" - A button to go to the next page
28740 * Default text parts of the naviframe items that you can use for are:
28741 * @li "default" - Title label in the title area
28742 * @li "subtitle" - Sub-title label in the title area
28744 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28747 //Available commonly
28748 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28749 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28750 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28751 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28752 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28753 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28754 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28755 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28756 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28757 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28758 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28759 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28760 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28761 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28762 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28763 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28764 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28766 //Available only in a style - "2line"
28767 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28769 //Available only in a style - "segment"
28770 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28771 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28774 * @addtogroup Naviframe
28779 * @brief Add a new Naviframe object to the parent.
28781 * @param parent Parent object
28782 * @return New object or @c NULL, if it cannot be created
28784 * @ingroup Naviframe
28786 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28788 * @brief Push a new item to the top of the naviframe stack (and show it).
28790 * @param obj The naviframe object
28791 * @param title_label The label in the title area. The name of the title
28792 * label part is "elm.text.title"
28793 * @param prev_btn The button to go to the previous item. If it is NULL,
28794 * then naviframe will create a back button automatically. The name of
28795 * the prev_btn part is "elm.swallow.prev_btn"
28796 * @param next_btn The button to go to the next item. Or It could be just an
28797 * extra function button. The name of the next_btn part is
28798 * "elm.swallow.next_btn"
28799 * @param content The main content object. The name of content part is
28800 * "elm.swallow.content"
28801 * @param item_style The current item style name. @c NULL would be default.
28802 * @return The created item or @c NULL upon failure.
28804 * The item pushed becomes one page of the naviframe, this item will be
28805 * deleted when it is popped.
28807 * @see also elm_naviframe_item_style_set()
28808 * @see also elm_naviframe_item_insert_before()
28809 * @see also elm_naviframe_item_insert_after()
28811 * The following styles are available for this item:
28814 * @ingroup Naviframe
28816 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);
28818 * @brief Insert a new item into the naviframe before item @p before.
28820 * @param before The naviframe item to insert before.
28821 * @param title_label The label in the title area. The name of the title
28822 * label part is "elm.text.title"
28823 * @param prev_btn The button to go to the previous item. If it is NULL,
28824 * then naviframe will create a back button automatically. The name of
28825 * the prev_btn part is "elm.swallow.prev_btn"
28826 * @param next_btn The button to go to the next item. Or It could be just an
28827 * extra function button. The name of the next_btn part is
28828 * "elm.swallow.next_btn"
28829 * @param content The main content object. The name of content part is
28830 * "elm.swallow.content"
28831 * @param item_style The current item style name. @c NULL would be default.
28832 * @return The created item or @c NULL upon failure.
28834 * The item is inserted into the naviframe straight away without any
28835 * transition operations. This item will be deleted when it is popped.
28837 * @see also elm_naviframe_item_style_set()
28838 * @see also elm_naviframe_item_push()
28839 * @see also elm_naviframe_item_insert_after()
28841 * The following styles are available for this item:
28844 * @ingroup Naviframe
28846 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);
28848 * @brief Insert a new item into the naviframe after item @p after.
28850 * @param after The naviframe item to insert after.
28851 * @param title_label The label in the title area. The name of the title
28852 * label part is "elm.text.title"
28853 * @param prev_btn The button to go to the previous item. If it is NULL,
28854 * then naviframe will create a back button automatically. The name of
28855 * the prev_btn part is "elm.swallow.prev_btn"
28856 * @param next_btn The button to go to the next item. Or It could be just an
28857 * extra function button. The name of the next_btn part is
28858 * "elm.swallow.next_btn"
28859 * @param content The main content object. The name of content part is
28860 * "elm.swallow.content"
28861 * @param item_style The current item style name. @c NULL would be default.
28862 * @return The created item or @c NULL upon failure.
28864 * The item is inserted into the naviframe straight away without any
28865 * transition operations. This item will be deleted when it is popped.
28867 * @see also elm_naviframe_item_style_set()
28868 * @see also elm_naviframe_item_push()
28869 * @see also elm_naviframe_item_insert_before()
28871 * The following styles are available for this item:
28874 * @ingroup Naviframe
28876 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);
28878 * @brief Pop an item that is on top of the stack
28880 * @param obj The naviframe object
28881 * @return @c NULL or the content object(if the
28882 * elm_naviframe_content_preserve_on_pop_get is true).
28884 * This pops an item that is on the top(visible) of the naviframe, makes it
28885 * disappear, then deletes the item. The item that was underneath it on the
28886 * stack will become visible.
28888 * @see also elm_naviframe_content_preserve_on_pop_get()
28890 * @ingroup Naviframe
28892 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28894 * @brief Pop the items between the top and the above one on the given item.
28896 * @param it The naviframe item
28898 * @ingroup Naviframe
28900 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28902 * Promote an item already in the naviframe stack to the top of the stack
28904 * @param it The naviframe item
28906 * This will take the indicated item and promote it to the top of the stack
28907 * as if it had been pushed there. The item must already be inside the
28908 * naviframe stack to work.
28911 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28913 * @brief Delete the given item instantly.
28915 * @param it The naviframe item
28917 * This just deletes the given item from the naviframe item list instantly.
28918 * So this would not emit any signals for view transitions but just change
28919 * the current view if the given item is a top one.
28921 * @ingroup Naviframe
28923 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28925 * @brief preserve the content objects when items are popped.
28927 * @param obj The naviframe object
28928 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28930 * @see also elm_naviframe_content_preserve_on_pop_get()
28932 * @ingroup Naviframe
28934 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28936 * @brief Get a value whether preserve mode is enabled or not.
28938 * @param obj The naviframe object
28939 * @return If @c EINA_TRUE, preserve mode is enabled
28941 * @see also elm_naviframe_content_preserve_on_pop_set()
28943 * @ingroup Naviframe
28945 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28947 * @brief Get a top item on the naviframe stack
28949 * @param obj The naviframe object
28950 * @return The top item on the naviframe stack or @c NULL, if the stack is
28953 * @ingroup Naviframe
28955 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28957 * @brief Get a bottom item on the naviframe stack
28959 * @param obj The naviframe object
28960 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28963 * @ingroup Naviframe
28965 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28967 * @brief Set an item style
28969 * @param obj The naviframe item
28970 * @param item_style The current item style name. @c NULL would be default
28972 * The following styles are available for this item:
28975 * @see also elm_naviframe_item_style_get()
28977 * @ingroup Naviframe
28979 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28981 * @brief Get an item style
28983 * @param obj The naviframe item
28984 * @return The current item style name
28986 * @see also elm_naviframe_item_style_set()
28988 * @ingroup Naviframe
28990 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28992 * @brief Show/Hide the title area
28994 * @param it The naviframe item
28995 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28998 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
29000 * @see also elm_naviframe_item_title_visible_get()
29002 * @ingroup Naviframe
29004 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29006 * @brief Get a value whether title area is visible or not.
29008 * @param it The naviframe item
29009 * @return If @c EINA_TRUE, title area is visible
29011 * @see also elm_naviframe_item_title_visible_set()
29013 * @ingroup Naviframe
29015 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29018 * @brief Set creating prev button automatically or not
29020 * @param obj The naviframe object
29021 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29022 * be created internally when you pass the @c NULL to the prev_btn
29023 * parameter in elm_naviframe_item_push
29025 * @see also elm_naviframe_item_push()
29027 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29029 * @brief Get a value whether prev button(back button) will be auto pushed or
29032 * @param obj The naviframe object
29033 * @return If @c EINA_TRUE, prev button will be auto pushed.
29035 * @see also elm_naviframe_item_push()
29036 * elm_naviframe_prev_btn_auto_pushed_set()
29038 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29040 * @brief Get a list of all the naviframe items.
29042 * @param obj The naviframe object
29043 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29044 * or @c NULL on failure.
29046 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29053 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29054 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29055 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29056 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29057 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29058 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29059 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29060 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29061 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29063 typedef enum _Elm_Controlbar_Mode_Type
29065 ELM_CONTROLBAR_MODE_DEFAULT = 0,
29066 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29067 ELM_CONTROLBAR_MODE_TRANSPARENCY,
29068 ELM_CONTROLBAR_MODE_LARGE,
29069 ELM_CONTROLBAR_MODE_SMALL,
29070 ELM_CONTROLBAR_MODE_LEFT,
29071 ELM_CONTROLBAR_MODE_RIGHT
29072 } Elm_Controlbar_Mode_Type;
29074 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29075 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29076 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29077 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29078 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);
29079 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);
29080 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);
29081 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);
29082 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);
29083 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);
29084 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29085 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29086 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29087 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29088 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29089 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
29090 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
29091 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29092 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29093 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29094 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29095 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29096 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29097 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29098 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29099 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29100 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29101 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29102 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
29103 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29104 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29105 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29106 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29107 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29108 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29109 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
29110 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29111 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29112 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29115 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29116 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29117 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
29118 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29119 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29120 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29121 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29122 EAPI void elm_searchbar_clear(Evas_Object *obj);
29123 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29125 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29126 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29127 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29128 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29131 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29132 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
29133 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
29134 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29135 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29140 ELM_TICKERNOTI_ORIENT_TOP = 0,
29141 ELM_TICKERNOTI_ORIENT_BOTTOM,
29142 ELM_TICKERNOTI_ORIENT_LAST
29143 } Elm_Tickernoti_Orient;
29145 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
29146 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29147 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29148 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29149 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29150 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29151 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29154 ELM_TICKERNOTI_DEFAULT,
29155 ELM_TICKERNOTI_DETAILVIEW
29156 } Elm_Tickernoti_Mode;
29157 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29158 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29159 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29160 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29161 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29162 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29163 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29164 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29165 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29166 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29167 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29168 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29169 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29170 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29171 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29172 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29173 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29174 /* ############################################################################### */
29176 * Parts which can be used with elm_object_text_part_set() and
29177 * elm_object_text_part_get():
29179 * @li NULL/"default" - Operates on tickernoti content-text
29181 * Parts which can be used with elm_object_content_part_set(),
29182 * elm_object_content_part_get() and elm_object_content_part_unset():
29184 * @li "icon" - Operates on tickernoti's icon
29185 * @li "button" - Operates on tickernoti's button
29187 * smart callbacks called:
29188 * @li "clicked" - emitted when tickernoti is clicked, except at the
29189 * swallow/button region, if any.
29190 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29191 * any hide animation, this signal is emitted after the animation.
29195 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29197 struct _Colorpalette_Color
29199 unsigned int r, g, b;
29202 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29203 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29204 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29205 /* smart callbacks called:
29206 * "clicked" - when image clicked
29210 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29211 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29212 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29213 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29214 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29215 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29216 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29217 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29218 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29219 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29220 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29221 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29222 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29223 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29224 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29225 /* smart callbacks called:
29226 * "clicked" - when an editfield is clicked
29227 * "unfocused" - when an editfield is unfocused
29231 /* Sliding Drawer */
29232 typedef enum _Elm_SlidingDrawer_Pos
29234 ELM_SLIDINGDRAWER_BOTTOM,
29235 ELM_SLIDINGDRAWER_LEFT,
29236 ELM_SLIDINGDRAWER_RIGHT,
29237 ELM_SLIDINGDRAWER_TOP
29238 } Elm_SlidingDrawer_Pos;
29240 typedef struct _Elm_SlidingDrawer_Drag_Value
29243 } Elm_SlidingDrawer_Drag_Value;
29245 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29246 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29247 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29248 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29249 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
29250 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29252 /* multibuttonentry */
29253 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29254 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29255 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29256 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
29257 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29258 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29259 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29260 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29261 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29262 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29263 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29264 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29265 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29266 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29267 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
29268 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29269 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29270 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29271 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29272 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29273 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29274 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29275 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29276 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29277 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29278 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29279 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29280 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29281 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29282 /* smart callback called:
29283 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29284 * "added" - This signal is emitted when a new multibuttonentry item is added.
29285 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29286 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29287 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29288 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29289 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29290 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29291 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29292 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29293 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29294 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29296 /* available styles:
29301 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29302 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29303 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29304 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29305 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29306 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29307 /* smart callback called:
29308 * "expanded" - This signal is emitted when a stackedicon is expanded.
29309 * "clicked" - This signal is emitted when a stackedicon is clicked.
29311 /* available styles:
29315 /* dialoguegroup */
29316 typedef struct _Dialogue_Item Dialogue_Item;
29318 typedef enum _Elm_Dialoguegourp_Item_Style
29320 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29321 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29322 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29323 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29324 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29325 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29326 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29327 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29328 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29329 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29330 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29331 } Elm_Dialoguegroup_Item_Style;
29333 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29334 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29335 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29336 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29337 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29338 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29339 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29340 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29341 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29342 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29343 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29344 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29345 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29346 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29347 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29348 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29353 ELM_DAYSELECTOR_SUN,
29354 ELM_DAYSELECTOR_MON,
29355 ELM_DAYSELECTOR_TUE,
29356 ELM_DAYSELECTOR_WED,
29357 ELM_DAYSELECTOR_THU,
29358 ELM_DAYSELECTOR_FRI,
29359 ELM_DAYSELECTOR_SAT
29360 } Elm_DaySelector_Day;
29362 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29363 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29364 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29367 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29368 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29369 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29370 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);
29371 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);
29372 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);
29373 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29374 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29375 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29376 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29377 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29378 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29379 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29380 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29381 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29382 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29383 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);