3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when any Elementary's policy value is changed.
488 EAPI extern int ELM_EVENT_POLICY_CHANGED;
491 * @typedef Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498 * @struct _Elm_Event_Policy_Changed
500 * Data on the event when an Elementary policy has changed
502 struct _Elm_Event_Policy_Changed
504 unsigned int policy; /**< the policy identifier */
505 int new_value; /**< value the policy had before the change */
506 int old_value; /**< new value the policy got */
510 * Policy identifiers.
512 typedef enum _Elm_Policy
514 ELM_POLICY_QUIT, /**< under which circumstances the application
515 * should quit automatically. @see
519 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
522 typedef enum _Elm_Policy_Quit
524 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
526 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
528 * window is closed */
529 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
531 typedef enum _Elm_Focus_Direction
535 } Elm_Focus_Direction;
537 typedef enum _Elm_Text_Format
539 ELM_TEXT_FORMAT_PLAIN_UTF8,
540 ELM_TEXT_FORMAT_MARKUP_UTF8
544 * Line wrapping types.
546 typedef enum _Elm_Wrap_Type
548 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
558 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
559 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
560 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
561 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
562 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
563 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
565 ELM_INPUT_PANEL_LAYOUT_INVALID
566 } Elm_Input_Panel_Layout;
570 ELM_AUTOCAPITAL_TYPE_NONE,
571 ELM_AUTOCAPITAL_TYPE_WORD,
572 ELM_AUTOCAPITAL_TYPE_SENTENCE,
573 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
574 } Elm_Autocapital_Type;
577 * @typedef Elm_Object_Item
578 * An Elementary Object item handle.
581 typedef struct _Elm_Object_Item Elm_Object_Item;
585 * Called back when a widget's tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
589 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
592 * Called back when a widget's item tooltip is activated and needs content.
593 * @param data user-data given to elm_object_tooltip_content_cb_set()
594 * @param obj owner widget.
595 * @param item context dependent item. As an example, if tooltip was
596 * set on Elm_List_Item, then it is of this type.
598 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
600 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
602 #ifndef ELM_LIB_QUICKLAUNCH
603 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
605 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
608 /**************************************************************************/
612 * Initialize Elementary
614 * @param[in] argc System's argument count value
615 * @param[in] argv System's pointer to array of argument strings
616 * @return The init counter value.
618 * This function initializes Elementary and increments a counter of
619 * the number of calls to it. It returns the new counter's value.
621 * @warning This call is exported only for use by the @c ELM_MAIN()
622 * macro. There is no need to use this if you use this macro (which
623 * is highly advisable). An elm_main() should contain the entry
624 * point code for your application, having the same prototype as
625 * elm_init(), and @b not being static (putting the @c EAPI symbol
626 * in front of its type declaration is advisable). The @c
627 * ELM_MAIN() call should be placed just after it.
630 * @dontinclude bg_example_01.c
634 * See the full @ref bg_example_01_c "example".
636 * @see elm_shutdown().
639 EAPI int elm_init(int argc, char **argv);
642 * Shut down Elementary
644 * @return The init counter value.
646 * This should be called at the end of your application, just
647 * before it ceases to do any more processing. This will clean up
648 * any permanent resources your application may have allocated via
649 * Elementary that would otherwise persist.
651 * @see elm_init() for an example
655 EAPI int elm_shutdown(void);
658 * Run Elementary's main loop
660 * This call should be issued just after all initialization is
661 * completed. This function will not return until elm_exit() is
662 * called. It will keep looping, running the main
663 * (event/processing) loop for Elementary.
665 * @see elm_init() for an example
669 EAPI void elm_run(void);
672 * Exit Elementary's main loop
674 * If this call is issued, it will flag the main loop to cease
675 * processing and return back to its parent function (usually your
676 * elm_main() function).
678 * @see elm_init() for an example. There, just after a request to
679 * close the window comes, the main loop will be left.
681 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
682 * applications, you'll be able to get this function called automatically for you.
686 EAPI void elm_exit(void);
689 * Provide information in order to make Elementary determine the @b
690 * run time location of the software in question, so other data files
691 * such as images, sound files, executable utilities, libraries,
692 * modules and locale files can be found.
694 * @param mainfunc This is your application's main function name,
695 * whose binary's location is to be found. Providing @c NULL
696 * will make Elementary not to use it
697 * @param dom This will be used as the application's "domain", in the
698 * form of a prefix to any environment variables that may
699 * override prefix detection and the directory name, inside the
700 * standard share or data directories, where the software's
701 * data files will be looked for.
702 * @param checkfile This is an (optional) magic file's path to check
703 * for existence (and it must be located in the data directory,
704 * under the share directory provided above). Its presence will
705 * help determine the prefix found was correct. Pass @c NULL if
706 * the check is not to be done.
708 * This function allows one to re-locate the application somewhere
709 * else after compilation, if the developer wishes for easier
710 * distribution of pre-compiled binaries.
712 * The prefix system is designed to locate where the given software is
713 * installed (under a common path prefix) at run time and then report
714 * specific locations of this prefix and common directories inside
715 * this prefix like the binary, library, data and locale directories,
716 * through the @c elm_app_*_get() family of functions.
718 * Call elm_app_info_set() early on before you change working
719 * directory or anything about @c argv[0], so it gets accurate
722 * It will then try and trace back which file @p mainfunc comes from,
723 * if provided, to determine the application's prefix directory.
725 * The @p dom parameter provides a string prefix to prepend before
726 * environment variables, allowing a fallback to @b specific
727 * environment variables to locate the software. You would most
728 * probably provide a lowercase string there, because it will also
729 * serve as directory domain, explained next. For environment
730 * variables purposes, this string is made uppercase. For example if
731 * @c "myapp" is provided as the prefix, then the program would expect
732 * @c "MYAPP_PREFIX" as a master environment variable to specify the
733 * exact install prefix for the software, or more specific environment
734 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
735 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
736 * the user or scripts before launching. If not provided (@c NULL),
737 * environment variables will not be used to override compiled-in
738 * defaults or auto detections.
740 * The @p dom string also provides a subdirectory inside the system
741 * shared data directory for data files. For example, if the system
742 * directory is @c /usr/local/share, then this directory name is
743 * appended, creating @c /usr/local/share/myapp, if it @p was @c
744 * "myapp". It is expected that the application installs data files in
747 * The @p checkfile is a file name or path of something inside the
748 * share or data directory to be used to test that the prefix
749 * detection worked. For example, your app will install a wallpaper
750 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
751 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
754 * @see elm_app_compile_bin_dir_set()
755 * @see elm_app_compile_lib_dir_set()
756 * @see elm_app_compile_data_dir_set()
757 * @see elm_app_compile_locale_set()
758 * @see elm_app_prefix_dir_get()
759 * @see elm_app_bin_dir_get()
760 * @see elm_app_lib_dir_get()
761 * @see elm_app_data_dir_get()
762 * @see elm_app_locale_dir_get()
764 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
767 * Provide information on the @b fallback application's binaries
768 * directory, in scenarios where they get overriden by
769 * elm_app_info_set().
771 * @param dir The path to the default binaries directory (compile time
774 * @note Elementary will as well use this path to determine actual
775 * names of binaries' directory paths, maybe changing it to be @c
776 * something/local/bin instead of @c something/bin, only, for
779 * @warning You should call this function @b before
780 * elm_app_info_set().
782 EAPI void elm_app_compile_bin_dir_set(const char *dir);
785 * Provide information on the @b fallback application's libraries
786 * directory, on scenarios where they get overriden by
787 * elm_app_info_set().
789 * @param dir The path to the default libraries directory (compile
792 * @note Elementary will as well use this path to determine actual
793 * names of libraries' directory paths, maybe changing it to be @c
794 * something/lib32 or @c something/lib64 instead of @c something/lib,
797 * @warning You should call this function @b before
798 * elm_app_info_set().
800 EAPI void elm_app_compile_lib_dir_set(const char *dir);
803 * Provide information on the @b fallback application's data
804 * directory, on scenarios where they get overriden by
805 * elm_app_info_set().
807 * @param dir The path to the default data directory (compile time
810 * @note Elementary will as well use this path to determine actual
811 * names of data directory paths, maybe changing it to be @c
812 * something/local/share instead of @c something/share, only, for
815 * @warning You should call this function @b before
816 * elm_app_info_set().
818 EAPI void elm_app_compile_data_dir_set(const char *dir);
821 * Provide information on the @b fallback application's locale
822 * directory, on scenarios where they get overriden by
823 * elm_app_info_set().
825 * @param dir The path to the default locale directory (compile time
828 * @warning You should call this function @b before
829 * elm_app_info_set().
831 EAPI void elm_app_compile_locale_set(const char *dir);
834 * Retrieve the application's run time prefix directory, as set by
835 * elm_app_info_set() and the way (environment) the application was
838 * @return The directory prefix the application is actually using.
840 EAPI const char *elm_app_prefix_dir_get(void);
843 * Retrieve the application's run time binaries prefix directory, as
844 * set by elm_app_info_set() and the way (environment) the application
847 * @return The binaries directory prefix the application is actually
850 EAPI const char *elm_app_bin_dir_get(void);
853 * Retrieve the application's run time libraries prefix directory, as
854 * set by elm_app_info_set() and the way (environment) the application
857 * @return The libraries directory prefix the application is actually
860 EAPI const char *elm_app_lib_dir_get(void);
863 * Retrieve the application's run time data prefix directory, as
864 * set by elm_app_info_set() and the way (environment) the application
867 * @return The data directory prefix the application is actually
870 EAPI const char *elm_app_data_dir_get(void);
873 * Retrieve the application's run time locale prefix directory, as
874 * set by elm_app_info_set() and the way (environment) the application
877 * @return The locale directory prefix the application is actually
880 EAPI const char *elm_app_locale_dir_get(void);
882 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
883 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
884 EAPI int elm_quicklaunch_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
886 EAPI int elm_quicklaunch_sub_shutdown(void);
887 EAPI int elm_quicklaunch_shutdown(void);
888 EAPI void elm_quicklaunch_seed(void);
889 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
890 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
891 EAPI void elm_quicklaunch_cleanup(void);
892 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
893 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
895 EAPI Eina_Bool elm_need_efreet(void);
896 EAPI Eina_Bool elm_need_e_dbus(void);
899 * This must be called before any other function that deals with
900 * elm_thumb objects or ethumb_client instances.
904 EAPI Eina_Bool elm_need_ethumb(void);
907 * This must be called before any other function that deals with
908 * elm_web objects or ewk_view instances.
912 EAPI Eina_Bool elm_need_web(void);
915 * Set a new policy's value (for a given policy group/identifier).
917 * @param policy policy identifier, as in @ref Elm_Policy.
918 * @param value policy value, which depends on the identifier
920 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
922 * Elementary policies define applications' behavior,
923 * somehow. These behaviors are divided in policy groups (see
924 * #Elm_Policy enumeration). This call will emit the Ecore event
925 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
926 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
929 * @note Currently, we have only one policy identifier/group
930 * (#ELM_POLICY_QUIT), which has two possible values.
934 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
937 * Gets the policy value for given policy identifier.
939 * @param policy policy identifier, as in #Elm_Policy.
940 * @return The currently set policy value, for that
941 * identifier. Will be @c 0 if @p policy passed is invalid.
945 EAPI int elm_policy_get(unsigned int policy);
948 * Change the language of the current application
950 * The @p lang passed must be the full name of the locale to use, for
951 * example "en_US.utf8" or "es_ES@euro".
953 * Changing language with this function will make Elementary run through
954 * all its widgets, translating strings set with
955 * elm_object_domain_translatable_text_part_set(). This way, an entire
956 * UI can have its language changed without having to restart the program.
958 * For more complex cases, like having formatted strings that need
959 * translation, widgets will also emit a "language,changed" signal that
960 * the user can listen to to manually translate the text.
962 * @param lang Language to set, must be the full name of the locale
966 EAPI void elm_language_set(const char *lang);
969 * Set a label of an object
971 * @param obj The Elementary object
972 * @param part The text part name to set (NULL for the default label)
973 * @param label The new text of the label
975 * @note Elementary objects may have many labels (e.g. Action Slider)
979 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
981 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
984 * Get a label of an object
986 * @param obj The Elementary object
987 * @param part The text part name to get (NULL for the default label)
988 * @return text of the label or NULL for any error
990 * @note Elementary objects may have many labels (e.g. Action Slider)
994 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
996 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
999 * Set the text for an objects' part, marking it as translatable.
1001 * The string to set as @p text must be the original one. Do not pass the
1002 * return of @c gettext() here. Elementary will translate the string
1003 * internally and set it on the object using elm_object_text_part_set(),
1004 * also storing the original string so that it can be automatically
1005 * translated when the language is changed with elm_language_set().
1007 * The @p domain will be stored along to find the translation in the
1008 * correct catalog. It can be NULL, in which case it will use whatever
1009 * domain was set by the application with @c textdomain(). This is useful
1010 * in case you are building a library on top of Elementary that will have
1011 * its own translatable strings, that should not be mixed with those of
1012 * programs using the library.
1014 * @param obj The object containing the text part
1015 * @param part The name of the part to set
1016 * @param domain The translation domain to use
1017 * @param text The original, non-translated text to set
1021 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1023 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1025 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1028 * Gets the original string set as translatable for an object
1030 * When setting translated strings, the function elm_object_text_part_get()
1031 * will return the translation returned by @c gettext(). To get the
1032 * original string use this function.
1034 * @param obj The object
1035 * @param part The name of the part that was set
1037 * @return The original, untranslated string
1041 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1043 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1046 * Set a content of an object
1048 * @param obj The Elementary object
1049 * @param part The content part name to set (NULL for the default content)
1050 * @param content The new content of the object
1052 * @note Elementary objects may have many contents
1056 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1058 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1061 * Get a content of an object
1063 * @param obj The Elementary object
1064 * @param item The content part name to get (NULL for the default content)
1065 * @return content of the object or NULL for any error
1067 * @note Elementary objects may have many contents
1071 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1073 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1076 * Unset a content of an object
1078 * @param obj The Elementary object
1079 * @param item The content part name to unset (NULL for the default content)
1081 * @note Elementary objects may have many contents
1085 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1087 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1090 * Get the widget object's handle which contains a given item
1092 * @param item The Elementary object item
1093 * @return The widget object
1095 * @note This returns the widget object itself that an item belongs to.
1099 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1102 * Set a content of an object item
1104 * @param it The Elementary object item
1105 * @param part The content part name to set (NULL for the default content)
1106 * @param content The new content of the object item
1108 * @note Elementary object items may have many contents
1112 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1114 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1117 * Get a content of an object item
1119 * @param it The Elementary object item
1120 * @param part The content part name to unset (NULL for the default content)
1121 * @return content of the object item or NULL for any error
1123 * @note Elementary object items may have many contents
1127 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1129 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1132 * Unset a content of an object item
1134 * @param it The Elementary object item
1135 * @param part The content part name to unset (NULL for the default content)
1137 * @note Elementary object items may have many contents
1141 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1143 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1146 * Set a label of an object item
1148 * @param it The Elementary object item
1149 * @param part The text part name to set (NULL for the default label)
1150 * @param label The new text of the label
1152 * @note Elementary object items may have many labels
1156 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1158 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1161 * Get a label of an object item
1163 * @param it The Elementary object item
1164 * @param part The text part name to get (NULL for the default label)
1165 * @return text of the label or NULL for any error
1167 * @note Elementary object items may have many labels
1171 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1174 * Set the text to read out when in accessibility mode
1176 * @param obj The object which is to be described
1177 * @param txt The text that describes the widget to people with poor or no vision
1181 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1184 * Set the text to read out when in accessibility mode
1186 * @param it The object item which is to be described
1187 * @param txt The text that describes the widget to people with poor or no vision
1191 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1194 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1197 * Set the text to read out when in accessibility mode
1199 * @param obj The object which is to be described
1200 * @param txt The text that describes the widget to people with poor or no vision
1204 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1207 * Set the text to read out when in accessibility mode
1209 * @param it The object item which is to be described
1210 * @param txt The text that describes the widget to people with poor or no vision
1214 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1217 * Get the data associated with an object item
1218 * @param it The object item
1219 * @return The data associated with @p it
1223 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1226 * Set the data associated with an object item
1227 * @param it The object item
1228 * @param data The data to be associated with @p it
1232 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1235 * Send a signal to the edje object of the widget item.
1237 * This function sends a signal to the edje object of the obj item. An
1238 * edje program can respond to a signal by specifying matching
1239 * 'signal' and 'source' fields.
1241 * @param it The Elementary object item
1242 * @param emission The signal's name.
1243 * @param source The signal's source.
1246 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1253 * @defgroup Caches Caches
1255 * These are functions which let one fine-tune some cache values for
1256 * Elementary applications, thus allowing for performance adjustments.
1262 * @brief Flush all caches.
1264 * Frees all data that was in cache and is not currently being used to reduce
1265 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1266 * to calling all of the following functions:
1267 * @li edje_file_cache_flush()
1268 * @li edje_collection_cache_flush()
1269 * @li eet_clearcache()
1270 * @li evas_image_cache_flush()
1271 * @li evas_font_cache_flush()
1272 * @li evas_render_dump()
1273 * @note Evas caches are flushed for every canvas associated with a window.
1277 EAPI void elm_all_flush(void);
1280 * Get the configured cache flush interval time
1282 * This gets the globally configured cache flush interval time, in
1285 * @return The cache flush interval time
1288 * @see elm_all_flush()
1290 EAPI int elm_cache_flush_interval_get(void);
1293 * Set the configured cache flush interval time
1295 * This sets the globally configured cache flush interval time, in ticks
1297 * @param size The cache flush interval time
1300 * @see elm_all_flush()
1302 EAPI void elm_cache_flush_interval_set(int size);
1305 * Set the configured cache flush interval time for all applications on the
1308 * This sets the globally configured cache flush interval time -- in ticks
1309 * -- for all applications on the display.
1311 * @param size The cache flush interval time
1314 EAPI void elm_cache_flush_interval_all_set(int size);
1317 * Get the configured cache flush enabled state
1319 * This gets the globally configured cache flush state - if it is enabled
1320 * or not. When cache flushing is enabled, elementary will regularly
1321 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1322 * memory and allow usage to re-seed caches and data in memory where it
1323 * can do so. An idle application will thus minimise its memory usage as
1324 * data will be freed from memory and not be re-loaded as it is idle and
1325 * not rendering or doing anything graphically right now.
1327 * @return The cache flush state
1330 * @see elm_all_flush()
1332 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1335 * Set the configured cache flush enabled state
1337 * This sets the globally configured cache flush enabled state.
1339 * @param size The cache flush enabled state
1342 * @see elm_all_flush()
1344 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1347 * Set the configured cache flush enabled state for all applications on the
1350 * This sets the globally configured cache flush enabled state for all
1351 * applications on the display.
1353 * @param size The cache flush enabled state
1356 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1359 * Get the configured font cache size
1361 * This gets the globally configured font cache size, in bytes.
1363 * @return The font cache size
1366 EAPI int elm_font_cache_get(void);
1369 * Set the configured font cache size
1371 * This sets the globally configured font cache size, in bytes
1373 * @param size The font cache size
1376 EAPI void elm_font_cache_set(int size);
1379 * Set the configured font cache size for all applications on the
1382 * This sets the globally configured font cache size -- in bytes
1383 * -- for all applications on the display.
1385 * @param size The font cache size
1388 EAPI void elm_font_cache_all_set(int size);
1391 * Get the configured image cache size
1393 * This gets the globally configured image cache size, in bytes
1395 * @return The image cache size
1398 EAPI int elm_image_cache_get(void);
1401 * Set the configured image cache size
1403 * This sets the globally configured image cache size, in bytes
1405 * @param size The image cache size
1408 EAPI void elm_image_cache_set(int size);
1411 * Set the configured image cache size for all applications on the
1414 * This sets the globally configured image cache size -- in bytes
1415 * -- for all applications on the display.
1417 * @param size The image cache size
1420 EAPI void elm_image_cache_all_set(int size);
1423 * Get the configured edje file cache size.
1425 * This gets the globally configured edje file cache size, in number
1428 * @return The edje file cache size
1431 EAPI int elm_edje_file_cache_get(void);
1434 * Set the configured edje file cache size
1436 * This sets the globally configured edje file cache size, in number
1439 * @param size The edje file cache size
1442 EAPI void elm_edje_file_cache_set(int size);
1445 * Set the configured edje file cache size for all applications on the
1448 * This sets the globally configured edje file cache size -- in number
1449 * of files -- for all applications on the display.
1451 * @param size The edje file cache size
1454 EAPI void elm_edje_file_cache_all_set(int size);
1457 * Get the configured edje collections (groups) cache size.
1459 * This gets the globally configured edje collections cache size, in
1460 * number of collections.
1462 * @return The edje collections cache size
1465 EAPI int elm_edje_collection_cache_get(void);
1468 * Set the configured edje collections (groups) cache size
1470 * This sets the globally configured edje collections cache size, in
1471 * number of collections.
1473 * @param size The edje collections cache size
1476 EAPI void elm_edje_collection_cache_set(int size);
1479 * Set the configured edje collections (groups) cache size for all
1480 * applications on the display
1482 * This sets the globally configured edje collections cache size -- in
1483 * number of collections -- for all applications on the display.
1485 * @param size The edje collections cache size
1488 EAPI void elm_edje_collection_cache_all_set(int size);
1495 * @defgroup Scaling Widget Scaling
1497 * Different widgets can be scaled independently. These functions
1498 * allow you to manipulate this scaling on a per-widget basis. The
1499 * object and all its children get their scaling factors multiplied
1500 * by the scale factor set. This is multiplicative, in that if a
1501 * child also has a scale size set it is in turn multiplied by its
1502 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1503 * double size, @c 0.5 is half, etc.
1505 * @ref general_functions_example_page "This" example contemplates
1506 * some of these functions.
1510 * Get the global scaling factor
1512 * This gets the globally configured scaling factor that is applied to all
1515 * @return The scaling factor
1518 EAPI double elm_scale_get(void);
1521 * Set the global scaling factor
1523 * This sets the globally configured scaling factor that is applied to all
1526 * @param scale The scaling factor to set
1529 EAPI void elm_scale_set(double scale);
1532 * Set the global scaling factor for all applications on the display
1534 * This sets the globally configured scaling factor that is applied to all
1535 * objects for all applications.
1536 * @param scale The scaling factor to set
1539 EAPI void elm_scale_all_set(double scale);
1542 * Set the scaling factor for a given Elementary object
1544 * @param obj The Elementary to operate on
1545 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1550 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1553 * Get the scaling factor for a given Elementary object
1555 * @param obj The object
1556 * @return The scaling factor set by elm_object_scale_set()
1560 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 * @defgroup Password_last_show Password last input show
1565 * Last show feature of password mode enables user to view
1566 * the last input entered for few seconds before masking it.
1567 * These functions allow to set this feature in password mode
1568 * of entry widget and also allow to manipulate the duration
1569 * for which the input has to be visible.
1575 * Get show last setting of password mode.
1577 * This gets the show last input setting of password mode which might be
1578 * enabled or disabled.
1580 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1582 * @ingroup Password_last_show
1584 EAPI Eina_Bool elm_password_show_last_get(void);
1587 * Set show last setting in password mode.
1589 * This enables or disables show last setting of password mode.
1591 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1592 * @see elm_password_show_last_timeout_set()
1593 * @ingroup Password_last_show
1595 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1598 * Get's the timeout value in last show password mode.
1600 * This gets the time out value for which the last input entered in password
1601 * mode will be visible.
1603 * @return The timeout value of last show password mode.
1604 * @ingroup Password_last_show
1606 EAPI double elm_password_show_last_timeout_get(void);
1609 * Set's the timeout value in last show password mode.
1611 * This sets the time out value for which the last input entered in password
1612 * mode will be visible.
1614 * @param password_show_last_timeout The timeout value.
1615 * @see elm_password_show_last_set()
1616 * @ingroup Password_last_show
1618 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1625 * @defgroup UI-Mirroring Selective Widget mirroring
1627 * These functions allow you to set ui-mirroring on specific
1628 * widgets or the whole interface. Widgets can be in one of two
1629 * modes, automatic and manual. Automatic means they'll be changed
1630 * according to the system mirroring mode and manual means only
1631 * explicit changes will matter. You are not supposed to change
1632 * mirroring state of a widget set to automatic, will mostly work,
1633 * but the behavior is not really defined.
1638 EAPI Eina_Bool elm_mirrored_get(void);
1639 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1642 * Get the system mirrored mode. This determines the default mirrored mode
1645 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1647 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1650 * Set the system mirrored mode. This determines the default mirrored mode
1653 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1655 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1658 * Returns the widget's mirrored mode setting.
1660 * @param obj The widget.
1661 * @return mirrored mode setting of the object.
1664 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1667 * Sets the widget's mirrored mode setting.
1668 * When widget in automatic mode, it follows the system mirrored mode set by
1669 * elm_mirrored_set().
1670 * @param obj The widget.
1671 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1673 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1680 * Set the style to use by a widget
1682 * Sets the style name that will define the appearance of a widget. Styles
1683 * vary from widget to widget and may also be defined by other themes
1684 * by means of extensions and overlays.
1686 * @param obj The Elementary widget to style
1687 * @param style The style name to use
1689 * @see elm_theme_extension_add()
1690 * @see elm_theme_extension_del()
1691 * @see elm_theme_overlay_add()
1692 * @see elm_theme_overlay_del()
1696 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1698 * Get the style used by the widget
1700 * This gets the style being used for that widget. Note that the string
1701 * pointer is only valid as longas the object is valid and the style doesn't
1704 * @param obj The Elementary widget to query for its style
1705 * @return The style name used
1707 * @see elm_object_style_set()
1711 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1714 * @defgroup Styles Styles
1716 * Widgets can have different styles of look. These generic API's
1717 * set styles of widgets, if they support them (and if the theme(s)
1720 * @ref general_functions_example_page "This" example contemplates
1721 * some of these functions.
1725 * Set the disabled state of an Elementary object.
1727 * @param obj The Elementary object to operate on
1728 * @param disabled The state to put in in: @c EINA_TRUE for
1729 * disabled, @c EINA_FALSE for enabled
1731 * Elementary objects can be @b disabled, in which state they won't
1732 * receive input and, in general, will be themed differently from
1733 * their normal state, usually greyed out. Useful for contexts
1734 * where you don't want your users to interact with some of the
1735 * parts of you interface.
1737 * This sets the state for the widget, either disabling it or
1742 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1745 * Get the disabled state of an Elementary object.
1747 * @param obj The Elementary object to operate on
1748 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1749 * if it's enabled (or on errors)
1751 * This gets the state of the widget, which might be enabled or disabled.
1755 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1758 * @defgroup WidgetNavigation Widget Tree Navigation.
1760 * How to check if an Evas Object is an Elementary widget? How to
1761 * get the first elementary widget that is parent of the given
1762 * object? These are all covered in widget tree navigation.
1764 * @ref general_functions_example_page "This" example contemplates
1765 * some of these functions.
1769 * Check if the given Evas Object is an Elementary widget.
1771 * @param obj the object to query.
1772 * @return @c EINA_TRUE if it is an elementary widget variant,
1773 * @c EINA_FALSE otherwise
1774 * @ingroup WidgetNavigation
1776 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1779 * Get the first parent of the given object that is an Elementary
1782 * @param obj the Elementary object to query parent from.
1783 * @return the parent object that is an Elementary widget, or @c
1784 * NULL, if it was not found.
1786 * Use this to query for an object's parent widget.
1788 * @note Most of Elementary users wouldn't be mixing non-Elementary
1789 * smart objects in the objects tree of an application, as this is
1790 * an advanced usage of Elementary with Evas. So, except for the
1791 * application's window, which is the root of that tree, all other
1792 * objects would have valid Elementary widget parents.
1794 * @ingroup WidgetNavigation
1796 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1799 * Get the top level parent of an Elementary widget.
1801 * @param obj The object to query.
1802 * @return The top level Elementary widget, or @c NULL if parent cannot be
1804 * @ingroup WidgetNavigation
1806 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1809 * Get the string that represents this Elementary widget.
1811 * @note Elementary is weird and exposes itself as a single
1812 * Evas_Object_Smart_Class of type "elm_widget", so
1813 * evas_object_type_get() always return that, making debug and
1814 * language bindings hard. This function tries to mitigate this
1815 * problem, but the solution is to change Elementary to use
1816 * proper inheritance.
1818 * @param obj the object to query.
1819 * @return Elementary widget name, or @c NULL if not a valid widget.
1820 * @ingroup WidgetNavigation
1822 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1825 * @defgroup Config Elementary Config
1827 * Elementary configuration is formed by a set options bounded to a
1828 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1829 * "finger size", etc. These are functions with which one syncronizes
1830 * changes made to those values to the configuration storing files, de
1831 * facto. You most probably don't want to use the functions in this
1832 * group unlees you're writing an elementary configuration manager.
1838 * Save back Elementary's configuration, so that it will persist on
1841 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1844 * This function will take effect -- thus, do I/O -- immediately. Use
1845 * it when you want to apply all configuration changes at once. The
1846 * current configuration set will get saved onto the current profile
1847 * configuration file.
1850 EAPI Eina_Bool elm_config_save(void);
1853 * Reload Elementary's configuration, bounded to current selected
1856 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1859 * Useful when you want to force reloading of configuration values for
1860 * a profile. If one removes user custom configuration directories,
1861 * for example, it will force a reload with system values insted.
1864 EAPI void elm_config_reload(void);
1871 * @defgroup Profile Elementary Profile
1873 * Profiles are pre-set options that affect the whole look-and-feel of
1874 * Elementary-based applications. There are, for example, profiles
1875 * aimed at desktop computer applications and others aimed at mobile,
1876 * touchscreen-based ones. You most probably don't want to use the
1877 * functions in this group unlees you're writing an elementary
1878 * configuration manager.
1884 * Get Elementary's profile in use.
1886 * This gets the global profile that is applied to all Elementary
1889 * @return The profile's name
1892 EAPI const char *elm_profile_current_get(void);
1895 * Get an Elementary's profile directory path in the filesystem. One
1896 * may want to fetch a system profile's dir or an user one (fetched
1899 * @param profile The profile's name
1900 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1901 * or a system one (@c EINA_FALSE)
1902 * @return The profile's directory path.
1905 * @note You must free it with elm_profile_dir_free().
1907 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1910 * Free an Elementary's profile directory path, as returned by
1911 * elm_profile_dir_get().
1913 * @param p_dir The profile's path
1917 EAPI void elm_profile_dir_free(const char *p_dir);
1920 * Get Elementary's list of available profiles.
1922 * @return The profiles list. List node data are the profile name
1926 * @note One must free this list, after usage, with the function
1927 * elm_profile_list_free().
1929 EAPI Eina_List *elm_profile_list_get(void);
1932 * Free Elementary's list of available profiles.
1934 * @param l The profiles list, as returned by elm_profile_list_get().
1938 EAPI void elm_profile_list_free(Eina_List *l);
1941 * Set Elementary's profile.
1943 * This sets the global profile that is applied to Elementary
1944 * applications. Just the process the call comes from will be
1947 * @param profile The profile's name
1951 EAPI void elm_profile_set(const char *profile);
1954 * Set Elementary's profile.
1956 * This sets the global profile that is applied to all Elementary
1957 * applications. All running Elementary windows will be affected.
1959 * @param profile The profile's name
1963 EAPI void elm_profile_all_set(const char *profile);
1970 * @defgroup Engine Elementary Engine
1972 * These are functions setting and querying which rendering engine
1973 * Elementary will use for drawing its windows' pixels.
1975 * The following are the available engines:
1976 * @li "software_x11"
1979 * @li "software_16_x11"
1980 * @li "software_8_x11"
1983 * @li "software_gdi"
1984 * @li "software_16_wince_gdi"
1986 * @li "software_16_sdl"
1990 * @li "opengl_cocoa"
1997 * @brief Get Elementary's rendering engine in use.
1999 * @return The rendering engine's name
2000 * @note there's no need to free the returned string, here.
2002 * This gets the global rendering engine that is applied to all Elementary
2005 * @see elm_engine_set()
2007 EAPI const char *elm_engine_current_get(void);
2010 * @brief Set Elementary's rendering engine for use.
2012 * @param engine The rendering engine's name
2014 * This sets global rendering engine that is applied to all Elementary
2015 * applications. Note that it will take effect only to Elementary windows
2016 * created after this is called.
2018 * @see elm_win_add()
2020 EAPI void elm_engine_set(const char *engine);
2027 * @defgroup Fonts Elementary Fonts
2029 * These are functions dealing with font rendering, selection and the
2030 * like for Elementary applications. One might fetch which system
2031 * fonts are there to use and set custom fonts for individual classes
2032 * of UI items containing text (text classes).
2037 typedef struct _Elm_Text_Class
2043 typedef struct _Elm_Font_Overlay
2045 const char *text_class;
2047 Evas_Font_Size size;
2050 typedef struct _Elm_Font_Properties
2054 } Elm_Font_Properties;
2057 * Get Elementary's list of supported text classes.
2059 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2062 * Release the list with elm_text_classes_list_free().
2064 EAPI const Eina_List *elm_text_classes_list_get(void);
2067 * Free Elementary's list of supported text classes.
2071 * @see elm_text_classes_list_get().
2073 EAPI void elm_text_classes_list_free(const Eina_List *list);
2076 * Get Elementary's list of font overlays, set with
2077 * elm_font_overlay_set().
2079 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2084 * For each text class, one can set a <b>font overlay</b> for it,
2085 * overriding the default font properties for that class coming from
2086 * the theme in use. There is no need to free this list.
2088 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2090 EAPI const Eina_List *elm_font_overlay_list_get(void);
2093 * Set a font overlay for a given Elementary text class.
2095 * @param text_class Text class name
2096 * @param font Font name and style string
2097 * @param size Font size
2101 * @p font has to be in the format returned by
2102 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2103 * and elm_font_overlay_unset().
2105 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2108 * Unset a font overlay for a given Elementary text class.
2110 * @param text_class Text class name
2114 * This will bring back text elements belonging to text class
2115 * @p text_class back to their default font settings.
2117 EAPI void elm_font_overlay_unset(const char *text_class);
2120 * Apply the changes made with elm_font_overlay_set() and
2121 * elm_font_overlay_unset() on the current Elementary window.
2125 * This applies all font overlays set to all objects in the UI.
2127 EAPI void elm_font_overlay_apply(void);
2130 * Apply the changes made with elm_font_overlay_set() and
2131 * elm_font_overlay_unset() on all Elementary application windows.
2135 * This applies all font overlays set to all objects in the UI.
2137 EAPI void elm_font_overlay_all_apply(void);
2140 * Translate a font (family) name string in fontconfig's font names
2141 * syntax into an @c Elm_Font_Properties struct.
2143 * @param font The font name and styles string
2144 * @return the font properties struct
2148 * @note The reverse translation can be achived with
2149 * elm_font_fontconfig_name_get(), for one style only (single font
2150 * instance, not family).
2152 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2155 * Free font properties return by elm_font_properties_get().
2157 * @param efp the font properties struct
2161 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2164 * Translate a font name, bound to a style, into fontconfig's font names
2167 * @param name The font (family) name
2168 * @param style The given style (may be @c NULL)
2170 * @return the font name and style string
2174 * @note The reverse translation can be achived with
2175 * elm_font_properties_get(), for one style only (single font
2176 * instance, not family).
2178 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2181 * Free the font string return by elm_font_fontconfig_name_get().
2183 * @param efp the font properties struct
2187 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2190 * Create a font hash table of available system fonts.
2192 * One must call it with @p list being the return value of
2193 * evas_font_available_list(). The hash will be indexed by font
2194 * (family) names, being its values @c Elm_Font_Properties blobs.
2196 * @param list The list of available system fonts, as returned by
2197 * evas_font_available_list().
2198 * @return the font hash.
2202 * @note The user is supposed to get it populated at least with 3
2203 * default font families (Sans, Serif, Monospace), which should be
2204 * present on most systems.
2206 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2209 * Free the hash return by elm_font_available_hash_add().
2211 * @param hash the hash to be freed.
2215 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2222 * @defgroup Fingers Fingers
2224 * Elementary is designed to be finger-friendly for touchscreens,
2225 * and so in addition to scaling for display resolution, it can
2226 * also scale based on finger "resolution" (or size). You can then
2227 * customize the granularity of the areas meant to receive clicks
2230 * Different profiles may have pre-set values for finger sizes.
2232 * @ref general_functions_example_page "This" example contemplates
2233 * some of these functions.
2239 * Get the configured "finger size"
2241 * @return The finger size
2243 * This gets the globally configured finger size, <b>in pixels</b>
2247 EAPI Evas_Coord elm_finger_size_get(void);
2250 * Set the configured finger size
2252 * This sets the globally configured finger size in pixels
2254 * @param size The finger size
2257 EAPI void elm_finger_size_set(Evas_Coord size);
2260 * Set the configured finger size for all applications on the display
2262 * This sets the globally configured finger size in pixels for all
2263 * applications on the display
2265 * @param size The finger size
2268 EAPI void elm_finger_size_all_set(Evas_Coord size);
2275 * @defgroup Focus Focus
2277 * An Elementary application has, at all times, one (and only one)
2278 * @b focused object. This is what determines where the input
2279 * events go to within the application's window. Also, focused
2280 * objects can be decorated differently, in order to signal to the
2281 * user where the input is, at a given moment.
2283 * Elementary applications also have the concept of <b>focus
2284 * chain</b>: one can cycle through all the windows' focusable
2285 * objects by input (tab key) or programmatically. The default
2286 * focus chain for an application is the one define by the order in
2287 * which the widgets where added in code. One will cycle through
2288 * top level widgets, and, for each one containg sub-objects, cycle
2289 * through them all, before returning to the level
2290 * above. Elementary also allows one to set @b custom focus chains
2291 * for their applications.
2293 * Besides the focused decoration a widget may exhibit, when it
2294 * gets focus, Elementary has a @b global focus highlight object
2295 * that can be enabled for a window. If one chooses to do so, this
2296 * extra highlight effect will surround the current focused object,
2299 * @note Some Elementary widgets are @b unfocusable, after
2300 * creation, by their very nature: they are not meant to be
2301 * interacted with input events, but are there just for visual
2304 * @ref general_functions_example_page "This" example contemplates
2305 * some of these functions.
2309 * Get the enable status of the focus highlight
2311 * This gets whether the highlight on focused objects is enabled or not
2314 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2317 * Set the enable status of the focus highlight
2319 * Set whether to show or not the highlight on focused objects
2320 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2323 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2326 * Get the enable status of the highlight animation
2328 * Get whether the focus highlight, if enabled, will animate its switch from
2329 * one object to the next
2332 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2335 * Set the enable status of the highlight animation
2337 * Set whether the focus highlight, if enabled, will animate its switch from
2338 * one object to the next
2339 * @param animate Enable animation if EINA_TRUE, disable otherwise
2342 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2345 * Get the whether an Elementary object has the focus or not.
2347 * @param obj The Elementary object to get the information from
2348 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2349 * not (and on errors).
2351 * @see elm_object_focus_set()
2355 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2358 * Set/unset focus to a given Elementary object.
2360 * @param obj The Elementary object to operate on.
2361 * @param enable @c EINA_TRUE Set focus to a given object,
2362 * @c EINA_FALSE Unset focus to a given object.
2364 * @note When you set focus to this object, if it can handle focus, will
2365 * take the focus away from the one who had it previously and will, for
2366 * now on, be the one receiving input events. Unsetting focus will remove
2367 * the focus from @p obj, passing it back to the previous element in the
2370 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2374 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2377 * Make a given Elementary object the focused one.
2379 * @param obj The Elementary object to make focused.
2381 * @note This object, if it can handle focus, will take the focus
2382 * away from the one who had it previously and will, for now on, be
2383 * the one receiving input events.
2385 * @see elm_object_focus_get()
2389 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2392 * Remove the focus from an Elementary object
2394 * @param obj The Elementary to take focus from
2396 * This removes the focus from @p obj, passing it back to the
2397 * previous element in the focus chain list.
2399 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2403 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2406 * Set the ability for an Element object to be focused
2408 * @param obj The Elementary object to operate on
2409 * @param enable @c EINA_TRUE if the object can be focused, @c
2410 * EINA_FALSE if not (and on errors)
2412 * This sets whether the object @p obj is able to take focus or
2413 * not. Unfocusable objects do nothing when programmatically
2414 * focused, being the nearest focusable parent object the one
2415 * really getting focus. Also, when they receive mouse input, they
2416 * will get the event, but not take away the focus from where it
2421 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2424 * Get whether an Elementary object is focusable or not
2426 * @param obj The Elementary object to operate on
2427 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2428 * EINA_FALSE if not (and on errors)
2430 * @note Objects which are meant to be interacted with by input
2431 * events are created able to be focused, by default. All the
2436 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2439 * Set custom focus chain.
2441 * This function overwrites any previous custom focus chain within
2442 * the list of objects. The previous list will be deleted and this list
2443 * will be managed by elementary. After it is set, don't modify it.
2445 * @note On focus cycle, only will be evaluated children of this container.
2447 * @param obj The container object
2448 * @param objs Chain of objects to pass focus
2451 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2454 * Unset a custom focus chain on a given Elementary widget
2456 * @param obj The container object to remove focus chain from
2458 * Any focus chain previously set on @p obj (for its child objects)
2459 * is removed entirely after this call.
2463 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2466 * Get custom focus chain
2468 * @param obj The container object
2471 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2474 * Append object to custom focus chain.
2476 * @note If relative_child equal to NULL or not in custom chain, the object
2477 * will be added in end.
2479 * @note On focus cycle, only will be evaluated children of this container.
2481 * @param obj The container object
2482 * @param child The child to be added in custom chain
2483 * @param relative_child The relative object to position the child
2486 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2489 * Prepend object to custom focus chain.
2491 * @note If relative_child equal to NULL or not in custom chain, the object
2492 * will be added in begin.
2494 * @note On focus cycle, only will be evaluated children of this container.
2496 * @param obj The container object
2497 * @param child The child to be added in custom chain
2498 * @param relative_child The relative object to position the child
2501 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2504 * Give focus to next object in object tree.
2506 * Give focus to next object in focus chain of one object sub-tree.
2507 * If the last object of chain already have focus, the focus will go to the
2508 * first object of chain.
2510 * @param obj The object root of sub-tree
2511 * @param dir Direction to cycle the focus
2515 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2518 * Give focus to near object in one direction.
2520 * Give focus to near object in direction of one object.
2521 * If none focusable object in given direction, the focus will not change.
2523 * @param obj The reference object
2524 * @param x Horizontal component of direction to focus
2525 * @param y Vertical component of direction to focus
2529 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2532 * Make the elementary object and its children to be unfocusable
2535 * @param obj The Elementary object to operate on
2536 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2537 * @c EINA_FALSE for focusable.
2539 * This sets whether the object @p obj and its children objects
2540 * are able to take focus or not. If the tree is set as unfocusable,
2541 * newest focused object which is not in this tree will get focus.
2542 * This API can be helpful for an object to be deleted.
2543 * When an object will be deleted soon, it and its children may not
2544 * want to get focus (by focus reverting or by other focus controls).
2545 * Then, just use this API before deleting.
2547 * @see elm_object_tree_unfocusable_get()
2551 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2554 * Get whether an Elementary object and its children are unfocusable or not.
2556 * @param obj The Elementary object to get the information from
2557 * @return @c EINA_TRUE, if the tree is unfocussable,
2558 * @c EINA_FALSE if not (and on errors).
2560 * @see elm_object_tree_unfocusable_set()
2564 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2567 * @defgroup Scrolling Scrolling
2569 * These are functions setting how scrollable views in Elementary
2570 * widgets should behave on user interaction.
2576 * Get whether scrollers should bounce when they reach their
2577 * viewport's edge during a scroll.
2579 * @return the thumb scroll bouncing state
2581 * This is the default behavior for touch screens, in general.
2582 * @ingroup Scrolling
2584 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2587 * Set whether scrollers should bounce when they reach their
2588 * viewport's edge during a scroll.
2590 * @param enabled the thumb scroll bouncing state
2592 * @see elm_thumbscroll_bounce_enabled_get()
2593 * @ingroup Scrolling
2595 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2598 * Set whether scrollers should bounce when they reach their
2599 * viewport's edge during a scroll, for all Elementary application
2602 * @param enabled the thumb scroll bouncing state
2604 * @see elm_thumbscroll_bounce_enabled_get()
2605 * @ingroup Scrolling
2607 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2610 * Get the amount of inertia a scroller will impose at bounce
2613 * @return the thumb scroll bounce friction
2615 * @ingroup Scrolling
2617 EAPI double elm_scroll_bounce_friction_get(void);
2620 * Set the amount of inertia a scroller will impose at bounce
2623 * @param friction the thumb scroll bounce friction
2625 * @see elm_thumbscroll_bounce_friction_get()
2626 * @ingroup Scrolling
2628 EAPI void elm_scroll_bounce_friction_set(double friction);
2631 * Set the amount of inertia a scroller will impose at bounce
2632 * animations, for all Elementary application windows.
2634 * @param friction the thumb scroll bounce friction
2636 * @see elm_thumbscroll_bounce_friction_get()
2637 * @ingroup Scrolling
2639 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2642 * Get the amount of inertia a <b>paged</b> scroller will impose at
2643 * page fitting animations.
2645 * @return the page scroll friction
2647 * @ingroup Scrolling
2649 EAPI double elm_scroll_page_scroll_friction_get(void);
2652 * Set the amount of inertia a <b>paged</b> scroller will impose at
2653 * page fitting animations.
2655 * @param friction the page scroll friction
2657 * @see elm_thumbscroll_page_scroll_friction_get()
2658 * @ingroup Scrolling
2660 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2663 * Set the amount of inertia a <b>paged</b> scroller will impose at
2664 * page fitting animations, for all Elementary application windows.
2666 * @param friction the page scroll friction
2668 * @see elm_thumbscroll_page_scroll_friction_get()
2669 * @ingroup Scrolling
2671 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2674 * Get the amount of inertia a scroller will impose at region bring
2677 * @return the bring in scroll friction
2679 * @ingroup Scrolling
2681 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2684 * Set the amount of inertia a scroller will impose at region bring
2687 * @param friction the bring in scroll friction
2689 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2690 * @ingroup Scrolling
2692 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2695 * Set the amount of inertia a scroller will impose at region bring
2696 * animations, for all Elementary application windows.
2698 * @param friction the bring in scroll friction
2700 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2701 * @ingroup Scrolling
2703 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2706 * Get the amount of inertia scrollers will impose at animations
2707 * triggered by Elementary widgets' zooming API.
2709 * @return the zoom friction
2711 * @ingroup Scrolling
2713 EAPI double elm_scroll_zoom_friction_get(void);
2716 * Set the amount of inertia scrollers will impose at animations
2717 * triggered by Elementary widgets' zooming API.
2719 * @param friction the zoom friction
2721 * @see elm_thumbscroll_zoom_friction_get()
2722 * @ingroup Scrolling
2724 EAPI void elm_scroll_zoom_friction_set(double friction);
2727 * Set the amount of inertia scrollers will impose at animations
2728 * triggered by Elementary widgets' zooming API, for all Elementary
2729 * application windows.
2731 * @param friction the zoom friction
2733 * @see elm_thumbscroll_zoom_friction_get()
2734 * @ingroup Scrolling
2736 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2739 * Get whether scrollers should be draggable from any point in their
2742 * @return the thumb scroll state
2744 * @note This is the default behavior for touch screens, in general.
2745 * @note All other functions namespaced with "thumbscroll" will only
2746 * have effect if this mode is enabled.
2748 * @ingroup Scrolling
2750 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2753 * Set whether scrollers should be draggable from any point in their
2756 * @param enabled the thumb scroll state
2758 * @see elm_thumbscroll_enabled_get()
2759 * @ingroup Scrolling
2761 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2764 * Set whether scrollers should be draggable from any point in their
2765 * views, for all Elementary application windows.
2767 * @param enabled the thumb scroll state
2769 * @see elm_thumbscroll_enabled_get()
2770 * @ingroup Scrolling
2772 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2775 * Get the number of pixels one should travel while dragging a
2776 * scroller's view to actually trigger scrolling.
2778 * @return the thumb scroll threshould
2780 * One would use higher values for touch screens, in general, because
2781 * of their inherent imprecision.
2782 * @ingroup Scrolling
2784 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2787 * Set the number of pixels one should travel while dragging a
2788 * scroller's view to actually trigger scrolling.
2790 * @param threshold the thumb scroll threshould
2792 * @see elm_thumbscroll_threshould_get()
2793 * @ingroup Scrolling
2795 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2798 * Set the number of pixels one should travel while dragging a
2799 * scroller's view to actually trigger scrolling, for all Elementary
2800 * application windows.
2802 * @param threshold the thumb scroll threshould
2804 * @see elm_thumbscroll_threshould_get()
2805 * @ingroup Scrolling
2807 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2810 * Get the minimum speed of mouse cursor movement which will trigger
2811 * list self scrolling animation after a mouse up event
2814 * @return the thumb scroll momentum threshould
2816 * @ingroup Scrolling
2818 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2821 * Set the minimum speed of mouse cursor movement which will trigger
2822 * list self scrolling animation after a mouse up event
2825 * @param threshold the thumb scroll momentum threshould
2827 * @see elm_thumbscroll_momentum_threshould_get()
2828 * @ingroup Scrolling
2830 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2833 * Set the minimum speed of mouse cursor movement which will trigger
2834 * list self scrolling animation after a mouse up event
2835 * (pixels/second), for all Elementary application windows.
2837 * @param threshold the thumb scroll momentum threshould
2839 * @see elm_thumbscroll_momentum_threshould_get()
2840 * @ingroup Scrolling
2842 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2845 * Get the amount of inertia a scroller will impose at self scrolling
2848 * @return the thumb scroll friction
2850 * @ingroup Scrolling
2852 EAPI double elm_scroll_thumbscroll_friction_get(void);
2855 * Set the amount of inertia a scroller will impose at self scrolling
2858 * @param friction the thumb scroll friction
2860 * @see elm_thumbscroll_friction_get()
2861 * @ingroup Scrolling
2863 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2866 * Set the amount of inertia a scroller will impose at self scrolling
2867 * animations, for all Elementary application windows.
2869 * @param friction the thumb scroll friction
2871 * @see elm_thumbscroll_friction_get()
2872 * @ingroup Scrolling
2874 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2877 * Get the amount of lag between your actual mouse cursor dragging
2878 * movement and a scroller's view movement itself, while pushing it
2879 * into bounce state manually.
2881 * @return the thumb scroll border friction
2883 * @ingroup Scrolling
2885 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2888 * Set the amount of lag between your actual mouse cursor dragging
2889 * movement and a scroller's view movement itself, while pushing it
2890 * into bounce state manually.
2892 * @param friction the thumb scroll border friction. @c 0.0 for
2893 * perfect synchrony between two movements, @c 1.0 for maximum
2896 * @see elm_thumbscroll_border_friction_get()
2897 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2899 * @ingroup Scrolling
2901 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2904 * Set the amount of lag between your actual mouse cursor dragging
2905 * movement and a scroller's view movement itself, while pushing it
2906 * into bounce state manually, for all Elementary application windows.
2908 * @param friction the thumb scroll border friction. @c 0.0 for
2909 * perfect synchrony between two movements, @c 1.0 for maximum
2912 * @see elm_thumbscroll_border_friction_get()
2913 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2915 * @ingroup Scrolling
2917 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2920 * Get the sensitivity amount which is be multiplied by the length of
2923 * @return the thumb scroll sensitivity friction
2925 * @ingroup Scrolling
2927 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2930 * Set the sensitivity amount which is be multiplied by the length of
2933 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2934 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2937 * @see elm_thumbscroll_sensitivity_friction_get()
2938 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2940 * @ingroup Scrolling
2942 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2945 * Set the sensitivity amount which is be multiplied by the length of
2946 * mouse dragging, for all Elementary application windows.
2948 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2949 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2952 * @see elm_thumbscroll_sensitivity_friction_get()
2953 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2955 * @ingroup Scrolling
2957 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2964 * @defgroup Scrollhints Scrollhints
2966 * Objects when inside a scroller can scroll, but this may not always be
2967 * desirable in certain situations. This allows an object to hint to itself
2968 * and parents to "not scroll" in one of 2 ways. If any child object of a
2969 * scroller has pushed a scroll freeze or hold then it affects all parent
2970 * scrollers until all children have released them.
2972 * 1. To hold on scrolling. This means just flicking and dragging may no
2973 * longer scroll, but pressing/dragging near an edge of the scroller will
2974 * still scroll. This is automatically used by the entry object when
2977 * 2. To totally freeze scrolling. This means it stops. until
2984 * Push the scroll hold by 1
2986 * This increments the scroll hold count by one. If it is more than 0 it will
2987 * take effect on the parents of the indicated object.
2989 * @param obj The object
2990 * @ingroup Scrollhints
2992 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2995 * Pop the scroll hold by 1
2997 * This decrements the scroll hold count by one. If it is more than 0 it will
2998 * take effect on the parents of the indicated object.
3000 * @param obj The object
3001 * @ingroup Scrollhints
3003 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3006 * Push the scroll freeze by 1
3008 * This increments the scroll freeze count by one. If it is more
3009 * than 0 it will take effect on the parents of the indicated
3012 * @param obj The object
3013 * @ingroup Scrollhints
3015 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3018 * Pop the scroll freeze by 1
3020 * This decrements the scroll freeze count by one. If it is more
3021 * than 0 it will take effect on the parents of the indicated
3024 * @param obj The object
3025 * @ingroup Scrollhints
3027 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3030 * Lock the scrolling of the given widget (and thus all parents)
3032 * This locks the given object from scrolling in the X axis (and implicitly
3033 * also locks all parent scrollers too from doing the same).
3035 * @param obj The object
3036 * @param lock The lock state (1 == locked, 0 == unlocked)
3037 * @ingroup Scrollhints
3039 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3042 * Lock the scrolling of the given widget (and thus all parents)
3044 * This locks the given object from scrolling in the Y axis (and implicitly
3045 * also locks all parent scrollers too from doing the same).
3047 * @param obj The object
3048 * @param lock The lock state (1 == locked, 0 == unlocked)
3049 * @ingroup Scrollhints
3051 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3054 * Get the scrolling lock of the given widget
3056 * This gets the lock for X axis scrolling.
3058 * @param obj The object
3059 * @ingroup Scrollhints
3061 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3064 * Get the scrolling lock of the given widget
3066 * This gets the lock for X axis scrolling.
3068 * @param obj The object
3069 * @ingroup Scrollhints
3071 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3078 * Send a signal to the widget edje object.
3080 * This function sends a signal to the edje object of the obj. An
3081 * edje program can respond to a signal by specifying matching
3082 * 'signal' and 'source' fields.
3084 * @param obj The object
3085 * @param emission The signal's name.
3086 * @param source The signal's source.
3089 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3092 * Add a callback for a signal emitted by widget edje object.
3094 * This function connects a callback function to a signal emitted by the
3095 * edje object of the obj.
3096 * Globs can occur in either the emission or source name.
3098 * @param obj The object
3099 * @param emission The signal's name.
3100 * @param source The signal's source.
3101 * @param func The callback function to be executed when the signal is
3103 * @param data A pointer to data to pass in to the callback function.
3106 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);
3109 * Remove a signal-triggered callback from a widget edje object.
3111 * This function removes a callback, previoulsy attached to a
3112 * signal emitted by the edje object of the obj. The parameters
3113 * emission, source and func must match exactly those passed to a
3114 * previous call to elm_object_signal_callback_add(). The data
3115 * pointer that was passed to this call will be returned.
3117 * @param obj The object
3118 * @param emission The signal's name.
3119 * @param source The signal's source.
3120 * @param func The callback function to be executed when the signal is
3122 * @return The data pointer
3125 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);
3128 * Add a callback for input events (key up, key down, mouse wheel)
3129 * on a given Elementary widget
3131 * @param obj The widget to add an event callback on
3132 * @param func The callback function to be executed when the event
3134 * @param data Data to pass in to @p func
3136 * Every widget in an Elementary interface set to receive focus,
3137 * with elm_object_focus_allow_set(), will propagate @b all of its
3138 * key up, key down and mouse wheel input events up to its parent
3139 * object, and so on. All of the focusable ones in this chain which
3140 * had an event callback set, with this call, will be able to treat
3141 * those events. There are two ways of making the propagation of
3142 * these event upwards in the tree of widgets to @b cease:
3143 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3144 * the event was @b not processed, so the propagation will go on.
3145 * - The @c event_info pointer passed to @p func will contain the
3146 * event's structure and, if you OR its @c event_flags inner
3147 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3148 * one has already handled it, thus killing the event's
3151 * @note Your event callback will be issued on those events taking
3152 * place only if no other child widget of @obj has consumed the
3155 * @note Not to be confused with @c
3156 * evas_object_event_callback_add(), which will add event callbacks
3157 * per type on general Evas objects (no event propagation
3158 * infrastructure taken in account).
3160 * @note Not to be confused with @c
3161 * elm_object_signal_callback_add(), which will add callbacks to @b
3162 * signals coming from a widget's theme, not input events.
3164 * @note Not to be confused with @c
3165 * edje_object_signal_callback_add(), which does the same as
3166 * elm_object_signal_callback_add(), but directly on an Edje
3169 * @note Not to be confused with @c
3170 * evas_object_smart_callback_add(), which adds callbacks to smart
3171 * objects' <b>smart events</b>, and not input events.
3173 * @see elm_object_event_callback_del()
3177 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3180 * Remove an event callback from a widget.
3182 * This function removes a callback, previoulsy attached to event emission
3184 * The parameters func and data must match exactly those passed to
3185 * a previous call to elm_object_event_callback_add(). The data pointer that
3186 * was passed to this call will be returned.
3188 * @param obj The object
3189 * @param func The callback function to be executed when the event is
3191 * @param data Data to pass in to the callback function.
3192 * @return The data pointer
3195 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3198 * Adjust size of an element for finger usage.
3200 * @param times_w How many fingers should fit horizontally
3201 * @param w Pointer to the width size to adjust
3202 * @param times_h How many fingers should fit vertically
3203 * @param h Pointer to the height size to adjust
3205 * This takes width and height sizes (in pixels) as input and a
3206 * size multiple (which is how many fingers you want to place
3207 * within the area, being "finger" the size set by
3208 * elm_finger_size_set()), and adjusts the size to be large enough
3209 * to accommodate the resulting size -- if it doesn't already
3210 * accommodate it. On return the @p w and @p h sizes pointed to by
3211 * these parameters will be modified, on those conditions.
3213 * @note This is kind of a low level Elementary call, most useful
3214 * on size evaluation times for widgets. An external user wouldn't
3215 * be calling, most of the time.
3219 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3222 * Get the duration for occuring long press event.
3224 * @return Timeout for long press event
3225 * @ingroup Longpress
3227 EAPI double elm_longpress_timeout_get(void);
3230 * Set the duration for occuring long press event.
3232 * @param lonpress_timeout Timeout for long press event
3233 * @ingroup Longpress
3235 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3238 * @defgroup Debug Debug
3239 * don't use it unless you are sure
3245 * Print Tree object hierarchy in stdout
3247 * @param obj The root object
3250 EAPI void elm_object_tree_dump(const Evas_Object *top);
3251 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3253 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3254 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3256 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3258 * @param obj The root object
3259 * @param file The path of output file
3262 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3269 * @defgroup Theme Theme
3271 * Elementary uses Edje to theme its widgets, naturally. But for the most
3272 * part this is hidden behind a simpler interface that lets the user set
3273 * extensions and choose the style of widgets in a much easier way.
3275 * Instead of thinking in terms of paths to Edje files and their groups
3276 * each time you want to change the appearance of a widget, Elementary
3277 * works so you can add any theme file with extensions or replace the
3278 * main theme at one point in the application, and then just set the style
3279 * of widgets with elm_object_style_set() and related functions. Elementary
3280 * will then look in its list of themes for a matching group and apply it,
3281 * and when the theme changes midway through the application, all widgets
3282 * will be updated accordingly.
3284 * There are three concepts you need to know to understand how Elementary
3285 * theming works: default theme, extensions and overlays.
3287 * Default theme, obviously enough, is the one that provides the default
3288 * look of all widgets. End users can change the theme used by Elementary
3289 * by setting the @c ELM_THEME environment variable before running an
3290 * application, or globally for all programs using the @c elementary_config
3291 * utility. Applications can change the default theme using elm_theme_set(),
3292 * but this can go against the user wishes, so it's not an adviced practice.
3294 * Ideally, applications should find everything they need in the already
3295 * provided theme, but there may be occasions when that's not enough and
3296 * custom styles are required to correctly express the idea. For this
3297 * cases, Elementary has extensions.
3299 * Extensions allow the application developer to write styles of its own
3300 * to apply to some widgets. This requires knowledge of how each widget
3301 * is themed, as extensions will always replace the entire group used by
3302 * the widget, so important signals and parts need to be there for the
3303 * object to behave properly (see documentation of Edje for details).
3304 * Once the theme for the extension is done, the application needs to add
3305 * it to the list of themes Elementary will look into, using
3306 * elm_theme_extension_add(), and set the style of the desired widgets as
3307 * he would normally with elm_object_style_set().
3309 * Overlays, on the other hand, can replace the look of all widgets by
3310 * overriding the default style. Like extensions, it's up to the application
3311 * developer to write the theme for the widgets it wants, the difference
3312 * being that when looking for the theme, Elementary will check first the
3313 * list of overlays, then the set theme and lastly the list of extensions,
3314 * so with overlays it's possible to replace the default view and every
3315 * widget will be affected. This is very much alike to setting the whole
3316 * theme for the application and will probably clash with the end user
3317 * options, not to mention the risk of ending up with not matching styles
3318 * across the program. Unless there's a very special reason to use them,
3319 * overlays should be avoided for the resons exposed before.
3321 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3322 * keeps one default internally and every function that receives one of
3323 * these can be called with NULL to refer to this default (except for
3324 * elm_theme_free()). It's possible to create a new instance of a
3325 * ::Elm_Theme to set other theme for a specific widget (and all of its
3326 * children), but this is as discouraged, if not even more so, than using
3327 * overlays. Don't use this unless you really know what you are doing.
3329 * But to be less negative about things, you can look at the following
3331 * @li @ref theme_example_01 "Using extensions"
3332 * @li @ref theme_example_02 "Using overlays"
3337 * @typedef Elm_Theme
3339 * Opaque handler for the list of themes Elementary looks for when
3340 * rendering widgets.
3342 * Stay out of this unless you really know what you are doing. For most
3343 * cases, sticking to the default is all a developer needs.
3345 typedef struct _Elm_Theme Elm_Theme;
3348 * Create a new specific theme
3350 * This creates an empty specific theme that only uses the default theme. A
3351 * specific theme has its own private set of extensions and overlays too
3352 * (which are empty by default). Specific themes do not fall back to themes
3353 * of parent objects. They are not intended for this use. Use styles, overlays
3354 * and extensions when needed, but avoid specific themes unless there is no
3355 * other way (example: you want to have a preview of a new theme you are
3356 * selecting in a "theme selector" window. The preview is inside a scroller
3357 * and should display what the theme you selected will look like, but not
3358 * actually apply it yet. The child of the scroller will have a specific
3359 * theme set to show this preview before the user decides to apply it to all
3362 EAPI Elm_Theme *elm_theme_new(void);
3364 * Free a specific theme
3366 * @param th The theme to free
3368 * This frees a theme created with elm_theme_new().
3370 EAPI void elm_theme_free(Elm_Theme *th);
3372 * Copy the theme fom the source to the destination theme
3374 * @param th The source theme to copy from
3375 * @param thdst The destination theme to copy data to
3377 * This makes a one-time static copy of all the theme config, extensions
3378 * and overlays from @p th to @p thdst. If @p th references a theme, then
3379 * @p thdst is also set to reference it, with all the theme settings,
3380 * overlays and extensions that @p th had.
3382 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3384 * Tell the source theme to reference the ref theme
3386 * @param th The theme that will do the referencing
3387 * @param thref The theme that is the reference source
3389 * This clears @p th to be empty and then sets it to refer to @p thref
3390 * so @p th acts as an override to @p thref, but where its overrides
3391 * don't apply, it will fall through to @p thref for configuration.
3393 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3395 * Return the theme referred to
3397 * @param th The theme to get the reference from
3398 * @return The referenced theme handle
3400 * This gets the theme set as the reference theme by elm_theme_ref_set().
3401 * If no theme is set as a reference, NULL is returned.
3403 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3405 * Return the default theme
3407 * @return The default theme handle
3409 * This returns the internal default theme setup handle that all widgets
3410 * use implicitly unless a specific theme is set. This is also often use
3411 * as a shorthand of NULL.
3413 EAPI Elm_Theme *elm_theme_default_get(void);
3415 * Prepends a theme overlay to the list of overlays
3417 * @param th The theme to add to, or if NULL, the default theme
3418 * @param item The Edje file path to be used
3420 * Use this if your application needs to provide some custom overlay theme
3421 * (An Edje file that replaces some default styles of widgets) where adding
3422 * new styles, or changing system theme configuration is not possible. Do
3423 * NOT use this instead of a proper system theme configuration. Use proper
3424 * configuration files, profiles, environment variables etc. to set a theme
3425 * so that the theme can be altered by simple confiugration by a user. Using
3426 * this call to achieve that effect is abusing the API and will create lots
3429 * @see elm_theme_extension_add()
3431 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3433 * Delete a theme overlay from the list of overlays
3435 * @param th The theme to delete from, or if NULL, the default theme
3436 * @param item The name of the theme overlay
3438 * @see elm_theme_overlay_add()
3440 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3442 * Appends a theme extension to the list of extensions.
3444 * @param th The theme to add to, or if NULL, the default theme
3445 * @param item The Edje file path to be used
3447 * This is intended when an application needs more styles of widgets or new
3448 * widget themes that the default does not provide (or may not provide). The
3449 * application has "extended" usage by coming up with new custom style names
3450 * for widgets for specific uses, but as these are not "standard", they are
3451 * not guaranteed to be provided by a default theme. This means the
3452 * application is required to provide these extra elements itself in specific
3453 * Edje files. This call adds one of those Edje files to the theme search
3454 * path to be search after the default theme. The use of this call is
3455 * encouraged when default styles do not meet the needs of the application.
3456 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3458 * @see elm_object_style_set()
3460 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3462 * Deletes a theme extension from the list of extensions.
3464 * @param th The theme to delete from, or if NULL, the default theme
3465 * @param item The name of the theme extension
3467 * @see elm_theme_extension_add()
3469 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3471 * Set the theme search order for the given theme
3473 * @param th The theme to set the search order, or if NULL, the default theme
3474 * @param theme Theme search string
3476 * This sets the search string for the theme in path-notation from first
3477 * theme to search, to last, delimited by the : character. Example:
3479 * "shiny:/path/to/file.edj:default"
3481 * See the ELM_THEME environment variable for more information.
3483 * @see elm_theme_get()
3484 * @see elm_theme_list_get()
3486 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3488 * Return the theme search order
3490 * @param th The theme to get the search order, or if NULL, the default theme
3491 * @return The internal search order path
3493 * This function returns a colon separated string of theme elements as
3494 * returned by elm_theme_list_get().
3496 * @see elm_theme_set()
3497 * @see elm_theme_list_get()
3499 EAPI const char *elm_theme_get(Elm_Theme *th);
3501 * Return a list of theme elements to be used in a theme.
3503 * @param th Theme to get the list of theme elements from.
3504 * @return The internal list of theme elements
3506 * This returns the internal list of theme elements (will only be valid as
3507 * long as the theme is not modified by elm_theme_set() or theme is not
3508 * freed by elm_theme_free(). This is a list of strings which must not be
3509 * altered as they are also internal. If @p th is NULL, then the default
3510 * theme element list is returned.
3512 * A theme element can consist of a full or relative path to a .edj file,
3513 * or a name, without extension, for a theme to be searched in the known
3514 * theme paths for Elemementary.
3516 * @see elm_theme_set()
3517 * @see elm_theme_get()
3519 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3521 * Return the full patrh for a theme element
3523 * @param f The theme element name
3524 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3525 * @return The full path to the file found.
3527 * This returns a string you should free with free() on success, NULL on
3528 * failure. This will search for the given theme element, and if it is a
3529 * full or relative path element or a simple searchable name. The returned
3530 * path is the full path to the file, if searched, and the file exists, or it
3531 * is simply the full path given in the element or a resolved path if
3532 * relative to home. The @p in_search_path boolean pointed to is set to
3533 * EINA_TRUE if the file was a searchable file andis in the search path,
3534 * and EINA_FALSE otherwise.
3536 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3538 * Flush the current theme.
3540 * @param th Theme to flush
3542 * This flushes caches that let elementary know where to find theme elements
3543 * in the given theme. If @p th is NULL, then the default theme is flushed.
3544 * Call this function if source theme data has changed in such a way as to
3545 * make any caches Elementary kept invalid.
3547 EAPI void elm_theme_flush(Elm_Theme *th);
3549 * This flushes all themes (default and specific ones).
3551 * This will flush all themes in the current application context, by calling
3552 * elm_theme_flush() on each of them.
3554 EAPI void elm_theme_full_flush(void);
3556 * Set the theme for all elementary using applications on the current display
3558 * @param theme The name of the theme to use. Format same as the ELM_THEME
3559 * environment variable.
3561 EAPI void elm_theme_all_set(const char *theme);
3563 * Return a list of theme elements in the theme search path
3565 * @return A list of strings that are the theme element names.
3567 * This lists all available theme files in the standard Elementary search path
3568 * for theme elements, and returns them in alphabetical order as theme
3569 * element names in a list of strings. Free this with
3570 * elm_theme_name_available_list_free() when you are done with the list.
3572 EAPI Eina_List *elm_theme_name_available_list_new(void);
3574 * Free the list returned by elm_theme_name_available_list_new()
3576 * This frees the list of themes returned by
3577 * elm_theme_name_available_list_new(). Once freed the list should no longer
3578 * be used. a new list mys be created.
3580 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3582 * Set a specific theme to be used for this object and its children
3584 * @param obj The object to set the theme on
3585 * @param th The theme to set
3587 * This sets a specific theme that will be used for the given object and any
3588 * child objects it has. If @p th is NULL then the theme to be used is
3589 * cleared and the object will inherit its theme from its parent (which
3590 * ultimately will use the default theme if no specific themes are set).
3592 * Use special themes with great care as this will annoy users and make
3593 * configuration difficult. Avoid any custom themes at all if it can be
3596 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3598 * Get the specific theme to be used
3600 * @param obj The object to get the specific theme from
3601 * @return The specifc theme set.
3603 * This will return a specific theme set, or NULL if no specific theme is
3604 * set on that object. It will not return inherited themes from parents, only
3605 * the specific theme set for that specific object. See elm_object_theme_set()
3606 * for more information.
3608 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3611 * Get a data item from a theme
3613 * @param th The theme, or NULL for default theme
3614 * @param key The data key to search with
3615 * @return The data value, or NULL on failure
3617 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3618 * It works the same way as edje_file_data_get() except that the return is stringshared.
3620 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3626 /** @defgroup Win Win
3628 * @image html img/widget/win/preview-00.png
3629 * @image latex img/widget/win/preview-00.eps
3631 * The window class of Elementary. Contains functions to manipulate
3632 * windows. The Evas engine used to render the window contents is specified
3633 * in the system or user elementary config files (whichever is found last),
3634 * and can be overridden with the ELM_ENGINE environment variable for
3635 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3636 * compilation setup and modules actually installed at runtime) are (listed
3637 * in order of best supported and most likely to be complete and work to
3640 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3641 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3643 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3645 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3647 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3649 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3650 * rendering using SDL as the buffer)
3651 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3652 * GDI with software)
3653 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3654 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3655 * grayscale using dedicated 8bit software engine in X11)
3656 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3657 * X11 using 16bit software engine)
3658 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3659 * (Windows CE rendering via GDI with 16bit software renderer)
3660 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3661 * buffer with 16bit software renderer)
3662 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3663 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3664 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3666 * All engines use a simple string to select the engine to render, EXCEPT
3667 * the "shot" engine. This actually encodes the output of the virtual
3668 * screenshot and how long to delay in the engine string. The engine string
3669 * is encoded in the following way:
3671 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3673 * Where options are separated by a ":" char if more than one option is
3674 * given, with delay, if provided being the first option and file the last
3675 * (order is important). The delay specifies how long to wait after the
3676 * window is shown before doing the virtual "in memory" rendering and then
3677 * save the output to the file specified by the file option (and then exit).
3678 * If no delay is given, the default is 0.5 seconds. If no file is given the
3679 * default output file is "out.png". Repeat option is for continous
3680 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3681 * fixed to "out001.png" Some examples of using the shot engine:
3683 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3684 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3685 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3686 * ELM_ENGINE="shot:delay=2.0" elementary_test
3687 * ELM_ENGINE="shot:" elementary_test
3689 * Signals that you can add callbacks for are:
3691 * @li "delete,request": the user requested to close the window. See
3692 * elm_win_autodel_set().
3693 * @li "focus,in": window got focus
3694 * @li "focus,out": window lost focus
3695 * @li "moved": window that holds the canvas was moved
3698 * @li @ref win_example_01
3703 * Defines the types of window that can be created
3705 * These are hints set on the window so that a running Window Manager knows
3706 * how the window should be handled and/or what kind of decorations it
3709 * Currently, only the X11 backed engines use them.
3711 typedef enum _Elm_Win_Type
3713 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3714 window. Almost every window will be created with this
3716 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3717 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3718 window holding desktop icons. */
3719 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3720 be kept on top of any other window by the Window
3722 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3724 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3725 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3727 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3728 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3729 entry in a menubar is clicked. Typically used
3730 with elm_win_override_set(). This hint exists
3731 for completion only, as the EFL way of
3732 implementing a menu would not normally use a
3733 separate window for its contents. */
3734 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3735 triggered by right-clicking an object. */
3736 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3737 explanatory text that typically appear after the
3738 mouse cursor hovers over an object for a while.
3739 Typically used with elm_win_override_set() and also
3740 not very commonly used in the EFL. */
3741 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3742 battery life or a new E-Mail received. */
3743 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3744 usually used in the EFL. */
3745 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3746 object being dragged across different windows, or even
3747 applications. Typically used with
3748 elm_win_override_set(). */
3749 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3750 buffer. No actual window is created for this
3751 type, instead the window and all of its
3752 contents will be rendered to an image buffer.
3753 This allows to have children window inside a
3754 parent one just like any other object would
3755 be, and do other things like applying @c
3756 Evas_Map effects to it. This is the only type
3757 of window that requires the @c parent
3758 parameter of elm_win_add() to be a valid @c
3763 * The differents layouts that can be requested for the virtual keyboard.
3765 * When the application window is being managed by Illume, it may request
3766 * any of the following layouts for the virtual keyboard.
3768 typedef enum _Elm_Win_Keyboard_Mode
3770 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3771 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3772 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3773 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3774 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3775 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3776 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3777 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3778 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3779 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3780 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3781 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3782 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3783 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3784 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3785 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3786 } Elm_Win_Keyboard_Mode;
3789 * Available commands that can be sent to the Illume manager.
3791 * When running under an Illume session, a window may send commands to the
3792 * Illume manager to perform different actions.
3794 typedef enum _Elm_Illume_Command
3796 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3798 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3800 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3802 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3803 } Elm_Illume_Command;
3806 * Adds a window object. If this is the first window created, pass NULL as
3809 * @param parent Parent object to add the window to, or NULL
3810 * @param name The name of the window
3811 * @param type The window type, one of #Elm_Win_Type.
3813 * The @p parent paramter can be @c NULL for every window @p type except
3814 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3815 * which the image object will be created.
3817 * @return The created object, or NULL on failure
3819 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3821 * Adds a window object with standard setup
3823 * @param name The name of the window
3824 * @param title The title for the window
3826 * This creates a window like elm_win_add() but also puts in a standard
3827 * background with elm_bg_add(), as well as setting the window title to
3828 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3829 * as the parent widget.
3831 * @return The created object, or NULL on failure
3833 * @see elm_win_add()
3835 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3837 * Add @p subobj as a resize object of window @p obj.
3840 * Setting an object as a resize object of the window means that the
3841 * @p subobj child's size and position will be controlled by the window
3842 * directly. That is, the object will be resized to match the window size
3843 * and should never be moved or resized manually by the developer.
3845 * In addition, resize objects of the window control what the minimum size
3846 * of it will be, as well as whether it can or not be resized by the user.
3848 * For the end user to be able to resize a window by dragging the handles
3849 * or borders provided by the Window Manager, or using any other similar
3850 * mechanism, all of the resize objects in the window should have their
3851 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3853 * @param obj The window object
3854 * @param subobj The resize object to add
3856 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3858 * Delete @p subobj as a resize object of window @p obj.
3860 * This function removes the object @p subobj from the resize objects of
3861 * the window @p obj. It will not delete the object itself, which will be
3862 * left unmanaged and should be deleted by the developer, manually handled
3863 * or set as child of some other container.
3865 * @param obj The window object
3866 * @param subobj The resize object to add
3868 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3870 * Set the title of the window
3872 * @param obj The window object
3873 * @param title The title to set
3875 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3877 * Get the title of the window
3879 * The returned string is an internal one and should not be freed or
3880 * modified. It will also be rendered invalid if a new title is set or if
3881 * the window is destroyed.
3883 * @param obj The window object
3886 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3888 * Set the window's autodel state.
3890 * When closing the window in any way outside of the program control, like
3891 * pressing the X button in the titlebar or using a command from the
3892 * Window Manager, a "delete,request" signal is emitted to indicate that
3893 * this event occurred and the developer can take any action, which may
3894 * include, or not, destroying the window object.
3896 * When the @p autodel parameter is set, the window will be automatically
3897 * destroyed when this event occurs, after the signal is emitted.
3898 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3899 * and is up to the program to do so when it's required.
3901 * @param obj The window object
3902 * @param autodel If true, the window will automatically delete itself when
3905 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3907 * Get the window's autodel state.
3909 * @param obj The window object
3910 * @return If the window will automatically delete itself when closed
3912 * @see elm_win_autodel_set()
3914 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3916 * Activate a window object.
3918 * This function sends a request to the Window Manager to activate the
3919 * window pointed by @p obj. If honored by the WM, the window will receive
3920 * the keyboard focus.
3922 * @note This is just a request that a Window Manager may ignore, so calling
3923 * this function does not ensure in any way that the window will be the
3924 * active one after it.
3926 * @param obj The window object
3928 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3930 * Lower a window object.
3932 * Places the window pointed by @p obj at the bottom of the stack, so that
3933 * no other window is covered by it.
3935 * If elm_win_override_set() is not set, the Window Manager may ignore this
3938 * @param obj The window object
3940 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3942 * Raise a window object.
3944 * Places the window pointed by @p obj at the top of the stack, so that it's
3945 * not covered by any other window.
3947 * If elm_win_override_set() is not set, the Window Manager may ignore this
3950 * @param obj The window object
3952 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3954 * Set the borderless state of a window.
3956 * This function requests the Window Manager to not draw any decoration
3957 * around the window.
3959 * @param obj The window object
3960 * @param borderless If true, the window is borderless
3962 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3964 * Get the borderless state of a window.
3966 * @param obj The window object
3967 * @return If true, the window is borderless
3969 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3971 * Set the shaped state of a window.
3973 * Shaped windows, when supported, will render the parts of the window that
3974 * has no content, transparent.
3976 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3977 * background object or cover the entire window in any other way, or the
3978 * parts of the canvas that have no data will show framebuffer artifacts.
3980 * @param obj The window object
3981 * @param shaped If true, the window is shaped
3983 * @see elm_win_alpha_set()
3985 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3987 * Get the shaped state of a window.
3989 * @param obj The window object
3990 * @return If true, the window is shaped
3992 * @see elm_win_shaped_set()
3994 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3996 * Set the alpha channel state of a window.
3998 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3999 * possibly making parts of the window completely or partially transparent.
4000 * This is also subject to the underlying system supporting it, like for
4001 * example, running under a compositing manager. If no compositing is
4002 * available, enabling this option will instead fallback to using shaped
4003 * windows, with elm_win_shaped_set().
4005 * @param obj The window object
4006 * @param alpha If true, the window has an alpha channel
4008 * @see elm_win_alpha_set()
4010 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4012 * Get the transparency state of a window.
4014 * @param obj The window object
4015 * @return If true, the window is transparent
4017 * @see elm_win_transparent_set()
4019 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4021 * Set the transparency state of a window.
4023 * Use elm_win_alpha_set() instead.
4025 * @param obj The window object
4026 * @param transparent If true, the window is transparent
4028 * @see elm_win_alpha_set()
4030 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4032 * Get the alpha channel state of a window.
4034 * @param obj The window object
4035 * @return If true, the window has an alpha channel
4037 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4039 * Set the override state of a window.
4041 * A window with @p override set to EINA_TRUE will not be managed by the
4042 * Window Manager. This means that no decorations of any kind will be shown
4043 * for it, moving and resizing must be handled by the application, as well
4044 * as the window visibility.
4046 * This should not be used for normal windows, and even for not so normal
4047 * ones, it should only be used when there's a good reason and with a lot
4048 * of care. Mishandling override windows may result situations that
4049 * disrupt the normal workflow of the end user.
4051 * @param obj The window object
4052 * @param override If true, the window is overridden
4054 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4056 * Get the override state of a window.
4058 * @param obj The window object
4059 * @return If true, the window is overridden
4061 * @see elm_win_override_set()
4063 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4065 * Set the fullscreen state of a window.
4067 * @param obj The window object
4068 * @param fullscreen If true, the window is fullscreen
4070 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4072 * Get the fullscreen state of a window.
4074 * @param obj The window object
4075 * @return If true, the window is fullscreen
4077 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4079 * Set the maximized state of a window.
4081 * @param obj The window object
4082 * @param maximized If true, the window is maximized
4084 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4086 * Get the maximized state of a window.
4088 * @param obj The window object
4089 * @return If true, the window is maximized
4091 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4093 * Set the iconified state of a window.
4095 * @param obj The window object
4096 * @param iconified If true, the window is iconified
4098 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4100 * Get the iconified state of a window.
4102 * @param obj The window object
4103 * @return If true, the window is iconified
4105 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4107 * Set the layer of the window.
4109 * What this means exactly will depend on the underlying engine used.
4111 * In the case of X11 backed engines, the value in @p layer has the
4112 * following meanings:
4113 * @li < 3: The window will be placed below all others.
4114 * @li > 5: The window will be placed above all others.
4115 * @li other: The window will be placed in the default layer.
4117 * @param obj The window object
4118 * @param layer The layer of the window
4120 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4122 * Get the layer of the window.
4124 * @param obj The window object
4125 * @return The layer of the window
4127 * @see elm_win_layer_set()
4129 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4131 * Set the rotation of the window.
4133 * Most engines only work with multiples of 90.
4135 * This function is used to set the orientation of the window @p obj to
4136 * match that of the screen. The window itself will be resized to adjust
4137 * to the new geometry of its contents. If you want to keep the window size,
4138 * see elm_win_rotation_with_resize_set().
4140 * @param obj The window object
4141 * @param rotation The rotation of the window, in degrees (0-360),
4142 * counter-clockwise.
4144 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4146 * Rotates the window and resizes it.
4148 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4149 * that they fit inside the current window geometry.
4151 * @param obj The window object
4152 * @param layer The rotation of the window in degrees (0-360),
4153 * counter-clockwise.
4155 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4157 * Get the rotation of the window.
4159 * @param obj The window object
4160 * @return The rotation of the window in degrees (0-360)
4162 * @see elm_win_rotation_set()
4163 * @see elm_win_rotation_with_resize_set()
4165 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4167 * Set the sticky state of the window.
4169 * Hints the Window Manager that the window in @p obj should be left fixed
4170 * at its position even when the virtual desktop it's on moves or changes.
4172 * @param obj The window object
4173 * @param sticky If true, the window's sticky state is enabled
4175 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4177 * Get the sticky state of the window.
4179 * @param obj The window object
4180 * @return If true, the window's sticky state is enabled
4182 * @see elm_win_sticky_set()
4184 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4186 * Set if this window is an illume conformant window
4188 * @param obj The window object
4189 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4191 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4193 * Get if this window is an illume conformant window
4195 * @param obj The window object
4196 * @return A boolean if this window is illume conformant or not
4198 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4200 * Set a window to be an illume quickpanel window
4202 * By default window objects are not quickpanel windows.
4204 * @param obj The window object
4205 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4207 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4209 * Get if this window is a quickpanel or not
4211 * @param obj The window object
4212 * @return A boolean if this window is a quickpanel or not
4214 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4216 * Set the major priority of a quickpanel window
4218 * @param obj The window object
4219 * @param priority The major priority for this quickpanel
4221 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4223 * Get the major priority of a quickpanel window
4225 * @param obj The window object
4226 * @return The major priority of this quickpanel
4228 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4230 * Set the minor priority of a quickpanel window
4232 * @param obj The window object
4233 * @param priority The minor priority for this quickpanel
4235 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4237 * Get the minor priority of a quickpanel window
4239 * @param obj The window object
4240 * @return The minor priority of this quickpanel
4242 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4244 * Set which zone this quickpanel should appear in
4246 * @param obj The window object
4247 * @param zone The requested zone for this quickpanel
4249 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4251 * Get which zone this quickpanel should appear in
4253 * @param obj The window object
4254 * @return The requested zone for this quickpanel
4256 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4258 * Set the window to be skipped by keyboard focus
4260 * This sets the window to be skipped by normal keyboard input. This means
4261 * a window manager will be asked to not focus this window as well as omit
4262 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4264 * Call this and enable it on a window BEFORE you show it for the first time,
4265 * otherwise it may have no effect.
4267 * Use this for windows that have only output information or might only be
4268 * interacted with by the mouse or fingers, and never for typing input.
4269 * Be careful that this may have side-effects like making the window
4270 * non-accessible in some cases unless the window is specially handled. Use
4273 * @param obj The window object
4274 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4276 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4278 * Send a command to the windowing environment
4280 * This is intended to work in touchscreen or small screen device
4281 * environments where there is a more simplistic window management policy in
4282 * place. This uses the window object indicated to select which part of the
4283 * environment to control (the part that this window lives in), and provides
4284 * a command and an optional parameter structure (use NULL for this if not
4287 * @param obj The window object that lives in the environment to control
4288 * @param command The command to send
4289 * @param params Optional parameters for the command
4291 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4293 * Get the inlined image object handle
4295 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4296 * then the window is in fact an evas image object inlined in the parent
4297 * canvas. You can get this object (be careful to not manipulate it as it
4298 * is under control of elementary), and use it to do things like get pixel
4299 * data, save the image to a file, etc.
4301 * @param obj The window object to get the inlined image from
4302 * @return The inlined image object, or NULL if none exists
4304 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4306 * Set the enabled status for the focus highlight in a window
4308 * This function will enable or disable the focus highlight only for the
4309 * given window, regardless of the global setting for it
4311 * @param obj The window where to enable the highlight
4312 * @param enabled The enabled value for the highlight
4314 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4316 * Get the enabled value of the focus highlight for this window
4318 * @param obj The window in which to check if the focus highlight is enabled
4320 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4322 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4324 * Set the style for the focus highlight on this window
4326 * Sets the style to use for theming the highlight of focused objects on
4327 * the given window. If @p style is NULL, the default will be used.
4329 * @param obj The window where to set the style
4330 * @param style The style to set
4332 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4334 * Get the style set for the focus highlight object
4336 * Gets the style set for this windows highilght object, or NULL if none
4339 * @param obj The window to retrieve the highlights style from
4341 * @return The style set or NULL if none was. Default is used in that case.
4343 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4344 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4345 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4347 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4348 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4349 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4350 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4351 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4352 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4353 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4355 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4356 * (blank mouse, private mouse obj, defaultmouse)
4360 * Sets the keyboard mode of the window.
4362 * @param obj The window object
4363 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4365 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4367 * Gets the keyboard mode of the window.
4369 * @param obj The window object
4370 * @return The mode, one of #Elm_Win_Keyboard_Mode
4372 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4374 * Sets whether the window is a keyboard.
4376 * @param obj The window object
4377 * @param is_keyboard If true, the window is a virtual keyboard
4379 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4381 * Gets whether the window is a keyboard.
4383 * @param obj The window object
4384 * @return If the window is a virtual keyboard
4386 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4389 * Get the screen position of a window.
4391 * @param obj The window object
4392 * @param x The int to store the x coordinate to
4393 * @param y The int to store the y coordinate to
4395 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4401 * @defgroup Inwin Inwin
4403 * @image html img/widget/inwin/preview-00.png
4404 * @image latex img/widget/inwin/preview-00.eps
4405 * @image html img/widget/inwin/preview-01.png
4406 * @image latex img/widget/inwin/preview-01.eps
4407 * @image html img/widget/inwin/preview-02.png
4408 * @image latex img/widget/inwin/preview-02.eps
4410 * An inwin is a window inside a window that is useful for a quick popup.
4411 * It does not hover.
4413 * It works by creating an object that will occupy the entire window, so it
4414 * must be created using an @ref Win "elm_win" as parent only. The inwin
4415 * object can be hidden or restacked below every other object if it's
4416 * needed to show what's behind it without destroying it. If this is done,
4417 * the elm_win_inwin_activate() function can be used to bring it back to
4418 * full visibility again.
4420 * There are three styles available in the default theme. These are:
4421 * @li default: The inwin is sized to take over most of the window it's
4423 * @li minimal: The size of the inwin will be the minimum necessary to show
4425 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4426 * possible, but it's sized vertically the most it needs to fit its\
4429 * Some examples of Inwin can be found in the following:
4430 * @li @ref inwin_example_01
4435 * Adds an inwin to the current window
4437 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4438 * Never call this function with anything other than the top-most window
4439 * as its parameter, unless you are fond of undefined behavior.
4441 * After creating the object, the widget will set itself as resize object
4442 * for the window with elm_win_resize_object_add(), so when shown it will
4443 * appear to cover almost the entire window (how much of it depends on its
4444 * content and the style used). It must not be added into other container
4445 * objects and it needs not be moved or resized manually.
4447 * @param parent The parent object
4448 * @return The new object or NULL if it cannot be created
4450 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4452 * Activates an inwin object, ensuring its visibility
4454 * This function will make sure that the inwin @p obj is completely visible
4455 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4456 * to the front. It also sets the keyboard focus to it, which will be passed
4459 * The object's theme will also receive the signal "elm,action,show" with
4462 * @param obj The inwin to activate
4464 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4466 * Set the content of an inwin object.
4468 * Once the content object is set, a previously set one will be deleted.
4469 * If you want to keep that old content object, use the
4470 * elm_win_inwin_content_unset() function.
4472 * @param obj The inwin object
4473 * @param content The object to set as content
4475 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4477 * Get the content of an inwin object.
4479 * Return the content object which is set for this widget.
4481 * The returned object is valid as long as the inwin is still alive and no
4482 * other content is set on it. Deleting the object will notify the inwin
4483 * about it and this one will be left empty.
4485 * If you need to remove an inwin's content to be reused somewhere else,
4486 * see elm_win_inwin_content_unset().
4488 * @param obj The inwin object
4489 * @return The content that is being used
4491 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4493 * Unset the content of an inwin object.
4495 * Unparent and return the content object which was set for this widget.
4497 * @param obj The inwin object
4498 * @return The content that was being used
4500 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4504 /* X specific calls - won't work on non-x engines (return 0) */
4507 * Get the Ecore_X_Window of an Evas_Object
4509 * @param obj The object
4511 * @return The Ecore_X_Window of @p obj
4515 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4517 /* smart callbacks called:
4518 * "delete,request" - the user requested to delete the window
4519 * "focus,in" - window got focus
4520 * "focus,out" - window lost focus
4521 * "moved" - window that holds the canvas was moved
4527 * @image html img/widget/bg/preview-00.png
4528 * @image latex img/widget/bg/preview-00.eps
4530 * @brief Background object, used for setting a solid color, image or Edje
4531 * group as background to a window or any container object.
4533 * The bg object is used for setting a solid background to a window or
4534 * packing into any container object. It works just like an image, but has
4535 * some properties useful to a background, like setting it to tiled,
4536 * centered, scaled or stretched.
4538 * Default contents parts of the bg widget that you can use for are:
4539 * @li "elm.swallow.content" - overlay of the bg
4541 * Here is some sample code using it:
4542 * @li @ref bg_01_example_page
4543 * @li @ref bg_02_example_page
4544 * @li @ref bg_03_example_page
4548 typedef enum _Elm_Bg_Option
4550 ELM_BG_OPTION_CENTER, /**< center the background */
4551 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4552 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4553 ELM_BG_OPTION_TILE /**< tile background at its original size */
4557 * Add a new background to the parent
4559 * @param parent The parent object
4560 * @return The new object or NULL if it cannot be created
4564 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4567 * Set the file (image or edje) used for the background
4569 * @param obj The bg object
4570 * @param file The file path
4571 * @param group Optional key (group in Edje) within the file
4573 * This sets the image file used in the background object. The image (or edje)
4574 * will be stretched (retaining aspect if its an image file) to completely fill
4575 * the bg object. This may mean some parts are not visible.
4577 * @note Once the image of @p obj is set, a previously set one will be deleted,
4578 * even if @p file is NULL.
4582 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4585 * Get the file (image or edje) used for the background
4587 * @param obj The bg object
4588 * @param file The file path
4589 * @param group Optional key (group in Edje) within the file
4593 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4596 * Set the option used for the background image
4598 * @param obj The bg object
4599 * @param option The desired background option (TILE, SCALE)
4601 * This sets the option used for manipulating the display of the background
4602 * image. The image can be tiled or scaled.
4606 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4609 * Get the option used for the background image
4611 * @param obj The bg object
4612 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4616 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4618 * Set the option used for the background color
4620 * @param obj The bg object
4625 * This sets the color used for the background rectangle. Its range goes
4630 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4632 * Get the option used for the background color
4634 * @param obj The bg object
4641 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4644 * Set the overlay object used for the background object.
4646 * @param obj The bg object
4647 * @param overlay The overlay object
4649 * This provides a way for elm_bg to have an 'overlay' that will be on top
4650 * of the bg. Once the over object is set, a previously set one will be
4651 * deleted, even if you set the new one to NULL. If you want to keep that
4652 * old content object, use the elm_bg_overlay_unset() function.
4654 * @deprecated use elm_object_content_set() instead
4659 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4662 * Get the overlay object used for the background object.
4664 * @param obj The bg object
4665 * @return The content that is being used
4667 * Return the content object which is set for this widget
4669 * @deprecated use elm_object_content_get() instead
4673 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4676 * Get the overlay object used for the background object.
4678 * @param obj The bg object
4679 * @return The content that was being used
4681 * Unparent and return the overlay object which was set for this widget
4683 * @deprecated use elm_object_content_unset() instead
4687 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4690 * Set the size of the pixmap representation of the image.
4692 * This option just makes sense if an image is going to be set in the bg.
4694 * @param obj The bg object
4695 * @param w The new width of the image pixmap representation.
4696 * @param h The new height of the image pixmap representation.
4698 * This function sets a new size for pixmap representation of the given bg
4699 * image. It allows the image to be loaded already in the specified size,
4700 * reducing the memory usage and load time when loading a big image with load
4701 * size set to a smaller size.
4703 * NOTE: this is just a hint, the real size of the pixmap may differ
4704 * depending on the type of image being loaded, being bigger than requested.
4708 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4709 /* smart callbacks called:
4713 * @defgroup Icon Icon
4715 * @image html img/widget/icon/preview-00.png
4716 * @image latex img/widget/icon/preview-00.eps
4718 * An object that provides standard icon images (delete, edit, arrows, etc.)
4719 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4721 * The icon image requested can be in the elementary theme, or in the
4722 * freedesktop.org paths. It's possible to set the order of preference from
4723 * where the image will be used.
4725 * This API is very similar to @ref Image, but with ready to use images.
4727 * Default images provided by the theme are described below.
4729 * The first list contains icons that were first intended to be used in
4730 * toolbars, but can be used in many other places too:
4746 * Now some icons that were designed to be used in menus (but again, you can
4747 * use them anywhere else):
4752 * @li menu/arrow_down
4753 * @li menu/arrow_left
4754 * @li menu/arrow_right
4763 * And here we have some media player specific icons:
4764 * @li media_player/forward
4765 * @li media_player/info
4766 * @li media_player/next
4767 * @li media_player/pause
4768 * @li media_player/play
4769 * @li media_player/prev
4770 * @li media_player/rewind
4771 * @li media_player/stop
4773 * Signals that you can add callbacks for are:
4775 * "clicked" - This is called when a user has clicked the icon
4777 * An example of usage for this API follows:
4778 * @li @ref tutorial_icon
4786 typedef enum _Elm_Icon_Type
4793 * @enum _Elm_Icon_Lookup_Order
4794 * @typedef Elm_Icon_Lookup_Order
4796 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4797 * theme, FDO paths, or both?
4801 typedef enum _Elm_Icon_Lookup_Order
4803 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4804 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4805 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4806 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4807 } Elm_Icon_Lookup_Order;
4810 * Add a new icon object to the parent.
4812 * @param parent The parent object
4813 * @return The new object or NULL if it cannot be created
4815 * @see elm_icon_file_set()
4819 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4821 * Set the file that will be used as icon.
4823 * @param obj The icon object
4824 * @param file The path to file that will be used as icon image
4825 * @param group The group that the icon belongs to an edje file
4827 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4829 * @note The icon image set by this function can be changed by
4830 * elm_icon_standard_set().
4832 * @see elm_icon_file_get()
4836 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4838 * Set a location in memory to be used as an icon
4840 * @param obj The icon object
4841 * @param img The binary data that will be used as an image
4842 * @param size The size of binary data @p img
4843 * @param format Optional format of @p img to pass to the image loader
4844 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4846 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4848 * @note The icon image set by this function can be changed by
4849 * elm_icon_standard_set().
4853 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);
4855 * Get the file that will be used as icon.
4857 * @param obj The icon object
4858 * @param file The path to file that will be used as the icon image
4859 * @param group The group that the icon belongs to, in edje file
4861 * @see elm_icon_file_set()
4865 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4866 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4868 * Set the icon by icon standards names.
4870 * @param obj The icon object
4871 * @param name The icon name
4873 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4875 * For example, freedesktop.org defines standard icon names such as "home",
4876 * "network", etc. There can be different icon sets to match those icon
4877 * keys. The @p name given as parameter is one of these "keys", and will be
4878 * used to look in the freedesktop.org paths and elementary theme. One can
4879 * change the lookup order with elm_icon_order_lookup_set().
4881 * If name is not found in any of the expected locations and it is the
4882 * absolute path of an image file, this image will be used.
4884 * @note The icon image set by this function can be changed by
4885 * elm_icon_file_set().
4887 * @see elm_icon_standard_get()
4888 * @see elm_icon_file_set()
4892 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4894 * Get the icon name set by icon standard names.
4896 * @param obj The icon object
4897 * @return The icon name
4899 * If the icon image was set using elm_icon_file_set() instead of
4900 * elm_icon_standard_set(), then this function will return @c NULL.
4902 * @see elm_icon_standard_set()
4906 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4908 * Set the smooth scaling for an icon object.
4910 * @param obj The icon object
4911 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4912 * otherwise. Default is @c EINA_TRUE.
4914 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4915 * scaling provides a better resulting image, but is slower.
4917 * The smooth scaling should be disabled when making animations that change
4918 * the icon size, since they will be faster. Animations that don't require
4919 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4920 * is already scaled, since the scaled icon image will be cached).
4922 * @see elm_icon_smooth_get()
4926 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4928 * Get whether smooth scaling is enabled for an icon object.
4930 * @param obj The icon object
4931 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4933 * @see elm_icon_smooth_set()
4937 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4939 * Disable scaling of this object.
4941 * @param obj The icon object.
4942 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4943 * otherwise. Default is @c EINA_FALSE.
4945 * This function disables scaling of the icon object through the function
4946 * elm_object_scale_set(). However, this does not affect the object
4947 * size/resize in any way. For that effect, take a look at
4948 * elm_icon_scale_set().
4950 * @see elm_icon_no_scale_get()
4951 * @see elm_icon_scale_set()
4952 * @see elm_object_scale_set()
4956 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4958 * Get whether scaling is disabled on the object.
4960 * @param obj The icon object
4961 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4963 * @see elm_icon_no_scale_set()
4967 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4969 * Set if the object is (up/down) resizable.
4971 * @param obj The icon object
4972 * @param scale_up A bool to set if the object is resizable up. Default is
4974 * @param scale_down A bool to set if the object is resizable down. Default
4977 * This function limits the icon object resize ability. If @p scale_up is set to
4978 * @c EINA_FALSE, the object can't have its height or width resized to a value
4979 * higher than the original icon size. Same is valid for @p scale_down.
4981 * @see elm_icon_scale_get()
4985 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4987 * Get if the object is (up/down) resizable.
4989 * @param obj The icon object
4990 * @param scale_up A bool to set if the object is resizable up
4991 * @param scale_down A bool to set if the object is resizable down
4993 * @see elm_icon_scale_set()
4997 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4999 * Get the object's image size
5001 * @param obj The icon object
5002 * @param w A pointer to store the width in
5003 * @param h A pointer to store the height in
5007 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5009 * Set if the icon fill the entire object area.
5011 * @param obj The icon object
5012 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5013 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5015 * When the icon object is resized to a different aspect ratio from the
5016 * original icon image, the icon image will still keep its aspect. This flag
5017 * tells how the image should fill the object's area. They are: keep the
5018 * entire icon inside the limits of height and width of the object (@p
5019 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5020 * of the object, and the icon will fill the entire object (@p fill_outside
5023 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5024 * retain property to false. Thus, the icon image will always keep its
5025 * original aspect ratio.
5027 * @see elm_icon_fill_outside_get()
5028 * @see elm_image_fill_outside_set()
5032 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5034 * Get if the object is filled outside.
5036 * @param obj The icon object
5037 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5039 * @see elm_icon_fill_outside_set()
5043 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5045 * Set the prescale size for the icon.
5047 * @param obj The icon object
5048 * @param size The prescale size. This value is used for both width and
5051 * This function sets a new size for pixmap representation of the given
5052 * icon. It allows the icon to be loaded already in the specified size,
5053 * reducing the memory usage and load time when loading a big icon with load
5054 * size set to a smaller size.
5056 * It's equivalent to the elm_bg_load_size_set() function for bg.
5058 * @note this is just a hint, the real size of the pixmap may differ
5059 * depending on the type of icon being loaded, being bigger than requested.
5061 * @see elm_icon_prescale_get()
5062 * @see elm_bg_load_size_set()
5066 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5068 * Get the prescale size for the icon.
5070 * @param obj The icon object
5071 * @return The prescale size
5073 * @see elm_icon_prescale_set()
5077 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5079 * Gets the image object of the icon. DO NOT MODIFY THIS.
5081 * @param obj The icon object
5082 * @return The internal icon object
5086 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5088 * Sets the icon lookup order used by elm_icon_standard_set().
5090 * @param obj The icon object
5091 * @param order The icon lookup order (can be one of
5092 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5093 * or ELM_ICON_LOOKUP_THEME)
5095 * @see elm_icon_order_lookup_get()
5096 * @see Elm_Icon_Lookup_Order
5100 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5102 * Gets the icon lookup order.
5104 * @param obj The icon object
5105 * @return The icon lookup order
5107 * @see elm_icon_order_lookup_set()
5108 * @see Elm_Icon_Lookup_Order
5112 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5114 * Enable or disable preloading of the icon
5116 * @param obj The icon object
5117 * @param disable If EINA_TRUE, preloading will be disabled
5120 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5122 * Get if the icon supports animation or not.
5124 * @param obj The icon object
5125 * @return @c EINA_TRUE if the icon supports animation,
5126 * @c EINA_FALSE otherwise.
5128 * Return if this elm icon's image can be animated. Currently Evas only
5129 * supports gif animation. If the return value is EINA_FALSE, other
5130 * elm_icon_animated_XXX APIs won't work.
5133 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5135 * Set animation mode of the icon.
5137 * @param obj The icon object
5138 * @param anim @c EINA_TRUE if the object do animation job,
5139 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5141 * Since the default animation mode is set to EINA_FALSE,
5142 * the icon is shown without animation.
5143 * This might be desirable when the application developer wants to show
5144 * a snapshot of the animated icon.
5145 * Set it to EINA_TRUE when the icon needs to be animated.
5148 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5150 * Get animation mode of the icon.
5152 * @param obj The icon object
5153 * @return The animation mode of the icon object
5154 * @see elm_icon_animated_set
5157 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5159 * Set animation play mode of the icon.
5161 * @param obj The icon object
5162 * @param play @c EINA_TRUE the object play animation images,
5163 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5165 * To play elm icon's animation, set play to EINA_TURE.
5166 * For example, you make gif player using this set/get API and click event.
5168 * 1. Click event occurs
5169 * 2. Check play flag using elm_icon_animaged_play_get
5170 * 3. If elm icon was playing, set play to EINA_FALSE.
5171 * Then animation will be stopped and vice versa
5174 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5176 * Get animation play mode of the icon.
5178 * @param obj The icon object
5179 * @return The play mode of the icon object
5181 * @see elm_icon_animated_play_get
5184 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5186 /* compatibility code to avoid API and ABI breaks */
5187 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5189 elm_icon_animated_set(obj, animated);
5192 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5194 return elm_icon_animated_get(obj);
5197 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5199 elm_icon_animated_play_set(obj, play);
5202 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5204 return elm_icon_animated_play_get(obj);
5212 * @defgroup Image Image
5214 * @image html img/widget/image/preview-00.png
5215 * @image latex img/widget/image/preview-00.eps
5218 * An object that allows one to load an image file to it. It can be used
5219 * anywhere like any other elementary widget.
5221 * This widget provides most of the functionality provided from @ref Bg or @ref
5222 * Icon, but with a slightly different API (use the one that fits better your
5225 * The features not provided by those two other image widgets are:
5226 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5227 * @li change the object orientation with elm_image_orient_set();
5228 * @li and turning the image editable with elm_image_editable_set().
5230 * Signals that you can add callbacks for are:
5232 * @li @c "clicked" - This is called when a user has clicked the image
5234 * An example of usage for this API follows:
5235 * @li @ref tutorial_image
5244 * @enum _Elm_Image_Orient
5245 * @typedef Elm_Image_Orient
5247 * Possible orientation options for elm_image_orient_set().
5249 * @image html elm_image_orient_set.png
5250 * @image latex elm_image_orient_set.eps width=\textwidth
5254 typedef enum _Elm_Image_Orient
5256 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5257 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5258 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5259 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5260 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5261 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5262 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5263 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5267 * Add a new image to the parent.
5269 * @param parent The parent object
5270 * @return The new object or NULL if it cannot be created
5272 * @see elm_image_file_set()
5276 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5278 * Set the file that will be used as image.
5280 * @param obj The image object
5281 * @param file The path to file that will be used as image
5282 * @param group The group that the image belongs in edje file (if it's an
5285 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5287 * @see elm_image_file_get()
5291 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5293 * Get the file that will be used as image.
5295 * @param obj The image object
5296 * @param file The path to file
5297 * @param group The group that the image belongs in edje file
5299 * @see elm_image_file_set()
5303 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5305 * Set the smooth effect for an image.
5307 * @param obj The image object
5308 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5309 * otherwise. Default is @c EINA_TRUE.
5311 * Set the scaling algorithm to be used when scaling the image. Smooth
5312 * scaling provides a better resulting image, but is slower.
5314 * The smooth scaling should be disabled when making animations that change
5315 * the image size, since it will be faster. Animations that don't require
5316 * resizing of the image can keep the smooth scaling enabled (even if the
5317 * image is already scaled, since the scaled image will be cached).
5319 * @see elm_image_smooth_get()
5323 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5325 * Get the smooth effect for an image.
5327 * @param obj The image object
5328 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5330 * @see elm_image_smooth_get()
5334 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5337 * Gets the current size of the image.
5339 * @param obj The image object.
5340 * @param w Pointer to store width, or NULL.
5341 * @param h Pointer to store height, or NULL.
5343 * This is the real size of the image, not the size of the object.
5345 * On error, neither w or h will be written.
5349 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5351 * Disable scaling of this object.
5353 * @param obj The image object.
5354 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5355 * otherwise. Default is @c EINA_FALSE.
5357 * This function disables scaling of the elm_image widget through the
5358 * function elm_object_scale_set(). However, this does not affect the widget
5359 * size/resize in any way. For that effect, take a look at
5360 * elm_image_scale_set().
5362 * @see elm_image_no_scale_get()
5363 * @see elm_image_scale_set()
5364 * @see elm_object_scale_set()
5368 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5370 * Get whether scaling is disabled on the object.
5372 * @param obj The image object
5373 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5375 * @see elm_image_no_scale_set()
5379 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5381 * Set if the object is (up/down) resizable.
5383 * @param obj The image object
5384 * @param scale_up A bool to set if the object is resizable up. Default is
5386 * @param scale_down A bool to set if the object is resizable down. Default
5389 * This function limits the image resize ability. If @p scale_up is set to
5390 * @c EINA_FALSE, the object can't have its height or width resized to a value
5391 * higher than the original image size. Same is valid for @p scale_down.
5393 * @see elm_image_scale_get()
5397 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5399 * Get if the object is (up/down) resizable.
5401 * @param obj The image object
5402 * @param scale_up A bool to set if the object is resizable up
5403 * @param scale_down A bool to set if the object is resizable down
5405 * @see elm_image_scale_set()
5409 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5411 * Set if the image fills the entire object area, when keeping the aspect ratio.
5413 * @param obj The image object
5414 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5415 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5417 * When the image should keep its aspect ratio even if resized to another
5418 * aspect ratio, there are two possibilities to resize it: keep the entire
5419 * image inside the limits of height and width of the object (@p fill_outside
5420 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5421 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5423 * @note This option will have no effect if
5424 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5426 * @see elm_image_fill_outside_get()
5427 * @see elm_image_aspect_ratio_retained_set()
5431 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5433 * Get if the object is filled outside
5435 * @param obj The image object
5436 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5438 * @see elm_image_fill_outside_set()
5442 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5444 * Set the prescale size for the image
5446 * @param obj The image object
5447 * @param size The prescale size. This value is used for both width and
5450 * This function sets a new size for pixmap representation of the given
5451 * image. It allows the image to be loaded already in the specified size,
5452 * reducing the memory usage and load time when loading a big image with load
5453 * size set to a smaller size.
5455 * It's equivalent to the elm_bg_load_size_set() function for bg.
5457 * @note this is just a hint, the real size of the pixmap may differ
5458 * depending on the type of image being loaded, being bigger than requested.
5460 * @see elm_image_prescale_get()
5461 * @see elm_bg_load_size_set()
5465 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5467 * Get the prescale size for the image
5469 * @param obj The image object
5470 * @return The prescale size
5472 * @see elm_image_prescale_set()
5476 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5478 * Set the image orientation.
5480 * @param obj The image object
5481 * @param orient The image orientation @ref Elm_Image_Orient
5482 * Default is #ELM_IMAGE_ORIENT_NONE.
5484 * This function allows to rotate or flip the given image.
5486 * @see elm_image_orient_get()
5487 * @see @ref Elm_Image_Orient
5491 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5493 * Get the image orientation.
5495 * @param obj The image object
5496 * @return The image orientation @ref Elm_Image_Orient
5498 * @see elm_image_orient_set()
5499 * @see @ref Elm_Image_Orient
5503 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5505 * Make the image 'editable'.
5507 * @param obj Image object.
5508 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5510 * This means the image is a valid drag target for drag and drop, and can be
5511 * cut or pasted too.
5515 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5517 * Check if the image 'editable'.
5519 * @param obj Image object.
5520 * @return Editability.
5522 * A return value of EINA_TRUE means the image is a valid drag target
5523 * for drag and drop, and can be cut or pasted too.
5527 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5529 * Get the basic Evas_Image object from this object (widget).
5531 * @param obj The image object to get the inlined image from
5532 * @return The inlined image object, or NULL if none exists
5534 * This function allows one to get the underlying @c Evas_Object of type
5535 * Image from this elementary widget. It can be useful to do things like get
5536 * the pixel data, save the image to a file, etc.
5538 * @note Be careful to not manipulate it, as it is under control of
5543 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5545 * Set whether the original aspect ratio of the image should be kept on resize.
5547 * @param obj The image object.
5548 * @param retained @c EINA_TRUE if the image should retain the aspect,
5549 * @c EINA_FALSE otherwise.
5551 * The original aspect ratio (width / height) of the image is usually
5552 * distorted to match the object's size. Enabling this option will retain
5553 * this original aspect, and the way that the image is fit into the object's
5554 * area depends on the option set by elm_image_fill_outside_set().
5556 * @see elm_image_aspect_ratio_retained_get()
5557 * @see elm_image_fill_outside_set()
5561 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5563 * Get if the object retains the original aspect ratio.
5565 * @param obj The image object.
5566 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5571 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5578 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5580 /* old API compatibility */
5581 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5583 typedef enum _Elm_GLView_Mode
5585 ELM_GLVIEW_ALPHA = 1,
5586 ELM_GLVIEW_DEPTH = 2,
5587 ELM_GLVIEW_STENCIL = 4
5591 * Defines a policy for the glview resizing.
5593 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5595 typedef enum _Elm_GLView_Resize_Policy
5597 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5598 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5599 } Elm_GLView_Resize_Policy;
5601 typedef enum _Elm_GLView_Render_Policy
5603 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5604 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5605 } Elm_GLView_Render_Policy;
5610 * A simple GLView widget that allows GL rendering.
5612 * Signals that you can add callbacks for are:
5618 * Add a new glview to the parent
5620 * @param parent The parent object
5621 * @return The new object or NULL if it cannot be created
5625 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5628 * Sets the size of the glview
5630 * @param obj The glview object
5631 * @param width width of the glview object
5632 * @param height height of the glview object
5636 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5639 * Gets the size of the glview.
5641 * @param obj The glview object
5642 * @param width width of the glview object
5643 * @param height height of the glview object
5645 * Note that this function returns the actual image size of the
5646 * glview. This means that when the scale policy is set to
5647 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5652 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5655 * Gets the gl api struct for gl rendering
5657 * @param obj The glview object
5658 * @return The api object or NULL if it cannot be created
5662 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5665 * Set the mode of the GLView. Supports Three simple modes.
5667 * @param obj The glview object
5668 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5669 * @return True if set properly.
5673 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5676 * Set the resize policy for the glview object.
5678 * @param obj The glview object.
5679 * @param policy The scaling policy.
5681 * By default, the resize policy is set to
5682 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5683 * destroys the previous surface and recreates the newly specified
5684 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5685 * however, glview only scales the image object and not the underlying
5690 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5693 * Set the render policy for the glview object.
5695 * @param obj The glview object.
5696 * @param policy The render policy.
5698 * By default, the render policy is set to
5699 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5700 * that during the render loop, glview is only redrawn if it needs
5701 * to be redrawn. (i.e. When it is visible) If the policy is set to
5702 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5703 * whether it is visible/need redrawing or not.
5707 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5710 * Set the init function that runs once in the main loop.
5712 * @param obj The glview object.
5713 * @param func The init function to be registered.
5715 * The registered init function gets called once during the render loop.
5719 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5722 * Set the render function that runs in the main loop.
5724 * @param obj The glview object.
5725 * @param func The delete function to be registered.
5727 * The registered del function gets called when GLView object is deleted.
5731 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5734 * Set the resize function that gets called when resize happens.
5736 * @param obj The glview object.
5737 * @param func The resize function to be registered.
5741 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5744 * Set the render function that runs in the main loop.
5746 * @param obj The glview object.
5747 * @param func The render function to be registered.
5751 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5754 * Notifies that there has been changes in the GLView.
5756 * @param obj The glview object.
5760 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5770 * @image html img/widget/box/preview-00.png
5771 * @image latex img/widget/box/preview-00.eps width=\textwidth
5773 * @image html img/box.png
5774 * @image latex img/box.eps width=\textwidth
5776 * A box arranges objects in a linear fashion, governed by a layout function
5777 * that defines the details of this arrangement.
5779 * By default, the box will use an internal function to set the layout to
5780 * a single row, either vertical or horizontal. This layout is affected
5781 * by a number of parameters, such as the homogeneous flag set by
5782 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5783 * elm_box_align_set() and the hints set to each object in the box.
5785 * For this default layout, it's possible to change the orientation with
5786 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5787 * placing its elements ordered from top to bottom. When horizontal is set,
5788 * the order will go from left to right. If the box is set to be
5789 * homogeneous, every object in it will be assigned the same space, that
5790 * of the largest object. Padding can be used to set some spacing between
5791 * the cell given to each object. The alignment of the box, set with
5792 * elm_box_align_set(), determines how the bounding box of all the elements
5793 * will be placed within the space given to the box widget itself.
5795 * The size hints of each object also affect how they are placed and sized
5796 * within the box. evas_object_size_hint_min_set() will give the minimum
5797 * size the object can have, and the box will use it as the basis for all
5798 * latter calculations. Elementary widgets set their own minimum size as
5799 * needed, so there's rarely any need to use it manually.
5801 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5802 * used to tell whether the object will be allocated the minimum size it
5803 * needs or if the space given to it should be expanded. It's important
5804 * to realize that expanding the size given to the object is not the same
5805 * thing as resizing the object. It could very well end being a small
5806 * widget floating in a much larger empty space. If not set, the weight
5807 * for objects will normally be 0.0 for both axis, meaning the widget will
5808 * not be expanded. To take as much space possible, set the weight to
5809 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5811 * Besides how much space each object is allocated, it's possible to control
5812 * how the widget will be placed within that space using
5813 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5814 * for both axis, meaning the object will be centered, but any value from
5815 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5816 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5817 * is -1.0, means the object will be resized to fill the entire space it
5820 * In addition, customized functions to define the layout can be set, which
5821 * allow the application developer to organize the objects within the box
5822 * in any number of ways.
5824 * The special elm_box_layout_transition() function can be used
5825 * to switch from one layout to another, animating the motion of the
5826 * children of the box.
5828 * @note Objects should not be added to box objects using _add() calls.
5830 * Some examples on how to use boxes follow:
5831 * @li @ref box_example_01
5832 * @li @ref box_example_02
5837 * @typedef Elm_Box_Transition
5839 * Opaque handler containing the parameters to perform an animated
5840 * transition of the layout the box uses.
5842 * @see elm_box_transition_new()
5843 * @see elm_box_layout_set()
5844 * @see elm_box_layout_transition()
5846 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5849 * Add a new box to the parent
5851 * By default, the box will be in vertical mode and non-homogeneous.
5853 * @param parent The parent object
5854 * @return The new object or NULL if it cannot be created
5856 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5858 * Set the horizontal orientation
5860 * By default, box object arranges their contents vertically from top to
5862 * By calling this function with @p horizontal as EINA_TRUE, the box will
5863 * become horizontal, arranging contents from left to right.
5865 * @note This flag is ignored if a custom layout function is set.
5867 * @param obj The box object
5868 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5869 * EINA_FALSE = vertical)
5871 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5873 * Get the horizontal orientation
5875 * @param obj The box object
5876 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5878 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5880 * Set the box to arrange its children homogeneously
5882 * If enabled, homogeneous layout makes all items the same size, according
5883 * to the size of the largest of its children.
5885 * @note This flag is ignored if a custom layout function is set.
5887 * @param obj The box object
5888 * @param homogeneous The homogeneous flag
5890 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5892 * Get whether the box is using homogeneous mode or not
5894 * @param obj The box object
5895 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5897 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5898 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5899 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5901 * Add an object to the beginning of the pack list
5903 * Pack @p subobj into the box @p obj, placing it first in the list of
5904 * children objects. The actual position the object will get on screen
5905 * depends on the layout used. If no custom layout is set, it will be at
5906 * the top or left, depending if the box is vertical or horizontal,
5909 * @param obj The box object
5910 * @param subobj The object to add to the box
5912 * @see elm_box_pack_end()
5913 * @see elm_box_pack_before()
5914 * @see elm_box_pack_after()
5915 * @see elm_box_unpack()
5916 * @see elm_box_unpack_all()
5917 * @see elm_box_clear()
5919 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5921 * Add an object at the end of the pack list
5923 * Pack @p subobj into the box @p obj, placing it last in the list of
5924 * children objects. The actual position the object will get on screen
5925 * depends on the layout used. If no custom layout is set, it will be at
5926 * the bottom or right, depending if the box is vertical or horizontal,
5929 * @param obj The box object
5930 * @param subobj The object to add to the box
5932 * @see elm_box_pack_start()
5933 * @see elm_box_pack_before()
5934 * @see elm_box_pack_after()
5935 * @see elm_box_unpack()
5936 * @see elm_box_unpack_all()
5937 * @see elm_box_clear()
5939 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5941 * Adds an object to the box before the indicated object
5943 * This will add the @p subobj to the box indicated before the object
5944 * indicated with @p before. If @p before is not already in the box, results
5945 * are undefined. Before means either to the left of the indicated object or
5946 * above it depending on orientation.
5948 * @param obj The box object
5949 * @param subobj The object to add to the box
5950 * @param before The object before which to add it
5952 * @see elm_box_pack_start()
5953 * @see elm_box_pack_end()
5954 * @see elm_box_pack_after()
5955 * @see elm_box_unpack()
5956 * @see elm_box_unpack_all()
5957 * @see elm_box_clear()
5959 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5961 * Adds an object to the box after the indicated object
5963 * This will add the @p subobj to the box indicated after the object
5964 * indicated with @p after. If @p after is not already in the box, results
5965 * are undefined. After means either to the right of the indicated object or
5966 * below it depending on orientation.
5968 * @param obj The box object
5969 * @param subobj The object to add to the box
5970 * @param after The object after which to add it
5972 * @see elm_box_pack_start()
5973 * @see elm_box_pack_end()
5974 * @see elm_box_pack_before()
5975 * @see elm_box_unpack()
5976 * @see elm_box_unpack_all()
5977 * @see elm_box_clear()
5979 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5981 * Clear the box of all children
5983 * Remove all the elements contained by the box, deleting the respective
5986 * @param obj The box object
5988 * @see elm_box_unpack()
5989 * @see elm_box_unpack_all()
5991 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 * Remove the object given by @p subobj from the box @p obj without
5998 * @param obj The box object
6000 * @see elm_box_unpack_all()
6001 * @see elm_box_clear()
6003 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6005 * Remove all items from the box, without deleting them
6007 * Clear the box from all children, but don't delete the respective objects.
6008 * If no other references of the box children exist, the objects will never
6009 * be deleted, and thus the application will leak the memory. Make sure
6010 * when using this function that you hold a reference to all the objects
6011 * in the box @p obj.
6013 * @param obj The box object
6015 * @see elm_box_clear()
6016 * @see elm_box_unpack()
6018 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6020 * Retrieve a list of the objects packed into the box
6022 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6023 * The order of the list corresponds to the packing order the box uses.
6025 * You must free this list with eina_list_free() once you are done with it.
6027 * @param obj The box object
6029 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6031 * Set the space (padding) between the box's elements.
6033 * Extra space in pixels that will be added between a box child and its
6034 * neighbors after its containing cell has been calculated. This padding
6035 * is set for all elements in the box, besides any possible padding that
6036 * individual elements may have through their size hints.
6038 * @param obj The box object
6039 * @param horizontal The horizontal space between elements
6040 * @param vertical The vertical space between elements
6042 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6044 * Get the space (padding) between the box's elements.
6046 * @param obj The box object
6047 * @param horizontal The horizontal space between elements
6048 * @param vertical The vertical space between elements
6050 * @see elm_box_padding_set()
6052 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6054 * Set the alignment of the whole bouding box of contents.
6056 * Sets how the bounding box containing all the elements of the box, after
6057 * their sizes and position has been calculated, will be aligned within
6058 * the space given for the whole box widget.
6060 * @param obj The box object
6061 * @param horizontal The horizontal alignment of elements
6062 * @param vertical The vertical alignment of elements
6064 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6066 * Get the alignment of the whole bouding box of contents.
6068 * @param obj The box object
6069 * @param horizontal The horizontal alignment of elements
6070 * @param vertical The vertical alignment of elements
6072 * @see elm_box_align_set()
6074 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6077 * Force the box to recalculate its children packing.
6079 * If any children was added or removed, box will not calculate the
6080 * values immediately rather leaving it to the next main loop
6081 * iteration. While this is great as it would save lots of
6082 * recalculation, whenever you need to get the position of a just
6083 * added item you must force recalculate before doing so.
6085 * @param obj The box object.
6087 EAPI void elm_box_recalculate(Evas_Object *obj);
6090 * Set the layout defining function to be used by the box
6092 * Whenever anything changes that requires the box in @p obj to recalculate
6093 * the size and position of its elements, the function @p cb will be called
6094 * to determine what the layout of the children will be.
6096 * Once a custom function is set, everything about the children layout
6097 * is defined by it. The flags set by elm_box_horizontal_set() and
6098 * elm_box_homogeneous_set() no longer have any meaning, and the values
6099 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6100 * layout function to decide if they are used and how. These last two
6101 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6102 * passed to @p cb. The @c Evas_Object the function receives is not the
6103 * Elementary widget, but the internal Evas Box it uses, so none of the
6104 * functions described here can be used on it.
6106 * Any of the layout functions in @c Evas can be used here, as well as the
6107 * special elm_box_layout_transition().
6109 * The final @p data argument received by @p cb is the same @p data passed
6110 * here, and the @p free_data function will be called to free it
6111 * whenever the box is destroyed or another layout function is set.
6113 * Setting @p cb to NULL will revert back to the default layout function.
6115 * @param obj The box object
6116 * @param cb The callback function used for layout
6117 * @param data Data that will be passed to layout function
6118 * @param free_data Function called to free @p data
6120 * @see elm_box_layout_transition()
6122 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);
6124 * Special layout function that animates the transition from one layout to another
6126 * Normally, when switching the layout function for a box, this will be
6127 * reflected immediately on screen on the next render, but it's also
6128 * possible to do this through an animated transition.
6130 * This is done by creating an ::Elm_Box_Transition and setting the box
6131 * layout to this function.
6135 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6136 * evas_object_box_layout_vertical, // start
6137 * NULL, // data for initial layout
6138 * NULL, // free function for initial data
6139 * evas_object_box_layout_horizontal, // end
6140 * NULL, // data for final layout
6141 * NULL, // free function for final data
6142 * anim_end, // will be called when animation ends
6143 * NULL); // data for anim_end function\
6144 * elm_box_layout_set(box, elm_box_layout_transition, t,
6145 * elm_box_transition_free);
6148 * @note This function can only be used with elm_box_layout_set(). Calling
6149 * it directly will not have the expected results.
6151 * @see elm_box_transition_new
6152 * @see elm_box_transition_free
6153 * @see elm_box_layout_set
6155 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6157 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6159 * If you want to animate the change from one layout to another, you need
6160 * to set the layout function of the box to elm_box_layout_transition(),
6161 * passing as user data to it an instance of ::Elm_Box_Transition with the
6162 * necessary information to perform this animation. The free function to
6163 * set for the layout is elm_box_transition_free().
6165 * The parameters to create an ::Elm_Box_Transition sum up to how long
6166 * will it be, in seconds, a layout function to describe the initial point,
6167 * another for the final position of the children and one function to be
6168 * called when the whole animation ends. This last function is useful to
6169 * set the definitive layout for the box, usually the same as the end
6170 * layout for the animation, but could be used to start another transition.
6172 * @param start_layout The layout function that will be used to start the animation
6173 * @param start_layout_data The data to be passed the @p start_layout function
6174 * @param start_layout_free_data Function to free @p start_layout_data
6175 * @param end_layout The layout function that will be used to end the animation
6176 * @param end_layout_free_data The data to be passed the @p end_layout function
6177 * @param end_layout_free_data Function to free @p end_layout_data
6178 * @param transition_end_cb Callback function called when animation ends
6179 * @param transition_end_data Data to be passed to @p transition_end_cb
6180 * @return An instance of ::Elm_Box_Transition
6182 * @see elm_box_transition_new
6183 * @see elm_box_layout_transition
6185 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);
6187 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6189 * This function is mostly useful as the @c free_data parameter in
6190 * elm_box_layout_set() when elm_box_layout_transition().
6192 * @param data The Elm_Box_Transition instance to be freed.
6194 * @see elm_box_transition_new
6195 * @see elm_box_layout_transition
6197 EAPI void elm_box_transition_free(void *data);
6204 * @defgroup Button Button
6206 * @image html img/widget/button/preview-00.png
6207 * @image latex img/widget/button/preview-00.eps
6208 * @image html img/widget/button/preview-01.png
6209 * @image latex img/widget/button/preview-01.eps
6210 * @image html img/widget/button/preview-02.png
6211 * @image latex img/widget/button/preview-02.eps
6213 * This is a push-button. Press it and run some function. It can contain
6214 * a simple label and icon object and it also has an autorepeat feature.
6216 * This widgets emits the following signals:
6217 * @li "clicked": the user clicked the button (press/release).
6218 * @li "repeated": the user pressed the button without releasing it.
6219 * @li "pressed": button was pressed.
6220 * @li "unpressed": button was released after being pressed.
6221 * In all three cases, the @c event parameter of the callback will be
6224 * Also, defined in the default theme, the button has the following styles
6226 * @li default: a normal button.
6227 * @li anchor: Like default, but the button fades away when the mouse is not
6228 * over it, leaving only the text or icon.
6229 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6230 * continuous look across its options.
6231 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6233 * Default contents parts of the button widget that you can use for are:
6234 * @li "elm.swallow.content" - A icon of the button
6236 * Default text parts of the button widget that you can use for are:
6237 * @li "elm.text" - Label of the button
6239 * Follow through a complete example @ref button_example_01 "here".
6245 UIControlStateDefault,
6246 UIControlStateHighlighted,
6247 UIControlStateDisabled,
6248 UIControlStateFocused,
6249 UIControlStateReserved
6253 * Add a new button to the parent's canvas
6255 * @param parent The parent object
6256 * @return The new object or NULL if it cannot be created
6258 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6260 * Set the label used in the button
6262 * The passed @p label can be NULL to clean any existing text in it and
6263 * leave the button as an icon only object.
6265 * @param obj The button object
6266 * @param label The text will be written on the button
6267 * @deprecated use elm_object_text_set() instead.
6269 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6271 * Get the label set for the button
6273 * The string returned is an internal pointer and should not be freed or
6274 * altered. It will also become invalid when the button is destroyed.
6275 * The string returned, if not NULL, is a stringshare, so if you need to
6276 * keep it around even after the button is destroyed, you can use
6277 * eina_stringshare_ref().
6279 * @param obj The button object
6280 * @return The text set to the label, or NULL if nothing is set
6281 * @deprecated use elm_object_text_set() instead.
6283 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6285 * Set the label for each state of button
6287 * The passed @p label can be NULL to clean any existing text in it and
6288 * leave the button as an icon only object for the state.
6290 * @param obj The button object
6291 * @param label The text will be written on the button
6292 * @param state The state of button
6296 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6298 * Get the label of button for each state
6300 * The string returned is an internal pointer and should not be freed or
6301 * altered. It will also become invalid when the button is destroyed.
6302 * The string returned, if not NULL, is a stringshare, so if you need to
6303 * keep it around even after the button is destroyed, you can use
6304 * eina_stringshare_ref().
6306 * @param obj The button object
6307 * @param state The state of button
6308 * @return The title of button for state
6312 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6314 * Set the icon used for the button
6316 * Setting a new icon will delete any other that was previously set, making
6317 * any reference to them invalid. If you need to maintain the previous
6318 * object alive, unset it first with elm_button_icon_unset().
6320 * @param obj The button object
6321 * @param icon The icon object for the button
6322 * @deprecated use elm_object_content_set() instead.
6324 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6326 * Get the icon used for the button
6328 * Return the icon object which is set for this widget. If the button is
6329 * destroyed or another icon is set, the returned object will be deleted
6330 * and any reference to it will be invalid.
6332 * @param obj The button object
6333 * @return The icon object that is being used
6335 * @deprecated use elm_button_icon_unset() instead
6337 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6339 * Remove the icon set without deleting it and return the object
6341 * This function drops the reference the button holds of the icon object
6342 * and returns this last object. It is used in case you want to remove any
6343 * icon, or set another one, without deleting the actual object. The button
6344 * will be left without an icon set.
6346 * @param obj The button object
6347 * @return The icon object that was being used
6348 * @deprecated use elm_object_content_unset() instead.
6350 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 * Turn on/off the autorepeat event generated when the button is kept pressed
6354 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6355 * signal when they are clicked.
6357 * When on, keeping a button pressed will continuously emit a @c repeated
6358 * signal until the button is released. The time it takes until it starts
6359 * emitting the signal is given by
6360 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6361 * new emission by elm_button_autorepeat_gap_timeout_set().
6363 * @param obj The button object
6364 * @param on A bool to turn on/off the event
6366 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6368 * Get whether the autorepeat feature is enabled
6370 * @param obj The button object
6371 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6373 * @see elm_button_autorepeat_set()
6375 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6377 * Set the initial timeout before the autorepeat event is generated
6379 * Sets the timeout, in seconds, since the button is pressed until the
6380 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6381 * won't be any delay and the even will be fired the moment the button is
6384 * @param obj The button object
6385 * @param t Timeout in seconds
6387 * @see elm_button_autorepeat_set()
6388 * @see elm_button_autorepeat_gap_timeout_set()
6390 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6392 * Get the initial timeout before the autorepeat event is generated
6394 * @param obj The button object
6395 * @return Timeout in seconds
6397 * @see elm_button_autorepeat_initial_timeout_set()
6399 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6401 * Set the interval between each generated autorepeat event
6403 * After the first @c repeated event is fired, all subsequent ones will
6404 * follow after a delay of @p t seconds for each.
6406 * @param obj The button object
6407 * @param t Interval in seconds
6409 * @see elm_button_autorepeat_initial_timeout_set()
6411 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6413 * Get the interval between each generated autorepeat event
6415 * @param obj The button object
6416 * @return Interval in seconds
6418 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6424 * @defgroup File_Selector_Button File Selector Button
6426 * @image html img/widget/fileselector_button/preview-00.png
6427 * @image latex img/widget/fileselector_button/preview-00.eps
6428 * @image html img/widget/fileselector_button/preview-01.png
6429 * @image latex img/widget/fileselector_button/preview-01.eps
6430 * @image html img/widget/fileselector_button/preview-02.png
6431 * @image latex img/widget/fileselector_button/preview-02.eps
6433 * This is a button that, when clicked, creates an Elementary
6434 * window (or inner window) <b> with a @ref Fileselector "file
6435 * selector widget" within</b>. When a file is chosen, the (inner)
6436 * window is closed and the button emits a signal having the
6437 * selected file as it's @c event_info.
6439 * This widget encapsulates operations on its internal file
6440 * selector on its own API. There is less control over its file
6441 * selector than that one would have instatiating one directly.
6443 * The following styles are available for this button:
6446 * @li @c "hoversel_vertical"
6447 * @li @c "hoversel_vertical_entry"
6449 * Smart callbacks one can register to:
6450 * - @c "file,chosen" - the user has selected a path, whose string
6451 * pointer comes as the @c event_info data (a stringshared
6454 * Here is an example on its usage:
6455 * @li @ref fileselector_button_example
6457 * @see @ref File_Selector_Entry for a similar widget.
6462 * Add a new file selector button widget to the given parent
6463 * Elementary (container) object
6465 * @param parent The parent object
6466 * @return a new file selector button widget handle or @c NULL, on
6469 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6472 * Set the label for a given file selector button widget
6474 * @param obj The file selector button widget
6475 * @param label The text label to be displayed on @p obj
6477 * @deprecated use elm_object_text_set() instead.
6479 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6482 * Get the label set for a given file selector button widget
6484 * @param obj The file selector button widget
6485 * @return The button label
6487 * @deprecated use elm_object_text_set() instead.
6489 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6492 * Set the icon on a given file selector button widget
6494 * @param obj The file selector button widget
6495 * @param icon The icon object for the button
6497 * Once the icon object is set, a previously set one will be
6498 * deleted. If you want to keep the latter, use the
6499 * elm_fileselector_button_icon_unset() function.
6501 * @see elm_fileselector_button_icon_get()
6503 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6506 * Get the icon set for a given file selector button widget
6508 * @param obj The file selector button widget
6509 * @return The icon object currently set on @p obj or @c NULL, if
6512 * @see elm_fileselector_button_icon_set()
6514 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6517 * Unset the icon used in a given file selector button widget
6519 * @param obj The file selector button widget
6520 * @return The icon object that was being used on @p obj or @c
6523 * Unparent and return the icon object which was set for this
6526 * @see elm_fileselector_button_icon_set()
6528 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6531 * Set the title for a given file selector button widget's window
6533 * @param obj The file selector button widget
6534 * @param title The title string
6536 * This will change the window's title, when the file selector pops
6537 * out after a click on the button. Those windows have the default
6538 * (unlocalized) value of @c "Select a file" as titles.
6540 * @note It will only take any effect if the file selector
6541 * button widget is @b not under "inwin mode".
6543 * @see elm_fileselector_button_window_title_get()
6545 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6548 * Get the title set for a given file selector button widget's
6551 * @param obj The file selector button widget
6552 * @return Title of the file selector button's window
6554 * @see elm_fileselector_button_window_title_get() for more details
6556 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 * Set the size of a given file selector button widget's window,
6560 * holding the file selector itself.
6562 * @param obj The file selector button widget
6563 * @param width The window's width
6564 * @param height The window's height
6566 * @note it will only take any effect if the file selector button
6567 * widget is @b not under "inwin mode". The default size for the
6568 * window (when applicable) is 400x400 pixels.
6570 * @see elm_fileselector_button_window_size_get()
6572 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6575 * Get the size of a given file selector button widget's window,
6576 * holding the file selector itself.
6578 * @param obj The file selector button widget
6579 * @param width Pointer into which to store the width value
6580 * @param height Pointer into which to store the height value
6582 * @note Use @c NULL pointers on the size values you're not
6583 * interested in: they'll be ignored by the function.
6585 * @see elm_fileselector_button_window_size_set(), for more details
6587 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6590 * Set the initial file system path for a given file selector
6593 * @param obj The file selector button widget
6594 * @param path The path string
6596 * It must be a <b>directory</b> path, which will have the contents
6597 * displayed initially in the file selector's view, when invoked
6598 * from @p obj. The default initial path is the @c "HOME"
6599 * environment variable's value.
6601 * @see elm_fileselector_button_path_get()
6603 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6606 * Get the initial file system path set for a given file selector
6609 * @param obj The file selector button widget
6610 * @return path The path string
6612 * @see elm_fileselector_button_path_set() for more details
6614 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6617 * Enable/disable a tree view in the given file selector button
6618 * widget's internal file selector
6620 * @param obj The file selector button widget
6621 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6624 * This has the same effect as elm_fileselector_expandable_set(),
6625 * but now applied to a file selector button's internal file
6628 * @note There's no way to put a file selector button's internal
6629 * file selector in "grid mode", as one may do with "pure" file
6632 * @see elm_fileselector_expandable_get()
6634 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6637 * Get whether tree view is enabled for the given file selector
6638 * button widget's internal file selector
6640 * @param obj The file selector button widget
6641 * @return @c EINA_TRUE if @p obj widget's internal file selector
6642 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6644 * @see elm_fileselector_expandable_set() for more details
6646 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6649 * Set whether a given file selector button widget's internal file
6650 * selector is to display folders only or the directory contents,
6653 * @param obj The file selector button widget
6654 * @param only @c EINA_TRUE to make @p obj widget's internal file
6655 * selector only display directories, @c EINA_FALSE to make files
6656 * to be displayed in it too
6658 * This has the same effect as elm_fileselector_folder_only_set(),
6659 * but now applied to a file selector button's internal file
6662 * @see elm_fileselector_folder_only_get()
6664 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6667 * Get whether a given file selector button widget's internal file
6668 * selector is displaying folders only or the directory contents,
6671 * @param obj The file selector button widget
6672 * @return @c EINA_TRUE if @p obj widget's internal file
6673 * selector is only displaying directories, @c EINA_FALSE if files
6674 * are being displayed in it too (and on errors)
6676 * @see elm_fileselector_button_folder_only_set() for more details
6678 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6681 * Enable/disable the file name entry box where the user can type
6682 * in a name for a file, in a given file selector button widget's
6683 * internal file selector.
6685 * @param obj The file selector button widget
6686 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6687 * file selector a "saving dialog", @c EINA_FALSE otherwise
6689 * This has the same effect as elm_fileselector_is_save_set(),
6690 * but now applied to a file selector button's internal file
6693 * @see elm_fileselector_is_save_get()
6695 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6698 * Get whether the given file selector button widget's internal
6699 * file selector is in "saving dialog" mode
6701 * @param obj The file selector button widget
6702 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6703 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6706 * @see elm_fileselector_button_is_save_set() for more details
6708 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6711 * Set whether a given file selector button widget's internal file
6712 * selector will raise an Elementary "inner window", instead of a
6713 * dedicated Elementary window. By default, it won't.
6715 * @param obj The file selector button widget
6716 * @param value @c EINA_TRUE to make it use an inner window, @c
6717 * EINA_TRUE to make it use a dedicated window
6719 * @see elm_win_inwin_add() for more information on inner windows
6720 * @see elm_fileselector_button_inwin_mode_get()
6722 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6725 * Get whether a given file selector button widget's internal file
6726 * selector will raise an Elementary "inner window", instead of a
6727 * dedicated Elementary window.
6729 * @param obj The file selector button widget
6730 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6731 * if it will use a dedicated window
6733 * @see elm_fileselector_button_inwin_mode_set() for more details
6735 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6742 * @defgroup File_Selector_Entry File Selector Entry
6744 * @image html img/widget/fileselector_entry/preview-00.png
6745 * @image latex img/widget/fileselector_entry/preview-00.eps
6747 * This is an entry made to be filled with or display a <b>file
6748 * system path string</b>. Besides the entry itself, the widget has
6749 * a @ref File_Selector_Button "file selector button" on its side,
6750 * which will raise an internal @ref Fileselector "file selector widget",
6751 * when clicked, for path selection aided by file system
6754 * This file selector may appear in an Elementary window or in an
6755 * inner window. When a file is chosen from it, the (inner) window
6756 * is closed and the selected file's path string is exposed both as
6757 * an smart event and as the new text on the entry.
6759 * This widget encapsulates operations on its internal file
6760 * selector on its own API. There is less control over its file
6761 * selector than that one would have instatiating one directly.
6763 * Smart callbacks one can register to:
6764 * - @c "changed" - The text within the entry was changed
6765 * - @c "activated" - The entry has had editing finished and
6766 * changes are to be "committed"
6767 * - @c "press" - The entry has been clicked
6768 * - @c "longpressed" - The entry has been clicked (and held) for a
6770 * - @c "clicked" - The entry has been clicked
6771 * - @c "clicked,double" - The entry has been double clicked
6772 * - @c "focused" - The entry has received focus
6773 * - @c "unfocused" - The entry has lost focus
6774 * - @c "selection,paste" - A paste action has occurred on the
6776 * - @c "selection,copy" - A copy action has occurred on the entry
6777 * - @c "selection,cut" - A cut action has occurred on the entry
6778 * - @c "unpressed" - The file selector entry's button was released
6779 * after being pressed.
6780 * - @c "file,chosen" - The user has selected a path via the file
6781 * selector entry's internal file selector, whose string pointer
6782 * comes as the @c event_info data (a stringshared string)
6784 * Here is an example on its usage:
6785 * @li @ref fileselector_entry_example
6787 * @see @ref File_Selector_Button for a similar widget.
6792 * Add a new file selector entry widget to the given parent
6793 * Elementary (container) object
6795 * @param parent The parent object
6796 * @return a new file selector entry widget handle or @c NULL, on
6799 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6802 * Set the label for a given file selector entry widget's button
6804 * @param obj The file selector entry widget
6805 * @param label The text label to be displayed on @p obj widget's
6808 * @deprecated use elm_object_text_set() instead.
6810 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6813 * Get the label set for a given file selector entry widget's button
6815 * @param obj The file selector entry widget
6816 * @return The widget button's label
6818 * @deprecated use elm_object_text_set() instead.
6820 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6823 * Set the icon on a given file selector entry widget's button
6825 * @param obj The file selector entry widget
6826 * @param icon The icon object for the entry's button
6828 * Once the icon object is set, a previously set one will be
6829 * deleted. If you want to keep the latter, use the
6830 * elm_fileselector_entry_button_icon_unset() function.
6832 * @see elm_fileselector_entry_button_icon_get()
6834 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6837 * Get the icon set for a given file selector entry widget's button
6839 * @param obj The file selector entry widget
6840 * @return The icon object currently set on @p obj widget's button
6841 * or @c NULL, if none is
6843 * @see elm_fileselector_entry_button_icon_set()
6845 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6848 * Unset the icon used in a given file selector entry widget's
6851 * @param obj The file selector entry widget
6852 * @return The icon object that was being used on @p obj widget's
6853 * button or @c NULL, on errors
6855 * Unparent and return the icon object which was set for this
6858 * @see elm_fileselector_entry_button_icon_set()
6860 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6863 * Set the title for a given file selector entry widget's window
6865 * @param obj The file selector entry widget
6866 * @param title The title string
6868 * This will change the window's title, when the file selector pops
6869 * out after a click on the entry's button. Those windows have the
6870 * default (unlocalized) value of @c "Select a file" as titles.
6872 * @note It will only take any effect if the file selector
6873 * entry widget is @b not under "inwin mode".
6875 * @see elm_fileselector_entry_window_title_get()
6877 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6880 * Get the title set for a given file selector entry widget's
6883 * @param obj The file selector entry widget
6884 * @return Title of the file selector entry's window
6886 * @see elm_fileselector_entry_window_title_get() for more details
6888 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6891 * Set the size of a given file selector entry widget's window,
6892 * holding the file selector itself.
6894 * @param obj The file selector entry widget
6895 * @param width The window's width
6896 * @param height The window's height
6898 * @note it will only take any effect if the file selector entry
6899 * widget is @b not under "inwin mode". The default size for the
6900 * window (when applicable) is 400x400 pixels.
6902 * @see elm_fileselector_entry_window_size_get()
6904 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6907 * Get the size of a given file selector entry widget's window,
6908 * holding the file selector itself.
6910 * @param obj The file selector entry widget
6911 * @param width Pointer into which to store the width value
6912 * @param height Pointer into which to store the height value
6914 * @note Use @c NULL pointers on the size values you're not
6915 * interested in: they'll be ignored by the function.
6917 * @see elm_fileselector_entry_window_size_set(), for more details
6919 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6922 * Set the initial file system path and the entry's path string for
6923 * a given file selector entry widget
6925 * @param obj The file selector entry widget
6926 * @param path The path string
6928 * It must be a <b>directory</b> path, which will have the contents
6929 * displayed initially in the file selector's view, when invoked
6930 * from @p obj. The default initial path is the @c "HOME"
6931 * environment variable's value.
6933 * @see elm_fileselector_entry_path_get()
6935 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6938 * Get the entry's path string for a given file selector entry
6941 * @param obj The file selector entry widget
6942 * @return path The path string
6944 * @see elm_fileselector_entry_path_set() for more details
6946 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6949 * Enable/disable a tree view in the given file selector entry
6950 * widget's internal file selector
6952 * @param obj The file selector entry widget
6953 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6956 * This has the same effect as elm_fileselector_expandable_set(),
6957 * but now applied to a file selector entry's internal file
6960 * @note There's no way to put a file selector entry's internal
6961 * file selector in "grid mode", as one may do with "pure" file
6964 * @see elm_fileselector_expandable_get()
6966 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6969 * Get whether tree view is enabled for the given file selector
6970 * entry widget's internal file selector
6972 * @param obj The file selector entry widget
6973 * @return @c EINA_TRUE if @p obj widget's internal file selector
6974 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6976 * @see elm_fileselector_expandable_set() for more details
6978 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6981 * Set whether a given file selector entry widget's internal file
6982 * selector is to display folders only or the directory contents,
6985 * @param obj The file selector entry widget
6986 * @param only @c EINA_TRUE to make @p obj widget's internal file
6987 * selector only display directories, @c EINA_FALSE to make files
6988 * to be displayed in it too
6990 * This has the same effect as elm_fileselector_folder_only_set(),
6991 * but now applied to a file selector entry's internal file
6994 * @see elm_fileselector_folder_only_get()
6996 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6999 * Get whether a given file selector entry widget's internal file
7000 * selector is displaying folders only or the directory contents,
7003 * @param obj The file selector entry widget
7004 * @return @c EINA_TRUE if @p obj widget's internal file
7005 * selector is only displaying directories, @c EINA_FALSE if files
7006 * are being displayed in it too (and on errors)
7008 * @see elm_fileselector_entry_folder_only_set() for more details
7010 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7013 * Enable/disable the file name entry box where the user can type
7014 * in a name for a file, in a given file selector entry widget's
7015 * internal file selector.
7017 * @param obj The file selector entry widget
7018 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7019 * file selector a "saving dialog", @c EINA_FALSE otherwise
7021 * This has the same effect as elm_fileselector_is_save_set(),
7022 * but now applied to a file selector entry's internal file
7025 * @see elm_fileselector_is_save_get()
7027 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7030 * Get whether the given file selector entry widget's internal
7031 * file selector is in "saving dialog" mode
7033 * @param obj The file selector entry widget
7034 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7035 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7038 * @see elm_fileselector_entry_is_save_set() for more details
7040 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7043 * Set whether a given file selector entry widget's internal file
7044 * selector will raise an Elementary "inner window", instead of a
7045 * dedicated Elementary window. By default, it won't.
7047 * @param obj The file selector entry widget
7048 * @param value @c EINA_TRUE to make it use an inner window, @c
7049 * EINA_TRUE to make it use a dedicated window
7051 * @see elm_win_inwin_add() for more information on inner windows
7052 * @see elm_fileselector_entry_inwin_mode_get()
7054 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7057 * Get whether a given file selector entry widget's internal file
7058 * selector will raise an Elementary "inner window", instead of a
7059 * dedicated Elementary window.
7061 * @param obj The file selector entry widget
7062 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7063 * if it will use a dedicated window
7065 * @see elm_fileselector_entry_inwin_mode_set() for more details
7067 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7070 * Set the initial file system path for a given file selector entry
7073 * @param obj The file selector entry widget
7074 * @param path The path string
7076 * It must be a <b>directory</b> path, which will have the contents
7077 * displayed initially in the file selector's view, when invoked
7078 * from @p obj. The default initial path is the @c "HOME"
7079 * environment variable's value.
7081 * @see elm_fileselector_entry_path_get()
7083 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7086 * Get the parent directory's path to the latest file selection on
7087 * a given filer selector entry widget
7089 * @param obj The file selector object
7090 * @return The (full) path of the directory of the last selection
7091 * on @p obj widget, a @b stringshared string
7093 * @see elm_fileselector_entry_path_set()
7095 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7102 * @defgroup Scroller Scroller
7104 * A scroller holds a single object and "scrolls it around". This means that
7105 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7106 * region around, allowing to move through a much larger object that is
7107 * contained in the scroller. The scroller will always have a small minimum
7108 * size by default as it won't be limited by the contents of the scroller.
7110 * Signals that you can add callbacks for are:
7111 * @li "edge,left" - the left edge of the content has been reached
7112 * @li "edge,right" - the right edge of the content has been reached
7113 * @li "edge,top" - the top edge of the content has been reached
7114 * @li "edge,bottom" - the bottom edge of the content has been reached
7115 * @li "scroll" - the content has been scrolled (moved)
7116 * @li "scroll,anim,start" - scrolling animation has started
7117 * @li "scroll,anim,stop" - scrolling animation has stopped
7118 * @li "scroll,drag,start" - dragging the contents around has started
7119 * @li "scroll,drag,stop" - dragging the contents around has stopped
7120 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7123 * @note When Elemementary is in embedded mode the scrollbars will not be
7124 * dragable, they appear merely as indicators of how much has been scrolled.
7125 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7126 * fingerscroll) won't work.
7128 * To set/get/unset the content of the panel, you can use
7129 * elm_object_content_set/get/unset APIs.
7130 * Once the content object is set, a previously set one will be deleted.
7131 * If you want to keep that old content object, use the
7132 * elm_object_content_unset() function
7134 * In @ref tutorial_scroller you'll find an example of how to use most of
7139 * @brief Type that controls when scrollbars should appear.
7141 * @see elm_scroller_policy_set()
7143 typedef enum _Elm_Scroller_Policy
7145 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7146 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7147 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7148 ELM_SCROLLER_POLICY_LAST
7149 } Elm_Scroller_Policy;
7151 * @brief Add a new scroller to the parent
7153 * @param parent The parent object
7154 * @return The new object or NULL if it cannot be created
7156 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7158 * @brief Set the content of the scroller widget (the object to be scrolled around).
7160 * @param obj The scroller object
7161 * @param content The new content object
7163 * Once the content object is set, a previously set one will be deleted.
7164 * If you want to keep that old content object, use the
7165 * elm_scroller_content_unset() function.
7166 * @deprecated use elm_object_content_set() instead
7168 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7170 * @brief Get the content of the scroller widget
7172 * @param obj The slider object
7173 * @return The content that is being used
7175 * Return the content object which is set for this widget
7177 * @see elm_scroller_content_set()
7178 * @deprecated use elm_object_content_get() instead.
7180 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7182 * @brief Unset the content of the scroller widget
7184 * @param obj The slider object
7185 * @return The content that was being used
7187 * Unparent and return the content object which was set for this widget
7189 * @see elm_scroller_content_set()
7190 * @deprecated use elm_object_content_unset() instead.
7192 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7194 * @brief Set custom theme elements for the scroller
7196 * @param obj The scroller object
7197 * @param widget The widget name to use (default is "scroller")
7198 * @param base The base name to use (default is "base")
7200 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7202 * @brief Make the scroller minimum size limited to the minimum size of the content
7204 * @param obj The scroller object
7205 * @param w Enable limiting minimum size horizontally
7206 * @param h Enable limiting minimum size vertically
7208 * By default the scroller will be as small as its design allows,
7209 * irrespective of its content. This will make the scroller minimum size the
7210 * right size horizontally and/or vertically to perfectly fit its content in
7213 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7215 * @brief Show a specific virtual region within the scroller content object
7217 * @param obj The scroller object
7218 * @param x X coordinate of the region
7219 * @param y Y coordinate of the region
7220 * @param w Width of the region
7221 * @param h Height of the region
7223 * This will ensure all (or part if it does not fit) of the designated
7224 * region in the virtual content object (0, 0 starting at the top-left of the
7225 * virtual content object) is shown within the scroller.
7227 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);
7229 * @brief Set the scrollbar visibility policy
7231 * @param obj The scroller object
7232 * @param policy_h Horizontal scrollbar policy
7233 * @param policy_v Vertical scrollbar policy
7235 * This sets the scrollbar visibility policy for the given scroller.
7236 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7237 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7238 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7239 * respectively for the horizontal and vertical scrollbars.
7241 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7243 * @brief Gets scrollbar visibility policy
7245 * @param obj The scroller object
7246 * @param policy_h Horizontal scrollbar policy
7247 * @param policy_v Vertical scrollbar policy
7249 * @see elm_scroller_policy_set()
7251 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7253 * @brief Get the currently visible content region
7255 * @param obj The scroller object
7256 * @param x X coordinate of the region
7257 * @param y Y coordinate of the region
7258 * @param w Width of the region
7259 * @param h Height of the region
7261 * This gets the current region in the content object that is visible through
7262 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7263 * w, @p h values pointed to.
7265 * @note All coordinates are relative to the content.
7267 * @see elm_scroller_region_show()
7269 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);
7271 * @brief Get the size of the content object
7273 * @param obj The scroller object
7274 * @param w Width of the content object.
7275 * @param h Height of the content object.
7277 * This gets the size of the content object of the scroller.
7279 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7281 * @brief Set bouncing behavior
7283 * @param obj The scroller object
7284 * @param h_bounce Allow bounce horizontally
7285 * @param v_bounce Allow bounce vertically
7287 * When scrolling, the scroller may "bounce" when reaching an edge of the
7288 * content object. This is a visual way to indicate the end has been reached.
7289 * This is enabled by default for both axis. This API will set if it is enabled
7290 * for the given axis with the boolean parameters for each axis.
7292 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7294 * @brief Get the bounce behaviour
7296 * @param obj The Scroller object
7297 * @param h_bounce Will the scroller bounce horizontally or not
7298 * @param v_bounce Will the scroller bounce vertically or not
7300 * @see elm_scroller_bounce_set()
7302 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7304 * @brief Set scroll page size relative to viewport size.
7306 * @param obj The scroller object
7307 * @param h_pagerel The horizontal page relative size
7308 * @param v_pagerel The vertical page relative size
7310 * The scroller is capable of limiting scrolling by the user to "pages". That
7311 * is to jump by and only show a "whole page" at a time as if the continuous
7312 * area of the scroller content is split into page sized pieces. This sets
7313 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7314 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7315 * axis. This is mutually exclusive with page size
7316 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7317 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7318 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7321 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7323 * @brief Set scroll page size.
7325 * @param obj The scroller object
7326 * @param h_pagesize The horizontal page size
7327 * @param v_pagesize The vertical page size
7329 * This sets the page size to an absolute fixed value, with 0 turning it off
7332 * @see elm_scroller_page_relative_set()
7334 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7336 * @brief Get scroll current page number.
7338 * @param obj The scroller object
7339 * @param h_pagenumber The horizontal page number
7340 * @param v_pagenumber The vertical page number
7342 * The page number starts from 0. 0 is the first page.
7343 * Current page means the page which meets the top-left of the viewport.
7344 * If there are two or more pages in the viewport, it returns the number of the page
7345 * which meets the top-left of the viewport.
7347 * @see elm_scroller_last_page_get()
7348 * @see elm_scroller_page_show()
7349 * @see elm_scroller_page_brint_in()
7351 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7353 * @brief Get scroll last page number.
7355 * @param obj The scroller object
7356 * @param h_pagenumber The horizontal page number
7357 * @param v_pagenumber The vertical page number
7359 * The page number starts from 0. 0 is the first page.
7360 * This returns the last page number among the pages.
7362 * @see elm_scroller_current_page_get()
7363 * @see elm_scroller_page_show()
7364 * @see elm_scroller_page_brint_in()
7366 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7368 * Show a specific virtual region within the scroller content object by page number.
7370 * @param obj The scroller object
7371 * @param h_pagenumber The horizontal page number
7372 * @param v_pagenumber The vertical page number
7374 * 0, 0 of the indicated page is located at the top-left of the viewport.
7375 * This will jump to the page directly without animation.
7380 * sc = elm_scroller_add(win);
7381 * elm_scroller_content_set(sc, content);
7382 * elm_scroller_page_relative_set(sc, 1, 0);
7383 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7384 * elm_scroller_page_show(sc, h_page + 1, v_page);
7387 * @see elm_scroller_page_bring_in()
7389 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7391 * Show a specific virtual region within the scroller content object by page number.
7393 * @param obj The scroller object
7394 * @param h_pagenumber The horizontal page number
7395 * @param v_pagenumber The vertical page number
7397 * 0, 0 of the indicated page is located at the top-left of the viewport.
7398 * This will slide to the page with animation.
7403 * sc = elm_scroller_add(win);
7404 * elm_scroller_content_set(sc, content);
7405 * elm_scroller_page_relative_set(sc, 1, 0);
7406 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7407 * elm_scroller_page_bring_in(sc, h_page, v_page);
7410 * @see elm_scroller_page_show()
7412 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7414 * @brief Show a specific virtual region within the scroller content object.
7416 * @param obj The scroller object
7417 * @param x X coordinate of the region
7418 * @param y Y coordinate of the region
7419 * @param w Width of the region
7420 * @param h Height of the region
7422 * This will ensure all (or part if it does not fit) of the designated
7423 * region in the virtual content object (0, 0 starting at the top-left of the
7424 * virtual content object) is shown within the scroller. Unlike
7425 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7426 * to this location (if configuration in general calls for transitions). It
7427 * may not jump immediately to the new location and make take a while and
7428 * show other content along the way.
7430 * @see elm_scroller_region_show()
7432 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);
7434 * @brief Set event propagation on a scroller
7436 * @param obj The scroller object
7437 * @param propagation If propagation is enabled or not
7439 * This enables or disabled event propagation from the scroller content to
7440 * the scroller and its parent. By default event propagation is disabled.
7442 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7444 * @brief Get event propagation for a scroller
7446 * @param obj The scroller object
7447 * @return The propagation state
7449 * This gets the event propagation for a scroller.
7451 * @see elm_scroller_propagate_events_set()
7453 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7455 * @brief Set scrolling gravity on a scroller
7457 * @param obj The scroller object
7458 * @param x The scrolling horizontal gravity
7459 * @param y The scrolling vertical gravity
7461 * The gravity, defines how the scroller will adjust its view
7462 * when the size of the scroller contents increase.
7464 * The scroller will adjust the view to glue itself as follows.
7466 * x=0.0, for showing the left most region of the content.
7467 * x=1.0, for showing the right most region of the content.
7468 * y=0.0, for showing the bottom most region of the content.
7469 * y=1.0, for showing the top most region of the content.
7471 * Default values for x and y are 0.0
7473 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7475 * @brief Get scrolling gravity values for a scroller
7477 * @param obj The scroller object
7478 * @param x The scrolling horizontal gravity
7479 * @param y The scrolling vertical gravity
7481 * This gets gravity values for a scroller.
7483 * @see elm_scroller_gravity_set()
7486 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7492 * @defgroup Label Label
7494 * @image html img/widget/label/preview-00.png
7495 * @image latex img/widget/label/preview-00.eps
7497 * @brief Widget to display text, with simple html-like markup.
7499 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7500 * text doesn't fit the geometry of the label it will be ellipsized or be
7501 * cut. Elementary provides several themes for this widget:
7502 * @li default - No animation
7503 * @li marker - Centers the text in the label and make it bold by default
7504 * @li slide_long - The entire text appears from the right of the screen and
7505 * slides until it disappears in the left of the screen(reappering on the
7507 * @li slide_short - The text appears in the left of the label and slides to
7508 * the right to show the overflow. When all of the text has been shown the
7509 * position is reset.
7510 * @li slide_bounce - The text appears in the left of the label and slides to
7511 * the right to show the overflow. When all of the text has been shown the
7512 * animation reverses, moving the text to the left.
7514 * Custom themes can of course invent new markup tags and style them any way
7517 * The following signals may be emitted by the label widget:
7518 * @li "language,changed": The program's language changed.
7520 * See @ref tutorial_label for a demonstration of how to use a label widget.
7524 * @brief Add a new label to the parent
7526 * @param parent The parent object
7527 * @return The new object or NULL if it cannot be created
7529 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7531 * @brief Set the label on the label object
7533 * @param obj The label object
7534 * @param label The label will be used on the label object
7535 * @deprecated See elm_object_text_set()
7537 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 */
7539 * @brief Get the label used on the label object
7541 * @param obj The label object
7542 * @return The string inside the label
7543 * @deprecated See elm_object_text_get()
7545 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7547 * @brief Set the wrapping behavior of the label
7549 * @param obj The label object
7550 * @param wrap To wrap text or not
7552 * By default no wrapping is done. Possible values for @p wrap are:
7553 * @li ELM_WRAP_NONE - No wrapping
7554 * @li ELM_WRAP_CHAR - wrap between characters
7555 * @li ELM_WRAP_WORD - wrap between words
7556 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7558 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7560 * @brief Get the wrapping behavior of the label
7562 * @param obj The label object
7565 * @see elm_label_line_wrap_set()
7567 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7569 * @brief Set wrap width of the label
7571 * @param obj The label object
7572 * @param w The wrap width in pixels at a minimum where words need to wrap
7574 * This function sets the maximum width size hint of the label.
7576 * @warning This is only relevant if the label is inside a container.
7578 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7580 * @brief Get wrap width of the label
7582 * @param obj The label object
7583 * @return The wrap width in pixels at a minimum where words need to wrap
7585 * @see elm_label_wrap_width_set()
7587 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7589 * @brief Set wrap height of the label
7591 * @param obj The label object
7592 * @param h The wrap height in pixels at a minimum where words need to wrap
7594 * This function sets the maximum height size hint of the label.
7596 * @warning This is only relevant if the label is inside a container.
7598 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7600 * @brief get wrap width of the label
7602 * @param obj The label object
7603 * @return The wrap height in pixels at a minimum where words need to wrap
7605 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7607 * @brief Set the font size on the label object.
7609 * @param obj The label object
7610 * @param size font size
7612 * @warning NEVER use this. It is for hyper-special cases only. use styles
7613 * instead. e.g. "big", "medium", "small" - or better name them by use:
7614 * "title", "footnote", "quote" etc.
7616 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7618 * @brief Set the text color on the label object
7620 * @param obj The label object
7621 * @param r Red property background color of The label object
7622 * @param g Green property background color of The label object
7623 * @param b Blue property background color of The label object
7624 * @param a Alpha property background color of The label object
7626 * @warning NEVER use this. It is for hyper-special cases only. use styles
7627 * instead. e.g. "big", "medium", "small" - or better name them by use:
7628 * "title", "footnote", "quote" etc.
7630 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);
7632 * @brief Set the text align on the label object
7634 * @param obj The label object
7635 * @param align align mode ("left", "center", "right")
7637 * @warning NEVER use this. It is for hyper-special cases only. use styles
7638 * instead. e.g. "big", "medium", "small" - or better name them by use:
7639 * "title", "footnote", "quote" etc.
7641 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7643 * @brief Set background color of the label
7645 * @param obj The label object
7646 * @param r Red property background color of The label object
7647 * @param g Green property background color of The label object
7648 * @param b Blue property background color of The label object
7649 * @param a Alpha property background alpha of The label object
7651 * @warning NEVER use this. It is for hyper-special cases only. use styles
7652 * instead. e.g. "big", "medium", "small" - or better name them by use:
7653 * "title", "footnote", "quote" etc.
7655 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);
7657 * @brief Set the ellipsis behavior of the label
7659 * @param obj The label object
7660 * @param ellipsis To ellipsis text or not
7662 * If set to true and the text doesn't fit in the label an ellipsis("...")
7663 * will be shown at the end of the widget.
7665 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7666 * choosen wrap method was ELM_WRAP_WORD.
7668 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7669 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7671 * @brief Set the text slide of the label
7673 * @param obj The label object
7674 * @param slide To start slide or stop
7676 * If set to true, the text of the label will slide/scroll through the length of
7679 * @warning This only works with the themes "slide_short", "slide_long" and
7682 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7684 * @brief Get the text slide mode of the label
7686 * @param obj The label object
7687 * @return slide slide mode value
7689 * @see elm_label_slide_set()
7691 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7693 * @brief Set the slide duration(speed) of the label
7695 * @param obj The label object
7696 * @return The duration in seconds in moving text from slide begin position
7697 * to slide end position
7699 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7701 * @brief Get the slide duration(speed) of the label
7703 * @param obj The label object
7704 * @return The duration time in moving text from slide begin position to slide end position
7706 * @see elm_label_slide_duration_set()
7708 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7714 * @defgroup Toggle Toggle
7716 * @image html img/widget/toggle/preview-00.png
7717 * @image latex img/widget/toggle/preview-00.eps
7719 * @brief A toggle is a slider which can be used to toggle between
7720 * two values. It has two states: on and off.
7722 * This widget is deprecated. Please use elm_check_add() instead using the
7723 * toggle style like:
7726 * obj = elm_check_add(parent);
7727 * elm_object_style_set(obj, "toggle");
7728 * elm_object_text_part_set(obj, "on", "ON");
7729 * elm_object_text_part_set(obj, "off", "OFF");
7732 * Signals that you can add callbacks for are:
7733 * @li "changed" - Whenever the toggle value has been changed. Is not called
7734 * until the toggle is released by the cursor (assuming it
7735 * has been triggered by the cursor in the first place).
7737 * @ref tutorial_toggle show how to use a toggle.
7741 * @brief Add a toggle to @p parent.
7743 * @param parent The parent object
7745 * @return The toggle object
7747 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7749 * @brief Sets the label to be displayed with the toggle.
7751 * @param obj The toggle object
7752 * @param label The label to be displayed
7754 * @deprecated use elm_object_text_set() instead.
7756 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7758 * @brief Gets the label of the toggle
7760 * @param obj toggle object
7761 * @return The label of the toggle
7763 * @deprecated use elm_object_text_get() instead.
7765 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7767 * @brief Set the icon used for the toggle
7769 * @param obj The toggle object
7770 * @param icon The icon object for the button
7772 * Once the icon object is set, a previously set one will be deleted
7773 * If you want to keep that old content object, use the
7774 * elm_toggle_icon_unset() function.
7776 * @deprecated use elm_object_content_set() instead.
7778 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7780 * @brief Get the icon used for the toggle
7782 * @param obj The toggle object
7783 * @return The icon object that is being used
7785 * Return the icon object which is set for this widget.
7787 * @see elm_toggle_icon_set()
7789 * @deprecated use elm_object_content_get() instead.
7791 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7793 * @brief Unset the icon used for the toggle
7795 * @param obj The toggle object
7796 * @return The icon object that was being used
7798 * Unparent and return the icon object which was set for this widget.
7800 * @see elm_toggle_icon_set()
7802 * @deprecated use elm_object_content_unset() instead.
7804 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7806 * @brief Sets the labels to be associated with the on and off states of the toggle.
7808 * @param obj The toggle object
7809 * @param onlabel The label displayed when the toggle is in the "on" state
7810 * @param offlabel The label displayed when the toggle is in the "off" state
7812 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7815 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7817 * @brief Gets the labels associated with the on and off states of the
7820 * @param obj The toggle object
7821 * @param onlabel A char** to place the onlabel of @p obj into
7822 * @param offlabel A char** to place the offlabel of @p obj into
7824 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7827 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7829 * @brief Sets the state of the toggle to @p state.
7831 * @param obj The toggle object
7832 * @param state The state of @p obj
7834 * @deprecated use elm_check_state_set() instead.
7836 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7838 * @brief Gets the state of the toggle to @p state.
7840 * @param obj The toggle object
7841 * @return The state of @p obj
7843 * @deprecated use elm_check_state_get() instead.
7845 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7847 * @brief Sets the state pointer of the toggle to @p statep.
7849 * @param obj The toggle object
7850 * @param statep The state pointer of @p obj
7852 * @deprecated use elm_check_state_pointer_set() instead.
7854 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7860 * @defgroup Frame Frame
7862 * @image html img/widget/frame/preview-00.png
7863 * @image latex img/widget/frame/preview-00.eps
7865 * @brief Frame is a widget that holds some content and has a title.
7867 * The default look is a frame with a title, but Frame supports multple
7875 * @li outdent_bottom
7877 * Of all this styles only default shows the title. Frame emits no signals.
7879 * Default contents parts of the frame widget that you can use for are:
7880 * @li "elm.swallow.content" - A content of the frame
7882 * Default text parts of the frame widget that you can use for are:
7883 * @li "elm.text" - Label of the frame
7885 * For a detailed example see the @ref tutorial_frame.
7890 * @brief Add a new frame to the parent
7892 * @param parent The parent object
7893 * @return The new object or NULL if it cannot be created
7895 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7897 * @brief Set the frame label
7899 * @param obj The frame object
7900 * @param label The label of this frame object
7902 * @deprecated use elm_object_text_set() instead.
7904 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7906 * @brief Get the frame label
7908 * @param obj The frame object
7910 * @return The label of this frame objet or NULL if unable to get frame
7912 * @deprecated use elm_object_text_get() instead.
7914 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7916 * @brief Set the content of the frame widget
7918 * Once the content object is set, a previously set one will be deleted.
7919 * If you want to keep that old content object, use the
7920 * elm_frame_content_unset() function.
7922 * @param obj The frame object
7923 * @param content The content will be filled in this frame object
7925 * @deprecated use elm_object_content_set() instead.
7927 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7929 * @brief Get the content of the frame widget
7931 * Return the content object which is set for this widget
7933 * @param obj The frame object
7934 * @return The content that is being used
7936 * @deprecated use elm_object_content_get() instead.
7938 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7940 * @brief Unset the content of the frame widget
7942 * Unparent and return the content object which was set for this widget
7944 * @param obj The frame object
7945 * @return The content that was being used
7947 * @deprecated use elm_object_content_unset() instead.
7949 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7955 * @defgroup Table Table
7957 * A container widget to arrange other widgets in a table where items can
7958 * also span multiple columns or rows - even overlap (and then be raised or
7959 * lowered accordingly to adjust stacking if they do overlap).
7961 * For a Table widget the row/column count is not fixed.
7962 * The table widget adjusts itself when subobjects are added to it dynamically.
7964 * The followin are examples of how to use a table:
7965 * @li @ref tutorial_table_01
7966 * @li @ref tutorial_table_02
7971 * @brief Add a new table to the parent
7973 * @param parent The parent object
7974 * @return The new object or NULL if it cannot be created
7976 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7978 * @brief Set the homogeneous layout in the table
7980 * @param obj The layout object
7981 * @param homogeneous A boolean to set if the layout is homogeneous in the
7982 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7984 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7986 * @brief Get the current table homogeneous mode.
7988 * @param obj The table object
7989 * @return A boolean to indicating if the layout is homogeneous in the table
7990 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7992 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7994 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7996 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7998 * @warning <b>Use elm_table_homogeneous_get() instead</b>
8000 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8002 * @brief Set padding between cells.
8004 * @param obj The layout object.
8005 * @param horizontal set the horizontal padding.
8006 * @param vertical set the vertical padding.
8008 * Default value is 0.
8010 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8012 * @brief Get padding between cells.
8014 * @param obj The layout object.
8015 * @param horizontal set the horizontal padding.
8016 * @param vertical set the vertical padding.
8018 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8020 * @brief Add a subobject on the table with the coordinates passed
8022 * @param obj The table object
8023 * @param subobj The subobject to be added to the table
8024 * @param x Row number
8025 * @param y Column number
8029 * @note All positioning inside the table is relative to rows and columns, so
8030 * a value of 0 for x and y, means the top left cell of the table, and a
8031 * value of 1 for w and h means @p subobj only takes that 1 cell.
8033 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8035 * @brief Remove child from table.
8037 * @param obj The table object
8038 * @param subobj The subobject
8040 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8042 * @brief Faster way to remove all child objects from a table object.
8044 * @param obj The table object
8045 * @param clear If true, will delete children, else just remove from table.
8047 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8049 * @brief Set the packing location of an existing child of the table
8051 * @param subobj The subobject to be modified in the table
8052 * @param x Row number
8053 * @param y Column number
8057 * Modifies the position of an object already in the table.
8059 * @note All positioning inside the table is relative to rows and columns, so
8060 * a value of 0 for x and y, means the top left cell of the table, and a
8061 * value of 1 for w and h means @p subobj only takes that 1 cell.
8063 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8065 * @brief Get the packing location of an existing child of the table
8067 * @param subobj The subobject to be modified in the table
8068 * @param x Row number
8069 * @param y Column number
8073 * @see elm_table_pack_set()
8075 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8081 * @defgroup Gengrid Gengrid (Generic grid)
8083 * This widget aims to position objects in a grid layout while
8084 * actually creating and rendering only the visible ones, using the
8085 * same idea as the @ref Genlist "genlist": the user defines a @b
8086 * class for each item, specifying functions that will be called at
8087 * object creation, deletion, etc. When those items are selected by
8088 * the user, a callback function is issued. Users may interact with
8089 * a gengrid via the mouse (by clicking on items to select them and
8090 * clicking on the grid's viewport and swiping to pan the whole
8091 * view) or via the keyboard, navigating through item with the
8094 * @section Gengrid_Layouts Gengrid layouts
8096 * Gengrid may layout its items in one of two possible layouts:
8100 * When in "horizontal mode", items will be placed in @b columns,
8101 * from top to bottom and, when the space for a column is filled,
8102 * another one is started on the right, thus expanding the grid
8103 * horizontally, making for horizontal scrolling. When in "vertical
8104 * mode" , though, items will be placed in @b rows, from left to
8105 * right and, when the space for a row is filled, another one is
8106 * started below, thus expanding the grid vertically (and making
8107 * for vertical scrolling).
8109 * @section Gengrid_Items Gengrid items
8111 * An item in a gengrid can have 0 or more text labels (they can be
8112 * regular text or textblock Evas objects - that's up to the style
8113 * to determine), 0 or more icons (which are simply objects
8114 * swallowed into the gengrid item's theming Edje object) and 0 or
8115 * more <b>boolean states</b>, which have the behavior left to the
8116 * user to define. The Edje part names for each of these properties
8117 * will be looked up, in the theme file for the gengrid, under the
8118 * Edje (string) data items named @c "labels", @c "icons" and @c
8119 * "states", respectively. For each of those properties, if more
8120 * than one part is provided, they must have names listed separated
8121 * by spaces in the data fields. For the default gengrid item
8122 * theme, we have @b one label part (@c "elm.text"), @b two icon
8123 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8126 * A gengrid item may be at one of several styles. Elementary
8127 * provides one by default - "default", but this can be extended by
8128 * system or application custom themes/overlays/extensions (see
8129 * @ref Theme "themes" for more details).
8131 * @section Gengrid_Item_Class Gengrid item classes
8133 * In order to have the ability to add and delete items on the fly,
8134 * gengrid implements a class (callback) system where the
8135 * application provides a structure with information about that
8136 * type of item (gengrid may contain multiple different items with
8137 * different classes, states and styles). Gengrid will call the
8138 * functions in this struct (methods) when an item is "realized"
8139 * (i.e., created dynamically, while the user is scrolling the
8140 * grid). All objects will simply be deleted when no longer needed
8141 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8142 * contains the following members:
8143 * - @c item_style - This is a constant string and simply defines
8144 * the name of the item style. It @b must be specified and the
8145 * default should be @c "default".
8146 * - @c func.label_get - This function is called when an item
8147 * object is actually created. The @c data parameter will point to
8148 * the same data passed to elm_gengrid_item_append() and related
8149 * item creation functions. The @c obj parameter is the gengrid
8150 * object itself, while the @c part one is the name string of one
8151 * of the existing text parts in the Edje group implementing the
8152 * item's theme. This function @b must return a strdup'()ed string,
8153 * as the caller will free() it when done. See
8154 * #Elm_Gengrid_Item_Label_Get_Cb.
8155 * - @c func.content_get - This function is called when an item object
8156 * is actually created. The @c data parameter will point to the
8157 * same data passed to elm_gengrid_item_append() and related item
8158 * creation functions. The @c obj parameter is the gengrid object
8159 * itself, while the @c part one is the name string of one of the
8160 * existing (content) swallow parts in the Edje group implementing the
8161 * item's theme. It must return @c NULL, when no content is desired,
8162 * or a valid object handle, otherwise. The object will be deleted
8163 * by the gengrid on its deletion or when the item is "unrealized".
8164 * See #Elm_Gengrid_Item_Content_Get_Cb.
8165 * - @c func.state_get - This function is called when an item
8166 * object is actually created. The @c data parameter will point to
8167 * the same data passed to elm_gengrid_item_append() and related
8168 * item creation functions. The @c obj parameter is the gengrid
8169 * object itself, while the @c part one is the name string of one
8170 * of the state parts in the Edje group implementing the item's
8171 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8172 * true/on. Gengrids will emit a signal to its theming Edje object
8173 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8174 * "source" arguments, respectively, when the state is true (the
8175 * default is false), where @c XXX is the name of the (state) part.
8176 * See #Elm_Gengrid_Item_State_Get_Cb.
8177 * - @c func.del - This is called when elm_gengrid_item_del() is
8178 * called on an item or elm_gengrid_clear() is called on the
8179 * gengrid. This is intended for use when gengrid items are
8180 * deleted, so any data attached to the item (e.g. its data
8181 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8183 * @section Gengrid_Usage_Hints Usage hints
8185 * If the user wants to have multiple items selected at the same
8186 * time, elm_gengrid_multi_select_set() will permit it. If the
8187 * gengrid is single-selection only (the default), then
8188 * elm_gengrid_select_item_get() will return the selected item or
8189 * @c NULL, if none is selected. If the gengrid is under
8190 * multi-selection, then elm_gengrid_selected_items_get() will
8191 * return a list (that is only valid as long as no items are
8192 * modified (added, deleted, selected or unselected) of child items
8195 * If an item changes (internal (boolean) state, label or content
8196 * changes), then use elm_gengrid_item_update() to have gengrid
8197 * update the item with the new state. A gengrid will re-"realize"
8198 * the item, thus calling the functions in the
8199 * #Elm_Gengrid_Item_Class set for that item.
8201 * To programmatically (un)select an item, use
8202 * elm_gengrid_item_selected_set(). To get its selected state use
8203 * elm_gengrid_item_selected_get(). To make an item disabled
8204 * (unable to be selected and appear differently) use
8205 * elm_gengrid_item_disabled_set() to set this and
8206 * elm_gengrid_item_disabled_get() to get the disabled state.
8208 * Grid cells will only have their selection smart callbacks called
8209 * when firstly getting selected. Any further clicks will do
8210 * nothing, unless you enable the "always select mode", with
8211 * elm_gengrid_always_select_mode_set(), thus making every click to
8212 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8213 * turn off the ability to select items entirely in the widget and
8214 * they will neither appear selected nor call the selection smart
8217 * Remember that you can create new styles and add your own theme
8218 * augmentation per application with elm_theme_extension_add(). If
8219 * you absolutely must have a specific style that overrides any
8220 * theme the user or system sets up you can use
8221 * elm_theme_overlay_add() to add such a file.
8223 * @section Gengrid_Smart_Events Gengrid smart events
8225 * Smart events that you can add callbacks for are:
8226 * - @c "activated" - The user has double-clicked or pressed
8227 * (enter|return|spacebar) on an item. The @c event_info parameter
8228 * is the gengrid item that was activated.
8229 * - @c "clicked,double" - The user has double-clicked an item.
8230 * The @c event_info parameter is the gengrid item that was double-clicked.
8231 * - @c "longpressed" - This is called when the item is pressed for a certain
8232 * amount of time. By default it's 1 second.
8233 * - @c "selected" - The user has made an item selected. The
8234 * @c event_info parameter is the gengrid item that was selected.
8235 * - @c "unselected" - The user has made an item unselected. The
8236 * @c event_info parameter is the gengrid item that was unselected.
8237 * - @c "realized" - This is called when the item in the gengrid
8238 * has its implementing Evas object instantiated, de facto. @c
8239 * event_info is the gengrid item that was created. The object
8240 * may be deleted at any time, so it is highly advised to the
8241 * caller @b not to use the object pointer returned from
8242 * elm_gengrid_item_object_get(), because it may point to freed
8244 * - @c "unrealized" - This is called when the implementing Evas
8245 * object for this item is deleted. @c event_info is the gengrid
8246 * item that was deleted.
8247 * - @c "changed" - Called when an item is added, removed, resized
8248 * or moved and when the gengrid is resized or gets "horizontal"
8250 * - @c "scroll,anim,start" - This is called when scrolling animation has
8252 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8254 * - @c "drag,start,up" - Called when the item in the gengrid has
8255 * been dragged (not scrolled) up.
8256 * - @c "drag,start,down" - Called when the item in the gengrid has
8257 * been dragged (not scrolled) down.
8258 * - @c "drag,start,left" - Called when the item in the gengrid has
8259 * been dragged (not scrolled) left.
8260 * - @c "drag,start,right" - Called when the item in the gengrid has
8261 * been dragged (not scrolled) right.
8262 * - @c "drag,stop" - Called when the item in the gengrid has
8263 * stopped being dragged.
8264 * - @c "drag" - Called when the item in the gengrid is being
8266 * - @c "scroll" - called when the content has been scrolled
8268 * - @c "scroll,drag,start" - called when dragging the content has
8270 * - @c "scroll,drag,stop" - called when dragging the content has
8272 * - @c "edge,top" - This is called when the gengrid is scrolled until
8274 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8275 * until the bottom edge.
8276 * - @c "edge,left" - This is called when the gengrid is scrolled
8277 * until the left edge.
8278 * - @c "edge,right" - This is called when the gengrid is scrolled
8279 * until the right edge.
8281 * List of gengrid examples:
8282 * @li @ref gengrid_example
8286 * @addtogroup Gengrid
8290 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8291 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8292 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8293 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8294 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8295 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
8296 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8298 /* temporary compatibility code */
8299 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8300 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8301 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8302 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8305 * @struct _Elm_Gengrid_Item_Class
8307 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8310 struct _Elm_Gengrid_Item_Class
8312 const char *item_style;
8313 struct _Elm_Gengrid_Item_Class_Func
8315 Elm_Gengrid_Item_Label_Get_Cb label_get;
8316 union { /* temporary compatibility code */
8317 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8318 Elm_Gengrid_Item_Content_Get_Cb content_get;
8320 Elm_Gengrid_Item_State_Get_Cb state_get;
8321 Elm_Gengrid_Item_Del_Cb del;
8323 }; /**< #Elm_Gengrid_Item_Class member definitions */
8325 * Add a new gengrid widget to the given parent Elementary
8326 * (container) object
8328 * @param parent The parent object
8329 * @return a new gengrid widget handle or @c NULL, on errors
8331 * This function inserts a new gengrid widget on the canvas.
8333 * @see elm_gengrid_item_size_set()
8334 * @see elm_gengrid_group_item_size_set()
8335 * @see elm_gengrid_horizontal_set()
8336 * @see elm_gengrid_item_append()
8337 * @see elm_gengrid_item_del()
8338 * @see elm_gengrid_clear()
8342 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8345 * Set the size for the items of a given gengrid widget
8347 * @param obj The gengrid object.
8348 * @param w The items' width.
8349 * @param h The items' height;
8351 * A gengrid, after creation, has still no information on the size
8352 * to give to each of its cells. So, you most probably will end up
8353 * with squares one @ref Fingers "finger" wide, the default
8354 * size. Use this function to force a custom size for you items,
8355 * making them as big as you wish.
8357 * @see elm_gengrid_item_size_get()
8361 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8364 * Get the size set for the items of a given gengrid widget
8366 * @param obj The gengrid object.
8367 * @param w Pointer to a variable where to store the items' width.
8368 * @param h Pointer to a variable where to store the items' height.
8370 * @note Use @c NULL pointers on the size values you're not
8371 * interested in: they'll be ignored by the function.
8373 * @see elm_gengrid_item_size_get() for more details
8377 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8380 * Set the items grid's alignment within a given gengrid widget
8382 * @param obj The gengrid object.
8383 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8384 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8386 * This sets the alignment of the whole grid of items of a gengrid
8387 * within its given viewport. By default, those values are both
8388 * 0.5, meaning that the gengrid will have its items grid placed
8389 * exactly in the middle of its viewport.
8391 * @note If given alignment values are out of the cited ranges,
8392 * they'll be changed to the nearest boundary values on the valid
8395 * @see elm_gengrid_align_get()
8399 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8402 * Get the items grid's alignment values within a given gengrid
8405 * @param obj The gengrid object.
8406 * @param align_x Pointer to a variable where to store the
8407 * horizontal alignment.
8408 * @param align_y Pointer to a variable where to store the vertical
8411 * @note Use @c NULL pointers on the alignment values you're not
8412 * interested in: they'll be ignored by the function.
8414 * @see elm_gengrid_align_set() for more details
8418 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8421 * Set whether a given gengrid widget is or not able have items
8424 * @param obj The gengrid object
8425 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8426 * @c EINA_FALSE to turn it off
8428 * If a gengrid is set to allow reordering, a click held for more
8429 * than 0.5 over a given item will highlight it specially,
8430 * signalling the gengrid has entered the reordering state. From
8431 * that time on, the user will be able to, while still holding the
8432 * mouse button down, move the item freely in the gengrid's
8433 * viewport, replacing to said item to the locations it goes to.
8434 * The replacements will be animated and, whenever the user
8435 * releases the mouse button, the item being replaced gets a new
8436 * definitive place in the grid.
8438 * @see elm_gengrid_reorder_mode_get()
8442 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8445 * Get whether a given gengrid widget is or not able have items
8448 * @param obj The gengrid object
8449 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8452 * @see elm_gengrid_reorder_mode_set() for more details
8456 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8459 * Append a new item in a given gengrid widget.
8461 * @param obj The gengrid object.
8462 * @param gic The item class for the item.
8463 * @param data The item data.
8464 * @param func Convenience function called when the item is
8466 * @param func_data Data to be passed to @p func.
8467 * @return A handle to the item added or @c NULL, on errors.
8469 * This adds an item to the beginning of the gengrid.
8471 * @see elm_gengrid_item_prepend()
8472 * @see elm_gengrid_item_insert_before()
8473 * @see elm_gengrid_item_insert_after()
8474 * @see elm_gengrid_item_del()
8478 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);
8481 * Prepend a new item in a given gengrid widget.
8483 * @param obj The gengrid object.
8484 * @param gic The item class for the item.
8485 * @param data The item data.
8486 * @param func Convenience function called when the item is
8488 * @param func_data Data to be passed to @p func.
8489 * @return A handle to the item added or @c NULL, on errors.
8491 * This adds an item to the end of the gengrid.
8493 * @see elm_gengrid_item_append()
8494 * @see elm_gengrid_item_insert_before()
8495 * @see elm_gengrid_item_insert_after()
8496 * @see elm_gengrid_item_del()
8500 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);
8503 * Insert an item before another in a gengrid widget
8505 * @param obj The gengrid object.
8506 * @param gic The item class for the item.
8507 * @param data The item data.
8508 * @param relative The item to place this new one before.
8509 * @param func Convenience function called when the item is
8511 * @param func_data Data to be passed to @p func.
8512 * @return A handle to the item added or @c NULL, on errors.
8514 * This inserts an item before another in the gengrid.
8516 * @see elm_gengrid_item_append()
8517 * @see elm_gengrid_item_prepend()
8518 * @see elm_gengrid_item_insert_after()
8519 * @see elm_gengrid_item_del()
8523 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);
8526 * Insert an item after another in a gengrid widget
8528 * @param obj The gengrid object.
8529 * @param gic The item class for the item.
8530 * @param data The item data.
8531 * @param relative The item to place this new one after.
8532 * @param func Convenience function called when the item is
8534 * @param func_data Data to be passed to @p func.
8535 * @return A handle to the item added or @c NULL, on errors.
8537 * This inserts an item after another in the gengrid.
8539 * @see elm_gengrid_item_append()
8540 * @see elm_gengrid_item_prepend()
8541 * @see elm_gengrid_item_insert_after()
8542 * @see elm_gengrid_item_del()
8546 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);
8549 * Insert an item in a gengrid widget using a user-defined sort function.
8551 * @param obj The gengrid object.
8552 * @param gic The item class for the item.
8553 * @param data The item data.
8554 * @param comp User defined comparison function that defines the sort order based on
8555 * Elm_Gen_Item and its data param.
8556 * @param func Convenience function called when the item is selected.
8557 * @param func_data Data to be passed to @p func.
8558 * @return A handle to the item added or @c NULL, on errors.
8560 * This inserts an item in the gengrid based on user defined comparison function.
8562 * @see elm_gengrid_item_append()
8563 * @see elm_gengrid_item_prepend()
8564 * @see elm_gengrid_item_insert_after()
8565 * @see elm_gengrid_item_del()
8566 * @see elm_gengrid_item_direct_sorted_insert()
8570 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);
8573 * Insert an item in a gengrid widget using a user-defined sort function.
8575 * @param obj The gengrid object.
8576 * @param gic The item class for the item.
8577 * @param data The item data.
8578 * @param comp User defined comparison function that defines the sort order based on
8580 * @param func Convenience function called when the item is selected.
8581 * @param func_data Data to be passed to @p func.
8582 * @return A handle to the item added or @c NULL, on errors.
8584 * This inserts an item in the gengrid based on user defined comparison function.
8586 * @see elm_gengrid_item_append()
8587 * @see elm_gengrid_item_prepend()
8588 * @see elm_gengrid_item_insert_after()
8589 * @see elm_gengrid_item_del()
8590 * @see elm_gengrid_item_sorted_insert()
8594 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);
8597 * Set whether items on a given gengrid widget are to get their
8598 * selection callbacks issued for @b every subsequent selection
8599 * click on them or just for the first click.
8601 * @param obj The gengrid object
8602 * @param always_select @c EINA_TRUE to make items "always
8603 * selected", @c EINA_FALSE, otherwise
8605 * By default, grid items will only call their selection callback
8606 * function when firstly getting selected, any subsequent further
8607 * clicks will do nothing. With this call, you make those
8608 * subsequent clicks also to issue the selection callbacks.
8610 * @note <b>Double clicks</b> will @b always be reported on items.
8612 * @see elm_gengrid_always_select_mode_get()
8616 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8619 * Get whether items on a given gengrid widget have their selection
8620 * callbacks issued for @b every subsequent selection click on them
8621 * or just for the first click.
8623 * @param obj The gengrid object.
8624 * @return @c EINA_TRUE if the gengrid items are "always selected",
8625 * @c EINA_FALSE, otherwise
8627 * @see elm_gengrid_always_select_mode_set() for more details
8631 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8634 * Set whether items on a given gengrid widget can be selected or not.
8636 * @param obj The gengrid object
8637 * @param no_select @c EINA_TRUE to make items selectable,
8638 * @c EINA_FALSE otherwise
8640 * This will make items in @p obj selectable or not. In the latter
8641 * case, any user interaction on the gengrid items will neither make
8642 * them appear selected nor them call their selection callback
8645 * @see elm_gengrid_no_select_mode_get()
8649 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8652 * Get whether items on a given gengrid widget can be selected or
8655 * @param obj The gengrid object
8656 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8659 * @see elm_gengrid_no_select_mode_set() for more details
8663 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8666 * Enable or disable multi-selection in a given gengrid widget
8668 * @param obj The gengrid object.
8669 * @param multi @c EINA_TRUE, to enable multi-selection,
8670 * @c EINA_FALSE to disable it.
8672 * Multi-selection is the ability to have @b more than one
8673 * item selected, on a given gengrid, simultaneously. When it is
8674 * enabled, a sequence of clicks on different items will make them
8675 * all selected, progressively. A click on an already selected item
8676 * will unselect it. If interacting via the keyboard,
8677 * multi-selection is enabled while holding the "Shift" key.
8679 * @note By default, multi-selection is @b disabled on gengrids
8681 * @see elm_gengrid_multi_select_get()
8685 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8688 * Get whether multi-selection is enabled or disabled for a given
8691 * @param obj The gengrid object.
8692 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8693 * EINA_FALSE otherwise
8695 * @see elm_gengrid_multi_select_set() for more details
8699 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8702 * Enable or disable bouncing effect for a given gengrid widget
8704 * @param obj The gengrid object
8705 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8706 * @c EINA_FALSE to disable it
8707 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8708 * @c EINA_FALSE to disable it
8710 * The bouncing effect occurs whenever one reaches the gengrid's
8711 * edge's while panning it -- it will scroll past its limits a
8712 * little bit and return to the edge again, in a animated for,
8715 * @note By default, gengrids have bouncing enabled on both axis
8717 * @see elm_gengrid_bounce_get()
8721 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8724 * Get whether bouncing effects are enabled or disabled, for a
8725 * given gengrid widget, on each axis
8727 * @param obj The gengrid object
8728 * @param h_bounce Pointer to a variable where to store the
8729 * horizontal bouncing flag.
8730 * @param v_bounce Pointer to a variable where to store the
8731 * vertical bouncing flag.
8733 * @see elm_gengrid_bounce_set() for more details
8737 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8740 * Set a given gengrid widget's scrolling page size, relative to
8741 * its viewport size.
8743 * @param obj The gengrid object
8744 * @param h_pagerel The horizontal page (relative) size
8745 * @param v_pagerel The vertical page (relative) size
8747 * The gengrid's scroller is capable of binding scrolling by the
8748 * user to "pages". It means that, while scrolling and, specially
8749 * after releasing the mouse button, the grid will @b snap to the
8750 * nearest displaying page's area. When page sizes are set, the
8751 * grid's continuous content area is split into (equal) page sized
8754 * This function sets the size of a page <b>relatively to the
8755 * viewport dimensions</b> of the gengrid, for each axis. A value
8756 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8757 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8758 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8759 * 1.0. Values beyond those will make it behave behave
8760 * inconsistently. If you only want one axis to snap to pages, use
8761 * the value @c 0.0 for the other one.
8763 * There is a function setting page size values in @b absolute
8764 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8765 * is mutually exclusive to this one.
8767 * @see elm_gengrid_page_relative_get()
8771 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8774 * Get a given gengrid widget's scrolling page size, relative to
8775 * its viewport size.
8777 * @param obj The gengrid object
8778 * @param h_pagerel Pointer to a variable where to store the
8779 * horizontal page (relative) size
8780 * @param v_pagerel Pointer to a variable where to store the
8781 * vertical page (relative) size
8783 * @see elm_gengrid_page_relative_set() for more details
8787 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8790 * Set a given gengrid widget's scrolling page size
8792 * @param obj The gengrid object
8793 * @param h_pagerel The horizontal page size, in pixels
8794 * @param v_pagerel The vertical page size, in pixels
8796 * The gengrid's scroller is capable of binding scrolling by the
8797 * user to "pages". It means that, while scrolling and, specially
8798 * after releasing the mouse button, the grid will @b snap to the
8799 * nearest displaying page's area. When page sizes are set, the
8800 * grid's continuous content area is split into (equal) page sized
8803 * This function sets the size of a page of the gengrid, in pixels,
8804 * for each axis. Sane usable values are, between @c 0 and the
8805 * dimensions of @p obj, for each axis. Values beyond those will
8806 * make it behave behave inconsistently. If you only want one axis
8807 * to snap to pages, use the value @c 0 for the other one.
8809 * There is a function setting page size values in @b relative
8810 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8811 * use is mutually exclusive to this one.
8815 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8818 * Set the direction in which a given gengrid widget will expand while
8819 * placing its items.
8821 * @param obj The gengrid object.
8822 * @param setting @c EINA_TRUE to make the gengrid expand
8823 * horizontally, @c EINA_FALSE to expand vertically.
8825 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8826 * in @b columns, from top to bottom and, when the space for a
8827 * column is filled, another one is started on the right, thus
8828 * expanding the grid horizontally. When in "vertical mode"
8829 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8830 * to right and, when the space for a row is filled, another one is
8831 * started below, thus expanding the grid vertically.
8833 * @see elm_gengrid_horizontal_get()
8837 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8840 * Get for what direction a given gengrid widget will expand while
8841 * placing its items.
8843 * @param obj The gengrid object.
8844 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8845 * @c EINA_FALSE if it's set to expand vertically.
8847 * @see elm_gengrid_horizontal_set() for more detais
8851 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8854 * Get the first item in a given gengrid widget
8856 * @param obj The gengrid object
8857 * @return The first item's handle or @c NULL, if there are no
8858 * items in @p obj (and on errors)
8860 * This returns the first item in the @p obj's internal list of
8863 * @see elm_gengrid_last_item_get()
8867 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8870 * Get the last item in a given gengrid widget
8872 * @param obj The gengrid object
8873 * @return The last item's handle or @c NULL, if there are no
8874 * items in @p obj (and on errors)
8876 * This returns the last item in the @p obj's internal list of
8879 * @see elm_gengrid_first_item_get()
8883 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8886 * Get the @b next item in a gengrid widget's internal list of items,
8887 * given a handle to one of those items.
8889 * @param item The gengrid item to fetch next from
8890 * @return The item after @p item, or @c NULL if there's none (and
8893 * This returns the item placed after the @p item, on the container
8896 * @see elm_gengrid_item_prev_get()
8900 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8903 * Get the @b previous item in a gengrid widget's internal list of items,
8904 * given a handle to one of those items.
8906 * @param item The gengrid item to fetch previous from
8907 * @return The item before @p item, or @c NULL if there's none (and
8910 * This returns the item placed before the @p item, on the container
8913 * @see elm_gengrid_item_next_get()
8917 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8920 * Get the gengrid object's handle which contains a given gengrid
8923 * @param item The item to fetch the container from
8924 * @return The gengrid (parent) object
8926 * This returns the gengrid object itself that an item belongs to.
8930 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8933 * Remove a gengrid item from its parent, deleting it.
8935 * @param item The item to be removed.
8936 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8938 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8943 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8946 * Update the contents of a given gengrid item
8948 * @param item The gengrid item
8950 * This updates an item by calling all the item class functions
8951 * again to get the contents, labels and states. Use this when the
8952 * original item data has changed and you want the changes to be
8957 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8960 * Get the Gengrid Item class for the given Gengrid Item.
8962 * @param item The gengrid item
8964 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8965 * the function pointers and item_style.
8969 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8972 * Get the Gengrid Item class for the given Gengrid Item.
8974 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8975 * the function pointers and item_style.
8977 * @param item The gengrid item
8978 * @param gic The gengrid item class describing the function pointers and the item style.
8982 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8985 * Return the data associated to a given gengrid item
8987 * @param item The gengrid item.
8988 * @return the data associated with this item.
8990 * This returns the @c data value passed on the
8991 * elm_gengrid_item_append() and related item addition calls.
8993 * @see elm_gengrid_item_append()
8994 * @see elm_gengrid_item_data_set()
8998 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9001 * Set the data associated with a given gengrid item
9003 * @param item The gengrid item
9004 * @param data The data pointer to set on it
9006 * This @b overrides the @c data value passed on the
9007 * elm_gengrid_item_append() and related item addition calls. This
9008 * function @b won't call elm_gengrid_item_update() automatically,
9009 * so you'd issue it afterwards if you want to have the item
9010 * updated to reflect the new data.
9012 * @see elm_gengrid_item_data_get()
9013 * @see elm_gengrid_item_update()
9017 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9020 * Get a given gengrid item's position, relative to the whole
9021 * gengrid's grid area.
9023 * @param item The Gengrid item.
9024 * @param x Pointer to variable to store the item's <b>row number</b>.
9025 * @param y Pointer to variable to store the item's <b>column number</b>.
9027 * This returns the "logical" position of the item within the
9028 * gengrid. For example, @c (0, 1) would stand for first row,
9033 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9036 * Set whether a given gengrid item is selected or not
9038 * @param item The gengrid item
9039 * @param selected Use @c EINA_TRUE, to make it selected, @c
9040 * EINA_FALSE to make it unselected
9042 * This sets the selected state of an item. If multi-selection is
9043 * not enabled on the containing gengrid and @p selected is @c
9044 * EINA_TRUE, any other previously selected items will get
9045 * unselected in favor of this new one.
9047 * @see elm_gengrid_item_selected_get()
9051 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9054 * Get whether a given gengrid item is selected or not
9056 * @param item The gengrid item
9057 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9059 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9061 * @see elm_gengrid_item_selected_set() for more details
9065 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9068 * Get the real Evas object created to implement the view of a
9069 * given gengrid item
9071 * @param item The gengrid item.
9072 * @return the Evas object implementing this item's view.
9074 * This returns the actual Evas object used to implement the
9075 * specified gengrid item's view. This may be @c NULL, as it may
9076 * not have been created or may have been deleted, at any time, by
9077 * the gengrid. <b>Do not modify this object</b> (move, resize,
9078 * show, hide, etc.), as the gengrid is controlling it. This
9079 * function is for querying, emitting custom signals or hooking
9080 * lower level callbacks for events on that object. Do not delete
9081 * this object under any circumstances.
9083 * @see elm_gengrid_item_data_get()
9087 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9090 * Show the portion of a gengrid's internal grid containing a given
9091 * item, @b immediately.
9093 * @param item The item to display
9095 * This causes gengrid to @b redraw its viewport's contents to the
9096 * region contining the given @p item item, if it is not fully
9099 * @see elm_gengrid_item_bring_in()
9103 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9106 * Animatedly bring in, to the visible area of a gengrid, a given
9109 * @param item The gengrid item to display
9111 * This causes gengrid to jump to the given @p item and show
9112 * it (by scrolling), if it is not fully visible. This will use
9113 * animation to do so and take a period of time to complete.
9115 * @see elm_gengrid_item_show()
9119 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9122 * Set whether a given gengrid item is disabled or not.
9124 * @param item The gengrid item
9125 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9126 * to enable it back.
9128 * A disabled item cannot be selected or unselected. It will also
9129 * change its appearance, to signal the user it's disabled.
9131 * @see elm_gengrid_item_disabled_get()
9135 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9138 * Get whether a given gengrid item is disabled or not.
9140 * @param item The gengrid item
9141 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9144 * @see elm_gengrid_item_disabled_set() for more details
9148 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9151 * Set the text to be shown in a given gengrid item's tooltips.
9153 * @param item The gengrid item
9154 * @param text The text to set in the content
9156 * This call will setup the text to be used as tooltip to that item
9157 * (analogous to elm_object_tooltip_text_set(), but being item
9158 * tooltips with higher precedence than object tooltips). It can
9159 * have only one tooltip at a time, so any previous tooltip data
9164 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9167 * Set the content to be shown in a given gengrid item's tooltip
9169 * @param item The gengrid item.
9170 * @param func The function returning the tooltip contents.
9171 * @param data What to provide to @a func as callback data/context.
9172 * @param del_cb Called when data is not needed anymore, either when
9173 * another callback replaces @p func, the tooltip is unset with
9174 * elm_gengrid_item_tooltip_unset() or the owner @p item
9175 * dies. This callback receives as its first parameter the
9176 * given @p data, being @c event_info the item handle.
9178 * This call will setup the tooltip's contents to @p item
9179 * (analogous to elm_object_tooltip_content_cb_set(), but being
9180 * item tooltips with higher precedence than object tooltips). It
9181 * can have only one tooltip at a time, so any previous tooltip
9182 * content will get removed. @p func (with @p data) will be called
9183 * every time Elementary needs to show the tooltip and it should
9184 * return a valid Evas object, which will be fully managed by the
9185 * tooltip system, getting deleted when the tooltip is gone.
9189 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);
9192 * Unset a tooltip from a given gengrid item
9194 * @param item gengrid item to remove a previously set tooltip from.
9196 * This call removes any tooltip set on @p item. The callback
9197 * provided as @c del_cb to
9198 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9199 * notify it is not used anymore (and have resources cleaned, if
9202 * @see elm_gengrid_item_tooltip_content_cb_set()
9206 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9209 * Set a different @b style for a given gengrid item's tooltip.
9211 * @param item gengrid item with tooltip set
9212 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9213 * "default", @c "transparent", etc)
9215 * Tooltips can have <b>alternate styles</b> to be displayed on,
9216 * which are defined by the theme set on Elementary. This function
9217 * works analogously as elm_object_tooltip_style_set(), but here
9218 * applied only to gengrid item objects. The default style for
9219 * tooltips is @c "default".
9221 * @note before you set a style you should define a tooltip with
9222 * elm_gengrid_item_tooltip_content_cb_set() or
9223 * elm_gengrid_item_tooltip_text_set()
9225 * @see elm_gengrid_item_tooltip_style_get()
9229 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9232 * Get the style set a given gengrid item's tooltip.
9234 * @param item gengrid item with tooltip already set on.
9235 * @return style the theme style in use, which defaults to
9236 * "default". If the object does not have a tooltip set,
9237 * then @c NULL is returned.
9239 * @see elm_gengrid_item_tooltip_style_set() for more details
9243 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9245 * Set the type of mouse pointer/cursor decoration to be shown,
9246 * when the mouse pointer is over the given gengrid widget item
9248 * @param item gengrid item to customize cursor on
9249 * @param cursor the cursor type's name
9251 * This function works analogously as elm_object_cursor_set(), but
9252 * here the cursor's changing area is restricted to the item's
9253 * area, and not the whole widget's. Note that that item cursors
9254 * have precedence over widget cursors, so that a mouse over @p
9255 * item will always show cursor @p type.
9257 * If this function is called twice for an object, a previously set
9258 * cursor will be unset on the second call.
9260 * @see elm_object_cursor_set()
9261 * @see elm_gengrid_item_cursor_get()
9262 * @see elm_gengrid_item_cursor_unset()
9266 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9269 * Get the type of mouse pointer/cursor decoration set to be shown,
9270 * when the mouse pointer is over the given gengrid widget item
9272 * @param item gengrid item with custom cursor set
9273 * @return the cursor type's name or @c NULL, if no custom cursors
9274 * were set to @p item (and on errors)
9276 * @see elm_object_cursor_get()
9277 * @see elm_gengrid_item_cursor_set() for more details
9278 * @see elm_gengrid_item_cursor_unset()
9282 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9285 * Unset any custom mouse pointer/cursor decoration set to be
9286 * shown, when the mouse pointer is over the given gengrid widget
9287 * item, thus making it show the @b default cursor again.
9289 * @param item a gengrid item
9291 * Use this call to undo any custom settings on this item's cursor
9292 * decoration, bringing it back to defaults (no custom style set).
9294 * @see elm_object_cursor_unset()
9295 * @see elm_gengrid_item_cursor_set() for more details
9299 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9302 * Set a different @b style for a given custom cursor set for a
9305 * @param item gengrid item with custom cursor set
9306 * @param style the <b>theme style</b> to use (e.g. @c "default",
9307 * @c "transparent", etc)
9309 * This function only makes sense when one is using custom mouse
9310 * cursor decorations <b>defined in a theme file</b> , which can
9311 * have, given a cursor name/type, <b>alternate styles</b> on
9312 * it. It works analogously as elm_object_cursor_style_set(), but
9313 * here applied only to gengrid item objects.
9315 * @warning Before you set a cursor style you should have defined a
9316 * custom cursor previously on the item, with
9317 * elm_gengrid_item_cursor_set()
9319 * @see elm_gengrid_item_cursor_engine_only_set()
9320 * @see elm_gengrid_item_cursor_style_get()
9324 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9327 * Get the current @b style set for a given gengrid item's custom
9330 * @param item gengrid item with custom cursor set.
9331 * @return style the cursor style in use. If the object does not
9332 * have a cursor set, then @c NULL is returned.
9334 * @see elm_gengrid_item_cursor_style_set() for more details
9338 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9341 * Set if the (custom) cursor for a given gengrid item should be
9342 * searched in its theme, also, or should only rely on the
9345 * @param item item with custom (custom) cursor already set on
9346 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9347 * only on those provided by the rendering engine, @c EINA_FALSE to
9348 * have them searched on the widget's theme, as well.
9350 * @note This call is of use only if you've set a custom cursor
9351 * for gengrid items, with elm_gengrid_item_cursor_set().
9353 * @note By default, cursors will only be looked for between those
9354 * provided by the rendering engine.
9358 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9361 * Get if the (custom) cursor for a given gengrid item is being
9362 * searched in its theme, also, or is only relying on the rendering
9365 * @param item a gengrid item
9366 * @return @c EINA_TRUE, if cursors are being looked for only on
9367 * those provided by the rendering engine, @c EINA_FALSE if they
9368 * are being searched on the widget's theme, as well.
9370 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9374 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9377 * Remove all items from a given gengrid widget
9379 * @param obj The gengrid object.
9381 * This removes (and deletes) all items in @p obj, leaving it
9384 * @see elm_gengrid_item_del(), to remove just one item.
9388 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9391 * Get the selected item in a given gengrid widget
9393 * @param obj The gengrid object.
9394 * @return The selected item's handleor @c NULL, if none is
9395 * selected at the moment (and on errors)
9397 * This returns the selected item in @p obj. If multi selection is
9398 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9399 * the first item in the list is selected, which might not be very
9400 * useful. For that case, see elm_gengrid_selected_items_get().
9404 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9407 * Get <b>a list</b> of selected items in a given gengrid
9409 * @param obj The gengrid object.
9410 * @return The list of selected items or @c NULL, if none is
9411 * selected at the moment (and on errors)
9413 * This returns a list of the selected items, in the order that
9414 * they appear in the grid. This list is only valid as long as no
9415 * more items are selected or unselected (or unselected implictly
9416 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9419 * @see elm_gengrid_selected_item_get()
9423 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9430 * @defgroup Clock Clock
9432 * @image html img/widget/clock/preview-00.png
9433 * @image latex img/widget/clock/preview-00.eps
9435 * This is a @b digital clock widget. In its default theme, it has a
9436 * vintage "flipping numbers clock" appearance, which will animate
9437 * sheets of individual algarisms individually as time goes by.
9439 * A newly created clock will fetch system's time (already
9440 * considering local time adjustments) to start with, and will tick
9441 * accondingly. It may or may not show seconds.
9443 * Clocks have an @b edition mode. When in it, the sheets will
9444 * display extra arrow indications on the top and bottom and the
9445 * user may click on them to raise or lower the time values. After
9446 * it's told to exit edition mode, it will keep ticking with that
9447 * new time set (it keeps the difference from local time).
9449 * Also, when under edition mode, user clicks on the cited arrows
9450 * which are @b held for some time will make the clock to flip the
9451 * sheet, thus editing the time, continuosly and automatically for
9452 * the user. The interval between sheet flips will keep growing in
9453 * time, so that it helps the user to reach a time which is distant
9456 * The time display is, by default, in military mode (24h), but an
9457 * am/pm indicator may be optionally shown, too, when it will
9460 * Smart callbacks one can register to:
9461 * - "changed" - the clock's user changed the time
9463 * Here is an example on its usage:
9464 * @li @ref clock_example
9473 * Identifiers for which clock digits should be editable, when a
9474 * clock widget is in edition mode. Values may be ORed together to
9475 * make a mask, naturally.
9477 * @see elm_clock_edit_set()
9478 * @see elm_clock_digit_edit_set()
9480 typedef enum _Elm_Clock_Digedit
9482 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9483 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9484 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9485 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9486 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9487 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9488 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9489 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9490 } Elm_Clock_Digedit;
9493 * Add a new clock widget to the given parent Elementary
9494 * (container) object
9496 * @param parent The parent object
9497 * @return a new clock widget handle or @c NULL, on errors
9499 * This function inserts a new clock widget on the canvas.
9503 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9506 * Set a clock widget's time, programmatically
9508 * @param obj The clock widget object
9509 * @param hrs The hours to set
9510 * @param min The minutes to set
9511 * @param sec The secondes to set
9513 * This function updates the time that is showed by the clock
9516 * Values @b must be set within the following ranges:
9517 * - 0 - 23, for hours
9518 * - 0 - 59, for minutes
9519 * - 0 - 59, for seconds,
9521 * even if the clock is not in "military" mode.
9523 * @warning The behavior for values set out of those ranges is @b
9528 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9531 * Get a clock widget's time values
9533 * @param obj The clock object
9534 * @param[out] hrs Pointer to the variable to get the hours value
9535 * @param[out] min Pointer to the variable to get the minutes value
9536 * @param[out] sec Pointer to the variable to get the seconds value
9538 * This function gets the time set for @p obj, returning
9539 * it on the variables passed as the arguments to function
9541 * @note Use @c NULL pointers on the time values you're not
9542 * interested in: they'll be ignored by the function.
9546 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9549 * Set whether a given clock widget is under <b>edition mode</b> or
9550 * under (default) displaying-only mode.
9552 * @param obj The clock object
9553 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9554 * put it back to "displaying only" mode
9556 * This function makes a clock's time to be editable or not <b>by
9557 * user interaction</b>. When in edition mode, clocks @b stop
9558 * ticking, until one brings them back to canonical mode. The
9559 * elm_clock_digit_edit_set() function will influence which digits
9560 * of the clock will be editable. By default, all of them will be
9561 * (#ELM_CLOCK_NONE).
9563 * @note am/pm sheets, if being shown, will @b always be editable
9564 * under edition mode.
9566 * @see elm_clock_edit_get()
9570 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9573 * Retrieve whether a given clock widget is under <b>edition
9574 * mode</b> or under (default) displaying-only mode.
9576 * @param obj The clock object
9577 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9580 * This function retrieves whether the clock's time can be edited
9581 * or not by user interaction.
9583 * @see elm_clock_edit_set() for more details
9587 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9590 * Set what digits of the given clock widget should be editable
9591 * when in edition mode.
9593 * @param obj The clock object
9594 * @param digedit Bit mask indicating the digits to be editable
9595 * (values in #Elm_Clock_Digedit).
9597 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9598 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9601 * @see elm_clock_digit_edit_get()
9605 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9608 * Retrieve what digits of the given clock widget should be
9609 * editable when in edition mode.
9611 * @param obj The clock object
9612 * @return Bit mask indicating the digits to be editable
9613 * (values in #Elm_Clock_Digedit).
9615 * @see elm_clock_digit_edit_set() for more details
9619 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9622 * Set if the given clock widget must show hours in military or
9625 * @param obj The clock object
9626 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9629 * This function sets if the clock must show hours in military or
9630 * am/pm mode. In some countries like Brazil the military mode
9631 * (00-24h-format) is used, in opposition to the USA, where the
9632 * am/pm mode is more commonly used.
9634 * @see elm_clock_show_am_pm_get()
9638 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9641 * Get if the given clock widget shows hours in military or am/pm
9644 * @param obj The clock object
9645 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9648 * This function gets if the clock shows hours in military or am/pm
9651 * @see elm_clock_show_am_pm_set() for more details
9655 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9658 * Set if the given clock widget must show time with seconds or not
9660 * @param obj The clock object
9661 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9663 * This function sets if the given clock must show or not elapsed
9664 * seconds. By default, they are @b not shown.
9666 * @see elm_clock_show_seconds_get()
9670 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9673 * Get whether the given clock widget is showing time with seconds
9676 * @param obj The clock object
9677 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9679 * This function gets whether @p obj is showing or not the elapsed
9682 * @see elm_clock_show_seconds_set()
9686 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9689 * Set the interval on time updates for an user mouse button hold
9690 * on clock widgets' time edition.
9692 * @param obj The clock object
9693 * @param interval The (first) interval value in seconds
9695 * This interval value is @b decreased while the user holds the
9696 * mouse pointer either incrementing or decrementing a given the
9697 * clock digit's value.
9699 * This helps the user to get to a given time distant from the
9700 * current one easier/faster, as it will start to flip quicker and
9701 * quicker on mouse button holds.
9703 * The calculation for the next flip interval value, starting from
9704 * the one set with this call, is the previous interval divided by
9705 * 1.05, so it decreases a little bit.
9707 * The default starting interval value for automatic flips is
9710 * @see elm_clock_interval_get()
9714 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9717 * Get the interval on time updates for an user mouse button hold
9718 * on clock widgets' time edition.
9720 * @param obj The clock object
9721 * @return The (first) interval value, in seconds, set on it
9723 * @see elm_clock_interval_set() for more details
9727 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9734 * @defgroup Layout Layout
9736 * @image html img/widget/layout/preview-00.png
9737 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9739 * @image html img/layout-predefined.png
9740 * @image latex img/layout-predefined.eps width=\textwidth
9742 * This is a container widget that takes a standard Edje design file and
9743 * wraps it very thinly in a widget.
9745 * An Edje design (theme) file has a very wide range of possibilities to
9746 * describe the behavior of elements added to the Layout. Check out the Edje
9747 * documentation and the EDC reference to get more information about what can
9748 * be done with Edje.
9750 * Just like @ref List, @ref Box, and other container widgets, any
9751 * object added to the Layout will become its child, meaning that it will be
9752 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9754 * The Layout widget can contain as many Contents, Boxes or Tables as
9755 * described in its theme file. For instance, objects can be added to
9756 * different Tables by specifying the respective Table part names. The same
9757 * is valid for Content and Box.
9759 * The objects added as child of the Layout will behave as described in the
9760 * part description where they were added. There are 3 possible types of
9761 * parts where a child can be added:
9763 * @section secContent Content (SWALLOW part)
9765 * Only one object can be added to the @c SWALLOW part (but you still can
9766 * have many @c SWALLOW parts and one object on each of them). Use the @c
9767 * elm_object_content_set/get/unset functions to set, retrieve and unset
9768 * objects as content of the @c SWALLOW. After being set to this part, the
9769 * object size, position, visibility, clipping and other description
9770 * properties will be totally controled by the description of the given part
9771 * (inside the Edje theme file).
9773 * One can use @c evas_object_size_hint_* functions on the child to have some
9774 * kind of control over its behavior, but the resulting behavior will still
9775 * depend heavily on the @c SWALLOW part description.
9777 * The Edje theme also can change the part description, based on signals or
9778 * scripts running inside the theme. This change can also be animated. All of
9779 * this will affect the child object set as content accordingly. The object
9780 * size will be changed if the part size is changed, it will animate move if
9781 * the part is moving, and so on.
9783 * The following picture demonstrates a Layout widget with a child object
9784 * added to its @c SWALLOW:
9786 * @image html layout_swallow.png
9787 * @image latex layout_swallow.eps width=\textwidth
9789 * @section secBox Box (BOX part)
9791 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9792 * allows one to add objects to the box and have them distributed along its
9793 * area, accordingly to the specified @a layout property (now by @a layout we
9794 * mean the chosen layouting design of the Box, not the Layout widget
9797 * A similar effect for having a box with its position, size and other things
9798 * controled by the Layout theme would be to create an Elementary @ref Box
9799 * widget and add it as a Content in the @c SWALLOW part.
9801 * The main difference of using the Layout Box is that its behavior, the box
9802 * properties like layouting format, padding, align, etc. will be all
9803 * controled by the theme. This means, for example, that a signal could be
9804 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9805 * handled the signal by changing the box padding, or align, or both. Using
9806 * the Elementary @ref Box widget is not necessarily harder or easier, it
9807 * just depends on the circunstances and requirements.
9809 * The Layout Box can be used through the @c elm_layout_box_* set of
9812 * The following picture demonstrates a Layout widget with many child objects
9813 * added to its @c BOX part:
9815 * @image html layout_box.png
9816 * @image latex layout_box.eps width=\textwidth
9818 * @section secTable Table (TABLE part)
9820 * Just like the @ref secBox, the Layout Table is very similar to the
9821 * Elementary @ref Table widget. It allows one to add objects to the Table
9822 * specifying the row and column where the object should be added, and any
9823 * column or row span if necessary.
9825 * Again, we could have this design by adding a @ref Table widget to the @c
9826 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9827 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9828 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9830 * The Layout Table can be used through the @c elm_layout_table_* set of
9833 * The following picture demonstrates a Layout widget with many child objects
9834 * added to its @c TABLE part:
9836 * @image html layout_table.png
9837 * @image latex layout_table.eps width=\textwidth
9839 * @section secPredef Predefined Layouts
9841 * Another interesting thing about the Layout widget is that it offers some
9842 * predefined themes that come with the default Elementary theme. These
9843 * themes can be set by the call elm_layout_theme_set(), and provide some
9844 * basic functionality depending on the theme used.
9846 * Most of them already send some signals, some already provide a toolbar or
9847 * back and next buttons.
9849 * These are available predefined theme layouts. All of them have class = @c
9850 * layout, group = @c application, and style = one of the following options:
9852 * @li @c toolbar-content - application with toolbar and main content area
9853 * @li @c toolbar-content-back - application with toolbar and main content
9854 * area with a back button and title area
9855 * @li @c toolbar-content-back-next - application with toolbar and main
9856 * content area with a back and next buttons and title area
9857 * @li @c content-back - application with a main content area with a back
9858 * button and title area
9859 * @li @c content-back-next - application with a main content area with a
9860 * back and next buttons and title area
9861 * @li @c toolbar-vbox - application with toolbar and main content area as a
9863 * @li @c toolbar-table - application with toolbar and main content area as a
9866 * @section secExamples Examples
9868 * Some examples of the Layout widget can be found here:
9869 * @li @ref layout_example_01
9870 * @li @ref layout_example_02
9871 * @li @ref layout_example_03
9872 * @li @ref layout_example_edc
9877 * Add a new layout to the parent
9879 * @param parent The parent object
9880 * @return The new object or NULL if it cannot be created
9882 * @see elm_layout_file_set()
9883 * @see elm_layout_theme_set()
9887 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9889 * Set the file that will be used as layout
9891 * @param obj The layout object
9892 * @param file The path to file (edj) that will be used as layout
9893 * @param group The group that the layout belongs in edje file
9895 * @return (1 = success, 0 = error)
9899 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9901 * Set the edje group from the elementary theme that will be used as layout
9903 * @param obj The layout object
9904 * @param clas the clas of the group
9905 * @param group the group
9906 * @param style the style to used
9908 * @return (1 = success, 0 = error)
9912 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9914 * Set the layout content.
9916 * @param obj The layout object
9917 * @param swallow The swallow part name in the edje file
9918 * @param content The child that will be added in this layout object
9920 * Once the content object is set, a previously set one will be deleted.
9921 * If you want to keep that old content object, use the
9922 * elm_object_content_part_unset() function.
9924 * @note In an Edje theme, the part used as a content container is called @c
9925 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9926 * expected to be a part name just like the second parameter of
9927 * elm_layout_box_append().
9929 * @see elm_layout_box_append()
9930 * @see elm_object_content_part_get()
9931 * @see elm_object_content_part_unset()
9936 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9938 * Get the child object in the given content part.
9940 * @param obj The layout object
9941 * @param swallow The SWALLOW part to get its content
9943 * @return The swallowed object or NULL if none or an error occurred
9945 * @see elm_object_content_part_set()
9949 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9951 * Unset the layout content.
9953 * @param obj The layout object
9954 * @param swallow The swallow part name in the edje file
9955 * @return The content that was being used
9957 * Unparent and return the content object which was set for this part.
9959 * @see elm_object_content_part_set()
9963 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9965 * Set the text of the given part
9967 * @param obj The layout object
9968 * @param part The TEXT part where to set the text
9969 * @param text The text to set
9972 * @deprecated use elm_object_text_part_set() instead.
9974 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9976 * Get the text set in the given part
9978 * @param obj The layout object
9979 * @param part The TEXT part to retrieve the text off
9981 * @return The text set in @p part
9984 * @deprecated use elm_object_text_part_get() instead.
9986 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9988 * Append child to layout box part.
9990 * @param obj the layout object
9991 * @param part the box part to which the object will be appended.
9992 * @param child the child object to append to box.
9994 * Once the object is appended, it will become child of the layout. Its
9995 * lifetime will be bound to the layout, whenever the layout dies the child
9996 * will be deleted automatically. One should use elm_layout_box_remove() to
9997 * make this layout forget about the object.
9999 * @see elm_layout_box_prepend()
10000 * @see elm_layout_box_insert_before()
10001 * @see elm_layout_box_insert_at()
10002 * @see elm_layout_box_remove()
10006 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10008 * Prepend child to layout box part.
10010 * @param obj the layout object
10011 * @param part the box part to prepend.
10012 * @param child the child object to prepend to box.
10014 * Once the object is prepended, it will become child of the layout. Its
10015 * lifetime will be bound to the layout, whenever the layout dies the child
10016 * will be deleted automatically. One should use elm_layout_box_remove() to
10017 * make this layout forget about the object.
10019 * @see elm_layout_box_append()
10020 * @see elm_layout_box_insert_before()
10021 * @see elm_layout_box_insert_at()
10022 * @see elm_layout_box_remove()
10026 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10028 * Insert child to layout box part before a reference object.
10030 * @param obj the layout object
10031 * @param part the box part to insert.
10032 * @param child the child object to insert into box.
10033 * @param reference another reference object to insert before in box.
10035 * Once the object is inserted, it will become child of the layout. Its
10036 * lifetime will be bound to the layout, whenever the layout dies the child
10037 * will be deleted automatically. One should use elm_layout_box_remove() to
10038 * make this layout forget about the object.
10040 * @see elm_layout_box_append()
10041 * @see elm_layout_box_prepend()
10042 * @see elm_layout_box_insert_before()
10043 * @see elm_layout_box_remove()
10047 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10049 * Insert child to layout box part at a given position.
10051 * @param obj the layout object
10052 * @param part the box part to insert.
10053 * @param child the child object to insert into box.
10054 * @param pos the numeric position >=0 to insert the child.
10056 * Once the object is inserted, it will become child of the layout. Its
10057 * lifetime will be bound to the layout, whenever the layout dies the child
10058 * will be deleted automatically. One should use elm_layout_box_remove() to
10059 * make this layout forget about the object.
10061 * @see elm_layout_box_append()
10062 * @see elm_layout_box_prepend()
10063 * @see elm_layout_box_insert_before()
10064 * @see elm_layout_box_remove()
10068 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10070 * Remove a child of the given part box.
10072 * @param obj The layout object
10073 * @param part The box part name to remove child.
10074 * @param child The object to remove from box.
10075 * @return The object that was being used, or NULL if not found.
10077 * The object will be removed from the box part and its lifetime will
10078 * not be handled by the layout anymore. This is equivalent to
10079 * elm_object_content_part_unset() for box.
10081 * @see elm_layout_box_append()
10082 * @see elm_layout_box_remove_all()
10086 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10088 * Remove all child of the given part box.
10090 * @param obj The layout object
10091 * @param part The box part name to remove child.
10092 * @param clear If EINA_TRUE, then all objects will be deleted as
10093 * well, otherwise they will just be removed and will be
10094 * dangling on the canvas.
10096 * The objects will be removed from the box part and their lifetime will
10097 * not be handled by the layout anymore. This is equivalent to
10098 * elm_layout_box_remove() for all box children.
10100 * @see elm_layout_box_append()
10101 * @see elm_layout_box_remove()
10105 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10107 * Insert child to layout table part.
10109 * @param obj the layout object
10110 * @param part the box part to pack child.
10111 * @param child_obj the child object to pack into table.
10112 * @param col the column to which the child should be added. (>= 0)
10113 * @param row the row to which the child should be added. (>= 0)
10114 * @param colspan how many columns should be used to store this object. (>=
10116 * @param rowspan how many rows should be used to store this object. (>= 1)
10118 * Once the object is inserted, it will become child of the table. Its
10119 * lifetime will be bound to the layout, and whenever the layout dies the
10120 * child will be deleted automatically. One should use
10121 * elm_layout_table_remove() to make this layout forget about the object.
10123 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10124 * more space than a single cell. For instance, the following code:
10126 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10129 * Would result in an object being added like the following picture:
10131 * @image html layout_colspan.png
10132 * @image latex layout_colspan.eps width=\textwidth
10134 * @see elm_layout_table_unpack()
10135 * @see elm_layout_table_clear()
10139 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);
10141 * Unpack (remove) a child of the given part table.
10143 * @param obj The layout object
10144 * @param part The table part name to remove child.
10145 * @param child_obj The object to remove from table.
10146 * @return The object that was being used, or NULL if not found.
10148 * The object will be unpacked from the table part and its lifetime
10149 * will not be handled by the layout anymore. This is equivalent to
10150 * elm_object_content_part_unset() for table.
10152 * @see elm_layout_table_pack()
10153 * @see elm_layout_table_clear()
10157 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10159 * Remove all child of the given part table.
10161 * @param obj The layout object
10162 * @param part The table part name to remove child.
10163 * @param clear If EINA_TRUE, then all objects will be deleted as
10164 * well, otherwise they will just be removed and will be
10165 * dangling on the canvas.
10167 * The objects will be removed from the table part and their lifetime will
10168 * not be handled by the layout anymore. This is equivalent to
10169 * elm_layout_table_unpack() for all table children.
10171 * @see elm_layout_table_pack()
10172 * @see elm_layout_table_unpack()
10176 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10178 * Get the edje layout
10180 * @param obj The layout object
10182 * @return A Evas_Object with the edje layout settings loaded
10183 * with function elm_layout_file_set
10185 * This returns the edje object. It is not expected to be used to then
10186 * swallow objects via edje_object_part_swallow() for example. Use
10187 * elm_object_content_part_set() instead so child object handling and sizing is
10190 * @note This function should only be used if you really need to call some
10191 * low level Edje function on this edje object. All the common stuff (setting
10192 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10193 * with proper elementary functions.
10195 * @see elm_object_signal_callback_add()
10196 * @see elm_object_signal_emit()
10197 * @see elm_object_text_part_set()
10198 * @see elm_object_content_part_set()
10199 * @see elm_layout_box_append()
10200 * @see elm_layout_table_pack()
10201 * @see elm_layout_data_get()
10205 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10207 * Get the edje data from the given layout
10209 * @param obj The layout object
10210 * @param key The data key
10212 * @return The edje data string
10214 * This function fetches data specified inside the edje theme of this layout.
10215 * This function return NULL if data is not found.
10217 * In EDC this comes from a data block within the group block that @p
10218 * obj was loaded from. E.g.
10225 * item: "key1" "value1";
10226 * item: "key2" "value2";
10234 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10238 * @param obj The layout object
10240 * Manually forces a sizing re-evaluation. This is useful when the minimum
10241 * size required by the edje theme of this layout has changed. The change on
10242 * the minimum size required by the edje theme is not immediately reported to
10243 * the elementary layout, so one needs to call this function in order to tell
10244 * the widget (layout) that it needs to reevaluate its own size.
10246 * The minimum size of the theme is calculated based on minimum size of
10247 * parts, the size of elements inside containers like box and table, etc. All
10248 * of this can change due to state changes, and that's when this function
10249 * should be called.
10251 * Also note that a standard signal of "size,eval" "elm" emitted from the
10252 * edje object will cause this to happen too.
10256 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10259 * Sets a specific cursor for an edje part.
10261 * @param obj The layout object.
10262 * @param part_name a part from loaded edje group.
10263 * @param cursor cursor name to use, see Elementary_Cursor.h
10265 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10266 * part not exists or it has "mouse_events: 0".
10270 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10273 * Get the cursor to be shown when mouse is over an edje part
10275 * @param obj The layout object.
10276 * @param part_name a part from loaded edje group.
10277 * @return the cursor name.
10281 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10284 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10286 * @param obj The layout object.
10287 * @param part_name a part from loaded edje group, that had a cursor set
10288 * with elm_layout_part_cursor_set().
10292 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10295 * Sets a specific cursor style for an edje part.
10297 * @param obj The layout object.
10298 * @param part_name a part from loaded edje group.
10299 * @param style the theme style to use (default, transparent, ...)
10301 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10302 * part not exists or it did not had a cursor set.
10306 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10309 * Gets a specific cursor style for an edje part.
10311 * @param obj The layout object.
10312 * @param part_name a part from loaded edje group.
10314 * @return the theme style in use, defaults to "default". If the
10315 * object does not have a cursor set, then NULL is returned.
10319 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10322 * Sets if the cursor set should be searched on the theme or should use
10323 * the provided by the engine, only.
10325 * @note before you set if should look on theme you should define a
10326 * cursor with elm_layout_part_cursor_set(). By default it will only
10327 * look for cursors provided by the engine.
10329 * @param obj The layout object.
10330 * @param part_name a part from loaded edje group.
10331 * @param engine_only if cursors should be just provided by the engine
10332 * or should also search on widget's theme as well
10334 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10335 * part not exists or it did not had a cursor set.
10339 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);
10342 * Gets a specific cursor engine_only for an edje part.
10344 * @param obj The layout object.
10345 * @param part_name a part from loaded edje group.
10347 * @return whenever the cursor is just provided by engine or also from theme.
10351 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10354 * @def elm_layout_icon_set
10355 * Convienience macro to set the icon object in a layout that follows the
10356 * Elementary naming convention for its parts.
10360 #define elm_layout_icon_set(_ly, _obj) \
10363 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10364 if ((_obj)) sig = "elm,state,icon,visible"; \
10365 else sig = "elm,state,icon,hidden"; \
10366 elm_object_signal_emit((_ly), sig, "elm"); \
10370 * @def elm_layout_icon_get
10371 * Convienience macro to get the icon object from a layout that follows the
10372 * Elementary naming convention for its parts.
10376 #define elm_layout_icon_get(_ly) \
10377 elm_object_content_part_get((_ly), "elm.swallow.icon")
10380 * @def elm_layout_end_set
10381 * Convienience macro to set the end object in a layout that follows the
10382 * Elementary naming convention for its parts.
10386 #define elm_layout_end_set(_ly, _obj) \
10389 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10390 if ((_obj)) sig = "elm,state,end,visible"; \
10391 else sig = "elm,state,end,hidden"; \
10392 elm_object_signal_emit((_ly), sig, "elm"); \
10396 * @def elm_layout_end_get
10397 * Convienience macro to get the end object in a layout that follows the
10398 * Elementary naming convention for its parts.
10402 #define elm_layout_end_get(_ly) \
10403 elm_object_content_part_get((_ly), "elm.swallow.end")
10406 * @def elm_layout_label_set
10407 * Convienience macro to set the label in a layout that follows the
10408 * Elementary naming convention for its parts.
10411 * @deprecated use elm_object_text_set() instead.
10413 #define elm_layout_label_set(_ly, _txt) \
10414 elm_layout_text_set((_ly), "elm.text", (_txt))
10417 * @def elm_layout_label_get
10418 * Convenience macro to get the label in a layout that follows the
10419 * Elementary naming convention for its parts.
10422 * @deprecated use elm_object_text_set() instead.
10424 #define elm_layout_label_get(_ly) \
10425 elm_layout_text_get((_ly), "elm.text")
10427 /* smart callbacks called:
10428 * "theme,changed" - when elm theme is changed.
10432 * @defgroup Notify Notify
10434 * @image html img/widget/notify/preview-00.png
10435 * @image latex img/widget/notify/preview-00.eps
10437 * Display a container in a particular region of the parent(top, bottom,
10438 * etc). A timeout can be set to automatically hide the notify. This is so
10439 * that, after an evas_object_show() on a notify object, if a timeout was set
10440 * on it, it will @b automatically get hidden after that time.
10442 * Signals that you can add callbacks for are:
10443 * @li "timeout" - when timeout happens on notify and it's hidden
10444 * @li "block,clicked" - when a click outside of the notify happens
10446 * Default contents parts of the notify widget that you can use for are:
10447 * @li "elm.swallow.content" - A content of the notify
10449 * @ref tutorial_notify show usage of the API.
10454 * @brief Possible orient values for notify.
10456 * This values should be used in conjunction to elm_notify_orient_set() to
10457 * set the position in which the notify should appear(relative to its parent)
10458 * and in conjunction with elm_notify_orient_get() to know where the notify
10461 typedef enum _Elm_Notify_Orient
10463 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10464 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10465 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10466 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10467 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10468 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10469 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10470 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10471 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10472 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10473 } Elm_Notify_Orient;
10475 * @brief Add a new notify to the parent
10477 * @param parent The parent object
10478 * @return The new object or NULL if it cannot be created
10480 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10482 * @brief Set the content of the notify widget
10484 * @param obj The notify object
10485 * @param content The content will be filled in this notify object
10487 * Once the content object is set, a previously set one will be deleted. If
10488 * you want to keep that old content object, use the
10489 * elm_notify_content_unset() function.
10491 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10493 * @brief Unset the content of the notify widget
10495 * @param obj The notify object
10496 * @return The content that was being used
10498 * Unparent and return the content object which was set for this widget
10500 * @see elm_notify_content_set()
10502 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10504 * @brief Return the content of the notify widget
10506 * @param obj The notify object
10507 * @return The content that is being used
10509 * @see elm_notify_content_set()
10511 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10513 * @brief Set the notify parent
10515 * @param obj The notify object
10516 * @param content The new parent
10518 * Once the parent object is set, a previously set one will be disconnected
10521 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10523 * @brief Get the notify parent
10525 * @param obj The notify object
10526 * @return The parent
10528 * @see elm_notify_parent_set()
10530 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10532 * @brief Set the orientation
10534 * @param obj The notify object
10535 * @param orient The new orientation
10537 * Sets the position in which the notify will appear in its parent.
10539 * @see @ref Elm_Notify_Orient for possible values.
10541 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10543 * @brief Return the orientation
10544 * @param obj The notify object
10545 * @return The orientation of the notification
10547 * @see elm_notify_orient_set()
10548 * @see Elm_Notify_Orient
10550 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10552 * @brief Set the time interval after which the notify window is going to be
10555 * @param obj The notify object
10556 * @param time The timeout in seconds
10558 * This function sets a timeout and starts the timer controlling when the
10559 * notify is hidden. Since calling evas_object_show() on a notify restarts
10560 * the timer controlling when the notify is hidden, setting this before the
10561 * notify is shown will in effect mean starting the timer when the notify is
10564 * @note Set a value <= 0.0 to disable a running timer.
10566 * @note If the value > 0.0 and the notify is previously visible, the
10567 * timer will be started with this value, canceling any running timer.
10569 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10571 * @brief Return the timeout value (in seconds)
10572 * @param obj the notify object
10574 * @see elm_notify_timeout_set()
10576 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10578 * @brief Sets whether events should be passed to by a click outside
10581 * @param obj The notify object
10582 * @param repeats EINA_TRUE Events are repeats, else no
10584 * When true if the user clicks outside the window the events will be caught
10585 * by the others widgets, else the events are blocked.
10587 * @note The default value is EINA_TRUE.
10589 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10591 * @brief Return true if events are repeat below the notify object
10592 * @param obj the notify object
10594 * @see elm_notify_repeat_events_set()
10596 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10602 * @defgroup Hover Hover
10604 * @image html img/widget/hover/preview-00.png
10605 * @image latex img/widget/hover/preview-00.eps
10607 * A Hover object will hover over its @p parent object at the @p target
10608 * location. Anything in the background will be given a darker coloring to
10609 * indicate that the hover object is on top (at the default theme). When the
10610 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10611 * clicked that @b doesn't cause the hover to be dismissed.
10613 * A Hover object has two parents. One parent that owns it during creation
10614 * and the other parent being the one over which the hover object spans.
10617 * @note The hover object will take up the entire space of @p target
10620 * Elementary has the following styles for the hover widget:
10624 * @li hoversel_vertical
10626 * The following are the available position for content:
10638 * Signals that you can add callbacks for are:
10639 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10640 * @li "smart,changed" - a content object placed under the "smart"
10641 * policy was replaced to a new slot direction.
10643 * See @ref tutorial_hover for more information.
10647 typedef enum _Elm_Hover_Axis
10649 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10650 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10651 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10652 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10655 * @brief Adds a hover object to @p parent
10657 * @param parent The parent object
10658 * @return The hover object or NULL if one could not be created
10660 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10662 * @brief Sets the target object for the hover.
10664 * @param obj The hover object
10665 * @param target The object to center the hover onto. The hover
10667 * This function will cause the hover to be centered on the target object.
10669 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10671 * @brief Gets the target object for the hover.
10673 * @param obj The hover object
10674 * @param parent The object to locate the hover over.
10676 * @see elm_hover_target_set()
10678 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10680 * @brief Sets the parent object for the hover.
10682 * @param obj The hover object
10683 * @param parent The object to locate the hover over.
10685 * This function will cause the hover to take up the entire space that the
10686 * parent object fills.
10688 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10690 * @brief Gets the parent object for the hover.
10692 * @param obj The hover object
10693 * @return The parent object to locate the hover over.
10695 * @see elm_hover_parent_set()
10697 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10699 * @brief Sets the content of the hover object and the direction in which it
10702 * @param obj The hover object
10703 * @param swallow The direction that the object will be displayed
10704 * at. Accepted values are "left", "top-left", "top", "top-right",
10705 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10707 * @param content The content to place at @p swallow
10709 * Once the content object is set for a given direction, a previously
10710 * set one (on the same direction) will be deleted. If you want to
10711 * keep that old content object, use the elm_hover_content_unset()
10714 * All directions may have contents at the same time, except for
10715 * "smart". This is a special placement hint and its use case
10716 * independs of the calculations coming from
10717 * elm_hover_best_content_location_get(). Its use is for cases when
10718 * one desires only one hover content, but with a dinamic special
10719 * placement within the hover area. The content's geometry, whenever
10720 * it changes, will be used to decide on a best location not
10721 * extrapolating the hover's parent object view to show it in (still
10722 * being the hover's target determinant of its medium part -- move and
10723 * resize it to simulate finger sizes, for example). If one of the
10724 * directions other than "smart" are used, a previously content set
10725 * using it will be deleted, and vice-versa.
10727 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10729 * @brief Get the content of the hover object, in a given direction.
10731 * Return the content object which was set for this widget in the
10732 * @p swallow direction.
10734 * @param obj The hover object
10735 * @param swallow The direction that the object was display at.
10736 * @return The content that was being used
10738 * @see elm_hover_content_set()
10740 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10742 * @brief Unset the content of the hover object, in a given direction.
10744 * Unparent and return the content object set at @p swallow direction.
10746 * @param obj The hover object
10747 * @param swallow The direction that the object was display at.
10748 * @return The content that was being used.
10750 * @see elm_hover_content_set()
10752 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10754 * @brief Returns the best swallow location for content in the hover.
10756 * @param obj The hover object
10757 * @param pref_axis The preferred orientation axis for the hover object to use
10758 * @return The edje location to place content into the hover or @c
10761 * Best is defined here as the location at which there is the most available
10764 * @p pref_axis may be one of
10765 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10766 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10767 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10768 * - @c ELM_HOVER_AXIS_BOTH -- both
10770 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10771 * nescessarily be along the horizontal axis("left" or "right"). If
10772 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10773 * be along the vertical axis("top" or "bottom"). Chossing
10774 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10775 * returned position may be in either axis.
10777 * @see elm_hover_content_set()
10779 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10786 * @defgroup Entry Entry
10788 * @image html img/widget/entry/preview-00.png
10789 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10790 * @image html img/widget/entry/preview-01.png
10791 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10792 * @image html img/widget/entry/preview-02.png
10793 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10794 * @image html img/widget/entry/preview-03.png
10795 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10797 * An entry is a convenience widget which shows a box that the user can
10798 * enter text into. Entries by default don't scroll, so they grow to
10799 * accomodate the entire text, resizing the parent window as needed. This
10800 * can be changed with the elm_entry_scrollable_set() function.
10802 * They can also be single line or multi line (the default) and when set
10803 * to multi line mode they support text wrapping in any of the modes
10804 * indicated by #Elm_Wrap_Type.
10806 * Other features include password mode, filtering of inserted text with
10807 * elm_entry_text_filter_append() and related functions, inline "items" and
10808 * formatted markup text.
10810 * @section entry-markup Formatted text
10812 * The markup tags supported by the Entry are defined by the theme, but
10813 * even when writing new themes or extensions it's a good idea to stick to
10814 * a sane default, to maintain coherency and avoid application breakages.
10815 * Currently defined by the default theme are the following tags:
10816 * @li \<br\>: Inserts a line break.
10817 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10819 * @li \<tab\>: Inserts a tab.
10820 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10822 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10823 * @li \<link\>...\</link\>: Underlines the enclosed text.
10824 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10826 * @section entry-special Special markups
10828 * Besides those used to format text, entries support two special markup
10829 * tags used to insert clickable portions of text or items inlined within
10832 * @subsection entry-anchors Anchors
10834 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10835 * \</a\> tags and an event will be generated when this text is clicked,
10839 * This text is outside <a href=anc-01>but this one is an anchor</a>
10842 * The @c href attribute in the opening tag gives the name that will be
10843 * used to identify the anchor and it can be any valid utf8 string.
10845 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10846 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10847 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10848 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10851 * @subsection entry-items Items
10853 * Inlined in the text, any other @c Evas_Object can be inserted by using
10854 * \<item\> tags this way:
10857 * <item size=16x16 vsize=full href=emoticon/haha></item>
10860 * Just like with anchors, the @c href identifies each item, but these need,
10861 * in addition, to indicate their size, which is done using any one of
10862 * @c size, @c absize or @c relsize attributes. These attributes take their
10863 * value in the WxH format, where W is the width and H the height of the
10866 * @li absize: Absolute pixel size for the item. Whatever value is set will
10867 * be the item's size regardless of any scale value the object may have
10868 * been set to. The final line height will be adjusted to fit larger items.
10869 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10871 * @li relsize: Size is adjusted for the item to fit within the current
10874 * Besides their size, items are specificed a @c vsize value that affects
10875 * how their final size and position are calculated. The possible values
10877 * @li ascent: Item will be placed within the line's baseline and its
10878 * ascent. That is, the height between the line where all characters are
10879 * positioned and the highest point in the line. For @c size and @c absize
10880 * items, the descent value will be added to the total line height to make
10881 * them fit. @c relsize items will be adjusted to fit within this space.
10882 * @li full: Items will be placed between the descent and ascent, or the
10883 * lowest point in the line and its highest.
10885 * The next image shows different configurations of items and how they
10886 * are the previously mentioned options affect their sizes. In all cases,
10887 * the green line indicates the ascent, blue for the baseline and red for
10890 * @image html entry_item.png
10891 * @image latex entry_item.eps width=\textwidth
10893 * And another one to show how size differs from absize. In the first one,
10894 * the scale value is set to 1.0, while the second one is using one of 2.0.
10896 * @image html entry_item_scale.png
10897 * @image latex entry_item_scale.eps width=\textwidth
10899 * After the size for an item is calculated, the entry will request an
10900 * object to place in its space. For this, the functions set with
10901 * elm_entry_item_provider_append() and related functions will be called
10902 * in order until one of them returns a @c non-NULL value. If no providers
10903 * are available, or all of them return @c NULL, then the entry falls back
10904 * to one of the internal defaults, provided the name matches with one of
10907 * All of the following are currently supported:
10910 * - emoticon/angry-shout
10911 * - emoticon/crazy-laugh
10912 * - emoticon/evil-laugh
10914 * - emoticon/goggle-smile
10915 * - emoticon/grumpy
10916 * - emoticon/grumpy-smile
10917 * - emoticon/guilty
10918 * - emoticon/guilty-smile
10920 * - emoticon/half-smile
10921 * - emoticon/happy-panting
10923 * - emoticon/indifferent
10925 * - emoticon/knowing-grin
10927 * - emoticon/little-bit-sorry
10928 * - emoticon/love-lots
10930 * - emoticon/minimal-smile
10931 * - emoticon/not-happy
10932 * - emoticon/not-impressed
10934 * - emoticon/opensmile
10937 * - emoticon/squint-laugh
10938 * - emoticon/surprised
10939 * - emoticon/suspicious
10940 * - emoticon/tongue-dangling
10941 * - emoticon/tongue-poke
10943 * - emoticon/unhappy
10944 * - emoticon/very-sorry
10947 * - emoticon/worried
10950 * Alternatively, an item may reference an image by its path, using
10951 * the URI form @c file:///path/to/an/image.png and the entry will then
10952 * use that image for the item.
10954 * @section entry-files Loading and saving files
10956 * Entries have convinience functions to load text from a file and save
10957 * changes back to it after a short delay. The automatic saving is enabled
10958 * by default, but can be disabled with elm_entry_autosave_set() and files
10959 * can be loaded directly as plain text or have any markup in them
10960 * recognized. See elm_entry_file_set() for more details.
10962 * @section entry-signals Emitted signals
10964 * This widget emits the following signals:
10966 * @li "changed": The text within the entry was changed.
10967 * @li "changed,user": The text within the entry was changed because of user interaction.
10968 * @li "activated": The enter key was pressed on a single line entry.
10969 * @li "press": A mouse button has been pressed on the entry.
10970 * @li "longpressed": A mouse button has been pressed and held for a couple
10972 * @li "clicked": The entry has been clicked (mouse press and release).
10973 * @li "clicked,double": The entry has been double clicked.
10974 * @li "clicked,triple": The entry has been triple clicked.
10975 * @li "focused": The entry has received focus.
10976 * @li "unfocused": The entry has lost focus.
10977 * @li "selection,paste": A paste of the clipboard contents was requested.
10978 * @li "selection,copy": A copy of the selected text into the clipboard was
10980 * @li "selection,cut": A cut of the selected text into the clipboard was
10982 * @li "selection,start": A selection has begun and no previous selection
10984 * @li "selection,changed": The current selection has changed.
10985 * @li "selection,cleared": The current selection has been cleared.
10986 * @li "cursor,changed": The cursor has changed position.
10987 * @li "anchor,clicked": An anchor has been clicked. The event_info
10988 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10989 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10990 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10991 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10992 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10993 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10994 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10995 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10996 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10997 * @li "preedit,changed": The preedit string has changed.
10998 * @li "language,changed": Program language changed.
11000 * @section entry-examples
11002 * An overview of the Entry API can be seen in @ref entry_example_01
11007 * @typedef Elm_Entry_Anchor_Info
11009 * The info sent in the callback for the "anchor,clicked" signals emitted
11012 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11014 * @struct _Elm_Entry_Anchor_Info
11016 * The info sent in the callback for the "anchor,clicked" signals emitted
11019 struct _Elm_Entry_Anchor_Info
11021 const char *name; /**< The name of the anchor, as stated in its href */
11022 int button; /**< The mouse button used to click on it */
11023 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11024 y, /**< Anchor geometry, relative to canvas */
11025 w, /**< Anchor geometry, relative to canvas */
11026 h; /**< Anchor geometry, relative to canvas */
11029 * @typedef Elm_Entry_Filter_Cb
11030 * This callback type is used by entry filters to modify text.
11031 * @param data The data specified as the last param when adding the filter
11032 * @param entry The entry object
11033 * @param text A pointer to the location of the text being filtered. This data can be modified,
11034 * but any additional allocations must be managed by the user.
11035 * @see elm_entry_text_filter_append
11036 * @see elm_entry_text_filter_prepend
11038 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11041 * This adds an entry to @p parent object.
11043 * By default, entries are:
11047 * @li autosave is enabled
11049 * @param parent The parent object
11050 * @return The new object or NULL if it cannot be created
11052 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11054 * Sets the entry to single line mode.
11056 * In single line mode, entries don't ever wrap when the text reaches the
11057 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11058 * key will generate an @c "activate" event instead of adding a new line.
11060 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11061 * and pressing enter will break the text into a different line
11062 * without generating any events.
11064 * @param obj The entry object
11065 * @param single_line If true, the text in the entry
11066 * will be on a single line.
11068 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11070 * Gets whether the entry is set to be single line.
11072 * @param obj The entry object
11073 * @return single_line If true, the text in the entry is set to display
11074 * on a single line.
11076 * @see elm_entry_single_line_set()
11078 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11080 * Sets the entry to password mode.
11082 * In password mode, entries are implicitly single line and the display of
11083 * any text in them is replaced with asterisks (*).
11085 * @param obj The entry object
11086 * @param password If true, password mode is enabled.
11088 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11090 * Gets whether the entry is set to password mode.
11092 * @param obj The entry object
11093 * @return If true, the entry is set to display all characters
11094 * as asterisks (*).
11096 * @see elm_entry_password_set()
11098 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11100 * This sets the text displayed within the entry to @p entry.
11102 * @param obj The entry object
11103 * @param entry The text to be displayed
11105 * @deprecated Use elm_object_text_set() instead.
11106 * @note Using this function bypasses text filters
11108 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11110 * This returns the text currently shown in object @p entry.
11111 * See also elm_entry_entry_set().
11113 * @param obj The entry object
11114 * @return The currently displayed text or NULL on failure
11116 * @deprecated Use elm_object_text_get() instead.
11118 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11120 * Appends @p entry to the text of the entry.
11122 * Adds the text in @p entry to the end of any text already present in the
11125 * The appended text is subject to any filters set for the widget.
11127 * @param obj The entry object
11128 * @param entry The text to be displayed
11130 * @see elm_entry_text_filter_append()
11132 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11134 * Gets whether the entry is empty.
11136 * Empty means no text at all. If there are any markup tags, like an item
11137 * tag for which no provider finds anything, and no text is displayed, this
11138 * function still returns EINA_FALSE.
11140 * @param obj The entry object
11141 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11143 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11145 * Gets any selected text within the entry.
11147 * If there's any selected text in the entry, this function returns it as
11148 * a string in markup format. NULL is returned if no selection exists or
11149 * if an error occurred.
11151 * The returned value points to an internal string and should not be freed
11152 * or modified in any way. If the @p entry object is deleted or its
11153 * contents are changed, the returned pointer should be considered invalid.
11155 * @param obj The entry object
11156 * @return The selected text within the entry or NULL on failure
11158 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11160 * Inserts the given text into the entry at the current cursor position.
11162 * This inserts text at the cursor position as if it was typed
11163 * by the user (note that this also allows markup which a user
11164 * can't just "type" as it would be converted to escaped text, so this
11165 * call can be used to insert things like emoticon items or bold push/pop
11166 * tags, other font and color change tags etc.)
11168 * If any selection exists, it will be replaced by the inserted text.
11170 * The inserted text is subject to any filters set for the widget.
11172 * @param obj The entry object
11173 * @param entry The text to insert
11175 * @see elm_entry_text_filter_append()
11177 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11179 * Set the line wrap type to use on multi-line entries.
11181 * Sets the wrap type used by the entry to any of the specified in
11182 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11183 * line (without inserting a line break or paragraph separator) when it
11184 * reaches the far edge of the widget.
11186 * Note that this only makes sense for multi-line entries. A widget set
11187 * to be single line will never wrap.
11189 * @param obj The entry object
11190 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11192 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11193 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11195 * Gets the wrap mode the entry was set to use.
11197 * @param obj The entry object
11198 * @return Wrap type
11200 * @see also elm_entry_line_wrap_set()
11202 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11204 * Sets if the entry is to be editable or not.
11206 * By default, entries are editable and when focused, any text input by the
11207 * user will be inserted at the current cursor position. But calling this
11208 * function with @p editable as EINA_FALSE will prevent the user from
11209 * inputting text into the entry.
11211 * The only way to change the text of a non-editable entry is to use
11212 * elm_object_text_set(), elm_entry_entry_insert() and other related
11215 * @param obj The entry object
11216 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11217 * if not, the entry is read-only and no user input is allowed.
11219 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11221 * Gets whether the entry is editable or not.
11223 * @param obj The entry object
11224 * @return If true, the entry is editable by the user.
11225 * If false, it is not editable by the user
11227 * @see elm_entry_editable_set()
11229 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11231 * This drops any existing text selection within the entry.
11233 * @param obj The entry object
11235 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11237 * This selects all text within the entry.
11239 * @param obj The entry object
11241 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11243 * This moves the cursor one place to the right within the entry.
11245 * @param obj The entry object
11246 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11248 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11250 * This moves the cursor one place to the left within the entry.
11252 * @param obj The entry object
11253 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11255 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11257 * This moves the cursor one line up within the entry.
11259 * @param obj The entry object
11260 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11262 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11264 * This moves the cursor one line down within the entry.
11266 * @param obj The entry object
11267 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11269 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11271 * This moves the cursor to the beginning of the entry.
11273 * @param obj The entry object
11275 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11277 * This moves the cursor to the end of the entry.
11279 * @param obj The entry object
11281 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11283 * This moves the cursor to the beginning of the current line.
11285 * @param obj The entry object
11287 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11289 * This moves the cursor to the end of the current line.
11291 * @param obj The entry object
11293 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11295 * This begins a selection within the entry as though
11296 * the user were holding down the mouse button to make a selection.
11298 * @param obj The entry object
11300 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11302 * This ends a selection within the entry as though
11303 * the user had just released the mouse button while making a selection.
11305 * @param obj The entry object
11307 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11309 * Gets whether a format node exists at the current cursor position.
11311 * A format node is anything that defines how the text is rendered. It can
11312 * be a visible format node, such as a line break or a paragraph separator,
11313 * or an invisible one, such as bold begin or end tag.
11314 * This function returns whether any format node exists at the current
11317 * @param obj The entry object
11318 * @return EINA_TRUE if the current cursor position contains a format node,
11319 * EINA_FALSE otherwise.
11321 * @see elm_entry_cursor_is_visible_format_get()
11323 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11325 * Gets if the current cursor position holds a visible format node.
11327 * @param obj The entry object
11328 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11329 * if it's an invisible one or no format exists.
11331 * @see elm_entry_cursor_is_format_get()
11333 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11335 * Gets the character pointed by the cursor at its current position.
11337 * This function returns a string with the utf8 character stored at the
11338 * current cursor position.
11339 * Only the text is returned, any format that may exist will not be part
11340 * of the return value.
11342 * @param obj The entry object
11343 * @return The text pointed by the cursors.
11345 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11347 * This function returns the geometry of the cursor.
11349 * It's useful if you want to draw something on the cursor (or where it is),
11350 * or for example in the case of scrolled entry where you want to show the
11353 * @param obj The entry object
11354 * @param x returned geometry
11355 * @param y returned geometry
11356 * @param w returned geometry
11357 * @param h returned geometry
11358 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11360 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);
11362 * Sets the cursor position in the entry to the given value
11364 * The value in @p pos is the index of the character position within the
11365 * contents of the string as returned by elm_entry_cursor_pos_get().
11367 * @param obj The entry object
11368 * @param pos The position of the cursor
11370 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11372 * Retrieves the current position of the cursor in the entry
11374 * @param obj The entry object
11375 * @return The cursor position
11377 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11379 * This executes a "cut" action on the selected text in the entry.
11381 * @param obj The entry object
11383 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11385 * This executes a "copy" action on the selected text in the entry.
11387 * @param obj The entry object
11389 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11391 * This executes a "paste" action in the entry.
11393 * @param obj The entry object
11395 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11397 * This clears and frees the items in a entry's contextual (longpress)
11400 * @param obj The entry object
11402 * @see elm_entry_context_menu_item_add()
11404 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11406 * This adds an item to the entry's contextual menu.
11408 * A longpress on an entry will make the contextual menu show up, if this
11409 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11410 * By default, this menu provides a few options like enabling selection mode,
11411 * which is useful on embedded devices that need to be explicit about it,
11412 * and when a selection exists it also shows the copy and cut actions.
11414 * With this function, developers can add other options to this menu to
11415 * perform any action they deem necessary.
11417 * @param obj The entry object
11418 * @param label The item's text label
11419 * @param icon_file The item's icon file
11420 * @param icon_type The item's icon type
11421 * @param func The callback to execute when the item is clicked
11422 * @param data The data to associate with the item for related functions
11424 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);
11426 * This disables the entry's contextual (longpress) menu.
11428 * @param obj The entry object
11429 * @param disabled If true, the menu is disabled
11431 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11433 * This returns whether the entry's contextual (longpress) menu is
11436 * @param obj The entry object
11437 * @return If true, the menu is disabled
11439 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11441 * This appends a custom item provider to the list for that entry
11443 * This appends the given callback. The list is walked from beginning to end
11444 * with each function called given the item href string in the text. If the
11445 * function returns an object handle other than NULL (it should create an
11446 * object to do this), then this object is used to replace that item. If
11447 * not the next provider is called until one provides an item object, or the
11448 * default provider in entry does.
11450 * @param obj The entry object
11451 * @param func The function called to provide the item object
11452 * @param data The data passed to @p func
11454 * @see @ref entry-items
11456 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);
11458 * This prepends a custom item provider to the list for that entry
11460 * This prepends the given callback. See elm_entry_item_provider_append() for
11463 * @param obj The entry object
11464 * @param func The function called to provide the item object
11465 * @param data The data passed to @p func
11467 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);
11469 * This removes a custom item provider to the list for that entry
11471 * This removes the given callback. See elm_entry_item_provider_append() for
11474 * @param obj The entry object
11475 * @param func The function called to provide the item object
11476 * @param data The data passed to @p func
11478 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);
11480 * Append a filter function for text inserted in the entry
11482 * Append the given callback to the list. This functions will be called
11483 * whenever any text is inserted into the entry, with the text to be inserted
11484 * as a parameter. The callback function is free to alter the text in any way
11485 * it wants, but it must remember to free the given pointer and update it.
11486 * If the new text is to be discarded, the function can free it and set its
11487 * text parameter to NULL. This will also prevent any following filters from
11490 * @param obj The entry object
11491 * @param func The function to use as text filter
11492 * @param data User data to pass to @p func
11494 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11496 * Prepend a filter function for text insdrted in the entry
11498 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11499 * for more information
11501 * @param obj The entry object
11502 * @param func The function to use as text filter
11503 * @param data User data to pass to @p func
11505 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11507 * Remove a filter from the list
11509 * Removes the given callback from the filter list. See
11510 * elm_entry_text_filter_append() for more information.
11512 * @param obj The entry object
11513 * @param func The filter function to remove
11514 * @param data The user data passed when adding the function
11516 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11518 * This converts a markup (HTML-like) string into UTF-8.
11520 * The returned string is a malloc'ed buffer and it should be freed when
11521 * not needed anymore.
11523 * @param s The string (in markup) to be converted
11524 * @return The converted string (in UTF-8). It should be freed.
11526 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11528 * This converts a UTF-8 string into markup (HTML-like).
11530 * The returned string is a malloc'ed buffer and it should be freed when
11531 * not needed anymore.
11533 * @param s The string (in UTF-8) to be converted
11534 * @return The converted string (in markup). It should be freed.
11536 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11538 * This sets the file (and implicitly loads it) for the text to display and
11539 * then edit. All changes are written back to the file after a short delay if
11540 * the entry object is set to autosave (which is the default).
11542 * If the entry had any other file set previously, any changes made to it
11543 * will be saved if the autosave feature is enabled, otherwise, the file
11544 * will be silently discarded and any non-saved changes will be lost.
11546 * @param obj The entry object
11547 * @param file The path to the file to load and save
11548 * @param format The file format
11550 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11552 * Gets the file being edited by the entry.
11554 * This function can be used to retrieve any file set on the entry for
11555 * edition, along with the format used to load and save it.
11557 * @param obj The entry object
11558 * @param file The path to the file to load and save
11559 * @param format The file format
11561 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11563 * This function writes any changes made to the file set with
11564 * elm_entry_file_set()
11566 * @param obj The entry object
11568 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11570 * This sets the entry object to 'autosave' the loaded text file or not.
11572 * @param obj The entry object
11573 * @param autosave Autosave the loaded file or not
11575 * @see elm_entry_file_set()
11577 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11579 * This gets the entry object's 'autosave' status.
11581 * @param obj The entry object
11582 * @return Autosave the loaded file or not
11584 * @see elm_entry_file_set()
11586 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11588 * Control pasting of text and images for the widget.
11590 * Normally the entry allows both text and images to be pasted. By setting
11591 * textonly to be true, this prevents images from being pasted.
11593 * Note this only changes the behaviour of text.
11595 * @param obj The entry object
11596 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11597 * text+image+other.
11599 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11601 * Getting elm_entry text paste/drop mode.
11603 * In textonly mode, only text may be pasted or dropped into the widget.
11605 * @param obj The entry object
11606 * @return If the widget only accepts text from pastes.
11608 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11610 * Enable or disable scrolling in entry
11612 * Normally the entry is not scrollable unless you enable it with this call.
11614 * @param obj The entry object
11615 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11617 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11619 * Get the scrollable state of the entry
11621 * Normally the entry is not scrollable. This gets the scrollable state
11622 * of the entry. See elm_entry_scrollable_set() for more information.
11624 * @param obj The entry object
11625 * @return The scrollable state
11627 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11629 * This sets a widget to be displayed to the left of a scrolled entry.
11631 * @param obj The scrolled entry object
11632 * @param icon The widget to display on the left side of the scrolled
11635 * @note A previously set widget will be destroyed.
11636 * @note If the object being set does not have minimum size hints set,
11637 * it won't get properly displayed.
11639 * @see elm_entry_end_set()
11641 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11643 * Gets the leftmost widget of the scrolled entry. This object is
11644 * owned by the scrolled entry and should not be modified.
11646 * @param obj The scrolled entry object
11647 * @return the left widget inside the scroller
11649 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11651 * Unset the leftmost widget of the scrolled entry, unparenting and
11654 * @param obj The scrolled entry object
11655 * @return the previously set icon sub-object of this entry, on
11658 * @see elm_entry_icon_set()
11660 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11662 * Sets the visibility of the left-side widget of the scrolled entry,
11663 * set by elm_entry_icon_set().
11665 * @param obj The scrolled entry object
11666 * @param setting EINA_TRUE if the object should be displayed,
11667 * EINA_FALSE if not.
11669 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11671 * This sets a widget to be displayed to the end of a scrolled entry.
11673 * @param obj The scrolled entry object
11674 * @param end The widget to display on the right side of the scrolled
11677 * @note A previously set widget will be destroyed.
11678 * @note If the object being set does not have minimum size hints set,
11679 * it won't get properly displayed.
11681 * @see elm_entry_icon_set
11683 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11685 * Gets the endmost widget of the scrolled entry. This object is owned
11686 * by the scrolled entry and should not be modified.
11688 * @param obj The scrolled entry object
11689 * @return the right widget inside the scroller
11691 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11693 * Unset the endmost widget of the scrolled entry, unparenting and
11696 * @param obj The scrolled entry object
11697 * @return the previously set icon sub-object of this entry, on
11700 * @see elm_entry_icon_set()
11702 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11704 * Sets the visibility of the end widget of the scrolled entry, set by
11705 * elm_entry_end_set().
11707 * @param obj The scrolled entry object
11708 * @param setting EINA_TRUE if the object should be displayed,
11709 * EINA_FALSE if not.
11711 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11713 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11716 * Setting an entry to single-line mode with elm_entry_single_line_set()
11717 * will automatically disable the display of scrollbars when the entry
11718 * moves inside its scroller.
11720 * @param obj The scrolled entry object
11721 * @param h The horizontal scrollbar policy to apply
11722 * @param v The vertical scrollbar policy to apply
11724 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11726 * This enables/disables bouncing within the entry.
11728 * This function sets whether the entry will bounce when scrolling reaches
11729 * the end of the contained entry.
11731 * @param obj The scrolled entry object
11732 * @param h The horizontal bounce state
11733 * @param v The vertical bounce state
11735 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11737 * Get the bounce mode
11739 * @param obj The Entry object
11740 * @param h_bounce Allow bounce horizontally
11741 * @param v_bounce Allow bounce vertically
11743 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11745 /* pre-made filters for entries */
11747 * @typedef Elm_Entry_Filter_Limit_Size
11749 * Data for the elm_entry_filter_limit_size() entry filter.
11751 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11753 * @struct _Elm_Entry_Filter_Limit_Size
11755 * Data for the elm_entry_filter_limit_size() entry filter.
11757 struct _Elm_Entry_Filter_Limit_Size
11759 int max_char_count; /**< The maximum number of characters allowed. */
11760 int max_byte_count; /**< The maximum number of bytes allowed*/
11763 * Filter inserted text based on user defined character and byte limits
11765 * Add this filter to an entry to limit the characters that it will accept
11766 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11767 * The funtion works on the UTF-8 representation of the string, converting
11768 * it from the set markup, thus not accounting for any format in it.
11770 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11771 * it as data when setting the filter. In it, it's possible to set limits
11772 * by character count or bytes (any of them is disabled if 0), and both can
11773 * be set at the same time. In that case, it first checks for characters,
11776 * The function will cut the inserted text in order to allow only the first
11777 * number of characters that are still allowed. The cut is made in
11778 * characters, even when limiting by bytes, in order to always contain
11779 * valid ones and avoid half unicode characters making it in.
11781 * This filter, like any others, does not apply when setting the entry text
11782 * directly with elm_object_text_set() (or the deprecated
11783 * elm_entry_entry_set()).
11785 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11787 * @typedef Elm_Entry_Filter_Accept_Set
11789 * Data for the elm_entry_filter_accept_set() entry filter.
11791 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11793 * @struct _Elm_Entry_Filter_Accept_Set
11795 * Data for the elm_entry_filter_accept_set() entry filter.
11797 struct _Elm_Entry_Filter_Accept_Set
11799 const char *accepted; /**< Set of characters accepted in the entry. */
11800 const char *rejected; /**< Set of characters rejected from the entry. */
11803 * Filter inserted text based on accepted or rejected sets of characters
11805 * Add this filter to an entry to restrict the set of accepted characters
11806 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11807 * This structure contains both accepted and rejected sets, but they are
11808 * mutually exclusive.
11810 * The @c accepted set takes preference, so if it is set, the filter will
11811 * only work based on the accepted characters, ignoring anything in the
11812 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11814 * In both cases, the function filters by matching utf8 characters to the
11815 * raw markup text, so it can be used to remove formatting tags.
11817 * This filter, like any others, does not apply when setting the entry text
11818 * directly with elm_object_text_set() (or the deprecated
11819 * elm_entry_entry_set()).
11821 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11823 * Set the input panel layout of the entry
11825 * @param obj The entry object
11826 * @param layout layout type
11828 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11830 * Get the input panel layout of the entry
11832 * @param obj The entry object
11833 * @return layout type
11835 * @see elm_entry_input_panel_layout_set
11837 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11839 * Set the autocapitalization type on the immodule.
11841 * @param obj The entry object
11842 * @param autocapital_type The type of autocapitalization
11844 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11846 * Retrieve the autocapitalization type on the immodule.
11848 * @param obj The entry object
11849 * @return autocapitalization type
11851 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11853 * Sets the attribute to show the input panel automatically.
11855 * @param obj The entry object
11856 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11858 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11860 * Retrieve the attribute to show the input panel automatically.
11862 * @param obj The entry object
11863 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11865 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11867 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11868 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11869 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11870 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11871 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11872 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11873 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11875 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11876 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11877 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11878 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11879 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11885 /* composite widgets - these basically put together basic widgets above
11886 * in convenient packages that do more than basic stuff */
11890 * @defgroup Anchorview Anchorview
11892 * @image html img/widget/anchorview/preview-00.png
11893 * @image latex img/widget/anchorview/preview-00.eps
11895 * Anchorview is for displaying text that contains markup with anchors
11896 * like <c>\<a href=1234\>something\</\></c> in it.
11898 * Besides being styled differently, the anchorview widget provides the
11899 * necessary functionality so that clicking on these anchors brings up a
11900 * popup with user defined content such as "call", "add to contacts" or
11901 * "open web page". This popup is provided using the @ref Hover widget.
11903 * This widget is very similar to @ref Anchorblock, so refer to that
11904 * widget for an example. The only difference Anchorview has is that the
11905 * widget is already provided with scrolling functionality, so if the
11906 * text set to it is too large to fit in the given space, it will scroll,
11907 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11908 * text can be displayed.
11910 * This widget emits the following signals:
11911 * @li "anchor,clicked": will be called when an anchor is clicked. The
11912 * @p event_info parameter on the callback will be a pointer of type
11913 * ::Elm_Entry_Anchorview_Info.
11915 * See @ref Anchorblock for an example on how to use both of them.
11924 * @typedef Elm_Entry_Anchorview_Info
11926 * The info sent in the callback for "anchor,clicked" signals emitted by
11927 * the Anchorview widget.
11929 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11931 * @struct _Elm_Entry_Anchorview_Info
11933 * The info sent in the callback for "anchor,clicked" signals emitted by
11934 * the Anchorview widget.
11936 struct _Elm_Entry_Anchorview_Info
11938 const char *name; /**< Name of the anchor, as indicated in its href
11940 int button; /**< The mouse button used to click on it */
11941 Evas_Object *hover; /**< The hover object to use for the popup */
11943 Evas_Coord x, y, w, h;
11944 } anchor, /**< Geometry selection of text used as anchor */
11945 hover_parent; /**< Geometry of the object used as parent by the
11947 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11948 for content on the left side of
11949 the hover. Before calling the
11950 callback, the widget will make the
11951 necessary calculations to check
11952 which sides are fit to be set with
11953 content, based on the position the
11954 hover is activated and its distance
11955 to the edges of its parent object
11957 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11958 the right side of the hover.
11959 See @ref hover_left */
11960 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11961 of the hover. See @ref hover_left */
11962 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11963 below the hover. See @ref
11967 * Add a new Anchorview object
11969 * @param parent The parent object
11970 * @return The new object or NULL if it cannot be created
11972 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11974 * Set the text to show in the anchorview
11976 * Sets the text of the anchorview to @p text. This text can include markup
11977 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11978 * text that will be specially styled and react to click events, ended with
11979 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11980 * "anchor,clicked" signal that you can attach a callback to with
11981 * evas_object_smart_callback_add(). The name of the anchor given in the
11982 * event info struct will be the one set in the href attribute, in this
11983 * case, anchorname.
11985 * Other markup can be used to style the text in different ways, but it's
11986 * up to the style defined in the theme which tags do what.
11987 * @deprecated use elm_object_text_set() instead.
11989 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11991 * Get the markup text set for the anchorview
11993 * Retrieves the text set on the anchorview, with markup tags included.
11995 * @param obj The anchorview object
11996 * @return The markup text set or @c NULL if nothing was set or an error
11998 * @deprecated use elm_object_text_set() instead.
12000 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12002 * Set the parent of the hover popup
12004 * Sets the parent object to use by the hover created by the anchorview
12005 * when an anchor is clicked. See @ref Hover for more details on this.
12006 * If no parent is set, the same anchorview object will be used.
12008 * @param obj The anchorview object
12009 * @param parent The object to use as parent for the hover
12011 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12013 * Get the parent of the hover popup
12015 * Get the object used as parent for the hover created by the anchorview
12016 * widget. See @ref Hover for more details on this.
12018 * @param obj The anchorview object
12019 * @return The object used as parent for the hover, NULL if none is set.
12021 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12023 * Set the style that the hover should use
12025 * When creating the popup hover, anchorview will request that it's
12026 * themed according to @p style.
12028 * @param obj The anchorview object
12029 * @param style The style to use for the underlying hover
12031 * @see elm_object_style_set()
12033 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12035 * Get the style that the hover should use
12037 * Get the style the hover created by anchorview will use.
12039 * @param obj The anchorview object
12040 * @return The style to use by the hover. NULL means the default is used.
12042 * @see elm_object_style_set()
12044 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12046 * Ends the hover popup in the anchorview
12048 * When an anchor is clicked, the anchorview widget will create a hover
12049 * object to use as a popup with user provided content. This function
12050 * terminates this popup, returning the anchorview to its normal state.
12052 * @param obj The anchorview object
12054 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12056 * Set bouncing behaviour when the scrolled content reaches an edge
12058 * Tell the internal scroller object whether it should bounce or not
12059 * when it reaches the respective edges for each axis.
12061 * @param obj The anchorview object
12062 * @param h_bounce Whether to bounce or not in the horizontal axis
12063 * @param v_bounce Whether to bounce or not in the vertical axis
12065 * @see elm_scroller_bounce_set()
12067 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12069 * Get the set bouncing behaviour of the internal scroller
12071 * Get whether the internal scroller should bounce when the edge of each
12072 * axis is reached scrolling.
12074 * @param obj The anchorview object
12075 * @param h_bounce Pointer where to store the bounce state of the horizontal
12077 * @param v_bounce Pointer where to store the bounce state of the vertical
12080 * @see elm_scroller_bounce_get()
12082 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12084 * Appends a custom item provider to the given anchorview
12086 * Appends the given function to the list of items providers. This list is
12087 * called, one function at a time, with the given @p data pointer, the
12088 * anchorview object and, in the @p item parameter, the item name as
12089 * referenced in its href string. Following functions in the list will be
12090 * called in order until one of them returns something different to NULL,
12091 * which should be an Evas_Object which will be used in place of the item
12094 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12095 * href=item/name\>\</item\>
12097 * @param obj The anchorview object
12098 * @param func The function to add to the list of providers
12099 * @param data User data that will be passed to the callback function
12101 * @see elm_entry_item_provider_append()
12103 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);
12105 * Prepend a custom item provider to the given anchorview
12107 * Like elm_anchorview_item_provider_append(), but it adds the function
12108 * @p func to the beginning of the list, instead of the end.
12110 * @param obj The anchorview object
12111 * @param func The function to add to the list of providers
12112 * @param data User data that will be passed to the callback function
12114 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);
12116 * Remove a custom item provider from the list of the given anchorview
12118 * Removes the function and data pairing that matches @p func and @p data.
12119 * That is, unless the same function and same user data are given, the
12120 * function will not be removed from the list. This allows us to add the
12121 * same callback several times, with different @p data pointers and be
12122 * able to remove them later without conflicts.
12124 * @param obj The anchorview object
12125 * @param func The function to remove from the list
12126 * @param data The data matching the function to remove from the list
12128 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);
12135 * @defgroup Anchorblock Anchorblock
12137 * @image html img/widget/anchorblock/preview-00.png
12138 * @image latex img/widget/anchorblock/preview-00.eps
12140 * Anchorblock is for displaying text that contains markup with anchors
12141 * like <c>\<a href=1234\>something\</\></c> in it.
12143 * Besides being styled differently, the anchorblock widget provides the
12144 * necessary functionality so that clicking on these anchors brings up a
12145 * popup with user defined content such as "call", "add to contacts" or
12146 * "open web page". This popup is provided using the @ref Hover widget.
12148 * This widget emits the following signals:
12149 * @li "anchor,clicked": will be called when an anchor is clicked. The
12150 * @p event_info parameter on the callback will be a pointer of type
12151 * ::Elm_Entry_Anchorblock_Info.
12157 * Since examples are usually better than plain words, we might as well
12158 * try @ref tutorial_anchorblock_example "one".
12161 * @addtogroup Anchorblock
12165 * @typedef Elm_Entry_Anchorblock_Info
12167 * The info sent in the callback for "anchor,clicked" signals emitted by
12168 * the Anchorblock widget.
12170 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12172 * @struct _Elm_Entry_Anchorblock_Info
12174 * The info sent in the callback for "anchor,clicked" signals emitted by
12175 * the Anchorblock widget.
12177 struct _Elm_Entry_Anchorblock_Info
12179 const char *name; /**< Name of the anchor, as indicated in its href
12181 int button; /**< The mouse button used to click on it */
12182 Evas_Object *hover; /**< The hover object to use for the popup */
12184 Evas_Coord x, y, w, h;
12185 } anchor, /**< Geometry selection of text used as anchor */
12186 hover_parent; /**< Geometry of the object used as parent by the
12188 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12189 for content on the left side of
12190 the hover. Before calling the
12191 callback, the widget will make the
12192 necessary calculations to check
12193 which sides are fit to be set with
12194 content, based on the position the
12195 hover is activated and its distance
12196 to the edges of its parent object
12198 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12199 the right side of the hover.
12200 See @ref hover_left */
12201 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12202 of the hover. See @ref hover_left */
12203 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12204 below the hover. See @ref
12208 * Add a new Anchorblock object
12210 * @param parent The parent object
12211 * @return The new object or NULL if it cannot be created
12213 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12215 * Set the text to show in the anchorblock
12217 * Sets the text of the anchorblock to @p text. This text can include markup
12218 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12219 * of text that will be specially styled and react to click events, ended
12220 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12221 * "anchor,clicked" signal that you can attach a callback to with
12222 * evas_object_smart_callback_add(). The name of the anchor given in the
12223 * event info struct will be the one set in the href attribute, in this
12224 * case, anchorname.
12226 * Other markup can be used to style the text in different ways, but it's
12227 * up to the style defined in the theme which tags do what.
12228 * @deprecated use elm_object_text_set() instead.
12230 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12232 * Get the markup text set for the anchorblock
12234 * Retrieves the text set on the anchorblock, with markup tags included.
12236 * @param obj The anchorblock object
12237 * @return The markup text set or @c NULL if nothing was set or an error
12239 * @deprecated use elm_object_text_set() instead.
12241 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12243 * Set the parent of the hover popup
12245 * Sets the parent object to use by the hover created by the anchorblock
12246 * when an anchor is clicked. See @ref Hover for more details on this.
12248 * @param obj The anchorblock object
12249 * @param parent The object to use as parent for the hover
12251 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12253 * Get the parent of the hover popup
12255 * Get the object used as parent for the hover created by the anchorblock
12256 * widget. See @ref Hover for more details on this.
12257 * If no parent is set, the same anchorblock object will be used.
12259 * @param obj The anchorblock object
12260 * @return The object used as parent for the hover, NULL if none is set.
12262 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12264 * Set the style that the hover should use
12266 * When creating the popup hover, anchorblock will request that it's
12267 * themed according to @p style.
12269 * @param obj The anchorblock object
12270 * @param style The style to use for the underlying hover
12272 * @see elm_object_style_set()
12274 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12276 * Get the style that the hover should use
12278 * Get the style, the hover created by anchorblock will use.
12280 * @param obj The anchorblock object
12281 * @return The style to use by the hover. NULL means the default is used.
12283 * @see elm_object_style_set()
12285 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12287 * Ends the hover popup in the anchorblock
12289 * When an anchor is clicked, the anchorblock widget will create a hover
12290 * object to use as a popup with user provided content. This function
12291 * terminates this popup, returning the anchorblock to its normal state.
12293 * @param obj The anchorblock object
12295 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12297 * Appends a custom item provider to the given anchorblock
12299 * Appends the given function to the list of items providers. This list is
12300 * called, one function at a time, with the given @p data pointer, the
12301 * anchorblock object and, in the @p item parameter, the item name as
12302 * referenced in its href string. Following functions in the list will be
12303 * called in order until one of them returns something different to NULL,
12304 * which should be an Evas_Object which will be used in place of the item
12307 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12308 * href=item/name\>\</item\>
12310 * @param obj The anchorblock object
12311 * @param func The function to add to the list of providers
12312 * @param data User data that will be passed to the callback function
12314 * @see elm_entry_item_provider_append()
12316 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);
12318 * Prepend a custom item provider to the given anchorblock
12320 * Like elm_anchorblock_item_provider_append(), but it adds the function
12321 * @p func to the beginning of the list, instead of the end.
12323 * @param obj The anchorblock object
12324 * @param func The function to add to the list of providers
12325 * @param data User data that will be passed to the callback function
12327 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);
12329 * Remove a custom item provider from the list of the given anchorblock
12331 * Removes the function and data pairing that matches @p func and @p data.
12332 * That is, unless the same function and same user data are given, the
12333 * function will not be removed from the list. This allows us to add the
12334 * same callback several times, with different @p data pointers and be
12335 * able to remove them later without conflicts.
12337 * @param obj The anchorblock object
12338 * @param func The function to remove from the list
12339 * @param data The data matching the function to remove from the list
12341 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);
12347 * @defgroup Bubble Bubble
12349 * @image html img/widget/bubble/preview-00.png
12350 * @image latex img/widget/bubble/preview-00.eps
12351 * @image html img/widget/bubble/preview-01.png
12352 * @image latex img/widget/bubble/preview-01.eps
12353 * @image html img/widget/bubble/preview-02.png
12354 * @image latex img/widget/bubble/preview-02.eps
12356 * @brief The Bubble is a widget to show text similar to how speech is
12357 * represented in comics.
12359 * The bubble widget contains 5 important visual elements:
12360 * @li The frame is a rectangle with rounded edjes and an "arrow".
12361 * @li The @p icon is an image to which the frame's arrow points to.
12362 * @li The @p label is a text which appears to the right of the icon if the
12363 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12365 * @li The @p info is a text which appears to the right of the label. Info's
12366 * font is of a ligther color than label.
12367 * @li The @p content is an evas object that is shown inside the frame.
12369 * The position of the arrow, icon, label and info depends on which corner is
12370 * selected. The four available corners are:
12371 * @li "top_left" - Default
12373 * @li "bottom_left"
12374 * @li "bottom_right"
12376 * Signals that you can add callbacks for are:
12377 * @li "clicked" - This is called when a user has clicked the bubble.
12379 * For an example of using a buble see @ref bubble_01_example_page "this".
12384 #define ELM_BUBBLE_CONTENT_ICON "elm.swallow.icon"
12387 * Add a new bubble to the parent
12389 * @param parent The parent object
12390 * @return The new object or NULL if it cannot be created
12392 * This function adds a text bubble to the given parent evas object.
12394 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12396 * Set the label of the bubble
12398 * @param obj The bubble object
12399 * @param label The string to set in the label
12401 * This function sets the title of the bubble. Where this appears depends on
12402 * the selected corner.
12403 * @deprecated use elm_object_text_set() instead.
12405 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12407 * Get the label of the bubble
12409 * @param obj The bubble object
12410 * @return The string of set in the label
12412 * This function gets the title of the bubble.
12413 * @deprecated use elm_object_text_get() instead.
12415 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12417 * Set the info of the bubble
12419 * @param obj The bubble object
12420 * @param info The given info about the bubble
12422 * This function sets the info of the bubble. Where this appears depends on
12423 * the selected corner.
12424 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12426 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12428 * Get the info of the bubble
12430 * @param obj The bubble object
12432 * @return The "info" string of the bubble
12434 * This function gets the info text.
12435 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12437 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12439 * Set the content to be shown in the bubble
12441 * Once the content object is set, a previously set one will be deleted.
12442 * If you want to keep the old content object, use the
12443 * elm_bubble_content_unset() function.
12445 * @param obj The bubble object
12446 * @param content The given content of the bubble
12448 * This function sets the content shown on the middle of the bubble.
12450 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12452 * Get the content shown in the bubble
12454 * Return the content object which is set for this widget.
12456 * @param obj The bubble object
12457 * @return The content that is being used
12459 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12461 * Unset the content shown in the bubble
12463 * Unparent and return the content object which was set for this widget.
12465 * @param obj The bubble object
12466 * @return The content that was being used
12468 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12470 * Set the icon of the bubble
12472 * Once the icon object is set, a previously set one will be deleted.
12473 * If you want to keep the old content object, use the
12474 * elm_icon_content_unset() function.
12476 * @param obj The bubble object
12477 * @param icon The given icon for the bubble
12479 * @deprecated use elm_object_content_part_set() instead
12482 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12484 * Get the icon of the bubble
12486 * @param obj The bubble object
12487 * @return The icon for the bubble
12489 * This function gets the icon shown on the top left of bubble.
12491 * @deprecated use elm_object_content_part_get() instead
12494 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12496 * Unset the icon of the bubble
12498 * Unparent and return the icon object which was set for this widget.
12500 * @param obj The bubble object
12501 * @return The icon that was being used
12503 * @deprecated use elm_object_content_part_unset() instead
12506 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12508 * Set the corner of the bubble
12510 * @param obj The bubble object.
12511 * @param corner The given corner for the bubble.
12513 * This function sets the corner of the bubble. The corner will be used to
12514 * determine where the arrow in the frame points to and where label, icon and
12517 * Possible values for corner are:
12518 * @li "top_left" - Default
12520 * @li "bottom_left"
12521 * @li "bottom_right"
12523 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12525 * Get the corner of the bubble
12527 * @param obj The bubble object.
12528 * @return The given corner for the bubble.
12530 * This function gets the selected corner of the bubble.
12532 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12534 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12535 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12542 * @defgroup Photo Photo
12544 * For displaying the photo of a person (contact). Simple, yet
12545 * with a very specific purpose.
12547 * Signals that you can add callbacks for are:
12549 * "clicked" - This is called when a user has clicked the photo
12550 * "drag,start" - Someone started dragging the image out of the object
12551 * "drag,end" - Dragged item was dropped (somewhere)
12557 * Add a new photo to the parent
12559 * @param parent The parent object
12560 * @return The new object or NULL if it cannot be created
12564 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12567 * Set the file that will be used as photo
12569 * @param obj The photo object
12570 * @param file The path to file that will be used as photo
12572 * @return (1 = success, 0 = error)
12576 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12579 * Set the file that will be used as thumbnail in the photo.
12581 * @param obj The photo object.
12582 * @param file The path to file that will be used as thumb.
12583 * @param group The key used in case of an EET file.
12587 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12590 * Set the size that will be used on the photo
12592 * @param obj The photo object
12593 * @param size The size that the photo will be
12597 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12600 * Set if the photo should be completely visible or not.
12602 * @param obj The photo object
12603 * @param fill if true the photo will be completely visible
12607 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12610 * Set editability of the photo.
12612 * An editable photo can be dragged to or from, and can be cut or
12613 * pasted too. Note that pasting an image or dropping an item on
12614 * the image will delete the existing content.
12616 * @param obj The photo object.
12617 * @param set To set of clear editablity.
12619 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12625 /* gesture layer */
12627 * @defgroup Elm_Gesture_Layer Gesture Layer
12628 * Gesture Layer Usage:
12630 * Use Gesture Layer to detect gestures.
12631 * The advantage is that you don't have to implement
12632 * gesture detection, just set callbacks of gesture state.
12633 * By using gesture layer we make standard interface.
12635 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12636 * with a parent object parameter.
12637 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12638 * call. Usually with same object as target (2nd parameter).
12640 * Now you need to tell gesture layer what gestures you follow.
12641 * This is done with @ref elm_gesture_layer_cb_set call.
12642 * By setting the callback you actually saying to gesture layer:
12643 * I would like to know when the gesture @ref Elm_Gesture_Types
12644 * switches to state @ref Elm_Gesture_State.
12646 * Next, you need to implement the actual action that follows the input
12647 * in your callback.
12649 * Note that if you like to stop being reported about a gesture, just set
12650 * all callbacks referring this gesture to NULL.
12651 * (again with @ref elm_gesture_layer_cb_set)
12653 * The information reported by gesture layer to your callback is depending
12654 * on @ref Elm_Gesture_Types:
12655 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12656 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12657 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12659 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12660 * @ref ELM_GESTURE_MOMENTUM.
12662 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12663 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12664 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12665 * Note that we consider a flick as a line-gesture that should be completed
12666 * in flick-time-limit as defined in @ref Config.
12668 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12670 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12673 * Gesture Layer Tweaks:
12675 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12676 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12678 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12679 * so gesture starts when user touches (a *DOWN event) touch-surface
12680 * and ends when no fingers touches surface (a *UP event).
12684 * @enum _Elm_Gesture_Types
12685 * Enum of supported gesture types.
12686 * @ingroup Elm_Gesture_Layer
12688 enum _Elm_Gesture_Types
12690 ELM_GESTURE_FIRST = 0,
12692 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12693 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12694 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12695 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12697 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12699 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12700 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12702 ELM_GESTURE_ZOOM, /**< Zoom */
12703 ELM_GESTURE_ROTATE, /**< Rotate */
12709 * @typedef Elm_Gesture_Types
12710 * gesture types enum
12711 * @ingroup Elm_Gesture_Layer
12713 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12716 * @enum _Elm_Gesture_State
12717 * Enum of gesture states.
12718 * @ingroup Elm_Gesture_Layer
12720 enum _Elm_Gesture_State
12722 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12723 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12724 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12725 ELM_GESTURE_STATE_END, /**< Gesture completed */
12726 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12730 * @typedef Elm_Gesture_State
12731 * gesture states enum
12732 * @ingroup Elm_Gesture_Layer
12734 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12737 * @struct _Elm_Gesture_Taps_Info
12738 * Struct holds taps info for user
12739 * @ingroup Elm_Gesture_Layer
12741 struct _Elm_Gesture_Taps_Info
12743 Evas_Coord x, y; /**< Holds center point between fingers */
12744 unsigned int n; /**< Number of fingers tapped */
12745 unsigned int timestamp; /**< event timestamp */
12749 * @typedef Elm_Gesture_Taps_Info
12750 * holds taps info for user
12751 * @ingroup Elm_Gesture_Layer
12753 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12756 * @struct _Elm_Gesture_Momentum_Info
12757 * Struct holds momentum info for user
12758 * x1 and y1 are not necessarily in sync
12759 * x1 holds x value of x direction starting point
12760 * and same holds for y1.
12761 * This is noticeable when doing V-shape movement
12762 * @ingroup Elm_Gesture_Layer
12764 struct _Elm_Gesture_Momentum_Info
12765 { /* Report line ends, timestamps, and momentum computed */
12766 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12767 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12768 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12769 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12771 unsigned int tx; /**< Timestamp of start of final x-swipe */
12772 unsigned int ty; /**< Timestamp of start of final y-swipe */
12774 Evas_Coord mx; /**< Momentum on X */
12775 Evas_Coord my; /**< Momentum on Y */
12777 unsigned int n; /**< Number of fingers */
12781 * @typedef Elm_Gesture_Momentum_Info
12782 * holds momentum info for user
12783 * @ingroup Elm_Gesture_Layer
12785 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12788 * @struct _Elm_Gesture_Line_Info
12789 * Struct holds line info for user
12790 * @ingroup Elm_Gesture_Layer
12792 struct _Elm_Gesture_Line_Info
12793 { /* Report line ends, timestamps, and momentum computed */
12794 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12795 double angle; /**< Angle (direction) of lines */
12799 * @typedef Elm_Gesture_Line_Info
12800 * Holds line info for user
12801 * @ingroup Elm_Gesture_Layer
12803 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12806 * @struct _Elm_Gesture_Zoom_Info
12807 * Struct holds zoom info for user
12808 * @ingroup Elm_Gesture_Layer
12810 struct _Elm_Gesture_Zoom_Info
12812 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12813 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12814 double zoom; /**< Zoom value: 1.0 means no zoom */
12815 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12819 * @typedef Elm_Gesture_Zoom_Info
12820 * Holds zoom info for user
12821 * @ingroup Elm_Gesture_Layer
12823 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12826 * @struct _Elm_Gesture_Rotate_Info
12827 * Struct holds rotation info for user
12828 * @ingroup Elm_Gesture_Layer
12830 struct _Elm_Gesture_Rotate_Info
12832 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12833 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12834 double base_angle; /**< Holds start-angle */
12835 double angle; /**< Rotation value: 0.0 means no rotation */
12836 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12840 * @typedef Elm_Gesture_Rotate_Info
12841 * Holds rotation info for user
12842 * @ingroup Elm_Gesture_Layer
12844 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12847 * @typedef Elm_Gesture_Event_Cb
12848 * User callback used to stream gesture info from gesture layer
12849 * @param data user data
12850 * @param event_info gesture report info
12851 * Returns a flag field to be applied on the causing event.
12852 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12853 * upon the event, in an irreversible way.
12855 * @ingroup Elm_Gesture_Layer
12857 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12860 * Use function to set callbacks to be notified about
12861 * change of state of gesture.
12862 * When a user registers a callback with this function
12863 * this means this gesture has to be tested.
12865 * When ALL callbacks for a gesture are set to NULL
12866 * it means user isn't interested in gesture-state
12867 * and it will not be tested.
12869 * @param obj Pointer to gesture-layer.
12870 * @param idx The gesture you would like to track its state.
12871 * @param cb callback function pointer.
12872 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12873 * @param data user info to be sent to callback (usually, Smart Data)
12875 * @ingroup Elm_Gesture_Layer
12877 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);
12880 * Call this function to get repeat-events settings.
12882 * @param obj Pointer to gesture-layer.
12884 * @return repeat events settings.
12885 * @see elm_gesture_layer_hold_events_set()
12886 * @ingroup Elm_Gesture_Layer
12888 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12891 * This function called in order to make gesture-layer repeat events.
12892 * Set this of you like to get the raw events only if gestures were not detected.
12893 * Clear this if you like gesture layer to fwd events as testing gestures.
12895 * @param obj Pointer to gesture-layer.
12896 * @param r Repeat: TRUE/FALSE
12898 * @ingroup Elm_Gesture_Layer
12900 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12903 * This function sets step-value for zoom action.
12904 * Set step to any positive value.
12905 * Cancel step setting by setting to 0.0
12907 * @param obj Pointer to gesture-layer.
12908 * @param s new zoom step value.
12910 * @ingroup Elm_Gesture_Layer
12912 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12915 * This function sets step-value for rotate action.
12916 * Set step to any positive value.
12917 * Cancel step setting by setting to 0.0
12919 * @param obj Pointer to gesture-layer.
12920 * @param s new roatate step value.
12922 * @ingroup Elm_Gesture_Layer
12924 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12927 * This function called to attach gesture-layer to an Evas_Object.
12928 * @param obj Pointer to gesture-layer.
12929 * @param t Pointer to underlying object (AKA Target)
12931 * @return TRUE, FALSE on success, failure.
12933 * @ingroup Elm_Gesture_Layer
12935 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12938 * Call this function to construct a new gesture-layer object.
12939 * This does not activate the gesture layer. You have to
12940 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12942 * @param parent the parent object.
12944 * @return Pointer to new gesture-layer object.
12946 * @ingroup Elm_Gesture_Layer
12948 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12951 * @defgroup Thumb Thumb
12953 * @image html img/widget/thumb/preview-00.png
12954 * @image latex img/widget/thumb/preview-00.eps
12956 * A thumb object is used for displaying the thumbnail of an image or video.
12957 * You must have compiled Elementary with Ethumb_Client support and the DBus
12958 * service must be present and auto-activated in order to have thumbnails to
12961 * Once the thumbnail object becomes visible, it will check if there is a
12962 * previously generated thumbnail image for the file set on it. If not, it
12963 * will start generating this thumbnail.
12965 * Different config settings will cause different thumbnails to be generated
12966 * even on the same file.
12968 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12969 * Ethumb documentation to change this path, and to see other configuration
12972 * Signals that you can add callbacks for are:
12974 * - "clicked" - This is called when a user has clicked the thumb without dragging
12976 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12977 * - "press" - This is called when a user has pressed down the thumb.
12978 * - "generate,start" - The thumbnail generation started.
12979 * - "generate,stop" - The generation process stopped.
12980 * - "generate,error" - The generation failed.
12981 * - "load,error" - The thumbnail image loading failed.
12983 * available styles:
12987 * An example of use of thumbnail:
12989 * - @ref thumb_example_01
12993 * @addtogroup Thumb
12998 * @enum _Elm_Thumb_Animation_Setting
12999 * @typedef Elm_Thumb_Animation_Setting
13001 * Used to set if a video thumbnail is animating or not.
13005 typedef enum _Elm_Thumb_Animation_Setting
13007 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13008 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13009 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13010 ELM_THUMB_ANIMATION_LAST
13011 } Elm_Thumb_Animation_Setting;
13014 * Add a new thumb object to the parent.
13016 * @param parent The parent object.
13017 * @return The new object or NULL if it cannot be created.
13019 * @see elm_thumb_file_set()
13020 * @see elm_thumb_ethumb_client_get()
13024 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13026 * Reload thumbnail if it was generated before.
13028 * @param obj The thumb object to reload
13030 * This is useful if the ethumb client configuration changed, like its
13031 * size, aspect or any other property one set in the handle returned
13032 * by elm_thumb_ethumb_client_get().
13034 * If the options didn't change, the thumbnail won't be generated again, but
13035 * the old one will still be used.
13037 * @see elm_thumb_file_set()
13041 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13043 * Set the file that will be used as thumbnail.
13045 * @param obj The thumb object.
13046 * @param file The path to file that will be used as thumb.
13047 * @param key The key used in case of an EET file.
13049 * The file can be an image or a video (in that case, acceptable extensions are:
13050 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13051 * function elm_thumb_animate().
13053 * @see elm_thumb_file_get()
13054 * @see elm_thumb_reload()
13055 * @see elm_thumb_animate()
13059 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13061 * Get the image or video path and key used to generate the thumbnail.
13063 * @param obj The thumb object.
13064 * @param file Pointer to filename.
13065 * @param key Pointer to key.
13067 * @see elm_thumb_file_set()
13068 * @see elm_thumb_path_get()
13072 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13074 * Get the path and key to the image or video generated by ethumb.
13076 * One just need to make sure that the thumbnail was generated before getting
13077 * its path; otherwise, the path will be NULL. One way to do that is by asking
13078 * for the path when/after the "generate,stop" smart callback is called.
13080 * @param obj The thumb object.
13081 * @param file Pointer to thumb path.
13082 * @param key Pointer to thumb key.
13084 * @see elm_thumb_file_get()
13088 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13090 * Set the animation state for the thumb object. If its content is an animated
13091 * video, you may start/stop the animation or tell it to play continuously and
13094 * @param obj The thumb object.
13095 * @param setting The animation setting.
13097 * @see elm_thumb_file_set()
13101 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13103 * Get the animation state for the thumb object.
13105 * @param obj The thumb object.
13106 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13109 * @see elm_thumb_animate_set()
13113 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13115 * Get the ethumb_client handle so custom configuration can be made.
13117 * @return Ethumb_Client instance or NULL.
13119 * This must be called before the objects are created to be sure no object is
13120 * visible and no generation started.
13122 * Example of usage:
13125 * #include <Elementary.h>
13126 * #ifndef ELM_LIB_QUICKLAUNCH
13128 * elm_main(int argc, char **argv)
13130 * Ethumb_Client *client;
13132 * elm_need_ethumb();
13136 * client = elm_thumb_ethumb_client_get();
13139 * ERR("could not get ethumb_client");
13142 * ethumb_client_size_set(client, 100, 100);
13143 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13146 * // Create elm_thumb objects here
13156 * @note There's only one client handle for Ethumb, so once a configuration
13157 * change is done to it, any other request for thumbnails (for any thumbnail
13158 * object) will use that configuration. Thus, this configuration is global.
13162 EAPI void *elm_thumb_ethumb_client_get(void);
13164 * Get the ethumb_client connection state.
13166 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13169 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13171 * Make the thumbnail 'editable'.
13173 * @param obj Thumb object.
13174 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13176 * This means the thumbnail is a valid drag target for drag and drop, and can be
13177 * cut or pasted too.
13179 * @see elm_thumb_editable_get()
13183 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13184 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13186 * Make the thumbnail 'editable'.
13188 * @param obj Thumb object.
13189 * @return Editability.
13191 * This means the thumbnail is a valid drag target for drag and drop, and can be
13192 * cut or pasted too.
13194 * @see elm_thumb_editable_set()
13198 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13205 * @defgroup Web Web
13207 * @image html img/widget/web/preview-00.png
13208 * @image latex img/widget/web/preview-00.eps
13210 * A web object is used for displaying web pages (HTML/CSS/JS)
13211 * using WebKit-EFL. You must have compiled Elementary with
13214 * Signals that you can add callbacks for are:
13215 * @li "download,request": A file download has been requested. Event info is
13216 * a pointer to a Elm_Web_Download
13217 * @li "editorclient,contents,changed": Editor client's contents changed
13218 * @li "editorclient,selection,changed": Editor client's selection changed
13219 * @li "frame,created": A new frame was created. Event info is an
13220 * Evas_Object which can be handled with WebKit's ewk_frame API
13221 * @li "icon,received": An icon was received by the main frame
13222 * @li "inputmethod,changed": Input method changed. Event info is an
13223 * Eina_Bool indicating whether it's enabled or not
13224 * @li "js,windowobject,clear": JS window object has been cleared
13225 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13226 * is a char *link[2], where the first string contains the URL the link
13227 * points to, and the second one the title of the link
13228 * @li "link,hover,out": Mouse cursor left the link
13229 * @li "load,document,finished": Loading of a document finished. Event info
13230 * is the frame that finished loading
13231 * @li "load,error": Load failed. Event info is a pointer to
13232 * Elm_Web_Frame_Load_Error
13233 * @li "load,finished": Load finished. Event info is NULL on success, on
13234 * error it's a pointer to Elm_Web_Frame_Load_Error
13235 * @li "load,newwindow,show": A new window was created and is ready to be
13237 * @li "load,progress": Overall load progress. Event info is a pointer to
13238 * a double containing a value between 0.0 and 1.0
13239 * @li "load,provisional": Started provisional load
13240 * @li "load,started": Loading of a document started
13241 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13242 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13243 * the menubar is visible, or EINA_FALSE in case it's not
13244 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13245 * an Eina_Bool indicating the visibility
13246 * @li "popup,created": A dropdown widget was activated, requesting its
13247 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13248 * @li "popup,willdelete": The web object is ready to destroy the popup
13249 * object created. Event info is a pointer to Elm_Web_Menu
13250 * @li "ready": Page is fully loaded
13251 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13252 * info is a pointer to Eina_Bool where the visibility state should be set
13253 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13254 * is an Eina_Bool with the visibility state set
13255 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13256 * a string with the new text
13257 * @li "statusbar,visible,get": Queries visibility of the status bar.
13258 * Event info is a pointer to Eina_Bool where the visibility state should be
13260 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13261 * an Eina_Bool with the visibility value
13262 * @li "title,changed": Title of the main frame changed. Event info is a
13263 * string with the new title
13264 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13265 * is a pointer to Eina_Bool where the visibility state should be set
13266 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13267 * info is an Eina_Bool with the visibility state
13268 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13269 * a string with the text to show
13270 * @li "uri,changed": URI of the main frame changed. Event info is a string
13272 * @li "view,resized": The web object internal's view changed sized
13273 * @li "windows,close,request": A JavaScript request to close the current
13274 * window was requested
13275 * @li "zoom,animated,end": Animated zoom finished
13277 * available styles:
13280 * An example of use of web:
13282 * - @ref web_example_01 TBD
13291 * Structure used to report load errors.
13293 * Load errors are reported as signal by elm_web. All the strings are
13294 * temporary references and should @b not be used after the signal
13295 * callback returns. If it's required, make copies with strdup() or
13296 * eina_stringshare_add() (they are not even guaranteed to be
13297 * stringshared, so must use eina_stringshare_add() and not
13298 * eina_stringshare_ref()).
13300 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13302 * Structure used to report load errors.
13304 * Load errors are reported as signal by elm_web. All the strings are
13305 * temporary references and should @b not be used after the signal
13306 * callback returns. If it's required, make copies with strdup() or
13307 * eina_stringshare_add() (they are not even guaranteed to be
13308 * stringshared, so must use eina_stringshare_add() and not
13309 * eina_stringshare_ref()).
13311 struct _Elm_Web_Frame_Load_Error
13313 int code; /**< Numeric error code */
13314 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13315 const char *domain; /**< Error domain name */
13316 const char *description; /**< Error description (already localized) */
13317 const char *failing_url; /**< The URL that failed to load */
13318 Evas_Object *frame; /**< Frame object that produced the error */
13322 * The possibles types that the items in a menu can be
13324 typedef enum _Elm_Web_Menu_Item_Type
13326 ELM_WEB_MENU_SEPARATOR,
13327 ELM_WEB_MENU_GROUP,
13328 ELM_WEB_MENU_OPTION
13329 } Elm_Web_Menu_Item_Type;
13332 * Structure describing the items in a menu
13334 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13336 * Structure describing the items in a menu
13338 struct _Elm_Web_Menu_Item
13340 const char *text; /**< The text for the item */
13341 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13345 * Structure describing the menu of a popup
13347 * This structure will be passed as the @c event_info for the "popup,create"
13348 * signal, which is emitted when a dropdown menu is opened. Users wanting
13349 * to handle these popups by themselves should listen to this signal and
13350 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13351 * property as @c EINA_FALSE means that the user will not handle the popup
13352 * and the default implementation will be used.
13354 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13355 * will be emitted to notify the user that it can destroy any objects and
13356 * free all data related to it.
13358 * @see elm_web_popup_selected_set()
13359 * @see elm_web_popup_destroy()
13361 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13363 * Structure describing the menu of a popup
13365 * This structure will be passed as the @c event_info for the "popup,create"
13366 * signal, which is emitted when a dropdown menu is opened. Users wanting
13367 * to handle these popups by themselves should listen to this signal and
13368 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13369 * property as @c EINA_FALSE means that the user will not handle the popup
13370 * and the default implementation will be used.
13372 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13373 * will be emitted to notify the user that it can destroy any objects and
13374 * free all data related to it.
13376 * @see elm_web_popup_selected_set()
13377 * @see elm_web_popup_destroy()
13379 struct _Elm_Web_Menu
13381 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13382 int x; /**< The X position of the popup, relative to the elm_web object */
13383 int y; /**< The Y position of the popup, relative to the elm_web object */
13384 int width; /**< Width of the popup menu */
13385 int height; /**< Height of the popup menu */
13387 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. */
13390 typedef struct _Elm_Web_Download Elm_Web_Download;
13391 struct _Elm_Web_Download
13397 * Types of zoom available.
13399 typedef enum _Elm_Web_Zoom_Mode
13401 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13402 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13403 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13404 ELM_WEB_ZOOM_MODE_LAST
13405 } Elm_Web_Zoom_Mode;
13407 * Opaque handler containing the features (such as statusbar, menubar, etc)
13408 * that are to be set on a newly requested window.
13410 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13412 * Callback type for the create_window hook.
13414 * The function parameters are:
13415 * @li @p data User data pointer set when setting the hook function
13416 * @li @p obj The elm_web object requesting the new window
13417 * @li @p js Set to @c EINA_TRUE if the request was originated from
13418 * JavaScript. @c EINA_FALSE otherwise.
13419 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13420 * the features requested for the new window.
13422 * The returned value of the function should be the @c elm_web widget where
13423 * the request will be loaded. That is, if a new window or tab is created,
13424 * the elm_web widget in it should be returned, and @b NOT the window
13426 * Returning @c NULL should cancel the request.
13428 * @see elm_web_window_create_hook_set()
13430 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13432 * Callback type for the JS alert hook.
13434 * The function parameters are:
13435 * @li @p data User data pointer set when setting the hook function
13436 * @li @p obj The elm_web object requesting the new window
13437 * @li @p message The message to show in the alert dialog
13439 * The function should return the object representing the alert dialog.
13440 * Elm_Web will run a second main loop to handle the dialog and normal
13441 * flow of the application will be restored when the object is deleted, so
13442 * the user should handle the popup properly in order to delete the object
13443 * when the action is finished.
13444 * If the function returns @c NULL the popup will be ignored.
13446 * @see elm_web_dialog_alert_hook_set()
13448 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13450 * Callback type for the JS confirm hook.
13452 * The function parameters are:
13453 * @li @p data User data pointer set when setting the hook function
13454 * @li @p obj The elm_web object requesting the new window
13455 * @li @p message The message to show in the confirm dialog
13456 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13457 * the user selected @c Ok, @c EINA_FALSE otherwise.
13459 * The function should return the object representing the confirm dialog.
13460 * Elm_Web will run a second main loop to handle the dialog and normal
13461 * flow of the application will be restored when the object is deleted, so
13462 * the user should handle the popup properly in order to delete the object
13463 * when the action is finished.
13464 * If the function returns @c NULL the popup will be ignored.
13466 * @see elm_web_dialog_confirm_hook_set()
13468 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13470 * Callback type for the JS prompt hook.
13472 * The function parameters are:
13473 * @li @p data User data pointer set when setting the hook function
13474 * @li @p obj The elm_web object requesting the new window
13475 * @li @p message The message to show in the prompt dialog
13476 * @li @p def_value The default value to present the user in the entry
13477 * @li @p value Pointer where to store the value given by the user. Must
13478 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13479 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13480 * the user selected @c Ok, @c EINA_FALSE otherwise.
13482 * The function should return the object representing the prompt dialog.
13483 * Elm_Web will run a second main loop to handle the dialog and normal
13484 * flow of the application will be restored when the object is deleted, so
13485 * the user should handle the popup properly in order to delete the object
13486 * when the action is finished.
13487 * If the function returns @c NULL the popup will be ignored.
13489 * @see elm_web_dialog_prompt_hook_set()
13491 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13493 * Callback type for the JS file selector hook.
13495 * The function parameters are:
13496 * @li @p data User data pointer set when setting the hook function
13497 * @li @p obj The elm_web object requesting the new window
13498 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13499 * @li @p accept_types Mime types accepted
13500 * @li @p selected Pointer where to store the list of malloc'ed strings
13501 * containing the path to each file selected. Must be @c NULL if the file
13502 * dialog is cancelled
13503 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13504 * the user selected @c Ok, @c EINA_FALSE otherwise.
13506 * The function should return the object representing the file selector
13508 * Elm_Web will run a second main loop to handle the dialog and normal
13509 * flow of the application will be restored when the object is deleted, so
13510 * the user should handle the popup properly in order to delete the object
13511 * when the action is finished.
13512 * If the function returns @c NULL the popup will be ignored.
13514 * @see elm_web_dialog_file selector_hook_set()
13516 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);
13518 * Callback type for the JS console message hook.
13520 * When a console message is added from JavaScript, any set function to the
13521 * console message hook will be called for the user to handle. There is no
13522 * default implementation of this hook.
13524 * The function parameters are:
13525 * @li @p data User data pointer set when setting the hook function
13526 * @li @p obj The elm_web object that originated the message
13527 * @li @p message The message sent
13528 * @li @p line_number The line number
13529 * @li @p source_id Source id
13531 * @see elm_web_console_message_hook_set()
13533 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13535 * Add a new web object to the parent.
13537 * @param parent The parent object.
13538 * @return The new object or NULL if it cannot be created.
13540 * @see elm_web_uri_set()
13541 * @see elm_web_webkit_view_get()
13543 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13546 * Get internal ewk_view object from web object.
13548 * Elementary may not provide some low level features of EWebKit,
13549 * instead of cluttering the API with proxy methods we opted to
13550 * return the internal reference. Be careful using it as it may
13551 * interfere with elm_web behavior.
13553 * @param obj The web object.
13554 * @return The internal ewk_view object or NULL if it does not
13555 * exist. (Failure to create or Elementary compiled without
13558 * @see elm_web_add()
13560 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13563 * Sets the function to call when a new window is requested
13565 * This hook will be called when a request to create a new window is
13566 * issued from the web page loaded.
13567 * There is no default implementation for this feature, so leaving this
13568 * unset or passing @c NULL in @p func will prevent new windows from
13571 * @param obj The web object where to set the hook function
13572 * @param func The hook function to be called when a window is requested
13573 * @param data User data
13575 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13577 * Sets the function to call when an alert dialog
13579 * This hook will be called when a JavaScript alert dialog is requested.
13580 * If no function is set or @c NULL is passed in @p func, the default
13581 * implementation will take place.
13583 * @param obj The web object where to set the hook function
13584 * @param func The callback function to be used
13585 * @param data User data
13587 * @see elm_web_inwin_mode_set()
13589 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13591 * Sets the function to call when an confirm dialog
13593 * This hook will be called when a JavaScript confirm dialog is requested.
13594 * If no function is set or @c NULL is passed in @p func, the default
13595 * implementation will take place.
13597 * @param obj The web object where to set the hook function
13598 * @param func The callback function to be used
13599 * @param data User data
13601 * @see elm_web_inwin_mode_set()
13603 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13605 * Sets the function to call when an prompt dialog
13607 * This hook will be called when a JavaScript prompt dialog is requested.
13608 * If no function is set or @c NULL is passed in @p func, the default
13609 * implementation will take place.
13611 * @param obj The web object where to set the hook function
13612 * @param func The callback function to be used
13613 * @param data User data
13615 * @see elm_web_inwin_mode_set()
13617 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13619 * Sets the function to call when an file selector dialog
13621 * This hook will be called when a JavaScript file selector dialog is
13623 * If no function is set or @c NULL is passed in @p func, the default
13624 * implementation will take place.
13626 * @param obj The web object where to set the hook function
13627 * @param func The callback function to be used
13628 * @param data User data
13630 * @see elm_web_inwin_mode_set()
13632 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13634 * Sets the function to call when a console message is emitted from JS
13636 * This hook will be called when a console message is emitted from
13637 * JavaScript. There is no default implementation for this feature.
13639 * @param obj The web object where to set the hook function
13640 * @param func The callback function to be used
13641 * @param data User data
13643 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13645 * Gets the status of the tab propagation
13647 * @param obj The web object to query
13648 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13650 * @see elm_web_tab_propagate_set()
13652 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13654 * Sets whether to use tab propagation
13656 * If tab propagation is enabled, whenever the user presses the Tab key,
13657 * Elementary will handle it and switch focus to the next widget.
13658 * The default value is disabled, where WebKit will handle the Tab key to
13659 * cycle focus though its internal objects, jumping to the next widget
13660 * only when that cycle ends.
13662 * @param obj The web object
13663 * @param propagate Whether to propagate Tab keys to Elementary or not
13665 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13667 * Sets the URI for the web object
13669 * It must be a full URI, with resource included, in the form
13670 * http://www.enlightenment.org or file:///tmp/something.html
13672 * @param obj The web object
13673 * @param uri The URI to set
13674 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13676 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13678 * Gets the current URI for the object
13680 * The returned string must not be freed and is guaranteed to be
13683 * @param obj The web object
13684 * @return A stringshared internal string with the current URI, or NULL on
13687 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13689 * Gets the current title
13691 * The returned string must not be freed and is guaranteed to be
13694 * @param obj The web object
13695 * @return A stringshared internal string with the current title, or NULL on
13698 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13700 * Sets the background color to be used by the web object
13702 * This is the color that will be used by default when the loaded page
13703 * does not set it's own. Color values are pre-multiplied.
13705 * @param obj The web object
13706 * @param r Red component
13707 * @param g Green component
13708 * @param b Blue component
13709 * @param a Alpha component
13711 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13713 * Gets the background color to be used by the web object
13715 * This is the color that will be used by default when the loaded page
13716 * does not set it's own. Color values are pre-multiplied.
13718 * @param obj The web object
13719 * @param r Red component
13720 * @param g Green component
13721 * @param b Blue component
13722 * @param a Alpha component
13724 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13726 * Gets a copy of the currently selected text
13728 * The string returned must be freed by the user when it's done with it.
13730 * @param obj The web object
13731 * @return A newly allocated string, or NULL if nothing is selected or an
13734 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13736 * Tells the web object which index in the currently open popup was selected
13738 * When the user handles the popup creation from the "popup,created" signal,
13739 * it needs to tell the web object which item was selected by calling this
13740 * function with the index corresponding to the item.
13742 * @param obj The web object
13743 * @param index The index selected
13745 * @see elm_web_popup_destroy()
13747 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13749 * Dismisses an open dropdown popup
13751 * When the popup from a dropdown widget is to be dismissed, either after
13752 * selecting an option or to cancel it, this function must be called, which
13753 * will later emit an "popup,willdelete" signal to notify the user that
13754 * any memory and objects related to this popup can be freed.
13756 * @param obj The web object
13757 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13758 * if there was no menu to destroy
13760 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13762 * Searches the given string in a document.
13764 * @param obj The web object where to search the text
13765 * @param string String to search
13766 * @param case_sensitive If search should be case sensitive or not
13767 * @param forward If search is from cursor and on or backwards
13768 * @param wrap If search should wrap at the end
13770 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13773 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13775 * Marks matches of the given string in a document.
13777 * @param obj The web object where to search text
13778 * @param string String to match
13779 * @param case_sensitive If match should be case sensitive or not
13780 * @param highlight If matches should be highlighted
13781 * @param limit Maximum amount of matches, or zero to unlimited
13783 * @return number of matched @a string
13785 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13787 * Clears all marked matches in the document
13789 * @param obj The web object
13791 * @return EINA_TRUE on success, EINA_FALSE otherwise
13793 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13795 * Sets whether to highlight the matched marks
13797 * If enabled, marks set with elm_web_text_matches_mark() will be
13800 * @param obj The web object
13801 * @param highlight Whether to highlight the marks or not
13803 * @return EINA_TRUE on success, EINA_FALSE otherwise
13805 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13807 * Gets whether highlighting marks is enabled
13809 * @param The web object
13811 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13814 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13816 * Gets the overall loading progress of the page
13818 * Returns the estimated loading progress of the page, with a value between
13819 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13820 * included in the page.
13822 * @param The web object
13824 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13827 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13829 * Stops loading the current page
13831 * Cancels the loading of the current page in the web object. This will
13832 * cause a "load,error" signal to be emitted, with the is_cancellation
13833 * flag set to EINA_TRUE.
13835 * @param obj The web object
13837 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13839 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13841 * Requests a reload of the current document in the object
13843 * @param obj The web object
13845 * @return EINA_TRUE on success, EINA_FALSE otherwise
13847 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13849 * Requests a reload of the current document, avoiding any existing caches
13851 * @param obj The web object
13853 * @return EINA_TRUE on success, EINA_FALSE otherwise
13855 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13857 * Goes back one step in the browsing history
13859 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13861 * @param obj The web object
13863 * @return EINA_TRUE on success, EINA_FALSE otherwise
13865 * @see elm_web_history_enable_set()
13866 * @see elm_web_back_possible()
13867 * @see elm_web_forward()
13868 * @see elm_web_navigate()
13870 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13872 * Goes forward one step in the browsing history
13874 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13876 * @param obj The web object
13878 * @return EINA_TRUE on success, EINA_FALSE otherwise
13880 * @see elm_web_history_enable_set()
13881 * @see elm_web_forward_possible()
13882 * @see elm_web_back()
13883 * @see elm_web_navigate()
13885 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13887 * Jumps the given number of steps in the browsing history
13889 * The @p steps value can be a negative integer to back in history, or a
13890 * positive to move forward.
13892 * @param obj The web object
13893 * @param steps The number of steps to jump
13895 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13896 * history exists to jump the given number of steps
13898 * @see elm_web_history_enable_set()
13899 * @see elm_web_navigate_possible()
13900 * @see elm_web_back()
13901 * @see elm_web_forward()
13903 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13905 * Queries whether it's possible to go back in history
13907 * @param obj The web object
13909 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13912 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13914 * Queries whether it's possible to go forward in history
13916 * @param obj The web object
13918 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13921 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13923 * Queries whether it's possible to jump the given number of steps
13925 * The @p steps value can be a negative integer to back in history, or a
13926 * positive to move forward.
13928 * @param obj The web object
13929 * @param steps The number of steps to check for
13931 * @return EINA_TRUE if enough history exists to perform the given jump,
13932 * EINA_FALSE otherwise
13934 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13936 * Gets whether browsing history is enabled for the given object
13938 * @param obj The web object
13940 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13942 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13944 * Enables or disables the browsing history
13946 * @param obj The web object
13947 * @param enable Whether to enable or disable the browsing history
13949 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13951 * Sets the zoom level of the web object
13953 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13954 * values meaning zoom in and lower meaning zoom out. This function will
13955 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13956 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13958 * @param obj The web object
13959 * @param zoom The zoom level to set
13961 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13963 * Gets the current zoom level set on the web object
13965 * Note that this is the zoom level set on the web object and not that
13966 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13967 * the two zoom levels should match, but for the other two modes the
13968 * Webkit zoom is calculated internally to match the chosen mode without
13969 * changing the zoom level set for the web object.
13971 * @param obj The web object
13973 * @return The zoom level set on the object
13975 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13977 * Sets the zoom mode to use
13979 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13980 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13982 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13983 * with the elm_web_zoom_set() function.
13984 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13985 * make sure the entirety of the web object's contents are shown.
13986 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13987 * fit the contents in the web object's size, without leaving any space
13990 * @param obj The web object
13991 * @param mode The mode to set
13993 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13995 * Gets the currently set zoom mode
13997 * @param obj The web object
13999 * @return The current zoom mode set for the object, or
14000 * ::ELM_WEB_ZOOM_MODE_LAST on error
14002 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14004 * Shows the given region in the web object
14006 * @param obj The web object
14007 * @param x The x coordinate of the region to show
14008 * @param y The y coordinate of the region to show
14009 * @param w The width of the region to show
14010 * @param h The height of the region to show
14012 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14014 * Brings in the region to the visible area
14016 * Like elm_web_region_show(), but it animates the scrolling of the object
14019 * @param obj The web object
14020 * @param x The x coordinate of the region to show
14021 * @param y The y coordinate of the region to show
14022 * @param w The width of the region to show
14023 * @param h The height of the region to show
14025 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14027 * Sets the default dialogs to use an Inwin instead of a normal window
14029 * If set, then the default implementation for the JavaScript dialogs and
14030 * file selector will be opened in an Inwin. Otherwise they will use a
14031 * normal separated window.
14033 * @param obj The web object
14034 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14036 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14038 * Gets whether Inwin mode is set for the current object
14040 * @param obj The web object
14042 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14044 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14046 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14047 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14048 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);
14049 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14056 * @defgroup Hoversel Hoversel
14058 * @image html img/widget/hoversel/preview-00.png
14059 * @image latex img/widget/hoversel/preview-00.eps
14061 * A hoversel is a button that pops up a list of items (automatically
14062 * choosing the direction to display) that have a label and, optionally, an
14063 * icon to select from. It is a convenience widget to avoid the need to do
14064 * all the piecing together yourself. It is intended for a small number of
14065 * items in the hoversel menu (no more than 8), though is capable of many
14068 * Signals that you can add callbacks for are:
14069 * "clicked" - the user clicked the hoversel button and popped up the sel
14070 * "selected" - an item in the hoversel list is selected. event_info is the item
14071 * "dismissed" - the hover is dismissed
14073 * See @ref tutorial_hoversel for an example.
14076 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14078 * @brief Add a new Hoversel object
14080 * @param parent The parent object
14081 * @return The new object or NULL if it cannot be created
14083 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14085 * @brief This sets the hoversel to expand horizontally.
14087 * @param obj The hoversel object
14088 * @param horizontal If true, the hover will expand horizontally to the
14091 * @note The initial button will display horizontally regardless of this
14094 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14096 * @brief This returns whether the hoversel is set to expand horizontally.
14098 * @param obj The hoversel object
14099 * @return If true, the hover will expand horizontally to the right.
14101 * @see elm_hoversel_horizontal_set()
14103 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14105 * @brief Set the Hover parent
14107 * @param obj The hoversel object
14108 * @param parent The parent to use
14110 * Sets the hover parent object, the area that will be darkened when the
14111 * hoversel is clicked. Should probably be the window that the hoversel is
14112 * in. See @ref Hover objects for more information.
14114 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14116 * @brief Get the Hover parent
14118 * @param obj The hoversel object
14119 * @return The used parent
14121 * Gets the hover parent object.
14123 * @see elm_hoversel_hover_parent_set()
14125 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14127 * @brief Set the hoversel button label
14129 * @param obj The hoversel object
14130 * @param label The label text.
14132 * This sets the label of the button that is always visible (before it is
14133 * clicked and expanded).
14135 * @deprecated elm_object_text_set()
14137 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14139 * @brief Get the hoversel button label
14141 * @param obj The hoversel object
14142 * @return The label text.
14144 * @deprecated elm_object_text_get()
14146 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14148 * @brief Set the icon of the hoversel button
14150 * @param obj The hoversel object
14151 * @param icon The icon object
14153 * Sets the icon of the button that is always visible (before it is clicked
14154 * and expanded). Once the icon object is set, a previously set one will be
14155 * deleted, if you want to keep that old content object, use the
14156 * elm_hoversel_icon_unset() function.
14158 * @see elm_object_content_set() for the button widget
14160 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14162 * @brief Get the icon of the hoversel button
14164 * @param obj The hoversel object
14165 * @return The icon object
14167 * Get the icon of the button that is always visible (before it is clicked
14168 * and expanded). Also see elm_object_content_get() for the button widget.
14170 * @see elm_hoversel_icon_set()
14172 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14174 * @brief Get and unparent the icon of the hoversel button
14176 * @param obj The hoversel object
14177 * @return The icon object that was being used
14179 * Unparent and return the icon of the button that is always visible
14180 * (before it is clicked and expanded).
14182 * @see elm_hoversel_icon_set()
14183 * @see elm_object_content_unset() for the button widget
14185 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14187 * @brief This triggers the hoversel popup from code, the same as if the user
14188 * had clicked the button.
14190 * @param obj The hoversel object
14192 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14194 * @brief This dismisses the hoversel popup as if the user had clicked
14195 * outside the hover.
14197 * @param obj The hoversel object
14199 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14201 * @brief Returns whether the hoversel is expanded.
14203 * @param obj The hoversel object
14204 * @return This will return EINA_TRUE if the hoversel is expanded or
14205 * EINA_FALSE if it is not expanded.
14207 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14209 * @brief This will remove all the children items from the hoversel.
14211 * @param obj The hoversel object
14213 * @warning Should @b not be called while the hoversel is active; use
14214 * elm_hoversel_expanded_get() to check first.
14216 * @see elm_hoversel_item_del_cb_set()
14217 * @see elm_hoversel_item_del()
14219 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14221 * @brief Get the list of items within the given hoversel.
14223 * @param obj The hoversel object
14224 * @return Returns a list of Elm_Hoversel_Item*
14226 * @see elm_hoversel_item_add()
14228 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14230 * @brief Add an item to the hoversel button
14232 * @param obj The hoversel object
14233 * @param label The text label to use for the item (NULL if not desired)
14234 * @param icon_file An image file path on disk to use for the icon or standard
14235 * icon name (NULL if not desired)
14236 * @param icon_type The icon type if relevant
14237 * @param func Convenience function to call when this item is selected
14238 * @param data Data to pass to item-related functions
14239 * @return A handle to the item added.
14241 * This adds an item to the hoversel to show when it is clicked. Note: if you
14242 * need to use an icon from an edje file then use
14243 * elm_hoversel_item_icon_set() right after the this function, and set
14244 * icon_file to NULL here.
14246 * For more information on what @p icon_file and @p icon_type are see the
14247 * @ref Icon "icon documentation".
14249 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);
14251 * @brief Delete an item from the hoversel
14253 * @param item The item to delete
14255 * This deletes the item from the hoversel (should not be called while the
14256 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14258 * @see elm_hoversel_item_add()
14259 * @see elm_hoversel_item_del_cb_set()
14261 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14263 * @brief Set the function to be called when an item from the hoversel is
14266 * @param item The item to set the callback on
14267 * @param func The function called
14269 * That function will receive these parameters:
14270 * @li void *item_data
14271 * @li Evas_Object *the_item_object
14272 * @li Elm_Hoversel_Item *the_object_struct
14274 * @see elm_hoversel_item_add()
14276 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14278 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14279 * that will be passed to associated function callbacks.
14281 * @param item The item to get the data from
14282 * @return The data pointer set with elm_hoversel_item_add()
14284 * @see elm_hoversel_item_add()
14286 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14288 * @brief This returns the label text of the given hoversel item.
14290 * @param item The item to get the label
14291 * @return The label text of the hoversel item
14293 * @see elm_hoversel_item_add()
14295 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14297 * @brief This sets the icon for the given hoversel item.
14299 * @param item The item to set the icon
14300 * @param icon_file An image file path on disk to use for the icon or standard
14302 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14303 * to NULL if the icon is not an edje file
14304 * @param icon_type The icon type
14306 * The icon can be loaded from the standard set, from an image file, or from
14309 * @see elm_hoversel_item_add()
14311 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);
14313 * @brief Get the icon object of the hoversel item
14315 * @param item The item to get the icon from
14316 * @param icon_file The image file path on disk used for the icon or standard
14318 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14319 * if the icon is not an edje file
14320 * @param icon_type The icon type
14322 * @see elm_hoversel_item_icon_set()
14323 * @see elm_hoversel_item_add()
14325 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);
14331 * @defgroup Toolbar Toolbar
14332 * @ingroup Elementary
14334 * @image html img/widget/toolbar/preview-00.png
14335 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14337 * @image html img/toolbar.png
14338 * @image latex img/toolbar.eps width=\textwidth
14340 * A toolbar is a widget that displays a list of items inside
14341 * a box. It can be scrollable, show a menu with items that don't fit
14342 * to toolbar size or even crop them.
14344 * Only one item can be selected at a time.
14346 * Items can have multiple states, or show menus when selected by the user.
14348 * Smart callbacks one can listen to:
14349 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14350 * - "language,changed" - when the program language changes
14352 * Available styles for it:
14354 * - @c "transparent" - no background or shadow, just show the content
14356 * List of examples:
14357 * @li @ref toolbar_example_01
14358 * @li @ref toolbar_example_02
14359 * @li @ref toolbar_example_03
14363 * @addtogroup Toolbar
14368 * @enum _Elm_Toolbar_Shrink_Mode
14369 * @typedef Elm_Toolbar_Shrink_Mode
14371 * Set toolbar's items display behavior, it can be scrollabel,
14372 * show a menu with exceeding items, or simply hide them.
14374 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14377 * Values <b> don't </b> work as bitmask, only one can be choosen.
14379 * @see elm_toolbar_mode_shrink_set()
14380 * @see elm_toolbar_mode_shrink_get()
14384 typedef enum _Elm_Toolbar_Shrink_Mode
14386 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14387 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14388 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14389 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14390 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14391 } Elm_Toolbar_Shrink_Mode;
14393 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(). */
14395 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(). */
14398 * Add a new toolbar widget to the given parent Elementary
14399 * (container) object.
14401 * @param parent The parent object.
14402 * @return a new toolbar widget handle or @c NULL, on errors.
14404 * This function inserts a new toolbar widget on the canvas.
14408 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14411 * Set the icon size, in pixels, to be used by toolbar items.
14413 * @param obj The toolbar object
14414 * @param icon_size The icon size in pixels
14416 * @note Default value is @c 32. It reads value from elm config.
14418 * @see elm_toolbar_icon_size_get()
14422 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14425 * Get the icon size, in pixels, to be used by toolbar items.
14427 * @param obj The toolbar object.
14428 * @return The icon size in pixels.
14430 * @see elm_toolbar_icon_size_set() for details.
14434 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14437 * Sets icon lookup order, for toolbar items' icons.
14439 * @param obj The toolbar object.
14440 * @param order The icon lookup order.
14442 * Icons added before calling this function will not be affected.
14443 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14445 * @see elm_toolbar_icon_order_lookup_get()
14449 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14452 * Gets the icon lookup order.
14454 * @param obj The toolbar object.
14455 * @return The icon lookup order.
14457 * @see elm_toolbar_icon_order_lookup_set() for details.
14461 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14464 * Set whether the toolbar should always have an item selected.
14466 * @param obj The toolbar object.
14467 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14470 * This will cause the toolbar to always have an item selected, and clicking
14471 * the selected item will not cause a selected event to be emitted. Enabling this mode
14472 * will immediately select the first toolbar item.
14474 * Always-selected is disabled by default.
14476 * @see elm_toolbar_always_select_mode_get().
14480 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14483 * Get whether the toolbar should always have an item selected.
14485 * @param obj The toolbar object.
14486 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14487 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14489 * @see elm_toolbar_always_select_mode_set() for details.
14493 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14496 * Set whether the toolbar items' should be selected by the user or not.
14498 * @param obj The toolbar object.
14499 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14502 * This will turn off the ability to select items entirely and they will
14503 * neither appear selected nor emit selected signals. The clicked
14504 * callback function will still be called.
14506 * Selection is enabled by default.
14508 * @see elm_toolbar_no_select_mode_get().
14512 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14515 * Set whether the toolbar items' should be selected by the user or not.
14517 * @param obj The toolbar object.
14518 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14519 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14521 * @see elm_toolbar_no_select_mode_set() for details.
14525 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14528 * Append item to the toolbar.
14530 * @param obj The toolbar object.
14531 * @param icon A string with icon name or the absolute path of an image file.
14532 * @param label The label of the item.
14533 * @param func The function to call when the item is clicked.
14534 * @param data The data to associate with the item for related callbacks.
14535 * @return The created item or @c NULL upon failure.
14537 * A new item will be created and appended to the toolbar, i.e., will
14538 * be set as @b last item.
14540 * Items created with this method can be deleted with
14541 * elm_toolbar_item_del().
14543 * Associated @p data can be properly freed when item is deleted if a
14544 * callback function is set with elm_toolbar_item_del_cb_set().
14546 * If a function is passed as argument, it will be called everytime this item
14547 * is selected, i.e., the user clicks over an unselected item.
14548 * If such function isn't needed, just passing
14549 * @c NULL as @p func is enough. The same should be done for @p data.
14551 * Toolbar will load icon image from fdo or current theme.
14552 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14553 * If an absolute path is provided it will load it direct from a file.
14555 * @see elm_toolbar_item_icon_set()
14556 * @see elm_toolbar_item_del()
14557 * @see elm_toolbar_item_del_cb_set()
14561 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);
14564 * Prepend item to the toolbar.
14566 * @param obj The toolbar object.
14567 * @param icon A string with icon name or the absolute path of an image file.
14568 * @param label The label of the item.
14569 * @param func The function to call when the item is clicked.
14570 * @param data The data to associate with the item for related callbacks.
14571 * @return The created item or @c NULL upon failure.
14573 * A new item will be created and prepended to the toolbar, i.e., will
14574 * be set as @b first item.
14576 * Items created with this method can be deleted with
14577 * elm_toolbar_item_del().
14579 * Associated @p data can be properly freed when item is deleted if a
14580 * callback function is set with elm_toolbar_item_del_cb_set().
14582 * If a function is passed as argument, it will be called everytime this item
14583 * is selected, i.e., the user clicks over an unselected item.
14584 * If such function isn't needed, just passing
14585 * @c NULL as @p func is enough. The same should be done for @p data.
14587 * Toolbar will load icon image from fdo or current theme.
14588 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14589 * If an absolute path is provided it will load it direct from a file.
14591 * @see elm_toolbar_item_icon_set()
14592 * @see elm_toolbar_item_del()
14593 * @see elm_toolbar_item_del_cb_set()
14597 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);
14600 * Insert a new item into the toolbar object before item @p before.
14602 * @param obj The toolbar object.
14603 * @param before The toolbar item to insert before.
14604 * @param icon A string with icon name or the absolute path of an image file.
14605 * @param label The label of the item.
14606 * @param func The function to call when the item is clicked.
14607 * @param data The data to associate with the item for related callbacks.
14608 * @return The created item or @c NULL upon failure.
14610 * A new item will be created and added to the toolbar. Its position in
14611 * this toolbar will be just before item @p before.
14613 * Items created with this method can be deleted with
14614 * elm_toolbar_item_del().
14616 * Associated @p data can be properly freed when item is deleted if a
14617 * callback function is set with elm_toolbar_item_del_cb_set().
14619 * If a function is passed as argument, it will be called everytime this item
14620 * is selected, i.e., the user clicks over an unselected item.
14621 * If such function isn't needed, just passing
14622 * @c NULL as @p func is enough. The same should be done for @p data.
14624 * Toolbar will load icon image from fdo or current theme.
14625 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14626 * If an absolute path is provided it will load it direct from a file.
14628 * @see elm_toolbar_item_icon_set()
14629 * @see elm_toolbar_item_del()
14630 * @see elm_toolbar_item_del_cb_set()
14634 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);
14637 * Insert a new item into the toolbar object after item @p after.
14639 * @param obj The toolbar object.
14640 * @param after The toolbar item to insert after.
14641 * @param icon A string with icon name or the absolute path of an image file.
14642 * @param label The label of the item.
14643 * @param func The function to call when the item is clicked.
14644 * @param data The data to associate with the item for related callbacks.
14645 * @return The created item or @c NULL upon failure.
14647 * A new item will be created and added to the toolbar. Its position in
14648 * this toolbar will be just after item @p after.
14650 * Items created with this method can be deleted with
14651 * elm_toolbar_item_del().
14653 * Associated @p data can be properly freed when item is deleted if a
14654 * callback function is set with elm_toolbar_item_del_cb_set().
14656 * If a function is passed as argument, it will be called everytime this item
14657 * is selected, i.e., the user clicks over an unselected item.
14658 * If such function isn't needed, just passing
14659 * @c NULL as @p func is enough. The same should be done for @p data.
14661 * Toolbar will load icon image from fdo or current theme.
14662 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14663 * If an absolute path is provided it will load it direct from a file.
14665 * @see elm_toolbar_item_icon_set()
14666 * @see elm_toolbar_item_del()
14667 * @see elm_toolbar_item_del_cb_set()
14671 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);
14674 * Get the first item in the given toolbar widget's list of
14677 * @param obj The toolbar object
14678 * @return The first item or @c NULL, if it has no items (and on
14681 * @see elm_toolbar_item_append()
14682 * @see elm_toolbar_last_item_get()
14686 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14689 * Get the last item in the given toolbar widget's list of
14692 * @param obj The toolbar object
14693 * @return The last item or @c NULL, if it has no items (and on
14696 * @see elm_toolbar_item_prepend()
14697 * @see elm_toolbar_first_item_get()
14701 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14704 * Get the item after @p item in toolbar.
14706 * @param item The toolbar item.
14707 * @return The item after @p item, or @c NULL if none or on failure.
14709 * @note If it is the last item, @c NULL will be returned.
14711 * @see elm_toolbar_item_append()
14715 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14718 * Get the item before @p item in toolbar.
14720 * @param item The toolbar item.
14721 * @return The item before @p item, or @c NULL if none or on failure.
14723 * @note If it is the first item, @c NULL will be returned.
14725 * @see elm_toolbar_item_prepend()
14729 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14732 * Get the toolbar object from an item.
14734 * @param item The item.
14735 * @return The toolbar object.
14737 * This returns the toolbar object itself that an item belongs to.
14741 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14744 * Set the priority of a toolbar item.
14746 * @param item The toolbar item.
14747 * @param priority The item priority. The default is zero.
14749 * This is used only when the toolbar shrink mode is set to
14750 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14751 * When space is less than required, items with low priority
14752 * will be removed from the toolbar and added to a dynamically-created menu,
14753 * while items with higher priority will remain on the toolbar,
14754 * with the same order they were added.
14756 * @see elm_toolbar_item_priority_get()
14760 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14763 * Get the priority of a toolbar item.
14765 * @param item The toolbar item.
14766 * @return The @p item priority, or @c 0 on failure.
14768 * @see elm_toolbar_item_priority_set() for details.
14772 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14775 * Get the label of item.
14777 * @param item The item of toolbar.
14778 * @return The label of item.
14780 * The return value is a pointer to the label associated to @p item when
14781 * it was created, with function elm_toolbar_item_append() or similar,
14783 * with function elm_toolbar_item_label_set. If no label
14784 * was passed as argument, it will return @c NULL.
14786 * @see elm_toolbar_item_label_set() for more details.
14787 * @see elm_toolbar_item_append()
14791 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14794 * Set the label of item.
14796 * @param item The item of toolbar.
14797 * @param text The label of item.
14799 * The label to be displayed by the item.
14800 * Label will be placed at icons bottom (if set).
14802 * If a label was passed as argument on item creation, with function
14803 * elm_toolbar_item_append() or similar, it will be already
14804 * displayed by the item.
14806 * @see elm_toolbar_item_label_get()
14807 * @see elm_toolbar_item_append()
14811 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14814 * Return the data associated with a given toolbar widget item.
14816 * @param item The toolbar widget item handle.
14817 * @return The data associated with @p item.
14819 * @see elm_toolbar_item_data_set()
14823 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14826 * Set the data associated with a given toolbar widget item.
14828 * @param item The toolbar widget item handle.
14829 * @param data The new data pointer to set to @p item.
14831 * This sets new item data on @p item.
14833 * @warning The old data pointer won't be touched by this function, so
14834 * the user had better to free that old data himself/herself.
14838 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14841 * Returns a pointer to a toolbar item by its label.
14843 * @param obj The toolbar object.
14844 * @param label The label of the item to find.
14846 * @return The pointer to the toolbar item matching @p label or @c NULL
14851 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14854 * Get whether the @p item is selected or not.
14856 * @param item The toolbar item.
14857 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14858 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14860 * @see elm_toolbar_selected_item_set() for details.
14861 * @see elm_toolbar_item_selected_get()
14865 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14868 * Set the selected state of an item.
14870 * @param item The toolbar item
14871 * @param selected The selected state
14873 * This sets the selected state of the given item @p it.
14874 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14876 * If a new item is selected the previosly selected will be unselected.
14877 * Previoulsy selected item can be get with function
14878 * elm_toolbar_selected_item_get().
14880 * Selected items will be highlighted.
14882 * @see elm_toolbar_item_selected_get()
14883 * @see elm_toolbar_selected_item_get()
14887 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14890 * Get the selected item.
14892 * @param obj The toolbar object.
14893 * @return The selected toolbar item.
14895 * The selected item can be unselected with function
14896 * elm_toolbar_item_selected_set().
14898 * The selected item always will be highlighted on toolbar.
14900 * @see elm_toolbar_selected_items_get()
14904 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14907 * Set the icon associated with @p item.
14909 * @param obj The parent of this item.
14910 * @param item The toolbar item.
14911 * @param icon A string with icon name or the absolute path of an image file.
14913 * Toolbar will load icon image from fdo or current theme.
14914 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14915 * If an absolute path is provided it will load it direct from a file.
14917 * @see elm_toolbar_icon_order_lookup_set()
14918 * @see elm_toolbar_icon_order_lookup_get()
14922 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14925 * Get the string used to set the icon of @p item.
14927 * @param item The toolbar item.
14928 * @return The string associated with the icon object.
14930 * @see elm_toolbar_item_icon_set() for details.
14934 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14937 * Get the object of @p item.
14939 * @param item The toolbar item.
14940 * @return The object
14944 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14947 * Get the icon object of @p item.
14949 * @param item The toolbar item.
14950 * @return The icon object
14952 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14956 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14959 * Set the icon associated with @p item to an image in a binary buffer.
14961 * @param item The toolbar item.
14962 * @param img The binary data that will be used as an image
14963 * @param size The size of binary data @p img
14964 * @param format Optional format of @p img to pass to the image loader
14965 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14967 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14969 * @note The icon image set by this function can be changed by
14970 * elm_toolbar_item_icon_set().
14974 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);
14977 * Delete them item from the toolbar.
14979 * @param item The item of toolbar to be deleted.
14981 * @see elm_toolbar_item_append()
14982 * @see elm_toolbar_item_del_cb_set()
14986 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14989 * Set the function called when a toolbar item is freed.
14991 * @param item The item to set the callback on.
14992 * @param func The function called.
14994 * If there is a @p func, then it will be called prior item's memory release.
14995 * That will be called with the following arguments:
14997 * @li item's Evas object;
15000 * This way, a data associated to a toolbar item could be properly freed.
15004 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15007 * Get a value whether toolbar item is disabled or not.
15009 * @param item The item.
15010 * @return The disabled state.
15012 * @see elm_toolbar_item_disabled_set() for more details.
15016 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15019 * Sets the disabled/enabled state of a toolbar item.
15021 * @param item The item.
15022 * @param disabled The disabled state.
15024 * A disabled item cannot be selected or unselected. It will also
15025 * change its appearance (generally greyed out). This sets the
15026 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15031 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15034 * Set or unset item as a separator.
15036 * @param item The toolbar item.
15037 * @param setting @c EINA_TRUE to set item @p item as separator or
15038 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15040 * Items aren't set as separator by default.
15042 * If set as separator it will display separator theme, so won't display
15045 * @see elm_toolbar_item_separator_get()
15049 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15052 * Get a value whether item is a separator or not.
15054 * @param item The toolbar item.
15055 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15056 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15058 * @see elm_toolbar_item_separator_set() for details.
15062 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15065 * Set the shrink state of toolbar @p obj.
15067 * @param obj The toolbar object.
15068 * @param shrink_mode Toolbar's items display behavior.
15070 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15071 * but will enforce a minimun size so all the items will fit, won't scroll
15072 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15073 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15074 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15078 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15081 * Get the shrink mode of toolbar @p obj.
15083 * @param obj The toolbar object.
15084 * @return Toolbar's items display behavior.
15086 * @see elm_toolbar_mode_shrink_set() for details.
15090 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15093 * Enable/disable homogenous mode.
15095 * @param obj The toolbar object
15096 * @param homogeneous Assume the items within the toolbar are of the
15097 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15099 * This will enable the homogeneous mode where items are of the same size.
15100 * @see elm_toolbar_homogeneous_get()
15104 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15107 * Get whether the homogenous mode is enabled.
15109 * @param obj The toolbar object.
15110 * @return Assume the items within the toolbar are of the same height
15111 * and width (EINA_TRUE = on, EINA_FALSE = off).
15113 * @see elm_toolbar_homogeneous_set()
15117 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15120 * Enable/disable homogenous mode.
15122 * @param obj The toolbar object
15123 * @param homogeneous Assume the items within the toolbar are of the
15124 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15126 * This will enable the homogeneous mode where items are of the same size.
15127 * @see elm_toolbar_homogeneous_get()
15129 * @deprecated use elm_toolbar_homogeneous_set() instead.
15133 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15136 * Get whether the homogenous mode is enabled.
15138 * @param obj The toolbar object.
15139 * @return Assume the items within the toolbar are of the same height
15140 * and width (EINA_TRUE = on, EINA_FALSE = off).
15142 * @see elm_toolbar_homogeneous_set()
15143 * @deprecated use elm_toolbar_homogeneous_get() instead.
15147 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15150 * Set the parent object of the toolbar items' menus.
15152 * @param obj The toolbar object.
15153 * @param parent The parent of the menu objects.
15155 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15157 * For more details about setting the parent for toolbar menus, see
15158 * elm_menu_parent_set().
15160 * @see elm_menu_parent_set() for details.
15161 * @see elm_toolbar_item_menu_set() for details.
15165 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15168 * Get the parent object of the toolbar items' menus.
15170 * @param obj The toolbar object.
15171 * @return The parent of the menu objects.
15173 * @see elm_toolbar_menu_parent_set() for details.
15177 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15180 * Set the alignment of the items.
15182 * @param obj The toolbar object.
15183 * @param align The new alignment, a float between <tt> 0.0 </tt>
15184 * and <tt> 1.0 </tt>.
15186 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15187 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15190 * Centered items by default.
15192 * @see elm_toolbar_align_get()
15196 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15199 * Get the alignment of the items.
15201 * @param obj The toolbar object.
15202 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15205 * @see elm_toolbar_align_set() for details.
15209 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15212 * Set whether the toolbar item opens a menu.
15214 * @param item The toolbar item.
15215 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15217 * A toolbar item can be set to be a menu, using this function.
15219 * Once it is set to be a menu, it can be manipulated through the
15220 * menu-like function elm_toolbar_menu_parent_set() and the other
15221 * elm_menu functions, using the Evas_Object @c menu returned by
15222 * elm_toolbar_item_menu_get().
15224 * So, items to be displayed in this item's menu should be added with
15225 * elm_menu_item_add().
15227 * The following code exemplifies the most basic usage:
15229 * tb = elm_toolbar_add(win)
15230 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15231 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15232 * elm_toolbar_menu_parent_set(tb, win);
15233 * menu = elm_toolbar_item_menu_get(item);
15234 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15235 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15239 * @see elm_toolbar_item_menu_get()
15243 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15246 * Get toolbar item's menu.
15248 * @param item The toolbar item.
15249 * @return Item's menu object or @c NULL on failure.
15251 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15252 * this function will set it.
15254 * @see elm_toolbar_item_menu_set() for details.
15258 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15261 * Add a new state to @p item.
15263 * @param item The item.
15264 * @param icon A string with icon name or the absolute path of an image file.
15265 * @param label The label of the new state.
15266 * @param func The function to call when the item is clicked when this
15267 * state is selected.
15268 * @param data The data to associate with the state.
15269 * @return The toolbar item state, or @c NULL upon failure.
15271 * Toolbar will load icon image from fdo or current theme.
15272 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15273 * If an absolute path is provided it will load it direct from a file.
15275 * States created with this function can be removed with
15276 * elm_toolbar_item_state_del().
15278 * @see elm_toolbar_item_state_del()
15279 * @see elm_toolbar_item_state_sel()
15280 * @see elm_toolbar_item_state_get()
15284 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);
15287 * Delete a previoulsy added state to @p item.
15289 * @param item The toolbar item.
15290 * @param state The state to be deleted.
15291 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15293 * @see elm_toolbar_item_state_add()
15295 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15298 * Set @p state as the current state of @p it.
15300 * @param it The item.
15301 * @param state The state to use.
15302 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15304 * If @p state is @c NULL, it won't select any state and the default item's
15305 * icon and label will be used. It's the same behaviour than
15306 * elm_toolbar_item_state_unser().
15308 * @see elm_toolbar_item_state_unset()
15312 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15315 * Unset the state of @p it.
15317 * @param it The item.
15319 * The default icon and label from this item will be displayed.
15321 * @see elm_toolbar_item_state_set() for more details.
15325 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15328 * Get the current state of @p it.
15330 * @param item The item.
15331 * @return The selected state or @c NULL if none is selected or on failure.
15333 * @see elm_toolbar_item_state_set() for details.
15334 * @see elm_toolbar_item_state_unset()
15335 * @see elm_toolbar_item_state_add()
15339 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15342 * Get the state after selected state in toolbar's @p item.
15344 * @param it The toolbar item to change state.
15345 * @return The state after current state, or @c NULL on failure.
15347 * If last state is selected, this function will return first state.
15349 * @see elm_toolbar_item_state_set()
15350 * @see elm_toolbar_item_state_add()
15354 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15357 * Get the state before selected state in toolbar's @p item.
15359 * @param it The toolbar item to change state.
15360 * @return The state before current state, or @c NULL on failure.
15362 * If first state is selected, this function will return last state.
15364 * @see elm_toolbar_item_state_set()
15365 * @see elm_toolbar_item_state_add()
15369 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15372 * Set the text to be shown in a given toolbar item's tooltips.
15374 * @param item Target item.
15375 * @param text The text to set in the content.
15377 * Setup the text as tooltip to object. The item can have only one tooltip,
15378 * so any previous tooltip data - set with this function or
15379 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15381 * @see elm_object_tooltip_text_set() for more details.
15385 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15388 * Set the content to be shown in the tooltip item.
15390 * Setup the tooltip to item. The item can have only one tooltip,
15391 * so any previous tooltip data is removed. @p func(with @p data) will
15392 * be called every time that need show the tooltip and it should
15393 * return a valid Evas_Object. This object is then managed fully by
15394 * tooltip system and is deleted when the tooltip is gone.
15396 * @param item the toolbar item being attached a tooltip.
15397 * @param func the function used to create the tooltip contents.
15398 * @param data what to provide to @a func as callback data/context.
15399 * @param del_cb called when data is not needed anymore, either when
15400 * another callback replaces @a func, the tooltip is unset with
15401 * elm_toolbar_item_tooltip_unset() or the owner @a item
15402 * dies. This callback receives as the first parameter the
15403 * given @a data, and @c event_info is the item.
15405 * @see elm_object_tooltip_content_cb_set() for more details.
15409 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);
15412 * Unset tooltip from item.
15414 * @param item toolbar item to remove previously set tooltip.
15416 * Remove tooltip from item. The callback provided as del_cb to
15417 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15418 * it is not used anymore.
15420 * @see elm_object_tooltip_unset() for more details.
15421 * @see elm_toolbar_item_tooltip_content_cb_set()
15425 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15428 * Sets a different style for this item tooltip.
15430 * @note before you set a style you should define a tooltip with
15431 * elm_toolbar_item_tooltip_content_cb_set() or
15432 * elm_toolbar_item_tooltip_text_set()
15434 * @param item toolbar item with tooltip already set.
15435 * @param style the theme style to use (default, transparent, ...)
15437 * @see elm_object_tooltip_style_set() for more details.
15441 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15444 * Get the style for this item tooltip.
15446 * @param item toolbar item with tooltip already set.
15447 * @return style the theme style in use, defaults to "default". If the
15448 * object does not have a tooltip set, then NULL is returned.
15450 * @see elm_object_tooltip_style_get() for more details.
15451 * @see elm_toolbar_item_tooltip_style_set()
15455 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15458 * Set the type of mouse pointer/cursor decoration to be shown,
15459 * when the mouse pointer is over the given toolbar widget item
15461 * @param item toolbar item to customize cursor on
15462 * @param cursor the cursor type's name
15464 * This function works analogously as elm_object_cursor_set(), but
15465 * here the cursor's changing area is restricted to the item's
15466 * area, and not the whole widget's. Note that that item cursors
15467 * have precedence over widget cursors, so that a mouse over an
15468 * item with custom cursor set will always show @b that cursor.
15470 * If this function is called twice for an object, a previously set
15471 * cursor will be unset on the second call.
15473 * @see elm_object_cursor_set()
15474 * @see elm_toolbar_item_cursor_get()
15475 * @see elm_toolbar_item_cursor_unset()
15479 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15482 * Get the type of mouse pointer/cursor decoration set to be shown,
15483 * when the mouse pointer is over the given toolbar widget item
15485 * @param item toolbar item with custom cursor set
15486 * @return the cursor type's name or @c NULL, if no custom cursors
15487 * were set to @p item (and on errors)
15489 * @see elm_object_cursor_get()
15490 * @see elm_toolbar_item_cursor_set()
15491 * @see elm_toolbar_item_cursor_unset()
15495 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15498 * Unset any custom mouse pointer/cursor decoration set to be
15499 * shown, when the mouse pointer is over the given toolbar widget
15500 * item, thus making it show the @b default cursor again.
15502 * @param item a toolbar item
15504 * Use this call to undo any custom settings on this item's cursor
15505 * decoration, bringing it back to defaults (no custom style set).
15507 * @see elm_object_cursor_unset()
15508 * @see elm_toolbar_item_cursor_set()
15512 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15515 * Set a different @b style for a given custom cursor set for a
15518 * @param item toolbar item with custom cursor set
15519 * @param style the <b>theme style</b> to use (e.g. @c "default",
15520 * @c "transparent", etc)
15522 * This function only makes sense when one is using custom mouse
15523 * cursor decorations <b>defined in a theme file</b>, which can have,
15524 * given a cursor name/type, <b>alternate styles</b> on it. It
15525 * works analogously as elm_object_cursor_style_set(), but here
15526 * applyed only to toolbar item objects.
15528 * @warning Before you set a cursor style you should have definen a
15529 * custom cursor previously on the item, with
15530 * elm_toolbar_item_cursor_set()
15532 * @see elm_toolbar_item_cursor_engine_only_set()
15533 * @see elm_toolbar_item_cursor_style_get()
15537 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15540 * Get the current @b style set for a given toolbar item's custom
15543 * @param item toolbar item with custom cursor set.
15544 * @return style the cursor style in use. If the object does not
15545 * have a cursor set, then @c NULL is returned.
15547 * @see elm_toolbar_item_cursor_style_set() for more details
15551 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15554 * Set if the (custom)cursor for a given toolbar item should be
15555 * searched in its theme, also, or should only rely on the
15556 * rendering engine.
15558 * @param item item with custom (custom) cursor already set on
15559 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15560 * only on those provided by the rendering engine, @c EINA_FALSE to
15561 * have them searched on the widget's theme, as well.
15563 * @note This call is of use only if you've set a custom cursor
15564 * for toolbar items, with elm_toolbar_item_cursor_set().
15566 * @note By default, cursors will only be looked for between those
15567 * provided by the rendering engine.
15571 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15574 * Get if the (custom) cursor for a given toolbar item is being
15575 * searched in its theme, also, or is only relying on the rendering
15578 * @param item a toolbar item
15579 * @return @c EINA_TRUE, if cursors are being looked for only on
15580 * those provided by the rendering engine, @c EINA_FALSE if they
15581 * are being searched on the widget's theme, as well.
15583 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15587 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15590 * Change a toolbar's orientation
15591 * @param obj The toolbar object
15592 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15593 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15595 * @deprecated use elm_toolbar_horizontal_set() instead.
15597 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15600 * Change a toolbar's orientation
15601 * @param obj The toolbar object
15602 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15603 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15606 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15609 * Get a toolbar's orientation
15610 * @param obj The toolbar object
15611 * @return If @c EINA_TRUE, the toolbar is vertical
15612 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15614 * @deprecated use elm_toolbar_horizontal_get() instead.
15616 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15619 * Get a toolbar's orientation
15620 * @param obj The toolbar object
15621 * @return If @c EINA_TRUE, the toolbar is horizontal
15622 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15625 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15631 * @defgroup Tooltips Tooltips
15633 * The Tooltip is an (internal, for now) smart object used to show a
15634 * content in a frame on mouse hover of objects(or widgets), with
15635 * tips/information about them.
15640 EAPI double elm_tooltip_delay_get(void);
15641 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15642 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15643 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15644 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15645 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15646 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15647 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);
15648 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15649 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15650 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15653 * @defgroup Cursors Cursors
15655 * The Elementary cursor is an internal smart object used to
15656 * customize the mouse cursor displayed over objects (or
15657 * widgets). In the most common scenario, the cursor decoration
15658 * comes from the graphical @b engine Elementary is running
15659 * on. Those engines may provide different decorations for cursors,
15660 * and Elementary provides functions to choose them (think of X11
15661 * cursors, as an example).
15663 * There's also the possibility of, besides using engine provided
15664 * cursors, also use ones coming from Edje theming files. Both
15665 * globally and per widget, Elementary makes it possible for one to
15666 * make the cursors lookup to be held on engines only or on
15667 * Elementary's theme file, too. To set cursor's hot spot,
15668 * two data items should be added to cursor's theme: "hot_x" and
15669 * "hot_y", that are the offset from upper-left corner of the cursor
15670 * (coordinates 0,0).
15676 * Set the cursor to be shown when mouse is over the object
15678 * Set the cursor that will be displayed when mouse is over the
15679 * object. The object can have only one cursor set to it, so if
15680 * this function is called twice for an object, the previous set
15682 * If using X cursors, a definition of all the valid cursor names
15683 * is listed on Elementary_Cursors.h. If an invalid name is set
15684 * the default cursor will be used.
15686 * @param obj the object being set a cursor.
15687 * @param cursor the cursor name to be used.
15691 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15694 * Get the cursor to be shown when mouse is over the object
15696 * @param obj an object with cursor already set.
15697 * @return the cursor name.
15701 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15704 * Unset cursor for object
15706 * Unset cursor for object, and set the cursor to default if the mouse
15707 * was over this object.
15709 * @param obj Target object
15710 * @see elm_object_cursor_set()
15714 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15717 * Sets a different style for this object cursor.
15719 * @note before you set a style you should define a cursor with
15720 * elm_object_cursor_set()
15722 * @param obj an object with cursor already set.
15723 * @param style the theme style to use (default, transparent, ...)
15727 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15730 * Get the style for this object cursor.
15732 * @param obj an object with cursor already set.
15733 * @return style the theme style in use, defaults to "default". If the
15734 * object does not have a cursor set, then NULL is returned.
15738 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15741 * Set if the cursor set should be searched on the theme or should use
15742 * the provided by the engine, only.
15744 * @note before you set if should look on theme you should define a cursor
15745 * with elm_object_cursor_set(). By default it will only look for cursors
15746 * provided by the engine.
15748 * @param obj an object with cursor already set.
15749 * @param engine_only boolean to define it cursors should be looked only
15750 * between the provided by the engine or searched on widget's theme as well.
15754 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15757 * Get the cursor engine only usage for this object cursor.
15759 * @param obj an object with cursor already set.
15760 * @return engine_only boolean to define it cursors should be
15761 * looked only between the provided by the engine or searched on
15762 * widget's theme as well. If the object does not have a cursor
15763 * set, then EINA_FALSE is returned.
15767 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15770 * Get the configured cursor engine only usage
15772 * This gets the globally configured exclusive usage of engine cursors.
15774 * @return 1 if only engine cursors should be used
15777 EAPI int elm_cursor_engine_only_get(void);
15780 * Set the configured cursor engine only usage
15782 * This sets the globally configured exclusive usage of engine cursors.
15783 * It won't affect cursors set before changing this value.
15785 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15786 * look for them on theme before.
15787 * @return EINA_TRUE if value is valid and setted (0 or 1)
15790 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15797 * @defgroup Menu Menu
15799 * @image html img/widget/menu/preview-00.png
15800 * @image latex img/widget/menu/preview-00.eps
15802 * A menu is a list of items displayed above its parent. When the menu is
15803 * showing its parent is darkened. Each item can have a sub-menu. The menu
15804 * object can be used to display a menu on a right click event, in a toolbar,
15807 * Signals that you can add callbacks for are:
15808 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15809 * event_info is NULL.
15811 * @see @ref tutorial_menu
15814 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15816 * @brief Add a new menu to the parent
15818 * @param parent The parent object.
15819 * @return The new object or NULL if it cannot be created.
15821 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15823 * @brief Set the parent for the given menu widget
15825 * @param obj The menu object.
15826 * @param parent The new parent.
15828 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15830 * @brief Get the parent for the given menu widget
15832 * @param obj The menu object.
15833 * @return The parent.
15835 * @see elm_menu_parent_set()
15837 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15839 * @brief Move the menu to a new position
15841 * @param obj The menu object.
15842 * @param x The new position.
15843 * @param y The new position.
15845 * Sets the top-left position of the menu to (@p x,@p y).
15847 * @note @p x and @p y coordinates are relative to parent.
15849 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15851 * @brief Close a opened menu
15853 * @param obj the menu object
15856 * Hides the menu and all it's sub-menus.
15858 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15860 * @brief Returns a list of @p item's items.
15862 * @param obj The menu object
15863 * @return An Eina_List* of @p item's items
15865 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15867 * @brief Get the Evas_Object of an Elm_Menu_Item
15869 * @param item The menu item object.
15870 * @return The edje object containing the swallowed content
15872 * @warning Don't manipulate this object!
15874 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15876 * @brief Add an item at the end of the given menu widget
15878 * @param obj The menu object.
15879 * @param parent The parent menu item (optional)
15880 * @param icon A icon display on the item. The icon will be destryed by the menu.
15881 * @param label The label of the item.
15882 * @param func Function called when the user select the item.
15883 * @param data Data sent by the callback.
15884 * @return Returns the new item.
15886 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);
15888 * @brief Add an object swallowed in an item at the end of the given menu
15891 * @param obj The menu object.
15892 * @param parent The parent menu item (optional)
15893 * @param subobj The object to swallow
15894 * @param func Function called when the user select the item.
15895 * @param data Data sent by the callback.
15896 * @return Returns the new item.
15898 * Add an evas object as an item to the menu.
15900 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);
15902 * @brief Set the label of a menu item
15904 * @param item The menu item object.
15905 * @param label The label to set for @p item
15907 * @warning Don't use this funcion on items created with
15908 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15910 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15912 * @brief Get the label of a menu item
15914 * @param item The menu item object.
15915 * @return The label of @p item
15917 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15919 * @brief Set the icon of a menu item to the standard icon with name @p icon
15921 * @param item The menu item object.
15922 * @param icon The icon object to set for the content of @p item
15924 * Once this icon is set, any previously set icon will be deleted.
15926 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15928 * @brief Get the string representation from the icon of a menu item
15930 * @param item The menu item object.
15931 * @return The string representation of @p item's icon or NULL
15933 * @see elm_menu_item_object_icon_name_set()
15935 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15937 * @brief Set the content object of a menu item
15939 * @param item The menu item object
15940 * @param The content object or NULL
15941 * @return EINA_TRUE on success, else EINA_FALSE
15943 * Use this function to change the object swallowed by a menu item, deleting
15944 * any previously swallowed object.
15946 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15948 * @brief Get the content object of a menu item
15950 * @param item The menu item object
15951 * @return The content object or NULL
15952 * @note If @p item was added with elm_menu_item_add_object, this
15953 * function will return the object passed, else it will return the
15956 * @see elm_menu_item_object_content_set()
15958 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15960 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15962 elm_menu_item_object_icon_name_set(item, icon);
15965 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15967 return elm_menu_item_object_content_get(item);
15970 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15972 return elm_menu_item_object_icon_name_get(item);
15976 * @brief Set the selected state of @p item.
15978 * @param item The menu item object.
15979 * @param selected The selected/unselected state of the item
15981 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15983 * @brief Get the selected state of @p item.
15985 * @param item The menu item object.
15986 * @return The selected/unselected state of the item
15988 * @see elm_menu_item_selected_set()
15990 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15992 * @brief Set the disabled state of @p item.
15994 * @param item The menu item object.
15995 * @param disabled The enabled/disabled state of the item
15997 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15999 * @brief Get the disabled state of @p item.
16001 * @param item The menu item object.
16002 * @return The enabled/disabled state of the item
16004 * @see elm_menu_item_disabled_set()
16006 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16008 * @brief Add a separator item to menu @p obj under @p parent.
16010 * @param obj The menu object
16011 * @param parent The item to add the separator under
16012 * @return The created item or NULL on failure
16014 * This is item is a @ref Separator.
16016 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16018 * @brief Returns whether @p item is a separator.
16020 * @param item The item to check
16021 * @return If true, @p item is a separator
16023 * @see elm_menu_item_separator_add()
16025 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16027 * @brief Deletes an item from the menu.
16029 * @param item The item to delete.
16031 * @see elm_menu_item_add()
16033 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16035 * @brief Set the function called when a menu item is deleted.
16037 * @param item The item to set the callback on
16038 * @param func The function called
16040 * @see elm_menu_item_add()
16041 * @see elm_menu_item_del()
16043 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16045 * @brief Returns the data associated with menu item @p item.
16047 * @param item The item
16048 * @return The data associated with @p item or NULL if none was set.
16050 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16052 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16054 * @brief Sets the data to be associated with menu item @p item.
16056 * @param item The item
16057 * @param data The data to be associated with @p item
16059 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16061 * @brief Returns a list of @p item's subitems.
16063 * @param item The item
16064 * @return An Eina_List* of @p item's subitems
16066 * @see elm_menu_add()
16068 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16070 * @brief Get the position of a menu item
16072 * @param item The menu item
16073 * @return The item's index
16075 * This function returns the index position of a menu item in a menu.
16076 * For a sub-menu, this number is relative to the first item in the sub-menu.
16078 * @note Index values begin with 0
16080 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16082 * @brief @brief Return a menu item's owner menu
16084 * @param item The menu item
16085 * @return The menu object owning @p item, or NULL on failure
16087 * Use this function to get the menu object owning an item.
16089 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16091 * @brief Get the selected item in the menu
16093 * @param obj The menu object
16094 * @return The selected item, or NULL if none
16096 * @see elm_menu_item_selected_get()
16097 * @see elm_menu_item_selected_set()
16099 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16101 * @brief Get the last item in the menu
16103 * @param obj The menu object
16104 * @return The last item, or NULL if none
16106 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16108 * @brief Get the first item in the menu
16110 * @param obj The menu object
16111 * @return The first item, or NULL if none
16113 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16115 * @brief Get the next item in the menu.
16117 * @param item The menu item object.
16118 * @return The item after it, or NULL if none
16120 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16122 * @brief Get the previous item in the menu.
16124 * @param item The menu item object.
16125 * @return The item before it, or NULL if none
16127 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16133 * @defgroup List List
16134 * @ingroup Elementary
16136 * @image html img/widget/list/preview-00.png
16137 * @image latex img/widget/list/preview-00.eps width=\textwidth
16139 * @image html img/list.png
16140 * @image latex img/list.eps width=\textwidth
16142 * A list widget is a container whose children are displayed vertically or
16143 * horizontally, in order, and can be selected.
16144 * The list can accept only one or multiple items selection. Also has many
16145 * modes of items displaying.
16147 * A list is a very simple type of list widget. For more robust
16148 * lists, @ref Genlist should probably be used.
16150 * Smart callbacks one can listen to:
16151 * - @c "activated" - The user has double-clicked or pressed
16152 * (enter|return|spacebar) on an item. The @c event_info parameter
16153 * is the item that was activated.
16154 * - @c "clicked,double" - The user has double-clicked an item.
16155 * The @c event_info parameter is the item that was double-clicked.
16156 * - "selected" - when the user selected an item
16157 * - "unselected" - when the user unselected an item
16158 * - "longpressed" - an item in the list is long-pressed
16159 * - "edge,top" - the list is scrolled until the top edge
16160 * - "edge,bottom" - the list is scrolled until the bottom edge
16161 * - "edge,left" - the list is scrolled until the left edge
16162 * - "edge,right" - the list is scrolled until the right edge
16163 * - "language,changed" - the program's language changed
16165 * Available styles for it:
16168 * List of examples:
16169 * @li @ref list_example_01
16170 * @li @ref list_example_02
16171 * @li @ref list_example_03
16180 * @enum _Elm_List_Mode
16181 * @typedef Elm_List_Mode
16183 * Set list's resize behavior, transverse axis scroll and
16184 * items cropping. See each mode's description for more details.
16186 * @note Default value is #ELM_LIST_SCROLL.
16188 * Values <b> don't </b> work as bitmask, only one can be choosen.
16190 * @see elm_list_mode_set()
16191 * @see elm_list_mode_get()
16195 typedef enum _Elm_List_Mode
16197 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. */
16198 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). */
16199 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. */
16200 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. */
16201 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16204 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(). */
16207 * Add a new list widget to the given parent Elementary
16208 * (container) object.
16210 * @param parent The parent object.
16211 * @return a new list widget handle or @c NULL, on errors.
16213 * This function inserts a new list widget on the canvas.
16217 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16222 * @param obj The list object
16224 * @note Call before running show() on the list object.
16225 * @warning If not called, it won't display the list properly.
16228 * li = elm_list_add(win);
16229 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16230 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16232 * evas_object_show(li);
16237 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16240 * Enable or disable multiple items selection on the list object.
16242 * @param obj The list object
16243 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16246 * Disabled by default. If disabled, the user can select a single item of
16247 * the list each time. Selected items are highlighted on list.
16248 * If enabled, many items can be selected.
16250 * If a selected item is selected again, it will be unselected.
16252 * @see elm_list_multi_select_get()
16256 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16259 * Get a value whether multiple items selection is enabled or not.
16261 * @see elm_list_multi_select_set() for details.
16263 * @param obj The list object.
16264 * @return @c EINA_TRUE means multiple items selection is enabled.
16265 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16266 * @c EINA_FALSE is returned.
16270 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16273 * Set which mode to use for the list object.
16275 * @param obj The list object
16276 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16277 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16279 * Set list's resize behavior, transverse axis scroll and
16280 * items cropping. See each mode's description for more details.
16282 * @note Default value is #ELM_LIST_SCROLL.
16284 * Only one can be set, if a previous one was set, it will be changed
16285 * by the new mode set. Bitmask won't work as well.
16287 * @see elm_list_mode_get()
16291 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16294 * Get the mode the list is at.
16296 * @param obj The list object
16297 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16298 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16300 * @note see elm_list_mode_set() for more information.
16304 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16307 * Enable or disable horizontal mode on the list object.
16309 * @param obj The list object.
16310 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16311 * disable it, i.e., to enable vertical mode.
16313 * @note Vertical mode is set by default.
16315 * On horizontal mode items are displayed on list from left to right,
16316 * instead of from top to bottom. Also, the list will scroll horizontally.
16317 * Each item will presents left icon on top and right icon, or end, at
16320 * @see elm_list_horizontal_get()
16324 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16327 * Get a value whether horizontal mode is enabled or not.
16329 * @param obj The list object.
16330 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16331 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16332 * @c EINA_FALSE is returned.
16334 * @see elm_list_horizontal_set() for details.
16338 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16341 * Enable or disable always select mode on the list object.
16343 * @param obj The list object
16344 * @param always_select @c EINA_TRUE to enable always select mode or
16345 * @c EINA_FALSE to disable it.
16347 * @note Always select mode is disabled by default.
16349 * Default behavior of list items is to only call its callback function
16350 * the first time it's pressed, i.e., when it is selected. If a selected
16351 * item is pressed again, and multi-select is disabled, it won't call
16352 * this function (if multi-select is enabled it will unselect the item).
16354 * If always select is enabled, it will call the callback function
16355 * everytime a item is pressed, so it will call when the item is selected,
16356 * and again when a selected item is pressed.
16358 * @see elm_list_always_select_mode_get()
16359 * @see elm_list_multi_select_set()
16363 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16366 * Get a value whether always select mode is enabled or not, meaning that
16367 * an item will always call its callback function, even if already selected.
16369 * @param obj The list object
16370 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16371 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16372 * @c EINA_FALSE is returned.
16374 * @see elm_list_always_select_mode_set() for details.
16378 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16381 * Set bouncing behaviour when the scrolled content reaches an edge.
16383 * Tell the internal scroller object whether it should bounce or not
16384 * when it reaches the respective edges for each axis.
16386 * @param obj The list object
16387 * @param h_bounce Whether to bounce or not in the horizontal axis.
16388 * @param v_bounce Whether to bounce or not in the vertical axis.
16390 * @see elm_scroller_bounce_set()
16394 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16397 * Get the bouncing behaviour of the internal scroller.
16399 * Get whether the internal scroller should bounce when the edge of each
16400 * axis is reached scrolling.
16402 * @param obj The list object.
16403 * @param h_bounce Pointer where to store the bounce state of the horizontal
16405 * @param v_bounce Pointer where to store the bounce state of the vertical
16408 * @see elm_scroller_bounce_get()
16409 * @see elm_list_bounce_set()
16413 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16416 * Set the scrollbar policy.
16418 * @param obj The list object
16419 * @param policy_h Horizontal scrollbar policy.
16420 * @param policy_v Vertical scrollbar policy.
16422 * This sets the scrollbar visibility policy for the given scroller.
16423 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16424 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16425 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16426 * This applies respectively for the horizontal and vertical scrollbars.
16428 * The both are disabled by default, i.e., are set to
16429 * #ELM_SCROLLER_POLICY_OFF.
16433 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16436 * Get the scrollbar policy.
16438 * @see elm_list_scroller_policy_get() for details.
16440 * @param obj The list object.
16441 * @param policy_h Pointer where to store horizontal scrollbar policy.
16442 * @param policy_v Pointer where to store vertical scrollbar policy.
16446 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);
16449 * Append a new item to the list object.
16451 * @param obj The list object.
16452 * @param label The label of the list item.
16453 * @param icon The icon object to use for the left side of the item. An
16454 * icon can be any Evas object, but usually it is an icon created
16455 * with elm_icon_add().
16456 * @param end The icon object to use for the right side of the item. An
16457 * icon can be any Evas object.
16458 * @param func The function to call when the item is clicked.
16459 * @param data The data to associate with the item for related callbacks.
16461 * @return The created item or @c NULL upon failure.
16463 * A new item will be created and appended to the list, i.e., will
16464 * be set as @b last item.
16466 * Items created with this method can be deleted with
16467 * elm_list_item_del().
16469 * Associated @p data can be properly freed when item is deleted if a
16470 * callback function is set with elm_list_item_del_cb_set().
16472 * If a function is passed as argument, it will be called everytime this item
16473 * is selected, i.e., the user clicks over an unselected item.
16474 * If always select is enabled it will call this function every time
16475 * user clicks over an item (already selected or not).
16476 * If such function isn't needed, just passing
16477 * @c NULL as @p func is enough. The same should be done for @p data.
16479 * Simple example (with no function callback or data associated):
16481 * li = elm_list_add(win);
16482 * ic = elm_icon_add(win);
16483 * elm_icon_file_set(ic, "path/to/image", NULL);
16484 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16485 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16487 * evas_object_show(li);
16490 * @see elm_list_always_select_mode_set()
16491 * @see elm_list_item_del()
16492 * @see elm_list_item_del_cb_set()
16493 * @see elm_list_clear()
16494 * @see elm_icon_add()
16498 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);
16501 * Prepend a new item to the list object.
16503 * @param obj The list object.
16504 * @param label The label of the list item.
16505 * @param icon The icon object to use for the left side of the item. An
16506 * icon can be any Evas object, but usually it is an icon created
16507 * with elm_icon_add().
16508 * @param end The icon object to use for the right side of the item. An
16509 * icon can be any Evas object.
16510 * @param func The function to call when the item is clicked.
16511 * @param data The data to associate with the item for related callbacks.
16513 * @return The created item or @c NULL upon failure.
16515 * A new item will be created and prepended to the list, i.e., will
16516 * be set as @b first item.
16518 * Items created with this method can be deleted with
16519 * elm_list_item_del().
16521 * Associated @p data can be properly freed when item is deleted if a
16522 * callback function is set with elm_list_item_del_cb_set().
16524 * If a function is passed as argument, it will be called everytime this item
16525 * is selected, i.e., the user clicks over an unselected item.
16526 * If always select is enabled it will call this function every time
16527 * user clicks over an item (already selected or not).
16528 * If such function isn't needed, just passing
16529 * @c NULL as @p func is enough. The same should be done for @p data.
16531 * @see elm_list_item_append() for a simple code example.
16532 * @see elm_list_always_select_mode_set()
16533 * @see elm_list_item_del()
16534 * @see elm_list_item_del_cb_set()
16535 * @see elm_list_clear()
16536 * @see elm_icon_add()
16540 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);
16543 * Insert a new item into the list object before item @p before.
16545 * @param obj The list object.
16546 * @param before The list item to insert before.
16547 * @param label The label of the list item.
16548 * @param icon The icon object to use for the left side of the item. An
16549 * icon can be any Evas object, but usually it is an icon created
16550 * with elm_icon_add().
16551 * @param end The icon object to use for the right side of the item. An
16552 * icon can be any Evas object.
16553 * @param func The function to call when the item is clicked.
16554 * @param data The data to associate with the item for related callbacks.
16556 * @return The created item or @c NULL upon failure.
16558 * A new item will be created and added to the list. Its position in
16559 * this list will be just before item @p before.
16561 * Items created with this method can be deleted with
16562 * elm_list_item_del().
16564 * Associated @p data can be properly freed when item is deleted if a
16565 * callback function is set with elm_list_item_del_cb_set().
16567 * If a function is passed as argument, it will be called everytime this item
16568 * is selected, i.e., the user clicks over an unselected item.
16569 * If always select is enabled it will call this function every time
16570 * user clicks over an item (already selected or not).
16571 * If such function isn't needed, just passing
16572 * @c NULL as @p func is enough. The same should be done for @p data.
16574 * @see elm_list_item_append() for a simple code example.
16575 * @see elm_list_always_select_mode_set()
16576 * @see elm_list_item_del()
16577 * @see elm_list_item_del_cb_set()
16578 * @see elm_list_clear()
16579 * @see elm_icon_add()
16583 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);
16586 * Insert a new item into the list object after item @p after.
16588 * @param obj The list object.
16589 * @param after The list item to insert after.
16590 * @param label The label of the list item.
16591 * @param icon The icon object to use for the left side of the item. An
16592 * icon can be any Evas object, but usually it is an icon created
16593 * with elm_icon_add().
16594 * @param end The icon object to use for the right side of the item. An
16595 * icon can be any Evas object.
16596 * @param func The function to call when the item is clicked.
16597 * @param data The data to associate with the item for related callbacks.
16599 * @return The created item or @c NULL upon failure.
16601 * A new item will be created and added to the list. Its position in
16602 * this list will be just after item @p after.
16604 * Items created with this method can be deleted with
16605 * elm_list_item_del().
16607 * Associated @p data can be properly freed when item is deleted if a
16608 * callback function is set with elm_list_item_del_cb_set().
16610 * If a function is passed as argument, it will be called everytime this item
16611 * is selected, i.e., the user clicks over an unselected item.
16612 * If always select is enabled it will call this function every time
16613 * user clicks over an item (already selected or not).
16614 * If such function isn't needed, just passing
16615 * @c NULL as @p func is enough. The same should be done for @p data.
16617 * @see elm_list_item_append() for a simple code example.
16618 * @see elm_list_always_select_mode_set()
16619 * @see elm_list_item_del()
16620 * @see elm_list_item_del_cb_set()
16621 * @see elm_list_clear()
16622 * @see elm_icon_add()
16626 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);
16629 * Insert a new item into the sorted list object.
16631 * @param obj The list object.
16632 * @param label The label of the list item.
16633 * @param icon The icon object to use for the left side of the item. An
16634 * icon can be any Evas object, but usually it is an icon created
16635 * with elm_icon_add().
16636 * @param end The icon object to use for the right side of the item. An
16637 * icon can be any Evas object.
16638 * @param func The function to call when the item is clicked.
16639 * @param data The data to associate with the item for related callbacks.
16640 * @param cmp_func The comparing function to be used to sort list
16641 * items <b>by #Elm_List_Item item handles</b>. This function will
16642 * receive two items and compare them, returning a non-negative integer
16643 * if the second item should be place after the first, or negative value
16644 * if should be placed before.
16646 * @return The created item or @c NULL upon failure.
16648 * @note This function inserts values into a list object assuming it was
16649 * sorted and the result will be sorted.
16651 * A new item will be created and added to the list. Its position in
16652 * this list will be found comparing the new item with previously inserted
16653 * items using function @p cmp_func.
16655 * Items created with this method can be deleted with
16656 * elm_list_item_del().
16658 * Associated @p data can be properly freed when item is deleted if a
16659 * callback function is set with elm_list_item_del_cb_set().
16661 * If a function is passed as argument, it will be called everytime this item
16662 * is selected, i.e., the user clicks over an unselected item.
16663 * If always select is enabled it will call this function every time
16664 * user clicks over an item (already selected or not).
16665 * If such function isn't needed, just passing
16666 * @c NULL as @p func is enough. The same should be done for @p data.
16668 * @see elm_list_item_append() for a simple code example.
16669 * @see elm_list_always_select_mode_set()
16670 * @see elm_list_item_del()
16671 * @see elm_list_item_del_cb_set()
16672 * @see elm_list_clear()
16673 * @see elm_icon_add()
16677 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);
16680 * Remove all list's items.
16682 * @param obj The list object
16684 * @see elm_list_item_del()
16685 * @see elm_list_item_append()
16689 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16692 * Get a list of all the list items.
16694 * @param obj The list object
16695 * @return An @c Eina_List of list items, #Elm_List_Item,
16696 * or @c NULL on failure.
16698 * @see elm_list_item_append()
16699 * @see elm_list_item_del()
16700 * @see elm_list_clear()
16704 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16707 * Get the selected item.
16709 * @param obj The list object.
16710 * @return The selected list item.
16712 * The selected item can be unselected with function
16713 * elm_list_item_selected_set().
16715 * The selected item always will be highlighted on list.
16717 * @see elm_list_selected_items_get()
16721 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16724 * Return a list of the currently selected list items.
16726 * @param obj The list object.
16727 * @return An @c Eina_List of list items, #Elm_List_Item,
16728 * or @c NULL on failure.
16730 * Multiple items can be selected if multi select is enabled. It can be
16731 * done with elm_list_multi_select_set().
16733 * @see elm_list_selected_item_get()
16734 * @see elm_list_multi_select_set()
16738 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16741 * Set the selected state of an item.
16743 * @param item The list item
16744 * @param selected The selected state
16746 * This sets the selected state of the given item @p it.
16747 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16749 * If a new item is selected the previosly selected will be unselected,
16750 * unless multiple selection is enabled with elm_list_multi_select_set().
16751 * Previoulsy selected item can be get with function
16752 * elm_list_selected_item_get().
16754 * Selected items will be highlighted.
16756 * @see elm_list_item_selected_get()
16757 * @see elm_list_selected_item_get()
16758 * @see elm_list_multi_select_set()
16762 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16765 * Get whether the @p item is selected or not.
16767 * @param item The list item.
16768 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16769 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16771 * @see elm_list_selected_item_set() for details.
16772 * @see elm_list_item_selected_get()
16776 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16779 * Set or unset item as a separator.
16781 * @param it The list item.
16782 * @param setting @c EINA_TRUE to set item @p it as separator or
16783 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16785 * Items aren't set as separator by default.
16787 * If set as separator it will display separator theme, so won't display
16790 * @see elm_list_item_separator_get()
16794 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16797 * Get a value whether item is a separator or not.
16799 * @see elm_list_item_separator_set() for details.
16801 * @param it The list item.
16802 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16803 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16807 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16810 * Show @p item in the list view.
16812 * @param item The list item to be shown.
16814 * It won't animate list until item is visible. If such behavior is wanted,
16815 * use elm_list_bring_in() intead.
16819 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16822 * Bring in the given item to list view.
16824 * @param item The item.
16826 * This causes list to jump to the given item @p item and show it
16827 * (by scrolling), if it is not fully visible.
16829 * This may use animation to do so and take a period of time.
16831 * If animation isn't wanted, elm_list_item_show() can be used.
16835 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16838 * Delete them item from the list.
16840 * @param item The item of list to be deleted.
16842 * If deleting all list items is required, elm_list_clear()
16843 * should be used instead of getting items list and deleting each one.
16845 * @see elm_list_clear()
16846 * @see elm_list_item_append()
16847 * @see elm_list_item_del_cb_set()
16851 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16854 * Set the function called when a list item is freed.
16856 * @param item The item to set the callback on
16857 * @param func The function called
16859 * If there is a @p func, then it will be called prior item's memory release.
16860 * That will be called with the following arguments:
16862 * @li item's Evas object;
16865 * This way, a data associated to a list item could be properly freed.
16869 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16872 * Get the data associated to the item.
16874 * @param item The list item
16875 * @return The data associated to @p item
16877 * The return value is a pointer to data associated to @p item when it was
16878 * created, with function elm_list_item_append() or similar. If no data
16879 * was passed as argument, it will return @c NULL.
16881 * @see elm_list_item_append()
16885 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16888 * Get the left side icon associated to the item.
16890 * @param item The list item
16891 * @return The left side icon associated to @p item
16893 * The return value is a pointer to the icon associated to @p item when
16895 * created, with function elm_list_item_append() or similar, or later
16896 * with function elm_list_item_icon_set(). If no icon
16897 * was passed as argument, it will return @c NULL.
16899 * @see elm_list_item_append()
16900 * @see elm_list_item_icon_set()
16904 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16907 * Set the left side icon associated to the item.
16909 * @param item The list item
16910 * @param icon The left side icon object to associate with @p item
16912 * The icon object to use at left side of the item. An
16913 * icon can be any Evas object, but usually it is an icon created
16914 * with elm_icon_add().
16916 * Once the icon object is set, a previously set one will be deleted.
16917 * @warning Setting the same icon for two items will cause the icon to
16918 * dissapear from the first item.
16920 * If an icon was passed as argument on item creation, with function
16921 * elm_list_item_append() or similar, it will be already
16922 * associated to the item.
16924 * @see elm_list_item_append()
16925 * @see elm_list_item_icon_get()
16929 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16932 * Get the right side icon associated to the item.
16934 * @param item The list item
16935 * @return The right side icon associated to @p item
16937 * The return value is a pointer to the icon associated to @p item when
16939 * created, with function elm_list_item_append() or similar, or later
16940 * with function elm_list_item_icon_set(). If no icon
16941 * was passed as argument, it will return @c NULL.
16943 * @see elm_list_item_append()
16944 * @see elm_list_item_icon_set()
16948 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16951 * Set the right side icon associated to the item.
16953 * @param item The list item
16954 * @param end The right side icon object to associate with @p item
16956 * The icon object to use at right side of the item. An
16957 * icon can be any Evas object, but usually it is an icon created
16958 * with elm_icon_add().
16960 * Once the icon object is set, a previously set one will be deleted.
16961 * @warning Setting the same icon for two items will cause the icon to
16962 * dissapear from the first item.
16964 * If an icon was passed as argument on item creation, with function
16965 * elm_list_item_append() or similar, it will be already
16966 * associated to the item.
16968 * @see elm_list_item_append()
16969 * @see elm_list_item_end_get()
16973 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16974 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16977 * Gets the base object of the item.
16979 * @param item The list item
16980 * @return The base object associated with @p item
16982 * Base object is the @c Evas_Object that represents that item.
16986 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16989 * Get the label of item.
16991 * @param item The item of list.
16992 * @return The label of item.
16994 * The return value is a pointer to the label associated to @p item when
16995 * it was created, with function elm_list_item_append(), or later
16996 * with function elm_list_item_label_set. If no label
16997 * was passed as argument, it will return @c NULL.
16999 * @see elm_list_item_label_set() for more details.
17000 * @see elm_list_item_append()
17004 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17007 * Set the label of item.
17009 * @param item The item of list.
17010 * @param text The label of item.
17012 * The label to be displayed by the item.
17013 * Label will be placed between left and right side icons (if set).
17015 * If a label was passed as argument on item creation, with function
17016 * elm_list_item_append() or similar, it will be already
17017 * displayed by the item.
17019 * @see elm_list_item_label_get()
17020 * @see elm_list_item_append()
17024 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17028 * Get the item before @p it in list.
17030 * @param it The list item.
17031 * @return The item before @p it, or @c NULL if none or on failure.
17033 * @note If it is the first item, @c NULL will be returned.
17035 * @see elm_list_item_append()
17036 * @see elm_list_items_get()
17040 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17043 * Get the item after @p it in list.
17045 * @param it The list item.
17046 * @return The item after @p it, or @c NULL if none or on failure.
17048 * @note If it is the last item, @c NULL will be returned.
17050 * @see elm_list_item_append()
17051 * @see elm_list_items_get()
17055 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17058 * Sets the disabled/enabled state of a list item.
17060 * @param it The item.
17061 * @param disabled The disabled state.
17063 * A disabled item cannot be selected or unselected. It will also
17064 * change its appearance (generally greyed out). This sets the
17065 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17070 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17073 * Get a value whether list item is disabled or not.
17075 * @param it The item.
17076 * @return The disabled state.
17078 * @see elm_list_item_disabled_set() for more details.
17082 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17085 * Set the text to be shown in a given list item's tooltips.
17087 * @param item Target item.
17088 * @param text The text to set in the content.
17090 * Setup the text as tooltip to object. The item can have only one tooltip,
17091 * so any previous tooltip data - set with this function or
17092 * elm_list_item_tooltip_content_cb_set() - is removed.
17094 * @see elm_object_tooltip_text_set() for more details.
17098 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17102 * @brief Disable size restrictions on an object's tooltip
17103 * @param item The tooltip's anchor object
17104 * @param disable If EINA_TRUE, size restrictions are disabled
17105 * @return EINA_FALSE on failure, EINA_TRUE on success
17107 * This function allows a tooltip to expand beyond its parant window's canvas.
17108 * It will instead be limited only by the size of the display.
17110 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17112 * @brief Retrieve size restriction state of an object's tooltip
17113 * @param obj The tooltip's anchor object
17114 * @return If EINA_TRUE, size restrictions are disabled
17116 * This function returns whether a tooltip is allowed to expand beyond
17117 * its parant window's canvas.
17118 * It will instead be limited only by the size of the display.
17120 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17123 * Set the content to be shown in the tooltip item.
17125 * Setup the tooltip to item. The item can have only one tooltip,
17126 * so any previous tooltip data is removed. @p func(with @p data) will
17127 * be called every time that need show the tooltip and it should
17128 * return a valid Evas_Object. This object is then managed fully by
17129 * tooltip system and is deleted when the tooltip is gone.
17131 * @param item the list item being attached a tooltip.
17132 * @param func the function used to create the tooltip contents.
17133 * @param data what to provide to @a func as callback data/context.
17134 * @param del_cb called when data is not needed anymore, either when
17135 * another callback replaces @a func, the tooltip is unset with
17136 * elm_list_item_tooltip_unset() or the owner @a item
17137 * dies. This callback receives as the first parameter the
17138 * given @a data, and @c event_info is the item.
17140 * @see elm_object_tooltip_content_cb_set() for more details.
17144 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);
17147 * Unset tooltip from item.
17149 * @param item list item to remove previously set tooltip.
17151 * Remove tooltip from item. The callback provided as del_cb to
17152 * elm_list_item_tooltip_content_cb_set() will be called to notify
17153 * it is not used anymore.
17155 * @see elm_object_tooltip_unset() for more details.
17156 * @see elm_list_item_tooltip_content_cb_set()
17160 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17163 * Sets a different style for this item tooltip.
17165 * @note before you set a style you should define a tooltip with
17166 * elm_list_item_tooltip_content_cb_set() or
17167 * elm_list_item_tooltip_text_set()
17169 * @param item list item with tooltip already set.
17170 * @param style the theme style to use (default, transparent, ...)
17172 * @see elm_object_tooltip_style_set() for more details.
17176 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17179 * Get the style for this item tooltip.
17181 * @param item list item with tooltip already set.
17182 * @return style the theme style in use, defaults to "default". If the
17183 * object does not have a tooltip set, then NULL is returned.
17185 * @see elm_object_tooltip_style_get() for more details.
17186 * @see elm_list_item_tooltip_style_set()
17190 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17193 * Set the type of mouse pointer/cursor decoration to be shown,
17194 * when the mouse pointer is over the given list widget item
17196 * @param item list item to customize cursor on
17197 * @param cursor the cursor type's name
17199 * This function works analogously as elm_object_cursor_set(), but
17200 * here the cursor's changing area is restricted to the item's
17201 * area, and not the whole widget's. Note that that item cursors
17202 * have precedence over widget cursors, so that a mouse over an
17203 * item with custom cursor set will always show @b that cursor.
17205 * If this function is called twice for an object, a previously set
17206 * cursor will be unset on the second call.
17208 * @see elm_object_cursor_set()
17209 * @see elm_list_item_cursor_get()
17210 * @see elm_list_item_cursor_unset()
17214 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17217 * Get the type of mouse pointer/cursor decoration set to be shown,
17218 * when the mouse pointer is over the given list widget item
17220 * @param item list item with custom cursor set
17221 * @return the cursor type's name or @c NULL, if no custom cursors
17222 * were set to @p item (and on errors)
17224 * @see elm_object_cursor_get()
17225 * @see elm_list_item_cursor_set()
17226 * @see elm_list_item_cursor_unset()
17230 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17233 * Unset any custom mouse pointer/cursor decoration set to be
17234 * shown, when the mouse pointer is over the given list widget
17235 * item, thus making it show the @b default cursor again.
17237 * @param item a list item
17239 * Use this call to undo any custom settings on this item's cursor
17240 * decoration, bringing it back to defaults (no custom style set).
17242 * @see elm_object_cursor_unset()
17243 * @see elm_list_item_cursor_set()
17247 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17250 * Set a different @b style for a given custom cursor set for a
17253 * @param item list item with custom cursor set
17254 * @param style the <b>theme style</b> to use (e.g. @c "default",
17255 * @c "transparent", etc)
17257 * This function only makes sense when one is using custom mouse
17258 * cursor decorations <b>defined in a theme file</b>, which can have,
17259 * given a cursor name/type, <b>alternate styles</b> on it. It
17260 * works analogously as elm_object_cursor_style_set(), but here
17261 * applyed only to list item objects.
17263 * @warning Before you set a cursor style you should have definen a
17264 * custom cursor previously on the item, with
17265 * elm_list_item_cursor_set()
17267 * @see elm_list_item_cursor_engine_only_set()
17268 * @see elm_list_item_cursor_style_get()
17272 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17275 * Get the current @b style set for a given list item's custom
17278 * @param item list item with custom cursor set.
17279 * @return style the cursor style in use. If the object does not
17280 * have a cursor set, then @c NULL is returned.
17282 * @see elm_list_item_cursor_style_set() for more details
17286 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17289 * Set if the (custom)cursor for a given list item should be
17290 * searched in its theme, also, or should only rely on the
17291 * rendering engine.
17293 * @param item item with custom (custom) cursor already set on
17294 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17295 * only on those provided by the rendering engine, @c EINA_FALSE to
17296 * have them searched on the widget's theme, as well.
17298 * @note This call is of use only if you've set a custom cursor
17299 * for list items, with elm_list_item_cursor_set().
17301 * @note By default, cursors will only be looked for between those
17302 * provided by the rendering engine.
17306 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17309 * Get if the (custom) cursor for a given list item is being
17310 * searched in its theme, also, or is only relying on the rendering
17313 * @param item a list item
17314 * @return @c EINA_TRUE, if cursors are being looked for only on
17315 * those provided by the rendering engine, @c EINA_FALSE if they
17316 * are being searched on the widget's theme, as well.
17318 * @see elm_list_item_cursor_engine_only_set(), for more details
17322 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17329 * @defgroup Slider Slider
17330 * @ingroup Elementary
17332 * @image html img/widget/slider/preview-00.png
17333 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17335 * The slider adds a dragable āsliderā widget for selecting the value of
17336 * something within a range.
17338 * A slider can be horizontal or vertical. It can contain an Icon and has a
17339 * primary label as well as a units label (that is formatted with floating
17340 * point values and thus accepts a printf-style format string, like
17341 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17342 * else (like on the slider itself) that also accepts a format string like
17343 * units. Label, Icon Unit and Indicator strings/objects are optional.
17345 * A slider may be inverted which means values invert, with high vales being
17346 * on the left or top and low values on the right or bottom (as opposed to
17347 * normally being low on the left or top and high on the bottom and right).
17349 * The slider should have its minimum and maximum values set by the
17350 * application with elm_slider_min_max_set() and value should also be set by
17351 * the application before use with elm_slider_value_set(). The span of the
17352 * slider is its length (horizontally or vertically). This will be scaled by
17353 * the object or applications scaling factor. At any point code can query the
17354 * slider for its value with elm_slider_value_get().
17356 * Smart callbacks one can listen to:
17357 * - "changed" - Whenever the slider value is changed by the user.
17358 * - "slider,drag,start" - dragging the slider indicator around has started.
17359 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17360 * - "delay,changed" - A short time after the value is changed by the user.
17361 * This will be called only when the user stops dragging for
17362 * a very short period or when they release their
17363 * finger/mouse, so it avoids possibly expensive reactions to
17364 * the value change.
17366 * Available styles for it:
17369 * Default contents parts of the slider widget that you can use for are:
17370 * @li "elm.swallow.icon" - A icon of the slider
17371 * @li "elm.swallow.end" - A end part content of the slider
17373 * Here is an example on its usage:
17374 * @li @ref slider_example
17377 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17378 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17381 * @addtogroup Slider
17386 * Add a new slider widget to the given parent Elementary
17387 * (container) object.
17389 * @param parent The parent object.
17390 * @return a new slider widget handle or @c NULL, on errors.
17392 * This function inserts a new slider widget on the canvas.
17396 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17399 * Set the label of a given slider widget
17401 * @param obj The progress bar object
17402 * @param label The text label string, in UTF-8
17405 * @deprecated use elm_object_text_set() instead.
17407 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17410 * Get the label of a given slider widget
17412 * @param obj The progressbar object
17413 * @return The text label string, in UTF-8
17416 * @deprecated use elm_object_text_get() instead.
17418 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17421 * Set the icon object of the slider object.
17423 * @param obj The slider object.
17424 * @param icon The icon object.
17426 * On horizontal mode, icon is placed at left, and on vertical mode,
17429 * @note Once the icon object is set, a previously set one will be deleted.
17430 * If you want to keep that old content object, use the
17431 * elm_slider_icon_unset() function.
17433 * @warning If the object being set does not have minimum size hints set,
17434 * it won't get properly displayed.
17437 * @deprecated use elm_object_content_set() instead.
17439 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17442 * Unset an icon set on a given slider widget.
17444 * @param obj The slider object.
17445 * @return The icon object that was being used, if any was set, or
17446 * @c NULL, otherwise (and on errors).
17448 * On horizontal mode, icon is placed at left, and on vertical mode,
17451 * This call will unparent and return the icon object which was set
17452 * for this widget, previously, on success.
17454 * @see elm_slider_icon_set() for more details
17455 * @see elm_slider_icon_get()
17456 * @deprecated use elm_object_content_unset() instead.
17460 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17463 * Retrieve the icon object set for a given slider widget.
17465 * @param obj The slider object.
17466 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17467 * otherwise (and on errors).
17469 * On horizontal mode, icon is placed at left, and on vertical mode,
17472 * @see elm_slider_icon_set() for more details
17473 * @see elm_slider_icon_unset()
17477 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17480 * Set the end object of the slider object.
17482 * @param obj The slider object.
17483 * @param end The end object.
17485 * On horizontal mode, end is placed at left, and on vertical mode,
17486 * placed at bottom.
17488 * @note Once the icon object is set, a previously set one will be deleted.
17489 * If you want to keep that old content object, use the
17490 * elm_slider_end_unset() function.
17492 * @warning If the object being set does not have minimum size hints set,
17493 * it won't get properly displayed.
17497 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17500 * Unset an end object set on a given slider widget.
17502 * @param obj The slider object.
17503 * @return The end object that was being used, if any was set, or
17504 * @c NULL, otherwise (and on errors).
17506 * On horizontal mode, end is placed at left, and on vertical mode,
17507 * placed at bottom.
17509 * This call will unparent and return the icon object which was set
17510 * for this widget, previously, on success.
17512 * @see elm_slider_end_set() for more details.
17513 * @see elm_slider_end_get()
17517 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17520 * Retrieve the end object set for a given slider widget.
17522 * @param obj The slider object.
17523 * @return The end object's handle, if @p obj had one set, or @c NULL,
17524 * otherwise (and on errors).
17526 * On horizontal mode, icon is placed at right, and on vertical mode,
17527 * placed at bottom.
17529 * @see elm_slider_end_set() for more details.
17530 * @see elm_slider_end_unset()
17534 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17537 * Set the (exact) length of the bar region of a given slider widget.
17539 * @param obj The slider object.
17540 * @param size The length of the slider's bar region.
17542 * This sets the minimum width (when in horizontal mode) or height
17543 * (when in vertical mode) of the actual bar area of the slider
17544 * @p obj. This in turn affects the object's minimum size. Use
17545 * this when you're not setting other size hints expanding on the
17546 * given direction (like weight and alignment hints) and you would
17547 * like it to have a specific size.
17549 * @note Icon, end, label, indicator and unit text around @p obj
17550 * will require their
17551 * own space, which will make @p obj to require more the @p size,
17554 * @see elm_slider_span_size_get()
17558 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17561 * Get the length set for the bar region of a given slider widget
17563 * @param obj The slider object.
17564 * @return The length of the slider's bar region.
17566 * If that size was not set previously, with
17567 * elm_slider_span_size_set(), this call will return @c 0.
17571 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17574 * Set the format string for the unit label.
17576 * @param obj The slider object.
17577 * @param format The format string for the unit display.
17579 * Unit label is displayed all the time, if set, after slider's bar.
17580 * In horizontal mode, at right and in vertical mode, at bottom.
17582 * If @c NULL, unit label won't be visible. If not it sets the format
17583 * string for the label text. To the label text is provided a floating point
17584 * value, so the label text can display up to 1 floating point value.
17585 * Note that this is optional.
17587 * Use a format string such as "%1.2f meters" for example, and it will
17588 * display values like: "3.14 meters" for a value equal to 3.14159.
17590 * Default is unit label disabled.
17592 * @see elm_slider_indicator_format_get()
17596 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17599 * Get the unit label format of the slider.
17601 * @param obj The slider object.
17602 * @return The unit label format string in UTF-8.
17604 * Unit label is displayed all the time, if set, after slider's bar.
17605 * In horizontal mode, at right and in vertical mode, at bottom.
17607 * @see elm_slider_unit_format_set() for more
17608 * information on how this works.
17612 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17615 * Set the format string for the indicator label.
17617 * @param obj The slider object.
17618 * @param indicator The format string for the indicator display.
17620 * The slider may display its value somewhere else then unit label,
17621 * for example, above the slider knob that is dragged around. This function
17622 * sets the format string used for this.
17624 * If @c NULL, indicator label won't be visible. If not it sets the format
17625 * string for the label text. To the label text is provided a floating point
17626 * value, so the label text can display up to 1 floating point value.
17627 * Note that this is optional.
17629 * Use a format string such as "%1.2f meters" for example, and it will
17630 * display values like: "3.14 meters" for a value equal to 3.14159.
17632 * Default is indicator label disabled.
17634 * @see elm_slider_indicator_format_get()
17638 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17641 * Get the indicator label format of the slider.
17643 * @param obj The slider object.
17644 * @return The indicator label format string in UTF-8.
17646 * The slider may display its value somewhere else then unit label,
17647 * for example, above the slider knob that is dragged around. This function
17648 * gets the format string used for this.
17650 * @see elm_slider_indicator_format_set() for more
17651 * information on how this works.
17655 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17658 * Set the format function pointer for the indicator label
17660 * @param obj The slider object.
17661 * @param func The indicator format function.
17662 * @param free_func The freeing function for the format string.
17664 * Set the callback function to format the indicator string.
17666 * @see elm_slider_indicator_format_set() for more info on how this works.
17670 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);
17673 * Set the format function pointer for the units label
17675 * @param obj The slider object.
17676 * @param func The units format function.
17677 * @param free_func The freeing function for the format string.
17679 * Set the callback function to format the indicator string.
17681 * @see elm_slider_units_format_set() for more info on how this works.
17685 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);
17688 * Set the orientation of a given slider widget.
17690 * @param obj The slider object.
17691 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17692 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17694 * Use this function to change how your slider is to be
17695 * disposed: vertically or horizontally.
17697 * By default it's displayed horizontally.
17699 * @see elm_slider_horizontal_get()
17703 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17706 * Retrieve the orientation of a given slider widget
17708 * @param obj The slider object.
17709 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17710 * @c EINA_FALSE if it's @b vertical (and on errors).
17712 * @see elm_slider_horizontal_set() for more details.
17716 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17719 * Set the minimum and maximum values for the slider.
17721 * @param obj The slider object.
17722 * @param min The minimum value.
17723 * @param max The maximum value.
17725 * Define the allowed range of values to be selected by the user.
17727 * If actual value is less than @p min, it will be updated to @p min. If it
17728 * is bigger then @p max, will be updated to @p max. Actual value can be
17729 * get with elm_slider_value_get().
17731 * By default, min is equal to 0.0, and max is equal to 1.0.
17733 * @warning Maximum must be greater than minimum, otherwise behavior
17736 * @see elm_slider_min_max_get()
17740 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17743 * Get the minimum and maximum values of the slider.
17745 * @param obj The slider object.
17746 * @param min Pointer where to store the minimum value.
17747 * @param max Pointer where to store the maximum value.
17749 * @note If only one value is needed, the other pointer can be passed
17752 * @see elm_slider_min_max_set() for details.
17756 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17759 * Set the value the slider displays.
17761 * @param obj The slider object.
17762 * @param val The value to be displayed.
17764 * Value will be presented on the unit label following format specified with
17765 * elm_slider_unit_format_set() and on indicator with
17766 * elm_slider_indicator_format_set().
17768 * @warning The value must to be between min and max values. This values
17769 * are set by elm_slider_min_max_set().
17771 * @see elm_slider_value_get()
17772 * @see elm_slider_unit_format_set()
17773 * @see elm_slider_indicator_format_set()
17774 * @see elm_slider_min_max_set()
17778 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17781 * Get the value displayed by the spinner.
17783 * @param obj The spinner object.
17784 * @return The value displayed.
17786 * @see elm_spinner_value_set() for details.
17790 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17793 * Invert a given slider widget's displaying values order
17795 * @param obj The slider object.
17796 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17797 * @c EINA_FALSE to bring it back to default, non-inverted values.
17799 * A slider may be @b inverted, in which state it gets its
17800 * values inverted, with high vales being on the left or top and
17801 * low values on the right or bottom, as opposed to normally have
17802 * the low values on the former and high values on the latter,
17803 * respectively, for horizontal and vertical modes.
17805 * @see elm_slider_inverted_get()
17809 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17812 * Get whether a given slider widget's displaying values are
17815 * @param obj The slider object.
17816 * @return @c EINA_TRUE, if @p obj has inverted values,
17817 * @c EINA_FALSE otherwise (and on errors).
17819 * @see elm_slider_inverted_set() for more details.
17823 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17826 * Set whether to enlarge slider indicator (augmented knob) or not.
17828 * @param obj The slider object.
17829 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17830 * let the knob always at default size.
17832 * By default, indicator will be bigger while dragged by the user.
17834 * @warning It won't display values set with
17835 * elm_slider_indicator_format_set() if you disable indicator.
17839 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17842 * Get whether a given slider widget's enlarging indicator or not.
17844 * @param obj The slider object.
17845 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17846 * @c EINA_FALSE otherwise (and on errors).
17848 * @see elm_slider_indicator_show_set() for details.
17852 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17859 * @addtogroup Actionslider Actionslider
17861 * @image html img/widget/actionslider/preview-00.png
17862 * @image latex img/widget/actionslider/preview-00.eps
17864 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17865 * properties. The user drags and releases the indicator, to choose a label.
17867 * Labels occupy the following positions.
17872 * Positions can be enabled or disabled.
17874 * Magnets can be set on the above positions.
17876 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17878 * @note By default all positions are set as enabled.
17880 * Signals that you can add callbacks for are:
17882 * "selected" - when user selects an enabled position (the label is passed
17885 * "pos_changed" - when the indicator reaches any of the positions("left",
17886 * "right" or "center").
17888 * See an example of actionslider usage @ref actionslider_example_page "here"
17892 typedef enum _Elm_Actionslider_Indicator_Pos
17894 ELM_ACTIONSLIDER_INDICATOR_NONE,
17895 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17896 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17897 ELM_ACTIONSLIDER_INDICATOR_CENTER
17898 } Elm_Actionslider_Indicator_Pos;
17900 typedef enum _Elm_Actionslider_Magnet_Pos
17902 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17903 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17904 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17905 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17906 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17907 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17908 } Elm_Actionslider_Magnet_Pos;
17910 typedef enum _Elm_Actionslider_Label_Pos
17912 ELM_ACTIONSLIDER_LABEL_LEFT,
17913 ELM_ACTIONSLIDER_LABEL_RIGHT,
17914 ELM_ACTIONSLIDER_LABEL_CENTER,
17915 ELM_ACTIONSLIDER_LABEL_BUTTON
17916 } Elm_Actionslider_Label_Pos;
17918 /* smart callbacks called:
17919 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17923 * Add a new actionslider to the parent.
17925 * @param parent The parent object
17926 * @return The new actionslider object or NULL if it cannot be created
17928 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17931 * Set actionslider label.
17933 * @param[in] obj The actionslider object
17934 * @param[in] pos The position of the label.
17935 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17936 * @param label The label which is going to be set.
17938 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17940 * Get actionslider labels.
17942 * @param obj The actionslider object
17943 * @param left_label A char** to place the left_label of @p obj into.
17944 * @param center_label A char** to place the center_label of @p obj into.
17945 * @param right_label A char** to place the right_label of @p obj into.
17947 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);
17949 * Get actionslider selected label.
17951 * @param obj The actionslider object
17952 * @return The selected label
17954 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17956 * Set actionslider indicator position.
17958 * @param obj The actionslider object.
17959 * @param pos The position of the indicator.
17961 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17963 * Get actionslider indicator position.
17965 * @param obj The actionslider object.
17966 * @return The position of the indicator.
17968 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17970 * Set actionslider magnet position. To make multiple positions magnets @c or
17971 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17973 * @param obj The actionslider object.
17974 * @param pos Bit mask indicating the magnet positions.
17976 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17978 * Get actionslider magnet position.
17980 * @param obj The actionslider object.
17981 * @return The positions with magnet property.
17983 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17985 * Set actionslider enabled position. To set multiple positions as enabled @c or
17986 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17988 * @note All the positions are enabled by default.
17990 * @param obj The actionslider object.
17991 * @param pos Bit mask indicating the enabled positions.
17993 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17995 * Get actionslider enabled position.
17997 * @param obj The actionslider object.
17998 * @return The enabled positions.
18000 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18002 * Set the label used on the indicator.
18004 * @param obj The actionslider object
18005 * @param label The label to be set on the indicator.
18006 * @deprecated use elm_object_text_set() instead.
18008 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18010 * Get the label used on the indicator object.
18012 * @param obj The actionslider object
18013 * @return The indicator label
18014 * @deprecated use elm_object_text_get() instead.
18016 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18019 * Hold actionslider object movement.
18021 * @param[in] obj The actionslider object
18022 * @param[in] flag Actionslider hold/release
18023 * (EINA_TURE = hold/EIN_FALSE = release)
18025 * @ingroup Actionslider
18027 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18035 * @defgroup Genlist Genlist
18037 * @image html img/widget/genlist/preview-00.png
18038 * @image latex img/widget/genlist/preview-00.eps
18039 * @image html img/genlist.png
18040 * @image latex img/genlist.eps
18042 * This widget aims to have more expansive list than the simple list in
18043 * Elementary that could have more flexible items and allow many more entries
18044 * while still being fast and low on memory usage. At the same time it was
18045 * also made to be able to do tree structures. But the price to pay is more
18046 * complexity when it comes to usage. If all you want is a simple list with
18047 * icons and a single label, use the normal @ref List object.
18049 * Genlist has a fairly large API, mostly because it's relatively complex,
18050 * trying to be both expansive, powerful and efficient. First we will begin
18051 * an overview on the theory behind genlist.
18053 * @section Genlist_Item_Class Genlist item classes - creating items
18055 * In order to have the ability to add and delete items on the fly, genlist
18056 * implements a class (callback) system where the application provides a
18057 * structure with information about that type of item (genlist may contain
18058 * multiple different items with different classes, states and styles).
18059 * Genlist will call the functions in this struct (methods) when an item is
18060 * "realized" (i.e., created dynamically, while the user is scrolling the
18061 * grid). All objects will simply be deleted when no longer needed with
18062 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18063 * following members:
18064 * - @c item_style - This is a constant string and simply defines the name
18065 * of the item style. It @b must be specified and the default should be @c
18068 * - @c func - A struct with pointers to functions that will be called when
18069 * an item is going to be actually created. All of them receive a @c data
18070 * parameter that will point to the same data passed to
18071 * elm_genlist_item_append() and related item creation functions, and a @c
18072 * obj parameter that points to the genlist object itself.
18074 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18075 * state_get and @c del. The 3 first functions also receive a @c part
18076 * parameter described below. A brief description of these functions follows:
18078 * - @c label_get - The @c part parameter is the name string of one of the
18079 * existing text parts in the Edje group implementing the item's theme.
18080 * This function @b must return a strdup'()ed string, as the caller will
18081 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18082 * - @c content_get - The @c part parameter is the name string of one of the
18083 * existing (content) swallow parts in the Edje group implementing the item's
18084 * theme. It must return @c NULL, when no content is desired, or a valid
18085 * object handle, otherwise. The object will be deleted by the genlist on
18086 * its deletion or when the item is "unrealized". See
18087 * #Elm_Genlist_Item_Icon_Get_Cb.
18088 * - @c func.state_get - The @c part parameter is the name string of one of
18089 * the state parts in the Edje group implementing the item's theme. Return
18090 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18091 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18092 * and @c "elm" as "emission" and "source" arguments, respectively, when
18093 * the state is true (the default is false), where @c XXX is the name of
18094 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18095 * - @c func.del - This is intended for use when genlist items are deleted,
18096 * so any data attached to the item (e.g. its data parameter on creation)
18097 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18099 * available item styles:
18101 * - default_style - The text part is a textblock
18103 * @image html img/widget/genlist/preview-04.png
18104 * @image latex img/widget/genlist/preview-04.eps
18108 * @image html img/widget/genlist/preview-01.png
18109 * @image latex img/widget/genlist/preview-01.eps
18111 * - icon_top_text_bottom
18113 * @image html img/widget/genlist/preview-02.png
18114 * @image latex img/widget/genlist/preview-02.eps
18118 * @image html img/widget/genlist/preview-03.png
18119 * @image latex img/widget/genlist/preview-03.eps
18121 * @section Genlist_Items Structure of items
18123 * An item in a genlist can have 0 or more text labels (they can be regular
18124 * text or textblock Evas objects - that's up to the style to determine), 0
18125 * or more contents (which are simply objects swallowed into the genlist item's
18126 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18127 * behavior left to the user to define. The Edje part names for each of
18128 * these properties will be looked up, in the theme file for the genlist,
18129 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18130 * "states", respectively. For each of those properties, if more than one
18131 * part is provided, they must have names listed separated by spaces in the
18132 * data fields. For the default genlist item theme, we have @b one label
18133 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18134 * "elm.swallow.end") and @b no state parts.
18136 * A genlist item may be at one of several styles. Elementary provides one
18137 * by default - "default", but this can be extended by system or application
18138 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18141 * @section Genlist_Manipulation Editing and Navigating
18143 * Items can be added by several calls. All of them return a @ref
18144 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18145 * They all take a data parameter that is meant to be used for a handle to
18146 * the applications internal data (eg the struct with the original item
18147 * data). The parent parameter is the parent genlist item this belongs to if
18148 * it is a tree or an indexed group, and NULL if there is no parent. The
18149 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18150 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18151 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18152 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18153 * is set then this item is group index item that is displayed at the top
18154 * until the next group comes. The func parameter is a convenience callback
18155 * that is called when the item is selected and the data parameter will be
18156 * the func_data parameter, obj be the genlist object and event_info will be
18157 * the genlist item.
18159 * elm_genlist_item_append() adds an item to the end of the list, or if
18160 * there is a parent, to the end of all the child items of the parent.
18161 * elm_genlist_item_prepend() is the same but adds to the beginning of
18162 * the list or children list. elm_genlist_item_insert_before() inserts at
18163 * item before another item and elm_genlist_item_insert_after() inserts after
18164 * the indicated item.
18166 * The application can clear the list with elm_genlist_clear() which deletes
18167 * all the items in the list and elm_genlist_item_del() will delete a specific
18168 * item. elm_genlist_item_subitems_clear() will clear all items that are
18169 * children of the indicated parent item.
18171 * To help inspect list items you can jump to the item at the top of the list
18172 * with elm_genlist_first_item_get() which will return the item pointer, and
18173 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18174 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18175 * and previous items respectively relative to the indicated item. Using
18176 * these calls you can walk the entire item list/tree. Note that as a tree
18177 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18178 * let you know which item is the parent (and thus know how to skip them if
18181 * @section Genlist_Muti_Selection Multi-selection
18183 * If the application wants multiple items to be able to be selected,
18184 * elm_genlist_multi_select_set() can enable this. If the list is
18185 * single-selection only (the default), then elm_genlist_selected_item_get()
18186 * will return the selected item, if any, or NULL I none is selected. If the
18187 * list is multi-select then elm_genlist_selected_items_get() will return a
18188 * list (that is only valid as long as no items are modified (added, deleted,
18189 * selected or unselected)).
18191 * @section Genlist_Usage_Hints Usage hints
18193 * There are also convenience functions. elm_genlist_item_genlist_get() will
18194 * return the genlist object the item belongs to. elm_genlist_item_show()
18195 * will make the scroller scroll to show that specific item so its visible.
18196 * elm_genlist_item_data_get() returns the data pointer set by the item
18197 * creation functions.
18199 * If an item changes (state of boolean changes, label or contents change),
18200 * then use elm_genlist_item_update() to have genlist update the item with
18201 * the new state. Genlist will re-realize the item thus call the functions
18202 * in the _Elm_Genlist_Item_Class for that item.
18204 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18205 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18206 * to expand/contract an item and get its expanded state, use
18207 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18208 * again to make an item disabled (unable to be selected and appear
18209 * differently) use elm_genlist_item_disabled_set() to set this and
18210 * elm_genlist_item_disabled_get() to get the disabled state.
18212 * In general to indicate how the genlist should expand items horizontally to
18213 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18214 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18215 * mode means that if items are too wide to fit, the scroller will scroll
18216 * horizontally. Otherwise items are expanded to fill the width of the
18217 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18218 * to the viewport width and limited to that size. This can be combined with
18219 * a different style that uses edjes' ellipsis feature (cutting text off like
18222 * Items will only call their selection func and callback when first becoming
18223 * selected. Any further clicks will do nothing, unless you enable always
18224 * select with elm_genlist_always_select_mode_set(). This means even if
18225 * selected, every click will make the selected callbacks be called.
18226 * elm_genlist_no_select_mode_set() will turn off the ability to select
18227 * items entirely and they will neither appear selected nor call selected
18228 * callback functions.
18230 * Remember that you can create new styles and add your own theme augmentation
18231 * per application with elm_theme_extension_add(). If you absolutely must
18232 * have a specific style that overrides any theme the user or system sets up
18233 * you can use elm_theme_overlay_add() to add such a file.
18235 * @section Genlist_Implementation Implementation
18237 * Evas tracks every object you create. Every time it processes an event
18238 * (mouse move, down, up etc.) it needs to walk through objects and find out
18239 * what event that affects. Even worse every time it renders display updates,
18240 * in order to just calculate what to re-draw, it needs to walk through many
18241 * many many objects. Thus, the more objects you keep active, the more
18242 * overhead Evas has in just doing its work. It is advisable to keep your
18243 * active objects to the minimum working set you need. Also remember that
18244 * object creation and deletion carries an overhead, so there is a
18245 * middle-ground, which is not easily determined. But don't keep massive lists
18246 * of objects you can't see or use. Genlist does this with list objects. It
18247 * creates and destroys them dynamically as you scroll around. It groups them
18248 * into blocks so it can determine the visibility etc. of a whole block at
18249 * once as opposed to having to walk the whole list. This 2-level list allows
18250 * for very large numbers of items to be in the list (tests have used up to
18251 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18252 * may be different sizes, every item added needs to be calculated as to its
18253 * size and thus this presents a lot of overhead on populating the list, this
18254 * genlist employs a queue. Any item added is queued and spooled off over
18255 * time, actually appearing some time later, so if your list has many members
18256 * you may find it takes a while for them to all appear, with your process
18257 * consuming a lot of CPU while it is busy spooling.
18259 * Genlist also implements a tree structure, but it does so with callbacks to
18260 * the application, with the application filling in tree structures when
18261 * requested (allowing for efficient building of a very deep tree that could
18262 * even be used for file-management). See the above smart signal callbacks for
18265 * @section Genlist_Smart_Events Genlist smart events
18267 * Signals that you can add callbacks for are:
18268 * - @c "activated" - The user has double-clicked or pressed
18269 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18270 * item that was activated.
18271 * - @c "clicked,double" - The user has double-clicked an item. The @c
18272 * event_info parameter is the item that was double-clicked.
18273 * - @c "selected" - This is called when a user has made an item selected.
18274 * The event_info parameter is the genlist item that was selected.
18275 * - @c "unselected" - This is called when a user has made an item
18276 * unselected. The event_info parameter is the genlist item that was
18278 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18279 * called and the item is now meant to be expanded. The event_info
18280 * parameter is the genlist item that was indicated to expand. It is the
18281 * job of this callback to then fill in the child items.
18282 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18283 * called and the item is now meant to be contracted. The event_info
18284 * parameter is the genlist item that was indicated to contract. It is the
18285 * job of this callback to then delete the child items.
18286 * - @c "expand,request" - This is called when a user has indicated they want
18287 * to expand a tree branch item. The callback should decide if the item can
18288 * expand (has any children) and then call elm_genlist_item_expanded_set()
18289 * appropriately to set the state. The event_info parameter is the genlist
18290 * item that was indicated to expand.
18291 * - @c "contract,request" - This is called when a user has indicated they
18292 * want to contract a tree branch item. The callback should decide if the
18293 * item can contract (has any children) and then call
18294 * elm_genlist_item_expanded_set() appropriately to set the state. The
18295 * event_info parameter is the genlist item that was indicated to contract.
18296 * - @c "realized" - This is called when the item in the list is created as a
18297 * real evas object. event_info parameter is the genlist item that was
18298 * created. The object may be deleted at any time, so it is up to the
18299 * caller to not use the object pointer from elm_genlist_item_object_get()
18300 * in a way where it may point to freed objects.
18301 * - @c "unrealized" - This is called just before an item is unrealized.
18302 * After this call content objects provided will be deleted and the item
18303 * object itself delete or be put into a floating cache.
18304 * - @c "drag,start,up" - This is called when the item in the list has been
18305 * dragged (not scrolled) up.
18306 * - @c "drag,start,down" - This is called when the item in the list has been
18307 * dragged (not scrolled) down.
18308 * - @c "drag,start,left" - This is called when the item in the list has been
18309 * dragged (not scrolled) left.
18310 * - @c "drag,start,right" - This is called when the item in the list has
18311 * been dragged (not scrolled) right.
18312 * - @c "drag,stop" - This is called when the item in the list has stopped
18314 * - @c "drag" - This is called when the item in the list is being dragged.
18315 * - @c "longpressed" - This is called when the item is pressed for a certain
18316 * amount of time. By default it's 1 second.
18317 * - @c "scroll,anim,start" - This is called when scrolling animation has
18319 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18321 * - @c "scroll,drag,start" - This is called when dragging the content has
18323 * - @c "scroll,drag,stop" - This is called when dragging the content has
18325 * - @c "edge,top" - This is called when the genlist is scrolled until
18327 * - @c "edge,bottom" - This is called when the genlist is scrolled
18328 * until the bottom edge.
18329 * - @c "edge,left" - This is called when the genlist is scrolled
18330 * until the left edge.
18331 * - @c "edge,right" - This is called when the genlist is scrolled
18332 * until the right edge.
18333 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18335 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18337 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18339 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18341 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18342 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18343 * multi-touch pinched in.
18344 * - @c "swipe" - This is called when the genlist is swiped.
18345 * - @c "moved" - This is called when a genlist item is moved.
18346 * - @c "language,changed" - This is called when the program's language is
18349 * @section Genlist_Examples Examples
18351 * Here is a list of examples that use the genlist, trying to show some of
18352 * its capabilities:
18353 * - @ref genlist_example_01
18354 * - @ref genlist_example_02
18355 * - @ref genlist_example_03
18356 * - @ref genlist_example_04
18357 * - @ref genlist_example_05
18361 * @addtogroup Genlist
18366 * @enum _Elm_Genlist_Item_Flags
18367 * @typedef Elm_Genlist_Item_Flags
18369 * Defines if the item is of any special type (has subitems or it's the
18370 * index of a group), or is just a simple item.
18374 typedef enum _Elm_Genlist_Item_Flags
18376 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18377 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18378 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18379 } Elm_Genlist_Item_Flags;
18380 typedef enum _Elm_Genlist_Item_Field_Flags
18382 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18383 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18384 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18385 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18386 } Elm_Genlist_Item_Field_Flags;
18387 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18388 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18389 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18390 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18391 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18392 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18393 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18394 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18397 * @struct _Elm_Genlist_Item_Class
18399 * Genlist item class definition structs.
18401 * This struct contains the style and fetching functions that will define the
18402 * contents of each item.
18404 * @see @ref Genlist_Item_Class
18406 struct _Elm_Genlist_Item_Class
18408 const char *item_style;
18410 GenlistItemLabelGetFunc label_get;
18411 GenlistItemIconGetFunc icon_get;
18412 GenlistItemStateGetFunc state_get;
18413 GenlistItemDelFunc del;
18414 GenlistItemMovedFunc moved;
18416 const char *edit_item_style;
18417 const char *mode_item_style;
18419 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18421 * Add a new genlist widget to the given parent Elementary
18422 * (container) object
18424 * @param parent The parent object
18425 * @return a new genlist widget handle or @c NULL, on errors
18427 * This function inserts a new genlist widget on the canvas.
18429 * @see elm_genlist_item_append()
18430 * @see elm_genlist_item_del()
18431 * @see elm_genlist_clear()
18435 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18437 * Remove all items from a given genlist widget.
18439 * @param obj The genlist object
18441 * This removes (and deletes) all items in @p obj, leaving it empty.
18443 * @see elm_genlist_item_del(), to remove just one item.
18447 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18449 * Enable or disable multi-selection in the genlist
18451 * @param obj The genlist object
18452 * @param multi Multi-select enable/disable. Default is disabled.
18454 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18455 * the list. This allows more than 1 item to be selected. To retrieve the list
18456 * of selected items, use elm_genlist_selected_items_get().
18458 * @see elm_genlist_selected_items_get()
18459 * @see elm_genlist_multi_select_get()
18463 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18465 * Gets if multi-selection in genlist is enabled or disabled.
18467 * @param obj The genlist object
18468 * @return Multi-select enabled/disabled
18469 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18471 * @see elm_genlist_multi_select_set()
18475 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18477 * This sets the horizontal stretching mode.
18479 * @param obj The genlist object
18480 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18482 * This sets the mode used for sizing items horizontally. Valid modes
18483 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18484 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18485 * the scroller will scroll horizontally. Otherwise items are expanded
18486 * to fill the width of the viewport of the scroller. If it is
18487 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18488 * limited to that size.
18490 * @see elm_genlist_horizontal_get()
18494 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18496 * Gets the horizontal stretching mode.
18498 * @param obj The genlist object
18499 * @return The mode to use
18500 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18502 * @see elm_genlist_horizontal_set()
18506 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18508 * Set the always select mode.
18510 * @param obj The genlist object
18511 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18512 * EINA_FALSE = off). Default is @c EINA_FALSE.
18514 * Items will only call their selection func and callback when first
18515 * becoming selected. Any further clicks will do nothing, unless you
18516 * enable always select with elm_genlist_always_select_mode_set().
18517 * This means that, even if selected, every click will make the selected
18518 * callbacks be called.
18520 * @see elm_genlist_always_select_mode_get()
18524 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18526 * Get the always select mode.
18528 * @param obj The genlist object
18529 * @return The always select mode
18530 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18532 * @see elm_genlist_always_select_mode_set()
18536 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18538 * Enable/disable the no select mode.
18540 * @param obj The genlist object
18541 * @param no_select The no select mode
18542 * (EINA_TRUE = on, EINA_FALSE = off)
18544 * This will turn off the ability to select items entirely and they
18545 * will neither appear selected nor call selected callback functions.
18547 * @see elm_genlist_no_select_mode_get()
18551 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18553 * Gets whether the no select mode is enabled.
18555 * @param obj The genlist object
18556 * @return The no select mode
18557 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18559 * @see elm_genlist_no_select_mode_set()
18563 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18565 * Enable/disable compress mode.
18567 * @param obj The genlist object
18568 * @param compress The compress mode
18569 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18571 * This will enable the compress mode where items are "compressed"
18572 * horizontally to fit the genlist scrollable viewport width. This is
18573 * special for genlist. Do not rely on
18574 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18575 * work as genlist needs to handle it specially.
18577 * @see elm_genlist_compress_mode_get()
18581 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18583 * Get whether the compress mode is enabled.
18585 * @param obj The genlist object
18586 * @return The compress mode
18587 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18589 * @see elm_genlist_compress_mode_set()
18593 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18595 * Enable/disable height-for-width mode.
18597 * @param obj The genlist object
18598 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18599 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18601 * With height-for-width mode the item width will be fixed (restricted
18602 * to a minimum of) to the list width when calculating its size in
18603 * order to allow the height to be calculated based on it. This allows,
18604 * for instance, text block to wrap lines if the Edje part is
18605 * configured with "text.min: 0 1".
18607 * @note This mode will make list resize slower as it will have to
18608 * recalculate every item height again whenever the list width
18611 * @note When height-for-width mode is enabled, it also enables
18612 * compress mode (see elm_genlist_compress_mode_set()) and
18613 * disables homogeneous (see elm_genlist_homogeneous_set()).
18617 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18619 * Get whether the height-for-width mode is enabled.
18621 * @param obj The genlist object
18622 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18627 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18629 * Enable/disable horizontal and vertical bouncing effect.
18631 * @param obj The genlist object
18632 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18633 * EINA_FALSE = off). Default is @c EINA_FALSE.
18634 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18635 * EINA_FALSE = off). Default is @c EINA_TRUE.
18637 * This will enable or disable the scroller bouncing effect for the
18638 * genlist. See elm_scroller_bounce_set() for details.
18640 * @see elm_scroller_bounce_set()
18641 * @see elm_genlist_bounce_get()
18645 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18647 * Get whether the horizontal and vertical bouncing effect is enabled.
18649 * @param obj The genlist object
18650 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18652 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18655 * @see elm_genlist_bounce_set()
18659 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18661 * Enable/disable homogenous mode.
18663 * @param obj The genlist object
18664 * @param homogeneous Assume the items within the genlist are of the
18665 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18668 * This will enable the homogeneous mode where items are of the same
18669 * height and width so that genlist may do the lazy-loading at its
18670 * maximum (which increases the performance for scrolling the list). This
18671 * implies 'compressed' mode.
18673 * @see elm_genlist_compress_mode_set()
18674 * @see elm_genlist_homogeneous_get()
18678 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18680 * Get whether the homogenous mode is enabled.
18682 * @param obj The genlist object
18683 * @return Assume the items within the genlist are of the same height
18684 * and width (EINA_TRUE = on, EINA_FALSE = off)
18686 * @see elm_genlist_homogeneous_set()
18690 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18692 * Set the maximum number of items within an item block
18694 * @param obj The genlist object
18695 * @param n Maximum number of items within an item block. Default is 32.
18697 * This will configure the block count to tune to the target with
18698 * particular performance matrix.
18700 * A block of objects will be used to reduce the number of operations due to
18701 * many objects in the screen. It can determine the visibility, or if the
18702 * object has changed, it theme needs to be updated, etc. doing this kind of
18703 * calculation to the entire block, instead of per object.
18705 * The default value for the block count is enough for most lists, so unless
18706 * you know you will have a lot of objects visible in the screen at the same
18707 * time, don't try to change this.
18709 * @see elm_genlist_block_count_get()
18710 * @see @ref Genlist_Implementation
18714 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18716 * Get the maximum number of items within an item block
18718 * @param obj The genlist object
18719 * @return Maximum number of items within an item block
18721 * @see elm_genlist_block_count_set()
18725 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18727 * Set the timeout in seconds for the longpress event.
18729 * @param obj The genlist object
18730 * @param timeout timeout in seconds. Default is 1.
18732 * This option will change how long it takes to send an event "longpressed"
18733 * after the mouse down signal is sent to the list. If this event occurs, no
18734 * "clicked" event will be sent.
18736 * @see elm_genlist_longpress_timeout_set()
18740 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18742 * Get the timeout in seconds for the longpress event.
18744 * @param obj The genlist object
18745 * @return timeout in seconds
18747 * @see elm_genlist_longpress_timeout_get()
18751 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18753 * Append a new item in a given genlist widget.
18755 * @param obj The genlist object
18756 * @param itc The item class for the item
18757 * @param data The item data
18758 * @param parent The parent item, or NULL if none
18759 * @param flags Item flags
18760 * @param func Convenience function called when the item is selected
18761 * @param func_data Data passed to @p func above.
18762 * @return A handle to the item added or @c NULL if not possible
18764 * This adds the given item to the end of the list or the end of
18765 * the children list if the @p parent is given.
18767 * @see elm_genlist_item_prepend()
18768 * @see elm_genlist_item_insert_before()
18769 * @see elm_genlist_item_insert_after()
18770 * @see elm_genlist_item_del()
18774 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);
18776 * Prepend a new item in a given genlist widget.
18778 * @param obj The genlist object
18779 * @param itc The item class for the item
18780 * @param data The item data
18781 * @param parent The parent item, or NULL if none
18782 * @param flags Item flags
18783 * @param func Convenience function called when the item is selected
18784 * @param func_data Data passed to @p func above.
18785 * @return A handle to the item added or NULL if not possible
18787 * This adds an item to the beginning of the list or beginning of the
18788 * children of the parent if given.
18790 * @see elm_genlist_item_append()
18791 * @see elm_genlist_item_insert_before()
18792 * @see elm_genlist_item_insert_after()
18793 * @see elm_genlist_item_del()
18797 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);
18799 * Insert an item before another in a genlist widget
18801 * @param obj The genlist object
18802 * @param itc The item class for the item
18803 * @param data The item data
18804 * @param before The item to place this new one before.
18805 * @param flags Item flags
18806 * @param func Convenience function called when the item is selected
18807 * @param func_data Data passed to @p func above.
18808 * @return A handle to the item added or @c NULL if not possible
18810 * This inserts an item before another in the list. It will be in the
18811 * same tree level or group as the item it is inserted before.
18813 * @see elm_genlist_item_append()
18814 * @see elm_genlist_item_prepend()
18815 * @see elm_genlist_item_insert_after()
18816 * @see elm_genlist_item_del()
18820 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);
18822 * Insert an item after another in a genlist widget
18824 * @param obj The genlist object
18825 * @param itc The item class for the item
18826 * @param data The item data
18827 * @param after The item to place this new one after.
18828 * @param flags Item flags
18829 * @param func Convenience function called when the item is selected
18830 * @param func_data Data passed to @p func above.
18831 * @return A handle to the item added or @c NULL if not possible
18833 * This inserts an item after another in the list. It will be in the
18834 * same tree level or group as the item it is inserted after.
18836 * @see elm_genlist_item_append()
18837 * @see elm_genlist_item_prepend()
18838 * @see elm_genlist_item_insert_before()
18839 * @see elm_genlist_item_del()
18843 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);
18845 * Insert a new item into the sorted genlist object
18847 * @param obj The genlist object
18848 * @param itc The item class for the item
18849 * @param data The item data
18850 * @param parent The parent item, or NULL if none
18851 * @param flags Item flags
18852 * @param comp The function called for the sort
18853 * @param func Convenience function called when item selected
18854 * @param func_data Data passed to @p func above.
18855 * @return A handle to the item added or NULL if not possible
18859 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);
18860 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);
18861 /* operations to retrieve existing items */
18863 * Get the selectd item in the genlist.
18865 * @param obj The genlist object
18866 * @return The selected item, or NULL if none is selected.
18868 * This gets the selected item in the list (if multi-selection is enabled, only
18869 * the item that was first selected in the list is returned - which is not very
18870 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18873 * If no item is selected, NULL is returned.
18875 * @see elm_genlist_selected_items_get()
18879 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18881 * Get a list of selected items in the genlist.
18883 * @param obj The genlist object
18884 * @return The list of selected items, or NULL if none are selected.
18886 * It returns a list of the selected items. This list pointer is only valid so
18887 * long as the selection doesn't change (no items are selected or unselected, or
18888 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18889 * pointers. The order of the items in this list is the order which they were
18890 * selected, i.e. the first item in this list is the first item that was
18891 * selected, and so on.
18893 * @note If not in multi-select mode, consider using function
18894 * elm_genlist_selected_item_get() instead.
18896 * @see elm_genlist_multi_select_set()
18897 * @see elm_genlist_selected_item_get()
18901 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18903 * Get the mode item style of items in the genlist
18904 * @param obj The genlist object
18905 * @return The mode item style string, or NULL if none is specified
18907 * This is a constant string and simply defines the name of the
18908 * style that will be used for mode animations. It can be
18909 * @c NULL if you don't plan to use Genlist mode. See
18910 * elm_genlist_item_mode_set() for more info.
18914 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18916 * Set the mode item style of items in the genlist
18917 * @param obj The genlist object
18918 * @param style The mode item style string, or NULL if none is desired
18920 * This is a constant string and simply defines the name of the
18921 * style that will be used for mode animations. It can be
18922 * @c NULL if you don't plan to use Genlist mode. See
18923 * elm_genlist_item_mode_set() for more info.
18927 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18929 * Get a list of realized items in genlist
18931 * @param obj The genlist object
18932 * @return The list of realized items, nor NULL if none are realized.
18934 * This returns a list of the realized items in the genlist. The list
18935 * contains Elm_Genlist_Item pointers. The list must be freed by the
18936 * caller when done with eina_list_free(). The item pointers in the
18937 * list are only valid so long as those items are not deleted or the
18938 * genlist is not deleted.
18940 * @see elm_genlist_realized_items_update()
18944 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18946 * Get the item that is at the x, y canvas coords.
18948 * @param obj The gelinst object.
18949 * @param x The input x coordinate
18950 * @param y The input y coordinate
18951 * @param posret The position relative to the item returned here
18952 * @return The item at the coordinates or NULL if none
18954 * This returns the item at the given coordinates (which are canvas
18955 * relative, not object-relative). If an item is at that coordinate,
18956 * that item handle is returned, and if @p posret is not NULL, the
18957 * integer pointed to is set to a value of -1, 0 or 1, depending if
18958 * the coordinate is on the upper portion of that item (-1), on the
18959 * middle section (0) or on the lower part (1). If NULL is returned as
18960 * an item (no item found there), then posret may indicate -1 or 1
18961 * based if the coordinate is above or below all items respectively in
18966 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);
18968 * Get the first item in the genlist
18970 * This returns the first item in the list.
18972 * @param obj The genlist object
18973 * @return The first item, or NULL if none
18977 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18979 * Get the last item in the genlist
18981 * This returns the last item in the list.
18983 * @return The last item, or NULL if none
18987 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18989 * Set the scrollbar policy
18991 * @param obj The genlist object
18992 * @param policy_h Horizontal scrollbar policy.
18993 * @param policy_v Vertical scrollbar policy.
18995 * This sets the scrollbar visibility policy for the given genlist
18996 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18997 * made visible if it is needed, and otherwise kept hidden.
18998 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18999 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19000 * respectively for the horizontal and vertical scrollbars. Default is
19001 * #ELM_SMART_SCROLLER_POLICY_AUTO
19003 * @see elm_genlist_scroller_policy_get()
19007 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19009 * Get the scrollbar policy
19011 * @param obj The genlist object
19012 * @param policy_h Pointer to store the horizontal scrollbar policy.
19013 * @param policy_v Pointer to store the vertical scrollbar policy.
19015 * @see elm_genlist_scroller_policy_set()
19019 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);
19021 * Get the @b next item in a genlist widget's internal list of items,
19022 * given a handle to one of those items.
19024 * @param item The genlist item to fetch next from
19025 * @return The item after @p item, or @c NULL if there's none (and
19028 * This returns the item placed after the @p item, on the container
19031 * @see elm_genlist_item_prev_get()
19035 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19037 * Get the @b previous item in a genlist widget's internal list of items,
19038 * given a handle to one of those items.
19040 * @param item The genlist item to fetch previous from
19041 * @return The item before @p item, or @c NULL if there's none (and
19044 * This returns the item placed before the @p item, on the container
19047 * @see elm_genlist_item_next_get()
19051 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19053 * Get the genlist object's handle which contains a given genlist
19056 * @param item The item to fetch the container from
19057 * @return The genlist (parent) object
19059 * This returns the genlist object itself that an item belongs to.
19063 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19065 * Get the parent item of the given item
19067 * @param it The item
19068 * @return The parent of the item or @c NULL if it has no parent.
19070 * This returns the item that was specified as parent of the item @p it on
19071 * elm_genlist_item_append() and insertion related functions.
19075 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19077 * Remove all sub-items (children) of the given item
19079 * @param it The item
19081 * This removes all items that are children (and their descendants) of the
19082 * given item @p it.
19084 * @see elm_genlist_clear()
19085 * @see elm_genlist_item_del()
19089 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19091 * Set whether a given genlist item is selected or not
19093 * @param it The item
19094 * @param selected Use @c EINA_TRUE, to make it selected, @c
19095 * EINA_FALSE to make it unselected
19097 * This sets the selected state of an item. If multi selection is
19098 * not enabled on the containing genlist and @p selected is @c
19099 * EINA_TRUE, any other previously selected items will get
19100 * unselected in favor of this new one.
19102 * @see elm_genlist_item_selected_get()
19106 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19108 * Get whether a given genlist item is selected or not
19110 * @param it The item
19111 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19113 * @see elm_genlist_item_selected_set() for more details
19117 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19119 * Sets the expanded state of an item.
19121 * @param it The item
19122 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19124 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19127 * The theme will respond to this change visually, and a signal "expanded" or
19128 * "contracted" will be sent from the genlist with a pointer to the item that
19129 * has been expanded/contracted.
19131 * Calling this function won't show or hide any child of this item (if it is
19132 * a parent). You must manually delete and create them on the callbacks fo
19133 * the "expanded" or "contracted" signals.
19135 * @see elm_genlist_item_expanded_get()
19139 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19141 * Get the expanded state of an item
19143 * @param it The item
19144 * @return The expanded state
19146 * This gets the expanded state of an item.
19148 * @see elm_genlist_item_expanded_set()
19152 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19154 * Get the depth of expanded item
19156 * @param it The genlist item object
19157 * @return The depth of expanded item
19161 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19163 * Set whether a given genlist item is disabled or not.
19165 * @param it The item
19166 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19167 * to enable it back.
19169 * A disabled item cannot be selected or unselected. It will also
19170 * change its appearance, to signal the user it's disabled.
19172 * @see elm_genlist_item_disabled_get()
19176 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19178 * Get whether a given genlist item is disabled or not.
19180 * @param it The item
19181 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19184 * @see elm_genlist_item_disabled_set() for more details
19188 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19190 * Sets the display only state of an item.
19192 * @param it The item
19193 * @param display_only @c EINA_TRUE if the item is display only, @c
19194 * EINA_FALSE otherwise.
19196 * A display only item cannot be selected or unselected. It is for
19197 * display only and not selecting or otherwise clicking, dragging
19198 * etc. by the user, thus finger size rules will not be applied to
19201 * It's good to set group index items to display only state.
19203 * @see elm_genlist_item_display_only_get()
19207 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19209 * Get the display only state of an item
19211 * @param it The item
19212 * @return @c EINA_TRUE if the item is display only, @c
19213 * EINA_FALSE otherwise.
19215 * @see elm_genlist_item_display_only_set()
19219 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19221 * Show the portion of a genlist's internal list containing a given
19222 * item, immediately.
19224 * @param it The item to display
19226 * This causes genlist to jump to the given item @p it and show it (by
19227 * immediately scrolling to that position), if it is not fully visible.
19229 * @see elm_genlist_item_bring_in()
19230 * @see elm_genlist_item_top_show()
19231 * @see elm_genlist_item_middle_show()
19235 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19237 * Animatedly bring in, to the visible are of a genlist, a given
19240 * @param it The item to display
19242 * This causes genlist to jump to the given item @p it and show it (by
19243 * animatedly scrolling), if it is not fully visible. This may use animation
19244 * to do so and take a period of time
19246 * @see elm_genlist_item_show()
19247 * @see elm_genlist_item_top_bring_in()
19248 * @see elm_genlist_item_middle_bring_in()
19252 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19254 * Show the portion of a genlist's internal list containing a given
19255 * item, immediately.
19257 * @param it The item to display
19259 * This causes genlist to jump to the given item @p it and show it (by
19260 * immediately scrolling to that position), if it is not fully visible.
19262 * The item will be positioned at the top of the genlist viewport.
19264 * @see elm_genlist_item_show()
19265 * @see elm_genlist_item_top_bring_in()
19269 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19271 * Animatedly bring in, to the visible are of a genlist, a given
19274 * @param it The item
19276 * This causes genlist to jump to the given item @p it and show it (by
19277 * animatedly scrolling), if it is not fully visible. This may use animation
19278 * to do so and take a period of time
19280 * The item will be positioned at the top of the genlist viewport.
19282 * @see elm_genlist_item_bring_in()
19283 * @see elm_genlist_item_top_show()
19287 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19289 * Show the portion of a genlist's internal list containing a given
19290 * item, immediately.
19292 * @param it The item to display
19294 * This causes genlist to jump to the given item @p it and show it (by
19295 * immediately scrolling to that position), if it is not fully visible.
19297 * The item will be positioned at the middle of the genlist viewport.
19299 * @see elm_genlist_item_show()
19300 * @see elm_genlist_item_middle_bring_in()
19304 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19306 * Animatedly bring in, to the visible are of a genlist, a given
19309 * @param it The item
19311 * This causes genlist to jump to the given item @p it and show it (by
19312 * animatedly scrolling), if it is not fully visible. This may use animation
19313 * to do so and take a period of time
19315 * The item will be positioned at the middle of the genlist viewport.
19317 * @see elm_genlist_item_bring_in()
19318 * @see elm_genlist_item_middle_show()
19322 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19324 * Remove a genlist item from the its parent, deleting it.
19326 * @param item The item to be removed.
19327 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19329 * @see elm_genlist_clear(), to remove all items in a genlist at
19334 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19336 * Return the data associated to a given genlist item
19338 * @param item The genlist item.
19339 * @return the data associated to this item.
19341 * This returns the @c data value passed on the
19342 * elm_genlist_item_append() and related item addition calls.
19344 * @see elm_genlist_item_append()
19345 * @see elm_genlist_item_data_set()
19349 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19351 * Set the data associated to a given genlist item
19353 * @param item The genlist item
19354 * @param data The new data pointer to set on it
19356 * This @b overrides the @c data value passed on the
19357 * elm_genlist_item_append() and related item addition calls. This
19358 * function @b won't call elm_genlist_item_update() automatically,
19359 * so you'd issue it afterwards if you want to hove the item
19360 * updated to reflect the that new data.
19362 * @see elm_genlist_item_data_get()
19366 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19368 * Tells genlist to "orphan" icons fetchs by the item class
19370 * @param it The item
19372 * This instructs genlist to release references to icons in the item,
19373 * meaning that they will no longer be managed by genlist and are
19374 * floating "orphans" that can be re-used elsewhere if the user wants
19379 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19380 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19382 * Get the real Evas object created to implement the view of a
19383 * given genlist item
19385 * @param item The genlist item.
19386 * @return the Evas object implementing this item's view.
19388 * This returns the actual Evas object used to implement the
19389 * specified genlist item's view. This may be @c NULL, as it may
19390 * not have been created or may have been deleted, at any time, by
19391 * the genlist. <b>Do not modify this object</b> (move, resize,
19392 * show, hide, etc.), as the genlist is controlling it. This
19393 * function is for querying, emitting custom signals or hooking
19394 * lower level callbacks for events on that object. Do not delete
19395 * this object under any circumstances.
19397 * @see elm_genlist_item_data_get()
19401 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19403 * Update the contents of an item
19405 * @param it The item
19407 * This updates an item by calling all the item class functions again
19408 * to get the icons, labels and states. Use this when the original
19409 * item data has changed and the changes are desired to be reflected.
19411 * Use elm_genlist_realized_items_update() to update all already realized
19414 * @see elm_genlist_realized_items_update()
19418 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19419 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19421 * Update the item class of an item
19423 * @param it The item
19424 * @param itc The item class for the item
19426 * This sets another class fo the item, changing the way that it is
19427 * displayed. After changing the item class, elm_genlist_item_update() is
19428 * called on the item @p it.
19432 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19433 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19435 * Set the text to be shown in a given genlist item's tooltips.
19437 * @param item The genlist item
19438 * @param text The text to set in the content
19440 * This call will setup the text to be used as tooltip to that item
19441 * (analogous to elm_object_tooltip_text_set(), but being item
19442 * tooltips with higher precedence than object tooltips). It can
19443 * have only one tooltip at a time, so any previous tooltip data
19444 * will get removed.
19446 * In order to set an icon or something else as a tooltip, look at
19447 * elm_genlist_item_tooltip_content_cb_set().
19451 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19453 * Set the content to be shown in a given genlist item's tooltips
19455 * @param item The genlist item.
19456 * @param func The function returning the tooltip contents.
19457 * @param data What to provide to @a func as callback data/context.
19458 * @param del_cb Called when data is not needed anymore, either when
19459 * another callback replaces @p func, the tooltip is unset with
19460 * elm_genlist_item_tooltip_unset() or the owner @p item
19461 * dies. This callback receives as its first parameter the
19462 * given @p data, being @c event_info the item handle.
19464 * This call will setup the tooltip's contents to @p item
19465 * (analogous to elm_object_tooltip_content_cb_set(), but being
19466 * item tooltips with higher precedence than object tooltips). It
19467 * can have only one tooltip at a time, so any previous tooltip
19468 * content will get removed. @p func (with @p data) will be called
19469 * every time Elementary needs to show the tooltip and it should
19470 * return a valid Evas object, which will be fully managed by the
19471 * tooltip system, getting deleted when the tooltip is gone.
19473 * In order to set just a text as a tooltip, look at
19474 * elm_genlist_item_tooltip_text_set().
19478 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);
19480 * Unset a tooltip from a given genlist item
19482 * @param item genlist item to remove a previously set tooltip from.
19484 * This call removes any tooltip set on @p item. The callback
19485 * provided as @c del_cb to
19486 * elm_genlist_item_tooltip_content_cb_set() will be called to
19487 * notify it is not used anymore (and have resources cleaned, if
19490 * @see elm_genlist_item_tooltip_content_cb_set()
19494 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19496 * Set a different @b style for a given genlist item's tooltip.
19498 * @param item genlist item with tooltip set
19499 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19500 * "default", @c "transparent", etc)
19502 * Tooltips can have <b>alternate styles</b> to be displayed on,
19503 * which are defined by the theme set on Elementary. This function
19504 * works analogously as elm_object_tooltip_style_set(), but here
19505 * applied only to genlist item objects. The default style for
19506 * tooltips is @c "default".
19508 * @note before you set a style you should define a tooltip with
19509 * elm_genlist_item_tooltip_content_cb_set() or
19510 * elm_genlist_item_tooltip_text_set()
19512 * @see elm_genlist_item_tooltip_style_get()
19516 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19518 * Get the style set a given genlist item's tooltip.
19520 * @param item genlist item with tooltip already set on.
19521 * @return style the theme style in use, which defaults to
19522 * "default". If the object does not have a tooltip set,
19523 * then @c NULL is returned.
19525 * @see elm_genlist_item_tooltip_style_set() for more details
19529 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19531 * Set the type of mouse pointer/cursor decoration to be shown,
19532 * when the mouse pointer is over the given genlist widget item
19534 * @param item genlist item to customize cursor on
19535 * @param cursor the cursor type's name
19537 * This function works analogously as elm_object_cursor_set(), but
19538 * here the cursor's changing area is restricted to the item's
19539 * area, and not the whole widget's. Note that that item cursors
19540 * have precedence over widget cursors, so that a mouse over @p
19541 * item will always show cursor @p type.
19543 * If this function is called twice for an object, a previously set
19544 * cursor will be unset on the second call.
19546 * @see elm_object_cursor_set()
19547 * @see elm_genlist_item_cursor_get()
19548 * @see elm_genlist_item_cursor_unset()
19552 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19554 * Get the type of mouse pointer/cursor decoration set to be shown,
19555 * when the mouse pointer is over the given genlist widget item
19557 * @param item genlist item with custom cursor set
19558 * @return the cursor type's name or @c NULL, if no custom cursors
19559 * were set to @p item (and on errors)
19561 * @see elm_object_cursor_get()
19562 * @see elm_genlist_item_cursor_set() for more details
19563 * @see elm_genlist_item_cursor_unset()
19567 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19569 * Unset any custom mouse pointer/cursor decoration set to be
19570 * shown, when the mouse pointer is over the given genlist widget
19571 * item, thus making it show the @b default cursor again.
19573 * @param item a genlist item
19575 * Use this call to undo any custom settings on this item's cursor
19576 * decoration, bringing it back to defaults (no custom style set).
19578 * @see elm_object_cursor_unset()
19579 * @see elm_genlist_item_cursor_set() for more details
19583 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19585 * Set a different @b style for a given custom cursor set for a
19588 * @param item genlist item with custom cursor set
19589 * @param style the <b>theme style</b> to use (e.g. @c "default",
19590 * @c "transparent", etc)
19592 * This function only makes sense when one is using custom mouse
19593 * cursor decorations <b>defined in a theme file</b> , which can
19594 * have, given a cursor name/type, <b>alternate styles</b> on
19595 * it. It works analogously as elm_object_cursor_style_set(), but
19596 * here applied only to genlist item objects.
19598 * @warning Before you set a cursor style you should have defined a
19599 * custom cursor previously on the item, with
19600 * elm_genlist_item_cursor_set()
19602 * @see elm_genlist_item_cursor_engine_only_set()
19603 * @see elm_genlist_item_cursor_style_get()
19607 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19609 * Get the current @b style set for a given genlist item's custom
19612 * @param item genlist item with custom cursor set.
19613 * @return style the cursor style in use. If the object does not
19614 * have a cursor set, then @c NULL is returned.
19616 * @see elm_genlist_item_cursor_style_set() for more details
19620 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19622 * Set if the (custom) cursor for a given genlist item should be
19623 * searched in its theme, also, or should only rely on the
19624 * rendering engine.
19626 * @param item item with custom (custom) cursor already set on
19627 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19628 * only on those provided by the rendering engine, @c EINA_FALSE to
19629 * have them searched on the widget's theme, as well.
19631 * @note This call is of use only if you've set a custom cursor
19632 * for genlist items, with elm_genlist_item_cursor_set().
19634 * @note By default, cursors will only be looked for between those
19635 * provided by the rendering engine.
19639 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19641 * Get if the (custom) cursor for a given genlist item is being
19642 * searched in its theme, also, or is only relying on the rendering
19645 * @param item a genlist item
19646 * @return @c EINA_TRUE, if cursors are being looked for only on
19647 * those provided by the rendering engine, @c EINA_FALSE if they
19648 * are being searched on the widget's theme, as well.
19650 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19654 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19656 * Update the contents of all realized items.
19658 * @param obj The genlist object.
19660 * This updates all realized items by calling all the item class functions again
19661 * to get the icons, labels and states. Use this when the original
19662 * item data has changed and the changes are desired to be reflected.
19664 * To update just one item, use elm_genlist_item_update().
19666 * @see elm_genlist_realized_items_get()
19667 * @see elm_genlist_item_update()
19671 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19673 * Activate a genlist mode on an item
19675 * @param item The genlist item
19676 * @param mode Mode name
19677 * @param mode_set Boolean to define set or unset mode.
19679 * A genlist mode is a different way of selecting an item. Once a mode is
19680 * activated on an item, any other selected item is immediately unselected.
19681 * This feature provides an easy way of implementing a new kind of animation
19682 * for selecting an item, without having to entirely rewrite the item style
19683 * theme. However, the elm_genlist_selected_* API can't be used to get what
19684 * item is activate for a mode.
19686 * The current item style will still be used, but applying a genlist mode to
19687 * an item will select it using a different kind of animation.
19689 * The current active item for a mode can be found by
19690 * elm_genlist_mode_item_get().
19692 * The characteristics of genlist mode are:
19693 * - Only one mode can be active at any time, and for only one item.
19694 * - Genlist handles deactivating other items when one item is activated.
19695 * - A mode is defined in the genlist theme (edc), and more modes can easily
19697 * - A mode style and the genlist item style are different things. They
19698 * can be combined to provide a default style to the item, with some kind
19699 * of animation for that item when the mode is activated.
19701 * When a mode is activated on an item, a new view for that item is created.
19702 * The theme of this mode defines the animation that will be used to transit
19703 * the item from the old view to the new view. This second (new) view will be
19704 * active for that item while the mode is active on the item, and will be
19705 * destroyed after the mode is totally deactivated from that item.
19707 * @see elm_genlist_mode_get()
19708 * @see elm_genlist_mode_item_get()
19712 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19714 * Get the last (or current) genlist mode used.
19716 * @param obj The genlist object
19718 * This function just returns the name of the last used genlist mode. It will
19719 * be the current mode if it's still active.
19721 * @see elm_genlist_item_mode_set()
19722 * @see elm_genlist_mode_item_get()
19726 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19728 * Get active genlist mode item
19730 * @param obj The genlist object
19731 * @return The active item for that current mode. Or @c NULL if no item is
19732 * activated with any mode.
19734 * This function returns the item that was activated with a mode, by the
19735 * function elm_genlist_item_mode_set().
19737 * @see elm_genlist_item_mode_set()
19738 * @see elm_genlist_mode_get()
19742 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19747 * @param obj The genlist object
19748 * @param reorder_mode The reorder mode
19749 * (EINA_TRUE = on, EINA_FALSE = off)
19753 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19756 * Get the reorder mode
19758 * @param obj The genlist object
19759 * @return The reorder mode
19760 * (EINA_TRUE = on, EINA_FALSE = off)
19764 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19766 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19767 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19768 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19769 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19770 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19771 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19772 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19773 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19774 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19775 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19782 * @defgroup Check Check
19784 * @image html img/widget/check/preview-00.png
19785 * @image latex img/widget/check/preview-00.eps
19786 * @image html img/widget/check/preview-01.png
19787 * @image latex img/widget/check/preview-01.eps
19788 * @image html img/widget/check/preview-02.png
19789 * @image latex img/widget/check/preview-02.eps
19791 * @brief The check widget allows for toggling a value between true and
19794 * Check objects are a lot like radio objects in layout and functionality
19795 * except they do not work as a group, but independently and only toggle the
19796 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19797 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19798 * returns the current state. For convenience, like the radio objects, you
19799 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19800 * for it to modify.
19802 * Signals that you can add callbacks for are:
19803 * "changed" - This is called whenever the user changes the state of one of
19804 * the check object(event_info is NULL).
19806 * Default contents parts of the check widget that you can use for are:
19807 * @li "elm.swallow.content" - A icon of the check
19809 * Default text parts of the check widget that you can use for are:
19810 * @li "elm.text" - Label of the check
19812 * @ref tutorial_check should give you a firm grasp of how to use this widget
19817 * @brief Add a new Check object
19819 * @param parent The parent object
19820 * @return The new object or NULL if it cannot be created
19822 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19824 * @brief Set the text label of the check object
19826 * @param obj The check object
19827 * @param label The text label string in UTF-8
19829 * @deprecated use elm_object_text_set() instead.
19831 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19833 * @brief Get the text label of the check object
19835 * @param obj The check object
19836 * @return The text label string in UTF-8
19838 * @deprecated use elm_object_text_get() instead.
19840 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19842 * @brief Set the icon object of the check object
19844 * @param obj The check object
19845 * @param icon The icon object
19847 * Once the icon object is set, a previously set one will be deleted.
19848 * If you want to keep that old content object, use the
19849 * elm_object_content_unset() function.
19851 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19853 * @brief Get the icon object of the check object
19855 * @param obj The check object
19856 * @return The icon object
19858 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19860 * @brief Unset the icon used for the check object
19862 * @param obj The check object
19863 * @return The icon object that was being used
19865 * Unparent and return the icon object which was set for this widget.
19867 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19869 * @brief Set the on/off state of the check object
19871 * @param obj The check object
19872 * @param state The state to use (1 == on, 0 == off)
19874 * This sets the state of the check. If set
19875 * with elm_check_state_pointer_set() the state of that variable is also
19876 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19878 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19880 * @brief Get the state of the check object
19882 * @param obj The check object
19883 * @return The boolean state
19885 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19887 * @brief Set a convenience pointer to a boolean to change
19889 * @param obj The check object
19890 * @param statep Pointer to the boolean to modify
19892 * This sets a pointer to a boolean, that, in addition to the check objects
19893 * state will also be modified directly. To stop setting the object pointed
19894 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19895 * then when this is called, the check objects state will also be modified to
19896 * reflect the value of the boolean @p statep points to, just like calling
19897 * elm_check_state_set().
19899 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19905 * @defgroup Radio Radio
19907 * @image html img/widget/radio/preview-00.png
19908 * @image latex img/widget/radio/preview-00.eps
19910 * @brief Radio is a widget that allows for 1 or more options to be displayed
19911 * and have the user choose only 1 of them.
19913 * A radio object contains an indicator, an optional Label and an optional
19914 * icon object. While it's possible to have a group of only one radio they,
19915 * are normally used in groups of 2 or more. To add a radio to a group use
19916 * elm_radio_group_add(). The radio object(s) will select from one of a set
19917 * of integer values, so any value they are configuring needs to be mapped to
19918 * a set of integers. To configure what value that radio object represents,
19919 * use elm_radio_state_value_set() to set the integer it represents. To set
19920 * the value the whole group(which one is currently selected) is to indicate
19921 * use elm_radio_value_set() on any group member, and to get the groups value
19922 * use elm_radio_value_get(). For convenience the radio objects are also able
19923 * to directly set an integer(int) to the value that is selected. To specify
19924 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19925 * The radio objects will modify this directly. That implies the pointer must
19926 * point to valid memory for as long as the radio objects exist.
19928 * Signals that you can add callbacks for are:
19929 * @li changed - This is called whenever the user changes the state of one of
19930 * the radio objects within the group of radio objects that work together.
19932 * Default contents parts of the radio widget that you can use for are:
19933 * @li "elm.swallow.content" - A icon of the radio
19935 * @ref tutorial_radio show most of this API in action.
19939 * @brief Add a new radio to the parent
19941 * @param parent The parent object
19942 * @return The new object or NULL if it cannot be created
19944 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19946 * @brief Set the text label of the radio object
19948 * @param obj The radio object
19949 * @param label The text label string in UTF-8
19951 * @deprecated use elm_object_text_set() instead.
19953 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19955 * @brief Get the text label of the radio object
19957 * @param obj The radio object
19958 * @return The text label string in UTF-8
19960 * @deprecated use elm_object_text_set() instead.
19962 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19964 * @brief Set the icon object of the radio object
19966 * @param obj The radio object
19967 * @param icon The icon object
19969 * Once the icon object is set, a previously set one will be deleted. If you
19970 * want to keep that old content object, use the elm_radio_icon_unset()
19973 * @deprecated use elm_object_content_set() instead.
19975 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19977 * @brief Get the icon object of the radio object
19979 * @param obj The radio object
19980 * @return The icon object
19982 * @see elm_radio_icon_set()
19984 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19986 * @brief Unset the icon used for the radio object
19988 * @param obj The radio object
19989 * @return The icon object that was being used
19991 * Unparent and return the icon object which was set for this widget.
19993 * @see elm_radio_icon_set()
19994 * @deprecated use elm_object_content_unset() instead.
19996 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19998 * @brief Add this radio to a group of other radio objects
20000 * @param obj The radio object
20001 * @param group Any object whose group the @p obj is to join.
20003 * Radio objects work in groups. Each member should have a different integer
20004 * value assigned. In order to have them work as a group, they need to know
20005 * about each other. This adds the given radio object to the group of which
20006 * the group object indicated is a member.
20008 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20010 * @brief Set the integer value that this radio object represents
20012 * @param obj The radio object
20013 * @param value The value to use if this radio object is selected
20015 * This sets the value of the radio.
20017 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20019 * @brief Get the integer value that this radio object represents
20021 * @param obj The radio object
20022 * @return The value used if this radio object is selected
20024 * This gets the value of the radio.
20026 * @see elm_radio_value_set()
20028 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20030 * @brief Set the value of the radio.
20032 * @param obj The radio object
20033 * @param value The value to use for the group
20035 * This sets the value of the radio group and will also set the value if
20036 * pointed to, to the value supplied, but will not call any callbacks.
20038 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20040 * @brief Get the state of the radio object
20042 * @param obj The radio object
20043 * @return The integer state
20045 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20047 * @brief Set a convenience pointer to a integer to change
20049 * @param obj The radio object
20050 * @param valuep Pointer to the integer to modify
20052 * This sets a pointer to a integer, that, in addition to the radio objects
20053 * state will also be modified directly. To stop setting the object pointed
20054 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20055 * when this is called, the radio objects state will also be modified to
20056 * reflect the value of the integer valuep points to, just like calling
20057 * elm_radio_value_set().
20059 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20065 * @defgroup Pager Pager
20067 * @image html img/widget/pager/preview-00.png
20068 * @image latex img/widget/pager/preview-00.eps
20070 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20072 * The flipping between āpagesā of objects is animated. All content in pager
20073 * is kept in a stack, the last content to be added will be on the top of the
20074 * stack(be visible).
20076 * Objects can be pushed or popped from the stack or deleted as normal.
20077 * Pushes and pops will animate (and a pop will delete the object once the
20078 * animation is finished). Any object already in the pager can be promoted to
20079 * the top(from its current stacking position) through the use of
20080 * elm_pager_content_promote(). Objects are pushed to the top with
20081 * elm_pager_content_push() and when the top item is no longer wanted, simply
20082 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20083 * object is no longer needed and is not the top item, just delete it as
20084 * normal. You can query which objects are the top and bottom with
20085 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20087 * Signals that you can add callbacks for are:
20088 * "hide,finished" - when the previous page is hided
20090 * This widget has the following styles available:
20093 * @li fade_translucide
20094 * @li fade_invisible
20095 * @note This styles affect only the flipping animations, the appearance when
20096 * not animating is unaffected by styles.
20098 * @ref tutorial_pager gives a good overview of the usage of the API.
20102 * Add a new pager to the parent
20104 * @param parent The parent object
20105 * @return The new object or NULL if it cannot be created
20109 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20111 * @brief Push an object to the top of the pager stack (and show it).
20113 * @param obj The pager object
20114 * @param content The object to push
20116 * The object pushed becomes a child of the pager, it will be controlled and
20117 * deleted when the pager is deleted.
20119 * @note If the content is already in the stack use
20120 * elm_pager_content_promote().
20121 * @warning Using this function on @p content already in the stack results in
20122 * undefined behavior.
20124 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20126 * @brief Pop the object that is on top of the stack
20128 * @param obj The pager object
20130 * This pops the object that is on the top(visible) of the pager, makes it
20131 * disappear, then deletes the object. The object that was underneath it on
20132 * the stack will become visible.
20134 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20136 * @brief Moves an object already in the pager stack to the top of the stack.
20138 * @param obj The pager object
20139 * @param content The object to promote
20141 * This will take the @p content and move it to the top of the stack as
20142 * if it had been pushed there.
20144 * @note If the content isn't already in the stack use
20145 * elm_pager_content_push().
20146 * @warning Using this function on @p content not already in the stack
20147 * results in undefined behavior.
20149 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20151 * @brief Return the object at the bottom of the pager stack
20153 * @param obj The pager object
20154 * @return The bottom object or NULL if none
20156 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @brief Return the object at the top of the pager stack
20160 * @param obj The pager object
20161 * @return The top object or NULL if none
20163 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20165 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20166 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20173 * @defgroup Slideshow Slideshow
20175 * @image html img/widget/slideshow/preview-00.png
20176 * @image latex img/widget/slideshow/preview-00.eps
20178 * This widget, as the name indicates, is a pre-made image
20179 * slideshow panel, with API functions acting on (child) image
20180 * items presentation. Between those actions, are:
20181 * - advance to next/previous image
20182 * - select the style of image transition animation
20183 * - set the exhibition time for each image
20184 * - start/stop the slideshow
20186 * The transition animations are defined in the widget's theme,
20187 * consequently new animations can be added without having to
20188 * update the widget's code.
20190 * @section Slideshow_Items Slideshow items
20192 * For slideshow items, just like for @ref Genlist "genlist" ones,
20193 * the user defines a @b classes, specifying functions that will be
20194 * called on the item's creation and deletion times.
20196 * The #Elm_Slideshow_Item_Class structure contains the following
20199 * - @c func.get - When an item is displayed, this function is
20200 * called, and it's where one should create the item object, de
20201 * facto. For example, the object can be a pure Evas image object
20202 * or an Elementary @ref Photocam "photocam" widget. See
20203 * #SlideshowItemGetFunc.
20204 * - @c func.del - When an item is no more displayed, this function
20205 * is called, where the user must delete any data associated to
20206 * the item. See #SlideshowItemDelFunc.
20208 * @section Slideshow_Caching Slideshow caching
20210 * The slideshow provides facilities to have items adjacent to the
20211 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20212 * you, so that the system does not have to decode image data
20213 * anymore at the time it has to actually switch images on its
20214 * viewport. The user is able to set the numbers of items to be
20215 * cached @b before and @b after the current item, in the widget's
20218 * Smart events one can add callbacks for are:
20220 * - @c "changed" - when the slideshow switches its view to a new
20223 * List of examples for the slideshow widget:
20224 * @li @ref slideshow_example
20228 * @addtogroup Slideshow
20232 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20233 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20234 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20235 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20236 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20239 * @struct _Elm_Slideshow_Item_Class
20241 * Slideshow item class definition. See @ref Slideshow_Items for
20244 struct _Elm_Slideshow_Item_Class
20246 struct _Elm_Slideshow_Item_Class_Func
20248 SlideshowItemGetFunc get;
20249 SlideshowItemDelFunc del;
20251 }; /**< #Elm_Slideshow_Item_Class member definitions */
20254 * Add a new slideshow widget to the given parent Elementary
20255 * (container) object
20257 * @param parent The parent object
20258 * @return A new slideshow widget handle or @c NULL, on errors
20260 * This function inserts a new slideshow widget on the canvas.
20262 * @ingroup Slideshow
20264 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20267 * Add (append) a new item in a given slideshow widget.
20269 * @param obj The slideshow object
20270 * @param itc The item class for the item
20271 * @param data The item's data
20272 * @return A handle to the item added or @c NULL, on errors
20274 * Add a new item to @p obj's internal list of items, appending it.
20275 * The item's class must contain the function really fetching the
20276 * image object to show for this item, which could be an Evas image
20277 * object or an Elementary photo, for example. The @p data
20278 * parameter is going to be passed to both class functions of the
20281 * @see #Elm_Slideshow_Item_Class
20282 * @see elm_slideshow_item_sorted_insert()
20284 * @ingroup Slideshow
20286 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20289 * Insert a new item into the given slideshow widget, using the @p func
20290 * function to sort items (by item handles).
20292 * @param obj The slideshow object
20293 * @param itc The item class for the item
20294 * @param data The item's data
20295 * @param func The comparing function to be used to sort slideshow
20296 * items <b>by #Elm_Slideshow_Item item handles</b>
20297 * @return Returns The slideshow item handle, on success, or
20298 * @c NULL, on errors
20300 * Add a new item to @p obj's internal list of items, in a position
20301 * determined by the @p func comparing function. The item's class
20302 * must contain the function really fetching the image object to
20303 * show for this item, which could be an Evas image object or an
20304 * Elementary photo, for example. The @p data parameter is going to
20305 * be passed to both class functions of the item.
20307 * @see #Elm_Slideshow_Item_Class
20308 * @see elm_slideshow_item_add()
20310 * @ingroup Slideshow
20312 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);
20315 * Display a given slideshow widget's item, programmatically.
20317 * @param obj The slideshow object
20318 * @param item The item to display on @p obj's viewport
20320 * The change between the current item and @p item will use the
20321 * transition @p obj is set to use (@see
20322 * elm_slideshow_transition_set()).
20324 * @ingroup Slideshow
20326 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20329 * Slide to the @b next item, in a given slideshow widget
20331 * @param obj The slideshow object
20333 * The sliding animation @p obj is set to use will be the
20334 * transition effect used, after this call is issued.
20336 * @note If the end of the slideshow's internal list of items is
20337 * reached, it'll wrap around to the list's beginning, again.
20339 * @ingroup Slideshow
20341 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20344 * Slide to the @b previous item, in a given slideshow widget
20346 * @param obj The slideshow object
20348 * The sliding animation @p obj is set to use will be the
20349 * transition effect used, after this call is issued.
20351 * @note If the beginning of the slideshow's internal list of items
20352 * is reached, it'll wrap around to the list's end, again.
20354 * @ingroup Slideshow
20356 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20359 * Returns the list of sliding transition/effect names available, for a
20360 * given slideshow widget.
20362 * @param obj The slideshow object
20363 * @return The list of transitions (list of @b stringshared strings
20366 * The transitions, which come from @p obj's theme, must be an EDC
20367 * data item named @c "transitions" on the theme file, with (prefix)
20368 * names of EDC programs actually implementing them.
20370 * The available transitions for slideshows on the default theme are:
20371 * - @c "fade" - the current item fades out, while the new one
20372 * fades in to the slideshow's viewport.
20373 * - @c "black_fade" - the current item fades to black, and just
20374 * then, the new item will fade in.
20375 * - @c "horizontal" - the current item slides horizontally, until
20376 * it gets out of the slideshow's viewport, while the new item
20377 * comes from the left to take its place.
20378 * - @c "vertical" - the current item slides vertically, until it
20379 * gets out of the slideshow's viewport, while the new item comes
20380 * from the bottom to take its place.
20381 * - @c "square" - the new item starts to appear from the middle of
20382 * the current one, but with a tiny size, growing until its
20383 * target (full) size and covering the old one.
20385 * @warning The stringshared strings get no new references
20386 * exclusive to the user grabbing the list, here, so if you'd like
20387 * to use them out of this call's context, you'd better @c
20388 * eina_stringshare_ref() them.
20390 * @see elm_slideshow_transition_set()
20392 * @ingroup Slideshow
20394 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20397 * Set the current slide transition/effect in use for a given
20400 * @param obj The slideshow object
20401 * @param transition The new transition's name string
20403 * If @p transition is implemented in @p obj's theme (i.e., is
20404 * contained in the list returned by
20405 * elm_slideshow_transitions_get()), this new sliding effect will
20406 * be used on the widget.
20408 * @see elm_slideshow_transitions_get() for more details
20410 * @ingroup Slideshow
20412 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20415 * Get the current slide transition/effect in use for a given
20418 * @param obj The slideshow object
20419 * @return The current transition's name
20421 * @see elm_slideshow_transition_set() for more details
20423 * @ingroup Slideshow
20425 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20428 * Set the interval between each image transition on a given
20429 * slideshow widget, <b>and start the slideshow, itself</b>
20431 * @param obj The slideshow object
20432 * @param timeout The new displaying timeout for images
20434 * After this call, the slideshow widget will start cycling its
20435 * view, sequentially and automatically, with the images of the
20436 * items it has. The time between each new image displayed is going
20437 * to be @p timeout, in @b seconds. If a different timeout was set
20438 * previously and an slideshow was in progress, it will continue
20439 * with the new time between transitions, after this call.
20441 * @note A value less than or equal to 0 on @p timeout will disable
20442 * the widget's internal timer, thus halting any slideshow which
20443 * could be happening on @p obj.
20445 * @see elm_slideshow_timeout_get()
20447 * @ingroup Slideshow
20449 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20452 * Get the interval set for image transitions on a given slideshow
20455 * @param obj The slideshow object
20456 * @return Returns the timeout set on it
20458 * @see elm_slideshow_timeout_set() for more details
20460 * @ingroup Slideshow
20462 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20465 * Set if, after a slideshow is started, for a given slideshow
20466 * widget, its items should be displayed cyclically or not.
20468 * @param obj The slideshow object
20469 * @param loop Use @c EINA_TRUE to make it cycle through items or
20470 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20473 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20474 * ignore what is set by this functions, i.e., they'll @b always
20475 * cycle through items. This affects only the "automatic"
20476 * slideshow, as set by elm_slideshow_timeout_set().
20478 * @see elm_slideshow_loop_get()
20480 * @ingroup Slideshow
20482 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20485 * Get if, after a slideshow is started, for a given slideshow
20486 * widget, its items are to be displayed cyclically or not.
20488 * @param obj The slideshow object
20489 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20490 * through or @c EINA_FALSE, otherwise
20492 * @see elm_slideshow_loop_set() for more details
20494 * @ingroup Slideshow
20496 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20499 * Remove all items from a given slideshow widget
20501 * @param obj The slideshow object
20503 * This removes (and deletes) all items in @p obj, leaving it
20506 * @see elm_slideshow_item_del(), to remove just one item.
20508 * @ingroup Slideshow
20510 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20513 * Get the internal list of items in a given slideshow widget.
20515 * @param obj The slideshow object
20516 * @return The list of items (#Elm_Slideshow_Item as data) or
20517 * @c NULL on errors.
20519 * This list is @b not to be modified in any way and must not be
20520 * freed. Use the list members with functions like
20521 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20523 * @warning This list is only valid until @p obj object's internal
20524 * items list is changed. It should be fetched again with another
20525 * call to this function when changes happen.
20527 * @ingroup Slideshow
20529 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20532 * Delete a given item from a slideshow widget.
20534 * @param item The slideshow item
20536 * @ingroup Slideshow
20538 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20541 * Return the data associated with a given slideshow item
20543 * @param item The slideshow item
20544 * @return Returns the data associated to this item
20546 * @ingroup Slideshow
20548 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20551 * Returns the currently displayed item, in a given slideshow widget
20553 * @param obj The slideshow object
20554 * @return A handle to the item being displayed in @p obj or
20555 * @c NULL, if none is (and on errors)
20557 * @ingroup Slideshow
20559 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20562 * Get the real Evas object created to implement the view of a
20563 * given slideshow item
20565 * @param item The slideshow item.
20566 * @return the Evas object implementing this item's view.
20568 * This returns the actual Evas object used to implement the
20569 * specified slideshow item's view. This may be @c NULL, as it may
20570 * not have been created or may have been deleted, at any time, by
20571 * the slideshow. <b>Do not modify this object</b> (move, resize,
20572 * show, hide, etc.), as the slideshow is controlling it. This
20573 * function is for querying, emitting custom signals or hooking
20574 * lower level callbacks for events on that object. Do not delete
20575 * this object under any circumstances.
20577 * @see elm_slideshow_item_data_get()
20579 * @ingroup Slideshow
20581 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20584 * Get the the item, in a given slideshow widget, placed at
20585 * position @p nth, in its internal items list
20587 * @param obj The slideshow object
20588 * @param nth The number of the item to grab a handle to (0 being
20590 * @return The item stored in @p obj at position @p nth or @c NULL,
20591 * if there's no item with that index (and on errors)
20593 * @ingroup Slideshow
20595 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20598 * Set the current slide layout in use for a given slideshow widget
20600 * @param obj The slideshow object
20601 * @param layout The new layout's name string
20603 * If @p layout is implemented in @p obj's theme (i.e., is contained
20604 * in the list returned by elm_slideshow_layouts_get()), this new
20605 * images layout will be used on the widget.
20607 * @see elm_slideshow_layouts_get() for more details
20609 * @ingroup Slideshow
20611 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20614 * Get the current slide layout in use for a given slideshow widget
20616 * @param obj The slideshow object
20617 * @return The current layout's name
20619 * @see elm_slideshow_layout_set() for more details
20621 * @ingroup Slideshow
20623 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20626 * Returns the list of @b layout names available, for a given
20627 * slideshow widget.
20629 * @param obj The slideshow object
20630 * @return The list of layouts (list of @b stringshared strings
20633 * Slideshow layouts will change how the widget is to dispose each
20634 * image item in its viewport, with regard to cropping, scaling,
20637 * The layouts, which come from @p obj's theme, must be an EDC
20638 * data item name @c "layouts" on the theme file, with (prefix)
20639 * names of EDC programs actually implementing them.
20641 * The available layouts for slideshows on the default theme are:
20642 * - @c "fullscreen" - item images with original aspect, scaled to
20643 * touch top and down slideshow borders or, if the image's heigh
20644 * is not enough, left and right slideshow borders.
20645 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20646 * one, but always leaving 10% of the slideshow's dimensions of
20647 * distance between the item image's borders and the slideshow
20648 * borders, for each axis.
20650 * @warning The stringshared strings get no new references
20651 * exclusive to the user grabbing the list, here, so if you'd like
20652 * to use them out of this call's context, you'd better @c
20653 * eina_stringshare_ref() them.
20655 * @see elm_slideshow_layout_set()
20657 * @ingroup Slideshow
20659 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20662 * Set the number of items to cache, on a given slideshow widget,
20663 * <b>before the current item</b>
20665 * @param obj The slideshow object
20666 * @param count Number of items to cache before the current one
20668 * The default value for this property is @c 2. See
20669 * @ref Slideshow_Caching "slideshow caching" for more details.
20671 * @see elm_slideshow_cache_before_get()
20673 * @ingroup Slideshow
20675 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20678 * Retrieve the number of items to cache, on a given slideshow widget,
20679 * <b>before the current item</b>
20681 * @param obj The slideshow object
20682 * @return The number of items set to be cached before the current one
20684 * @see elm_slideshow_cache_before_set() for more details
20686 * @ingroup Slideshow
20688 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20691 * Set the number of items to cache, on a given slideshow widget,
20692 * <b>after the current item</b>
20694 * @param obj The slideshow object
20695 * @param count Number of items to cache after the current one
20697 * The default value for this property is @c 2. See
20698 * @ref Slideshow_Caching "slideshow caching" for more details.
20700 * @see elm_slideshow_cache_after_get()
20702 * @ingroup Slideshow
20704 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20707 * Retrieve the number of items to cache, on a given slideshow widget,
20708 * <b>after the current item</b>
20710 * @param obj The slideshow object
20711 * @return The number of items set to be cached after the current one
20713 * @see elm_slideshow_cache_after_set() for more details
20715 * @ingroup Slideshow
20717 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20720 * Get the number of items stored in a given slideshow widget
20722 * @param obj The slideshow object
20723 * @return The number of items on @p obj, at the moment of this call
20725 * @ingroup Slideshow
20727 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20734 * @defgroup Fileselector File Selector
20736 * @image html img/widget/fileselector/preview-00.png
20737 * @image latex img/widget/fileselector/preview-00.eps
20739 * A file selector is a widget that allows a user to navigate
20740 * through a file system, reporting file selections back via its
20743 * It contains shortcut buttons for home directory (@c ~) and to
20744 * jump one directory upwards (..), as well as cancel/ok buttons to
20745 * confirm/cancel a given selection. After either one of those two
20746 * former actions, the file selector will issue its @c "done" smart
20749 * There's a text entry on it, too, showing the name of the current
20750 * selection. There's the possibility of making it editable, so it
20751 * is useful on file saving dialogs on applications, where one
20752 * gives a file name to save contents to, in a given directory in
20753 * the system. This custom file name will be reported on the @c
20754 * "done" smart callback (explained in sequence).
20756 * Finally, it has a view to display file system items into in two
20761 * If Elementary is built with support of the Ethumb thumbnailing
20762 * library, the second form of view will display preview thumbnails
20763 * of files which it supports.
20765 * Smart callbacks one can register to:
20767 * - @c "selected" - the user has clicked on a file (when not in
20768 * folders-only mode) or directory (when in folders-only mode)
20769 * - @c "directory,open" - the list has been populated with new
20770 * content (@c event_info is a pointer to the directory's
20771 * path, a @b stringshared string)
20772 * - @c "done" - the user has clicked on the "ok" or "cancel"
20773 * buttons (@c event_info is a pointer to the selection's
20774 * path, a @b stringshared string)
20776 * Here is an example on its usage:
20777 * @li @ref fileselector_example
20781 * @addtogroup Fileselector
20786 * Defines how a file selector widget is to layout its contents
20787 * (file system entries).
20789 typedef enum _Elm_Fileselector_Mode
20791 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20792 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20793 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20794 } Elm_Fileselector_Mode;
20797 * Add a new file selector widget to the given parent Elementary
20798 * (container) object
20800 * @param parent The parent object
20801 * @return a new file selector widget handle or @c NULL, on errors
20803 * This function inserts a new file selector widget on the canvas.
20805 * @ingroup Fileselector
20807 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20810 * Enable/disable the file name entry box where the user can type
20811 * in a name for a file, in a given file selector widget
20813 * @param obj The file selector object
20814 * @param is_save @c EINA_TRUE to make the file selector a "saving
20815 * dialog", @c EINA_FALSE otherwise
20817 * Having the entry editable is useful on file saving dialogs on
20818 * applications, where one gives a file name to save contents to,
20819 * in a given directory in the system. This custom file name will
20820 * be reported on the @c "done" smart callback.
20822 * @see elm_fileselector_is_save_get()
20824 * @ingroup Fileselector
20826 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20829 * Get whether the given file selector is in "saving dialog" mode
20831 * @param obj The file selector object
20832 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20833 * mode, @c EINA_FALSE otherwise (and on errors)
20835 * @see elm_fileselector_is_save_set() for more details
20837 * @ingroup Fileselector
20839 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20842 * Enable/disable folder-only view for a given file selector widget
20844 * @param obj The file selector object
20845 * @param only @c EINA_TRUE to make @p obj only display
20846 * directories, @c EINA_FALSE to make files to be displayed in it
20849 * If enabled, the widget's view will only display folder items,
20852 * @see elm_fileselector_folder_only_get()
20854 * @ingroup Fileselector
20856 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20859 * Get whether folder-only view is set for a given file selector
20862 * @param obj The file selector object
20863 * @return only @c EINA_TRUE if @p obj is only displaying
20864 * directories, @c EINA_FALSE if files are being displayed in it
20865 * too (and on errors)
20867 * @see elm_fileselector_folder_only_get()
20869 * @ingroup Fileselector
20871 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20874 * Enable/disable the "ok" and "cancel" buttons on a given file
20877 * @param obj The file selector object
20878 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20880 * @note A file selector without those buttons will never emit the
20881 * @c "done" smart event, and is only usable if one is just hooking
20882 * to the other two events.
20884 * @see elm_fileselector_buttons_ok_cancel_get()
20886 * @ingroup Fileselector
20888 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20891 * Get whether the "ok" and "cancel" buttons on a given file
20892 * selector widget are being shown.
20894 * @param obj The file selector object
20895 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20896 * otherwise (and on errors)
20898 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20900 * @ingroup Fileselector
20902 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20905 * Enable/disable a tree view in the given file selector widget,
20906 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20908 * @param obj The file selector object
20909 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20912 * In a tree view, arrows are created on the sides of directories,
20913 * allowing them to expand in place.
20915 * @note If it's in other mode, the changes made by this function
20916 * will only be visible when one switches back to "list" mode.
20918 * @see elm_fileselector_expandable_get()
20920 * @ingroup Fileselector
20922 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20925 * Get whether tree view is enabled for the given file selector
20928 * @param obj The file selector object
20929 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20930 * otherwise (and or errors)
20932 * @see elm_fileselector_expandable_set() for more details
20934 * @ingroup Fileselector
20936 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20939 * Set, programmatically, the @b directory that a given file
20940 * selector widget will display contents from
20942 * @param obj The file selector object
20943 * @param path The path to display in @p obj
20945 * This will change the @b directory that @p obj is displaying. It
20946 * will also clear the text entry area on the @p obj object, which
20947 * displays select files' names.
20949 * @see elm_fileselector_path_get()
20951 * @ingroup Fileselector
20953 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20956 * Get the parent directory's path that a given file selector
20957 * widget is displaying
20959 * @param obj The file selector object
20960 * @return The (full) path of the directory the file selector is
20961 * displaying, a @b stringshared string
20963 * @see elm_fileselector_path_set()
20965 * @ingroup Fileselector
20967 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20970 * Set, programmatically, the currently selected file/directory in
20971 * the given file selector widget
20973 * @param obj The file selector object
20974 * @param path The (full) path to a file or directory
20975 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20976 * latter case occurs if the directory or file pointed to do not
20979 * @see elm_fileselector_selected_get()
20981 * @ingroup Fileselector
20983 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20986 * Get the currently selected item's (full) path, in the given file
20989 * @param obj The file selector object
20990 * @return The absolute path of the selected item, a @b
20991 * stringshared string
20993 * @note Custom editions on @p obj object's text entry, if made,
20994 * will appear on the return string of this function, naturally.
20996 * @see elm_fileselector_selected_set() for more details
20998 * @ingroup Fileselector
21000 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21003 * Set the mode in which a given file selector widget will display
21004 * (layout) file system entries in its view
21006 * @param obj The file selector object
21007 * @param mode The mode of the fileselector, being it one of
21008 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21009 * first one, naturally, will display the files in a list. The
21010 * latter will make the widget to display its entries in a grid
21013 * @note By using elm_fileselector_expandable_set(), the user may
21014 * trigger a tree view for that list.
21016 * @note If Elementary is built with support of the Ethumb
21017 * thumbnailing library, the second form of view will display
21018 * preview thumbnails of files which it supports. You must have
21019 * elm_need_ethumb() called in your Elementary for thumbnailing to
21022 * @see elm_fileselector_expandable_set().
21023 * @see elm_fileselector_mode_get().
21025 * @ingroup Fileselector
21027 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21030 * Get the mode in which a given file selector widget is displaying
21031 * (layouting) file system entries in its view
21033 * @param obj The fileselector object
21034 * @return The mode in which the fileselector is at
21036 * @see elm_fileselector_mode_set() for more details
21038 * @ingroup Fileselector
21040 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21047 * @defgroup Progressbar Progress bar
21049 * The progress bar is a widget for visually representing the
21050 * progress status of a given job/task.
21052 * A progress bar may be horizontal or vertical. It may display an
21053 * icon besides it, as well as primary and @b units labels. The
21054 * former is meant to label the widget as a whole, while the
21055 * latter, which is formatted with floating point values (and thus
21056 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21057 * units"</c>), is meant to label the widget's <b>progress
21058 * value</b>. Label, icon and unit strings/objects are @b optional
21059 * for progress bars.
21061 * A progress bar may be @b inverted, in which state it gets its
21062 * values inverted, with high values being on the left or top and
21063 * low values on the right or bottom, as opposed to normally have
21064 * the low values on the former and high values on the latter,
21065 * respectively, for horizontal and vertical modes.
21067 * The @b span of the progress, as set by
21068 * elm_progressbar_span_size_set(), is its length (horizontally or
21069 * vertically), unless one puts size hints on the widget to expand
21070 * on desired directions, by any container. That length will be
21071 * scaled by the object or applications scaling factor. At any
21072 * point code can query the progress bar for its value with
21073 * elm_progressbar_value_get().
21075 * Available widget styles for progress bars:
21077 * - @c "wheel" (simple style, no text, no progression, only
21078 * "pulse" effect is available)
21080 * Default contents parts of the progressbar widget that you can use for are:
21081 * @li "elm.swallow.content" - A icon of the progressbar
21083 * Here is an example on its usage:
21084 * @li @ref progressbar_example
21088 * Add a new progress bar widget to the given parent Elementary
21089 * (container) object
21091 * @param parent The parent object
21092 * @return a new progress bar widget handle or @c NULL, on errors
21094 * This function inserts a new progress bar widget on the canvas.
21096 * @ingroup Progressbar
21098 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21101 * Set whether a given progress bar widget is at "pulsing mode" or
21104 * @param obj The progress bar object
21105 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21106 * @c EINA_FALSE to put it back to its default one
21108 * By default, progress bars will display values from the low to
21109 * high value boundaries. There are, though, contexts in which the
21110 * state of progression of a given task is @b unknown. For those,
21111 * one can set a progress bar widget to a "pulsing state", to give
21112 * the user an idea that some computation is being held, but
21113 * without exact progress values. In the default theme it will
21114 * animate its bar with the contents filling in constantly and back
21115 * to non-filled, in a loop. To start and stop this pulsing
21116 * animation, one has to explicitly call elm_progressbar_pulse().
21118 * @see elm_progressbar_pulse_get()
21119 * @see elm_progressbar_pulse()
21121 * @ingroup Progressbar
21123 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21126 * Get whether a given progress bar widget is at "pulsing mode" or
21129 * @param obj The progress bar object
21130 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21131 * if it's in the default one (and on errors)
21133 * @ingroup Progressbar
21135 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21138 * Start/stop a given progress bar "pulsing" animation, if its
21141 * @param obj The progress bar object
21142 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21143 * @c EINA_FALSE to @b stop it
21145 * @note This call won't do anything if @p obj is not under "pulsing mode".
21147 * @see elm_progressbar_pulse_set() for more details.
21149 * @ingroup Progressbar
21151 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21154 * Set the progress value (in percentage) on a given progress bar
21157 * @param obj The progress bar object
21158 * @param val The progress value (@b must be between @c 0.0 and @c
21161 * Use this call to set progress bar levels.
21163 * @note If you passes a value out of the specified range for @p
21164 * val, it will be interpreted as the @b closest of the @b boundary
21165 * values in the range.
21167 * @ingroup Progressbar
21169 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21172 * Get the progress value (in percentage) on a given progress bar
21175 * @param obj The progress bar object
21176 * @return The value of the progressbar
21178 * @see elm_progressbar_value_set() for more details
21180 * @ingroup Progressbar
21182 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21185 * Set the label of a given progress bar widget
21187 * @param obj The progress bar object
21188 * @param label The text label string, in UTF-8
21190 * @ingroup Progressbar
21191 * @deprecated use elm_object_text_set() instead.
21193 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21196 * Get the label of a given progress bar widget
21198 * @param obj The progressbar object
21199 * @return The text label string, in UTF-8
21201 * @ingroup Progressbar
21202 * @deprecated use elm_object_text_set() instead.
21204 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21207 * Set the icon object of a given progress bar widget
21209 * @param obj The progress bar object
21210 * @param icon The icon object
21212 * Use this call to decorate @p obj with an icon next to it.
21214 * @note Once the icon object is set, a previously set one will be
21215 * deleted. If you want to keep that old content object, use the
21216 * elm_progressbar_icon_unset() function.
21218 * @see elm_progressbar_icon_get()
21219 * @deprecated use elm_object_content_set() instead.
21221 * @ingroup Progressbar
21223 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21226 * Retrieve the icon object set for a given progress bar widget
21228 * @param obj The progress bar object
21229 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21230 * otherwise (and on errors)
21232 * @see elm_progressbar_icon_set() for more details
21233 * @deprecated use elm_object_content_set() instead.
21235 * @ingroup Progressbar
21237 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21240 * Unset an icon set on a given progress bar widget
21242 * @param obj The progress bar object
21243 * @return The icon object that was being used, if any was set, or
21244 * @c NULL, otherwise (and on errors)
21246 * This call will unparent and return the icon object which was set
21247 * for this widget, previously, on success.
21249 * @see elm_progressbar_icon_set() for more details
21250 * @deprecated use elm_object_content_unset() instead.
21252 * @ingroup Progressbar
21254 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21257 * Set the (exact) length of the bar region of a given progress bar
21260 * @param obj The progress bar object
21261 * @param size The length of the progress bar's bar region
21263 * This sets the minimum width (when in horizontal mode) or height
21264 * (when in vertical mode) of the actual bar area of the progress
21265 * bar @p obj. This in turn affects the object's minimum size. Use
21266 * this when you're not setting other size hints expanding on the
21267 * given direction (like weight and alignment hints) and you would
21268 * like it to have a specific size.
21270 * @note Icon, label and unit text around @p obj will require their
21271 * own space, which will make @p obj to require more the @p size,
21274 * @see elm_progressbar_span_size_get()
21276 * @ingroup Progressbar
21278 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21281 * Get the length set for the bar region of a given progress bar
21284 * @param obj The progress bar object
21285 * @return The length of the progress bar's bar region
21287 * If that size was not set previously, with
21288 * elm_progressbar_span_size_set(), this call will return @c 0.
21290 * @ingroup Progressbar
21292 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21295 * Set the format string for a given progress bar widget's units
21298 * @param obj The progress bar object
21299 * @param format The format string for @p obj's units label
21301 * If @c NULL is passed on @p format, it will make @p obj's units
21302 * area to be hidden completely. If not, it'll set the <b>format
21303 * string</b> for the units label's @b text. The units label is
21304 * provided a floating point value, so the units text is up display
21305 * at most one floating point falue. Note that the units label is
21306 * optional. Use a format string such as "%1.2f meters" for
21309 * @note The default format string for a progress bar is an integer
21310 * percentage, as in @c "%.0f %%".
21312 * @see elm_progressbar_unit_format_get()
21314 * @ingroup Progressbar
21316 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21319 * Retrieve the format string set for a given progress bar widget's
21322 * @param obj The progress bar object
21323 * @return The format set string for @p obj's units label or
21324 * @c NULL, if none was set (and on errors)
21326 * @see elm_progressbar_unit_format_set() for more details
21328 * @ingroup Progressbar
21330 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21333 * Set the orientation of a given progress bar widget
21335 * @param obj The progress bar object
21336 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21337 * @b horizontal, @c EINA_FALSE to make it @b vertical
21339 * Use this function to change how your progress bar is to be
21340 * disposed: vertically or horizontally.
21342 * @see elm_progressbar_horizontal_get()
21344 * @ingroup Progressbar
21346 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21349 * Retrieve the orientation of a given progress bar widget
21351 * @param obj The progress bar object
21352 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21353 * @c EINA_FALSE if it's @b vertical (and on errors)
21355 * @see elm_progressbar_horizontal_set() for more details
21357 * @ingroup Progressbar
21359 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21362 * Invert a given progress bar widget's displaying values order
21364 * @param obj The progress bar object
21365 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21366 * @c EINA_FALSE to bring it back to default, non-inverted values.
21368 * A progress bar may be @b inverted, in which state it gets its
21369 * values inverted, with high values being on the left or top and
21370 * low values on the right or bottom, as opposed to normally have
21371 * the low values on the former and high values on the latter,
21372 * respectively, for horizontal and vertical modes.
21374 * @see elm_progressbar_inverted_get()
21376 * @ingroup Progressbar
21378 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21381 * Get whether a given progress bar widget's displaying values are
21384 * @param obj The progress bar object
21385 * @return @c EINA_TRUE, if @p obj has inverted values,
21386 * @c EINA_FALSE otherwise (and on errors)
21388 * @see elm_progressbar_inverted_set() for more details
21390 * @ingroup Progressbar
21392 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21395 * @defgroup Separator Separator
21397 * @brief Separator is a very thin object used to separate other objects.
21399 * A separator can be vertical or horizontal.
21401 * @ref tutorial_separator is a good example of how to use a separator.
21405 * @brief Add a separator object to @p parent
21407 * @param parent The parent object
21409 * @return The separator object, or NULL upon failure
21411 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21413 * @brief Set the horizontal mode of a separator object
21415 * @param obj The separator object
21416 * @param horizontal If true, the separator is horizontal
21418 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21420 * @brief Get the horizontal mode of a separator object
21422 * @param obj The separator object
21423 * @return If true, the separator is horizontal
21425 * @see elm_separator_horizontal_set()
21427 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21433 * @defgroup Spinner Spinner
21434 * @ingroup Elementary
21436 * @image html img/widget/spinner/preview-00.png
21437 * @image latex img/widget/spinner/preview-00.eps
21439 * A spinner is a widget which allows the user to increase or decrease
21440 * numeric values using arrow buttons, or edit values directly, clicking
21441 * over it and typing the new value.
21443 * By default the spinner will not wrap and has a label
21444 * of "%.0f" (just showing the integer value of the double).
21446 * A spinner has a label that is formatted with floating
21447 * point values and thus accepts a printf-style format string, like
21448 * ā%1.2f unitsā.
21450 * It also allows specific values to be replaced by pre-defined labels.
21452 * Smart callbacks one can register to:
21454 * - "changed" - Whenever the spinner value is changed.
21455 * - "delay,changed" - A short time after the value is changed by the user.
21456 * This will be called only when the user stops dragging for a very short
21457 * period or when they release their finger/mouse, so it avoids possibly
21458 * expensive reactions to the value change.
21460 * Available styles for it:
21462 * - @c "vertical": up/down buttons at the right side and text left aligned.
21464 * Here is an example on its usage:
21465 * @ref spinner_example
21469 * @addtogroup Spinner
21474 * Add a new spinner widget to the given parent Elementary
21475 * (container) object.
21477 * @param parent The parent object.
21478 * @return a new spinner widget handle or @c NULL, on errors.
21480 * This function inserts a new spinner widget on the canvas.
21485 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21488 * Set the format string of the displayed label.
21490 * @param obj The spinner object.
21491 * @param fmt The format string for the label display.
21493 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21494 * string for the label text. The label text is provided a floating point
21495 * value, so the label text can display up to 1 floating point value.
21496 * Note that this is optional.
21498 * Use a format string such as "%1.2f meters" for example, and it will
21499 * display values like: "3.14 meters" for a value equal to 3.14159.
21501 * Default is "%0.f".
21503 * @see elm_spinner_label_format_get()
21507 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21510 * Get the label format of the spinner.
21512 * @param obj The spinner object.
21513 * @return The text label format string in UTF-8.
21515 * @see elm_spinner_label_format_set() for details.
21519 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21522 * Set the minimum and maximum values for the spinner.
21524 * @param obj The spinner object.
21525 * @param min The minimum value.
21526 * @param max The maximum value.
21528 * Define the allowed range of values to be selected by the user.
21530 * If actual value is less than @p min, it will be updated to @p min. If it
21531 * is bigger then @p max, will be updated to @p max. Actual value can be
21532 * get with elm_spinner_value_get().
21534 * By default, min is equal to 0, and max is equal to 100.
21536 * @warning Maximum must be greater than minimum.
21538 * @see elm_spinner_min_max_get()
21542 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21545 * Get the minimum and maximum values of the spinner.
21547 * @param obj The spinner object.
21548 * @param min Pointer where to store the minimum value.
21549 * @param max Pointer where to store the maximum value.
21551 * @note If only one value is needed, the other pointer can be passed
21554 * @see elm_spinner_min_max_set() for details.
21558 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21561 * Set the step used to increment or decrement the spinner value.
21563 * @param obj The spinner object.
21564 * @param step The step value.
21566 * This value will be incremented or decremented to the displayed value.
21567 * It will be incremented while the user keep right or top arrow pressed,
21568 * and will be decremented while the user keep left or bottom arrow pressed.
21570 * The interval to increment / decrement can be set with
21571 * elm_spinner_interval_set().
21573 * By default step value is equal to 1.
21575 * @see elm_spinner_step_get()
21579 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21582 * Get the step used to increment or decrement the spinner value.
21584 * @param obj The spinner object.
21585 * @return The step value.
21587 * @see elm_spinner_step_get() for more details.
21591 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21594 * Set the value the spinner displays.
21596 * @param obj The spinner object.
21597 * @param val The value to be displayed.
21599 * Value will be presented on the label following format specified with
21600 * elm_spinner_format_set().
21602 * @warning The value must to be between min and max values. This values
21603 * are set by elm_spinner_min_max_set().
21605 * @see elm_spinner_value_get().
21606 * @see elm_spinner_format_set().
21607 * @see elm_spinner_min_max_set().
21611 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21614 * Get the value displayed by the spinner.
21616 * @param obj The spinner object.
21617 * @return The value displayed.
21619 * @see elm_spinner_value_set() for details.
21623 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21626 * Set whether the spinner should wrap when it reaches its
21627 * minimum or maximum value.
21629 * @param obj The spinner object.
21630 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21633 * Disabled by default. If disabled, when the user tries to increment the
21635 * but displayed value plus step value is bigger than maximum value,
21637 * won't allow it. The same happens when the user tries to decrement it,
21638 * but the value less step is less than minimum value.
21640 * When wrap is enabled, in such situations it will allow these changes,
21641 * but will get the value that would be less than minimum and subtracts
21642 * from maximum. Or add the value that would be more than maximum to
21646 * @li min value = 10
21647 * @li max value = 50
21648 * @li step value = 20
21649 * @li displayed value = 20
21651 * When the user decrement value (using left or bottom arrow), it will
21652 * displays @c 40, because max - (min - (displayed - step)) is
21653 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21655 * @see elm_spinner_wrap_get().
21659 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21662 * Get whether the spinner should wrap when it reaches its
21663 * minimum or maximum value.
21665 * @param obj The spinner object
21666 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21667 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21669 * @see elm_spinner_wrap_set() for details.
21673 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21676 * Set whether the spinner can be directly edited by the user or not.
21678 * @param obj The spinner object.
21679 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21680 * don't allow users to edit it directly.
21682 * Spinner objects can have edition @b disabled, in which state they will
21683 * be changed only by arrows.
21684 * Useful for contexts
21685 * where you don't want your users to interact with it writting the value.
21687 * when using special values, the user can see real value instead
21688 * of special label on edition.
21690 * It's enabled by default.
21692 * @see elm_spinner_editable_get()
21696 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21699 * Get whether the spinner can be directly edited by the user or not.
21701 * @param obj The spinner object.
21702 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21703 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21705 * @see elm_spinner_editable_set() for details.
21709 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21712 * Set a special string to display in the place of the numerical value.
21714 * @param obj The spinner object.
21715 * @param value The value to be replaced.
21716 * @param label The label to be used.
21718 * It's useful for cases when a user should select an item that is
21719 * better indicated by a label than a value. For example, weekdays or months.
21723 * sp = elm_spinner_add(win);
21724 * elm_spinner_min_max_set(sp, 1, 3);
21725 * elm_spinner_special_value_add(sp, 1, "January");
21726 * elm_spinner_special_value_add(sp, 2, "February");
21727 * elm_spinner_special_value_add(sp, 3, "March");
21728 * evas_object_show(sp);
21733 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21736 * Set the interval on time updates for an user mouse button hold
21737 * on spinner widgets' arrows.
21739 * @param obj The spinner object.
21740 * @param interval The (first) interval value in seconds.
21742 * This interval value is @b decreased while the user holds the
21743 * mouse pointer either incrementing or decrementing spinner's value.
21745 * This helps the user to get to a given value distant from the
21746 * current one easier/faster, as it will start to change quicker and
21747 * quicker on mouse button holds.
21749 * The calculation for the next change interval value, starting from
21750 * the one set with this call, is the previous interval divided by
21751 * @c 1.05, so it decreases a little bit.
21753 * The default starting interval value for automatic changes is
21756 * @see elm_spinner_interval_get()
21760 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21763 * Get the interval on time updates for an user mouse button hold
21764 * on spinner widgets' arrows.
21766 * @param obj The spinner object.
21767 * @return The (first) interval value, in seconds, set on it.
21769 * @see elm_spinner_interval_set() for more details.
21773 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21780 * @defgroup Index Index
21782 * @image html img/widget/index/preview-00.png
21783 * @image latex img/widget/index/preview-00.eps
21785 * An index widget gives you an index for fast access to whichever
21786 * group of other UI items one might have. It's a list of text
21787 * items (usually letters, for alphabetically ordered access).
21789 * Index widgets are by default hidden and just appear when the
21790 * user clicks over it's reserved area in the canvas. In its
21791 * default theme, it's an area one @ref Fingers "finger" wide on
21792 * the right side of the index widget's container.
21794 * When items on the index are selected, smart callbacks get
21795 * called, so that its user can make other container objects to
21796 * show a given area or child object depending on the index item
21797 * selected. You'd probably be using an index together with @ref
21798 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21801 * Smart events one can add callbacks for are:
21802 * - @c "changed" - When the selected index item changes. @c
21803 * event_info is the selected item's data pointer.
21804 * - @c "delay,changed" - When the selected index item changes, but
21805 * after a small idling period. @c event_info is the selected
21806 * item's data pointer.
21807 * - @c "selected" - When the user releases a mouse button and
21808 * selects an item. @c event_info is the selected item's data
21810 * - @c "level,up" - when the user moves a finger from the first
21811 * level to the second level
21812 * - @c "level,down" - when the user moves a finger from the second
21813 * level to the first level
21815 * The @c "delay,changed" event is so that it'll wait a small time
21816 * before actually reporting those events and, moreover, just the
21817 * last event happening on those time frames will actually be
21820 * Here are some examples on its usage:
21821 * @li @ref index_example_01
21822 * @li @ref index_example_02
21826 * @addtogroup Index
21830 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21833 * Add a new index widget to the given parent Elementary
21834 * (container) object
21836 * @param parent The parent object
21837 * @return a new index widget handle or @c NULL, on errors
21839 * This function inserts a new index widget on the canvas.
21843 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21846 * Set whether a given index widget is or not visible,
21849 * @param obj The index object
21850 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21852 * Not to be confused with visible as in @c evas_object_show() --
21853 * visible with regard to the widget's auto hiding feature.
21855 * @see elm_index_active_get()
21859 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21862 * Get whether a given index widget is currently visible or not.
21864 * @param obj The index object
21865 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21867 * @see elm_index_active_set() for more details
21871 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21874 * Set the items level for a given index widget.
21876 * @param obj The index object.
21877 * @param level @c 0 or @c 1, the currently implemented levels.
21879 * @see elm_index_item_level_get()
21883 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21886 * Get the items level set for a given index widget.
21888 * @param obj The index object.
21889 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21891 * @see elm_index_item_level_set() for more information
21895 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21898 * Returns the last selected item's data, for a given index widget.
21900 * @param obj The index object.
21901 * @return The item @b data associated to the last selected item on
21902 * @p obj (or @c NULL, on errors).
21904 * @warning The returned value is @b not an #Elm_Index_Item item
21905 * handle, but the data associated to it (see the @c item parameter
21906 * in elm_index_item_append(), as an example).
21910 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21913 * Append a new item on a given index widget.
21915 * @param obj The index object.
21916 * @param letter Letter under which the item should be indexed
21917 * @param item The item data to set for the index's item
21919 * Despite the most common usage of the @p letter argument is for
21920 * single char strings, one could use arbitrary strings as index
21923 * @c item will be the pointer returned back on @c "changed", @c
21924 * "delay,changed" and @c "selected" smart events.
21928 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21931 * Prepend a new item on a given index widget.
21933 * @param obj The index object.
21934 * @param letter Letter under which the item should be indexed
21935 * @param item The item data to set for the index's item
21937 * Despite the most common usage of the @p letter argument is for
21938 * single char strings, one could use arbitrary strings as index
21941 * @c item will be the pointer returned back on @c "changed", @c
21942 * "delay,changed" and @c "selected" smart events.
21946 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21949 * Append a new item, on a given index widget, <b>after the item
21950 * having @p relative as data</b>.
21952 * @param obj The index object.
21953 * @param letter Letter under which the item should be indexed
21954 * @param item The item data to set for the index's item
21955 * @param relative The item data of the index item to be the
21956 * predecessor of this new one
21958 * Despite the most common usage of the @p letter argument is for
21959 * single char strings, one could use arbitrary strings as index
21962 * @c item will be the pointer returned back on @c "changed", @c
21963 * "delay,changed" and @c "selected" smart events.
21965 * @note If @p relative is @c NULL or if it's not found to be data
21966 * set on any previous item on @p obj, this function will behave as
21967 * elm_index_item_append().
21971 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21974 * Prepend a new item, on a given index widget, <b>after the item
21975 * having @p relative as data</b>.
21977 * @param obj The index object.
21978 * @param letter Letter under which the item should be indexed
21979 * @param item The item data to set for the index's item
21980 * @param relative The item data of the index item to be the
21981 * successor of this new one
21983 * Despite the most common usage of the @p letter argument is for
21984 * single char strings, one could use arbitrary strings as index
21987 * @c item will be the pointer returned back on @c "changed", @c
21988 * "delay,changed" and @c "selected" smart events.
21990 * @note If @p relative is @c NULL or if it's not found to be data
21991 * set on any previous item on @p obj, this function will behave as
21992 * elm_index_item_prepend().
21996 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21999 * Insert a new item into the given index widget, using @p cmp_func
22000 * function to sort items (by item handles).
22002 * @param obj The index object.
22003 * @param letter Letter under which the item should be indexed
22004 * @param item The item data to set for the index's item
22005 * @param cmp_func The comparing function to be used to sort index
22006 * items <b>by #Elm_Index_Item item handles</b>
22007 * @param cmp_data_func A @b fallback function to be called for the
22008 * sorting of index items <b>by item data</b>). It will be used
22009 * when @p cmp_func returns @c 0 (equality), which means an index
22010 * item with provided item data already exists. To decide which
22011 * data item should be pointed to by the index item in question, @p
22012 * cmp_data_func will be used. If @p cmp_data_func returns a
22013 * non-negative value, the previous index item data will be
22014 * replaced by the given @p item pointer. If the previous data need
22015 * to be freed, it should be done by the @p cmp_data_func function,
22016 * because all references to it will be lost. If this function is
22017 * not provided (@c NULL is given), index items will be @b
22018 * duplicated, if @p cmp_func returns @c 0.
22020 * Despite the most common usage of the @p letter argument is for
22021 * single char strings, one could use arbitrary strings as index
22024 * @c item will be the pointer returned back on @c "changed", @c
22025 * "delay,changed" and @c "selected" smart events.
22029 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);
22032 * Remove an item from a given index widget, <b>to be referenced by
22033 * it's data value</b>.
22035 * @param obj The index object
22036 * @param item The item's data pointer for the item to be removed
22039 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22040 * that callback function will be called by this one.
22042 * @warning The item to be removed from @p obj will be found via
22043 * its item data pointer, and not by an #Elm_Index_Item handle.
22047 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22050 * Find a given index widget's item, <b>using item data</b>.
22052 * @param obj The index object
22053 * @param item The item data pointed to by the desired index item
22054 * @return The index item handle, if found, or @c NULL otherwise
22058 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22061 * Removes @b all items from a given index widget.
22063 * @param obj The index object.
22065 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22066 * that callback function will be called for each item in @p obj.
22070 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22073 * Go to a given items level on a index widget
22075 * @param obj The index object
22076 * @param level The index level (one of @c 0 or @c 1)
22080 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22083 * Return the data associated with a given index widget item
22085 * @param it The index widget item handle
22086 * @return The data associated with @p it
22088 * @see elm_index_item_data_set()
22092 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22095 * Set the data associated with a given index widget item
22097 * @param it The index widget item handle
22098 * @param data The new data pointer to set to @p it
22100 * This sets new item data on @p it.
22102 * @warning The old data pointer won't be touched by this function, so
22103 * the user had better to free that old data himself/herself.
22107 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22110 * Set the function to be called when a given index widget item is freed.
22112 * @param it The item to set the callback on
22113 * @param func The function to call on the item's deletion
22115 * When called, @p func will have both @c data and @c event_info
22116 * arguments with the @p it item's data value and, naturally, the
22117 * @c obj argument with a handle to the parent index widget.
22121 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22124 * Get the letter (string) set on a given index widget item.
22126 * @param it The index item handle
22127 * @return The letter string set on @p it
22131 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22135 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22142 * @defgroup Photocam Photocam
22144 * @image html img/widget/photocam/preview-00.png
22145 * @image latex img/widget/photocam/preview-00.eps
22147 * This is a widget specifically for displaying high-resolution digital
22148 * camera photos giving speedy feedback (fast load), low memory footprint
22149 * and zooming and panning as well as fitting logic. It is entirely focused
22150 * on jpeg images, and takes advantage of properties of the jpeg format (via
22151 * evas loader features in the jpeg loader).
22153 * Signals that you can add callbacks for are:
22154 * @li "clicked" - This is called when a user has clicked the photo without
22156 * @li "press" - This is called when a user has pressed down on the photo.
22157 * @li "longpressed" - This is called when a user has pressed down on the
22158 * photo for a long time without dragging around.
22159 * @li "clicked,double" - This is called when a user has double-clicked the
22161 * @li "load" - Photo load begins.
22162 * @li "loaded" - This is called when the image file load is complete for the
22163 * first view (low resolution blurry version).
22164 * @li "load,detail" - Photo detailed data load begins.
22165 * @li "loaded,detail" - This is called when the image file load is complete
22166 * for the detailed image data (full resolution needed).
22167 * @li "zoom,start" - Zoom animation started.
22168 * @li "zoom,stop" - Zoom animation stopped.
22169 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22170 * @li "scroll" - the content has been scrolled (moved)
22171 * @li "scroll,anim,start" - scrolling animation has started
22172 * @li "scroll,anim,stop" - scrolling animation has stopped
22173 * @li "scroll,drag,start" - dragging the contents around has started
22174 * @li "scroll,drag,stop" - dragging the contents around has stopped
22176 * @ref tutorial_photocam shows the API in action.
22180 * @brief Types of zoom available.
22182 typedef enum _Elm_Photocam_Zoom_Mode
22184 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22185 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22186 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22187 ELM_PHOTOCAM_ZOOM_MODE_LAST
22188 } Elm_Photocam_Zoom_Mode;
22190 * @brief Add a new Photocam object
22192 * @param parent The parent object
22193 * @return The new object or NULL if it cannot be created
22195 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22197 * @brief Set the photo file to be shown
22199 * @param obj The photocam object
22200 * @param file The photo file
22201 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22203 * This sets (and shows) the specified file (with a relative or absolute
22204 * path) and will return a load error (same error that
22205 * evas_object_image_load_error_get() will return). The image will change and
22206 * adjust its size at this point and begin a background load process for this
22207 * photo that at some time in the future will be displayed at the full
22210 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22212 * @brief Returns the path of the current image file
22214 * @param obj The photocam object
22215 * @return Returns the path
22217 * @see elm_photocam_file_set()
22219 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22221 * @brief Set the zoom level of the photo
22223 * @param obj The photocam object
22224 * @param zoom The zoom level to set
22226 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22227 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22228 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22229 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22232 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22234 * @brief Get the zoom level of the photo
22236 * @param obj The photocam object
22237 * @return The current zoom level
22239 * This returns the current zoom level of the photocam object. Note that if
22240 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22241 * (which is the default), the zoom level may be changed at any time by the
22242 * photocam object itself to account for photo size and photocam viewpoer
22245 * @see elm_photocam_zoom_set()
22246 * @see elm_photocam_zoom_mode_set()
22248 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22250 * @brief Set the zoom mode
22252 * @param obj The photocam object
22253 * @param mode The desired mode
22255 * This sets the zoom mode to manual or one of several automatic levels.
22256 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22257 * elm_photocam_zoom_set() and will stay at that level until changed by code
22258 * or until zoom mode is changed. This is the default mode. The Automatic
22259 * modes will allow the photocam object to automatically adjust zoom mode
22260 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22261 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22262 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22263 * pixels within the frame are left unfilled.
22265 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22267 * @brief Get the zoom mode
22269 * @param obj The photocam object
22270 * @return The current zoom mode
22272 * This gets the current zoom mode of the photocam object.
22274 * @see elm_photocam_zoom_mode_set()
22276 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22278 * @brief Get the current image pixel width and height
22280 * @param obj The photocam object
22281 * @param w A pointer to the width return
22282 * @param h A pointer to the height return
22284 * This gets the current photo pixel width and height (for the original).
22285 * The size will be returned in the integers @p w and @p h that are pointed
22288 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22290 * @brief Get the area of the image that is currently shown
22293 * @param x A pointer to the X-coordinate of region
22294 * @param y A pointer to the Y-coordinate of region
22295 * @param w A pointer to the width
22296 * @param h A pointer to the height
22298 * @see elm_photocam_image_region_show()
22299 * @see elm_photocam_image_region_bring_in()
22301 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22303 * @brief Set the viewed portion of the image
22305 * @param obj The photocam object
22306 * @param x X-coordinate of region in image original pixels
22307 * @param y Y-coordinate of region in image original pixels
22308 * @param w Width of region in image original pixels
22309 * @param h Height of region in image original pixels
22311 * This shows the region of the image without using animation.
22313 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22315 * @brief Bring in the viewed portion of the image
22317 * @param obj The photocam object
22318 * @param x X-coordinate of region in image original pixels
22319 * @param y Y-coordinate of region in image original pixels
22320 * @param w Width of region in image original pixels
22321 * @param h Height of region in image original pixels
22323 * This shows the region of the image using animation.
22325 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22327 * @brief Set the paused state for photocam
22329 * @param obj The photocam object
22330 * @param paused The pause state to set
22332 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22333 * photocam. The default is off. This will stop zooming using animation on
22334 * zoom levels changes and change instantly. This will stop any existing
22335 * animations that are running.
22337 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22339 * @brief Get the paused state for photocam
22341 * @param obj The photocam object
22342 * @return The current paused state
22344 * This gets the current paused state for the photocam object.
22346 * @see elm_photocam_paused_set()
22348 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22350 * @brief Get the internal low-res image used for photocam
22352 * @param obj The photocam object
22353 * @return The internal image object handle, or NULL if none exists
22355 * This gets the internal image object inside photocam. Do not modify it. It
22356 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22357 * deleted at any time as well.
22359 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22361 * @brief Set the photocam scrolling bouncing.
22363 * @param obj The photocam object
22364 * @param h_bounce bouncing for horizontal
22365 * @param v_bounce bouncing for vertical
22367 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22369 * @brief Get the photocam scrolling bouncing.
22371 * @param obj The photocam object
22372 * @param h_bounce bouncing for horizontal
22373 * @param v_bounce bouncing for vertical
22375 * @see elm_photocam_bounce_set()
22377 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22383 * @defgroup Map Map
22384 * @ingroup Elementary
22386 * @image html img/widget/map/preview-00.png
22387 * @image latex img/widget/map/preview-00.eps
22389 * This is a widget specifically for displaying a map. It uses basically
22390 * OpenStreetMap provider http://www.openstreetmap.org/,
22391 * but custom providers can be added.
22393 * It supports some basic but yet nice features:
22394 * @li zoom and scroll
22395 * @li markers with content to be displayed when user clicks over it
22396 * @li group of markers
22399 * Smart callbacks one can listen to:
22401 * - "clicked" - This is called when a user has clicked the map without
22403 * - "press" - This is called when a user has pressed down on the map.
22404 * - "longpressed" - This is called when a user has pressed down on the map
22405 * for a long time without dragging around.
22406 * - "clicked,double" - This is called when a user has double-clicked
22408 * - "load,detail" - Map detailed data load begins.
22409 * - "loaded,detail" - This is called when all currently visible parts of
22410 * the map are loaded.
22411 * - "zoom,start" - Zoom animation started.
22412 * - "zoom,stop" - Zoom animation stopped.
22413 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22414 * - "scroll" - the content has been scrolled (moved).
22415 * - "scroll,anim,start" - scrolling animation has started.
22416 * - "scroll,anim,stop" - scrolling animation has stopped.
22417 * - "scroll,drag,start" - dragging the contents around has started.
22418 * - "scroll,drag,stop" - dragging the contents around has stopped.
22419 * - "downloaded" - This is called when all currently required map images
22421 * - "route,load" - This is called when route request begins.
22422 * - "route,loaded" - This is called when route request ends.
22423 * - "name,load" - This is called when name request begins.
22424 * - "name,loaded- This is called when name request ends.
22426 * Available style for map widget:
22429 * Available style for markers:
22434 * Available style for marker bubble:
22437 * List of examples:
22438 * @li @ref map_example_01
22439 * @li @ref map_example_02
22440 * @li @ref map_example_03
22449 * @enum _Elm_Map_Zoom_Mode
22450 * @typedef Elm_Map_Zoom_Mode
22452 * Set map's zoom behavior. It can be set to manual or automatic.
22454 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22456 * Values <b> don't </b> work as bitmask, only one can be choosen.
22458 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22459 * than the scroller view.
22461 * @see elm_map_zoom_mode_set()
22462 * @see elm_map_zoom_mode_get()
22466 typedef enum _Elm_Map_Zoom_Mode
22468 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22469 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22470 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22471 ELM_MAP_ZOOM_MODE_LAST
22472 } Elm_Map_Zoom_Mode;
22475 * @enum _Elm_Map_Route_Sources
22476 * @typedef Elm_Map_Route_Sources
22478 * Set route service to be used. By default used source is
22479 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22481 * @see elm_map_route_source_set()
22482 * @see elm_map_route_source_get()
22486 typedef enum _Elm_Map_Route_Sources
22488 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22489 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. */
22490 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22491 ELM_MAP_ROUTE_SOURCE_LAST
22492 } Elm_Map_Route_Sources;
22494 typedef enum _Elm_Map_Name_Sources
22496 ELM_MAP_NAME_SOURCE_NOMINATIM,
22497 ELM_MAP_NAME_SOURCE_LAST
22498 } Elm_Map_Name_Sources;
22501 * @enum _Elm_Map_Route_Type
22502 * @typedef Elm_Map_Route_Type
22504 * Set type of transport used on route.
22506 * @see elm_map_route_add()
22510 typedef enum _Elm_Map_Route_Type
22512 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22513 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22514 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22515 ELM_MAP_ROUTE_TYPE_LAST
22516 } Elm_Map_Route_Type;
22519 * @enum _Elm_Map_Route_Method
22520 * @typedef Elm_Map_Route_Method
22522 * Set the routing method, what should be priorized, time or distance.
22524 * @see elm_map_route_add()
22528 typedef enum _Elm_Map_Route_Method
22530 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22531 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22532 ELM_MAP_ROUTE_METHOD_LAST
22533 } Elm_Map_Route_Method;
22535 typedef enum _Elm_Map_Name_Method
22537 ELM_MAP_NAME_METHOD_SEARCH,
22538 ELM_MAP_NAME_METHOD_REVERSE,
22539 ELM_MAP_NAME_METHOD_LAST
22540 } Elm_Map_Name_Method;
22542 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(). */
22543 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(). */
22544 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(). */
22545 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(). */
22546 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22547 typedef struct _Elm_Map_Track Elm_Map_Track;
22549 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. */
22550 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22551 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22552 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22554 typedef char *(*ElmMapModuleSourceFunc) (void);
22555 typedef int (*ElmMapModuleZoomMinFunc) (void);
22556 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22557 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22558 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22559 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22560 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22561 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22562 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22565 * Add a new map widget to the given parent Elementary (container) object.
22567 * @param parent The parent object.
22568 * @return a new map widget handle or @c NULL, on errors.
22570 * This function inserts a new map widget on the canvas.
22574 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22577 * Set the zoom level of the map.
22579 * @param obj The map object.
22580 * @param zoom The zoom level to set.
22582 * This sets the zoom level.
22584 * It will respect limits defined by elm_map_source_zoom_min_set() and
22585 * elm_map_source_zoom_max_set().
22587 * By default these values are 0 (world map) and 18 (maximum zoom).
22589 * This function should be used when zoom mode is set to
22590 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22591 * with elm_map_zoom_mode_set().
22593 * @see elm_map_zoom_mode_set().
22594 * @see elm_map_zoom_get().
22598 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22601 * Get the zoom level of the map.
22603 * @param obj The map object.
22604 * @return The current zoom level.
22606 * This returns the current zoom level of the map object.
22608 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22609 * (which is the default), the zoom level may be changed at any time by the
22610 * map object itself to account for map size and map viewport size.
22612 * @see elm_map_zoom_set() for details.
22616 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22619 * Set the zoom mode used by the map object.
22621 * @param obj The map object.
22622 * @param mode The zoom mode of the map, being it one of
22623 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22624 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22626 * This sets the zoom mode to manual or one of the automatic levels.
22627 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22628 * elm_map_zoom_set() and will stay at that level until changed by code
22629 * or until zoom mode is changed. This is the default mode.
22631 * The Automatic modes will allow the map object to automatically
22632 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22633 * adjust zoom so the map fits inside the scroll frame with no pixels
22634 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22635 * ensure no pixels within the frame are left unfilled. Do not forget that
22636 * the valid sizes are 2^zoom, consequently the map may be smaller than
22637 * the scroller view.
22639 * @see elm_map_zoom_set()
22643 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22646 * Get the zoom mode used by the map object.
22648 * @param obj The map object.
22649 * @return The zoom mode of the map, being it one of
22650 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22651 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22653 * This function returns the current zoom mode used by the map object.
22655 * @see elm_map_zoom_mode_set() for more details.
22659 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22662 * Get the current coordinates of the map.
22664 * @param obj The map object.
22665 * @param lon Pointer where to store longitude.
22666 * @param lat Pointer where to store latitude.
22668 * This gets the current center coordinates of the map object. It can be
22669 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22671 * @see elm_map_geo_region_bring_in()
22672 * @see elm_map_geo_region_show()
22676 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22679 * Animatedly bring in given coordinates to the center of the map.
22681 * @param obj The map object.
22682 * @param lon Longitude to center at.
22683 * @param lat Latitude to center at.
22685 * This causes map to jump to the given @p lat and @p lon coordinates
22686 * and show it (by scrolling) in the center of the viewport, if it is not
22687 * already centered. This will use animation to do so and take a period
22688 * of time to complete.
22690 * @see elm_map_geo_region_show() for a function to avoid animation.
22691 * @see elm_map_geo_region_get()
22695 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22698 * Show the given coordinates at the center of the map, @b immediately.
22700 * @param obj The map object.
22701 * @param lon Longitude to center at.
22702 * @param lat Latitude to center at.
22704 * This causes map to @b redraw its viewport's contents to the
22705 * region contining the given @p lat and @p lon, that will be moved to the
22706 * center of the map.
22708 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22709 * @see elm_map_geo_region_get()
22713 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22716 * Pause or unpause the map.
22718 * @param obj The map object.
22719 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22722 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22725 * The default is off.
22727 * This will stop zooming using animation, changing zoom levels will
22728 * change instantly. This will stop any existing animations that are running.
22730 * @see elm_map_paused_get()
22734 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22737 * Get a value whether map is paused or not.
22739 * @param obj The map object.
22740 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22741 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22743 * This gets the current paused state for the map object.
22745 * @see elm_map_paused_set() for details.
22749 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22752 * Set to show markers during zoom level changes or not.
22754 * @param obj The map object.
22755 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22758 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22761 * The default is off.
22763 * This will stop zooming using animation, changing zoom levels will
22764 * change instantly. This will stop any existing animations that are running.
22766 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22769 * The default is off.
22771 * Enabling it will force the map to stop displaying the markers during
22772 * zoom level changes. Set to on if you have a large number of markers.
22774 * @see elm_map_paused_markers_get()
22778 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22781 * Get a value whether markers will be displayed on zoom level changes or not
22783 * @param obj The map object.
22784 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22785 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22787 * This gets the current markers paused state for the map object.
22789 * @see elm_map_paused_markers_set() for details.
22793 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22796 * Get the information of downloading status.
22798 * @param obj The map object.
22799 * @param try_num Pointer where to store number of tiles being downloaded.
22800 * @param finish_num Pointer where to store number of tiles successfully
22803 * This gets the current downloading status for the map object, the number
22804 * of tiles being downloaded and the number of tiles already downloaded.
22808 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22811 * Convert a pixel coordinate (x,y) into a geographic coordinate
22812 * (longitude, latitude).
22814 * @param obj The map object.
22815 * @param x the coordinate.
22816 * @param y the coordinate.
22817 * @param size the size in pixels of the map.
22818 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22819 * @param lon Pointer where to store the longitude that correspond to x.
22820 * @param lat Pointer where to store the latitude that correspond to y.
22822 * @note Origin pixel point is the top left corner of the viewport.
22823 * Map zoom and size are taken on account.
22825 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22829 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);
22832 * Convert a geographic coordinate (longitude, latitude) into a pixel
22833 * coordinate (x, y).
22835 * @param obj The map object.
22836 * @param lon the longitude.
22837 * @param lat the latitude.
22838 * @param size the size in pixels of the map. The map is a square
22839 * and generally his size is : pow(2.0, zoom)*256.
22840 * @param x Pointer where to store the horizontal pixel coordinate that
22841 * correspond to the longitude.
22842 * @param y Pointer where to store the vertical pixel coordinate that
22843 * correspond to the latitude.
22845 * @note Origin pixel point is the top left corner of the viewport.
22846 * Map zoom and size are taken on account.
22848 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22852 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);
22855 * Convert a geographic coordinate (longitude, latitude) into a name
22858 * @param obj The map object.
22859 * @param lon the longitude.
22860 * @param lat the latitude.
22861 * @return name A #Elm_Map_Name handle for this coordinate.
22863 * To get the string for this address, elm_map_name_address_get()
22866 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22870 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22873 * Convert a name (address) into a geographic coordinate
22874 * (longitude, latitude).
22876 * @param obj The map object.
22877 * @param name The address.
22878 * @return name A #Elm_Map_Name handle for this address.
22880 * To get the longitude and latitude, elm_map_name_region_get()
22883 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22887 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22890 * Convert a pixel coordinate into a rotated pixel coordinate.
22892 * @param obj The map object.
22893 * @param x horizontal coordinate of the point to rotate.
22894 * @param y vertical coordinate of the point to rotate.
22895 * @param cx rotation's center horizontal position.
22896 * @param cy rotation's center vertical position.
22897 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22898 * @param xx Pointer where to store rotated x.
22899 * @param yy Pointer where to store rotated y.
22903 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);
22906 * Add a new marker to the map object.
22908 * @param obj The map object.
22909 * @param lon The longitude of the marker.
22910 * @param lat The latitude of the marker.
22911 * @param clas The class, to use when marker @b isn't grouped to others.
22912 * @param clas_group The class group, to use when marker is grouped to others
22913 * @param data The data passed to the callbacks.
22915 * @return The created marker or @c NULL upon failure.
22917 * A marker will be created and shown in a specific point of the map, defined
22918 * by @p lon and @p lat.
22920 * It will be displayed using style defined by @p class when this marker
22921 * is displayed alone (not grouped). A new class can be created with
22922 * elm_map_marker_class_new().
22924 * If the marker is grouped to other markers, it will be displayed with
22925 * style defined by @p class_group. Markers with the same group are grouped
22926 * if they are close. A new group class can be created with
22927 * elm_map_marker_group_class_new().
22929 * Markers created with this method can be deleted with
22930 * elm_map_marker_remove().
22932 * A marker can have associated content to be displayed by a bubble,
22933 * when a user click over it, as well as an icon. These objects will
22934 * be fetch using class' callback functions.
22936 * @see elm_map_marker_class_new()
22937 * @see elm_map_marker_group_class_new()
22938 * @see elm_map_marker_remove()
22942 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);
22945 * Set the maximum numbers of markers' content to be displayed in a group.
22947 * @param obj The map object.
22948 * @param max The maximum numbers of items displayed in a bubble.
22950 * A bubble will be displayed when the user clicks over the group,
22951 * and will place the content of markers that belong to this group
22954 * A group can have a long list of markers, consequently the creation
22955 * of the content of the bubble can be very slow.
22957 * In order to avoid this, a maximum number of items is displayed
22960 * By default this number is 30.
22962 * Marker with the same group class are grouped if they are close.
22964 * @see elm_map_marker_add()
22968 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22971 * Remove a marker from the map.
22973 * @param marker The marker to remove.
22975 * @see elm_map_marker_add()
22979 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22982 * Get the current coordinates of the marker.
22984 * @param marker marker.
22985 * @param lat Pointer where to store the marker's latitude.
22986 * @param lon Pointer where to store the marker's longitude.
22988 * These values are set when adding markers, with function
22989 * elm_map_marker_add().
22991 * @see elm_map_marker_add()
22995 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22998 * Animatedly bring in given marker to the center of the map.
23000 * @param marker The marker to center at.
23002 * This causes map to jump to the given @p marker's coordinates
23003 * and show it (by scrolling) in the center of the viewport, if it is not
23004 * already centered. This will use animation to do so and take a period
23005 * of time to complete.
23007 * @see elm_map_marker_show() for a function to avoid animation.
23008 * @see elm_map_marker_region_get()
23012 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23015 * Show the given marker at the center of the map, @b immediately.
23017 * @param marker The marker to center at.
23019 * This causes map to @b redraw its viewport's contents to the
23020 * region contining the given @p marker's coordinates, that will be
23021 * moved to the center of the map.
23023 * @see elm_map_marker_bring_in() for a function to move with animation.
23024 * @see elm_map_markers_list_show() if more than one marker need to be
23026 * @see elm_map_marker_region_get()
23030 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23033 * Move and zoom the map to display a list of markers.
23035 * @param markers A list of #Elm_Map_Marker handles.
23037 * The map will be centered on the center point of the markers in the list.
23038 * Then the map will be zoomed in order to fit the markers using the maximum
23039 * zoom which allows display of all the markers.
23041 * @warning All the markers should belong to the same map object.
23043 * @see elm_map_marker_show() to show a single marker.
23044 * @see elm_map_marker_bring_in()
23048 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23051 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23053 * @param marker The marker wich content should be returned.
23054 * @return Return the evas object if it exists, else @c NULL.
23056 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23057 * elm_map_marker_class_get_cb_set() should be used.
23059 * This content is what will be inside the bubble that will be displayed
23060 * when an user clicks over the marker.
23062 * This returns the actual Evas object used to be placed inside
23063 * the bubble. This may be @c NULL, as it may
23064 * not have been created or may have been deleted, at any time, by
23065 * the map. <b>Do not modify this object</b> (move, resize,
23066 * show, hide, etc.), as the map is controlling it. This
23067 * function is for querying, emitting custom signals or hooking
23068 * lower level callbacks for events on that object. Do not delete
23069 * this object under any circumstances.
23073 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23076 * Update the marker
23078 * @param marker The marker to be updated.
23080 * If a content is set to this marker, it will call function to delete it,
23081 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23082 * #ElmMapMarkerGetFunc.
23084 * These functions are set for the marker class with
23085 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23089 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23092 * Close all the bubbles opened by the user.
23094 * @param obj The map object.
23096 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23097 * when the user clicks on a marker.
23099 * This functions is set for the marker class with
23100 * elm_map_marker_class_get_cb_set().
23104 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23107 * Create a new group class.
23109 * @param obj The map object.
23110 * @return Returns the new group class.
23112 * Each marker must be associated to a group class. Markers in the same
23113 * group are grouped if they are close.
23115 * The group class defines the style of the marker when a marker is grouped
23116 * to others markers. When it is alone, another class will be used.
23118 * A group class will need to be provided when creating a marker with
23119 * elm_map_marker_add().
23121 * Some properties and functions can be set by class, as:
23122 * - style, with elm_map_group_class_style_set()
23123 * - data - to be associated to the group class. It can be set using
23124 * elm_map_group_class_data_set().
23125 * - min zoom to display markers, set with
23126 * elm_map_group_class_zoom_displayed_set().
23127 * - max zoom to group markers, set using
23128 * elm_map_group_class_zoom_grouped_set().
23129 * - visibility - set if markers will be visible or not, set with
23130 * elm_map_group_class_hide_set().
23131 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23132 * It can be set using elm_map_group_class_icon_cb_set().
23134 * @see elm_map_marker_add()
23135 * @see elm_map_group_class_style_set()
23136 * @see elm_map_group_class_data_set()
23137 * @see elm_map_group_class_zoom_displayed_set()
23138 * @see elm_map_group_class_zoom_grouped_set()
23139 * @see elm_map_group_class_hide_set()
23140 * @see elm_map_group_class_icon_cb_set()
23144 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23147 * Set the marker's style of a group class.
23149 * @param clas The group class.
23150 * @param style The style to be used by markers.
23152 * Each marker must be associated to a group class, and will use the style
23153 * defined by such class when grouped to other markers.
23155 * The following styles are provided by default theme:
23156 * @li @c radio - blue circle
23157 * @li @c radio2 - green circle
23160 * @see elm_map_group_class_new() for more details.
23161 * @see elm_map_marker_add()
23165 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23168 * Set the icon callback function of a group class.
23170 * @param clas The group class.
23171 * @param icon_get The callback function that will return the icon.
23173 * Each marker must be associated to a group class, and it can display a
23174 * custom icon. The function @p icon_get must return this icon.
23176 * @see elm_map_group_class_new() for more details.
23177 * @see elm_map_marker_add()
23181 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23184 * Set the data associated to the group class.
23186 * @param clas The group class.
23187 * @param data The new user data.
23189 * This data will be passed for callback functions, like icon get callback,
23190 * that can be set with elm_map_group_class_icon_cb_set().
23192 * If a data was previously set, the object will lose the pointer for it,
23193 * so if needs to be freed, you must do it yourself.
23195 * @see elm_map_group_class_new() for more details.
23196 * @see elm_map_group_class_icon_cb_set()
23197 * @see elm_map_marker_add()
23201 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23204 * Set the minimum zoom from where the markers are displayed.
23206 * @param clas The group class.
23207 * @param zoom The minimum zoom.
23209 * Markers only will be displayed when the map is displayed at @p zoom
23212 * @see elm_map_group_class_new() for more details.
23213 * @see elm_map_marker_add()
23217 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23220 * Set the zoom from where the markers are no more grouped.
23222 * @param clas The group class.
23223 * @param zoom The maximum zoom.
23225 * Markers only will be grouped when the map is displayed at
23226 * less than @p zoom.
23228 * @see elm_map_group_class_new() for more details.
23229 * @see elm_map_marker_add()
23233 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23236 * Set if the markers associated to the group class @clas are hidden or not.
23238 * @param clas The group class.
23239 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23242 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23247 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23250 * Create a new marker class.
23252 * @param obj The map object.
23253 * @return Returns the new group class.
23255 * Each marker must be associated to a class.
23257 * The marker class defines the style of the marker when a marker is
23258 * displayed alone, i.e., not grouped to to others markers. When grouped
23259 * it will use group class style.
23261 * A marker class will need to be provided when creating a marker with
23262 * elm_map_marker_add().
23264 * Some properties and functions can be set by class, as:
23265 * - style, with elm_map_marker_class_style_set()
23266 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23267 * It can be set using elm_map_marker_class_icon_cb_set().
23268 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23269 * Set using elm_map_marker_class_get_cb_set().
23270 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23271 * Set using elm_map_marker_class_del_cb_set().
23273 * @see elm_map_marker_add()
23274 * @see elm_map_marker_class_style_set()
23275 * @see elm_map_marker_class_icon_cb_set()
23276 * @see elm_map_marker_class_get_cb_set()
23277 * @see elm_map_marker_class_del_cb_set()
23281 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23284 * Set the marker's style of a marker class.
23286 * @param clas The marker class.
23287 * @param style The style to be used by markers.
23289 * Each marker must be associated to a marker class, and will use the style
23290 * defined by such class when alone, i.e., @b not grouped to other markers.
23292 * The following styles are provided by default theme:
23297 * @see elm_map_marker_class_new() for more details.
23298 * @see elm_map_marker_add()
23302 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23305 * Set the icon callback function of a marker class.
23307 * @param clas The marker class.
23308 * @param icon_get The callback function that will return the icon.
23310 * Each marker must be associated to a marker class, and it can display a
23311 * custom icon. The function @p icon_get must return this icon.
23313 * @see elm_map_marker_class_new() for more details.
23314 * @see elm_map_marker_add()
23318 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23321 * Set the bubble content callback function of a marker class.
23323 * @param clas The marker class.
23324 * @param get The callback function that will return the content.
23326 * Each marker must be associated to a marker class, and it can display a
23327 * a content on a bubble that opens when the user click over the marker.
23328 * The function @p get must return this content object.
23330 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23333 * @see elm_map_marker_class_new() for more details.
23334 * @see elm_map_marker_class_del_cb_set()
23335 * @see elm_map_marker_add()
23339 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23342 * Set the callback function used to delete bubble content of a marker class.
23344 * @param clas The marker class.
23345 * @param del The callback function that will delete the content.
23347 * Each marker must be associated to a marker class, and it can display a
23348 * a content on a bubble that opens when the user click over the marker.
23349 * The function to return such content can be set with
23350 * elm_map_marker_class_get_cb_set().
23352 * If this content must be freed, a callback function need to be
23353 * set for that task with this function.
23355 * If this callback is defined it will have to delete (or not) the
23356 * object inside, but if the callback is not defined the object will be
23357 * destroyed with evas_object_del().
23359 * @see elm_map_marker_class_new() for more details.
23360 * @see elm_map_marker_class_get_cb_set()
23361 * @see elm_map_marker_add()
23365 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23368 * Get the list of available sources.
23370 * @param obj The map object.
23371 * @return The source names list.
23373 * It will provide a list with all available sources, that can be set as
23374 * current source with elm_map_source_name_set(), or get with
23375 * elm_map_source_name_get().
23377 * Available sources:
23383 * @see elm_map_source_name_set() for more details.
23384 * @see elm_map_source_name_get()
23388 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23391 * Set the source of the map.
23393 * @param obj The map object.
23394 * @param source The source to be used.
23396 * Map widget retrieves images that composes the map from a web service.
23397 * This web service can be set with this method.
23399 * A different service can return a different maps with different
23400 * information and it can use different zoom values.
23402 * The @p source_name need to match one of the names provided by
23403 * elm_map_source_names_get().
23405 * The current source can be get using elm_map_source_name_get().
23407 * @see elm_map_source_names_get()
23408 * @see elm_map_source_name_get()
23413 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23416 * Get the name of currently used source.
23418 * @param obj The map object.
23419 * @return Returns the name of the source in use.
23421 * @see elm_map_source_name_set() for more details.
23425 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23428 * Set the source of the route service to be used by the map.
23430 * @param obj The map object.
23431 * @param source The route service to be used, being it one of
23432 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23433 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23435 * Each one has its own algorithm, so the route retrieved may
23436 * differ depending on the source route. Now, only the default is working.
23438 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23439 * http://www.yournavigation.org/.
23441 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23442 * assumptions. Its routing core is based on Contraction Hierarchies.
23444 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23446 * @see elm_map_route_source_get().
23450 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23453 * Get the current route source.
23455 * @param obj The map object.
23456 * @return The source of the route service used by the map.
23458 * @see elm_map_route_source_set() for details.
23462 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23465 * Set the minimum zoom of the source.
23467 * @param obj The map object.
23468 * @param zoom New minimum zoom value to be used.
23470 * By default, it's 0.
23474 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23477 * Get the minimum zoom of the source.
23479 * @param obj The map object.
23480 * @return Returns the minimum zoom of the source.
23482 * @see elm_map_source_zoom_min_set() for details.
23486 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23489 * Set the maximum zoom of the source.
23491 * @param obj The map object.
23492 * @param zoom New maximum zoom value to be used.
23494 * By default, it's 18.
23498 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23501 * Get the maximum zoom of the source.
23503 * @param obj The map object.
23504 * @return Returns the maximum zoom of the source.
23506 * @see elm_map_source_zoom_min_set() for details.
23510 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23513 * Set the user agent used by the map object to access routing services.
23515 * @param obj The map object.
23516 * @param user_agent The user agent to be used by the map.
23518 * User agent is a client application implementing a network protocol used
23519 * in communications within a clientāserver distributed computing system
23521 * The @p user_agent identification string will transmitted in a header
23522 * field @c User-Agent.
23524 * @see elm_map_user_agent_get()
23528 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23531 * Get the user agent used by the map object.
23533 * @param obj The map object.
23534 * @return The user agent identification string used by the map.
23536 * @see elm_map_user_agent_set() for details.
23540 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23543 * Add a new route to the map object.
23545 * @param obj The map object.
23546 * @param type The type of transport to be considered when tracing a route.
23547 * @param method The routing method, what should be priorized.
23548 * @param flon The start longitude.
23549 * @param flat The start latitude.
23550 * @param tlon The destination longitude.
23551 * @param tlat The destination latitude.
23553 * @return The created route or @c NULL upon failure.
23555 * A route will be traced by point on coordinates (@p flat, @p flon)
23556 * to point on coordinates (@p tlat, @p tlon), using the route service
23557 * set with elm_map_route_source_set().
23559 * It will take @p type on consideration to define the route,
23560 * depending if the user will be walking or driving, the route may vary.
23561 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23562 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23564 * Another parameter is what the route should priorize, the minor distance
23565 * or the less time to be spend on the route. So @p method should be one
23566 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23568 * Routes created with this method can be deleted with
23569 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23570 * and distance can be get with elm_map_route_distance_get().
23572 * @see elm_map_route_remove()
23573 * @see elm_map_route_color_set()
23574 * @see elm_map_route_distance_get()
23575 * @see elm_map_route_source_set()
23579 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);
23582 * Remove a route from the map.
23584 * @param route The route to remove.
23586 * @see elm_map_route_add()
23590 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23593 * Set the route color.
23595 * @param route The route object.
23596 * @param r Red channel value, from 0 to 255.
23597 * @param g Green channel value, from 0 to 255.
23598 * @param b Blue channel value, from 0 to 255.
23599 * @param a Alpha channel value, from 0 to 255.
23601 * It uses an additive color model, so each color channel represents
23602 * how much of each primary colors must to be used. 0 represents
23603 * ausence of this color, so if all of the three are set to 0,
23604 * the color will be black.
23606 * These component values should be integers in the range 0 to 255,
23607 * (single 8-bit byte).
23609 * This sets the color used for the route. By default, it is set to
23610 * solid red (r = 255, g = 0, b = 0, a = 255).
23612 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23614 * @see elm_map_route_color_get()
23618 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23621 * Get the route color.
23623 * @param route The route object.
23624 * @param r Pointer where to store the red channel value.
23625 * @param g Pointer where to store the green channel value.
23626 * @param b Pointer where to store the blue channel value.
23627 * @param a Pointer where to store the alpha channel value.
23629 * @see elm_map_route_color_set() for details.
23633 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23636 * Get the route distance in kilometers.
23638 * @param route The route object.
23639 * @return The distance of route (unit : km).
23643 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23646 * Get the information of route nodes.
23648 * @param route The route object.
23649 * @return Returns a string with the nodes of route.
23653 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23656 * Get the information of route waypoint.
23658 * @param route the route object.
23659 * @return Returns a string with information about waypoint of route.
23663 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23666 * Get the address of the name.
23668 * @param name The name handle.
23669 * @return Returns the address string of @p name.
23671 * This gets the coordinates of the @p name, created with one of the
23672 * conversion functions.
23674 * @see elm_map_utils_convert_name_into_coord()
23675 * @see elm_map_utils_convert_coord_into_name()
23679 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23682 * Get the current coordinates of the name.
23684 * @param name The name handle.
23685 * @param lat Pointer where to store the latitude.
23686 * @param lon Pointer where to store The longitude.
23688 * This gets the coordinates of the @p name, created with one of the
23689 * conversion functions.
23691 * @see elm_map_utils_convert_name_into_coord()
23692 * @see elm_map_utils_convert_coord_into_name()
23696 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23699 * Remove a name from the map.
23701 * @param name The name to remove.
23703 * Basically the struct handled by @p name will be freed, so convertions
23704 * between address and coordinates will be lost.
23706 * @see elm_map_utils_convert_name_into_coord()
23707 * @see elm_map_utils_convert_coord_into_name()
23711 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23716 * @param obj The map object.
23717 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23718 * @param cx Rotation's center horizontal position.
23719 * @param cy Rotation's center vertical position.
23721 * @see elm_map_rotate_get()
23725 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23728 * Get the rotate degree of the map
23730 * @param obj The map object
23731 * @param degree Pointer where to store degrees from 0.0 to 360.0
23732 * to rotate arount Z axis.
23733 * @param cx Pointer where to store rotation's center horizontal position.
23734 * @param cy Pointer where to store rotation's center vertical position.
23736 * @see elm_map_rotate_set() to set map rotation.
23740 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);
23743 * Enable or disable mouse wheel to be used to zoom in / out the map.
23745 * @param obj The map object.
23746 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23749 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23751 * It's disabled by default.
23753 * @see elm_map_wheel_disabled_get()
23757 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23760 * Get a value whether mouse wheel is enabled or not.
23762 * @param obj The map object.
23763 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23764 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23766 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23768 * @see elm_map_wheel_disabled_set() for details.
23772 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23776 * Add a track on the map
23778 * @param obj The map object.
23779 * @param emap The emap route object.
23780 * @return The route object. This is an elm object of type Route.
23782 * @see elm_route_add() for details.
23786 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23790 * Remove a track from the map
23792 * @param obj The map object.
23793 * @param route The track to remove.
23797 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23804 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23806 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23808 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23809 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23810 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23811 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23815 * @defgroup Panel Panel
23817 * @image html img/widget/panel/preview-00.png
23818 * @image latex img/widget/panel/preview-00.eps
23820 * @brief A panel is a type of animated container that contains subobjects.
23821 * It can be expanded or contracted by clicking the button on it's edge.
23823 * Orientations are as follows:
23824 * @li ELM_PANEL_ORIENT_TOP
23825 * @li ELM_PANEL_ORIENT_LEFT
23826 * @li ELM_PANEL_ORIENT_RIGHT
23828 * To set/get/unset the content of the panel, you can use
23829 * elm_object_content_set/get/unset APIs.
23830 * Once the content object is set, a previously set one will be deleted.
23831 * If you want to keep that old content object, use the
23832 * elm_object_content_unset() function
23834 * @ref tutorial_panel shows one way to use this widget.
23837 typedef enum _Elm_Panel_Orient
23839 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23840 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23841 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23842 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23843 } Elm_Panel_Orient;
23845 * @brief Adds a panel object
23847 * @param parent The parent object
23849 * @return The panel object, or NULL on failure
23851 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23853 * @brief Sets the orientation of the panel
23855 * @param parent The parent object
23856 * @param orient The panel orientation. Can be one of the following:
23857 * @li ELM_PANEL_ORIENT_TOP
23858 * @li ELM_PANEL_ORIENT_LEFT
23859 * @li ELM_PANEL_ORIENT_RIGHT
23861 * Sets from where the panel will (dis)appear.
23863 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23865 * @brief Get the orientation of the panel.
23867 * @param obj The panel object
23868 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23870 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23872 * @brief Set the content of the panel.
23874 * @param obj The panel object
23875 * @param content The panel content
23877 * Once the content object is set, a previously set one will be deleted.
23878 * If you want to keep that old content object, use the
23879 * elm_panel_content_unset() function.
23881 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23883 * @brief Get the content of the panel.
23885 * @param obj The panel object
23886 * @return The content that is being used
23888 * Return the content object which is set for this widget.
23890 * @see elm_panel_content_set()
23892 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23894 * @brief Unset the content of the panel.
23896 * @param obj The panel object
23897 * @return The content that was being used
23899 * Unparent and return the content object which was set for this widget.
23901 * @see elm_panel_content_set()
23903 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23905 * @brief Set the state of the panel.
23907 * @param obj The panel object
23908 * @param hidden If true, the panel will run the animation to contract
23910 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23912 * @brief Get the state of the panel.
23914 * @param obj The panel object
23915 * @param hidden If true, the panel is in the "hide" state
23917 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23919 * @brief Toggle the hidden state of the panel from code
23921 * @param obj The panel object
23923 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23929 * @defgroup Panes Panes
23930 * @ingroup Elementary
23932 * @image html img/widget/panes/preview-00.png
23933 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23935 * @image html img/panes.png
23936 * @image latex img/panes.eps width=\textwidth
23938 * The panes adds a dragable bar between two contents. When dragged
23939 * this bar will resize contents size.
23941 * Panes can be displayed vertically or horizontally, and contents
23942 * size proportion can be customized (homogeneous by default).
23944 * Smart callbacks one can listen to:
23945 * - "press" - The panes has been pressed (button wasn't released yet).
23946 * - "unpressed" - The panes was released after being pressed.
23947 * - "clicked" - The panes has been clicked>
23948 * - "clicked,double" - The panes has been double clicked
23950 * Available styles for it:
23953 * Default contents parts of the panes widget that you can use for are:
23954 * @li "elm.swallow.left" - A leftside content of the panes
23955 * @li "elm.swallow.right" - A rightside content of the panes
23957 * If panes is displayed vertically, left content will be displayed at
23960 * Here is an example on its usage:
23961 * @li @ref panes_example
23964 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23965 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23968 * @addtogroup Panes
23973 * Add a new panes widget to the given parent Elementary
23974 * (container) object.
23976 * @param parent The parent object.
23977 * @return a new panes widget handle or @c NULL, on errors.
23979 * This function inserts a new panes widget on the canvas.
23983 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23986 * Set the left content of the panes widget.
23988 * @param obj The panes object.
23989 * @param content The new left content object.
23991 * Once the content object is set, a previously set one will be deleted.
23992 * If you want to keep that old content object, use the
23993 * elm_panes_content_left_unset() function.
23995 * If panes is displayed vertically, left content will be displayed at
23998 * @see elm_panes_content_left_get()
23999 * @see elm_panes_content_right_set() to set content on the other side.
24003 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24006 * Set the right content of the panes widget.
24008 * @param obj The panes object.
24009 * @param content The new right content object.
24011 * Once the content object is set, a previously set one will be deleted.
24012 * If you want to keep that old content object, use the
24013 * elm_panes_content_right_unset() function.
24015 * If panes is displayed vertically, left content will be displayed at
24018 * @see elm_panes_content_right_get()
24019 * @see elm_panes_content_left_set() to set content on the other side.
24023 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24026 * Get the left content of the panes.
24028 * @param obj The panes object.
24029 * @return The left content object that is being used.
24031 * Return the left content object which is set for this widget.
24033 * @see elm_panes_content_left_set() for details.
24037 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24040 * Get the right content of the panes.
24042 * @param obj The panes object
24043 * @return The right content object that is being used
24045 * Return the right content object which is set for this widget.
24047 * @see elm_panes_content_right_set() for details.
24051 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24054 * Unset the left content used for the panes.
24056 * @param obj The panes object.
24057 * @return The left content object that was being used.
24059 * Unparent and return the left content object which was set for this widget.
24061 * @see elm_panes_content_left_set() for details.
24062 * @see elm_panes_content_left_get().
24066 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24069 * Unset the right content used for the panes.
24071 * @param obj The panes object.
24072 * @return The right content object that was being used.
24074 * Unparent and return the right content object which was set for this
24077 * @see elm_panes_content_right_set() for details.
24078 * @see elm_panes_content_right_get().
24082 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24085 * Get the size proportion of panes widget's left side.
24087 * @param obj The panes object.
24088 * @return float value between 0.0 and 1.0 representing size proportion
24091 * @see elm_panes_content_left_size_set() for more details.
24095 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24098 * Set the size proportion of panes widget's left side.
24100 * @param obj The panes object.
24101 * @param size Value between 0.0 and 1.0 representing size proportion
24104 * By default it's homogeneous, i.e., both sides have the same size.
24106 * If something different is required, it can be set with this function.
24107 * For example, if the left content should be displayed over
24108 * 75% of the panes size, @p size should be passed as @c 0.75.
24109 * This way, right content will be resized to 25% of panes size.
24111 * If displayed vertically, left content is displayed at top, and
24112 * right content at bottom.
24114 * @note This proportion will change when user drags the panes bar.
24116 * @see elm_panes_content_left_size_get()
24120 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24123 * Set the orientation of a given panes widget.
24125 * @param obj The panes object.
24126 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24127 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24129 * Use this function to change how your panes is to be
24130 * disposed: vertically or horizontally.
24132 * By default it's displayed horizontally.
24134 * @see elm_panes_horizontal_get()
24138 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24141 * Retrieve the orientation of a given panes widget.
24143 * @param obj The panes object.
24144 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24145 * @c EINA_FALSE if it's @b vertical (and on errors).
24147 * @see elm_panes_horizontal_set() for more details.
24151 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24152 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24153 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24160 * @defgroup Flip Flip
24162 * @image html img/widget/flip/preview-00.png
24163 * @image latex img/widget/flip/preview-00.eps
24165 * This widget holds 2 content objects(Evas_Object): one on the front and one
24166 * on the back. It allows you to flip from front to back and vice-versa using
24167 * various animations.
24169 * If either the front or back contents are not set the flip will treat that
24170 * as transparent. So if you wore to set the front content but not the back,
24171 * and then call elm_flip_go() you would see whatever is below the flip.
24173 * For a list of supported animations see elm_flip_go().
24175 * Signals that you can add callbacks for are:
24176 * "animate,begin" - when a flip animation was started
24177 * "animate,done" - when a flip animation is finished
24179 * @ref tutorial_flip show how to use most of the API.
24183 typedef enum _Elm_Flip_Mode
24185 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24186 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24187 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24188 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24189 ELM_FLIP_CUBE_LEFT,
24190 ELM_FLIP_CUBE_RIGHT,
24192 ELM_FLIP_CUBE_DOWN,
24193 ELM_FLIP_PAGE_LEFT,
24194 ELM_FLIP_PAGE_RIGHT,
24198 typedef enum _Elm_Flip_Interaction
24200 ELM_FLIP_INTERACTION_NONE,
24201 ELM_FLIP_INTERACTION_ROTATE,
24202 ELM_FLIP_INTERACTION_CUBE,
24203 ELM_FLIP_INTERACTION_PAGE
24204 } Elm_Flip_Interaction;
24205 typedef enum _Elm_Flip_Direction
24207 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24208 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24209 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24210 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24211 } Elm_Flip_Direction;
24213 * @brief Add a new flip to the parent
24215 * @param parent The parent object
24216 * @return The new object or NULL if it cannot be created
24218 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24220 * @brief Set the front content of the flip widget.
24222 * @param obj The flip object
24223 * @param content The new front content object
24225 * Once the content object is set, a previously set one will be deleted.
24226 * If you want to keep that old content object, use the
24227 * elm_flip_content_front_unset() function.
24229 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24231 * @brief Set the back content of the flip widget.
24233 * @param obj The flip object
24234 * @param content The new back content object
24236 * Once the content object is set, a previously set one will be deleted.
24237 * If you want to keep that old content object, use the
24238 * elm_flip_content_back_unset() function.
24240 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24242 * @brief Get the front content used for the flip
24244 * @param obj The flip object
24245 * @return The front content object that is being used
24247 * Return the front content object which is set for this widget.
24249 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24251 * @brief Get the back content used for the flip
24253 * @param obj The flip object
24254 * @return The back content object that is being used
24256 * Return the back content object which is set for this widget.
24258 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24260 * @brief Unset the front content used for the flip
24262 * @param obj The flip object
24263 * @return The front content object that was being used
24265 * Unparent and return the front content object which was set for this widget.
24267 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24269 * @brief Unset the back content used for the flip
24271 * @param obj The flip object
24272 * @return The back content object that was being used
24274 * Unparent and return the back content object which was set for this widget.
24276 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24278 * @brief Get flip front visibility state
24280 * @param obj The flip objct
24281 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24284 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24286 * @brief Set flip perspective
24288 * @param obj The flip object
24289 * @param foc The coordinate to set the focus on
24290 * @param x The X coordinate
24291 * @param y The Y coordinate
24293 * @warning This function currently does nothing.
24295 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24297 * @brief Runs the flip animation
24299 * @param obj The flip object
24300 * @param mode The mode type
24302 * Flips the front and back contents using the @p mode animation. This
24303 * efectively hides the currently visible content and shows the hidden one.
24305 * There a number of possible animations to use for the flipping:
24306 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24307 * around a horizontal axis in the middle of its height, the other content
24308 * is shown as the other side of the flip.
24309 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24310 * around a vertical axis in the middle of its width, the other content is
24311 * shown as the other side of the flip.
24312 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24313 * around a diagonal axis in the middle of its width, the other content is
24314 * shown as the other side of the flip.
24315 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24316 * around a diagonal axis in the middle of its height, the other content is
24317 * shown as the other side of the flip.
24318 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24319 * as if the flip was a cube, the other content is show as the right face of
24321 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24322 * right as if the flip was a cube, the other content is show as the left
24323 * face of the cube.
24324 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24325 * flip was a cube, the other content is show as the bottom face of the cube.
24326 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24327 * the flip was a cube, the other content is show as the upper face of the
24329 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24330 * if the flip was a book, the other content is shown as the page below that.
24331 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24332 * as if the flip was a book, the other content is shown as the page below
24334 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24335 * flip was a book, the other content is shown as the page below that.
24336 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24337 * flip was a book, the other content is shown as the page below that.
24339 * @image html elm_flip.png
24340 * @image latex elm_flip.eps width=\textwidth
24342 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24344 * @brief Set the interactive flip mode
24346 * @param obj The flip object
24347 * @param mode The interactive flip mode to use
24349 * This sets if the flip should be interactive (allow user to click and
24350 * drag a side of the flip to reveal the back page and cause it to flip).
24351 * By default a flip is not interactive. You may also need to set which
24352 * sides of the flip are "active" for flipping and how much space they use
24353 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24354 * and elm_flip_interacton_direction_hitsize_set()
24356 * The four avilable mode of interaction are:
24357 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24358 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24359 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24360 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24362 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24363 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24364 * happen, those can only be acheived with elm_flip_go();
24366 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24368 * @brief Get the interactive flip mode
24370 * @param obj The flip object
24371 * @return The interactive flip mode
24373 * Returns the interactive flip mode set by elm_flip_interaction_set()
24375 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24377 * @brief Set which directions of the flip respond to interactive flip
24379 * @param obj The flip object
24380 * @param dir The direction to change
24381 * @param enabled If that direction is enabled or not
24383 * By default all directions are disabled, so you may want to enable the
24384 * desired directions for flipping if you need interactive flipping. You must
24385 * call this function once for each direction that should be enabled.
24387 * @see elm_flip_interaction_set()
24389 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24391 * @brief Get the enabled state of that flip direction
24393 * @param obj The flip object
24394 * @param dir The direction to check
24395 * @return If that direction is enabled or not
24397 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24399 * @see elm_flip_interaction_set()
24401 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24403 * @brief Set the amount of the flip that is sensitive to interactive flip
24405 * @param obj The flip object
24406 * @param dir The direction to modify
24407 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24409 * Set the amount of the flip that is sensitive to interactive flip, with 0
24410 * representing no area in the flip and 1 representing the entire flip. There
24411 * is however a consideration to be made in that the area will never be
24412 * smaller than the finger size set(as set in your Elementary configuration).
24414 * @see elm_flip_interaction_set()
24416 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24418 * @brief Get the amount of the flip that is sensitive to interactive flip
24420 * @param obj The flip object
24421 * @param dir The direction to check
24422 * @return The size set for that direction
24424 * Returns the amount os sensitive area set by
24425 * elm_flip_interacton_direction_hitsize_set().
24427 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24432 /* scrolledentry */
24433 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24434 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24435 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24436 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24437 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24438 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24439 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24440 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24441 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24442 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24443 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24444 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24445 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24446 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24447 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24448 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24449 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24450 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24451 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24452 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24453 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24454 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24455 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24456 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24457 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24458 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24459 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24460 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24461 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24462 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24463 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24464 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24465 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24466 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24467 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24468 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);
24469 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24470 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24471 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);
24472 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24473 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);
24474 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24475 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24476 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24477 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24478 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24479 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24480 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24481 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24482 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);
24483 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);
24484 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);
24485 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);
24486 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);
24487 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);
24488 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24489 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24490 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24491 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24492 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24493 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24494 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24495 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24496 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24497 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24498 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24499 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24500 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24503 * @defgroup Conformant Conformant
24504 * @ingroup Elementary
24506 * @image html img/widget/conformant/preview-00.png
24507 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24509 * @image html img/conformant.png
24510 * @image latex img/conformant.eps width=\textwidth
24512 * The aim is to provide a widget that can be used in elementary apps to
24513 * account for space taken up by the indicator, virtual keypad & softkey
24514 * windows when running the illume2 module of E17.
24516 * So conformant content will be sized and positioned considering the
24517 * space required for such stuff, and when they popup, as a keyboard
24518 * shows when an entry is selected, conformant content won't change.
24520 * Available styles for it:
24523 * Default contents parts of the conformant widget that you can use for are:
24524 * @li "elm.swallow.content" - A content of the conformant
24526 * See how to use this widget in this example:
24527 * @ref conformant_example
24531 * @addtogroup Conformant
24536 * Add a new conformant widget to the given parent Elementary
24537 * (container) object.
24539 * @param parent The parent object.
24540 * @return A new conformant widget handle or @c NULL, on errors.
24542 * This function inserts a new conformant widget on the canvas.
24544 * @ingroup Conformant
24546 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24549 * Set the content of the conformant widget.
24551 * @param obj The conformant object.
24552 * @param content The content to be displayed by the conformant.
24554 * Content will be sized and positioned considering the space required
24555 * to display a virtual keyboard. So it won't fill all the conformant
24556 * size. This way is possible to be sure that content won't resize
24557 * or be re-positioned after the keyboard is displayed.
24559 * Once the content object is set, a previously set one will be deleted.
24560 * If you want to keep that old content object, use the
24561 * elm_object_content_unset() function.
24563 * @see elm_object_content_unset()
24564 * @see elm_object_content_get()
24566 * @ingroup Conformant
24568 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24571 * Get the content of the conformant widget.
24573 * @param obj The conformant object.
24574 * @return The content that is being used.
24576 * Return the content object which is set for this widget.
24577 * It won't be unparent from conformant. For that, use
24578 * elm_object_content_unset().
24580 * @see elm_object_content_set().
24581 * @see elm_object_content_unset()
24583 * @ingroup Conformant
24585 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24588 * Unset the content of the conformant widget.
24590 * @param obj The conformant object.
24591 * @return The content that was being used.
24593 * Unparent and return the content object which was set for this widget.
24595 * @see elm_object_content_set().
24597 * @ingroup Conformant
24599 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24602 * Returns the Evas_Object that represents the content area.
24604 * @param obj The conformant object.
24605 * @return The content area of the widget.
24607 * @ingroup Conformant
24609 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24616 * @defgroup Mapbuf Mapbuf
24617 * @ingroup Elementary
24619 * @image html img/widget/mapbuf/preview-00.png
24620 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24622 * This holds one content object and uses an Evas Map of transformation
24623 * points to be later used with this content. So the content will be
24624 * moved, resized, etc as a single image. So it will improve performance
24625 * when you have a complex interafce, with a lot of elements, and will
24626 * need to resize or move it frequently (the content object and its
24629 * To set/get/unset the content of the mapbuf, you can use
24630 * elm_object_content_set/get/unset APIs.
24631 * Once the content object is set, a previously set one will be deleted.
24632 * If you want to keep that old content object, use the
24633 * elm_object_content_unset() function.
24635 * To enable map, elm_mapbuf_enabled_set() should be used.
24637 * See how to use this widget in this example:
24638 * @ref mapbuf_example
24642 * @addtogroup Mapbuf
24647 * Add a new mapbuf widget to the given parent Elementary
24648 * (container) object.
24650 * @param parent The parent object.
24651 * @return A new mapbuf widget handle or @c NULL, on errors.
24653 * This function inserts a new mapbuf widget on the canvas.
24657 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24660 * Set the content of the mapbuf.
24662 * @param obj The mapbuf object.
24663 * @param content The content that will be filled in this mapbuf object.
24665 * Once the content object is set, a previously set one will be deleted.
24666 * If you want to keep that old content object, use the
24667 * elm_mapbuf_content_unset() function.
24669 * To enable map, elm_mapbuf_enabled_set() should be used.
24673 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24676 * Get the content of the mapbuf.
24678 * @param obj The mapbuf object.
24679 * @return The content that is being used.
24681 * Return the content object which is set for this widget.
24683 * @see elm_mapbuf_content_set() for details.
24687 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24690 * Unset the content of the mapbuf.
24692 * @param obj The mapbuf object.
24693 * @return The content that was being used.
24695 * Unparent and return the content object which was set for this widget.
24697 * @see elm_mapbuf_content_set() for details.
24701 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24704 * Enable or disable the map.
24706 * @param obj The mapbuf object.
24707 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24709 * This enables the map that is set or disables it. On enable, the object
24710 * geometry will be saved, and the new geometry will change (position and
24711 * size) to reflect the map geometry set.
24713 * Also, when enabled, alpha and smooth states will be used, so if the
24714 * content isn't solid, alpha should be enabled, for example, otherwise
24715 * a black retangle will fill the content.
24717 * When disabled, the stored map will be freed and geometry prior to
24718 * enabling the map will be restored.
24720 * It's disabled by default.
24722 * @see elm_mapbuf_alpha_set()
24723 * @see elm_mapbuf_smooth_set()
24727 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24730 * Get a value whether map is enabled or not.
24732 * @param obj The mapbuf object.
24733 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24734 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24736 * @see elm_mapbuf_enabled_set() for details.
24740 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24743 * Enable or disable smooth map rendering.
24745 * @param obj The mapbuf object.
24746 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24749 * This sets smoothing for map rendering. If the object is a type that has
24750 * its own smoothing settings, then both the smooth settings for this object
24751 * and the map must be turned off.
24753 * By default smooth maps are enabled.
24757 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24760 * Get a value whether smooth map rendering is enabled or not.
24762 * @param obj The mapbuf object.
24763 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24764 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24766 * @see elm_mapbuf_smooth_set() for details.
24770 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24773 * Set or unset alpha flag for map rendering.
24775 * @param obj The mapbuf object.
24776 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24779 * This sets alpha flag for map rendering. If the object is a type that has
24780 * its own alpha settings, then this will take precedence. Only image objects
24781 * have this currently. It stops alpha blending of the map area, and is
24782 * useful if you know the object and/or all sub-objects is 100% solid.
24784 * Alpha is enabled by default.
24788 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24791 * Get a value whether alpha blending is enabled or not.
24793 * @param obj The mapbuf object.
24794 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24795 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24797 * @see elm_mapbuf_alpha_set() for details.
24801 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24808 * @defgroup Flipselector Flip Selector
24810 * @image html img/widget/flipselector/preview-00.png
24811 * @image latex img/widget/flipselector/preview-00.eps
24813 * A flip selector is a widget to show a set of @b text items, one
24814 * at a time, with the same sheet switching style as the @ref Clock
24815 * "clock" widget, when one changes the current displaying sheet
24816 * (thus, the "flip" in the name).
24818 * User clicks to flip sheets which are @b held for some time will
24819 * make the flip selector to flip continuosly and automatically for
24820 * the user. The interval between flips will keep growing in time,
24821 * so that it helps the user to reach an item which is distant from
24822 * the current selection.
24824 * Smart callbacks one can register to:
24825 * - @c "selected" - when the widget's selected text item is changed
24826 * - @c "overflowed" - when the widget's current selection is changed
24827 * from the first item in its list to the last
24828 * - @c "underflowed" - when the widget's current selection is changed
24829 * from the last item in its list to the first
24831 * Available styles for it:
24834 * Here is an example on its usage:
24835 * @li @ref flipselector_example
24839 * @addtogroup Flipselector
24843 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24846 * Add a new flip selector widget to the given parent Elementary
24847 * (container) widget
24849 * @param parent The parent object
24850 * @return a new flip selector widget handle or @c NULL, on errors
24852 * This function inserts a new flip selector widget on the canvas.
24854 * @ingroup Flipselector
24856 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24859 * Programmatically select the next item of a flip selector widget
24861 * @param obj The flipselector object
24863 * @note The selection will be animated. Also, if it reaches the
24864 * end of its list of member items, it will continue with the first
24867 * @ingroup Flipselector
24869 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24872 * Programmatically select the previous item of a flip selector
24875 * @param obj The flipselector object
24877 * @note The selection will be animated. Also, if it reaches the
24878 * beginning of its list of member items, it will continue with the
24879 * last one backwards.
24881 * @ingroup Flipselector
24883 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24886 * Append a (text) item to a flip selector widget
24888 * @param obj The flipselector object
24889 * @param label The (text) label of the new item
24890 * @param func Convenience callback function to take place when
24892 * @param data Data passed to @p func, above
24893 * @return A handle to the item added or @c NULL, on errors
24895 * The widget's list of labels to show will be appended with the
24896 * given value. If the user wishes so, a callback function pointer
24897 * can be passed, which will get called when this same item is
24900 * @note The current selection @b won't be modified by appending an
24901 * element to the list.
24903 * @note The maximum length of the text label is going to be
24904 * determined <b>by the widget's theme</b>. Strings larger than
24905 * that value are going to be @b truncated.
24907 * @ingroup Flipselector
24909 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24912 * Prepend a (text) item to a flip selector widget
24914 * @param obj The flipselector object
24915 * @param label The (text) label of the new item
24916 * @param func Convenience callback function to take place when
24918 * @param data Data passed to @p func, above
24919 * @return A handle to the item added or @c NULL, on errors
24921 * The widget's list of labels to show will be prepended with the
24922 * given value. If the user wishes so, a callback function pointer
24923 * can be passed, which will get called when this same item is
24926 * @note The current selection @b won't be modified by prepending
24927 * an element to the list.
24929 * @note The maximum length of the text label is going to be
24930 * determined <b>by the widget's theme</b>. Strings larger than
24931 * that value are going to be @b truncated.
24933 * @ingroup Flipselector
24935 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24938 * Get the internal list of items in a given flip selector widget.
24940 * @param obj The flipselector object
24941 * @return The list of items (#Elm_Flipselector_Item as data) or
24942 * @c NULL on errors.
24944 * This list is @b not to be modified in any way and must not be
24945 * freed. Use the list members with functions like
24946 * elm_flipselector_item_label_set(),
24947 * elm_flipselector_item_label_get(),
24948 * elm_flipselector_item_del(),
24949 * elm_flipselector_item_selected_get(),
24950 * elm_flipselector_item_selected_set().
24952 * @warning This list is only valid until @p obj object's internal
24953 * items list is changed. It should be fetched again with another
24954 * call to this function when changes happen.
24956 * @ingroup Flipselector
24958 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24961 * Get the first item in the given flip selector widget's list of
24964 * @param obj The flipselector object
24965 * @return The first item or @c NULL, if it has no items (and on
24968 * @see elm_flipselector_item_append()
24969 * @see elm_flipselector_last_item_get()
24971 * @ingroup Flipselector
24973 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24976 * Get the last item in the given flip selector widget's list of
24979 * @param obj The flipselector object
24980 * @return The last item or @c NULL, if it has no items (and on
24983 * @see elm_flipselector_item_prepend()
24984 * @see elm_flipselector_first_item_get()
24986 * @ingroup Flipselector
24988 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24991 * Get the currently selected item in a flip selector widget.
24993 * @param obj The flipselector object
24994 * @return The selected item or @c NULL, if the widget has no items
24997 * @ingroup Flipselector
24999 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25002 * Set whether a given flip selector widget's item should be the
25003 * currently selected one.
25005 * @param item The flip selector item
25006 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25008 * This sets whether @p item is or not the selected (thus, under
25009 * display) one. If @p item is different than one under display,
25010 * the latter will be unselected. If the @p item is set to be
25011 * unselected, on the other hand, the @b first item in the widget's
25012 * internal members list will be the new selected one.
25014 * @see elm_flipselector_item_selected_get()
25016 * @ingroup Flipselector
25018 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25021 * Get whether a given flip selector widget's item is the currently
25024 * @param item The flip selector item
25025 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25028 * @see elm_flipselector_item_selected_set()
25030 * @ingroup Flipselector
25032 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25035 * Delete a given item from a flip selector widget.
25037 * @param item The item to delete
25039 * @ingroup Flipselector
25041 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25044 * Get the label of a given flip selector widget's item.
25046 * @param item The item to get label from
25047 * @return The text label of @p item or @c NULL, on errors
25049 * @see elm_flipselector_item_label_set()
25051 * @ingroup Flipselector
25053 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25056 * Set the label of a given flip selector widget's item.
25058 * @param item The item to set label on
25059 * @param label The text label string, in UTF-8 encoding
25061 * @see elm_flipselector_item_label_get()
25063 * @ingroup Flipselector
25065 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25068 * Gets the item before @p item in a flip selector widget's
25069 * internal list of items.
25071 * @param item The item to fetch previous from
25072 * @return The item before the @p item, in its parent's list. If
25073 * there is no previous item for @p item or there's an
25074 * error, @c NULL is returned.
25076 * @see elm_flipselector_item_next_get()
25078 * @ingroup Flipselector
25080 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25083 * Gets the item after @p item in a flip selector widget's
25084 * internal list of items.
25086 * @param item The item to fetch next from
25087 * @return The item after the @p item, in its parent's list. If
25088 * there is no next item for @p item or there's an
25089 * error, @c NULL is returned.
25091 * @see elm_flipselector_item_next_get()
25093 * @ingroup Flipselector
25095 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25098 * Set the interval on time updates for an user mouse button hold
25099 * on a flip selector widget.
25101 * @param obj The flip selector object
25102 * @param interval The (first) interval value in seconds
25104 * This interval value is @b decreased while the user holds the
25105 * mouse pointer either flipping up or flipping doww a given flip
25108 * This helps the user to get to a given item distant from the
25109 * current one easier/faster, as it will start to flip quicker and
25110 * quicker on mouse button holds.
25112 * The calculation for the next flip interval value, starting from
25113 * the one set with this call, is the previous interval divided by
25114 * 1.05, so it decreases a little bit.
25116 * The default starting interval value for automatic flips is
25119 * @see elm_flipselector_interval_get()
25121 * @ingroup Flipselector
25123 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25126 * Get the interval on time updates for an user mouse button hold
25127 * on a flip selector widget.
25129 * @param obj The flip selector object
25130 * @return The (first) interval value, in seconds, set on it
25132 * @see elm_flipselector_interval_set() for more details
25134 * @ingroup Flipselector
25136 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25143 * @addtogroup Calendar
25148 * @enum _Elm_Calendar_Mark_Repeat
25149 * @typedef Elm_Calendar_Mark_Repeat
25151 * Event periodicity, used to define if a mark should be repeated
25152 * @b beyond event's day. It's set when a mark is added.
25154 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25155 * there will be marks every week after this date. Marks will be displayed
25156 * at 13th, 20th, 27th, 3rd June ...
25158 * Values don't work as bitmask, only one can be choosen.
25160 * @see elm_calendar_mark_add()
25162 * @ingroup Calendar
25164 typedef enum _Elm_Calendar_Mark_Repeat
25166 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25167 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25168 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25169 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*/
25170 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. */
25171 } Elm_Calendar_Mark_Repeat;
25173 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(). */
25176 * Add a new calendar widget to the given parent Elementary
25177 * (container) object.
25179 * @param parent The parent object.
25180 * @return a new calendar widget handle or @c NULL, on errors.
25182 * This function inserts a new calendar widget on the canvas.
25184 * @ref calendar_example_01
25186 * @ingroup Calendar
25188 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25191 * Get weekdays names displayed by the calendar.
25193 * @param obj The calendar object.
25194 * @return Array of seven strings to be used as weekday names.
25196 * By default, weekdays abbreviations get from system are displayed:
25197 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25198 * The first string is related to Sunday, the second to Monday...
25200 * @see elm_calendar_weekdays_name_set()
25202 * @ref calendar_example_05
25204 * @ingroup Calendar
25206 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25209 * Set weekdays names to be displayed by the calendar.
25211 * @param obj The calendar object.
25212 * @param weekdays Array of seven strings to be used as weekday names.
25213 * @warning It must have 7 elements, or it will access invalid memory.
25214 * @warning The strings must be NULL terminated ('@\0').
25216 * By default, weekdays abbreviations get from system are displayed:
25217 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25219 * The first string should be related to Sunday, the second to Monday...
25221 * The usage should be like this:
25223 * const char *weekdays[] =
25225 * "Sunday", "Monday", "Tuesday", "Wednesday",
25226 * "Thursday", "Friday", "Saturday"
25228 * elm_calendar_weekdays_names_set(calendar, weekdays);
25231 * @see elm_calendar_weekdays_name_get()
25233 * @ref calendar_example_02
25235 * @ingroup Calendar
25237 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25240 * Set the minimum and maximum values for the year
25242 * @param obj The calendar object
25243 * @param min The minimum year, greater than 1901;
25244 * @param max The maximum year;
25246 * Maximum must be greater than minimum, except if you don't wan't to set
25248 * Default values are 1902 and -1.
25250 * If the maximum year is a negative value, it will be limited depending
25251 * on the platform architecture (year 2037 for 32 bits);
25253 * @see elm_calendar_min_max_year_get()
25255 * @ref calendar_example_03
25257 * @ingroup Calendar
25259 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25262 * Get the minimum and maximum values for the year
25264 * @param obj The calendar object.
25265 * @param min The minimum year.
25266 * @param max The maximum year.
25268 * Default values are 1902 and -1.
25270 * @see elm_calendar_min_max_year_get() for more details.
25272 * @ref calendar_example_05
25274 * @ingroup Calendar
25276 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25279 * Enable or disable day selection
25281 * @param obj The calendar object.
25282 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25285 * Enabled by default. If disabled, the user still can select months,
25286 * but not days. Selected days are highlighted on calendar.
25287 * It should be used if you won't need such selection for the widget usage.
25289 * When a day is selected, or month is changed, smart callbacks for
25290 * signal "changed" will be called.
25292 * @see elm_calendar_day_selection_enable_get()
25294 * @ref calendar_example_04
25296 * @ingroup Calendar
25298 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25301 * Get a value whether day selection is enabled or not.
25303 * @see elm_calendar_day_selection_enable_set() for details.
25305 * @param obj The calendar object.
25306 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25307 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25309 * @ref calendar_example_05
25311 * @ingroup Calendar
25313 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25317 * Set selected date to be highlighted on calendar.
25319 * @param obj The calendar object.
25320 * @param selected_time A @b tm struct to represent the selected date.
25322 * Set the selected date, changing the displayed month if needed.
25323 * Selected date changes when the user goes to next/previous month or
25324 * select a day pressing over it on calendar.
25326 * @see elm_calendar_selected_time_get()
25328 * @ref calendar_example_04
25330 * @ingroup Calendar
25332 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25335 * Get selected date.
25337 * @param obj The calendar object
25338 * @param selected_time A @b tm struct to point to selected date
25339 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25342 * Get date selected by the user or set by function
25343 * elm_calendar_selected_time_set().
25344 * Selected date changes when the user goes to next/previous month or
25345 * select a day pressing over it on calendar.
25347 * @see elm_calendar_selected_time_get()
25349 * @ref calendar_example_05
25351 * @ingroup Calendar
25353 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25356 * Set a function to format the string that will be used to display
25359 * @param obj The calendar object
25360 * @param format_function Function to set the month-year string given
25361 * the selected date
25363 * By default it uses strftime with "%B %Y" format string.
25364 * It should allocate the memory that will be used by the string,
25365 * that will be freed by the widget after usage.
25366 * A pointer to the string and a pointer to the time struct will be provided.
25371 * _format_month_year(struct tm *selected_time)
25374 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25375 * return strdup(buf);
25378 * elm_calendar_format_function_set(calendar, _format_month_year);
25381 * @ref calendar_example_02
25383 * @ingroup Calendar
25385 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25388 * Add a new mark to the calendar
25390 * @param obj The calendar object
25391 * @param mark_type A string used to define the type of mark. It will be
25392 * emitted to the theme, that should display a related modification on these
25393 * days representation.
25394 * @param mark_time A time struct to represent the date of inclusion of the
25395 * mark. For marks that repeats it will just be displayed after the inclusion
25396 * date in the calendar.
25397 * @param repeat Repeat the event following this periodicity. Can be a unique
25398 * mark (that don't repeat), daily, weekly, monthly or annually.
25399 * @return The created mark or @p NULL upon failure.
25401 * Add a mark that will be drawn in the calendar respecting the insertion
25402 * time and periodicity. It will emit the type as signal to the widget theme.
25403 * Default theme supports "holiday" and "checked", but it can be extended.
25405 * It won't immediately update the calendar, drawing the marks.
25406 * For this, call elm_calendar_marks_draw(). However, when user selects
25407 * next or previous month calendar forces marks drawn.
25409 * Marks created with this method can be deleted with
25410 * elm_calendar_mark_del().
25414 * struct tm selected_time;
25415 * time_t current_time;
25417 * current_time = time(NULL) + 5 * 84600;
25418 * localtime_r(¤t_time, &selected_time);
25419 * elm_calendar_mark_add(cal, "holiday", selected_time,
25420 * ELM_CALENDAR_ANNUALLY);
25422 * current_time = time(NULL) + 1 * 84600;
25423 * localtime_r(¤t_time, &selected_time);
25424 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25426 * elm_calendar_marks_draw(cal);
25429 * @see elm_calendar_marks_draw()
25430 * @see elm_calendar_mark_del()
25432 * @ref calendar_example_06
25434 * @ingroup Calendar
25436 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);
25439 * Delete mark from the calendar.
25441 * @param mark The mark to be deleted.
25443 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25444 * should be used instead of getting marks list and deleting each one.
25446 * @see elm_calendar_mark_add()
25448 * @ref calendar_example_06
25450 * @ingroup Calendar
25452 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25455 * Remove all calendar's marks
25457 * @param obj The calendar object.
25459 * @see elm_calendar_mark_add()
25460 * @see elm_calendar_mark_del()
25462 * @ingroup Calendar
25464 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25468 * Get a list of all the calendar marks.
25470 * @param obj The calendar object.
25471 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25473 * @see elm_calendar_mark_add()
25474 * @see elm_calendar_mark_del()
25475 * @see elm_calendar_marks_clear()
25477 * @ingroup Calendar
25479 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25482 * Draw calendar marks.
25484 * @param obj The calendar object.
25486 * Should be used after adding, removing or clearing marks.
25487 * It will go through the entire marks list updating the calendar.
25488 * If lots of marks will be added, add all the marks and then call
25491 * When the month is changed, i.e. user selects next or previous month,
25492 * marks will be drawed.
25494 * @see elm_calendar_mark_add()
25495 * @see elm_calendar_mark_del()
25496 * @see elm_calendar_marks_clear()
25498 * @ref calendar_example_06
25500 * @ingroup Calendar
25502 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25503 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25504 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25505 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25508 * Set a day text color to the same that represents Saturdays.
25510 * @param obj The calendar object.
25511 * @param pos The text position. Position is the cell counter, from left
25512 * to right, up to down. It starts on 0 and ends on 41.
25514 * @deprecated use elm_calendar_mark_add() instead like:
25517 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25518 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25521 * @see elm_calendar_mark_add()
25523 * @ingroup Calendar
25525 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25528 * Set a day text color to the same that represents Sundays.
25530 * @param obj The calendar object.
25531 * @param pos The text position. Position is the cell counter, from left
25532 * to right, up to down. It starts on 0 and ends on 41.
25534 * @deprecated use elm_calendar_mark_add() instead like:
25537 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25538 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25541 * @see elm_calendar_mark_add()
25543 * @ingroup Calendar
25545 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25548 * Set a day text color to the same that represents Weekdays.
25550 * @param obj The calendar object
25551 * @param pos The text position. Position is the cell counter, from left
25552 * to right, up to down. It starts on 0 and ends on 41.
25554 * @deprecated use elm_calendar_mark_add() instead like:
25557 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25559 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25560 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25561 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25562 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25563 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25564 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25565 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25566 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25567 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25570 * @see elm_calendar_mark_add()
25572 * @ingroup Calendar
25574 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25577 * Set the interval on time updates for an user mouse button hold
25578 * on calendar widgets' month selection.
25580 * @param obj The calendar object
25581 * @param interval The (first) interval value in seconds
25583 * This interval value is @b decreased while the user holds the
25584 * mouse pointer either selecting next or previous month.
25586 * This helps the user to get to a given month distant from the
25587 * current one easier/faster, as it will start to change quicker and
25588 * quicker on mouse button holds.
25590 * The calculation for the next change interval value, starting from
25591 * the one set with this call, is the previous interval divided by
25592 * 1.05, so it decreases a little bit.
25594 * The default starting interval value for automatic changes is
25597 * @see elm_calendar_interval_get()
25599 * @ingroup Calendar
25601 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25604 * Get the interval on time updates for an user mouse button hold
25605 * on calendar widgets' month selection.
25607 * @param obj The calendar object
25608 * @return The (first) interval value, in seconds, set on it
25610 * @see elm_calendar_interval_set() for more details
25612 * @ingroup Calendar
25614 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25621 * @defgroup Diskselector Diskselector
25622 * @ingroup Elementary
25624 * @image html img/widget/diskselector/preview-00.png
25625 * @image latex img/widget/diskselector/preview-00.eps
25627 * A diskselector is a kind of list widget. It scrolls horizontally,
25628 * and can contain label and icon objects. Three items are displayed
25629 * with the selected one in the middle.
25631 * It can act like a circular list with round mode and labels can be
25632 * reduced for a defined length for side items.
25634 * Smart callbacks one can listen to:
25635 * - "selected" - when item is selected, i.e. scroller stops.
25637 * Available styles for it:
25640 * List of examples:
25641 * @li @ref diskselector_example_01
25642 * @li @ref diskselector_example_02
25646 * @addtogroup Diskselector
25650 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(). */
25653 * Add a new diskselector widget to the given parent Elementary
25654 * (container) object.
25656 * @param parent The parent object.
25657 * @return a new diskselector widget handle or @c NULL, on errors.
25659 * This function inserts a new diskselector widget on the canvas.
25661 * @ingroup Diskselector
25663 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25666 * Enable or disable round mode.
25668 * @param obj The diskselector object.
25669 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25672 * Disabled by default. If round mode is enabled the items list will
25673 * work like a circle list, so when the user reaches the last item,
25674 * the first one will popup.
25676 * @see elm_diskselector_round_get()
25678 * @ingroup Diskselector
25680 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25683 * Get a value whether round mode is enabled or not.
25685 * @see elm_diskselector_round_set() for details.
25687 * @param obj The diskselector object.
25688 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25689 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25691 * @ingroup Diskselector
25693 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25696 * Get the side labels max length.
25698 * @deprecated use elm_diskselector_side_label_length_get() instead:
25700 * @param obj The diskselector object.
25701 * @return The max length defined for side labels, or 0 if not a valid
25704 * @ingroup Diskselector
25706 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25709 * Set the side labels max length.
25711 * @deprecated use elm_diskselector_side_label_length_set() instead:
25713 * @param obj The diskselector object.
25714 * @param len The max length defined for side labels.
25716 * @ingroup Diskselector
25718 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25721 * Get the side labels max length.
25723 * @see elm_diskselector_side_label_length_set() for details.
25725 * @param obj The diskselector object.
25726 * @return The max length defined for side labels, or 0 if not a valid
25729 * @ingroup Diskselector
25731 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25734 * Set the side labels max length.
25736 * @param obj The diskselector object.
25737 * @param len The max length defined for side labels.
25739 * Length is the number of characters of items' label that will be
25740 * visible when it's set on side positions. It will just crop
25741 * the string after defined size. E.g.:
25743 * An item with label "January" would be displayed on side position as
25744 * "Jan" if max length is set to 3, or "Janu", if this property
25747 * When it's selected, the entire label will be displayed, except for
25748 * width restrictions. In this case label will be cropped and "..."
25749 * will be concatenated.
25751 * Default side label max length is 3.
25753 * This property will be applyed over all items, included before or
25754 * later this function call.
25756 * @ingroup Diskselector
25758 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25761 * Set the number of items to be displayed.
25763 * @param obj The diskselector object.
25764 * @param num The number of items the diskselector will display.
25766 * Default value is 3, and also it's the minimun. If @p num is less
25767 * than 3, it will be set to 3.
25769 * Also, it can be set on theme, using data item @c display_item_num
25770 * on group "elm/diskselector/item/X", where X is style set.
25773 * group { name: "elm/diskselector/item/X";
25775 * item: "display_item_num" "5";
25778 * @ingroup Diskselector
25780 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25783 * Get the number of items in the diskselector object.
25785 * @param obj The diskselector object.
25787 * @ingroup Diskselector
25789 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25792 * Set bouncing behaviour when the scrolled content reaches an edge.
25794 * Tell the internal scroller object whether it should bounce or not
25795 * when it reaches the respective edges for each axis.
25797 * @param obj The diskselector object.
25798 * @param h_bounce Whether to bounce or not in the horizontal axis.
25799 * @param v_bounce Whether to bounce or not in the vertical axis.
25801 * @see elm_scroller_bounce_set()
25803 * @ingroup Diskselector
25805 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25808 * Get the bouncing behaviour of the internal scroller.
25810 * Get whether the internal scroller should bounce when the edge of each
25811 * axis is reached scrolling.
25813 * @param obj The diskselector object.
25814 * @param h_bounce Pointer where to store the bounce state of the horizontal
25816 * @param v_bounce Pointer where to store the bounce state of the vertical
25819 * @see elm_scroller_bounce_get()
25820 * @see elm_diskselector_bounce_set()
25822 * @ingroup Diskselector
25824 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25827 * Get the scrollbar policy.
25829 * @see elm_diskselector_scroller_policy_get() for details.
25831 * @param obj The diskselector object.
25832 * @param policy_h Pointer where to store horizontal scrollbar policy.
25833 * @param policy_v Pointer where to store vertical scrollbar policy.
25835 * @ingroup Diskselector
25837 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);
25840 * Set the scrollbar policy.
25842 * @param obj The diskselector object.
25843 * @param policy_h Horizontal scrollbar policy.
25844 * @param policy_v Vertical scrollbar policy.
25846 * This sets the scrollbar visibility policy for the given scroller.
25847 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25848 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25849 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25850 * This applies respectively for the horizontal and vertical scrollbars.
25852 * The both are disabled by default, i.e., are set to
25853 * #ELM_SCROLLER_POLICY_OFF.
25855 * @ingroup Diskselector
25857 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25860 * Remove all diskselector's items.
25862 * @param obj The diskselector object.
25864 * @see elm_diskselector_item_del()
25865 * @see elm_diskselector_item_append()
25867 * @ingroup Diskselector
25869 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25872 * Get a list of all the diskselector items.
25874 * @param obj The diskselector object.
25875 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25876 * or @c NULL on failure.
25878 * @see elm_diskselector_item_append()
25879 * @see elm_diskselector_item_del()
25880 * @see elm_diskselector_clear()
25882 * @ingroup Diskselector
25884 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25887 * Appends a new item to the diskselector object.
25889 * @param obj The diskselector object.
25890 * @param label The label of the diskselector item.
25891 * @param icon The icon object to use at left side of the item. An
25892 * icon can be any Evas object, but usually it is an icon created
25893 * with elm_icon_add().
25894 * @param func The function to call when the item is selected.
25895 * @param data The data to associate with the item for related callbacks.
25897 * @return The created item or @c NULL upon failure.
25899 * A new item will be created and appended to the diskselector, i.e., will
25900 * be set as last item. Also, if there is no selected item, it will
25901 * be selected. This will always happens for the first appended item.
25903 * If no icon is set, label will be centered on item position, otherwise
25904 * the icon will be placed at left of the label, that will be shifted
25907 * Items created with this method can be deleted with
25908 * elm_diskselector_item_del().
25910 * Associated @p data can be properly freed when item is deleted if a
25911 * callback function is set with elm_diskselector_item_del_cb_set().
25913 * If a function is passed as argument, it will be called everytime this item
25914 * is selected, i.e., the user stops the diskselector with this
25915 * item on center position. If such function isn't needed, just passing
25916 * @c NULL as @p func is enough. The same should be done for @p data.
25918 * Simple example (with no function callback or data associated):
25920 * disk = elm_diskselector_add(win);
25921 * ic = elm_icon_add(win);
25922 * elm_icon_file_set(ic, "path/to/image", NULL);
25923 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25924 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25927 * @see elm_diskselector_item_del()
25928 * @see elm_diskselector_item_del_cb_set()
25929 * @see elm_diskselector_clear()
25930 * @see elm_icon_add()
25932 * @ingroup Diskselector
25934 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);
25938 * Delete them item from the diskselector.
25940 * @param it The item of diskselector to be deleted.
25942 * If deleting all diskselector items is required, elm_diskselector_clear()
25943 * should be used instead of getting items list and deleting each one.
25945 * @see elm_diskselector_clear()
25946 * @see elm_diskselector_item_append()
25947 * @see elm_diskselector_item_del_cb_set()
25949 * @ingroup Diskselector
25951 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25954 * Set the function called when a diskselector item is freed.
25956 * @param it The item to set the callback on
25957 * @param func The function called
25959 * If there is a @p func, then it will be called prior item's memory release.
25960 * That will be called with the following arguments:
25962 * @li item's Evas object;
25965 * This way, a data associated to a diskselector item could be properly
25968 * @ingroup Diskselector
25970 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25973 * Get the data associated to the item.
25975 * @param it The diskselector item
25976 * @return The data associated to @p it
25978 * The return value is a pointer to data associated to @p item when it was
25979 * created, with function elm_diskselector_item_append(). If no data
25980 * was passed as argument, it will return @c NULL.
25982 * @see elm_diskselector_item_append()
25984 * @ingroup Diskselector
25986 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25989 * Set the icon associated to the item.
25991 * @param it The diskselector item
25992 * @param icon The icon object to associate with @p it
25994 * The icon object to use at left side of the item. An
25995 * icon can be any Evas object, but usually it is an icon created
25996 * with elm_icon_add().
25998 * Once the icon object is set, a previously set one will be deleted.
25999 * @warning Setting the same icon for two items will cause the icon to
26000 * dissapear from the first item.
26002 * If an icon was passed as argument on item creation, with function
26003 * elm_diskselector_item_append(), it will be already
26004 * associated to the item.
26006 * @see elm_diskselector_item_append()
26007 * @see elm_diskselector_item_icon_get()
26009 * @ingroup Diskselector
26011 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26014 * Get the icon associated to the item.
26016 * @param it The diskselector item
26017 * @return The icon associated to @p it
26019 * The return value is a pointer to the icon associated to @p item when it was
26020 * created, with function elm_diskselector_item_append(), or later
26021 * with function elm_diskselector_item_icon_set. If no icon
26022 * was passed as argument, it will return @c NULL.
26024 * @see elm_diskselector_item_append()
26025 * @see elm_diskselector_item_icon_set()
26027 * @ingroup Diskselector
26029 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26032 * Set the label of item.
26034 * @param it The item of diskselector.
26035 * @param label The label of item.
26037 * The label to be displayed by the item.
26039 * If no icon is set, label will be centered on item position, otherwise
26040 * the icon will be placed at left of the label, that will be shifted
26043 * An item with label "January" would be displayed on side position as
26044 * "Jan" if max length is set to 3 with function
26045 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26048 * When this @p item is selected, the entire label will be displayed,
26049 * except for width restrictions.
26050 * In this case label will be cropped and "..." will be concatenated,
26051 * but only for display purposes. It will keep the entire string, so
26052 * if diskselector is resized the remaining characters will be displayed.
26054 * If a label was passed as argument on item creation, with function
26055 * elm_diskselector_item_append(), it will be already
26056 * displayed by the item.
26058 * @see elm_diskselector_side_label_lenght_set()
26059 * @see elm_diskselector_item_label_get()
26060 * @see elm_diskselector_item_append()
26062 * @ingroup Diskselector
26064 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26067 * Get the label of item.
26069 * @param it The item of diskselector.
26070 * @return The label of item.
26072 * The return value is a pointer to the label associated to @p item when it was
26073 * created, with function elm_diskselector_item_append(), or later
26074 * with function elm_diskselector_item_label_set. If no label
26075 * was passed as argument, it will return @c NULL.
26077 * @see elm_diskselector_item_label_set() for more details.
26078 * @see elm_diskselector_item_append()
26080 * @ingroup Diskselector
26082 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26085 * Get the selected item.
26087 * @param obj The diskselector object.
26088 * @return The selected diskselector item.
26090 * The selected item can be unselected with function
26091 * elm_diskselector_item_selected_set(), and the first item of
26092 * diskselector will be selected.
26094 * The selected item always will be centered on diskselector, with
26095 * full label displayed, i.e., max lenght set to side labels won't
26096 * apply on the selected item. More details on
26097 * elm_diskselector_side_label_length_set().
26099 * @ingroup Diskselector
26101 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26104 * Set the selected state of an item.
26106 * @param it The diskselector item
26107 * @param selected The selected state
26109 * This sets the selected state of the given item @p it.
26110 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26112 * If a new item is selected the previosly selected will be unselected.
26113 * Previoulsy selected item can be get with function
26114 * elm_diskselector_selected_item_get().
26116 * If the item @p it is unselected, the first item of diskselector will
26119 * Selected items will be visible on center position of diskselector.
26120 * So if it was on another position before selected, or was invisible,
26121 * diskselector will animate items until the selected item reaches center
26124 * @see elm_diskselector_item_selected_get()
26125 * @see elm_diskselector_selected_item_get()
26127 * @ingroup Diskselector
26129 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26132 * Get whether the @p item is selected or not.
26134 * @param it The diskselector item.
26135 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26136 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26138 * @see elm_diskselector_selected_item_set() for details.
26139 * @see elm_diskselector_item_selected_get()
26141 * @ingroup Diskselector
26143 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26146 * Get the first item of the diskselector.
26148 * @param obj The diskselector object.
26149 * @return The first item, or @c NULL if none.
26151 * The list of items follows append order. So it will return the first
26152 * item appended to the widget that wasn't deleted.
26154 * @see elm_diskselector_item_append()
26155 * @see elm_diskselector_items_get()
26157 * @ingroup Diskselector
26159 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26162 * Get the last item of the diskselector.
26164 * @param obj The diskselector object.
26165 * @return The last item, or @c NULL if none.
26167 * The list of items follows append order. So it will return last first
26168 * item appended to the widget that wasn't deleted.
26170 * @see elm_diskselector_item_append()
26171 * @see elm_diskselector_items_get()
26173 * @ingroup Diskselector
26175 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26178 * Get the item before @p item in diskselector.
26180 * @param it The diskselector item.
26181 * @return The item before @p item, or @c NULL if none or on failure.
26183 * The list of items follows append order. So it will return item appended
26184 * just before @p item and that wasn't deleted.
26186 * If it is the first item, @c NULL will be returned.
26187 * First item can be get by elm_diskselector_first_item_get().
26189 * @see elm_diskselector_item_append()
26190 * @see elm_diskselector_items_get()
26192 * @ingroup Diskselector
26194 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26197 * Get the item after @p item in diskselector.
26199 * @param it The diskselector item.
26200 * @return The item after @p item, or @c NULL if none or on failure.
26202 * The list of items follows append order. So it will return item appended
26203 * just after @p item and that wasn't deleted.
26205 * If it is the last item, @c NULL will be returned.
26206 * Last item can be get by elm_diskselector_last_item_get().
26208 * @see elm_diskselector_item_append()
26209 * @see elm_diskselector_items_get()
26211 * @ingroup Diskselector
26213 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26216 * Set the text to be shown in the diskselector item.
26218 * @param item Target item
26219 * @param text The text to set in the content
26221 * Setup the text as tooltip to object. The item can have only one tooltip,
26222 * so any previous tooltip data is removed.
26224 * @see elm_object_tooltip_text_set() for more details.
26226 * @ingroup Diskselector
26228 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26231 * Set the content to be shown in the tooltip item.
26233 * Setup the tooltip to item. The item can have only one tooltip,
26234 * so any previous tooltip data is removed. @p func(with @p data) will
26235 * be called every time that need show the tooltip and it should
26236 * return a valid Evas_Object. This object is then managed fully by
26237 * tooltip system and is deleted when the tooltip is gone.
26239 * @param item the diskselector item being attached a tooltip.
26240 * @param func the function used to create the tooltip contents.
26241 * @param data what to provide to @a func as callback data/context.
26242 * @param del_cb called when data is not needed anymore, either when
26243 * another callback replaces @p func, the tooltip is unset with
26244 * elm_diskselector_item_tooltip_unset() or the owner @a item
26245 * dies. This callback receives as the first parameter the
26246 * given @a data, and @c event_info is the item.
26248 * @see elm_object_tooltip_content_cb_set() for more details.
26250 * @ingroup Diskselector
26252 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);
26255 * Unset tooltip from item.
26257 * @param item diskselector item to remove previously set tooltip.
26259 * Remove tooltip from item. The callback provided as del_cb to
26260 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26261 * it is not used anymore.
26263 * @see elm_object_tooltip_unset() for more details.
26264 * @see elm_diskselector_item_tooltip_content_cb_set()
26266 * @ingroup Diskselector
26268 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26272 * Sets a different style for this item tooltip.
26274 * @note before you set a style you should define a tooltip with
26275 * elm_diskselector_item_tooltip_content_cb_set() or
26276 * elm_diskselector_item_tooltip_text_set()
26278 * @param item diskselector item with tooltip already set.
26279 * @param style the theme style to use (default, transparent, ...)
26281 * @see elm_object_tooltip_style_set() for more details.
26283 * @ingroup Diskselector
26285 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26288 * Get the style for this item tooltip.
26290 * @param item diskselector item with tooltip already set.
26291 * @return style the theme style in use, defaults to "default". If the
26292 * object does not have a tooltip set, then NULL is returned.
26294 * @see elm_object_tooltip_style_get() for more details.
26295 * @see elm_diskselector_item_tooltip_style_set()
26297 * @ingroup Diskselector
26299 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26302 * Set the cursor to be shown when mouse is over the diskselector item
26304 * @param item Target item
26305 * @param cursor the cursor name to be used.
26307 * @see elm_object_cursor_set() for more details.
26309 * @ingroup Diskselector
26311 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26314 * Get the cursor to be shown when mouse is over the diskselector item
26316 * @param item diskselector item with cursor already set.
26317 * @return the cursor name.
26319 * @see elm_object_cursor_get() for more details.
26320 * @see elm_diskselector_cursor_set()
26322 * @ingroup Diskselector
26324 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26328 * Unset the cursor to be shown when mouse is over the diskselector item
26330 * @param item Target item
26332 * @see elm_object_cursor_unset() for more details.
26333 * @see elm_diskselector_cursor_set()
26335 * @ingroup Diskselector
26337 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26340 * Sets a different style for this item cursor.
26342 * @note before you set a style you should define a cursor with
26343 * elm_diskselector_item_cursor_set()
26345 * @param item diskselector item with cursor already set.
26346 * @param style the theme style to use (default, transparent, ...)
26348 * @see elm_object_cursor_style_set() for more details.
26350 * @ingroup Diskselector
26352 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26356 * Get the style for this item cursor.
26358 * @param item diskselector item with cursor already set.
26359 * @return style the theme style in use, defaults to "default". If the
26360 * object does not have a cursor set, then @c NULL is returned.
26362 * @see elm_object_cursor_style_get() for more details.
26363 * @see elm_diskselector_item_cursor_style_set()
26365 * @ingroup Diskselector
26367 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26371 * Set if the cursor set should be searched on the theme or should use
26372 * the provided by the engine, only.
26374 * @note before you set if should look on theme you should define a cursor
26375 * with elm_diskselector_item_cursor_set().
26376 * By default it will only look for cursors provided by the engine.
26378 * @param item widget item with cursor already set.
26379 * @param engine_only boolean to define if cursors set with
26380 * elm_diskselector_item_cursor_set() should be searched only
26381 * between cursors provided by the engine or searched on widget's
26384 * @see elm_object_cursor_engine_only_set() for more details.
26386 * @ingroup Diskselector
26388 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26391 * Get the cursor engine only usage for this item cursor.
26393 * @param item widget item with cursor already set.
26394 * @return engine_only boolean to define it cursors should be looked only
26395 * between the provided by the engine or searched on widget's theme as well.
26396 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26398 * @see elm_object_cursor_engine_only_get() for more details.
26399 * @see elm_diskselector_item_cursor_engine_only_set()
26401 * @ingroup Diskselector
26403 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26410 * @defgroup Colorselector Colorselector
26414 * @image html img/widget/colorselector/preview-00.png
26415 * @image latex img/widget/colorselector/preview-00.eps
26417 * @brief Widget for user to select a color.
26419 * Signals that you can add callbacks for are:
26420 * "changed" - When the color value changes(event_info is NULL).
26422 * See @ref tutorial_colorselector.
26425 * @brief Add a new colorselector to the parent
26427 * @param parent The parent object
26428 * @return The new object or NULL if it cannot be created
26430 * @ingroup Colorselector
26432 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26434 * Set a color for the colorselector
26436 * @param obj Colorselector object
26437 * @param r r-value of color
26438 * @param g g-value of color
26439 * @param b b-value of color
26440 * @param a a-value of color
26442 * @ingroup Colorselector
26444 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26446 * Get a color from the colorselector
26448 * @param obj Colorselector object
26449 * @param r integer pointer for r-value of color
26450 * @param g integer pointer for g-value of color
26451 * @param b integer pointer for b-value of color
26452 * @param a integer pointer for a-value of color
26454 * @ingroup Colorselector
26456 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26462 * @defgroup Ctxpopup Ctxpopup
26464 * @image html img/widget/ctxpopup/preview-00.png
26465 * @image latex img/widget/ctxpopup/preview-00.eps
26467 * @brief Context popup widet.
26469 * A ctxpopup is a widget that, when shown, pops up a list of items.
26470 * It automatically chooses an area inside its parent object's view
26471 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26472 * optimally fit into it. In the default theme, it will also point an
26473 * arrow to it's top left position at the time one shows it. Ctxpopup
26474 * items have a label and/or an icon. It is intended for a small
26475 * number of items (hence the use of list, not genlist).
26477 * @note Ctxpopup is a especialization of @ref Hover.
26479 * Signals that you can add callbacks for are:
26480 * "dismissed" - the ctxpopup was dismissed
26482 * Default contents parts of the ctxpopup widget that you can use for are:
26483 * @li "elm.swallow.content" - A content of the ctxpopup
26485 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26488 typedef enum _Elm_Ctxpopup_Direction
26490 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26492 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26493 the clicked area */
26494 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26495 the clicked area */
26496 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26498 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26499 } Elm_Ctxpopup_Direction;
26500 #define Elm_Ctxpopup_Item Elm_Object_Item
26503 * @brief Add a new Ctxpopup object to the parent.
26505 * @param parent Parent object
26506 * @return New object or @c NULL, if it cannot be created
26508 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26510 * @brief Set the Ctxpopup's parent
26512 * @param obj The ctxpopup object
26513 * @param area The parent to use
26515 * Set the parent object.
26517 * @note elm_ctxpopup_add() will automatically call this function
26518 * with its @c parent argument.
26520 * @see elm_ctxpopup_add()
26521 * @see elm_hover_parent_set()
26523 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26525 * @brief Get the Ctxpopup's parent
26527 * @param obj The ctxpopup object
26529 * @see elm_ctxpopup_hover_parent_set() for more information
26531 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26533 * @brief Clear all items in the given ctxpopup object.
26535 * @param obj Ctxpopup object
26537 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26539 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26541 * @param obj Ctxpopup object
26542 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26544 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26546 * @brief Get the value of current ctxpopup object's orientation.
26548 * @param obj Ctxpopup object
26549 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26551 * @see elm_ctxpopup_horizontal_set()
26553 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26555 * @brief Add a new item to a ctxpopup object.
26557 * @param obj Ctxpopup object
26558 * @param icon Icon to be set on new item
26559 * @param label The Label of the new item
26560 * @param func Convenience function called when item selected
26561 * @param data Data passed to @p func
26562 * @return A handle to the item added or @c NULL, on errors
26564 * @warning Ctxpopup can't hold both an item list and a content at the same
26565 * time. When an item is added, any previous content will be removed.
26567 * @see elm_ctxpopup_content_set()
26569 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);
26571 * @brief Delete the given item in a ctxpopup object.
26573 * @param it Ctxpopup item to be deleted
26575 * @see elm_ctxpopup_item_append()
26577 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26579 * @brief Set the ctxpopup item's state as disabled or enabled.
26581 * @param it Ctxpopup item to be enabled/disabled
26582 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26584 * When disabled the item is greyed out to indicate it's state.
26586 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26588 * @brief Get the ctxpopup item's disabled/enabled state.
26590 * @param it Ctxpopup item to be enabled/disabled
26591 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26593 * @see elm_ctxpopup_item_disabled_set()
26595 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26597 * @brief Get the icon object for the given ctxpopup item.
26599 * @param it Ctxpopup item
26600 * @return icon object or @c NULL, if the item does not have icon or an error
26603 * @see elm_ctxpopup_item_append()
26604 * @see elm_ctxpopup_item_icon_set()
26606 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26608 * @brief Sets the side icon associated with the ctxpopup item
26610 * @param it Ctxpopup item
26611 * @param icon Icon object to be set
26613 * Once the icon object is set, a previously set one will be deleted.
26614 * @warning Setting the same icon for two items will cause the icon to
26615 * dissapear from the first item.
26617 * @see elm_ctxpopup_item_append()
26619 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26621 * @brief Get the label for the given ctxpopup item.
26623 * @param it Ctxpopup item
26624 * @return label string or @c NULL, if the item does not have label or an
26627 * @see elm_ctxpopup_item_append()
26628 * @see elm_ctxpopup_item_label_set()
26630 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26632 * @brief (Re)set the label on the given ctxpopup item.
26634 * @param it Ctxpopup item
26635 * @param label String to set as label
26637 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26639 * @brief Set an elm widget as the content of the ctxpopup.
26641 * @param obj Ctxpopup object
26642 * @param content Content to be swallowed
26644 * If the content object is already set, a previous one will bedeleted. If
26645 * you want to keep that old content object, use the
26646 * elm_ctxpopup_content_unset() function.
26648 * @deprecated use elm_object_content_set()
26650 * @warning Ctxpopup can't hold both a item list and a content at the same
26651 * time. When a content is set, any previous items will be removed.
26653 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26655 * @brief Unset the ctxpopup content
26657 * @param obj Ctxpopup object
26658 * @return The content that was being used
26660 * Unparent and return the content object which was set for this widget.
26662 * @deprecated use elm_object_content_unset()
26664 * @see elm_ctxpopup_content_set()
26666 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26668 * @brief Set the direction priority of a ctxpopup.
26670 * @param obj Ctxpopup object
26671 * @param first 1st priority of direction
26672 * @param second 2nd priority of direction
26673 * @param third 3th priority of direction
26674 * @param fourth 4th priority of direction
26676 * This functions gives a chance to user to set the priority of ctxpopup
26677 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26678 * requested direction.
26680 * @see Elm_Ctxpopup_Direction
26682 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);
26684 * @brief Get the direction priority of a ctxpopup.
26686 * @param obj Ctxpopup object
26687 * @param first 1st priority of direction to be returned
26688 * @param second 2nd priority of direction to be returned
26689 * @param third 3th priority of direction to be returned
26690 * @param fourth 4th priority of direction to be returned
26692 * @see elm_ctxpopup_direction_priority_set() for more information.
26694 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);
26697 * @brief Get the current direction of a ctxpopup.
26699 * @param obj Ctxpopup object
26700 * @return current direction of a ctxpopup
26702 * @warning Once the ctxpopup showed up, the direction would be determined
26704 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26713 * @defgroup Transit Transit
26714 * @ingroup Elementary
26716 * Transit is designed to apply various animated transition effects to @c
26717 * Evas_Object, such like translation, rotation, etc. For using these
26718 * effects, create an @ref Elm_Transit and add the desired transition effects.
26720 * Once the effects are added into transit, they will be automatically
26721 * managed (their callback will be called until the duration is ended, and
26722 * they will be deleted on completion).
26726 * Elm_Transit *trans = elm_transit_add();
26727 * elm_transit_object_add(trans, obj);
26728 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26729 * elm_transit_duration_set(transit, 1);
26730 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26731 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26732 * elm_transit_repeat_times_set(transit, 3);
26735 * Some transition effects are used to change the properties of objects. They
26737 * @li @ref elm_transit_effect_translation_add
26738 * @li @ref elm_transit_effect_color_add
26739 * @li @ref elm_transit_effect_rotation_add
26740 * @li @ref elm_transit_effect_wipe_add
26741 * @li @ref elm_transit_effect_zoom_add
26742 * @li @ref elm_transit_effect_resizing_add
26744 * Other transition effects are used to make one object disappear and another
26745 * object appear on its old place. These effects are:
26747 * @li @ref elm_transit_effect_flip_add
26748 * @li @ref elm_transit_effect_resizable_flip_add
26749 * @li @ref elm_transit_effect_fade_add
26750 * @li @ref elm_transit_effect_blend_add
26752 * It's also possible to make a transition chain with @ref
26753 * elm_transit_chain_transit_add.
26755 * @warning We strongly recommend to use elm_transit just when edje can not do
26756 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26757 * animations can be manipulated inside the theme.
26759 * List of examples:
26760 * @li @ref transit_example_01_explained
26761 * @li @ref transit_example_02_explained
26762 * @li @ref transit_example_03_c
26763 * @li @ref transit_example_04_c
26769 * @enum Elm_Transit_Tween_Mode
26771 * The type of acceleration used in the transition.
26775 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26776 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26777 over time, then decrease again
26779 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26781 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26783 } Elm_Transit_Tween_Mode;
26786 * @enum Elm_Transit_Effect_Flip_Axis
26788 * The axis where flip effect should be applied.
26792 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26793 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26794 } Elm_Transit_Effect_Flip_Axis;
26796 * @enum Elm_Transit_Effect_Wipe_Dir
26798 * The direction where the wipe effect should occur.
26802 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26803 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26804 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26805 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26806 } Elm_Transit_Effect_Wipe_Dir;
26807 /** @enum Elm_Transit_Effect_Wipe_Type
26809 * Whether the wipe effect should show or hide the object.
26813 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26815 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26817 } Elm_Transit_Effect_Wipe_Type;
26820 * @typedef Elm_Transit
26822 * The Transit created with elm_transit_add(). This type has the information
26823 * about the objects which the transition will be applied, and the
26824 * transition effects that will be used. It also contains info about
26825 * duration, number of repetitions, auto-reverse, etc.
26827 typedef struct _Elm_Transit Elm_Transit;
26828 typedef void Elm_Transit_Effect;
26830 * @typedef Elm_Transit_Effect_Transition_Cb
26832 * Transition callback called for this effect on each transition iteration.
26834 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26836 * Elm_Transit_Effect_End_Cb
26838 * Transition callback called for this effect when the transition is over.
26840 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26843 * Elm_Transit_Del_Cb
26845 * A callback called when the transit is deleted.
26847 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26852 * @note Is not necessary to delete the transit object, it will be deleted at
26853 * the end of its operation.
26854 * @note The transit will start playing when the program enter in the main loop, is not
26855 * necessary to give a start to the transit.
26857 * @return The transit object.
26861 EAPI Elm_Transit *elm_transit_add(void);
26864 * Stops the animation and delete the @p transit object.
26866 * Call this function if you wants to stop the animation before the duration
26867 * time. Make sure the @p transit object is still alive with
26868 * elm_transit_del_cb_set() function.
26869 * All added effects will be deleted, calling its repective data_free_cb
26870 * functions. The function setted by elm_transit_del_cb_set() will be called.
26872 * @see elm_transit_del_cb_set()
26874 * @param transit The transit object to be deleted.
26877 * @warning Just call this function if you are sure the transit is alive.
26879 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26882 * Add a new effect to the transit.
26884 * @note The cb function and the data are the key to the effect. If you try to
26885 * add an already added effect, nothing is done.
26886 * @note After the first addition of an effect in @p transit, if its
26887 * effect list become empty again, the @p transit will be killed by
26888 * elm_transit_del(transit) function.
26892 * Elm_Transit *transit = elm_transit_add();
26893 * elm_transit_effect_add(transit,
26894 * elm_transit_effect_blend_op,
26895 * elm_transit_effect_blend_context_new(),
26896 * elm_transit_effect_blend_context_free);
26899 * @param transit The transit object.
26900 * @param transition_cb The operation function. It is called when the
26901 * animation begins, it is the function that actually performs the animation.
26902 * It is called with the @p data, @p transit and the time progression of the
26903 * animation (a double value between 0.0 and 1.0).
26904 * @param effect The context data of the effect.
26905 * @param end_cb The function to free the context data, it will be called
26906 * at the end of the effect, it must finalize the animation and free the
26910 * @warning The transit free the context data at the and of the transition with
26911 * the data_free_cb function, do not use the context data in another transit.
26913 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);
26916 * Delete an added effect.
26918 * This function will remove the effect from the @p transit, calling the
26919 * data_free_cb to free the @p data.
26921 * @see elm_transit_effect_add()
26923 * @note If the effect is not found, nothing is done.
26924 * @note If the effect list become empty, this function will call
26925 * elm_transit_del(transit), that is, it will kill the @p transit.
26927 * @param transit The transit object.
26928 * @param transition_cb The operation function.
26929 * @param effect The context data of the effect.
26933 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);
26936 * Add new object to apply the effects.
26938 * @note After the first addition of an object in @p transit, if its
26939 * object list become empty again, the @p transit will be killed by
26940 * elm_transit_del(transit) function.
26941 * @note If the @p obj belongs to another transit, the @p obj will be
26942 * removed from it and it will only belong to the @p transit. If the old
26943 * transit stays without objects, it will die.
26944 * @note When you add an object into the @p transit, its state from
26945 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26946 * transit ends, if you change this state whith evas_object_pass_events_set()
26947 * after add the object, this state will change again when @p transit stops to
26950 * @param transit The transit object.
26951 * @param obj Object to be animated.
26954 * @warning It is not allowed to add a new object after transit begins to go.
26956 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26959 * Removes an added object from the transit.
26961 * @note If the @p obj is not in the @p transit, nothing is done.
26962 * @note If the list become empty, this function will call
26963 * elm_transit_del(transit), that is, it will kill the @p transit.
26965 * @param transit The transit object.
26966 * @param obj Object to be removed from @p transit.
26969 * @warning It is not allowed to remove objects after transit begins to go.
26971 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26974 * Get the objects of the transit.
26976 * @param transit The transit object.
26977 * @return a Eina_List with the objects from the transit.
26981 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26984 * Enable/disable keeping up the objects states.
26985 * If it is not kept, the objects states will be reset when transition ends.
26987 * @note @p transit can not be NULL.
26988 * @note One state includes geometry, color, map data.
26990 * @param transit The transit object.
26991 * @param state_keep Keeping or Non Keeping.
26995 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26998 * Get a value whether the objects states will be reset or not.
27000 * @note @p transit can not be NULL
27002 * @see elm_transit_objects_final_state_keep_set()
27004 * @param transit The transit object.
27005 * @return EINA_TRUE means the states of the objects will be reset.
27006 * If @p transit is NULL, EINA_FALSE is returned
27010 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27013 * Set the event enabled when transit is operating.
27015 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27016 * events from mouse and keyboard during the animation.
27017 * @note When you add an object with elm_transit_object_add(), its state from
27018 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27019 * transit ends, if you change this state with evas_object_pass_events_set()
27020 * after adding the object, this state will change again when @p transit stops
27023 * @param transit The transit object.
27024 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27025 * ignored otherwise.
27029 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27032 * Get the value of event enabled status.
27034 * @see elm_transit_event_enabled_set()
27036 * @param transit The Transit object
27037 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27038 * EINA_FALSE is returned
27042 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27045 * Set the user-callback function when the transit is deleted.
27047 * @note Using this function twice will overwrite the first function setted.
27048 * @note the @p transit object will be deleted after call @p cb function.
27050 * @param transit The transit object.
27051 * @param cb Callback function pointer. This function will be called before
27052 * the deletion of the transit.
27053 * @param data Callback funtion user data. It is the @p op parameter.
27057 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27060 * Set reverse effect automatically.
27062 * If auto reverse is setted, after running the effects with the progress
27063 * parameter from 0 to 1, it will call the effecs again with the progress
27064 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27065 * where the duration was setted with the function elm_transit_add and
27066 * the repeat with the function elm_transit_repeat_times_set().
27068 * @param transit The transit object.
27069 * @param reverse EINA_TRUE means the auto_reverse is on.
27073 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27076 * Get if the auto reverse is on.
27078 * @see elm_transit_auto_reverse_set()
27080 * @param transit The transit object.
27081 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27082 * EINA_FALSE is returned
27086 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27089 * Set the transit repeat count. Effect will be repeated by repeat count.
27091 * This function sets the number of repetition the transit will run after
27092 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27093 * If the @p repeat is a negative number, it will repeat infinite times.
27095 * @note If this function is called during the transit execution, the transit
27096 * will run @p repeat times, ignoring the times it already performed.
27098 * @param transit The transit object
27099 * @param repeat Repeat count
27103 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27106 * Get the transit repeat count.
27108 * @see elm_transit_repeat_times_set()
27110 * @param transit The Transit object.
27111 * @return The repeat count. If @p transit is NULL
27116 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27119 * Set the transit animation acceleration type.
27121 * This function sets the tween mode of the transit that can be:
27122 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27123 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27124 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27125 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27127 * @param transit The transit object.
27128 * @param tween_mode The tween type.
27132 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27135 * Get the transit animation acceleration type.
27137 * @note @p transit can not be NULL
27139 * @param transit The transit object.
27140 * @return The tween type. If @p transit is NULL
27141 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27145 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27148 * Set the transit animation time
27150 * @note @p transit can not be NULL
27152 * @param transit The transit object.
27153 * @param duration The animation time.
27157 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27160 * Get the transit animation time
27162 * @note @p transit can not be NULL
27164 * @param transit The transit object.
27166 * @return The transit animation time.
27170 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27173 * Starts the transition.
27174 * Once this API is called, the transit begins to measure the time.
27176 * @note @p transit can not be NULL
27178 * @param transit The transit object.
27182 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27185 * Pause/Resume the transition.
27187 * If you call elm_transit_go again, the transit will be started from the
27188 * beginning, and will be unpaused.
27190 * @note @p transit can not be NULL
27192 * @param transit The transit object.
27193 * @param paused Whether the transition should be paused or not.
27197 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27200 * Get the value of paused status.
27202 * @see elm_transit_paused_set()
27204 * @note @p transit can not be NULL
27206 * @param transit The transit object.
27207 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27208 * EINA_FALSE is returned
27212 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27215 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27217 * The value returned is a fraction (current time / total time). It
27218 * represents the progression position relative to the total.
27220 * @note @p transit can not be NULL
27222 * @param transit The transit object.
27224 * @return The time progression value. If @p transit is NULL
27229 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27232 * Makes the chain relationship between two transits.
27234 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27235 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27237 * @param transit The transit object.
27238 * @param chain_transit The chain transit object. This transit will be operated
27239 * after transit is done.
27241 * This function adds @p chain_transit transition to a chain after the @p
27242 * transit, and will be started as soon as @p transit ends. See @ref
27243 * transit_example_02_explained for a full example.
27247 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27250 * Cut off the chain relationship between two transits.
27252 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27253 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27255 * @param transit The transit object.
27256 * @param chain_transit The chain transit object.
27258 * This function remove the @p chain_transit transition from the @p transit.
27262 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27265 * Get the current chain transit list.
27267 * @note @p transit can not be NULL.
27269 * @param transit The transit object.
27270 * @return chain transit list.
27274 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27277 * Add the Resizing Effect to Elm_Transit.
27279 * @note This API is one of the facades. It creates resizing effect context
27280 * and add it's required APIs to elm_transit_effect_add.
27282 * @see elm_transit_effect_add()
27284 * @param transit Transit object.
27285 * @param from_w Object width size when effect begins.
27286 * @param from_h Object height size when effect begins.
27287 * @param to_w Object width size when effect ends.
27288 * @param to_h Object height size when effect ends.
27289 * @return Resizing effect context data.
27293 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);
27296 * Add the Translation Effect to Elm_Transit.
27298 * @note This API is one of the facades. It creates translation effect context
27299 * and add it's required APIs to elm_transit_effect_add.
27301 * @see elm_transit_effect_add()
27303 * @param transit Transit object.
27304 * @param from_dx X Position variation when effect begins.
27305 * @param from_dy Y Position variation when effect begins.
27306 * @param to_dx X Position variation when effect ends.
27307 * @param to_dy Y Position variation when effect ends.
27308 * @return Translation effect context data.
27311 * @warning It is highly recommended just create a transit with this effect when
27312 * the window that the objects of the transit belongs has already been created.
27313 * This is because this effect needs the geometry information about the objects,
27314 * and if the window was not created yet, it can get a wrong information.
27316 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);
27319 * Add the Zoom Effect to Elm_Transit.
27321 * @note This API is one of the facades. It creates zoom effect context
27322 * and add it's required APIs to elm_transit_effect_add.
27324 * @see elm_transit_effect_add()
27326 * @param transit Transit object.
27327 * @param from_rate Scale rate when effect begins (1 is current rate).
27328 * @param to_rate Scale rate when effect ends.
27329 * @return Zoom effect context data.
27332 * @warning It is highly recommended just create a transit with this effect when
27333 * the window that the objects of the transit belongs has already been created.
27334 * This is because this effect needs the geometry information about the objects,
27335 * and if the window was not created yet, it can get a wrong information.
27337 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27340 * Add the Flip Effect to Elm_Transit.
27342 * @note This API is one of the facades. It creates flip effect context
27343 * and add it's required APIs to elm_transit_effect_add.
27344 * @note This effect is applied to each pair of objects in the order they are listed
27345 * in the transit list of objects. The first object in the pair will be the
27346 * "front" object and the second will be the "back" object.
27348 * @see elm_transit_effect_add()
27350 * @param transit Transit object.
27351 * @param axis Flipping Axis(X or Y).
27352 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27353 * @return Flip effect context data.
27356 * @warning It is highly recommended just create a transit with this effect when
27357 * the window that the objects of the transit belongs has already been created.
27358 * This is because this effect needs the geometry information about the objects,
27359 * and if the window was not created yet, it can get a wrong information.
27361 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27364 * Add the Resizable Flip Effect to Elm_Transit.
27366 * @note This API is one of the facades. It creates resizable flip effect context
27367 * and add it's required APIs to elm_transit_effect_add.
27368 * @note This effect is applied to each pair of objects in the order they are listed
27369 * in the transit list of objects. The first object in the pair will be the
27370 * "front" object and the second will be the "back" object.
27372 * @see elm_transit_effect_add()
27374 * @param transit Transit object.
27375 * @param axis Flipping Axis(X or Y).
27376 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27377 * @return Resizable flip effect context data.
27380 * @warning It is highly recommended just create a transit with this effect when
27381 * the window that the objects of the transit belongs has already been created.
27382 * This is because this effect needs the geometry information about the objects,
27383 * and if the window was not created yet, it can get a wrong information.
27385 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27388 * Add the Wipe Effect to Elm_Transit.
27390 * @note This API is one of the facades. It creates wipe effect context
27391 * and add it's required APIs to elm_transit_effect_add.
27393 * @see elm_transit_effect_add()
27395 * @param transit Transit object.
27396 * @param type Wipe type. Hide or show.
27397 * @param dir Wipe Direction.
27398 * @return Wipe effect context data.
27401 * @warning It is highly recommended just create a transit with this effect when
27402 * the window that the objects of the transit belongs has already been created.
27403 * This is because this effect needs the geometry information about the objects,
27404 * and if the window was not created yet, it can get a wrong information.
27406 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27409 * Add the Color Effect to Elm_Transit.
27411 * @note This API is one of the facades. It creates color effect context
27412 * and add it's required APIs to elm_transit_effect_add.
27414 * @see elm_transit_effect_add()
27416 * @param transit Transit object.
27417 * @param from_r RGB R when effect begins.
27418 * @param from_g RGB G when effect begins.
27419 * @param from_b RGB B when effect begins.
27420 * @param from_a RGB A when effect begins.
27421 * @param to_r RGB R when effect ends.
27422 * @param to_g RGB G when effect ends.
27423 * @param to_b RGB B when effect ends.
27424 * @param to_a RGB A when effect ends.
27425 * @return Color effect context data.
27429 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);
27432 * Add the Fade Effect to Elm_Transit.
27434 * @note This API is one of the facades. It creates fade effect context
27435 * and add it's required APIs to elm_transit_effect_add.
27436 * @note This effect is applied to each pair of objects in the order they are listed
27437 * in the transit list of objects. The first object in the pair will be the
27438 * "before" object and the second will be the "after" object.
27440 * @see elm_transit_effect_add()
27442 * @param transit Transit object.
27443 * @return Fade effect context data.
27446 * @warning It is highly recommended just create a transit with this effect when
27447 * the window that the objects of the transit belongs has already been created.
27448 * This is because this effect needs the color information about the objects,
27449 * and if the window was not created yet, it can get a wrong information.
27451 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27454 * Add the Blend Effect to Elm_Transit.
27456 * @note This API is one of the facades. It creates blend effect context
27457 * and add it's required APIs to elm_transit_effect_add.
27458 * @note This effect is applied to each pair of objects in the order they are listed
27459 * in the transit list of objects. The first object in the pair will be the
27460 * "before" object and the second will be the "after" object.
27462 * @see elm_transit_effect_add()
27464 * @param transit Transit object.
27465 * @return Blend effect context data.
27468 * @warning It is highly recommended just create a transit with this effect when
27469 * the window that the objects of the transit belongs has already been created.
27470 * This is because this effect needs the color information about the objects,
27471 * and if the window was not created yet, it can get a wrong information.
27473 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27476 * Add the Rotation Effect to Elm_Transit.
27478 * @note This API is one of the facades. It creates rotation effect context
27479 * and add it's required APIs to elm_transit_effect_add.
27481 * @see elm_transit_effect_add()
27483 * @param transit Transit object.
27484 * @param from_degree Degree when effect begins.
27485 * @param to_degree Degree when effect is ends.
27486 * @return Rotation effect context data.
27489 * @warning It is highly recommended just create a transit with this effect when
27490 * the window that the objects of the transit belongs has already been created.
27491 * This is because this effect needs the geometry information about the objects,
27492 * and if the window was not created yet, it can get a wrong information.
27494 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27497 * Add the ImageAnimation Effect to Elm_Transit.
27499 * @note This API is one of the facades. It creates image animation effect context
27500 * and add it's required APIs to elm_transit_effect_add.
27501 * The @p images parameter is a list images paths. This list and
27502 * its contents will be deleted at the end of the effect by
27503 * elm_transit_effect_image_animation_context_free() function.
27507 * char buf[PATH_MAX];
27508 * Eina_List *images = NULL;
27509 * Elm_Transit *transi = elm_transit_add();
27511 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27512 * images = eina_list_append(images, eina_stringshare_add(buf));
27514 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27515 * images = eina_list_append(images, eina_stringshare_add(buf));
27516 * elm_transit_effect_image_animation_add(transi, images);
27520 * @see elm_transit_effect_add()
27522 * @param transit Transit object.
27523 * @param images Eina_List of images file paths. This list and
27524 * its contents will be deleted at the end of the effect by
27525 * elm_transit_effect_image_animation_context_free() function.
27526 * @return Image Animation effect context data.
27530 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27536 typedef struct _Elm_Store Elm_Store;
27537 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27538 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27539 typedef struct _Elm_Store_Item Elm_Store_Item;
27540 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27541 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27542 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27543 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27544 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27545 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27546 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27547 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27548 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27550 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27551 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27552 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27553 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27554 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27555 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27556 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27560 ELM_STORE_ITEM_MAPPING_NONE = 0,
27561 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27562 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27563 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27564 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27565 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27566 // can add more here as needed by common apps
27567 ELM_STORE_ITEM_MAPPING_LAST
27568 } Elm_Store_Item_Mapping_Type;
27570 struct _Elm_Store_Item_Mapping_Icon
27572 // FIXME: allow edje file icons
27574 Elm_Icon_Lookup_Order lookup_order;
27575 Eina_Bool standard_name : 1;
27576 Eina_Bool no_scale : 1;
27577 Eina_Bool smooth : 1;
27578 Eina_Bool scale_up : 1;
27579 Eina_Bool scale_down : 1;
27582 struct _Elm_Store_Item_Mapping_Empty
27587 struct _Elm_Store_Item_Mapping_Photo
27592 struct _Elm_Store_Item_Mapping_Custom
27594 Elm_Store_Item_Mapping_Cb func;
27597 struct _Elm_Store_Item_Mapping
27599 Elm_Store_Item_Mapping_Type type;
27604 Elm_Store_Item_Mapping_Empty empty;
27605 Elm_Store_Item_Mapping_Icon icon;
27606 Elm_Store_Item_Mapping_Photo photo;
27607 Elm_Store_Item_Mapping_Custom custom;
27608 // add more types here
27612 struct _Elm_Store_Item_Info
27617 Eina_Bool rec_item;
27618 int pre_group_index;
27620 Elm_Genlist_Item_Class *item_class;
27621 const Elm_Store_Item_Mapping *mapping;
27626 struct _Elm_Store_Item_Info_Filesystem
27628 Elm_Store_Item_Info base;
27632 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27633 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27635 EAPI Elm_Store *elm_store_dbsystem_new(void);
27636 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27637 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27638 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27639 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27640 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27641 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27642 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27643 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27644 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27645 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27646 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27647 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27648 EAPI void elm_store_free(Elm_Store *st);
27649 EAPI Elm_Store *elm_store_filesystem_new(void);
27650 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27651 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27652 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27654 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27656 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27657 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27658 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27659 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27660 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27661 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27663 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27664 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27665 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27666 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27667 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27668 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27669 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27672 * @defgroup SegmentControl SegmentControl
27673 * @ingroup Elementary
27675 * @image html img/widget/segment_control/preview-00.png
27676 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27678 * @image html img/segment_control.png
27679 * @image latex img/segment_control.eps width=\textwidth
27681 * Segment control widget is a horizontal control made of multiple segment
27682 * items, each segment item functioning similar to discrete two state button.
27683 * A segment control groups the items together and provides compact
27684 * single button with multiple equal size segments.
27686 * Segment item size is determined by base widget
27687 * size and the number of items added.
27688 * Only one segment item can be at selected state. A segment item can display
27689 * combination of Text and any Evas_Object like Images or other widget.
27691 * Smart callbacks one can listen to:
27692 * - "changed" - When the user clicks on a segment item which is not
27693 * previously selected and get selected. The event_info parameter is the
27694 * segment item pointer.
27696 * Available styles for it:
27699 * Here is an example on its usage:
27700 * @li @ref segment_control_example
27704 * @addtogroup SegmentControl
27708 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27711 * Add a new segment control widget to the given parent Elementary
27712 * (container) object.
27714 * @param parent The parent object.
27715 * @return a new segment control widget handle or @c NULL, on errors.
27717 * This function inserts a new segment control widget on the canvas.
27719 * @ingroup SegmentControl
27721 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27724 * Append a new item to the segment control object.
27726 * @param obj The segment control object.
27727 * @param icon The icon object to use for the left side of the item. An
27728 * icon can be any Evas object, but usually it is an icon created
27729 * with elm_icon_add().
27730 * @param label The label of the item.
27731 * Note that, NULL is different from empty string "".
27732 * @return The created item or @c NULL upon failure.
27734 * A new item will be created and appended to the segment control, i.e., will
27735 * be set as @b last item.
27737 * If it should be inserted at another position,
27738 * elm_segment_control_item_insert_at() should be used instead.
27740 * Items created with this function can be deleted with function
27741 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27743 * @note @p label set to @c NULL is different from empty string "".
27745 * only has icon, it will be displayed bigger and centered. If it has
27746 * icon and label, even that an empty string, icon will be smaller and
27747 * positioned at left.
27751 * sc = elm_segment_control_add(win);
27752 * ic = elm_icon_add(win);
27753 * elm_icon_file_set(ic, "path/to/image", NULL);
27754 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27755 * elm_segment_control_item_add(sc, ic, "label");
27756 * evas_object_show(sc);
27759 * @see elm_segment_control_item_insert_at()
27760 * @see elm_segment_control_item_del()
27762 * @ingroup SegmentControl
27764 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27767 * Insert a new item to the segment control object at specified position.
27769 * @param obj The segment control object.
27770 * @param icon The icon object to use for the left side of the item. An
27771 * icon can be any Evas object, but usually it is an icon created
27772 * with elm_icon_add().
27773 * @param label The label of the item.
27774 * @param index Item position. Value should be between 0 and items count.
27775 * @return The created item or @c NULL upon failure.
27777 * Index values must be between @c 0, when item will be prepended to
27778 * segment control, and items count, that can be get with
27779 * elm_segment_control_item_count_get(), case when item will be appended
27780 * to segment control, just like elm_segment_control_item_add().
27782 * Items created with this function can be deleted with function
27783 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27785 * @note @p label set to @c NULL is different from empty string "".
27787 * only has icon, it will be displayed bigger and centered. If it has
27788 * icon and label, even that an empty string, icon will be smaller and
27789 * positioned at left.
27791 * @see elm_segment_control_item_add()
27792 * @see elm_segment_control_item_count_get()
27793 * @see elm_segment_control_item_del()
27795 * @ingroup SegmentControl
27797 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);
27800 * Remove a segment control item from its parent, deleting it.
27802 * @param it The item to be removed.
27804 * Items can be added with elm_segment_control_item_add() or
27805 * elm_segment_control_item_insert_at().
27807 * @ingroup SegmentControl
27809 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27812 * Remove a segment control item at given index from its parent,
27815 * @param obj The segment control object.
27816 * @param index The position of the segment control item to be deleted.
27818 * Items can be added with elm_segment_control_item_add() or
27819 * elm_segment_control_item_insert_at().
27821 * @ingroup SegmentControl
27823 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27826 * Get the Segment items count from segment control.
27828 * @param obj The segment control object.
27829 * @return Segment items count.
27831 * It will just return the number of items added to segment control @p obj.
27833 * @ingroup SegmentControl
27835 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27838 * Get the item placed at specified index.
27840 * @param obj The segment control object.
27841 * @param index The index of the segment item.
27842 * @return The segment control item or @c NULL on failure.
27844 * Index is the position of an item in segment control widget. Its
27845 * range is from @c 0 to <tt> count - 1 </tt>.
27846 * Count is the number of items, that can be get with
27847 * elm_segment_control_item_count_get().
27849 * @ingroup SegmentControl
27851 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27854 * Get the label of item.
27856 * @param obj The segment control object.
27857 * @param index The index of the segment item.
27858 * @return The label of the item at @p index.
27860 * The return value is a pointer to the label associated to the item when
27861 * it was created, with function elm_segment_control_item_add(), or later
27862 * with function elm_segment_control_item_label_set. If no label
27863 * was passed as argument, it will return @c NULL.
27865 * @see elm_segment_control_item_label_set() for more details.
27866 * @see elm_segment_control_item_add()
27868 * @ingroup SegmentControl
27870 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27873 * Set the label of item.
27875 * @param it The item of segment control.
27876 * @param text The label of item.
27878 * The label to be displayed by the item.
27879 * Label will be at right of the icon (if set).
27881 * If a label was passed as argument on item creation, with function
27882 * elm_control_segment_item_add(), it will be already
27883 * displayed by the item.
27885 * @see elm_segment_control_item_label_get()
27886 * @see elm_segment_control_item_add()
27888 * @ingroup SegmentControl
27890 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27893 * Get the icon associated to the item.
27895 * @param obj The segment control object.
27896 * @param index The index of the segment item.
27897 * @return The left side icon associated to the item at @p index.
27899 * The return value is a pointer to the icon associated to the item when
27900 * it was created, with function elm_segment_control_item_add(), or later
27901 * with function elm_segment_control_item_icon_set(). If no icon
27902 * was passed as argument, it will return @c NULL.
27904 * @see elm_segment_control_item_add()
27905 * @see elm_segment_control_item_icon_set()
27907 * @ingroup SegmentControl
27909 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27912 * Set the icon associated to the item.
27914 * @param it The segment control item.
27915 * @param icon The icon object to associate with @p it.
27917 * The icon object to use at left side of the item. An
27918 * icon can be any Evas object, but usually it is an icon created
27919 * with elm_icon_add().
27921 * Once the icon object is set, a previously set one will be deleted.
27922 * @warning Setting the same icon for two items will cause the icon to
27923 * dissapear from the first item.
27925 * If an icon was passed as argument on item creation, with function
27926 * elm_segment_control_item_add(), it will be already
27927 * associated to the item.
27929 * @see elm_segment_control_item_add()
27930 * @see elm_segment_control_item_icon_get()
27932 * @ingroup SegmentControl
27934 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27937 * Get the index of an item.
27939 * @param it The segment control item.
27940 * @return The position of item in segment control widget.
27942 * Index is the position of an item in segment control widget. Its
27943 * range is from @c 0 to <tt> count - 1 </tt>.
27944 * Count is the number of items, that can be get with
27945 * elm_segment_control_item_count_get().
27947 * @ingroup SegmentControl
27949 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27952 * Get the base object of the item.
27954 * @param it The segment control item.
27955 * @return The base object associated with @p it.
27957 * Base object is the @c Evas_Object that represents that item.
27959 * @ingroup SegmentControl
27961 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27964 * Get the selected item.
27966 * @param obj The segment control object.
27967 * @return The selected item or @c NULL if none of segment items is
27970 * The selected item can be unselected with function
27971 * elm_segment_control_item_selected_set().
27973 * The selected item always will be highlighted on segment control.
27975 * @ingroup SegmentControl
27977 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27980 * Set the selected state of an item.
27982 * @param it The segment control item
27983 * @param select The selected state
27985 * This sets the selected state of the given item @p it.
27986 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27988 * If a new item is selected the previosly selected will be unselected.
27989 * Previoulsy selected item can be get with function
27990 * elm_segment_control_item_selected_get().
27992 * The selected item always will be highlighted on segment control.
27994 * @see elm_segment_control_item_selected_get()
27996 * @ingroup SegmentControl
27998 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28005 * @defgroup Grid Grid
28007 * The grid is a grid layout widget that lays out a series of children as a
28008 * fixed "grid" of widgets using a given percentage of the grid width and
28009 * height each using the child object.
28011 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28012 * widgets size itself. The default is 100 x 100, so that means the
28013 * position and sizes of children will effectively be percentages (0 to 100)
28014 * of the width or height of the grid widget
28020 * Add a new grid to the parent
28022 * @param parent The parent object
28023 * @return The new object or NULL if it cannot be created
28027 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28030 * Set the virtual size of the grid
28032 * @param obj The grid object
28033 * @param w The virtual width of the grid
28034 * @param h The virtual height of the grid
28038 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28041 * Get the virtual size of the grid
28043 * @param obj The grid object
28044 * @param w Pointer to integer to store the virtual width of the grid
28045 * @param h Pointer to integer to store the virtual height of the grid
28049 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28052 * Pack child at given position and size
28054 * @param obj The grid object
28055 * @param subobj The child to pack
28056 * @param x The virtual x coord at which to pack it
28057 * @param y The virtual y coord at which to pack it
28058 * @param w The virtual width at which to pack it
28059 * @param h The virtual height at which to pack it
28063 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28066 * Unpack a child from a grid object
28068 * @param obj The grid object
28069 * @param subobj The child to unpack
28073 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28076 * Faster way to remove all child objects from a grid object.
28078 * @param obj The grid object
28079 * @param clear If true, it will delete just removed children
28083 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28086 * Set packing of an existing child at to position and size
28088 * @param subobj The child to set packing of
28089 * @param x The virtual x coord at which to pack it
28090 * @param y The virtual y coord at which to pack it
28091 * @param w The virtual width at which to pack it
28092 * @param h The virtual height at which to pack it
28096 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28099 * get packing of a child
28101 * @param subobj The child to query
28102 * @param x Pointer to integer to store the virtual x coord
28103 * @param y Pointer to integer to store the virtual y coord
28104 * @param w Pointer to integer to store the virtual width
28105 * @param h Pointer to integer to store the virtual height
28109 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28115 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28116 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28117 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28118 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28119 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28120 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28123 * @defgroup Video Video
28125 * @addtogroup Video
28128 * Elementary comes with two object that help design application that need
28129 * to display video. The main one, Elm_Video, display a video by using Emotion.
28130 * It does embedded the video inside an Edje object, so you can do some
28131 * animation depending on the video state change. It does also implement a
28132 * ressource management policy to remove this burden from the application writer.
28134 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28135 * It take care of updating its content according to Emotion event and provide a
28136 * way to theme itself. It also does automatically raise the priority of the
28137 * linked Elm_Video so it will use the video decoder if available. It also does
28138 * activate the remember function on the linked Elm_Video object.
28140 * Signals that you can add callback for are :
28142 * "forward,clicked" - the user clicked the forward button.
28143 * "info,clicked" - the user clicked the info button.
28144 * "next,clicked" - the user clicked the next button.
28145 * "pause,clicked" - the user clicked the pause button.
28146 * "play,clicked" - the user clicked the play button.
28147 * "prev,clicked" - the user clicked the prev button.
28148 * "rewind,clicked" - the user clicked the rewind button.
28149 * "stop,clicked" - the user clicked the stop button.
28151 * To set the video of the player, you can use elm_object_content_set() API.
28156 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28158 * @param parent The parent object
28159 * @return a new player widget handle or @c NULL, on errors.
28161 * This function inserts a new player widget on the canvas.
28163 * @see elm_object_content_set()
28167 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28170 * @brief Link a Elm_Payer with an Elm_Video object.
28172 * @param player the Elm_Player object.
28173 * @param video The Elm_Video object.
28175 * This mean that action on the player widget will affect the
28176 * video object and the state of the video will be reflected in
28177 * the player itself.
28179 * @see elm_player_add()
28180 * @see elm_video_add()
28184 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28187 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28189 * @param parent The parent object
28190 * @return a new video widget handle or @c NULL, on errors.
28192 * This function inserts a new video widget on the canvas.
28194 * @seeelm_video_file_set()
28195 * @see elm_video_uri_set()
28199 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28202 * @brief Define the file that will be the video source.
28204 * @param video The video object to define the file for.
28205 * @param filename The file to target.
28207 * This function will explicitly define a filename as a source
28208 * for the video of the Elm_Video object.
28210 * @see elm_video_uri_set()
28211 * @see elm_video_add()
28212 * @see elm_player_add()
28216 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28219 * @brief Define the uri that will be the video source.
28221 * @param video The video object to define the file for.
28222 * @param uri The uri to target.
28224 * This function will define an uri as a source for the video of the
28225 * Elm_Video object. URI could be remote source of video, like http:// or local source
28226 * like for example WebCam who are most of the time v4l2:// (but that depend and
28227 * you should use Emotion API to request and list the available Webcam on your system).
28229 * @see elm_video_file_set()
28230 * @see elm_video_add()
28231 * @see elm_player_add()
28235 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28238 * @brief Get the underlying Emotion object.
28240 * @param video The video object to proceed the request on.
28241 * @return the underlying Emotion object.
28245 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28248 * @brief Start to play the video
28250 * @param video The video object to proceed the request on.
28252 * Start to play the video and cancel all suspend state.
28256 EAPI void elm_video_play(Evas_Object *video);
28259 * @brief Pause the video
28261 * @param video The video object to proceed the request on.
28263 * Pause the video and start a timer to trigger suspend mode.
28267 EAPI void elm_video_pause(Evas_Object *video);
28270 * @brief Stop the video
28272 * @param video The video object to proceed the request on.
28274 * Stop the video and put the emotion in deep sleep mode.
28278 EAPI void elm_video_stop(Evas_Object *video);
28281 * @brief Is the video actually playing.
28283 * @param video The video object to proceed the request on.
28284 * @return EINA_TRUE if the video is actually playing.
28286 * You should consider watching event on the object instead of polling
28287 * the object state.
28291 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28294 * @brief Is it possible to seek inside the video.
28296 * @param video The video object to proceed the request on.
28297 * @return EINA_TRUE if is possible to seek inside the video.
28301 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28304 * @brief Is the audio muted.
28306 * @param video The video object to proceed the request on.
28307 * @return EINA_TRUE if the audio is muted.
28311 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28314 * @brief Change the mute state of the Elm_Video object.
28316 * @param video The video object to proceed the request on.
28317 * @param mute The new mute state.
28321 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28324 * @brief Get the audio level of the current video.
28326 * @param video The video object to proceed the request on.
28327 * @return the current audio level.
28331 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28334 * @brief Set the audio level of anElm_Video object.
28336 * @param video The video object to proceed the request on.
28337 * @param volume The new audio volume.
28341 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28343 EAPI double elm_video_play_position_get(const Evas_Object *video);
28344 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28345 EAPI double elm_video_play_length_get(const Evas_Object *video);
28346 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28347 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28348 EAPI const char *elm_video_title_get(const Evas_Object *video);
28353 // FIXME: incomplete - carousel. don't use this until this comment is removed
28354 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28355 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28356 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28357 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28358 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28359 /* smart callbacks called:
28360 * "clicked" - when the user clicks on a carousel item and becomes selected
28365 typedef enum _Elm_Datefield_ItemType
28367 ELM_DATEFIELD_YEAR = 0,
28368 ELM_DATEFIELD_MONTH,
28369 ELM_DATEFIELD_DATE,
28370 ELM_DATEFIELD_HOUR,
28371 ELM_DATEFIELD_MINUTE,
28373 } Elm_Datefield_ItemType;
28375 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28376 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28377 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28378 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28379 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28380 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28381 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28382 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28383 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28384 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28385 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28386 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28387 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28389 /* smart callbacks called:
28390 * "changed" - when datefield value is changed, this signal is sent.
28393 ////////////////////// DEPRECATED ///////////////////////////////////
28395 typedef enum _Elm_Datefield_Layout
28397 ELM_DATEFIELD_LAYOUT_TIME,
28398 ELM_DATEFIELD_LAYOUT_DATE,
28399 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28400 } Elm_Datefield_Layout;
28402 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28403 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28404 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28405 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28406 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28407 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28408 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28409 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28410 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28411 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28412 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28413 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28414 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);
28415 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28416 /////////////////////////////////////////////////////////////////////
28419 typedef enum _Elm_Popup_Response
28421 ELM_POPUP_RESPONSE_NONE = -1,
28422 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28423 ELM_POPUP_RESPONSE_OK = -3,
28424 ELM_POPUP_RESPONSE_CANCEL = -4,
28425 ELM_POPUP_RESPONSE_CLOSE = -5
28426 } Elm_Popup_Response;
28428 typedef enum _Elm_Popup_Mode
28430 ELM_POPUP_TYPE_NONE = 0,
28431 ELM_POPUP_TYPE_ALERT = (1 << 0)
28434 typedef enum _Elm_Popup_Orient
28436 ELM_POPUP_ORIENT_TOP,
28437 ELM_POPUP_ORIENT_CENTER,
28438 ELM_POPUP_ORIENT_BOTTOM,
28439 ELM_POPUP_ORIENT_LEFT,
28440 ELM_POPUP_ORIENT_RIGHT,
28441 ELM_POPUP_ORIENT_TOP_LEFT,
28442 ELM_POPUP_ORIENT_TOP_RIGHT,
28443 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28444 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28445 } Elm_Popup_Orient;
28447 /* smart callbacks called:
28448 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28451 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28452 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28453 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28454 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28455 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28456 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28457 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28458 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28459 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28460 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28461 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, ... );
28462 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28463 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28464 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28465 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28466 EAPI int elm_popup_run(Evas_Object *obj);
28468 /* NavigationBar */
28469 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28470 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28474 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28475 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28476 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28477 ELM_NAVIGATIONBAR_BACK_BUTTON
28478 } Elm_Navi_Button_Type;
28480 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28481 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);
28482 EINA_DEPRECATED EAPI void elm_navigationbar_pop(Evas_Object *obj);
28483 EINA_DEPRECATED EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28484 EINA_DEPRECATED EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28485 EINA_DEPRECATED EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28486 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28487 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28488 EINA_DEPRECATED EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28489 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28490 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28491 EINA_DEPRECATED EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28492 EINA_DEPRECATED EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28493 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28494 EINA_DEPRECATED EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28495 EINA_DEPRECATED EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28496 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28497 EINA_DEPRECATED EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28498 EINA_DEPRECATED EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28499 EINA_DEPRECATED Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28500 EINA_DEPRECATED EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28501 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28503 /* NavigationBar */
28504 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28505 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28509 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28510 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28511 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28512 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28513 ELM_NAVIGATIONBAR_EX_MAX
28514 } Elm_Navi_ex_Button_Type;
28515 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28517 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28518 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28519 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28520 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28521 EINA_DEPRECATED EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28522 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28523 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28524 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28525 EINA_DEPRECATED EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28526 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);
28527 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28528 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28529 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28530 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28531 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28532 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28533 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28534 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28535 EINA_DEPRECATED EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28536 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28537 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28538 EINA_DEPRECATED EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28539 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28540 EINA_DEPRECATED EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28541 EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28542 EINA_DEPRECATED EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28543 EINA_DEPRECATED EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28544 EINA_DEPRECATED Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28547 * @defgroup Naviframe Naviframe
28548 * @ingroup Elementary
28550 * @brief Naviframe is a kind of view manager for the applications.
28552 * Naviframe provides functions to switch different pages with stack
28553 * mechanism. It means if one page(item) needs to be changed to the new one,
28554 * then naviframe would push the new page to it's internal stack. Of course,
28555 * it can be back to the previous page by popping the top page. Naviframe
28556 * provides some transition effect while the pages are switching (same as
28559 * Since each item could keep the different styles, users could keep the
28560 * same look & feel for the pages or different styles for the items in it's
28563 * Signals that you can add callback for are:
28564 * @li "transition,finished" - When the transition is finished in changing
28566 * @li "title,clicked" - User clicked title area
28568 * Default contents parts of the naviframe items that you can use for are:
28569 * @li "elm.swallow.content" - A main content of the page
28570 * @li "elm.swallow.icon" - A icon in the title area
28571 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28572 * @li "elm.swallow.next_btn" - A button to go to the next page
28574 * Default text parts of the naviframe items that you can use for are:
28575 * @li "elm.text.title" - Title label in the title area
28576 * @li "elm.text.subtitle" - Sub-title label in the title area
28578 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28581 //Available commonly
28582 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28583 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28584 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28585 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28586 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28587 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28588 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28589 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28590 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28591 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28592 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28593 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28594 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28596 //Available only in a style - "2line"
28597 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28599 //Available only in a style - "segment"
28600 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28601 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28604 * @addtogroup Naviframe
28609 * @brief Add a new Naviframe object to the parent.
28611 * @param parent Parent object
28612 * @return New object or @c NULL, if it cannot be created
28614 * @ingroup Naviframe
28616 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28618 * @brief Push a new item to the top of the naviframe stack (and show it).
28620 * @param obj The naviframe object
28621 * @param title_label The label in the title area. The name of the title
28622 * label part is "elm.text.title"
28623 * @param prev_btn The button to go to the previous item. If it is NULL,
28624 * then naviframe will create a back button automatically. The name of
28625 * the prev_btn part is "elm.swallow.prev_btn"
28626 * @param next_btn The button to go to the next item. Or It could be just an
28627 * extra function button. The name of the next_btn part is
28628 * "elm.swallow.next_btn"
28629 * @param content The main content object. The name of content part is
28630 * "elm.swallow.content"
28631 * @param item_style The current item style name. @c NULL would be default.
28632 * @return The created item or @c NULL upon failure.
28634 * The item pushed becomes one page of the naviframe, this item will be
28635 * deleted when it is popped.
28637 * @see also elm_naviframe_item_style_set()
28638 * @see also elm_naviframe_item_insert_before()
28639 * @see also elm_naviframe_item_insert_after()
28641 * The following styles are available for this item:
28644 * @ingroup Naviframe
28646 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);
28648 * @brief Insert a new item into the naviframe before item @p before.
28650 * @param before The naviframe item to insert before.
28651 * @param title_label The label in the title area. The name of the title
28652 * label part is "elm.text.title"
28653 * @param prev_btn The button to go to the previous item. If it is NULL,
28654 * then naviframe will create a back button automatically. The name of
28655 * the prev_btn part is "elm.swallow.prev_btn"
28656 * @param next_btn The button to go to the next item. Or It could be just an
28657 * extra function button. The name of the next_btn part is
28658 * "elm.swallow.next_btn"
28659 * @param content The main content object. The name of content part is
28660 * "elm.swallow.content"
28661 * @param item_style The current item style name. @c NULL would be default.
28662 * @return The created item or @c NULL upon failure.
28664 * The item is inserted into the naviframe straight away without any
28665 * transition operations. This item will be deleted when it is popped.
28667 * @see also elm_naviframe_item_style_set()
28668 * @see also elm_naviframe_item_push()
28669 * @see also elm_naviframe_item_insert_after()
28671 * The following styles are available for this item:
28674 * @ingroup Naviframe
28676 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);
28678 * @brief Insert a new item into the naviframe after item @p after.
28680 * @param after The naviframe item to insert after.
28681 * @param title_label The label in the title area. The name of the title
28682 * label part is "elm.text.title"
28683 * @param prev_btn The button to go to the previous item. If it is NULL,
28684 * then naviframe will create a back button automatically. The name of
28685 * the prev_btn part is "elm.swallow.prev_btn"
28686 * @param next_btn The button to go to the next item. Or It could be just an
28687 * extra function button. The name of the next_btn part is
28688 * "elm.swallow.next_btn"
28689 * @param content The main content object. The name of content part is
28690 * "elm.swallow.content"
28691 * @param item_style The current item style name. @c NULL would be default.
28692 * @return The created item or @c NULL upon failure.
28694 * The item is inserted into the naviframe straight away without any
28695 * transition operations. This item will be deleted when it is popped.
28697 * @see also elm_naviframe_item_style_set()
28698 * @see also elm_naviframe_item_push()
28699 * @see also elm_naviframe_item_insert_before()
28701 * The following styles are available for this item:
28704 * @ingroup Naviframe
28706 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);
28708 * @brief Pop an item that is on top of the stack
28710 * @param obj The naviframe object
28711 * @return @c NULL or the content object(if the
28712 * elm_naviframe_content_preserve_on_pop_get is true).
28714 * This pops an item that is on the top(visible) of the naviframe, makes it
28715 * disappear, then deletes the item. The item that was underneath it on the
28716 * stack will become visible.
28718 * @see also elm_naviframe_content_preserve_on_pop_get()
28720 * @ingroup Naviframe
28722 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28724 * @brief Pop the items between the top and the above one on the given item.
28726 * @param it The naviframe item
28728 * @ingroup Naviframe
28730 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28732 * Promote an item already in the naviframe stack to the top of the stack
28734 * @param it The naviframe item
28736 * This will take the indicated item and promote it to the top of the stack
28737 * as if it had been pushed there. The item must already be inside the
28738 * naviframe stack to work.
28741 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28743 * @brief Delete the given item instantly.
28745 * @param it The naviframe item
28747 * This just deletes the given item from the naviframe item list instantly.
28748 * So this would not emit any signals for view transitions but just change
28749 * the current view if the given item is a top one.
28751 * @ingroup Naviframe
28753 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28755 * @brief preserve the content objects when items are popped.
28757 * @param obj The naviframe object
28758 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28760 * @see also elm_naviframe_content_preserve_on_pop_get()
28762 * @ingroup Naviframe
28764 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28766 * @brief Get a value whether preserve mode is enabled or not.
28768 * @param obj The naviframe object
28769 * @return If @c EINA_TRUE, preserve mode is enabled
28771 * @see also elm_naviframe_content_preserve_on_pop_set()
28773 * @ingroup Naviframe
28775 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28777 * @brief Get a top item on the naviframe stack
28779 * @param obj The naviframe object
28780 * @return The top item on the naviframe stack or @c NULL, if the stack is
28783 * @ingroup Naviframe
28785 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28787 * @brief Get a bottom item on the naviframe stack
28789 * @param obj The naviframe object
28790 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28793 * @ingroup Naviframe
28795 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28797 * @brief Set an item style
28799 * @param obj The naviframe item
28800 * @param item_style The current item style name. @c NULL would be default
28802 * The following styles are available for this item:
28805 * @see also elm_naviframe_item_style_get()
28807 * @ingroup Naviframe
28809 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28811 * @brief Get an item style
28813 * @param obj The naviframe item
28814 * @return The current item style name
28816 * @see also elm_naviframe_item_style_set()
28818 * @ingroup Naviframe
28820 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28822 * @brief Show/Hide the title area
28824 * @param it The naviframe item
28825 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28828 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28830 * @see also elm_naviframe_item_title_visible_get()
28832 * @ingroup Naviframe
28834 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28836 * @brief Get a value whether title area is visible or not.
28838 * @param it The naviframe item
28839 * @return If @c EINA_TRUE, title area is visible
28841 * @see also elm_naviframe_item_title_visible_set()
28843 * @ingroup Naviframe
28845 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28848 * @brief Set creating prev button automatically or not
28850 * @param obj The naviframe object
28851 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28852 * be created internally when you pass the @c NULL to the prev_btn
28853 * parameter in elm_naviframe_item_push
28855 * @see also elm_naviframe_item_push()
28857 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28859 * @brief Get a value whether prev button(back button) will be auto pushed or
28862 * @param obj The naviframe object
28863 * @return If @c EINA_TRUE, prev button will be auto pushed.
28865 * @see also elm_naviframe_item_push()
28866 * elm_naviframe_prev_btn_auto_pushed_set()
28868 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28870 * @brief Get a list of all the naviframe items.
28872 * @param obj The naviframe object
28873 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28874 * or @c NULL on failure.
28876 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28883 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28884 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28885 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28886 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28887 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28888 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28889 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28890 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28891 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28893 typedef enum _Elm_Controlbar_Mode_Type
28895 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28896 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28897 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28898 ELM_CONTROLBAR_MODE_LARGE,
28899 ELM_CONTROLBAR_MODE_SMALL,
28900 ELM_CONTROLBAR_MODE_LEFT,
28901 ELM_CONTROLBAR_MODE_RIGHT
28902 } Elm_Controlbar_Mode_Type;
28904 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28905 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28906 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28907 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28908 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);
28909 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);
28910 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);
28911 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);
28912 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);
28913 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);
28914 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28915 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28916 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28917 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28918 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28919 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28920 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28921 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28922 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28923 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28924 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28925 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28926 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28927 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28928 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28929 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28930 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28931 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28932 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28933 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28934 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28935 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28936 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28937 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28938 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28939 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28940 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28941 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28942 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28945 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28946 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28947 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28948 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28949 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28950 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28951 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28952 EAPI void elm_searchbar_clear(Evas_Object *obj);
28953 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28955 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28956 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28957 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28958 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28961 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28962 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28963 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28964 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28965 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28970 ELM_TICKERNOTI_ORIENT_TOP = 0,
28971 ELM_TICKERNOTI_ORIENT_BOTTOM,
28972 ELM_TICKERNOTI_ORIENT_LAST
28973 } Elm_Tickernoti_Orient;
28975 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28976 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28977 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28978 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28979 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28980 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28981 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28984 ELM_TICKERNOTI_DEFAULT,
28985 ELM_TICKERNOTI_DETAILVIEW
28986 } Elm_Tickernoti_Mode;
28987 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28988 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28989 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28990 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28991 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28992 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28993 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28994 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28995 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28996 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28997 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28998 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28999 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29000 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29001 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29002 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29003 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29004 /* ############################################################################### */
29006 * Parts which can be used with elm_object_text_part_set() and
29007 * elm_object_text_part_get():
29009 * @li NULL/"default" - Operates on tickernoti content-text
29011 * Parts which can be used with elm_object_content_part_set(),
29012 * elm_object_content_part_get() and elm_object_content_part_unset():
29014 * @li "icon" - Operates on tickernoti's icon
29015 * @li "button" - Operates on tickernoti's button
29017 * smart callbacks called:
29018 * @li "clicked" - emitted when tickernoti is clicked, except at the
29019 * swallow/button region, if any.
29020 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29021 * any hide animation, this signal is emitted after the animation.
29025 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29027 struct _Colorpalette_Color
29029 unsigned int r, g, b;
29032 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29033 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29034 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29035 /* smart callbacks called:
29036 * "clicked" - when image clicked
29040 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29041 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29042 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29043 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29044 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29045 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29046 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29047 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29048 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29049 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29050 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29051 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29052 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29053 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29054 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29055 /* smart callbacks called:
29056 * "clicked" - when an editfield is clicked
29057 * "unfocused" - when an editfield is unfocused
29061 /* Sliding Drawer */
29062 typedef enum _Elm_SlidingDrawer_Pos
29064 ELM_SLIDINGDRAWER_BOTTOM,
29065 ELM_SLIDINGDRAWER_LEFT,
29066 ELM_SLIDINGDRAWER_RIGHT,
29067 ELM_SLIDINGDRAWER_TOP
29068 } Elm_SlidingDrawer_Pos;
29070 typedef struct _Elm_SlidingDrawer_Drag_Value
29073 } Elm_SlidingDrawer_Drag_Value;
29075 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29076 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29077 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29078 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29079 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
29080 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29082 /* multibuttonentry */
29083 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29084 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29085 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29086 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
29087 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29088 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29089 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29090 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29091 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29092 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29093 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29094 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29095 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29096 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29097 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
29098 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29099 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29100 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29101 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29102 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29103 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29104 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
29105 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29106 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29107 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29108 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29109 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29110 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29111 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29112 /* smart callback called:
29113 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29114 * "added" - This signal is emitted when a new multibuttonentry item is added.
29115 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29116 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29117 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29118 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29119 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29120 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29121 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29122 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29123 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29124 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29126 /* available styles:
29131 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29132 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
29133 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29134 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29135 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29136 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
29137 /* smart callback called:
29138 * "expanded" - This signal is emitted when a stackedicon is expanded.
29139 * "clicked" - This signal is emitted when a stackedicon is clicked.
29141 /* available styles:
29145 /* dialoguegroup */
29146 typedef struct _Dialogue_Item Dialogue_Item;
29148 typedef enum _Elm_Dialoguegourp_Item_Style
29150 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29151 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29152 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29153 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29154 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29155 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29156 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29157 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29158 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29159 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29160 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29161 } Elm_Dialoguegroup_Item_Style;
29163 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
29164 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29165 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29166 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29167 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29168 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
29169 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
29170 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29171 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
29172 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29173 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29174 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29175 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29176 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29177 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29178 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29183 ELM_DAYSELECTOR_SUN,
29184 ELM_DAYSELECTOR_MON,
29185 ELM_DAYSELECTOR_TUE,
29186 ELM_DAYSELECTOR_WED,
29187 ELM_DAYSELECTOR_THU,
29188 ELM_DAYSELECTOR_FRI,
29189 ELM_DAYSELECTOR_SAT
29190 } Elm_DaySelector_Day;
29192 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29193 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29194 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29197 typedef struct _Imageslider_Item Elm_Imageslider_Item;
29198 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29199 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29200 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);
29201 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);
29202 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);
29203 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29204 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29205 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29206 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29207 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29208 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29209 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29210 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29211 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29212 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29213 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);